Add new tests for transformers.

This commit is contained in:
James Cole
2018-12-20 05:46:05 +01:00
parent c1ae0ab57d
commit 6f54f41946
8 changed files with 255 additions and 408 deletions

View File

@@ -35,6 +35,10 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
* @property int $id * @property int $id
* @property Carbon date * @property Carbon date
* @property TransactionJournal transactionJournal * @property TransactionJournal transactionJournal
* @property string $amount
* @property Carbon created_at
* @property Carbon updated_at
*
*/ */
class PiggyBankEvent extends Model class PiggyBankEvent extends Model
{ {

View File

@@ -308,6 +308,24 @@ class PiggyBankRepository implements PiggyBankRepositoryInterface
return (int)$this->user->piggyBanks()->max('order'); return (int)$this->user->piggyBanks()->max('order');
} }
/**
* Return note for piggy bank.
*
* @param PiggyBank $piggyBank
*
* @return string
*/
public function getNoteText(PiggyBank $piggyBank): string
{
/** @var Note $note */
$note = $piggyBank->notes()->first();
if (null === $note) {
return '';
}
return $note->text;
}
/** /**
* @return Collection * @return Collection
*/ */
@@ -381,6 +399,31 @@ class PiggyBankRepository implements PiggyBankRepositoryInterface
return $savePerMonth; return $savePerMonth;
} }
/**
* @param PiggyBankEvent $event
*
* @return int|null
*/
public function getTransactionWithEvent(PiggyBankEvent $event): ?int
{
$journal = $event->transactionJournal;
if (null === $journal) {
return null;
}
if ((float)$event->amount < 0) {
$transaction = $journal->transactions()->where('amount', '<', 0)->first();
return $transaction->id ?? null;
}
if ((float)$event->amount > 0) {
$transaction = $journal->transactions()->where('amount', '>', 0)->first();
return $transaction->id ?? null;
}
return null;
}
/** /**
* Get for piggy account what is left to put in piggies. * Get for piggy account what is left to put in piggies.
* *

View File

@@ -35,6 +35,7 @@ use Illuminate\Support\Collection;
*/ */
interface PiggyBankRepositoryInterface interface PiggyBankRepositoryInterface
{ {
/** /**
* @param PiggyBank $piggyBank * @param PiggyBank $piggyBank
* @param string $amount * @param string $amount
@@ -152,6 +153,15 @@ interface PiggyBankRepositoryInterface
*/ */
public function getMaxOrder(): int; public function getMaxOrder(): int;
/**
* Return note for piggy bank.
*
* @param PiggyBank $piggyBank
*
* @return string
*/
public function getNoteText(PiggyBank $piggyBank): string;
/** /**
* Return all piggy banks. * Return all piggy banks.
* *
@@ -182,6 +192,13 @@ interface PiggyBankRepositoryInterface
*/ */
public function getSuggestedMonthlyAmount(PiggyBank $piggyBank): string; public function getSuggestedMonthlyAmount(PiggyBank $piggyBank): string;
/**
* @param PiggyBankEvent $event
*
* @return int|null
*/
public function getTransactionWithEvent(PiggyBankEvent $event): ?int;
/** /**
* Get for piggy account what is left to put in piggies. * Get for piggy account what is left to put in piggies.
* *

View File

@@ -1,96 +0,0 @@
<?php
/**
* NoteTransformer.php
* Copyright (c) 2018 thegrumpydictator@gmail.com
*
* This file is part of Firefly III.
*
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Transformers;
use FireflyIII\Models\Note;
use League\CommonMark\CommonMarkConverter;
use League\Fractal\TransformerAbstract;
use Log;
use Symfony\Component\HttpFoundation\ParameterBag;
/**
* Class NoteTransformer
*/
class NoteTransformer extends TransformerAbstract
{
/**
* List of resources possible to include
*
* @var array
*/
protected $availableIncludes = [];
/**
* List of resources to automatically include
*
* @var array
*/
protected $defaultIncludes = [];
/** @var ParameterBag */
protected $parameters;
/**
* CurrencyTransformer constructor.
*
* @codeCoverageIgnore
*
* @param ParameterBag $parameters
*/
public function __construct(ParameterBag $parameters)
{
$this->parameters = $parameters;
if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
}
}
/**
* Transform the note.
*
* @param Note $note
*
* @return array
*/
public function transform(Note $note): array
{
$converter = new CommonMarkConverter;
$data = [
'id' => (int)$note->id,
'created_at' => $note->created_at->toAtomString(),
'updated_at' => $note->updated_at->toAtomString(),
'title' => $note->title,
'text' => $note->text,
'markdown' => $converter->convertToHtml($note->text),
'links' => [
[
'rel' => 'self',
'uri' => '/notes/' . $note->id,
],
],
];
return $data;
}
}

View File

@@ -27,15 +27,21 @@ namespace FireflyIII\Transformers;
use FireflyIII\Models\PiggyBankEvent; use FireflyIII\Models\PiggyBankEvent;
use FireflyIII\Repositories\Account\AccountRepositoryInterface; use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface; use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
use League\Fractal\TransformerAbstract; use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
use Log; use Log;
use Symfony\Component\HttpFoundation\ParameterBag;
/** /**
* Class PiggyBankEventTransformer * Class PiggyBankEventTransformer
*/ */
class PiggyBankEventTransformer extends AbstractTransformer class PiggyBankEventTransformer extends AbstractTransformer
{ {
/** @var CurrencyRepositoryInterface */
private $currencyRepos;
/** @var PiggyBankRepositoryInterface */
private $piggyRepos;
/** @var AccountRepositoryInterface */
private $repository;
/** /**
* PiggyBankEventTransformer constructor. * PiggyBankEventTransformer constructor.
* *
@@ -43,6 +49,9 @@ class PiggyBankEventTransformer extends AbstractTransformer
*/ */
public function __construct() public function __construct()
{ {
$this->repository = app(AccountRepositoryInterface::class);
$this->currencyRepos = app(CurrencyRepositoryInterface::class);
$this->piggyRepos = app(PiggyBankRepositoryInterface::class);
if ('testing' === config('app.env')) { if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this))); Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
} }
@@ -57,39 +66,35 @@ class PiggyBankEventTransformer extends AbstractTransformer
*/ */
public function transform(PiggyBankEvent $event): array public function transform(PiggyBankEvent $event): array
{ {
// get account linked to piggy bank
$account = $event->piggyBank->account; $account = $event->piggyBank->account;
/** @var AccountRepositoryInterface $accountRepos */
$accountRepos = app(AccountRepositoryInterface::class);
$accountRepos->setUser($account->user);
$currencyId = (int)$accountRepos->getMetaValue($account, 'currency_id'); // set up repositories.
$journal = $event->transactionJournal; $this->repository->setUser($account->user);
$transactionId = null; $this->currencyRepos->setUser($account->user);
$decimalPlaces = 2; $this->piggyRepos->setUser($account->user);
if ($currencyId > 0) {
/** @var CurrencyRepositoryInterface $repository */ // get associated currency or fall back to the default:
$repository = app(CurrencyRepositoryInterface::class); $currencyId = (int)$this->repository->getMetaValue($account, 'currency_id');
$repository->setUser($account->user); $currency = $this->currencyRepos->findNull($currencyId);
$currency = $repository->findNull($currencyId); if (null === $currency) {
/** @noinspection NullPointerExceptionInspection */
$decimalPlaces = $currency->decimal_places;
}
if (0 === $currencyId) {
$currency = app('amount')->getDefaultCurrencyByUser($account->user); $currency = app('amount')->getDefaultCurrencyByUser($account->user);
} }
if (null !== $journal) {
$transactionId = $journal->transactions()->first()->id; // get associated journal and transaction, if any:
} $journalId = $event->transaction_journal_id;
$transactionId = $this->piggyRepos->getTransactionWithEvent($event);
$data = [ $data = [
'id' => (int)$event->id, 'id' => (int)$event->id,
'created_at' => $event->created_at->toAtomString(), 'created_at' => $event->created_at->toAtomString(),
'updated_at' => $event->updated_at->toAtomString(), 'updated_at' => $event->updated_at->toAtomString(),
'amount' => round($event->amount, $decimalPlaces), 'amount' => round($event->amount, $currency->decimal_places),
'currency_id' => $currency->id, 'currency_id' => $currency->id,
'currency_code' => $currency->code, 'currency_code' => $currency->code,
'currency_symbol' => $currency->symbol, 'currency_symbol' => $currency->symbol,
'currency_decimal_places' => $currency->decimal_places, 'currency_decimal_places' => $currency->decimal_places,
'journal_id' => $journalId,
'transaction_id' => $transactionId, 'transaction_id' => $transactionId,
'links' => [ 'links' => [
[ [

View File

@@ -25,7 +25,6 @@ namespace FireflyIII\Transformers;
use FireflyIII\Models\Account; use FireflyIII\Models\Account;
use FireflyIII\Models\Note;
use FireflyIII\Models\PiggyBank; use FireflyIII\Models\PiggyBank;
use FireflyIII\Repositories\Account\AccountRepositoryInterface; use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface; use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
@@ -37,6 +36,13 @@ use Log;
*/ */
class PiggyBankTransformer extends AbstractTransformer class PiggyBankTransformer extends AbstractTransformer
{ {
/** @var AccountRepositoryInterface */
private $accountRepos;
/** @var CurrencyRepositoryInterface */
private $currencyRepos;
/** @var PiggyBankRepositoryInterface */
private $piggyRepos;
/** /**
* PiggyBankTransformer constructor. * PiggyBankTransformer constructor.
* *
@@ -44,6 +50,9 @@ class PiggyBankTransformer extends AbstractTransformer
*/ */
public function __construct() public function __construct()
{ {
$this->accountRepos = app(AccountRepositoryInterface::class);
$this->currencyRepos = app(CurrencyRepositoryInterface::class);
$this->piggyRepos = app(PiggyBankRepositoryInterface::class);
if ('testing' === config('app.env')) { if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this))); Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
} }
@@ -61,43 +70,40 @@ class PiggyBankTransformer extends AbstractTransformer
{ {
/** @var Account $account */ /** @var Account $account */
$account = $piggyBank->account; $account = $piggyBank->account;
/** @var AccountRepositoryInterface $accountRepos */
$accountRepos = app(AccountRepositoryInterface::class); // set up repositories
$accountRepos->setUser($account->user); $this->accountRepos->setUser($account->user);
$currencyId = (int)$accountRepos->getMetaValue($account, 'currency_id'); $this->currencyRepos->setUser($account->user);
$currency = null; $this->piggyRepos->setUser($account->user);
if (0 === $currencyId) {
// get currency from account, or use default.
$currencyId = (int)$this->accountRepos->getMetaValue($account, 'currency_id');
$currency = $this->currencyRepos->findNull($currencyId);
if (null === $currency) {
$currency = app('amount')->getDefaultCurrencyByUser($account->user); $currency = app('amount')->getDefaultCurrencyByUser($account->user);
} }
if ($currencyId > 0) { // note
/** @var CurrencyRepositoryInterface $repository */ $notes = $this->piggyRepos->getNoteText($piggyBank);
$repository = app(CurrencyRepositoryInterface::class); $notes = '' === $notes ? null : $notes;
$repository->setUser($account->user);
$currency = $repository->findNull($currencyId);
}
$decimalPlaces = $currency->decimal_places;
// get currently saved amount: // get currently saved amount:
/** @var PiggyBankRepositoryInterface $piggyRepos */ $currentAmountStr = $this->piggyRepos->getCurrentAmount($piggyBank);
$piggyRepos = app(PiggyBankRepositoryInterface::class); $currentAmount = round($currentAmountStr, $currency->decimal_places);
$piggyRepos->setUser($account->user);
// current amount in piggy bank: // left to save:
$currentAmountStr = $piggyRepos->getCurrentAmount($piggyBank);
$currentAmount = round($currentAmountStr, $decimalPlaces);
// left to save to target:
$leftToSave = bcsub($piggyBank->targetamount, $currentAmountStr); $leftToSave = bcsub($piggyBank->targetamount, $currentAmountStr);
$startDate = null === $piggyBank->startdate ? null : $piggyBank->startdate->format('Y-m-d'); $startDate = null === $piggyBank->startdate ? null : $piggyBank->startdate->format('Y-m-d');
$targetDate = null === $piggyBank->targetdate ? null : $piggyBank->targetdate->format('Y-m-d'); $targetDate = null === $piggyBank->targetdate ? null : $piggyBank->targetdate->format('Y-m-d');
$targetAmount = round($piggyBank->targetamount, $decimalPlaces);
// target and percentage:
$targetAmount = round($piggyBank->targetamount, $currency->decimal_places);
$percentage = (int)(0 !== bccomp('0', $currentAmountStr) ? $currentAmount / $targetAmount * 100 : 0); $percentage = (int)(0 !== bccomp('0', $currentAmountStr) ? $currentAmount / $targetAmount * 100 : 0);
$data = [ $data = [
'id' => (int)$piggyBank->id, 'id' => (int)$piggyBank->id,
'created_at' => $piggyBank->created_at->toAtomString(), 'created_at' => $piggyBank->created_at->toAtomString(),
'updated_at' => $piggyBank->updated_at->toAtomString(), 'updated_at' => $piggyBank->updated_at->toAtomString(),
'account_id' => $piggyBank->account_id,
'name' => $piggyBank->name, 'name' => $piggyBank->name,
'currency_id' => $currency->id, 'currency_id' => $currency->id,
'currency_code' => $currency->code, 'currency_code' => $currency->code,
@@ -106,13 +112,13 @@ class PiggyBankTransformer extends AbstractTransformer
'target_amount' => $targetAmount, 'target_amount' => $targetAmount,
'percentage' => $percentage, 'percentage' => $percentage,
'current_amount' => $currentAmount, 'current_amount' => $currentAmount,
'left_to_save' => round($leftToSave, $decimalPlaces), 'left_to_save' => round($leftToSave, $currency->decimal_places),
'save_per_month' => round($piggyRepos->getSuggestedMonthlyAmount($piggyBank), $decimalPlaces), 'save_per_month' => round($this->piggyRepos->getSuggestedMonthlyAmount($piggyBank), $currency->decimal_places),
'start_date' => $startDate, 'start_date' => $startDate,
'target_date' => $targetDate, 'target_date' => $targetDate,
'order' => (int)$piggyBank->order, 'order' => (int)$piggyBank->order,
'active' => true, 'active' => true,
'notes' => null, 'notes' => $notes,
'links' => [ 'links' => [
[ [
'rel' => 'self', 'rel' => 'self',
@@ -120,11 +126,6 @@ class PiggyBankTransformer extends AbstractTransformer
], ],
], ],
]; ];
/** @var Note $note */
$note = $piggyBank->notes()->first();
if (null !== $note) {
$data['notes'] = $note->text;
}
return $data; return $data;
} }

View File

@@ -23,13 +23,14 @@ declare(strict_types=1);
namespace Tests\Unit\Transformers; namespace Tests\Unit\Transformers;
use FireflyIII\Models\Account; use Amount;
use FireflyIII\Models\AccountMeta;
use FireflyIII\Models\PiggyBank;
use FireflyIII\Models\PiggyBankEvent; use FireflyIII\Models\PiggyBankEvent;
use FireflyIII\Models\TransactionCurrency; use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface; use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
use FireflyIII\Transformers\PiggyBankEventTransformer; use FireflyIII\Transformers\PiggyBankEventTransformer;
use Mockery;
use Symfony\Component\HttpFoundation\ParameterBag; use Symfony\Component\HttpFoundation\ParameterBag;
use Tests\TestCase; use Tests\TestCase;
@@ -45,100 +46,62 @@ class PiggyBankEventTransformerTest extends TestCase
*/ */
public function testBasic(): void public function testBasic(): void
{ {
// make new account: // repositories
$account = Account::create( $currencyRepos = $this->mock(CurrencyRepositoryInterface::class);
[ $piggyRepos = $this->mock(PiggyBankRepositoryInterface::class);
'user_id' => $this->user()->id, $accountRepos = $this->mock(AccountRepositoryInterface::class);
'account_type_id' => 3, // asset account
'name' => 'Random name #' . random_int(1, 10000), $currencyRepos->shouldReceive('setUser')->atLeast()->once();
'virtual_balance' => 12.34, $piggyRepos->shouldReceive('setUser')->atLeast()->once();
'iban' => 'NL85ABNA0466812694', $accountRepos->shouldReceive('setUser')->atLeast()->once();
'active' => 1,
'encrypted' => 0, // mock calls:
] $accountRepos->shouldReceive('getMetaValue')->withArgs([Mockery::any(), 'currency_id'])->atLeast()->once()->andReturn(1);
); $currencyRepos->shouldReceive('findNull')->withArgs([1])->atLeast()->once()->andReturn(TransactionCurrency::find(1));
$piggy = PiggyBank::create( $piggyRepos->shouldReceive('getTransactionWithEvent')->atLeast()->once()->andReturn(123);
[
'account_id' => $account->id, $event = PiggyBankEvent::first();
'name' => 'Some random piggy #' . random_int(1, 10000), $transformer = app(PiggyBankEventTransformer::class);
'targetamount' => '1000', $transformer->setParameters(new ParameterBag);
'startdate' => '2018-01-01',
'targetdate' => '2018-01-31',
'order' => 1,
'active' => 1,
]
);
$event = PiggyBankEvent::create(
[
'piggy_bank_id' => $piggy->id,
'date' => '2018-01-01',
'amount' => '123.45',
]
);
$transformer = new PiggyBankEventTransformer(new ParameterBag);
$result = $transformer->transform($event); $result = $transformer->transform($event);
$this->assertEquals($event->id, $result['id']); $this->assertEquals($event->id, $result['id']);
$this->assertEquals(123.45, $result['amount']); $this->assertEquals(245, $result['amount']);
$this->assertEquals(123, $result['transaction_id']);
} }
/** /**
* Basic test with currency meta data. * Basic test with no currency info.
* *
* @covers \FireflyIII\Transformers\PiggyBankEventTransformer * @covers \FireflyIII\Transformers\PiggyBankEventTransformer
*/ */
public function testBasicCurrency(): void public function testNoCurrency(): void
{ {
// mock repository. // repositories
$repository = $this->mock(CurrencyRepositoryInterface::class); $currencyRepos = $this->mock(CurrencyRepositoryInterface::class);
$repository->shouldReceive('setUser')->once(); $piggyRepos = $this->mock(PiggyBankRepositoryInterface::class);
$repository->shouldReceive('findNull')->withArgs([1])->andReturn(TransactionCurrency::find(1))->once(); $accountRepos = $this->mock(AccountRepositoryInterface::class);
// make new account: $currencyRepos->shouldReceive('setUser')->atLeast()->once();
$account = Account::create( $piggyRepos->shouldReceive('setUser')->atLeast()->once();
[ $accountRepos->shouldReceive('setUser')->atLeast()->once();
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . random_int(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
// meta // mock calls:
$accountMeta = AccountMeta::create( $accountRepos->shouldReceive('getMetaValue')->withArgs([Mockery::any(), 'currency_id'])->atLeast()->once()->andReturn(1);
[ $currencyRepos->shouldReceive('findNull')->withArgs([1])->atLeast()->once()->andReturn(null);
'account_id' => $account->id, $piggyRepos->shouldReceive('getTransactionWithEvent')->atLeast()->once()->andReturn(123);
'name' => 'currency_id',
'data' => 1,
]
);
$piggy = PiggyBank::create( Amount::shouldReceive('getDefaultCurrencyByUser')->andReturn(TransactionCurrency::find(1))->atLeast()->once();
[
'account_id' => $account->id, $event = PiggyBankEvent::first();
'name' => 'Some random piggy #' . random_int(1, 10000), $transformer = app(PiggyBankEventTransformer::class);
'targetamount' => '1000', $transformer->setParameters(new ParameterBag);
'startdate' => '2018-01-01',
'targetdate' => '2018-01-31',
'order' => 1,
'active' => 1,
]
);
$event = PiggyBankEvent::create(
[
'piggy_bank_id' => $piggy->id,
'date' => '2018-01-01',
'amount' => '123.45',
]
);
$transformer = new PiggyBankEventTransformer(new ParameterBag);
$result = $transformer->transform($event); $result = $transformer->transform($event);
$this->assertEquals($event->id, $result['id']); $this->assertEquals($event->id, $result['id']);
$this->assertEquals(123.45, $result['amount']); $this->assertEquals(245, $result['amount']);
} $this->assertEquals(123, $result['transaction_id']);
}
} }

View File

@@ -23,16 +23,16 @@ declare(strict_types=1);
namespace Tests\Unit\Transformers; namespace Tests\Unit\Transformers;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountMeta;
use FireflyIII\Models\Note;
use FireflyIII\Models\PiggyBank; use FireflyIII\Models\PiggyBank;
use FireflyIII\Models\TransactionCurrency; use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface; use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface; use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
use FireflyIII\Transformers\PiggyBankTransformer; use FireflyIII\Transformers\PiggyBankTransformer;
use Mockery;
use Symfony\Component\HttpFoundation\ParameterBag; use Symfony\Component\HttpFoundation\ParameterBag;
use Tests\TestCase; use Tests\TestCase;
use Amount;
/** /**
* Class PiggyBankTransformerTest * Class PiggyBankTransformerTest
@@ -46,168 +46,78 @@ class PiggyBankTransformerTest extends TestCase
*/ */
public function testBasic(): void public function testBasic(): void
{ {
// mock repository: // mock repositories
$repository = $this->mock(PiggyBankRepositoryInterface::class); $piggyRepos = $this->mock(PiggyBankRepositoryInterface::class);
$repository->shouldReceive('setUser')->once(); $accountRepos = $this->mock(AccountRepositoryInterface::class);
$repository->shouldReceive('getCurrentAmount')->andReturn('12.34')->once();
$repository->shouldReceive('getSuggestedMonthlyAmount')->andReturn('12.34')->once();
// make new account and piggy
$account = Account::create(
[
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . random_int(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
$piggy = PiggyBank::create(
[
'account_id' => $account->id,
'name' => 'Some random piggy #' . random_int(1, 10000),
'targetamount' => '1000',
'startdate' => '2018-01-01',
'targetdate' => '2018-01-31',
'order' => 1,
'active' => 1,
]
);
$transformer = new PiggyBankTransformer(new ParameterBag);
$result = $transformer->transform($piggy);
$this->assertTrue($result['active']);
$this->assertEquals(12.34, $result['current_amount']);
$this->assertEquals($piggy->name, $result['name']);
$this->assertEquals('', $result['notes']);
}
/**
* Test basic transformer with currency preference
*
* @covers \FireflyIII\Transformers\PiggyBankTransformer()
*/
public function testBasicWithCurrency(): void
{
// mock repository.
$currencyRepos = $this->mock(CurrencyRepositoryInterface::class); $currencyRepos = $this->mock(CurrencyRepositoryInterface::class);
$currencyRepos->shouldReceive('setUser')->once();
$currencyRepos->shouldReceive('findNull')->withArgs([1])->andReturn(TransactionCurrency::find(1))->once();
// mock calls:
$piggyRepos->shouldReceive('setUser')->atLeast()->once();
$accountRepos->shouldReceive('setUser')->atLeast()->once();
$currencyRepos->shouldReceive('setUser')->atLeast()->once();
// mock repository: // return a currency
$repository = $this->mock(PiggyBankRepositoryInterface::class); $accountRepos->shouldReceive('getMetaValue')->withArgs([Mockery::any(), 'currency_id'])->atLeast()->once()->andReturn('1');
$repository->shouldReceive('setUser')->once(); $currencyRepos->shouldReceive('findNull')->withArgs([1])->atLeast()->once()->andReturn(TransactionCurrency::find(1));
$repository->shouldReceive('getCurrentAmount')->andReturn('12.34')->once();
$repository->shouldReceive('getSuggestedMonthlyAmount')->andReturn('12.34')->once();
// make new account and piggy // get a note
$account = Account::create( $piggyRepos->shouldReceive('getNoteText')->atLeast()->once()->andReturn('I am a note.');
[
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . random_int(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
// meta
$accountMeta = AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'currency_id',
'data' => 1,
]
);
$piggy = PiggyBank::create( // get some amounts
[ $piggyRepos->shouldReceive('getCurrentAmount')->atLeast()->once()->andReturn('123.45');
'account_id' => $account->id, $piggyRepos->shouldReceive('getSuggestedMonthlyAmount')->atLeast()->once()->andReturn('12.45');
'name' => 'Some random piggy #' . random_int(1, 10000),
'targetamount' => '1000', /** @var PiggyBankTransformer $transformer */
'startdate' => '2018-01-01', $transformer = app(PiggyBankTransformer::class);
'targetdate' => '2018-01-31', $transformer->setParameters(new ParameterBag());
'order' => 1,
'active' => 1, $piggy = PiggyBank::first();
]
);
$transformer = new PiggyBankTransformer(new ParameterBag);
$result = $transformer->transform($piggy); $result = $transformer->transform($piggy);
$this->assertTrue($result['active']);
$this->assertEquals(12.34, $result['current_amount']); $this->assertEquals(12.45, $result['save_per_month']);
$this->assertEquals($piggy->name, $result['name']); $this->assertEquals($piggy->name, $result['name']);
$this->assertEquals('', $result['notes']); $this->assertEquals(1, $result['currency_id']);
} }
/** /**
* Test basic transformer with currency preference and a note * Test basic transformer.
* *
* @covers \FireflyIII\Transformers\PiggyBankTransformer * @covers \FireflyIII\Transformers\PiggyBankTransformer
*/ */
public function testBasicWithCurrencyAndNote(): void public function testNoCurrency(): void
{ {
// mock repository. // mock repositories
$piggyRepos = $this->mock(PiggyBankRepositoryInterface::class);
$accountRepos = $this->mock(AccountRepositoryInterface::class);
$currencyRepos = $this->mock(CurrencyRepositoryInterface::class); $currencyRepos = $this->mock(CurrencyRepositoryInterface::class);
$currencyRepos->shouldReceive('setUser')->once();
$currencyRepos->shouldReceive('findNull')->withArgs([1])->andReturn(TransactionCurrency::find(1))->once();
// mock repository: // mock calls:
$repository = $this->mock(PiggyBankRepositoryInterface::class); $piggyRepos->shouldReceive('setUser')->atLeast()->once();
$repository->shouldReceive('setUser')->once(); $accountRepos->shouldReceive('setUser')->atLeast()->once();
$repository->shouldReceive('getCurrentAmount')->andReturn('12.34')->once(); $currencyRepos->shouldReceive('setUser')->atLeast()->once();
$repository->shouldReceive('getSuggestedMonthlyAmount')->andReturn('12.34')->once();
// make new account and piggy // return a currency
$account = Account::create( $accountRepos->shouldReceive('getMetaValue')->withArgs([Mockery::any(), 'currency_id'])->atLeast()->once()->andReturn('1');
[ $currencyRepos->shouldReceive('findNull')->withArgs([1])->atLeast()->once()->andReturn(null);
'user_id' => $this->user()->id, Amount::shouldReceive('getDefaultCurrencyByUser')->atLeast()->once()->andReturn(TransactionCurrency::find(1));
'account_type_id' => 3, // asset account
'name' => 'Random name #' . random_int(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
// meta
$accountMeta = AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'currency_id',
'data' => 1,
]
);
$piggy = PiggyBank::create( // get a note
[ $piggyRepos->shouldReceive('getNoteText')->atLeast()->once()->andReturn('I am a note.');
'account_id' => $account->id,
'name' => 'Some random piggy #' . random_int(1, 10000),
'targetamount' => '1000',
'startdate' => '2018-01-01',
'targetdate' => '2018-01-31',
'order' => 1,
'active' => 1,
]
);
// note: // get some amounts
Note::create( $piggyRepos->shouldReceive('getCurrentAmount')->atLeast()->once()->andReturn('123.45');
[ $piggyRepos->shouldReceive('getSuggestedMonthlyAmount')->atLeast()->once()->andReturn('12.45');
'noteable_id' => $piggy->id,
'noteable_type' => PiggyBank::class, /** @var PiggyBankTransformer $transformer */
'title' => null, $transformer = app(PiggyBankTransformer::class);
'text' => 'I am a note.', $transformer->setParameters(new ParameterBag());
]
); $piggy = PiggyBank::first();
$transformer = new PiggyBankTransformer(new ParameterBag);
$result = $transformer->transform($piggy); $result = $transformer->transform($piggy);
$this->assertTrue($result['active']);
$this->assertEquals(12.34, $result['current_amount']); $this->assertEquals(12.45, $result['save_per_month']);
$this->assertEquals($piggy->name, $result['name']); $this->assertEquals($piggy->name, $result['name']);
$this->assertEquals('I am a note.', $result['notes']); $this->assertEquals(1, $result['currency_id']);
} }
} }