From 1502aa3b207ca297009247eeb7b784d5c13ed278 Mon Sep 17 00:00:00 2001 From: James Cole Date: Sun, 15 Jul 2018 19:17:26 +0200 Subject: [PATCH] Small code cleanup [skip ci] --- .../Controllers/Budget/IndexController.php | 3 ++ .../Controllers/Chart/AccountController.php | 4 +-- .../Controllers/Chart/BudgetController.php | 34 ++++++++++++------- .../Chart/BudgetReportController.php | 6 ++++ 4 files changed, 32 insertions(+), 15 deletions(-) diff --git a/app/Http/Controllers/Budget/IndexController.php b/app/Http/Controllers/Budget/IndexController.php index f3a7b43188..557da042eb 100644 --- a/app/Http/Controllers/Budget/IndexController.php +++ b/app/Http/Controllers/Budget/IndexController.php @@ -76,7 +76,9 @@ class IndexController extends Controller public function index(Request $request, string $moment = null) { $range = app('preferences')->get('viewRange', '1M')->data; + /** @var Carbon $start */ $start = session('start', new Carbon); + /** @var Carbon $end */ $end = session('end', new Carbon); $page = 0 === (int)$request->get('page') ? 1 : (int)$request->get('page'); $pageSize = (int)app('preferences')->get('listPageSize', 50)->data; @@ -86,6 +88,7 @@ class IndexController extends Controller if ('' !== (string)$moment) { try { $start = new Carbon($moment); + /** @var Carbon $end */ $end = app('navigation')->endOfPeriod($start, $range); } catch (Exception $e) { // start and end are already defined. diff --git a/app/Http/Controllers/Chart/AccountController.php b/app/Http/Controllers/Chart/AccountController.php index 433a773d0b..a89db85f0c 100644 --- a/app/Http/Controllers/Chart/AccountController.php +++ b/app/Http/Controllers/Chart/AccountController.php @@ -433,8 +433,8 @@ class AccountController extends Controller * * @return array * - * @SuppressWarnigns(PHPMD.CyclomaticComplexity) - * @SuppressWarnigns(PHPMD.ExcessiveMethodLength) + * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * @SuppressWarnings(PHPMD.ExcessiveMethodLength) */ private function accountBalanceChart(Collection $accounts, Carbon $start, Carbon $end): array { diff --git a/app/Http/Controllers/Chart/BudgetController.php b/app/Http/Controllers/Chart/BudgetController.php index 1b8dba0c61..9586e0fe54 100644 --- a/app/Http/Controllers/Chart/BudgetController.php +++ b/app/Http/Controllers/Chart/BudgetController.php @@ -43,6 +43,9 @@ use Illuminate\Support\Collection; /** * Class BudgetController. * + * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) + * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * */ class BudgetController extends Controller { @@ -91,13 +94,11 @@ class BudgetController extends Controller return response()->json($cache->get()); // @codeCoverageIgnore } - // depending on diff, do something with range of chart. - $step = $this->calculateStep($start, $end); + $step = $this->calculateStep($start, $end); // depending on diff, do something with range of chart. $budgetCollection = new Collection([$budget]); $chartData = []; $current = clone $start; $current = app('navigation')->startOfPeriod($current, $step); - while ($end >= $current) { /** @var Carbon $currentEnd */ $currentEnd = app('navigation')->endOfPeriod($current, $step); @@ -172,6 +173,8 @@ class BudgetController extends Controller * @param BudgetLimit|null $budgetLimit * * @return JsonResponse + * + * @SuppressWarnings(PHPMD.CyclomaticComplexity) */ public function expenseAsset(Budget $budget, ?BudgetLimit $budgetLimit): JsonResponse { @@ -218,6 +221,8 @@ class BudgetController extends Controller * @param BudgetLimit|null $budgetLimit * * @return JsonResponse + * + * @SuppressWarnings(PHPMD.CyclomaticComplexity) */ public function expenseCategory(Budget $budget, ?BudgetLimit $budgetLimit): JsonResponse { @@ -253,7 +258,6 @@ class BudgetController extends Controller foreach ($result as $categoryId => $amount) { $chartData[$names[$categoryId]] = $amount; } - $data = $this->generator->pieChart($chartData); $cache->store($data); @@ -266,6 +270,8 @@ class BudgetController extends Controller * @param BudgetLimit|null $budgetLimit * * @return JsonResponse + * + * @SuppressWarnings(PHPMD.CyclomaticComplexity) */ public function expenseExpense(Budget $budget, ?BudgetLimit $budgetLimit): JsonResponse { @@ -312,6 +318,9 @@ class BudgetController extends Controller * Shows a budget list with spent/left/overspent. * * @return \Symfony\Component\HttpFoundation\Response + * + * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * @SuppressWarnings(PHPMD.ExcessiveMethodLength) */ public function frontpage(): \Symfony\Component\HttpFoundation\Response { @@ -524,6 +533,8 @@ class BudgetController extends Controller * @param Carbon $end * * @return array + * + * @SuppressWarnings(PHPMD.CyclomaticComplexity) */ private function getExpensesForBudget(Collection $limits, Budget $budget, Carbon $start, Carbon $end): array { @@ -564,6 +575,9 @@ class BudgetController extends Controller * @param Collection $limits * * @return array + * + * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * */ private function spentInPeriodMulti(Budget $budget, Collection $limits): array { @@ -584,18 +598,12 @@ class BudgetController extends Controller ] ); } - /* - * amount: amount of budget limit - * left: amount of budget limit min spent, or 0 when < 0. - * spent: spent, or amount of budget limit when > amount - */ $amount = $budgetLimit->amount; $leftInLimit = bcsub($amount, $expenses); $hasOverspent = bccomp($leftInLimit, '0') === -1; - - $left = $hasOverspent ? '0' : bcsub($amount, $expenses); - $spent = $hasOverspent ? $amount : $expenses; - $overspent = $hasOverspent ? app('steam')->positive($leftInLimit) : '0'; + $left = $hasOverspent ? '0' : bcsub($amount, $expenses); + $spent = $hasOverspent ? $amount : $expenses; + $overspent = $hasOverspent ? app('steam')->positive($leftInLimit) : '0'; $return[$name] = [ 'left' => $left, diff --git a/app/Http/Controllers/Chart/BudgetReportController.php b/app/Http/Controllers/Chart/BudgetReportController.php index 8927ecf773..3d2f2aba80 100644 --- a/app/Http/Controllers/Chart/BudgetReportController.php +++ b/app/Http/Controllers/Chart/BudgetReportController.php @@ -43,6 +43,8 @@ use Illuminate\Support\Collection; * Separate controller because many helper functions are shared. * * Class BudgetReportController + * + * @SuppressWarnings(PHPMD.CouplingBetweenObjects) */ class BudgetReportController extends Controller { @@ -76,6 +78,8 @@ class BudgetReportController extends Controller * @param string $others * * @return JsonResponse + * + * @SuppressWarnings(PHPMD.ExcessiveParameterList) */ public function accountExpense(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end, string $others): JsonResponse { @@ -101,6 +105,8 @@ class BudgetReportController extends Controller * @param string $others * * @return JsonResponse + * + * @SuppressWarnings(PHPMD.ExcessiveParameterList) */ public function budgetExpense(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end, string $others): JsonResponse {