More code cleanup

This commit is contained in:
James Cole
2023-12-20 19:45:12 +01:00
parent 4961b1f715
commit c9d5d74662
30 changed files with 420 additions and 422 deletions

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
{
@@ -38,7 +37,7 @@ trait CreatesApplication
*/
public function createApplication()
{
$app = require __DIR__ . '/../../bootstrap/app.php';
$app = require __DIR__.'/../../bootstrap/app.php';
$app->make(Kernel::class)->bootstrap();

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
{
@@ -55,7 +58,7 @@ class MonthlyTest extends IntervalTestCase
new IntervalProvider(Carbon::parse('2021-01-31'), Carbon::parse('2021-02-28')),
new IntervalProvider(Carbon::parse('2023-03-31'), Carbon::parse('2023-04-30')),
new IntervalProvider(Carbon::parse('2023-05-31'), Carbon::parse('2023-06-30')),
//new IntervalProvider(Carbon::parse('2023-08-31'), Carbon::parse('2023-09-30')),
// new IntervalProvider(Carbon::parse('2023-08-31'), Carbon::parse('2023-09-30')),
new IntervalProvider(Carbon::parse('2023-10-31'), Carbon::parse('2023-11-30')),
];
}

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;
@@ -98,8 +102,9 @@ class NavigationStartOfPeriodTest extends TestCase
public function testGivenADateAndUnknownFrequencyWhenCalculateTheDateThenReturnsTheSameDateSuccessful(string $frequency, Carbon $from, Carbon $expected)
{
Log::shouldReceive('error')
->with(sprintf('Cannot do startOfPeriod for $repeat_freq "%s"', $frequency))
->andReturnNull();
->with(sprintf('Cannot do startOfPeriod for $repeat_freq "%s"', $frequency))
->andReturnNull()
;
$period = $this->navigation->startOfPeriod($from, $frequency);
self::assertSame($expected->toDateString(), $period->toDateString());