- Make data and openingHours readonly

- Make DateTimeRange, Time and PreciseTime readonly - Add stronger types - Drop PHP < 8.2 - Make Day an enum
spatie · Nov 12, 2023 · 25a7042 · 25a7042
1 parent cb696c2
commit 25a7042
Show file tree

Hide file tree

Showing 18 changed files with 200 additions and 288 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        php: ['7.4']
+        php: ['8.2']
         setup: ['stable']
 
     steps:

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.4', '8.0', '8.1', '8.2', '8.3']
+        php: ['8.2', '8.3']
         setup: ['lowest', 'stable']
 
     name: PHP ${{ matrix.php }} - ${{ matrix.setup || 'stable' }}

diff --git a/composer.json b/composer.json
@@ -16,14 +16,19 @@
             "email": "[email protected]",
             "homepage": "https://spatie.be",
             "role": "Developer"
+        },
+        {
+            "name": "kylekatarnls",
+            "homepage": "https://github.com/kylekatarnls",
+            "role": "Developer"
         }
     ],
     "require": {
-        "php": "^7.4 || ^8.0"
+        "php": "^8.2"
     },
     "require-dev": {
-        "kylekatarnls/multi-tester": "^1.1",
-        "phpunit/phpunit": "^9.4"
+        "kylekatarnls/multi-tester": "^1.4",
+        "phpunit/phpunit": "^10.4.2"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,29 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/9.4/phpunit.xsd"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd"
     bootstrap="vendor/autoload.php"
     colors="true"
-    verbose="true"
+    cacheDirectory=".phpunit.cache"
 >
-    <testsuites>
-        <testsuite name="Spatie Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <coverage
-        processUncoveredFiles="true"
-        ignoreDeprecatedCodeUnits="true"
-        disableCodeCoverageIgnore="true"
-    >
-        <include>
-            <directory>src</directory>
-        </include>
-        <report>
-            <html outputDirectory="coverage" />
-        </report>
-    </coverage>
-    <php>
-        <ini name="date.timezone" value="UTC"/>
-    </php>
+  <testsuites>
+    <testsuite name="Spatie Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <coverage ignoreDeprecatedCodeUnits="true" disableCodeCoverageIgnore="true">
+    <report>
+      <html outputDirectory="coverage"/>
+    </report>
+  </coverage>
+  <php>
+    <ini name="date.timezone" value="UTC"/>
+  </php>
+  <source>
+    <include>
+      <directory>src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/DateTimeRange.php b/src/DateTimeRange.php
@@ -4,11 +4,11 @@
 
 use DateTimeInterface;
 
-class DateTimeRange extends TimeRange
+readonly class DateTimeRange extends TimeRange
 {
     protected DateTimeInterface $date;
 
-    protected function __construct(DateTimeInterface $date, Time $start, Time $end, $data = null)
+    protected function __construct(DateTimeInterface $date, Time $start, Time $end, mixed $data = null)
     {
         $this->date = $date;
         $startDate = $this->copyAndModify($date, $start.(
@@ -28,7 +28,7 @@ protected function __construct(DateTimeInterface $date, Time $start, Time $end,
         );
     }
 
-    public static function fromTimeRange(DateTimeInterface $date, TimeRange $timeRange, $data = null)
+    public static function fromTimeRange(DateTimeInterface $date, TimeRange $timeRange, mixed $data = null)
     {
         return new self($date, $timeRange->start, $timeRange->end, $data);
     }

diff --git a/src/Day.php b/src/Day.php
@@ -5,46 +5,28 @@
 use DateTimeInterface;
 use Spatie\OpeningHours\Helpers\Arr;
 
-class Day
+enum Day: string
 {
-    const MONDAY = 'monday';
-    const TUESDAY = 'tuesday';
-    const WEDNESDAY = 'wednesday';
-    const THURSDAY = 'thursday';
-    const FRIDAY = 'friday';
-    const SATURDAY = 'saturday';
-    const SUNDAY = 'sunday';
-
-    public static function days(): array
-    {
-        return [
-            static::MONDAY,
-            static::TUESDAY,
-            static::WEDNESDAY,
-            static::THURSDAY,
-            static::FRIDAY,
-            static::SATURDAY,
-            static::SUNDAY,
-        ];
-    }
-
-    public static function mapDays(callable $callback): array
-    {
-        return Arr::map(Arr::mirror(static::days()), $callback);
-    }
-
-    public static function isValid(string $day): bool
+    case MONDAY = 'monday';
+    case TUESDAY = 'tuesday';
+    case WEDNESDAY = 'wednesday';
+    case THURSDAY = 'thursday';
+    case FRIDAY = 'friday';
+    case SATURDAY = 'saturday';
+    case SUNDAY = 'sunday';
+
+    public static function onDateTime(DateTimeInterface $dateTime): self
     {
-        return in_array($day, static::days());
+        return self::fromName($dateTime->format('l'));
     }
 
-    public static function onDateTime(DateTimeInterface $dateTime): string
+    public static function fromName(string $day): self
     {
-        return static::days()[$dateTime->format('N') - 1];
+        return self::from(strtolower($day));
     }
 
-    public static function toISO(string $day): int
+    public function toISO(): int
     {
-        return array_search($day, static::days()) + 1;
+        return array_search($this, self::cases()) + 1;
     }
 }
diff --git a/src/Helpers/Arr.php b/src/Helpers/Arr.php
@@ -35,7 +35,7 @@ public static function flatMap(array $array, callable $callback): array
         return $flattened;
     }
 
-    public static function pull(&$array, $key, $default = null)
+    public static function pull(array &$array, string $key, mixed $default = null): mixed
     {
         $value = $array[$key] ?? $default;
 
@@ -44,11 +44,6 @@ public static function pull(&$array, $key, $default = null)
         return $value;
     }
 
-    public static function mirror(array $array): array
-    {
-        return array_combine($array, $array);
-    }
-
     public static function createUniquePairs(array $array): array
     {
         $pairs = [];

diff --git a/src/Helpers/DataTrait.php b/src/Helpers/DataTrait.php
@@ -4,10 +4,9 @@
 
 trait DataTrait
 {
-    /** @var mixed */
-    protected $data = null;
+    protected readonly mixed $data;
 
-    public function getData()
+    public function getData(): mixed
     {
         return $this->data;
     }

diff --git a/src/Helpers/DiffTrait.php b/src/Helpers/DiffTrait.php
@@ -6,9 +6,14 @@
 
 trait DiffTrait
 {
-    private function diffInSeconds(string $stateCheckMethod, string $nextDateMethod, string $skipDateMethod, DateTimeInterface $startDate, DateTimeInterface $endDate): float
-    {
-        $time = 0;
+    private function diffInSeconds(
+        string $stateCheckMethod,
+        string $nextDateMethod,
+        string $skipDateMethod,
+        DateTimeInterface $startDate,
+        DateTimeInterface $endDate,
+    ): float {
+        $time = 0.0;
 
         if ($endDate < $startDate) {
             return -$this->diffInSeconds($stateCheckMethod, $nextDateMethod, $skipDateMethod, $endDate, $startDate);
@@ -24,7 +29,7 @@ private function diffInSeconds(string $stateCheckMethod, string $nextDateMethod,
             }
 
             $nextDate = min($endDate, $this->$nextDateMethod($date, null, $endDate));
-            $time += floatval($nextDate->format('U.u')) - floatval($date->format('U.u'));
+            $time += ((float) $nextDate->format('U.u')) - ((float) $date->format('U.u'));
             $date = $nextDate;
         }
 

diff --git a/src/Helpers/RangeFinder.php b/src/Helpers/RangeFinder.php
@@ -14,9 +14,7 @@ protected function findRangeInFreeTime(Time $time, TimeRange $timeRange): ?TimeR
 
     protected function findOpenInFreeTime(Time $time, TimeRange $timeRange): ?Time
     {
-        $range = $this->findRangeInFreeTime($time, $timeRange);
-
-        return $range ? $range->start() : null;
+        return $this->findRangeInFreeTime($time, $timeRange)?->start();
     }
 
     protected function findOpenRangeInWorkingHours(Time $time, TimeRange $timeRange): ?TimeRange
@@ -26,9 +24,7 @@ protected function findOpenRangeInWorkingHours(Time $time, TimeRange $timeRange)
 
     protected function findOpenInWorkingHours(Time $time, TimeRange $timeRange): ?Time
     {
-        $range = $this->findOpenRangeInWorkingHours($time, $timeRange);
-
-        return $range ? $range->start() : null;
+        return $this->findOpenRangeInWorkingHours($time, $timeRange)?->start();
     }
 
     protected function findCloseInWorkingHours(Time $time, TimeRange $timeRange): ?Time
@@ -43,9 +39,7 @@ protected function findCloseRangeInWorkingHours(Time $time, TimeRange $timeRange
 
     protected function findCloseInFreeTime(Time $time, TimeRange $timeRange): ?Time
     {
-        $range = $this->findRangeInFreeTime($time, $timeRange);
-
-        return $range ? $range->end() : null;
+        return $this->findRangeInFreeTime($time, $timeRange)?->end();
     }
 
     protected function findPreviousRangeInFreeTime(Time $time, TimeRange $timeRange): ?TimeRange
@@ -55,9 +49,7 @@ protected function findPreviousRangeInFreeTime(Time $time, TimeRange $timeRange)
 
     protected function findPreviousOpenInFreeTime(Time $time, TimeRange $timeRange): ?Time
     {
-        $range = $this->findPreviousRangeInFreeTime($time, $timeRange);
-
-        return $range ? $range->start() : null;
+        return $this->findPreviousRangeInFreeTime($time, $timeRange)?->start();
     }
 
     protected function findPreviousCloseInWorkingHours(Time $time, TimeRange $timeRange): ?Time