✨ DateTimeCollection

src/ObjectCollection/DateTime/ContainsDateTimeNullableValueTrait.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Steevanb\PhpCollection\ObjectCollection\DateTime;
+
+trait ContainsDateTimeNullableValueTrait
+{
+    public function containsDateTimeValue(\DateTimeInterface $dateTime): bool
+    {
+        foreach ($this->toArray() as $value) {
+            if (
+                $value === null
+                || ($dateTime->getTimestamp() + $dateTime->getOffset())
+                !== ($value->getTimestamp() + $value->getOffset())
+            ) {
+                continue;
+            }
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /** @return array<?\DateTimeInterface> */
+    abstract protected function toArray(): array;
+}

src/ObjectCollection/DateTime/ContainsDateTimeValueTrait.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Steevanb\PhpCollection\ObjectCollection\DateTime;
+
+trait ContainsDateTimeValueTrait
+{
+    public function containsDateTimeValue(\DateTimeInterface $dateTime): bool
+    {
+        foreach ($this->toArray() as $value) {
+            if (
+                ($dateTime->getTimestamp() + $dateTime->getOffset())
+                !== ($value->getTimestamp() + $value->getOffset())
+            ) {
+                continue;
+            }
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /** @return array<\DateTimeInterface> */
+    abstract protected function toArray(): array;
+}

src/ObjectCollection/DateTimeCollection.php

@@ -4,9 +4,13 @@
 
 namespace Steevanb\PhpCollection\ObjectCollection;
 
+use Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeValueTrait;
+
 /** @extends AbstractObjectCollection<\DateTime> */
 class DateTimeCollection extends AbstractObjectCollection
 {
+    use ContainsDateTimeValueTrait;
+
     public static function getValueFqcn(): string
     {
         return \DateTime::class;

src/ObjectCollection/DateTimeImmutableCollection.php

@@ -4,9 +4,13 @@
 
 namespace Steevanb\PhpCollection\ObjectCollection;
 
+use Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeValueTrait;
+
 /** @extends AbstractObjectCollection<\DateTimeImmutable> */
 class DateTimeImmutableCollection extends AbstractObjectCollection
 {
+    use ContainsDateTimeValueTrait;
+
     public static function getValueFqcn(): string
     {
         return \DateTimeImmutable::class;

src/ObjectCollection/DateTimeImmutableNullableCollection.php

@@ -4,9 +4,13 @@
 
 namespace Steevanb\PhpCollection\ObjectCollection;
 
+use Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeNullableValueTrait;
+
 /** @extends AbstractObjectNullableCollection<\DateTimeImmutable|null> */
 class DateTimeImmutableNullableCollection extends AbstractObjectNullableCollection
 {
+    use ContainsDateTimeNullableValueTrait;
+
     public static function getValueFqcn(): string
     {
         return \DateTimeImmutable::class;

src/ObjectCollection/DateTimeInterfaceCollection.php

@@ -4,9 +4,13 @@
 
 namespace Steevanb\PhpCollection\ObjectCollection;
 
+use Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeValueTrait;
+
 /** @extends AbstractObjectCollection<\DateTimeInterface> */
 class DateTimeInterfaceCollection extends AbstractObjectCollection
 {
+    use ContainsDateTimeValueTrait;
+
     public static function getValueFqcn(): string
     {
         return \DateTimeInterface::class;

src/ObjectCollection/DateTimeInterfaceNullableCollection.php

@@ -4,9 +4,13 @@
 
 namespace Steevanb\PhpCollection\ObjectCollection;
 
+use Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeNullableValueTrait;
+
 /** @extends AbstractObjectNullableCollection<\DateTimeInterface|null> */
 class DateTimeInterfaceNullableCollection extends AbstractObjectNullableCollection
 {
+    use ContainsDateTimeNullableValueTrait;
+
     public static function getValueFqcn(): string
     {
         return \DateTimeInterface::class;

src/ObjectCollection/DateTimeNullableCollection.php

@@ -4,9 +4,13 @@
 
 namespace Steevanb\PhpCollection\ObjectCollection;
 
+use Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeNullableValueTrait;
+
 /** @extends AbstractObjectNullableCollection<\DateTime|null> */
 class DateTimeNullableCollection extends AbstractObjectNullableCollection
 {
+    use ContainsDateTimeNullableValueTrait;
+
     public static function getValueFqcn(): string
     {
         return \DateTime::class;

tests/Unit/ObjectCollection/DateTime/ContainsDateTimeValue/TraitUsageTest.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Steevanb\PhpCollection\Tests\Unit\ObjectCollection\DateTime\ContainsDateTimeValue;
+
+use PHPUnit\Framework\TestCase;
+use Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeNullableValueTrait;
+use Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeValueTrait;
+use Steevanb\PhpCollection\ObjectCollection\DateTimeCollection;
+use Steevanb\PhpCollection\ObjectCollection\DateTimeImmutableCollection;
+use Steevanb\PhpCollection\ObjectCollection\DateTimeImmutableNullableCollection;
+use Steevanb\PhpCollection\ObjectCollection\DateTimeInterfaceCollection;
+use Steevanb\PhpCollection\ObjectCollection\DateTimeInterfaceNullableCollection;
+use Steevanb\PhpCollection\ObjectCollection\DateTimeNullableCollection;
+
+/**
+ * @covers \Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeValueTrait
+ * @covers \Steevanb\PhpCollection\ObjectCollection\DateTime\ContainsDateTimeNullableValueTrait
+ * @internal
+ */
+final class TraitUsageTest extends TestCase
+{
+    /**
+     * @dataProvider provideCollectionUsingTrait
+     * @param class-string $class
+     */
+    public function testUsingTrait(string $class): void
+    {
+        $reflectionCollection = new \ReflectionClass($class);
+        static::assertContains(
+            needle: ContainsDateTimeValueTrait::class,
+            haystack: array_map(
+                static fn (\ReflectionClass $reflectionTrait): string => $reflectionTrait->getName(),
+                $reflectionCollection->getTraits()
+            )
+        );
+    }
+
+    /**
+     * @dataProvider provideCollectionUsingNullableTrait
+     * @param class-string $class
+     */
+    public function testUsingNullableTrait(string $class): void
+    {
+        $reflectionCollection = new \ReflectionClass($class);
+        static::assertContains(
+            needle: ContainsDateTimeNullableValueTrait::class,
+            haystack: array_map(
+                static fn (\ReflectionClass $reflectionTrait): string => $reflectionTrait->getName(),
+                $reflectionCollection->getTraits()
+            )
+        );
+    }
+
+    /** @return iterable<string, array{class: class-string}> */
+    public static function provideCollectionUsingTrait(): iterable
+    {
+        yield 'ContainsDateTimeValueTrait_is_used_by_DateTimeCollection' => [
+            'class' => DateTimeCollection::class,
+        ];
+        yield 'ContainsDateTimeValueTrait_is_used_by_DateTimeImmutableCollection' => [
+            'class' => DateTimeImmutableCollection::class,
+        ];
+        yield 'ContainsDateTimeValueTrait_is_used_by_DateTimeInterfaceCollection' => [
+            'class' => DateTimeInterfaceCollection::class,
+        ];
+    }
+
+    /** @return iterable<string, array{class: class-string}> */
+    public static function provideCollectionUsingNullableTrait(): iterable
+    {
+        yield 'ContainsDateTimeNullableValueTrait_is_used_by_DateTimeNullableCollection' => [
+            'class' => DateTimeNullableCollection::class,
+        ];
+        yield 'ContainsDateTimeNullableValueTrait_is_used_by_DateTimeImmutableNullableCollection' => [
+            'class' => DateTimeImmutableNullableCollection::class,
+        ];
+        yield 'ContainsDateTimeNullableValueTrait_is_used_by_DateTimeInterfaceNullableCollection' => [
+            'class' => DateTimeInterfaceNullableCollection::class,
+        ];
+    }
+}

tests/Unit/ObjectCollection/DateTimeCollection/ContainsDateTimeValueTest.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Steevanb\PhpCollection\Tests\Unit\ObjectCollection\DateTimeCollection;
+
+use PHPUnit\Framework\TestCase;
+use Steevanb\PhpCollection\ObjectCollection\DateTimeCollection;
+
+/**
+ * @covers \Steevanb\PhpCollection\ObjectCollection\DateTimeCollection::containsDateTimeValue
+ * @internal
+ */
+final class ContainsDateTimeValueTest extends TestCase
+{
+    public function testContainsDateTimeValue(): void
+    {
+        $dateTimeA = new \DateTime();
+        $dateTimeCopy = $dateTimeA;
+        // Asserting different timestamps
+        $dateTimeB = (new \DateTime())->add(new \DateInterval('PT1S'));
+        $dateTimeClone = clone $dateTimeA;
+        $dateTimeSameTime = (new \DateTime())->setTimestamp($dateTimeA->getTimestamp());
+
+        $dateTimeCollection = new DateTimeCollection([$dateTimeA]);
+
+        static::assertTrue($dateTimeCollection->containsDateTimeValue($dateTimeA));
+        static::assertTrue($dateTimeCollection->containsDateTimeValue($dateTimeCopy));
+        static::assertFalse($dateTimeCollection->containsDateTimeValue($dateTimeB));
+        static::assertTrue($dateTimeCollection->containsDateTimeValue($dateTimeClone));
+        static::assertTrue($dateTimeCollection->containsDateTimeValue($dateTimeSameTime));
+    }
+
+    public function testContainsDateTimeValueWithTimezone(): void
+    {
+        $dateTime = new \DateTime('2024-07-14 12:00:00');
+        $dateTimeB = clone $dateTime;
+        $dateTimeC = clone $dateTime;
+        $dateTimeD = clone $dateTime;
+
+        // Setting timezones
+        $dateTime->setTimezone(new \DateTimeZone('+0800'));
+        $dateTimeB->setTimezone(new \DateTimeZone('+0600'));
+        $dateTimeC->setTimezone(new \DateTimeZone('-0600'));
+        $dateTimeD->setTimezone($dateTime->getTimezone());
+
+        $dateTimeCollection = new DateTimeCollection([$dateTime]);
+
+        static::assertFalse($dateTimeCollection->containsDateTimeValue($dateTimeB));
+        static::assertFalse($dateTimeCollection->containsDateTimeValue($dateTimeC));
+        static::assertTrue($dateTimeCollection->containsDateTimeValue($dateTimeD));
+    }
+
+    public function testContainsDateTimeValueAfterClone(): void
+    {
+        $dateTime = new \DateTime();
+
+        $dateTimeCollection = (new DateTimeCollection([$dateTime]));
+        $dateTimeCollectionClone = clone ($dateTimeCollection);
+
+        static::assertTrue($dateTimeCollection->containsDateTimeValue($dateTime));
+        static::assertTrue($dateTimeCollectionClone->containsDateTimeValue($dateTime));
+    }
+
+    public function testContainsDateTimeValueAfterMerge(): void
+    {
+        $dateTime = new \DateTime();
+
+        static::assertTrue(
+            (new DateTimeCollection([$dateTime]))
+                ->merge(new DateTimeCollection([new \DateTime()]))
+                ->containsDateTimeValue($dateTime)
+        );
+    }
+}

tests/Unit/ObjectCollection/DateTimeCollection/ContainsTest.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Steevanb\PhpCollection\Tests\Unit\ObjectCollection\DateTimeCollection;
+
+use PHPUnit\Framework\TestCase;
+use Steevanb\PhpCollection\ObjectCollection\DateTimeCollection;
+
+/**
+ * @covers \Steevanb\PhpCollection\ObjectCollection\DateTimeCollection::contains
+ * @internal
+ */
+final class ContainsTest extends TestCase
+{
+    public function testContains(): void
+    {
+        $dateTimeA = new \DateTime();
+        $dateTimeCopy = $dateTimeA;
+        $dateTimeB = new \DateTime();
+        $dateTimeClone = clone $dateTimeA;
+        $dateTimeSameTime = (new \DateTime())->setTimestamp($dateTimeA->getTimestamp());
+
+        $dateTimeCollection = new DateTimeCollection([$dateTimeA]);
+
+        static::assertTrue($dateTimeCollection->contains($dateTimeA));
+        static::assertTrue($dateTimeCollection->contains($dateTimeCopy));
+        static::assertFalse($dateTimeCollection->contains($dateTimeB));
+        static::assertFalse($dateTimeCollection->contains($dateTimeClone));
+        static::assertFalse($dateTimeCollection->contains($dateTimeSameTime));
+    }
+
+    public function testContainsAfterClone(): void
+    {
+        $dateTime = new \DateTime();
+
+        $dateTimeCollection = (new DateTimeCollection([$dateTime]));
+        $dateTimeCollectionClone = clone ($dateTimeCollection);
+
+        static::assertTrue($dateTimeCollection->contains($dateTime));
+        static::assertTrue($dateTimeCollectionClone->contains($dateTime));
+    }
+
+    public function testContainsAfterMerge(): void
+    {
+        $dateTime = new \DateTime();
+
+        static::assertTrue(
+            (new DateTimeCollection([$dateTime]))
+                ->merge(new DateTimeCollection([new \DateTime()]))
+                ->contains($dateTime)
+        );
+    }
+}