Add period range, update to php 8.5

Author: Stephan Wentz

.github/workflows/build.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
   push:
     branches:
-      - "master"
+      - "main"
 
 jobs:
   tests:

.github/workflows/code_coverage.yaml

@@ -4,7 +4,7 @@ on:
   pull_request: null
   push:
     branches:
-      - master
+      - main
 
 jobs:
   code_coverage:

.github/workflows/release.yaml

@@ -5,7 +5,7 @@ name: "Release"
 on:
   push:
     branches:
-      - "master"
+      - "main"
 
 jobs:
   tests:

composer.json

@@ -11,7 +11,7 @@
         }
     ],
     "require": {
-        "php": "^8.3",
+        "php": "^8.5",
         "ext-date": "*",
         "psr/clock": "^1.0"
     },
@@ -20,8 +20,8 @@
         "ergebnis/phpstan-rules": "^2.0",
         "lcobucci/clock": "^3.0",
         "phpstan/phpstan": "^2.0",
-        "phpunit/phpunit": "^12.0",
-        "symfony/serializer": "^6.0|^7.0",
+        "phpunit/phpunit": "^13.0",
+        "symfony/serializer": "^6.0|^7.0|^8.0",
         "twig/twig": "^3.0",
         "roave/backward-compatibility-check": "^8.2"
     },

phpstan.neon.dist

@@ -5,6 +5,8 @@ parameters:
         - src
         - tests
     ergebnis:
+        noPhpstanIgnore:
+            enabled: false
         noNullableReturnTypeDeclaration:
             enabled: false
         noParameterWithNullableTypeDeclaration:

src/Exception/MismatchingPeriods.php

@@ -19,4 +19,9 @@ public static function differ(Period $period, Period $otherPeriod): self
             $otherPeriod::class,
         ));
     }
+
+    public static function empty(): self
+    {
+        return new self('Empty periods are not allowed.');
+    }
 }

src/PeriodFactory.php

@@ -7,7 +7,6 @@
 use Brainbits\Period\Exception\InvalidPeriodIdentifier;
 use Brainbits\Period\Exception\MismatchingPeriods;
 use DateTimeImmutable;
-use Generator;
 use Psr\Clock\ClockInterface;
 
 use function sprintf;
@@ -213,24 +212,21 @@ public function fromIdentifier(string $periodIdentifier): Period
         };
     }
 
-    /**
-     * @param T $period
-     * @param T $toPeriod
-     *
-     * @return Generator<T>
-     *
-     * @template T of Period
-     */
-    public function fromTo(Period $period, Period $toPeriod): Generator
+    public function fromTo(Period $fromPeriod, Period $toPeriod): PeriodRange
     {
-        if ($period::class !== $toPeriod::class) {
-            throw MismatchingPeriods::differ($period, $toPeriod);
+        if ($fromPeriod::class !== $toPeriod::class) {
+            throw MismatchingPeriods::differ($fromPeriod, $toPeriod);
         }
 
+        $period = $fromPeriod;
+        $periods = [];
+
         do {
-            yield $period;
+            $periods[] = $period;
 
             $period = $this->next($period);
         } while ($period->getPeriodString() < $toPeriod->getPeriodString());
+
+        return new PeriodRange(...$periods);
     }
 }

src/PeriodRange.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Brainbits\Period;
+
+use Brainbits\Period\Exception\MismatchingPeriods;
+use IteratorAggregate;
+use Traversable;
+
+use function array_first;
+use function array_last;
+use function array_values;
+
+/** @implements IteratorAggregate<Period> */
+final class PeriodRange implements IteratorAggregate
+{
+    /** @var non-empty-list<Period> */
+    private array $periods;
+
+    public function __construct(Period ...$periods)
+    {
+        if (!$periods) {
+            throw MismatchingPeriods::empty();
+        }
+
+        $firstPeriod = null;
+        foreach ($periods as $period) {
+            if ($firstPeriod === null) {
+                $firstPeriod = $period;
+                continue;
+            }
+
+            if ($firstPeriod::class !== $period::class) {
+                throw MismatchingPeriods::differ($firstPeriod, $period);
+            }
+        }
+
+        $this->periods = array_values($periods);
+    }
+
+    public function startPeriod(): Period
+    {
+        return array_first($this->periods);
+    }
+
+    public function endPeriod(): Period
+    {
+        return array_last($this->periods);
+    }
+
+    /** @return Traversable<Period> */
+    public function getIterator(): Traversable
+    {
+        yield from $this->periods;
+    }
+}