From 51062bc80bb223138fea5cb67d8de27748c79c4d Mon Sep 17 00:00:00 2001
From: James Cole <thegrumpydictator@gmail.com>
Date: Fri, 15 Jan 2016 20:48:06 +0100
Subject: [PATCH] Some cleaning up and suppressing.

---
 .../Controllers/Chart/CategoryController.php     | 16 ++++++++--------
 app/Http/Controllers/CsvController.php           |  2 ++
 app/Repositories/Journal/JournalRepository.php   |  2 ++
 app/Repositories/Tag/TagRepository.php           |  8 ++++----
 4 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/app/Http/Controllers/Chart/CategoryController.php b/app/Http/Controllers/Chart/CategoryController.php
index f2a0623118..27c97ab7c6 100644
--- a/app/Http/Controllers/Chart/CategoryController.php
+++ b/app/Http/Controllers/Chart/CategoryController.php
@@ -313,6 +313,10 @@ class CategoryController extends Controller
      * @param Carbon                      $end
      * @param Collection                  $accounts
      *
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList) // cant avoid it.
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly 5.
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength) // it's long but ok.
+     *
      * @return \Illuminate\Http\JsonResponse
      */
     public function earnedInPeriod(CRI $repository, $reportType, Carbon $start, Carbon $end, Collection $accounts)
@@ -337,18 +341,15 @@ class CategoryController extends Controller
         $entries    = new Collection;
 
         while ($start < $end) { // filter the set:
-            $row = [clone $start];
-            // get possibly relevant entries from the big $set
-            $currentSet = $set->filter(
+            $row        = [clone $start];
+            $currentSet = $set->filter( // get possibly relevant entries from the big $set
                 function (Category $category) use ($start) {
                     return $category->dateFormatted == $start->format("Y-m");
                 }
             );
-            // check for each category if its in the current set.
             /** @var Category $category */
-            foreach ($categories as $category) {
-                // if its in there, use the value.
-                $entry = $currentSet->filter(
+            foreach ($categories as $category) { // check for each category if its in the current set.
+                $entry = $currentSet->filter( // if its in there, use the value.
                     function (Category $cat) use ($category) {
                         return ($cat->id == $category->id);
                     }
@@ -359,7 +360,6 @@ class CategoryController extends Controller
                     $row[] = 0;
                 }
             }
-
             $entries->push($row);
             $start->addMonth();
         }
diff --git a/app/Http/Controllers/CsvController.php b/app/Http/Controllers/CsvController.php
index f041562c15..6bc6a9b2e3 100644
--- a/app/Http/Controllers/CsvController.php
+++ b/app/Http/Controllers/CsvController.php
@@ -331,6 +331,8 @@ class CsvController extends Controller
      *
      * STEP SIX
      *
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity) it's 6, but it's allright.
+     *
      * @return \Illuminate\Http\RedirectResponse
      */
     public function saveMapping()
diff --git a/app/Repositories/Journal/JournalRepository.php b/app/Repositories/Journal/JournalRepository.php
index c3d4d08c5e..10d439b4fa 100644
--- a/app/Repositories/Journal/JournalRepository.php
+++ b/app/Repositories/Journal/JournalRepository.php
@@ -323,6 +323,8 @@ class JournalRepository implements JournalRepositoryInterface
      * @param array           $data
      *
      * @return array
+     *
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     protected function storeAccounts(TransactionType $type, array $data)
     {
diff --git a/app/Repositories/Tag/TagRepository.php b/app/Repositories/Tag/TagRepository.php
index 410ea191de..5406054c79 100644
--- a/app/Repositories/Tag/TagRepository.php
+++ b/app/Repositories/Tag/TagRepository.php
@@ -318,6 +318,8 @@ class TagRepository implements TagRepositoryInterface
      * @param TransactionJournal $journal
      * @param Tag                $tag
      *
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     *
      * @return boolean
      */
     protected function connectAdvancePayment(TransactionJournal $journal, Tag $tag)
@@ -332,13 +334,11 @@ class TagRepository implements TagRepositoryInterface
         $withdrawals = $tag->transactionjournals()->where('transaction_type_id', $withdrawal->id)->count();
         $deposits    = $tag->transactionjournals()->where('transaction_type_id', $deposit->id)->count();
 
-        // advance payments cannot accept transfers:
-        if ($journal->transaction_type_id == $transfer->id) {
+        if ($journal->transaction_type_id == $transfer->id) { // advance payments cannot accept transfers:
             return false;
         }
 
-        // the first transaction to be attached to this
-        // tag is attached just like that:
+        // the first transaction to be attached to this tag is attached just like that:
         if ($withdrawals < 1 && $deposits < 1) {
             $journal->tags()->save($tag);
             $journal->save();