mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 18:54:58 +00:00
327 lines
14 KiB
PHP
327 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* MetaPieChartTest.php
|
|
* Copyright (c) 2017 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 Tests\Unit\Helpers;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Helpers\Chart\MetaPieChart;
|
|
use FireflyIII\Helpers\Collector\JournalCollectorInterface;
|
|
use FireflyIII\Helpers\Filter\NegativeAmountFilter;
|
|
use FireflyIII\Helpers\Filter\OpposingAccountFilter;
|
|
use FireflyIII\Helpers\Filter\PositiveAmountFilter;
|
|
use FireflyIII\Helpers\Filter\TransferFilter;
|
|
use FireflyIII\Models\Account;
|
|
use FireflyIII\Models\Transaction;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use Illuminate\Support\Collection;
|
|
use Tests\TestCase;
|
|
|
|
/**
|
|
* Class MetaPieChartTest
|
|
*
|
|
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
|
|
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
|
|
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
|
|
*/
|
|
class MetaPieChartTest extends TestCase
|
|
{
|
|
/**
|
|
* @covers \FireflyIII\Helpers\Chart\MetaPieChart
|
|
*/
|
|
public function testGenerateExpenseAccount()
|
|
{
|
|
$som = (new Carbon())->startOfMonth();
|
|
$eom = (new Carbon())->endOfMonth();
|
|
$collection = $this->fakeTransactions();
|
|
$accounts = [
|
|
1 => factory(Account::class)->make(),
|
|
2 => factory(Account::class)->make(),
|
|
];
|
|
|
|
// mock collector so the correct set of journals is returned:
|
|
// then verify the results.
|
|
$collector = $this->mock(JournalCollectorInterface::class);
|
|
|
|
$collector->shouldReceive('addFilter')->withArgs([PositiveAmountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('removeFilter')->withArgs([NegativeAmountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('addFilter')->withArgs([NegativeAmountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('addFilter')->withArgs([OpposingAccountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('setUser')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setAccounts')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setRange')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setBudgets')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setCategories')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setTypes')->withArgs([[TransactionType::WITHDRAWAL, TransactionType::TRANSFER]])->andReturnSelf()->once();
|
|
$collector->shouldReceive('withOpposingAccount')->andReturnSelf()->once();
|
|
$collector->shouldReceive('getJournals')->andReturn($collection);
|
|
|
|
// mock all repositories:
|
|
$accountRepos = $this->mock(AccountRepositoryInterface::class);
|
|
|
|
$accountRepos->shouldReceive('setUser');
|
|
$accountRepos->shouldReceive('find')->withArgs([1])->andReturn($accounts[1]);
|
|
$accountRepos->shouldReceive('find')->withArgs([2])->andReturn($accounts[2]);
|
|
|
|
$helper = new MetaPieChart();
|
|
$helper->setUser($this->user());
|
|
$helper->setStart($som);
|
|
$helper->setEnd($eom);
|
|
$chart = $helper->generate('expense', 'account');
|
|
|
|
// since the set is pretty basic the result is easy to validate:
|
|
$keys = array_keys($chart);
|
|
$this->assertEquals($keys[0], $accounts[1]->name);
|
|
$this->assertEquals($keys[1], $accounts[2]->name);
|
|
$this->assertTrue(0 === bccomp('1000', $chart[$accounts[1]->name]));
|
|
$this->assertTrue(0 === bccomp('1000', $chart[$accounts[2]->name]));
|
|
|
|
$this->assertTrue(true);
|
|
}
|
|
|
|
/**
|
|
* @covers \FireflyIII\Helpers\Chart\MetaPieChart
|
|
*/
|
|
public function testGenerateExpenseAccountWithOthers()
|
|
{
|
|
$som = (new Carbon())->startOfMonth();
|
|
$eom = (new Carbon())->endOfMonth();
|
|
$collection = $this->fakeTransactions();
|
|
$others = $this->fakeOthers();
|
|
$accounts = [
|
|
1 => factory(Account::class)->make(),
|
|
2 => factory(Account::class)->make(),
|
|
];
|
|
|
|
// mock collector so the correct set of journals is returned:
|
|
// then verify the results.
|
|
$collector = $this->mock(JournalCollectorInterface::class);
|
|
$collector->shouldReceive('addFilter')->withArgs([NegativeAmountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('addFilter')->withArgs([PositiveAmountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('addFilter')->withArgs([OpposingAccountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('removeFilter')->withArgs([NegativeAmountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('setUser')->andReturnSelf()->twice();
|
|
$collector->shouldReceive('setAccounts')->andReturnSelf()->twice();
|
|
$collector->shouldReceive('setRange')->andReturnSelf()->twice();
|
|
$collector->shouldReceive('setBudgets')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setCategories')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setTypes')->withArgs([[TransactionType::WITHDRAWAL, TransactionType::TRANSFER]])->andReturnSelf()->once();
|
|
$collector->shouldReceive('withOpposingAccount')->andReturnSelf()->once();
|
|
$collector->shouldReceive('getJournals')->andReturn($collection)->once();
|
|
|
|
$collector->shouldReceive('setTypes')->withArgs([[TransactionType::WITHDRAWAL]])->andReturnSelf()->once();
|
|
$collector->shouldReceive('getJournals')->andReturn($others)->once();
|
|
|
|
// mock all repositories:
|
|
$accountRepos = $this->mock(AccountRepositoryInterface::class);
|
|
|
|
$accountRepos->shouldReceive('setUser');
|
|
$accountRepos->shouldReceive('find')->withArgs([1])->andReturn($accounts[1]);
|
|
$accountRepos->shouldReceive('find')->withArgs([2])->andReturn($accounts[2]);
|
|
|
|
$helper = new MetaPieChart();
|
|
$helper->setCollectOtherObjects(true);
|
|
$helper->setUser($this->user());
|
|
$helper->setStart($som);
|
|
$helper->setEnd($eom);
|
|
$chart = $helper->generate('expense', 'account');
|
|
|
|
// since the set is pretty basic the result is easy to validate:
|
|
$keys = array_keys($chart);
|
|
$this->assertEquals($keys[0], $accounts[1]->name);
|
|
$this->assertEquals($keys[1], $accounts[2]->name);
|
|
$this->assertTrue(0 === bccomp('1000', $chart[$accounts[1]->name]));
|
|
$this->assertTrue(0 === bccomp('1000', $chart[$accounts[2]->name]));
|
|
$this->assertTrue(0 === bccomp('-5000', $chart['Everything else']));
|
|
|
|
$this->assertTrue(true);
|
|
}
|
|
|
|
|
|
/**
|
|
* @covers \FireflyIII\Helpers\Chart\MetaPieChart
|
|
*/
|
|
public function testGenerateIncomeAccount()
|
|
{
|
|
$som = (new Carbon())->startOfMonth();
|
|
$eom = (new Carbon())->endOfMonth();
|
|
$collection = $this->fakeTransactions();
|
|
$accounts = [
|
|
1 => factory(Account::class)->make(),
|
|
2 => factory(Account::class)->make(),
|
|
];
|
|
|
|
// mock collector so the correct set of journals is returned:
|
|
// then verify the results.
|
|
$collector = $this->mock(JournalCollectorInterface::class);
|
|
|
|
$collector->shouldReceive('addFilter')->withArgs([NegativeAmountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('addFilter')->withArgs([OpposingAccountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('removeFilter')->withArgs([TransferFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('setUser')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setAccounts')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setRange')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setBudgets')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setCategories')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setTypes')->withArgs([[TransactionType::DEPOSIT, TransactionType::TRANSFER]])->andReturnSelf()->once();
|
|
$collector->shouldReceive('withOpposingAccount')->andReturnSelf()->once();
|
|
$collector->shouldReceive('getJournals')->andReturn($collection);
|
|
|
|
// mock all repositories:
|
|
$accountRepos = $this->mock(AccountRepositoryInterface::class);
|
|
|
|
$accountRepos->shouldReceive('setUser');
|
|
$accountRepos->shouldReceive('find')->withArgs([1])->andReturn($accounts[1]);
|
|
$accountRepos->shouldReceive('find')->withArgs([2])->andReturn($accounts[2]);
|
|
|
|
$helper = new MetaPieChart();
|
|
$helper->setUser($this->user());
|
|
$helper->setStart($som);
|
|
$helper->setEnd($eom);
|
|
$chart = $helper->generate('income', 'account');
|
|
|
|
// since the set is pretty basic the result is easy to validate:
|
|
$keys = array_keys($chart);
|
|
$this->assertEquals($keys[0], $accounts[1]->name);
|
|
$this->assertEquals($keys[1], $accounts[2]->name);
|
|
$this->assertTrue(0 === bccomp('1000', $chart[$accounts[1]->name]));
|
|
$this->assertTrue(0 === bccomp('1000', $chart[$accounts[2]->name]));
|
|
|
|
$this->assertTrue(true);
|
|
}
|
|
|
|
/**
|
|
* @covers \FireflyIII\Helpers\Chart\MetaPieChart
|
|
*/
|
|
public function testGenerateIncomeAccountWithOthers()
|
|
{
|
|
$som = (new Carbon())->startOfMonth();
|
|
$eom = (new Carbon())->endOfMonth();
|
|
$collection = $this->fakeTransactions();
|
|
$others = $this->fakeOthers();
|
|
$accounts = [
|
|
1 => factory(Account::class)->make(),
|
|
2 => factory(Account::class)->make(),
|
|
];
|
|
|
|
// mock collector so the correct set of journals is returned:
|
|
// then verify the results.
|
|
$collector = $this->mock(JournalCollectorInterface::class);
|
|
$collector->shouldReceive('addFilter')->withArgs([NegativeAmountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('addFilter')->withArgs([OpposingAccountFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('removeFilter')->withArgs([TransferFilter::class])->andReturnSelf()->once();
|
|
$collector->shouldReceive('setUser')->andReturnSelf()->twice();
|
|
$collector->shouldReceive('setAccounts')->andReturnSelf()->twice();
|
|
$collector->shouldReceive('setRange')->andReturnSelf()->twice();
|
|
$collector->shouldReceive('setBudgets')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setCategories')->andReturnSelf()->once();
|
|
$collector->shouldReceive('setTypes')->withArgs([[TransactionType::DEPOSIT, TransactionType::TRANSFER]])->andReturnSelf()->once();
|
|
$collector->shouldReceive('withOpposingAccount')->andReturnSelf()->once();
|
|
$collector->shouldReceive('getJournals')->andReturn($collection)->once();
|
|
|
|
$collector->shouldReceive('setTypes')->withArgs([[TransactionType::DEPOSIT]])->andReturnSelf()->once();
|
|
$collector->shouldReceive('getJournals')->andReturn($others)->once();
|
|
|
|
// mock all repositories:
|
|
$accountRepos = $this->mock(AccountRepositoryInterface::class);
|
|
|
|
$accountRepos->shouldReceive('setUser');
|
|
$accountRepos->shouldReceive('find')->withArgs([1])->andReturn($accounts[1]);
|
|
$accountRepos->shouldReceive('find')->withArgs([2])->andReturn($accounts[2]);
|
|
|
|
$helper = new MetaPieChart();
|
|
$helper->setCollectOtherObjects(true);
|
|
$helper->setUser($this->user());
|
|
$helper->setStart($som);
|
|
$helper->setEnd($eom);
|
|
$chart = $helper->generate('income', 'account');
|
|
|
|
// since the set is pretty basic the result is easy to validate:
|
|
$keys = array_keys($chart);
|
|
$this->assertEquals($keys[0], $accounts[1]->name);
|
|
$this->assertEquals($keys[1], $accounts[2]->name);
|
|
$this->assertTrue(0 === bccomp('1000', $chart[$accounts[1]->name]));
|
|
$this->assertTrue(0 === bccomp('1000', $chart[$accounts[2]->name]));
|
|
$this->assertTrue(0 === bccomp('1000', $chart['Everything else']));
|
|
|
|
$this->assertTrue(true);
|
|
}
|
|
|
|
/**
|
|
* @return Collection
|
|
*/
|
|
private function fakeOthers(): Collection
|
|
{
|
|
$set = new Collection;
|
|
|
|
for ($i = 0; $i < 30; ++$i) {
|
|
$transaction = new Transaction;
|
|
|
|
// basic fields.
|
|
$transaction->opposing_account_id = 3;
|
|
$transaction->transaction_journal_budget_id = 3;
|
|
$transaction->transaction_budget_id = 3;
|
|
$transaction->transaction_journal_category_id = 3;
|
|
$transaction->transaction_category_id = 3;
|
|
$transaction->transaction_amount = '100';
|
|
$set->push($transaction);
|
|
}
|
|
|
|
return $set;
|
|
}
|
|
|
|
/**
|
|
* @return Collection
|
|
*/
|
|
private function fakeTransactions(): Collection
|
|
{
|
|
$set = new Collection;
|
|
for ($i = 0; $i < 10; ++$i) {
|
|
$transaction = new Transaction;
|
|
|
|
// basic fields.
|
|
$transaction->opposing_account_id = 1;
|
|
$transaction->transaction_journal_budget_id = 1;
|
|
$transaction->transaction_budget_id = 1;
|
|
$transaction->transaction_journal_category_id = 1;
|
|
$transaction->transaction_category_id = 1;
|
|
$transaction->transaction_amount = '100';
|
|
$set->push($transaction);
|
|
}
|
|
|
|
for ($i = 0; $i < 10; ++$i) {
|
|
$transaction = new Transaction;
|
|
|
|
// basic fields.
|
|
$transaction->opposing_account_id = 2;
|
|
$transaction->transaction_journal_budget_id = 2;
|
|
$transaction->transaction_budget_id = 2;
|
|
$transaction->transaction_journal_category_id = 2;
|
|
$transaction->transaction_category_id = 2;
|
|
$transaction->transaction_amount = '100';
|
|
$set->push($transaction);
|
|
}
|
|
|
|
return $set;
|
|
}
|
|
}
|