From 0089e82cf754638c31f9a8bcf0db337621f2444f Mon Sep 17 00:00:00 2001
From: Christian Kolb <info@digital-craftsman.de>
Date: Mon, 17 Jun 2024 21:17:24 +0200
Subject: [PATCH] Added mustBeBeforeOrEqualTo and
 mustBeBeforeOrEqualToInTimeZone

---
 src/Exception/MomentIsNotBeforeOrEqualTo.php  | 18 ++++
 src/Moment.php                                | 35 ++++++++
 .../MustBeBeforeOrEqualToInTimeZoneTest.php   | 85 +++++++++++++++++++
 tests/Moment/MustBeBeforeOrEqualToTest.php    | 74 ++++++++++++++++
 .../CustomMomentIsNotBeforeOrEqualTo.php      |  9 ++
 ...omMomentIsNotBeforeOrEqualToInTimeZone.php |  9 ++
 6 files changed, 230 insertions(+)
 create mode 100644 src/Exception/MomentIsNotBeforeOrEqualTo.php
 create mode 100644 tests/Moment/MustBeBeforeOrEqualToInTimeZoneTest.php
 create mode 100644 tests/Moment/MustBeBeforeOrEqualToTest.php
 create mode 100644 tests/Test/Exception/CustomMomentIsNotBeforeOrEqualTo.php
 create mode 100644 tests/Test/Exception/CustomMomentIsNotBeforeOrEqualToInTimeZone.php

diff --git a/src/Exception/MomentIsNotBeforeOrEqualTo.php b/src/Exception/MomentIsNotBeforeOrEqualTo.php
new file mode 100644
index 0000000..78a6a9a
--- /dev/null
+++ b/src/Exception/MomentIsNotBeforeOrEqualTo.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class MomentIsNotBeforeOrEqualTo extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The moment is not before or equal to but must be.');
+    }
+}
diff --git a/src/Moment.php b/src/Moment.php
index 8292522..f577ee7 100644
--- a/src/Moment.php
+++ b/src/Moment.php
@@ -783,4 +783,39 @@ public function mustNotBeBeforeInTimeZone(
                 : new Exception\MomentIsBefore();
         }
     }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\MomentIsNotBeforeOrEqualTo
+     */
+    public function mustBeBeforeOrEqualTo(
+        self $moment,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isNotBeforeOrEqualTo($moment)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\MomentIsNotBeforeOrEqualTo();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\MomentIsNotBeforeOrEqualTo
+     */
+    public function mustBeBeforeOrEqualToInTimeZone(
+        Time | Weekday | Date | Month | Year $moment,
+        \DateTimeZone $timeZone,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isNotBeforeOrEqualToInTimeZone($moment, $timeZone)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\MomentIsNotBeforeOrEqualTo();
+        }
+    }
 }
diff --git a/tests/Moment/MustBeBeforeOrEqualToInTimeZoneTest.php b/tests/Moment/MustBeBeforeOrEqualToInTimeZoneTest.php
new file mode 100644
index 0000000..bf497c7
--- /dev/null
+++ b/tests/Moment/MustBeBeforeOrEqualToInTimeZoneTest.php
@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Moment;
+
+use DigitalCraftsman\DateTimePrecision\Date;
+use DigitalCraftsman\DateTimePrecision\Exception\MomentIsNotBeforeOrEqualTo;
+use DigitalCraftsman\DateTimePrecision\Moment;
+use DigitalCraftsman\DateTimePrecision\Month;
+use DigitalCraftsman\DateTimePrecision\Test\Exception\CustomMomentIsNotBeforeOrEqualToInTimeZone;
+use DigitalCraftsman\DateTimePrecision\Time;
+use DigitalCraftsman\DateTimePrecision\Weekday;
+use DigitalCraftsman\DateTimePrecision\Year;
+use PHPUnit\Framework\TestCase;
+
+/** @coversDefaultClass \DigitalCraftsman\DateTimePrecision\Moment */
+final class MustBeBeforeOrEqualToInTimeZoneTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @param ?class-string<\Throwable> $expectedResult
+     *
+     * @dataProvider dataProvider
+     *
+     * @covers ::mustBeBeforeOrEqualToInTimeZone
+     */
+    public function must_be_before_or_equal_to_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->mustBeBeforeOrEqualToInTimeZone(
+            $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('16:00:00'),
+                new \DateTimeZone('Europe/Berlin'),
+                null,
+            ],
+            'default exception' => [
+                MomentIsNotBeforeOrEqualTo::class,
+                Moment::fromStringInTimeZone('2022-10-08 16:00:00', new \DateTimeZone('Europe/Berlin')),
+                Time::fromString('15:00:00'),
+                new \DateTimeZone('Europe/Berlin'),
+                null,
+            ],
+            'custom exception' => [
+                CustomMomentIsNotBeforeOrEqualToInTimeZone::class,
+                Moment::fromStringInTimeZone('2022-10-08 16:00:00', new \DateTimeZone('Europe/Berlin')),
+                Time::fromString('15:00:00'),
+                new \DateTimeZone('Europe/Berlin'),
+                static fn () => new CustomMomentIsNotBeforeOrEqualToInTimeZone(),
+            ],
+        ];
+    }
+}
diff --git a/tests/Moment/MustBeBeforeOrEqualToTest.php b/tests/Moment/MustBeBeforeOrEqualToTest.php
new file mode 100644
index 0000000..9456f46
--- /dev/null
+++ b/tests/Moment/MustBeBeforeOrEqualToTest.php
@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Moment;
+
+use DigitalCraftsman\DateTimePrecision\Exception\MomentIsNotBeforeOrEqualTo;
+use DigitalCraftsman\DateTimePrecision\Moment;
+use DigitalCraftsman\DateTimePrecision\Test\Exception\CustomMomentIsNotBeforeOrEqualTo;
+use PHPUnit\Framework\TestCase;
+
+/** @coversDefaultClass \DigitalCraftsman\DateTimePrecision\Moment */
+final class MustBeBeforeOrEqualToTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @param ?class-string<\Throwable> $expectedResult
+     *
+     * @dataProvider dataProvider
+     *
+     * @covers ::mustBeBeforeOrEqualTo
+     */
+    public function must_be_before_or_equal_to_works(
+        ?string $expectedResult,
+        Moment $moment,
+        Moment $comparator,
+        ?callable $otherwiseThrow,
+    ): void {
+        // -- Act & Assert
+        if ($expectedResult !== null) {
+            $this->expectException($expectedResult);
+        } else {
+            $this->expectNotToPerformAssertions();
+        }
+
+        $moment->mustBeBeforeOrEqualTo(
+            $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 15:00:00'),
+                Moment::fromString('2022-10-08 16:00:00'),
+                null,
+            ],
+            'default exception' => [
+                MomentIsNotBeforeOrEqualTo::class,
+                Moment::fromString('2022-10-08 16:00:00'),
+                Moment::fromString('2022-10-08 15:00:00'),
+                null,
+            ],
+            'custom exception' => [
+                CustomMomentIsNotBeforeOrEqualTo::class,
+                Moment::fromString('2022-10-08 16:00:00'),
+                Moment::fromString('2022-10-08 15:00:00'),
+                static fn () => new CustomMomentIsNotBeforeOrEqualTo(),
+            ],
+        ];
+    }
+}
diff --git a/tests/Test/Exception/CustomMomentIsNotBeforeOrEqualTo.php b/tests/Test/Exception/CustomMomentIsNotBeforeOrEqualTo.php
new file mode 100644
index 0000000..b0f8663
--- /dev/null
+++ b/tests/Test/Exception/CustomMomentIsNotBeforeOrEqualTo.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Test\Exception;
+
+final class CustomMomentIsNotBeforeOrEqualTo extends \InvalidArgumentException
+{
+}
diff --git a/tests/Test/Exception/CustomMomentIsNotBeforeOrEqualToInTimeZone.php b/tests/Test/Exception/CustomMomentIsNotBeforeOrEqualToInTimeZone.php
new file mode 100644
index 0000000..480a548
--- /dev/null
+++ b/tests/Test/Exception/CustomMomentIsNotBeforeOrEqualToInTimeZone.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Test\Exception;
+
+final class CustomMomentIsNotBeforeOrEqualToInTimeZone extends \InvalidArgumentException
+{
+}