Added mustNotBeBefore and mustNotBeBeforeInTimeZone

digital-craftsman-de · Jun 17, 2024 · 5c9ad4f · 5c9ad4f
1 parent 25a6538
commit 5c9ad4f
Show file tree

Hide file tree

Showing 6 changed files with 230 additions and 0 deletions.
diff --git a/src/Exception/MomentIsBefore.php b/src/Exception/MomentIsBefore.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class MomentIsBefore extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The moment is before but must not be.');
+    }
+}
diff --git a/src/Moment.php b/src/Moment.php
@@ -748,4 +748,39 @@ public function mustBeBeforeInTimeZone(
                 : new Exception\MomentIsNotBefore();
         }
     }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\MomentIsBefore
+     */
+    public function mustNotBeBefore(
+        self $moment,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isBefore($moment)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\MomentIsBefore();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\MomentIsBefore
+     */
+    public function mustNotBeBeforeInTimeZone(
+        Time | Weekday | Date | Month | Year $moment,
+        \DateTimeZone $timeZone,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isBeforeInTimeZone($moment, $timeZone)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\MomentIsBefore();
+        }
+    }
 }
diff --git a/tests/Moment/MustNotBeBeforeInTimeZoneTest.php b/tests/Moment/MustNotBeBeforeInTimeZoneTest.php
@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Moment;
+
+use DigitalCraftsman\DateTimePrecision\Date;
+use DigitalCraftsman\DateTimePrecision\Exception\MomentIsBefore;
+use DigitalCraftsman\DateTimePrecision\Moment;
+use DigitalCraftsman\DateTimePrecision\Month;
+use DigitalCraftsman\DateTimePrecision\Test\Exception\CustomMomentIsBeforeInTimeZone;
+use DigitalCraftsman\DateTimePrecision\Time;
+use DigitalCraftsman\DateTimePrecision\Weekday;
+use DigitalCraftsman\DateTimePrecision\Year;
+use PHPUnit\Framework\TestCase;
+
+/** @coversDefaultClass \DigitalCraftsman\DateTimePrecision\Moment */
+final class MustNotBeBeforeInTimeZoneTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @param ?class-string<\Throwable> $expectedResult
+     *
+     * @dataProvider dataProvider
+     *
+     * @covers ::mustNotBeBeforeInTimeZone
+     */
+    public function must_not_be_before_in_time_zone_works(
+        ?string $expectedResult,
+        Moment $moment,
+        Time | Weekday | Date | Month | Year $comparator,
+        \DateTimeZone $timeZone,
+        ?callable $otherwiseThrow,
+    ): void {
+        // -- Act & Assert
+        if ($expectedResult !== null) {
+            $this->expectException($expectedResult);
+        } else {
+            $this->expectNotToPerformAssertions();
+        }
+
+        $moment->mustNotBeBeforeInTimeZone(
+            $comparator,
+            $timeZone,
+            $otherwiseThrow,
+        );
+    }
+
+    /**
+     * @return array<string, array{
+     *   0: ?string,
+     *   1: Moment,
+     *   2: Time | Weekday | Date | Month | Year,
+     *   3: \DateTimeZone,
+     *   4: ?callable(): \Throwable
+     * }>
+     */
+    public static function dataProvider(): array
+    {
+        return [
+            'without exception' => [
+                null,
+                Moment::fromStringInTimeZone('2022-10-08 15:00:00', new \DateTimeZone('Europe/Berlin')),
+                Time::fromString('15:00:00'),
+                new \DateTimeZone('Europe/Berlin'),
+                null,
+            ],
+            'default exception' => [
+                MomentIsBefore::class,
+                Moment::fromStringInTimeZone('2022-10-08 15:00:00', new \DateTimeZone('Europe/Berlin')),
+                Time::fromString('16:00:00'),
+                new \DateTimeZone('Europe/Berlin'),
+                null,
+            ],
+            'custom exception' => [
+                CustomMomentIsBeforeInTimeZone::class,
+                Moment::fromStringInTimeZone('2022-10-08 15:00:00', new \DateTimeZone('Europe/Berlin')),
+                Time::fromString('16:00:00'),
+                new \DateTimeZone('Europe/Berlin'),
+                static fn () => new CustomMomentIsBeforeInTimeZone(),
+            ],
+        ];
+    }
+}
diff --git a/tests/Moment/MustNotBeBeforeTest.php b/tests/Moment/MustNotBeBeforeTest.php
@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Moment;
+
+use DigitalCraftsman\DateTimePrecision\Exception\MomentIsBefore;
+use DigitalCraftsman\DateTimePrecision\Moment;
+use DigitalCraftsman\DateTimePrecision\Test\Exception\CustomMomentIsBefore;
+use PHPUnit\Framework\TestCase;
+
+/** @coversDefaultClass \DigitalCraftsman\DateTimePrecision\Moment */
+final class MustNotBeBeforeTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @param ?class-string<\Throwable> $expectedResult
+     *
+     * @dataProvider dataProvider
+     *
+     * @covers ::mustNotBeBefore
+     */
+    public function must_not_be_before_works(
+        ?string $expectedResult,
+        Moment $moment,
+        Moment $comparator,
+        ?callable $otherwiseThrow,
+    ): void {
+        // -- Act & Assert
+        if ($expectedResult !== null) {
+            $this->expectException($expectedResult);
+        } else {
+            $this->expectNotToPerformAssertions();
+        }
+
+        $moment->mustNotBeBefore(
+            $comparator,
+            $otherwiseThrow,
+        );
+    }
+
+    /**
+     * @return array<string, array{
+     *   0: ?string,
+     *   1: Moment,
+     *   2: Moment,
+     *   3: ?callable(): \Throwable
+     * }>
+     */
+    public static function dataProvider(): array
+    {
+        return [
+            'without exception' => [
+                null,
+                Moment::fromString('2022-10-08 16:00:00'),
+                Moment::fromString('2022-10-08 16:00:00'),
+                null,
+            ],
+            'default exception' => [
+                MomentIsBefore::class,
+                Moment::fromString('2022-10-08 15:00:00'),
+                Moment::fromString('2022-10-08 16:00:00'),
+                null,
+            ],
+            'custom exception' => [
+                CustomMomentIsBefore::class,
+                Moment::fromString('2022-10-08 15:00:00'),
+                Moment::fromString('2022-10-08 16:00:00'),
+                static fn () => new CustomMomentIsBefore(),
+            ],
+        ];
+    }
+}
diff --git a/tests/Test/Exception/CustomMomentIsBefore.php b/tests/Test/Exception/CustomMomentIsBefore.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Test\Exception;
+
+final class CustomMomentIsBefore extends \InvalidArgumentException
+{
+}
diff --git a/tests/Test/Exception/CustomMomentIsBeforeInTimeZone.php b/tests/Test/Exception/CustomMomentIsBeforeInTimeZone.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Test\Exception;
+
+final class CustomMomentIsBeforeInTimeZone extends \InvalidArgumentException
+{
+}