Add guard methods to Date

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 - **[Breaking change](./UPGRADE.md#removed-deprecated-isdate-methods-from-moment)**: Removed deprecated `isDate*` methods from `Moment`.
 - Added `Clock` implementation with `SystemClock` and `FrozenClock`.
-- Added guard methods for comparison methods to `Moment` like `mustBeEqualTo` with option to throw custom exception.
+- Added guard methods for comparison methods to `Moment` and `Date` like `mustBeEqualTo` with option to throw custom exception.
 
 ## 0.10.0
 

src/Date.php

@@ -49,14 +49,14 @@ public static function fromString(string $date): self
         }
     }
 
-    // Stringable
+    // -- Stringable
 
     public function __toString(): string
     {
         return $this->format(self::DATE_FORMAT);
     }
 
-    // Accessors
+    // -- Accessors
 
     public function isEqualTo(self $date): bool
     {
@@ -156,7 +156,179 @@ public function weekday(): Weekday
         return Weekday::fromDateTime($this->toDateTimeImmutable());
     }
 
-    // Mutations
+    // -- Guards
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsNotEqual
+     */
+    public function mustBeEqualTo(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isNotEqualTo($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsNotEqual();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsEqual
+     */
+    public function mustNotBeEqualTo(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isEqualTo($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsEqual();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsNotAfter
+     */
+    public function mustBeAfter(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isNotAfter($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsNotAfter();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsAfter
+     */
+    public function mustNotBeAfter(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isAfter($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsAfter();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsNotAfterOrEqualTo
+     */
+    public function mustBeAfterOrEqualTo(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isNotAfterOrEqualTo($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsNotAfterOrEqualTo();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsAfterOrEqualTo
+     */
+    public function mustNotBeAfterOrEqualTo(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isAfterOrEqualTo($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsAfterOrEqualTo();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsNotBefore
+     */
+    public function mustBeBefore(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isNotBefore($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsNotBefore();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsBefore
+     */
+    public function mustNotBeBefore(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isBefore($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsBefore();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsNotBeforeOrEqualTo
+     */
+    public function mustBeBeforeOrEqualTo(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isNotBeforeOrEqualTo($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsNotBeforeOrEqualTo();
+        }
+    }
+
+    /**
+     * @param ?callable(): \Throwable $otherwiseThrow
+     *
+     * @throws \Throwable
+     * @throws Exception\DateIsBeforeOrEqualTo
+     */
+    public function mustNotBeBeforeOrEqualTo(
+        self $date,
+        ?callable $otherwiseThrow = null,
+    ): void {
+        if ($this->isBeforeOrEqualTo($date)) {
+            throw $otherwiseThrow !== null
+                ? $otherwiseThrow()
+                : new Exception\DateIsBeforeOrEqualTo();
+        }
+    }
+
+    // -- Mutations
 
     public function format(string $format): string
     {

src/Exception/DateIsAfter.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsAfter extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is after but must not be.');
+    }
+}

src/Exception/DateIsAfterOrEqualTo.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsAfterOrEqualTo extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is after or equal to but must not be.');
+    }
+}

src/Exception/DateIsBefore.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsBefore extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is before but must not be.');
+    }
+}

src/Exception/DateIsBeforeOrEqualTo.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsBeforeOrEqualTo extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is before or equal to but must not be.');
+    }
+}

src/Exception/DateIsEqual.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsEqual extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is equal but must not be.');
+    }
+}

src/Exception/DateIsNotAfter.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsNotAfter extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is not after but must be.');
+    }
+}

src/Exception/DateIsNotAfterOrEqualTo.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsNotAfterOrEqualTo extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is not after or equal to but must be.');
+    }
+}

src/Exception/DateIsNotBefore.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsNotBefore extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is not before but must be.');
+    }
+}

src/Exception/DateIsNotBeforeOrEqualTo.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsNotBeforeOrEqualTo extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is not before or equal to but must be.');
+    }
+}

src/Exception/DateIsNotEqual.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCraftsman\DateTimePrecision\Exception;
+
+/**
+ * @psalm-immutable
+ *
+ * @codeCoverageIgnore
+ */
+final class DateIsNotEqual extends \InvalidArgumentException
+{
+    public function __construct()
+    {
+        parent::__construct('The date is not equal but must be.');
+    }
+}