From 44823c6fec03fdd294919a1e979dd50f3d7dbd00 Mon Sep 17 00:00:00 2001 From: James Cole Date: Sat, 17 Aug 2019 10:46:55 +0200 Subject: [PATCH] Code cleanup --- app/Console/Commands/Upgrade/MigrateToGroups.php | 2 +- app/Console/Commands/Upgrade/OtherCurrenciesCorrections.php | 2 +- .../Commands/Upgrade/TransferCurrenciesCorrections.php | 2 -- app/Events/StoredTransactionGroup.php | 5 ++--- app/Events/UpdatedTransactionGroup.php | 1 + app/Exceptions/GracefulNotFoundHandler.php | 4 +--- app/Exceptions/Handler.php | 6 ++---- app/Factory/AccountFactory.php | 2 +- app/Factory/BudgetFactory.php | 3 +-- app/Factory/CategoryFactory.php | 3 +-- app/Factory/PiggyBankEventFactory.php | 2 +- app/Factory/PiggyBankFactory.php | 2 +- app/Factory/TransactionCurrencyFactory.php | 2 +- app/Factory/TransactionJournalMetaFactory.php | 2 -- app/Generator/Chart/Basic/ChartJsGenerator.php | 2 +- app/Generator/Chart/Basic/GeneratorInterface.php | 2 +- app/Generator/Report/Support.php | 2 +- app/Handlers/Events/VersionCheckEventHandler.php | 4 +--- app/Helpers/Chart/MetaPieChart.php | 4 +--- app/Helpers/Report/BalanceReportHelper.php | 2 -- app/Helpers/Report/ReportHelper.php | 2 -- 21 files changed, 19 insertions(+), 37 deletions(-) diff --git a/app/Console/Commands/Upgrade/MigrateToGroups.php b/app/Console/Commands/Upgrade/MigrateToGroups.php index 2b46196a5b..a60445aab5 100644 --- a/app/Console/Commands/Upgrade/MigrateToGroups.php +++ b/app/Console/Commands/Upgrade/MigrateToGroups.php @@ -236,7 +236,7 @@ class MigrateToGroups extends Command * @param TransactionJournal $journal * * @throws Exception - * @SuppressWarnings(PHPMD.ExcessiveMethodLength) + * */ private function makeMultiGroup(TransactionJournal $journal): void { diff --git a/app/Console/Commands/Upgrade/OtherCurrenciesCorrections.php b/app/Console/Commands/Upgrade/OtherCurrenciesCorrections.php index 3af284a899..924e173d09 100644 --- a/app/Console/Commands/Upgrade/OtherCurrenciesCorrections.php +++ b/app/Console/Commands/Upgrade/OtherCurrenciesCorrections.php @@ -248,8 +248,8 @@ class OtherCurrenciesCorrections extends Command * Gets the transaction that determines the transaction that "leads" and will determine * the currency to be used by all transactions, and the journal itself. * - * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @param TransactionJournal $journal + * * @return Transaction|null */ private function getLeadTransaction(TransactionJournal $journal): ?Transaction diff --git a/app/Console/Commands/Upgrade/TransferCurrenciesCorrections.php b/app/Console/Commands/Upgrade/TransferCurrenciesCorrections.php index 36d51f678c..45337e7e90 100644 --- a/app/Console/Commands/Upgrade/TransferCurrenciesCorrections.php +++ b/app/Console/Commands/Upgrade/TransferCurrenciesCorrections.php @@ -291,8 +291,6 @@ class TransferCurrenciesCorrections extends Command } /** - * @SuppressWarnings(PHPMD.ExcessiveMethodLength) - * * @param TransactionJournal $transfer */ private function updateTransferCurrency(TransactionJournal $transfer): void diff --git a/app/Events/StoredTransactionGroup.php b/app/Events/StoredTransactionGroup.php index e558dd4d36..8e00398b65 100644 --- a/app/Events/StoredTransactionGroup.php +++ b/app/Events/StoredTransactionGroup.php @@ -36,16 +36,15 @@ class StoredTransactionGroup extends Event { use SerializesModels; + public $applyRules; /** @var TransactionGroup The group that was stored. */ public $transactionGroup; - public $applyRules; - /** * Create a new event instance. * * @param TransactionGroup $transactionGroup - * @param bool $applyRules + * @param bool $applyRules */ public function __construct(TransactionGroup $transactionGroup, bool $applyRules = true) { diff --git a/app/Events/UpdatedTransactionGroup.php b/app/Events/UpdatedTransactionGroup.php index af12194b17..784178de5b 100644 --- a/app/Events/UpdatedTransactionGroup.php +++ b/app/Events/UpdatedTransactionGroup.php @@ -29,6 +29,7 @@ use Illuminate\Queue\SerializesModels; /** * Class UpdatedTransactionGroup. + * * @codeCoverageIgnore * */ diff --git a/app/Exceptions/GracefulNotFoundHandler.php b/app/Exceptions/GracefulNotFoundHandler.php index 2866feaf1a..87c50ca1c7 100644 --- a/app/Exceptions/GracefulNotFoundHandler.php +++ b/app/Exceptions/GracefulNotFoundHandler.php @@ -43,9 +43,7 @@ class GracefulNotFoundHandler extends ExceptionHandler * * @param Request $request * @param Exception $exception - * @SuppressWarnings(PHPMD.CyclomaticComplexity) - * @SuppressWarnings(PHPMD.NPathComplexity) - * @SuppressWarnings(PHPMD.ExcessiveMethodLength) + * * * @return mixed */ diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php index 5e6ca46764..711e1a86b4 100644 --- a/app/Exceptions/Handler.php +++ b/app/Exceptions/Handler.php @@ -48,9 +48,7 @@ class Handler extends ExceptionHandler * * @param Request $request * @param Exception $exception - * @SuppressWarnings(PHPMD.CyclomaticComplexity) - * @SuppressWarnings(PHPMD.NPathComplexity) - * @SuppressWarnings(PHPMD.ExcessiveMethodLength) + * * * @return mixed */ @@ -112,7 +110,7 @@ class Handler extends ExceptionHandler * * This is a great spot to send exceptions to Sentry etc. * - * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's five its fine. + * // it's five its fine. * * @param Exception $exception * diff --git a/app/Factory/AccountFactory.php b/app/Factory/AccountFactory.php index 0c35036f02..8f555f57aa 100644 --- a/app/Factory/AccountFactory.php +++ b/app/Factory/AccountFactory.php @@ -189,7 +189,7 @@ class AccountFactory * @param null|string $accountType * * @return AccountType|null - * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * */ protected function getAccountType(?int $accountTypeId, ?string $accountType): ?AccountType { diff --git a/app/Factory/BudgetFactory.php b/app/Factory/BudgetFactory.php index 4824d322bc..da8882ad3b 100644 --- a/app/Factory/BudgetFactory.php +++ b/app/Factory/BudgetFactory.php @@ -26,7 +26,6 @@ namespace FireflyIII\Factory; use FireflyIII\Models\Budget; use FireflyIII\User; -use Illuminate\Support\Collection; use Log; /** @@ -53,7 +52,7 @@ class BudgetFactory * @param null|string $budgetName * * @return Budget|null - * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * */ public function find(?int $budgetId, ?string $budgetName): ?Budget { diff --git a/app/Factory/CategoryFactory.php b/app/Factory/CategoryFactory.php index 0e3498220e..1085b64ede 100644 --- a/app/Factory/CategoryFactory.php +++ b/app/Factory/CategoryFactory.php @@ -26,7 +26,6 @@ namespace FireflyIII\Factory; use FireflyIII\Models\Category; use FireflyIII\User; -use Illuminate\Support\Collection; use Log; /** @@ -63,7 +62,7 @@ class CategoryFactory * @param null|string $categoryName * * @return Category|null - * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * */ public function findOrCreate(?int $categoryId, ?string $categoryName): ?Category { diff --git a/app/Factory/PiggyBankEventFactory.php b/app/Factory/PiggyBankEventFactory.php index 3dcb2a1e16..597c63b22d 100644 --- a/app/Factory/PiggyBankEventFactory.php +++ b/app/Factory/PiggyBankEventFactory.php @@ -53,7 +53,7 @@ class PiggyBankEventFactory * @param PiggyBank|null $piggyBank * * @return PiggyBankEvent|null - * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * */ public function create(TransactionJournal $journal, ?PiggyBank $piggyBank): ?PiggyBankEvent { diff --git a/app/Factory/PiggyBankFactory.php b/app/Factory/PiggyBankFactory.php index e0d98fdc6f..020399bc73 100644 --- a/app/Factory/PiggyBankFactory.php +++ b/app/Factory/PiggyBankFactory.php @@ -52,7 +52,7 @@ class PiggyBankFactory * @param null|string $piggyBankName * * @return PiggyBank|null - * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * */ public function find(?int $piggyBankId, ?string $piggyBankName): ?PiggyBank { diff --git a/app/Factory/TransactionCurrencyFactory.php b/app/Factory/TransactionCurrencyFactory.php index 3d831791a5..f2e1a0f4cc 100644 --- a/app/Factory/TransactionCurrencyFactory.php +++ b/app/Factory/TransactionCurrencyFactory.php @@ -79,7 +79,7 @@ class TransactionCurrencyFactory * @param null|string $currencyCode * * @return TransactionCurrency|null - * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * */ public function find(?int $currencyId, ?string $currencyCode): ?TransactionCurrency { diff --git a/app/Factory/TransactionJournalMetaFactory.php b/app/Factory/TransactionJournalMetaFactory.php index 470468349f..7e13afd8fd 100644 --- a/app/Factory/TransactionJournalMetaFactory.php +++ b/app/Factory/TransactionJournalMetaFactory.php @@ -49,8 +49,6 @@ class TransactionJournalMetaFactory * @param array $data * * @return TransactionJournalMeta|null - * @SuppressWarnings(PHPMD.CyclomaticComplexity) - * @SuppressWarnings(PHPMD.ExcessiveMethodLength) */ public function updateOrCreate(array $data): ?TransactionJournalMeta { diff --git a/app/Generator/Chart/Basic/ChartJsGenerator.php b/app/Generator/Chart/Basic/ChartJsGenerator.php index 04a0fcb9ca..c0a4e0a39c 100644 --- a/app/Generator/Chart/Basic/ChartJsGenerator.php +++ b/app/Generator/Chart/Basic/ChartJsGenerator.php @@ -109,7 +109,7 @@ class ChartJsGenerator implements GeneratorInterface * ] * ] * - * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's five. + * // it's five. * * @param array $data * diff --git a/app/Generator/Chart/Basic/GeneratorInterface.php b/app/Generator/Chart/Basic/GeneratorInterface.php index cc7d55626c..75fa3e63ff 100644 --- a/app/Generator/Chart/Basic/GeneratorInterface.php +++ b/app/Generator/Chart/Basic/GeneratorInterface.php @@ -60,7 +60,7 @@ interface GeneratorInterface * ] * ] * - * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's five. + * // it's five. * * @param array $data * diff --git a/app/Generator/Report/Support.php b/app/Generator/Report/Support.php index 1f5e8d3b78..d004291fc9 100644 --- a/app/Generator/Report/Support.php +++ b/app/Generator/Report/Support.php @@ -112,7 +112,7 @@ class Support /** * Summarize collection by earned and spent data. * - * @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly five. + * // it's exactly five. * * @param array $spent * @param array $earned diff --git a/app/Handlers/Events/VersionCheckEventHandler.php b/app/Handlers/Events/VersionCheckEventHandler.php index 9a0029c74c..2316d040dc 100644 --- a/app/Handlers/Events/VersionCheckEventHandler.php +++ b/app/Handlers/Events/VersionCheckEventHandler.php @@ -43,9 +43,7 @@ class VersionCheckEventHandler /** * Checks with GitHub to see if there is a new version. * - * @SuppressWarnings(PHPMD.CyclomaticComplexity) - * @SuppressWarnings(PHPMD.NPathComplexity) - * @SuppressWarnings(PHPMD.ExcessiveMethodLength) + * * @param RequestedVersionCheckStatus $event */ public function checkForUpdates(RequestedVersionCheckStatus $event): void diff --git a/app/Helpers/Chart/MetaPieChart.php b/app/Helpers/Chart/MetaPieChart.php index 55c58704a7..4eb1efccd7 100644 --- a/app/Helpers/Chart/MetaPieChart.php +++ b/app/Helpers/Chart/MetaPieChart.php @@ -98,7 +98,7 @@ class MetaPieChart implements MetaPieChartInterface * @param string $group * * @return array - * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * */ public function generate(string $direction, string $group): array { @@ -181,8 +181,6 @@ class MetaPieChart implements MetaPieChartInterface * * @return array * - * @SuppressWarnings(PHPMD.CyclomaticComplexity) - * */ protected function groupByFields(array $array, array $fields): array { diff --git a/app/Helpers/Report/BalanceReportHelper.php b/app/Helpers/Report/BalanceReportHelper.php index 537586823f..4dbbe70a9e 100644 --- a/app/Helpers/Report/BalanceReportHelper.php +++ b/app/Helpers/Report/BalanceReportHelper.php @@ -43,8 +43,6 @@ class BalanceReportHelper implements BalanceReportHelperInterface /** * ReportHelper constructor. - * - * * @param BudgetRepositoryInterface $budgetRepository */ public function __construct(BudgetRepositoryInterface $budgetRepository) diff --git a/app/Helpers/Report/ReportHelper.php b/app/Helpers/Report/ReportHelper.php index 0d09d8e40a..a3b502c873 100644 --- a/app/Helpers/Report/ReportHelper.php +++ b/app/Helpers/Report/ReportHelper.php @@ -43,8 +43,6 @@ class ReportHelper implements ReportHelperInterface /** * ReportHelper constructor. - * - * * @param BudgetRepositoryInterface $budgetRepository */ public function __construct(BudgetRepositoryInterface $budgetRepository)