refactor: Update method signatures to use CarbonInterface for better type flexibility (#52)

Author: simbig

CHANGELOG.md

@@ -9,6 +9,12 @@ See [GitHub releases](https://github.com/mll-lab/php-utils/releases).
 
 ## Unreleased
 
+## v5.15.0
+
+### Changed
+
+- Update method signatures to use `CarbonInterface` in `MLL\Utils\BavarianHolidays` for better type flexibility
+
 ## v5.14.0
 
 ### Added

rector.php

@@ -25,10 +25,10 @@
     ])
     ->withSkip([
         Rector\PHPUnit\CodeQuality\Rector\Class_\PreferPHPUnitThisCallRector::class, // breaks tests
+        Rector\PHPUnit\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector::class, // breaks tests
         Rector\CodeQuality\Rector\Concat\JoinStringConcatRector::class => [
             __DIR__ . '/tests/CSVArrayTest.php', // keep `\r\n` for readability
         ],
-        Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertCountWithZeroToAssertEmptyRector::class, // sloppy
     ])
     ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
     ->withBootstrapFiles([

src/BavarianHolidays.php

@@ -3,6 +3,7 @@
 namespace MLL\Utils;
 
 use Carbon\Carbon;
+use Carbon\CarbonInterface;
 
 /**
  * Some definitions:
@@ -48,15 +49,15 @@ class BavarianHolidays
      */
     public static $loadUserDefinedHolidays;
 
-    /** Checks if given date is a business day. */
-    public static function isBusinessDay(Carbon $date): bool
+    /** Checks if the given date is a business day. */
+    public static function isBusinessDay(CarbonInterface $date): bool
     {
         return ! self::isHoliday($date)
             && ! $date->isWeekend();
     }
 
-    /** Checks if given date is a holiday. */
-    public static function isHoliday(Carbon $date): bool
+    /** Checks if the given date is a holiday. */
+    public static function isHoliday(CarbonInterface $date): bool
     {
         return is_string(self::nameHoliday($date));
     }
@@ -65,7 +66,7 @@ public static function isHoliday(Carbon $date): bool
      * Returns the name of the holiday if the date happens to land on one.
      * Saturday and Sunday are not evaluated as holiday.
      */
-    public static function nameHoliday(Carbon $date): ?string
+    public static function nameHoliday(CarbonInterface $date): ?string
     {
         $holidayMap = self::buildHolidayMap($date);
 
@@ -78,7 +79,7 @@ public static function addBusinessDays(Carbon $date, int $days): Carbon
         return DateModification::addDays(
             $date,
             $days,
-            fn (Carbon $date): bool => self::isBusinessDay($date)
+            fn (CarbonInterface $date): bool => self::isBusinessDay($date)
         );
     }
 
@@ -88,7 +89,7 @@ public static function subBusinessDays(Carbon $date, int $days): Carbon
         return DateModification::subDays(
             $date,
             $days,
-            fn (Carbon $date): bool => self::isBusinessDay($date)
+            fn (CarbonInterface $date): bool => self::isBusinessDay($date)
         );
     }
 
@@ -97,7 +98,7 @@ public static function subBusinessDays(Carbon $date, int $days): Carbon
      *
      * @return array<string, string>
      */
-    protected static function buildHolidayMap(Carbon $date): array
+    protected static function buildHolidayMap(CarbonInterface $date): array
     {
         $holidays = self::HOLIDAYS_STATIC;
 
@@ -131,14 +132,14 @@ protected static function buildHolidayMap(Carbon $date): array
         return $holidays;
     }
 
-    protected static function dateFromEaster(Carbon $easter, int $daysAway): string
+    protected static function dateFromEaster(CarbonInterface $easter, int $daysAway): string
     {
         $date = $easter->clone()->addDays($daysAway);
 
         return self::dayOfTheYear($date);
     }
 
-    public static function dayOfTheYear(Carbon $date): string
+    public static function dayOfTheYear(CarbonInterface $date): string
     {
         return $date->format('d.m');
     }

src/Microplate/Coordinates.php

@@ -29,14 +29,14 @@ public function __construct(string $row, int $column, CoordinateSystem $coordina
     {
         $rows = $coordinateSystem->rows();
         if (! in_array($row, $rows, true)) {
-            $rowList = \implode(',', $rows);
+            $rowList = implode(',', $rows);
             throw new \InvalidArgumentException("Expected a row with value of {$rowList}, got {$row}.");
         }
         $this->row = $row;
 
         $columns = $coordinateSystem->columns();
         if (! in_array($column, $columns, true)) {
-            $columnsList = \implode(',', $columns);
+            $columnsList = implode(',', $columns);
             throw new \InvalidArgumentException("Expected a column with value of {$columnsList}, got {$column}.");
         }
         $this->column = $column;
@@ -67,13 +67,13 @@ public static function fromArray(array $coordinates, CoordinateSystem $coordinat
     public static function fromString(string $coordinatesString, CoordinateSystem $coordinateSystem): self
     {
         $rows = $coordinateSystem->rows();
-        $rowsOptions = \implode('|', $rows);
+        $rowsOptions = implode('|', $rows);
 
         $columns = [
             ...$coordinateSystem->columns(),
             ...$coordinateSystem->paddedColumns(),
         ];
-        $columnsOptions = \implode('|', $columns);
+        $columnsOptions = implode('|', $columns);
 
         $valid = preg_match(
             "/^({$rowsOptions})({$columnsOptions})\$/",
@@ -84,7 +84,7 @@ public static function fromString(string $coordinatesString, CoordinateSystem $c
         if ($valid === 0) {
             $firstValidExample = Arr::first($rows) . Arr::first($columns);
             $lastValidExample = Arr::last($rows) . Arr::last($columns);
-            $coordinateSystemClass = \get_class($coordinateSystem);
+            $coordinateSystemClass = get_class($coordinateSystem);
             throw new \InvalidArgumentException("Expected coordinates between {$firstValidExample} and {$lastValidExample} for {$coordinateSystemClass}, got: {$coordinatesString}.");
         }
         /** @var array{1: string, 2: string} $matches */
@@ -145,9 +145,9 @@ public function position(FlowDirection $direction): int
 
         switch ($direction->value) {
             case FlowDirection::ROW:
-                return $rowIndex * \count($this->coordinateSystem->columns()) + $columnIndex + 1;
+                return $rowIndex * count($this->coordinateSystem->columns()) + $columnIndex + 1;
             case FlowDirection::COLUMN:
-                return $columnIndex * \count($this->coordinateSystem->rows()) + $rowIndex + 1;
+                return $columnIndex * count($this->coordinateSystem->rows()) + $rowIndex + 1;
                 // @codeCoverageIgnoreStart all Enums are listed and this should never happen
             default:
                 throw new UnexpectedFlowDirection($direction);

src/Microplate/FullColumnSection.php

@@ -70,7 +70,7 @@ private function growSection(): void
     private function nextReservedWell()
     {
         $search = $this->sectionItems->search(AbstractMicroplate::EMPTY_WELL);
-        assert($search === false || is_int($search));
+        assert($search === false || is_int($search)); // @phpstan-ignore-line function.alreadyNarrowedType (not yet supported by PHPStan of older versions)
 
         return $search;
     }