Moved more code around.

2024-12-28 09:51:21 -06:00 · 2016-01-27 21:35:59 +01:00 · 2016-01-27 21:35:59 +01:00 · 57a3f20c13
commit 57a3f20c13
parent eab2c57594
6 changed files with 279 additions and 209 deletions
--- a/app/Helpers/Report/BalanceReportHelper.php
+++ b/app/Helpers/Report/BalanceReportHelper.php
@ -0,0 +1,242 @@
+<?php
+/**
+ * BalanceReportHelper.php
+ * Copyright (C) 2016 Sander Dorigo
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license.  See the LICENSE file for details.
+ */
+
+namespace FireflyIII\Helpers\Report;
+
+use Carbon\Carbon;
+use FireflyIII\Helpers\Collection\Balance;
+use FireflyIII\Helpers\Collection\BalanceEntry;
+use FireflyIII\Helpers\Collection\BalanceHeader;
+use FireflyIII\Helpers\Collection\BalanceLine;
+use FireflyIII\Models\Budget;
+use FireflyIII\Models\Budget as BudgetModel;
+use FireflyIII\Models\Tag;
+use FireflyIII\Models\TransactionJournal;
+use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
+use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use Illuminate\Support\Collection;
+
+
+/**
+ * Class BalanceReportHelper
+ *
+ * @package FireflyIII\Helpers\Report
+ */
+class BalanceReportHelper implements BalanceReportHelperInterface
+{
+
+    /** @var  BudgetRepositoryInterface */
+    protected $budgetRepository;
+    /** @var  TagRepositoryInterface */
+    protected $tagRepository;
+
+    /**
+     * ReportHelper constructor.
+     *
+     * @codeCoverageIgnore
+     *
+     * @param ReportQueryInterface      $query
+     * @param BudgetRepositoryInterface $budgetRepository
+     * @param TagRepositoryInterface    $tagRepository
+     */
+    public function __construct(ReportQueryInterface $query, BudgetRepositoryInterface $budgetRepository, TagRepositoryInterface $tagRepository)
+    {
+        $this->budgetRepository = $budgetRepository;
+        $this->tagRepository    = $tagRepository;
+    }
+
+
+    /**
+     * @param Carbon     $start
+     * @param Carbon     $end
+     * @param Collection $accounts
+     *
+     * @return Balance
+     */
+    public function getBalanceReport(Carbon $start, Carbon $end, Collection $accounts)
+    {
+        $balance = new Balance;
+
+        // build a balance header:
+        $header    = new BalanceHeader;
+        $budgets   = $this->budgetRepository->getBudgetsAndLimitsInRange($start, $end);
+        $spentData = $this->budgetRepository->spentPerBudgetPerAccount($budgets, $accounts, $start, $end);
+        foreach ($accounts as $account) {
+            $header->addAccount($account);
+        }
+
+        /** @var BudgetModel $budget */
+        foreach ($budgets as $budget) {
+            $balance->addBalanceLine($this->createBalanceLine($budget, $accounts, $spentData));
+        }
+
+        $balance->addBalanceLine($this->createEmptyBalanceLine($accounts, $spentData));
+        $balance->addBalanceLine($this->createTagsBalanceLine($accounts, $start, $end));
+        $balance->addBalanceLine($this->createDifferenceBalanceLine($accounts, $spentData, $start, $end));
+
+        $balance->setBalanceHeader($header);
+
+        return $balance;
+    }
+
+
+    /**
+     * @param Budget     $budget
+     * @param Collection $accounts
+     * @param Collection $spentData
+     *
+     * @return BalanceLine
+     */
+    private function createBalanceLine(BudgetModel $budget, Collection $accounts, Collection $spentData)
+    {
+        $line = new BalanceLine;
+        $line->setBudget($budget);
+
+        // loop accounts:
+        foreach ($accounts as $account) {
+            $balanceEntry = new BalanceEntry;
+            $balanceEntry->setAccount($account);
+
+            // get spent:
+            $entry = $spentData->filter(
+                function (TransactionJournal $model) use ($budget, $account) {
+                    return $model->account_id == $account->id && $model->budget_id == $budget->id;
+                }
+            );
+            $spent = 0;
+            if (!is_null($entry->first())) {
+                $spent = $entry->first()->spent;
+            }
+            $balanceEntry->setSpent($spent);
+            $line->addBalanceEntry($balanceEntry);
+        }
+
+        return $line;
+    }
+
+    /**
+     * @param Collection $accounts
+     * @param Collection $spentData
+     * @param Carbon     $start
+     * @param Carbon     $end
+     *
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     *
+     * @return BalanceLine
+     */
+    private function createDifferenceBalanceLine(Collection $accounts, Collection $spentData, Carbon $start, Carbon $end)
+    {
+        $diff     = new BalanceLine;
+        $tagsLeft = $this->tagRepository->allCoveredByBalancingActs($accounts, $start, $end);
+
+        $diff->setRole(BalanceLine::ROLE_DIFFROLE);
+
+        foreach ($accounts as $account) {
+            $entry = $spentData->filter(
+                function (TransactionJournal $model) use ($account) {
+                    return $model->account_id == $account->id && is_null($model->budget_id);
+                }
+            );
+            $spent = 0;
+            if (!is_null($entry->first())) {
+                $spent = $entry->first()->spent;
+            }
+            $leftEntry = $tagsLeft->filter(
+                function (Tag $tag) use ($account) {
+                    return $tag->account_id == $account->id;
+                }
+            );
+            $left      = 0;
+            if (!is_null($leftEntry->first())) {
+                $left = $leftEntry->first()->sum;
+            }
+            bcscale(2);
+            $diffValue = bcadd($spent, $left);
+
+            // difference:
+            $diffEntry = new BalanceEntry;
+            $diffEntry->setAccount($account);
+            $diffEntry->setSpent($diffValue);
+            $diff->addBalanceEntry($diffEntry);
+
+        }
+
+        return $diff;
+    }
+
+    /**
+     * @param Collection $accounts
+     * @param Collection $spentData
+     *
+     * @return BalanceLine
+     */
+    private function createEmptyBalanceLine(Collection $accounts, Collection $spentData)
+    {
+        $empty = new BalanceLine;
+
+        foreach ($accounts as $account) {
+            $entry = $spentData->filter(
+                function (TransactionJournal $model) use ($account) {
+                    return $model->account_id == $account->id && is_null($model->budget_id);
+                }
+            );
+            $spent = 0;
+            if (!is_null($entry->first())) {
+                $spent = $entry->first()->spent;
+            }
+
+            // budget
+            $budgetEntry = new BalanceEntry;
+            $budgetEntry->setAccount($account);
+            $budgetEntry->setSpent($spent);
+            $empty->addBalanceEntry($budgetEntry);
+
+        }
+
+        return $empty;
+    }
+
+    /**
+     * @param Collection $accounts
+     * @param Carbon     $start
+     * @param Carbon     $end
+     *
+     * @return BalanceLine
+     */
+    private function createTagsBalanceLine(Collection $accounts, Carbon $start, Carbon $end)
+    {
+        $tags     = new BalanceLine;
+        $tagsLeft = $this->tagRepository->allCoveredByBalancingActs($accounts, $start, $end);
+
+        $tags->setRole(BalanceLine::ROLE_TAGROLE);
+
+        foreach ($accounts as $account) {
+            $leftEntry = $tagsLeft->filter(
+                function (Tag $tag) use ($account) {
+                    return $tag->account_id == $account->id;
+                }
+            );
+            $left      = 0;
+            if (!is_null($leftEntry->first())) {
+                $left = $leftEntry->first()->sum;
+            }
+            bcscale(2);
+
+            // balanced by tags
+            $tagEntry = new BalanceEntry;
+            $tagEntry->setAccount($account);
+            $tagEntry->setLeft($left);
+            $tags->addBalanceEntry($tagEntry);
+
+        }
+
+        return $tags;
+    }
+
+}
--- a/app/Helpers/Report/BalanceReportHelperInterface.php
+++ b/app/Helpers/Report/BalanceReportHelperInterface.php
@ -0,0 +1,32 @@
+<?php
+/**
+ * BalanceReportHelperInterface.php
+ * Copyright (C) 2016 Sander Dorigo
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license.  See the LICENSE file for details.
+ */
+
+namespace FireflyIII\Helpers\Report;
+
+use Carbon\Carbon;
+use FireflyIII\Helpers\Collection\Balance;
+use Illuminate\Support\Collection;
+
+
+/**
+ * Interface BalanceReportHelperInterface
+ *
+ * @package FireflyIII\Helpers\Report
+ */
+interface BalanceReportHelperInterface
+{
+    /**
+     * @param Carbon     $start
+     * @param Carbon     $end
+     * @param Collection $accounts
+     *
+     * @return Balance
+     */
+    public function getBalanceReport(Carbon $start, Carbon $end, Collection $accounts);
+}
--- a/app/Helpers/Report/ReportHelper.php
+++ b/app/Helpers/Report/ReportHelper.php
@ -3,23 +3,13 @@
 namespace FireflyIII\Helpers\Report;

 use Carbon\Carbon;
-use FireflyIII\Helpers\Collection\Balance;
-use FireflyIII\Helpers\Collection\BalanceEntry;
-use FireflyIII\Helpers\Collection\BalanceHeader;
-use FireflyIII\Helpers\Collection\BalanceLine;
 use FireflyIII\Helpers\Collection\Bill as BillCollection;
 use FireflyIII\Helpers\Collection\BillLine;
-use FireflyIII\Helpers\Collection\Budget as BudgetCollection;
-use FireflyIII\Helpers\Collection\BudgetLine;
 use FireflyIII\Helpers\Collection\Category as CategoryCollection;
 use FireflyIII\Helpers\Collection\Expense;
 use FireflyIII\Helpers\Collection\Income;
 use FireflyIII\Helpers\FiscalHelper;
 use FireflyIII\Models\Bill;
-use FireflyIII\Models\Budget;
-use FireflyIII\Models\Budget as BudgetModel;
-use FireflyIII\Models\LimitRepetition;
-use FireflyIII\Models\Tag;
 use FireflyIII\Models\TransactionJournal;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
@ -56,39 +46,6 @@ class ReportHelper implements ReportHelperInterface
        $this->tagRepository    = $tagRepository;
    }

-    /**
-     * @param Carbon     $start
-     * @param Carbon     $end
-     * @param Collection $accounts
-     *
-     * @return Balance
-     */
-    public function getBalanceReport(Carbon $start, Carbon $end, Collection $accounts)
-    {
-        $balance = new Balance;
-
-        // build a balance header:
-        $header    = new BalanceHeader;
-        $budgets   = $this->budgetRepository->getBudgetsAndLimitsInRange($start, $end);
-        $spentData = $this->budgetRepository->spentPerBudgetPerAccount($budgets, $accounts, $start, $end);
-        foreach ($accounts as $account) {
-            $header->addAccount($account);
-        }
-
-        /** @var BudgetModel $budget */
-        foreach ($budgets as $budget) {
-            $balance->addBalanceLine($this->createBalanceLine($budget, $accounts, $spentData));
-        }
-
-        $balance->addBalanceLine($this->createEmptyBalanceLine($accounts, $spentData));
-        $balance->addBalanceLine($this->createTagsBalanceLine($accounts, $start, $end));
-        $balance->addBalanceLine($this->createDifferenceBalanceLine($accounts, $spentData, $start, $end));
-
-        $balance->setBalanceHeader($header);
-
-        return $balance;
-    }
-
    /**
     * This method generates a full report for the given period on all
     * the users bills and their payments.
@ -273,157 +230,4 @@ class ReportHelper implements ReportHelperInterface

        return $sum;
    }
-
-    /**
-     * @param Budget     $budget
-     * @param Collection $accounts
-     * @param Collection $spentData
-     *
-     * @return BalanceLine
-     */
-    private function createBalanceLine(BudgetModel $budget, Collection $accounts, Collection $spentData)
-    {
-        $line = new BalanceLine;
-        $line->setBudget($budget);
-
-        // loop accounts:
-        foreach ($accounts as $account) {
-            $balanceEntry = new BalanceEntry;
-            $balanceEntry->setAccount($account);
-
-            // get spent:
-            $entry = $spentData->filter(
-                function (TransactionJournal $model) use ($budget, $account) {
-                    return $model->account_id == $account->id && $model->budget_id == $budget->id;
-                }
-            );
-            $spent = 0;
-            if (!is_null($entry->first())) {
-                $spent = $entry->first()->spent;
-            }
-            $balanceEntry->setSpent($spent);
-            $line->addBalanceEntry($balanceEntry);
-        }
-
-        return $line;
-    }
-
-    /**
-     * @param Collection $accounts
-     * @param Collection $spentData
-     * @param Carbon     $start
-     * @param Carbon     $end
-     *
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     *
-     * @return BalanceLine
-     */
-    private function createDifferenceBalanceLine(Collection $accounts, Collection $spentData, Carbon $start, Carbon $end)
-    {
-        $diff     = new BalanceLine;
-        $tagsLeft = $this->tagRepository->allCoveredByBalancingActs($accounts, $start, $end);
-
-        $diff->setRole(BalanceLine::ROLE_DIFFROLE);
-
-        foreach ($accounts as $account) {
-            $entry = $spentData->filter(
-                function (TransactionJournal $model) use ($account) {
-                    return $model->account_id == $account->id && is_null($model->budget_id);
-                }
-            );
-            $spent = 0;
-            if (!is_null($entry->first())) {
-                $spent = $entry->first()->spent;
-            }
-            $leftEntry = $tagsLeft->filter(
-                function (Tag $tag) use ($account) {
-                    return $tag->account_id == $account->id;
-                }
-            );
-            $left      = 0;
-            if (!is_null($leftEntry->first())) {
-                $left = $leftEntry->first()->sum;
-            }
-            bcscale(2);
-            $diffValue = bcadd($spent, $left);
-
-            // difference:
-            $diffEntry = new BalanceEntry;
-            $diffEntry->setAccount($account);
-            $diffEntry->setSpent($diffValue);
-            $diff->addBalanceEntry($diffEntry);
-
-        }
-
-        return $diff;
-    }
-
-    /**
-     * @param Collection $accounts
-     * @param Collection $spentData
-     *
-     * @return BalanceLine
-     */
-    private function createEmptyBalanceLine(Collection $accounts, Collection $spentData)
-    {
-        $empty = new BalanceLine;
-
-        foreach ($accounts as $account) {
-            $entry = $spentData->filter(
-                function (TransactionJournal $model) use ($account) {
-                    return $model->account_id == $account->id && is_null($model->budget_id);
-                }
-            );
-            $spent = 0;
-            if (!is_null($entry->first())) {
-                $spent = $entry->first()->spent;
-            }
-
-            // budget
-            $budgetEntry = new BalanceEntry;
-            $budgetEntry->setAccount($account);
-            $budgetEntry->setSpent($spent);
-            $empty->addBalanceEntry($budgetEntry);
-
-        }
-
-        return $empty;
-    }
-
-    /**
-     * @param Collection $accounts
-     * @param Carbon     $start
-     * @param Carbon     $end
-     *
-     * @return BalanceLine
-     */
-    private function createTagsBalanceLine(Collection $accounts, Carbon $start, Carbon $end)
-    {
-        $tags     = new BalanceLine;
-        $tagsLeft = $this->tagRepository->allCoveredByBalancingActs($accounts, $start, $end);
-
-        $tags->setRole(BalanceLine::ROLE_TAGROLE);
-
-        foreach ($accounts as $account) {
-            $leftEntry = $tagsLeft->filter(
-                function (Tag $tag) use ($account) {
-                    return $tag->account_id == $account->id;
-                }
-            );
-            $left      = 0;
-            if (!is_null($leftEntry->first())) {
-                $left = $leftEntry->first()->sum;
-            }
-            bcscale(2);
-
-            // balanced by tags
-            $tagEntry = new BalanceEntry;
-            $tagEntry->setAccount($account);
-            $tagEntry->setLeft($left);
-            $tags->addBalanceEntry($tagEntry);
-
-        }
-
-        return $tags;
-    }
 }
--- a/app/Helpers/Report/ReportHelperInterface.php
+++ b/app/Helpers/Report/ReportHelperInterface.php
@ -3,9 +3,7 @@
 namespace FireflyIII\Helpers\Report;

 use Carbon\Carbon;
-use FireflyIII\Helpers\Collection\Balance;
 use FireflyIII\Helpers\Collection\Bill as BillCollection;
-use FireflyIII\Helpers\Collection\Budget as BudgetCollection;
 use FireflyIII\Helpers\Collection\Category as CategoryCollection;
 use FireflyIII\Helpers\Collection\Expense;
 use FireflyIII\Helpers\Collection\Income;
@ -18,14 +16,6 @@ use Illuminate\Support\Collection;
 */
 interface ReportHelperInterface
 {
-    /**
-     * @param Carbon     $start
-     * @param Carbon     $end
-     * @param Collection $accounts
-     *
-     * @return Balance
-     */
-    public function getBalanceReport(Carbon $start, Carbon $end, Collection $accounts);

    /**
     * This method generates a full report for the given period on all
--- a/app/Http/Controllers/ReportController.php
+++ b/app/Http/Controllers/ReportController.php
@ -18,9 +18,8 @@ class ReportController extends Controller


    protected $accountHelper;
-
+    protected $balanceHelper;
    protected $budgetHelper;
-
    /** @var ReportHelperInterface */
    protected $helper;

@ -36,6 +35,7 @@ class ReportController extends Controller
        $this->helper        = $helper;
        $this->accountHelper = app('FireflyIII\Helpers\Report\AccountReportHelperInterface');
        $this->budgetHelper  = app('FireflyIII\Helpers\Report\BudgetReportHelperInterface');
+        $this->balanceHelper = app('FireflyIII\Helpers\Report\BalanceReportHelperInterface');

        View::share('title', trans('firefly.reports'));
        View::share('mainTitleIcon', 'fa-line-chart');
@ -61,7 +61,7 @@ class ReportController extends Controller
        $expenses      = $this->helper->getExpenseReport($start, $end, $accounts); // done (+1)
        $budgets       = $this->budgetHelper->getBudgetReport($start, $end, $accounts); // done (+5)
        $categories    = $this->helper->getCategoryReport($start, $end, $accounts); // done (+1) (20)
-        $balance       = $this->helper->getBalanceReport($start, $end, $accounts); // +566
+        $balance       = $this->balanceHelper->getBalanceReport($start, $end, $accounts); // +566
        $bills         = $this->helper->getBillReport($start, $end, $accounts);

        // and some id's, joined:
--- a/app/Providers/FireflyServiceProvider.php
+++ b/app/Providers/FireflyServiceProvider.php
@ -117,6 +117,8 @@ class FireflyServiceProvider extends ServiceProvider

        // better report helper interfaces:
        $this->app->bind('FireflyIII\Helpers\Report\AccountReportHelperInterface', 'FireflyIII\Helpers\Report\AccountReportHelper');
+        $this->app->bind('FireflyIII\Helpers\Report\BalanceReportHelperInterface', 'FireflyIII\Helpers\Report\BalanceReportHelper');
+        $this->app->bind('FireflyIII\Helpers\Report\BudgetReportHelperInterface', 'FireflyIII\Helpers\Report\BudgetReportHelper');