More code cleanup

This commit is contained in:
James Cole 2023-12-20 19:45:12 +01:00
parent 4961b1f715
commit c9d5d74662
No known key found for this signature in database
GPG Key ID: B49A324B7EAD6D80
30 changed files with 420 additions and 422 deletions

View File

@ -25,9 +25,9 @@ $paths = [
$current . '/../../app',
$current . '/../../config',
$current . '/../../database',
// $current . '/../../routes',
// $current . '/../../tests',
// $current . '/../../resources/lang',
$current . '/../../routes',
$current . '/../../tests',
$current . '/../../resources/lang',
];
$finder = PhpCsFixer\Finder::create()

View File

@ -22,9 +22,7 @@
declare(strict_types=1);
/**
* V2 API route for Summary boxes
*/
// V2 API route for Summary boxes
// BASIC
Route::group(
[
@ -36,9 +34,7 @@ Route::group(
Route::get('basic', ['uses' => 'BasicController@basic', 'as' => 'basic']);
}
);
/**
* V2 API route for TransactionList API endpoints
*/
// V2 API route for TransactionList API endpoints
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Transaction\List',
@ -51,9 +47,7 @@ Route::group(
}
);
/**
* V2 API routes for auto complete
*/
// V2 API routes for auto complete
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Autocomplete',
@ -67,9 +61,7 @@ Route::group(
}
);
/**
* V2 API route for net worth endpoint(s);
*/
// V2 API route for net worth endpoint(s);
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Summary',
@ -81,9 +73,7 @@ Route::group(
}
);
/**
* V2 API routes for charts
*/
// V2 API routes for charts
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Chart',
@ -98,9 +88,7 @@ Route::group(
}
);
/**
* V2 API route for accounts.
*/
// V2 API route for accounts.
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Model\Account',
@ -112,9 +100,7 @@ Route::group(
}
);
/**
* V2 API route for subscriptions.
*/
// V2 API route for subscriptions.
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Model\Bill',
@ -129,9 +115,7 @@ Route::group(
}
);
/**
* V2 API route for piggy banks.
*/
// V2 API route for piggy banks.
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Model\PiggyBank',
@ -143,9 +127,7 @@ Route::group(
}
);
/**
* V2 API route for transaction currencies
*/
// V2 API route for transaction currencies
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Model\Currency',
@ -157,9 +139,7 @@ Route::group(
}
);
/**
* V2 API route for transactions
*/
// V2 API route for transactions
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Model\Transaction',
@ -171,9 +151,7 @@ Route::group(
}
);
/**
* V2 API route for budgets and budget limits:
*/
// V2 API route for budgets and budget limits:
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\Model',
@ -191,9 +169,7 @@ Route::group(
}
);
/**
* V2 API route for system
*/
// V2 API route for system
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\System',
@ -205,9 +181,7 @@ Route::group(
}
);
/**
* V2 API route for user groups (administrations).
*/
// V2 API route for user groups (administrations).
Route::group(
[
'namespace' => 'FireflyIII\Api\V2\Controllers\UserGroup',
@ -226,9 +200,7 @@ Route::group(
// down here is v1
/**
* Autocomplete controllers
*/
// Autocomplete controllers
Route::group(
[
'namespace' => 'FireflyIII\Api\V1\Controllers\Autocomplete',
@ -256,9 +228,7 @@ Route::group(
}
);
/**
* CHART ROUTES.
*/
// CHART ROUTES.
// Accounts
Route::group(
[
@ -271,9 +241,7 @@ Route::group(
}
);
/**
* DATA ROUTES
*/
// DATA ROUTES
// Export data API routes
Route::group(
[
@ -327,9 +295,7 @@ Route::group(
}
);
/**
* INSIGHTS ROUTES
*/
// INSIGHTS ROUTES
// Insight in expenses:
Route::group(
@ -401,9 +367,7 @@ Route::group(
// TODO Transfers for piggies
}
);
/**
* SUMMARY CONTROLLER
*/
// SUMMARY CONTROLLER
// BASIC
Route::group(
[
@ -416,9 +380,7 @@ Route::group(
}
);
/**
* MODELS
*/
// MODELS
// Accounts API routes:
Route::group(
[
@ -763,9 +725,7 @@ Route::group(
}
);
/**
* SEARCH ENDPOINTS
*/
// SEARCH ENDPOINTS
Route::group(
[
'namespace' => 'FireflyIII\Api\V1\Controllers\Search',
@ -778,9 +738,7 @@ Route::group(
}
);
/**
* SYSTEM END POINTS
*/
// SYSTEM END POINTS
// About Firefly III API routes:
Route::group(
[
@ -823,9 +781,7 @@ Route::group(
}
);
/**
* USER
*/
// USER
// Preference API routes:
Route::group(

View File

@ -48,10 +48,6 @@ use Illuminate\Support\Arr;
if (!function_exists('limitStringLength')) {
/**
* Cuts away the middle of a string when it's very long.
*
* @param string $string
*
* @return string
*/
function limitStringLength(string $string): string
{

File diff suppressed because it is too large Load Diff

View File

@ -27,8 +27,12 @@ use Tests\integration\TestCase;
/**
* Class AccountControllerTest
*
* @internal
*
* @coversNothing
*/
class AccountControllerTest extends TestCase
final class AccountControllerTest extends TestCase
{
/**
* @covers \FireflyIII\Api\V1\Controllers\Autocomplete\AccountController

View File

@ -27,7 +27,6 @@ use Illuminate\Foundation\Application;
/**
* Trait CreatesApplication
*
*/
trait CreatesApplication
{

View File

@ -29,8 +29,12 @@ use Tests\integration\TestCase;
/**
* Class BillDateCalculatorTest
*
* @internal
*
* @coversNothing
*/
class BillDateCalculatorTest extends TestCase
final class BillDateCalculatorTest extends TestCase
{
private BillDateCalculator $calculator;

View File

@ -1,6 +1,5 @@
<?php
/*
* NavigationCustomEndOfPeriodTest.php
* Copyright (c) 2023 james@firefly-iii.org
@ -29,7 +28,12 @@ use Carbon\Carbon;
use FireflyIII\Support\Navigation;
use Tests\integration\TestCase;
class NavigationCustomEndOfPeriodTest extends TestCase
/**
* @internal
*
* @coversNothing
*/
final class NavigationCustomEndOfPeriodTest extends TestCase
{
/**
* @preserveGlobalState disabled

View File

@ -36,9 +36,6 @@ abstract class TestCase extends BaseTestCase
protected const MAX_ITERATIONS = 2;
/**
* @return array
*/
public function dateRangeProvider(): array
{
return [

View File

@ -30,9 +30,6 @@ use FireflyIII\User;
*/
trait CollectsValues
{
/**
* @return User
*/
public function user(): User
{
return User::where('email', 'james@firefly')->first();

View File

@ -1,6 +1,5 @@
<?php
/*
* CalculatorProvider.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -27,7 +26,6 @@ namespace Tests\unit\Support\Calendar;
use Carbon\Carbon;
use FireflyIII\Support\Calendar\Periodicity;
use Generator;
use Tests\unit\Support\Calendar\Periodicity\IntervalProvider;
readonly class CalculatorProvider
@ -45,7 +43,7 @@ readonly class CalculatorProvider
$this->label = "{$periodicity->name} {$intervalProvider->label}";
}
public static function providePeriodicityWithSkippedIntervals(): Generator
public static function providePeriodicityWithSkippedIntervals(): \Generator
{
$intervals = [
self::from(Periodicity::Daily, new IntervalProvider(Carbon::now(), Carbon::now()->addDays(2)), 1),

View File

@ -1,6 +1,5 @@
<?php
/*
* CalculatorTest.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -44,8 +43,12 @@ use Tests\unit\Support\Calendar\Periodicity\YearlyTest;
* @group support
* @group calendar
* @group calculator
*
* @internal
*
* @coversNothing
*/
class CalculatorTest extends TestCase
final class CalculatorTest extends TestCase
{
public static function provideAllPeriodicity(): iterable
{
@ -65,18 +68,6 @@ class CalculatorTest extends TestCase
}
}
private static function convert(Periodicity $periodicity, array $intervals): array
{
$periodicityIntervals = [];
/** @var IntervalProvider $interval */
foreach ($intervals as $index => $interval) {
$calculator = CalculatorProvider::from($periodicity, $interval);
$periodicityIntervals["#{$index} {$calculator->label}"] = [$calculator];
}
return $periodicityIntervals;
}
public static function provideSkippedIntervals(): iterable
{
return CalculatorProvider::providePeriodicityWithSkippedIntervals();
@ -84,6 +75,7 @@ class CalculatorTest extends TestCase
/**
* @dataProvider provideAllPeriodicity
*
* @throws IntervalException
*/
public function testGivenADailyPeriodicityWhenCallTheNextDateByIntervalMethodThenReturnsTheExpectedDateSuccessful(CalculatorProvider $provider)
@ -95,6 +87,7 @@ class CalculatorTest extends TestCase
/**
* @dataProvider provideSkippedIntervals
*
* @throws IntervalException
*/
public function testGivenAnEpochWithSkipIntervalNumberWhenCallTheNextDateBySkippedIntervalMethodThenReturnsTheExpectedDateSuccessful(CalculatorProvider $provider)
@ -103,4 +96,18 @@ class CalculatorTest extends TestCase
$period = $calculator->nextDateByInterval($provider->epoch(), $provider->periodicity, $provider->skip);
self::assertSame($provider->expected()->toDateString(), $period->toDateString());
}
private static function convert(Periodicity $periodicity, array $intervals): array
{
$periodicityIntervals = [];
/** @var IntervalProvider $interval */
foreach ($intervals as $index => $interval) {
$calculator = CalculatorProvider::from($periodicity, $interval);
$periodicityIntervals["#{$index} {$calculator->label}"] = [$calculator];
}
return $periodicityIntervals;
}
}

View File

@ -33,8 +33,12 @@ use FireflyIII\Support\Calendar\Periodicity\Interval;
* @group support
* @group calendar
* @group periodicity
*
* @internal
*
* @coversNothing
*/
class BimonthlyTest extends IntervalTestCase
final class BimonthlyTest extends IntervalTestCase
{
public static function factory(): Interval
{

View File

@ -1,6 +1,5 @@
<?php
/*
* DailyTest.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -34,8 +33,12 @@ use FireflyIII\Support\Calendar\Periodicity\Interval;
* @group support
* @group calendar
* @group periodicity
*
* @internal
*
* @coversNothing
*/
class DailyTest extends IntervalTestCase
final class DailyTest extends IntervalTestCase
{
public static function factory(): Interval
{

View File

@ -1,6 +1,5 @@
<?php
/*
* FortnightlyTest.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -34,8 +33,12 @@ use FireflyIII\Support\Calendar\Periodicity\Interval;
* @group support
* @group calendar
* @group periodicity
*
* @internal
*
* @coversNothing
*/
class FortnightlyTest extends IntervalTestCase
final class FortnightlyTest extends IntervalTestCase
{
public static function factory(): Interval
{

View File

@ -1,6 +1,5 @@
<?php
/*
* HalfYearlyTest.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -34,8 +33,12 @@ use FireflyIII\Support\Calendar\Periodicity\Interval;
* @group support
* @group calendar
* @group periodicity
*
* @internal
*
* @coversNothing
*/
class HalfYearlyTest extends IntervalTestCase
final class HalfYearlyTest extends IntervalTestCase
{
public static function factory(): Interval
{

View File

@ -1,6 +1,5 @@
<?php
/*
* IntervalProvider.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>

View File

@ -1,6 +1,5 @@
<?php
/*
* IntervalTestCase.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -33,6 +32,7 @@ abstract class IntervalTestCase extends TestCase
public static function provider(): iterable
{
$intervals = static::provideIntervals();
/** @var IntervalProvider $interval */
foreach ($intervals as $interval) {
yield "{$interval->label}" => [$interval];
@ -43,10 +43,6 @@ abstract class IntervalTestCase extends TestCase
/**
* @dataProvider provider
*
* @param IntervalProvider $provider
*
* @return void
*/
public function testGivenAnEpochWhenCallTheNextDateThenReturnsTheExpectedDateSuccessful(IntervalProvider $provider): void
{

View File

@ -1,6 +1,5 @@
<?php
/*
* MonthlyTest.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -34,8 +33,12 @@ use FireflyIII\Support\Calendar\Periodicity\Interval;
* @group support
* @group calendar
* @group periodicity
*
* @internal
*
* @coversNothing
*/
class MonthlyTest extends IntervalTestCase
final class MonthlyTest extends IntervalTestCase
{
public static function factory(): Interval
{

View File

@ -1,6 +1,5 @@
<?php
/*
* QuarterlyTest.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -34,8 +33,12 @@ use FireflyIII\Support\Calendar\Periodicity\Interval;
* @group support
* @group calendar
* @group periodicity
*
* @internal
*
* @coversNothing
*/
class QuarterlyTest extends IntervalTestCase
final class QuarterlyTest extends IntervalTestCase
{
public static function factory(): Interval
{

View File

@ -1,6 +1,5 @@
<?php
/*
* WeeklyTest.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -34,8 +33,12 @@ use FireflyIII\Support\Calendar\Periodicity\Interval;
* @group support
* @group calendar
* @group periodicity
*
* @internal
*
* @coversNothing
*/
class WeeklyTest extends IntervalTestCase
final class WeeklyTest extends IntervalTestCase
{
public static function factory(): Interval
{

View File

@ -1,6 +1,5 @@
<?php
/*
* YearlyTest.php
* Copyright (c) 2023 Antonio Spinelli <https://github.com/tonicospinelli>
@ -34,8 +33,12 @@ use FireflyIII\Support\Calendar\Periodicity\Interval;
* @group support
* @group calendar
* @group periodicity
*
* @internal
*
* @coversNothing
*/
class YearlyTest extends IntervalTestCase
final class YearlyTest extends IntervalTestCase
{
public static function factory(): Interval
{

View File

@ -27,15 +27,18 @@ namespace Tests\unit\Support;
use Carbon\Carbon;
use FireflyIII\Support\Calendar\Periodicity;
use FireflyIII\Support\Navigation;
use Generator;
use PHPUnit\Framework\TestCase;
/**
* @group unit-test
* @group support
* @group navigation
*
* @internal
*
* @coversNothing
*/
class NavigationAddPeriodTest extends TestCase
final class NavigationAddPeriodTest extends TestCase
{
private Navigation $navigation;

View File

@ -32,8 +32,12 @@ use PHPUnit\Framework\TestCase;
* @group unit-test
* @group support
* @group navigation
*
* @internal
*
* @coversNothing
*/
class NavigationEndOfPeriodTest extends TestCase
final class NavigationEndOfPeriodTest extends TestCase
{
private Navigation $navigation;
@ -43,9 +47,6 @@ class NavigationEndOfPeriodTest extends TestCase
$this->navigation = new Navigation();
}
/**
* @return iterable
*/
public static function provideDates(): iterable
{
return [

View File

@ -31,8 +31,12 @@ use PHPUnit\Framework\TestCase;
* @group unit-test
* @group support
* @group navigation
*
* @internal
*
* @coversNothing
*/
class NavigationPreferredCarbonFormatByPeriodTest extends TestCase
final class NavigationPreferredCarbonFormatByPeriodTest extends TestCase
{
private Navigation $navigation;

View File

@ -32,8 +32,12 @@ use PHPUnit\Framework\TestCase;
* @group unit-test
* @group support
* @group navigation
*
* @internal
*
* @coversNothing
*/
class NavigationPreferredCarbonFormatTest extends TestCase
final class NavigationPreferredCarbonFormatTest extends TestCase
{
private Navigation $navigation;

View File

@ -32,8 +32,12 @@ use PHPUnit\Framework\TestCase;
* @group unit-test
* @group support
* @group navigation
*
* @internal
*
* @coversNothing
*/
class NavigationPreferredEndOfPeriodTest extends TestCase
final class NavigationPreferredEndOfPeriodTest extends TestCase
{
private Navigation $navigation;

View File

@ -32,8 +32,12 @@ use PHPUnit\Framework\TestCase;
* @group unit-test
* @group support
* @group navigation
*
* @internal
*
* @coversNothing
*/
class NavigationPreferredRangeFormatTest extends TestCase
final class NavigationPreferredRangeFormatTest extends TestCase
{
private Navigation $navigation;

View File

@ -32,8 +32,12 @@ use PHPUnit\Framework\TestCase;
* @group unit-test
* @group support
* @group navigation
*
* @internal
*
* @coversNothing
*/
class NavigationPreferredSqlFormatTest extends TestCase
final class NavigationPreferredSqlFormatTest extends TestCase
{
private Navigation $navigation;

View File

@ -33,8 +33,12 @@ use PHPUnit\Framework\TestCase;
* @group unit-test
* @group support
* @group navigation
*
* @internal
*
* @coversNothing
*/
class NavigationStartOfPeriodTest extends TestCase
final class NavigationStartOfPeriodTest extends TestCase
{
private Navigation $navigation;
@ -99,7 +103,8 @@ class NavigationStartOfPeriodTest extends TestCase
{
Log::shouldReceive('error')
->with(sprintf('Cannot do startOfPeriod for $repeat_freq "%s"', $frequency))
->andReturnNull();
->andReturnNull()
;
$period = $this->navigation->startOfPeriod($from, $frequency);
self::assertSame($expected->toDateString(), $period->toDateString());