tests: add functional test

.dagger/src/CalendR.php

@@ -66,10 +66,39 @@ public function test(
         #[DefaultPath('.')] Directory $source,
         string $phpVersion = '8.4',
         string $dependencyVersion = 'highest',
-    ): string {
-        return $this
+        ?string $coverallsRepoToken = null,
+        ?string $ciName = null,
+        ?string $ciJobId = null,
+        ?string $ciBranch = null,
+    ): string
+    {
+        $container = $this
             ->build($source, $phpVersion, $dependencyVersion)
-            ->withExec(['php', './vendor/bin/phpunit', '--coverage-text'])
+            ->withFile('/tmp/coveralls-linux.tar.gz', dag()->http('https://coveralls.io/coveralls-linux.tar.gz'))
+            ->withExec(['tar', '-xvzf', '/tmp/coveralls-linux.tar.gz', '-C', '/usr/local/bin']);
+
+
+        $exec = ['php', './vendor/bin/phpunit', '--coverage-text'];
+        if ($coverallsRepoToken) {
+            $exec[] = '--coverage-clover=build/logs/clover.xml';
+
+            $container = $container->withEnvVariable('COVERALLS_REPO_TOKEN', $coverallsRepoToken);
+        }
+
+        if ($ciName && $ciJobId && $ciBranch) {
+            $container = $container
+                ->withEnvVariable('CI_NAME', $ciName)
+                ->withEnvVariable('CI_JOB_ID', $ciJobId)
+                ->withEnvVariable('CI_BRANCH', $ciBranch);
+        }
+
+        $container = $container->withExec($exec);
+
+        if ($coverallsRepoToken) {
+            $container = $container->withExec(['coveralls', 'report']);
+        }
+
+        return $container
             ->stdout();
     }
 

.github/workflows/ci.yml

@@ -56,7 +56,7 @@ jobs:
           with:
             version: "latest"
             verb: call
-            args: test --source=. --php-version=${{ matrix.php-versions }} --dependency-version=${{ matrix.dependencies-versions }}
+            args: test --source=. --php-version=${{ matrix.php-versions }} --dependency-version=${{ matrix.dependencies-versions }} --coveralls-repo-token=${{ secrets.COVERALLS_REPO_TOKEN }} --ci-name=gha --ci-job-id=${{ github.run_id }} --ci-branch=${{ github.ref }}
             cloud-token: ${{ secrets.DAGGER_CLOUD_TOKEN }}
 
   mutation:

README.md

@@ -5,6 +5,7 @@
 CalendR provides a clean, immutable, and iterable API to manipulate time periods (Years, Months, Weeks, Days...) and manage associated events.
 
 [![CI Status](https://github.com/yohang/CalendR/actions/workflows/ci.yml/badge.svg)](https://github.com/yohang/CalendR/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/yohang/CalendR/badge.svg?branch=master)](https://coveralls.io/github/yohang/CalendR?branch=main)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyohang%2FCalendR%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/yohang/CalendR/main)
 
 ## ✨ Features

src/Bridge/Symfony/Bundle/DependencyInjection/CalendRExtension.php

@@ -27,7 +27,7 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $defaultFirstWeekday = $config['periods']['default_first_weekday'];
         if (!($defaultFirstWeekday instanceof DayOfWeek)) {
-            $defaultFirstWeekday = DayOfWeek::from($defaultFirstWeekday);
+            $defaultFirstWeekday = DayOfWeek::from($defaultFirstWeekday); // @codeCoverageIgnore
         }
 
         $container

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -28,13 +28,15 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->enumFqcn(DayOfWeek::class)
                 ->defaultValue(DayOfWeek::MONDAY);
         } else {
+            // @codeCoverageIgnoreStart
             $enumNode
                 ->values(array_map(fn (DayOfWeek $dayOfWeek) => $dayOfWeek->value, DayOfWeek::cases()))
                 ->defaultValue(DayOfWeek::MONDAY->value)
                 ->validate()
                     ->ifNotInArray(array_map(static fn (DayOfWeek $d) => $d->value, DayOfWeek::cases()))
                     ->thenInvalid('Day must be be between 0 (Sunday) and 6 (Saturday)')
                 ->end();
+            // @codeCoverageIgnoreEnd
         }
 
         return $treeBuilder;

src/Bridge/Symfony/Bundle/Resources/config/services.php

@@ -5,7 +5,7 @@
 use CalendR\Bridge\Twig\CalendRExtension;
 use CalendR\Calendar;
 use CalendR\Event\EventManager;
-use CalendR\Period\PeriodPeriodFactory;
+use CalendR\Period\PeriodFactory;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
@@ -16,12 +16,12 @@
             ->public();
 
     $container->services()
-        ->set(PeriodPeriodFactory::class)
+        ->set(PeriodFactory::class)
             ->public();
 
     $container->services()
         ->set(Calendar::class)
-            ->arg('$factory', service(PeriodPeriodFactory::class))
+            ->arg('$factory', service(PeriodFactory::class))
             ->arg('$eventManager', service(EventManager::class))
             ->public();
 
@@ -35,7 +35,7 @@
             ->public();
 
     $container->services()
-        ->alias('calendr.factory', PeriodPeriodFactory::class)
+        ->alias('calendr.factory', PeriodFactory::class)
             ->public();
 
     $container->services()

src/Calendar.php

@@ -11,9 +11,9 @@
 use CalendR\Period\Hour;
 use CalendR\Period\Minute;
 use CalendR\Period\Month;
+use CalendR\Period\PeriodFactory;
 use CalendR\Period\PeriodFactoryInterface;
 use CalendR\Period\PeriodInterface;
-use CalendR\Period\PeriodPeriodFactory;
 use CalendR\Period\Second;
 use CalendR\Period\Week;
 use CalendR\Period\Year;
@@ -26,7 +26,7 @@
 readonly class Calendar
 {
     public function __construct(
-        protected PeriodFactoryInterface $factory = new PeriodPeriodFactory(),
+        protected PeriodFactoryInterface $factory = new PeriodFactory(),
         private EventManager $eventManager = new EventManager(),
     ) {
     }

src/Event/Collection/IndexedCollection.php

@@ -47,10 +47,7 @@ final class IndexedCollection implements CollectionInterface, \IteratorAggregate
      */
     public function __construct(array $events = [], ?callable $callable = null)
     {
-        $this->indexFunction = (static fn (\DateTimeInterface $dateTime): string => $dateTime->format('Y-m-d'));
-        if (\is_callable($callable)) {
-            $this->indexFunction = $callable;
-        }
+        $this->indexFunction = $callable ?? static fn (\DateTimeInterface $dateTime): string => $dateTime->format('Y-m-d');
 
         foreach ($events as $event) {
             $this->add($event);

src/Period/Month.php

@@ -33,7 +33,7 @@ public function getDays(): array
 
     /**
      * Returns the first day of the first week of month.
-     * First day of week is configurable via {@link PeriodPeriodFactory}.
+     * First day of week is configurable via {@link PeriodFactory}.
      */
     public function getFirstDayOfFirstWeek(): \DateTimeImmutable
     {
@@ -51,7 +51,7 @@ public function getExtendedMonth(): PeriodInterface
 
     /**
      * Returns the last day of last week of month
-     * First day of week is configurable via {@link PeriodPeriodFactory}.
+     * First day of week is configurable via {@link PeriodFactory}.
      */
     public function getLastDayOfLastWeek(): \DateTimeImmutable
     {

src/Period/PeriodAbstract.php

@@ -110,7 +110,7 @@ public function getEnd(): \DateTimeImmutable
     protected function getFactory(): PeriodFactoryInterface
     {
         if (null === $this->factory) {
-            $this->factory = new PeriodPeriodFactory();
+            $this->factory = new PeriodFactory();
         }
 
         return $this->factory;

src/Period/PeriodPeriodFactory.php → src/Period/PeriodFactory.php

@@ -6,7 +6,7 @@
 
 use CalendR\DayOfWeek;
 
-final class PeriodPeriodFactory implements PeriodFactoryInterface
+final class PeriodFactory implements PeriodFactoryInterface
 {
     public function __construct(
         private DayOfWeek $firstWeekday = DayOfWeek::MONDAY,

src/Period/Range.php

@@ -18,7 +18,7 @@ public function __construct(\DateTimeInterface $begin, \DateTimeInterface $end,
     #[\Override]
     public static function isValid(\DateTimeInterface $start): bool
     {
-        return true;
+        throw new NotImplemented('Range period doesn\'t support isValid().');
     }
 
     #[\Override]

tests/Bridge/Symfony/Functional/ServicesRegistrationTest.php

@@ -6,7 +6,7 @@
 
 use CalendR\Calendar;
 use CalendR\Event\EventManager;
-use CalendR\Period\PeriodPeriodFactory;
+use CalendR\Period\PeriodFactory;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 
 final class ServicesRegistrationTest extends KernelTestCase
@@ -19,7 +19,7 @@ protected function tearDown(): void
     public function testServicesAccessibles(): void
     {
         $this->assertInstanceOf(Calendar::class, self::getContainer()->get('calendr'));
-        $this->assertInstanceOf(PeriodPeriodFactory::class, self::getContainer()->get('calendr.factory'));
+        $this->assertInstanceOf(PeriodFactory::class, self::getContainer()->get('calendr.factory'));
         $this->assertInstanceOf(EventManager::class, self::getContainer()->get('calendr.event_manager'));
     }
 }

tests/Event/Collection/BasicTest.php → tests/Event/Collection/ArrayCollectionTest.php

@@ -13,7 +13,7 @@
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
 
-final class BasicTest extends TestCase
+final class ArrayCollectionTest extends TestCase
 {
     use ProphecyTrait;
 
@@ -104,4 +104,13 @@ public function testAll(): void
         }
         $this->assertCount(\count($this->collection), $this->collection->all());
     }
+
+    public function testIterationIsIndexed(): void
+    {
+        $collection = new ArrayCollection(self::$events);
+        foreach ($collection as $index => $events) {
+            $this->assertIsInt($index);
+            $this->assertInstanceOf(Event::class, $events);
+        }
+    }
 }

tests/Event/Collection/IndexedTest.php → tests/Event/Collection/IndexedCollectionTest.php

@@ -11,7 +11,7 @@
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
 
-final class IndexedTest extends TestCase
+final class IndexedCollectionTest extends TestCase
 {
     use ProphecyTrait;
 
@@ -103,4 +103,16 @@ public function testAll(): void
             $this->assertSame(self::$events[$index], $event);
         }
     }
+
+    public function testIterationIsIndexed(): void
+    {
+        $indexFunction = function (\DateTimeInterface $dateTime): string {
+            return 'i-'.$dateTime->format('W');
+        };
+
+        $collection = new IndexedCollection(self::$events, $indexFunction);
+        foreach ($collection as $index => $events) {
+            $this->assertSame('i-19', $index);
+        }
+    }
 }

tests/Event/EventTest.php

@@ -5,8 +5,10 @@
 namespace CalendR\Test\Event;
 
 use CalendR\Event\Event;
+use CalendR\Event\EventInterface;
 use CalendR\Event\Exception\InvalidEvent;
 use CalendR\Period\Day;
+use CalendR\Period\Month;
 use CalendR\Period\PeriodInterface;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
@@ -69,4 +71,19 @@ public static function provideDates(): iterable
         yield ['begin' => '2025-11-29 00:00:00', 'end' => '2025-11-30 00:00:00', 'date' => new \DateTimeImmutable('2025-11-29 00:00:00'), 'expected' => true];
         yield ['begin' => '2025-11-29 00:00:00', 'end' => '2025-11-30 00:00:00', 'date' => new \DateTimeImmutable('2025-11-30 00:00:00'), 'expected' => false];
     }
+
+    #[DataProvider('providerForDuring')]
+    public function testIsDuring(EventInterface $event, PeriodInterface $period, bool $result): void
+    {
+        $this->assertSame($result, $event->isDuring($period));
+    }
+
+    public static function providerForDuring(): iterable
+    {
+        yield [new Event(new \DateTimeImmutable('2025-12-02 08:00'), new \DateTimeImmutable('2025-12-02 12:00')), new Day(new \DateTimeImmutable('2025-12-02')), true];
+        yield [new Event(new \DateTimeImmutable('2025-12-03'), new \DateTimeImmutable('2025-12-04')), new Month(new \DateTimeImmutable('2025-12-01')), true];
+        yield [new Event(new \DateTimeImmutable('2025-12-03'), new \DateTimeImmutable('2025-12-04')), new Month(new \DateTimeImmutable('2025-11-01')), false];
+        yield [new Event(new \DateTimeImmutable('2025-11-02'), new \DateTimeImmutable('2025-11-03')), new Day(new \DateTimeImmutable('2025-11-02')), false];
+        yield [new Event(new \DateTimeImmutable('2025-11-01'), new \DateTimeImmutable('2025-11-03')), new Month(new \DateTimeImmutable('2025-11-01')), true];
+    }
 }

tests/Event/Provider/AggregateTest.php

@@ -49,4 +49,12 @@ public function testGetEvents(): void
 
         $this->assertSame([$event1, $event2], $this->object->getEvents($begin, $end));
     }
+
+    public function testConstructorThrowsIfInvalidProvider(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Providers must implement CalendR\\Event\\ProviderInterface');
+
+        new AggregateProvider([new \stdClass()]);
+    }
 }

tests/Period/DayTest.php

@@ -7,9 +7,9 @@
 use CalendR\Period\Day;
 use CalendR\Period\Exception\NotADay;
 use CalendR\Period\Hour;
+use CalendR\Period\PeriodFactory;
 use CalendR\Period\PeriodFactoryInterface;
 use CalendR\Period\PeriodInterface;
-use CalendR\Period\PeriodPeriodFactory;
 use CalendR\Period\Range;
 use CalendR\Period\Year;
 use PHPUnit\Framework\Attributes\DataProvider;
@@ -178,7 +178,7 @@ public static function includesDataProvider(): \Iterator
     public function testIteration(): void
     {
         $start = new \DateTimeImmutable('2012-01-15');
-        $day = new Day($start, new PeriodPeriodFactory());
+        $day = new Day($start, new PeriodFactory());
 
         $i = 0;
 

tests/Period/FactoryTest.php

@@ -9,7 +9,7 @@
 use CalendR\Period\Hour;
 use CalendR\Period\Minute;
 use CalendR\Period\Month;
-use CalendR\Period\PeriodPeriodFactory;
+use CalendR\Period\PeriodFactory;
 use CalendR\Period\Range;
 use CalendR\Period\Second;
 use CalendR\Period\Week;
@@ -103,8 +103,8 @@ public static function providerGetFirstMondayAndLastSunday(): \Iterator
         yield [$factory->getMonth(2012, 12), '2012-11-26'];
     }
 
-    protected function getDefaultOptionsFactory(): PeriodPeriodFactory
+    protected function getDefaultOptionsFactory(): PeriodFactory
     {
-        return new PeriodPeriodFactory();
+        return new PeriodFactory();
     }
 }

tests/Period/HourTest.php

@@ -8,9 +8,9 @@
 use CalendR\Period\Exception\NotAnHour;
 use CalendR\Period\Hour;
 use CalendR\Period\Minute;
+use CalendR\Period\PeriodFactory;
 use CalendR\Period\PeriodFactoryInterface;
 use CalendR\Period\PeriodInterface;
-use CalendR\Period\PeriodPeriodFactory;
 use CalendR\Period\Second;
 use CalendR\Period\Year;
 use PHPUnit\Framework\Attributes\DataProvider;
@@ -214,7 +214,7 @@ public static function includesDataProvider(): \Iterator
     public function testIteration(): void
     {
         $start = new \DateTimeImmutable('2012-01-15 13:00');
-        $hour = new Hour($start, new PeriodPeriodFactory());
+        $hour = new Hour($start, new PeriodFactory());
 
         $i = 0;
         foreach ($hour as $minuteKey => $minute) {

tests/Period/MinuteTest.php

@@ -8,9 +8,9 @@
 use CalendR\Period\Exception\NotAMinute;
 use CalendR\Period\Hour;
 use CalendR\Period\Minute;
+use CalendR\Period\PeriodFactory;
 use CalendR\Period\PeriodFactoryInterface;
 use CalendR\Period\PeriodInterface;
-use CalendR\Period\PeriodPeriodFactory;
 use CalendR\Period\Second;
 use CalendR\Period\Year;
 use PHPUnit\Framework\Attributes\DataProvider;
@@ -229,7 +229,7 @@ public static function providerIncludes(): \Iterator
     public function testIteration(): void
     {
         $start = new \DateTimeImmutable('2012-01-15 15:47');
-        $minute = new Minute($start, new PeriodPeriodFactory());
+        $minute = new Minute($start, new PeriodFactory());
 
         $i = 0;
         foreach ($minute as $secondKey => $second) {