fix: Add fromTo generator

Author: Stephan Wentz

phpstan.neon.dist

@@ -1,5 +1,6 @@
 parameters:
     level: max
+    treatPhpDocTypesAsCertain: false
     paths:
         - src
         - tests

src/Exception/MismatchingPeriods.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Brainbits\Period\Exception;
+
+use Brainbits\Period\Period;
+use InvalidArgumentException;
+
+use function sprintf;
+
+final class MismatchingPeriods extends InvalidArgumentException implements PeriodException
+{
+    public static function differ(Period $period, Period $otherPeriod): self
+    {
+        return new self(sprintf(
+            'Both periods must have the same class, %s and %s given.',
+            $period::class,
+            $otherPeriod::class,
+        ));
+    }
+}

src/PeriodFactory.php

@@ -5,7 +5,9 @@
 namespace Brainbits\Period;
 
 use Brainbits\Period\Exception\InvalidPeriodIdentifier;
+use Brainbits\Period\Exception\MismatchingPeriods;
 use DateTimeImmutable;
+use Generator;
 use Psr\Clock\ClockInterface;
 
 use function sprintf;
@@ -210,4 +212,25 @@ public function fromIdentifier(string $periodIdentifier): Period
             default => throw InvalidPeriodIdentifier::unknownPeriodIdentifier($periodIdentifier),
         };
     }
+
+    /**
+     * @param T $period
+     * @param T $toPeriod
+     *
+     * @return Generator<T>
+     *
+     * @template T of Period
+     */
+    public function fromTo(Period $period, Period $toPeriod): Generator
+    {
+        if ($period::class !== $toPeriod::class) {
+            throw MismatchingPeriods::differ($period, $toPeriod);
+        }
+
+        do {
+            yield $period;
+
+            $period = $this->next($period);
+        } while ($period->getPeriodString() < $toPeriod->getPeriodString());
+    }
 }

src/Twig/Extension/PeriodExtension.php

@@ -59,7 +59,7 @@ public function parsePeriodIdentifier(string $periodIdentifier): Period
         return $this->periodFactory->fromIdentifier($periodIdentifier);
     }
 
-    public function monthPeriod($periodString): MonthPeriod|null
+    public function monthPeriod(string $periodString): MonthPeriod|null
     {
         return $periodString ? MonthPeriod::createFromPeriodString($periodString) : null;
     }

tests/PeriodFactoryTest.php

@@ -5,6 +5,7 @@
 namespace Brainbits\PeriodTest;
 
 use Brainbits\Period\DayPeriod;
+use Brainbits\Period\Exception\MismatchingPeriods;
 use Brainbits\Period\MonthPeriod;
 use Brainbits\Period\Period;
 use Brainbits\Period\PeriodFactory;
@@ -20,6 +21,8 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
+use function iterator_to_array;
+
 #[CoversClass(PeriodFactory::class)]
 final class PeriodFactoryTest extends TestCase
 {
@@ -656,4 +659,34 @@ public function testTranslationPeriods(Period $period, string $expected): void
     {
         self::assertSame($expected, $this->factory->getTranslationKey($period));
     }
+
+    public function testFromToThrowMismatchingException(): void
+    {
+        $this->expectException(MismatchingPeriods::class);
+        // phpcs:ignore Generic.Files.LineLength.TooLong
+        $this->expectExceptionMessage('Both periods must have the same class, Brainbits\Period\MonthPeriod and Brainbits\Period\WeekPeriod given.');
+
+        $fromTo = $this->factory->fromTo(
+            new MonthPeriod(new DateTimeImmutable('2024-03')),
+            new WeekPeriod(new DateTimeImmutable('2024-07')),
+        );
+
+        iterator_to_array($fromTo);
+    }
+
+    public function testFromTo(): void
+    {
+        $fromTo = $this->factory->fromTo(
+            new MonthPeriod(new DateTimeImmutable('2024-03')),
+            new MonthPeriod(new DateTimeImmutable('2024-07')),
+        );
+
+        $result = iterator_to_array($fromTo);
+        self::assertCount(4, $result);
+        self::assertContainsOnlyInstancesOf(MonthPeriod::class, $result);
+        self::assertSame('2024-03', $result[0]->getPeriodString());
+        self::assertSame('2024-04', $result[1]->getPeriodString());
+        self::assertSame('2024-05', $result[2]->getPeriodString());
+        self::assertSame('2024-06', $result[3]->getPeriodString());
+    }
 }

tests/Twig/Extension/PeriodExtensionTest.php

@@ -36,18 +36,42 @@ public function setUp(): void
 
     public function testGetFunctions(): void
     {
-        $this->assertContainsOnlyInstancesOf(TwigFunction::class, $this->extension->getFunctions());
+        $this->assertContainsOnlyInstancesOf(
+            TwigFunction::class,
+            $this->extension->getFunctions(),
+        );
     }
 
     public function testParsePeriodIdentifier(): void
     {
-        $this->assertEquals($this->periodFactory->currentDay(), $this->extension->parsePeriodIdentifier('day#2018-06-15'));
-        $this->assertEquals($this->periodFactory->currentWeek(), $this->extension->parsePeriodIdentifier('week#2018-24'));
-        $this->assertEquals($this->periodFactory->currentMonth(), $this->extension->parsePeriodIdentifier('month#2018-06'));
-        $this->assertEquals($this->periodFactory->currentYear(), $this->extension->parsePeriodIdentifier('year#2018'));
-        $this->assertEquals($this->periodFactory->currentRunningWeek(), $this->extension->parsePeriodIdentifier('running-week#2018-24'));
-        $this->assertEquals($this->periodFactory->currentRunningMonth(), $this->extension->parsePeriodIdentifier('running-month#2018-06'));
-        $this->assertEquals($this->periodFactory->currentRunningYear(), $this->extension->parsePeriodIdentifier('running-year#2018'));
+        $this->assertEquals(
+            $this->periodFactory->currentDay(),
+            $this->extension->parsePeriodIdentifier('day#2018-06-15'),
+        );
+        $this->assertEquals(
+            $this->periodFactory->currentWeek(),
+            $this->extension->parsePeriodIdentifier('week#2018-24'),
+        );
+        $this->assertEquals(
+            $this->periodFactory->currentMonth(),
+            $this->extension->parsePeriodIdentifier('month#2018-06'),
+        );
+        $this->assertEquals(
+            $this->periodFactory->currentYear(),
+            $this->extension->parsePeriodIdentifier('year#2018'),
+        );
+        $this->assertEquals(
+            $this->periodFactory->currentRunningWeek(),
+            $this->extension->parsePeriodIdentifier('running-week#2018-24'),
+        );
+        $this->assertEquals(
+            $this->periodFactory->currentRunningMonth(),
+            $this->extension->parsePeriodIdentifier('running-month#2018-06'),
+        );
+        $this->assertEquals(
+            $this->periodFactory->currentRunningYear(),
+            $this->extension->parsePeriodIdentifier('running-year#2018'),
+        );
     }
 
     public function testMonthPeriod(): void