Add time guards (#59)

Co-authored-by: Christian Kolb <[email protected]>

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` and `Date` like `mustBeEqualTo` with option to throw custom exception.
+- Added guard methods for comparison methods to `Moment`, `Date` and `Time` like `mustBeEqualTo` with option to throw custom exception.
 
 ## 0.10.0
 

src/Date.php

@@ -162,7 +162,7 @@ public function weekday(): Weekday
      * @param ?callable(): \Throwable $otherwiseThrow
      *
      * @throws \Throwable
-     * @throws Exception\DateIsNotEqual
+     * @throws Exception\DateIsNotEqualTo
      */
     public function mustBeEqualTo(
         self $date,
@@ -171,15 +171,15 @@ public function mustBeEqualTo(
         if ($this->isNotEqualTo($date)) {
             throw $otherwiseThrow !== null
                 ? $otherwiseThrow()
-                : new Exception\DateIsNotEqual();
+                : new Exception\DateIsNotEqualTo();
         }
     }
 
     /**
      * @param ?callable(): \Throwable $otherwiseThrow
      *
      * @throws \Throwable
-     * @throws Exception\DateIsEqual
+     * @throws Exception\DateIsEqualTo
      */
     public function mustNotBeEqualTo(
         self $date,
@@ -188,7 +188,7 @@ public function mustNotBeEqualTo(
         if ($this->isEqualTo($date)) {
             throw $otherwiseThrow !== null
                 ? $otherwiseThrow()
-                : new Exception\DateIsEqual();
+                : new Exception\DateIsEqualTo();
         }
     }
 

src/Exception/DateIsEqual.php → src/Exception/DateIsEqualTo.php

@@ -9,7 +9,7 @@
  *
  * @codeCoverageIgnore
  */
-final class DateIsEqual extends \InvalidArgumentException
+final class DateIsEqualTo extends \InvalidArgumentException
 {
     public function __construct()
     {

src/Exception/DateIsNotEqual.php → src/Exception/DateIsNotEqualTo.php

@@ -9,7 +9,7 @@
  *
  * @codeCoverageIgnore
  */
-final class DateIsNotEqual extends \InvalidArgumentException
+final class DateIsNotEqualTo extends \InvalidArgumentException
 {
     public function __construct()
     {

src/Exception/MomentIsEqual.php → src/Exception/MomentIsEqualTo.php

@@ -9,7 +9,7 @@
  *
  * @codeCoverageIgnore
  */
-final class MomentIsEqual extends \InvalidArgumentException
+final class MomentIsEqualTo extends \InvalidArgumentException
 {
     public function __construct()
     {

src/Exception/MomentIsNotEqual.php → src/Exception/MomentIsNotEqualTo.php

@@ -9,7 +9,7 @@
  *
  * @codeCoverageIgnore
  */
-final class MomentIsNotEqual extends \InvalidArgumentException
+final class MomentIsNotEqualTo extends \InvalidArgumentException
 {
     public function __construct()
     {

src/Exception/TimeIsAfter.php

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

src/Exception/TimeIsAfterOrEqualTo.php

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

src/Exception/TimeIsBefore.php

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

src/Exception/TimeIsBeforeOrEqualTo.php

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

src/Exception/TimeIsEqualTo.php

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

src/Exception/TimeIsNotAfter.php

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

src/Exception/TimeIsNotAfterOrEqualTo.php

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

src/Exception/TimeIsNotBefore.php

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

src/Exception/TimeIsNotBeforeOrEqualTo.php

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

src/Exception/TimeIsNotEqualTo.php

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

src/Moment.php

@@ -408,7 +408,7 @@ public function midnightInTimeZone(\DateTimeZone $timeZone): self
      * @param ?callable(): \Throwable $otherwiseThrow
      *
      * @throws \Throwable
-     * @throws Exception\MomentIsNotEqual
+     * @throws Exception\MomentIsNotEqualTo
      */
     public function mustBeEqualTo(
         self $moment,
@@ -417,15 +417,15 @@ public function mustBeEqualTo(
         if ($this->isNotEqualTo($moment)) {
             throw $otherwiseThrow !== null
                 ? $otherwiseThrow()
-                : new Exception\MomentIsNotEqual();
+                : new Exception\MomentIsNotEqualTo();
         }
     }
 
     /**
      * @param ?callable(): \Throwable $otherwiseThrow
      *
      * @throws \Throwable
-     * @throws Exception\MomentIsNotEqual
+     * @throws Exception\MomentIsNotEqualTo
      */
     public function mustBeEqualToInTimeZone(
         Time | Weekday | Date | Month | Year $moment,
@@ -435,15 +435,15 @@ public function mustBeEqualToInTimeZone(
         if ($this->isNotEqualToInTimeZone($moment, $timeZone)) {
             throw $otherwiseThrow !== null
                 ? $otherwiseThrow()
-                : new Exception\MomentIsNotEqual();
+                : new Exception\MomentIsNotEqualTo();
         }
     }
 
     /**
      * @param ?callable(): \Throwable $otherwiseThrow
      *
      * @throws \Throwable
-     * @throws Exception\MomentIsEqual
+     * @throws Exception\MomentIsEqualTo
      */
     public function mustNotBeEqualTo(
         self $moment,
@@ -452,15 +452,15 @@ public function mustNotBeEqualTo(
         if ($this->isEqualTo($moment)) {
             throw $otherwiseThrow !== null
                 ? $otherwiseThrow()
-                : new Exception\MomentIsEqual();
+                : new Exception\MomentIsEqualTo();
         }
     }
 
     /**
      * @param ?callable(): \Throwable $otherwiseThrow
      *
      * @throws \Throwable
-     * @throws Exception\MomentIsEqual
+     * @throws Exception\MomentIsEqualTo
      */
     public function mustNotBeEqualToInTimeZone(
         Time | Weekday | Date | Month | Year $moment,
@@ -470,7 +470,7 @@ public function mustNotBeEqualToInTimeZone(
         if ($this->isEqualToInTimeZone($moment, $timeZone)) {
             throw $otherwiseThrow !== null
                 ? $otherwiseThrow()
-                : new Exception\MomentIsEqual();
+                : new Exception\MomentIsEqualTo();
         }
     }