Add guard methods for Moment (#56)

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

.github/workflows/ci.yml

@@ -39,10 +39,11 @@ jobs:
         run: make php-8.2-tests-ci
 
       - name: Upload to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v4
         with:
-          token: ${{ secrets.CODE_COV_TOKEN }}
+          fail_ci_if_error: true
           files: ./coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
 
   test-8-3:

.php-cs-fixer.dist.php

@@ -41,5 +41,8 @@
 
         // Nullable types should be explicit even with default values
         'nullable_type_declaration_for_default_null_value' => false,
+
+        // Throw in a single line is worse to read when using ternary operator
+        'single_line_throw' => false,
     ])
     ->setFinder($finder);

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 0.11.0
 
 - Added `Clock` implementation with `SystemClock` and `FrozenClock`.
+- Added guard methods for comparison methods to `Moment` like `mustBeEqualTo` with option to throw custom exception.
 
 ## 0.10.0
 

README.md

@@ -20,7 +20,7 @@ Additionally, the package provides a streamlined way to have the system running
 
 This Symfony bundle includes Symfony normalizers for automatic normalization and denormalization and Doctrine types to store the objects directly in the database. 
 
-As it's a central part of an application, it's tested thoroughly (including mutation testing).
+As it's a central part of an application, it's tested thoroughly (including mutation testing). Currently, more than 80% of the lines of code in this repository are tests.
 
 [![Latest Stable Version](http://poser.pugx.org/digital-craftsman/date-time-precision/v)](https://packagist.org/packages/digital-craftsman/date-time-precision)
 [![PHP Version Require](http://poser.pugx.org/digital-craftsman/date-time-precision/require/php)](https://packagist.org/packages/digital-craftsman/date-time-precision)

src/Exception/MomentIsAfter.php

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

src/Exception/MomentIsAfterOrEqualTo.php

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

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.');
+    }
+}

src/Exception/MomentIsBeforeOrEqualTo.php

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

src/Exception/MomentIsEqual.php

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

src/Exception/MomentIsNotAfter.php

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

src/Exception/MomentIsNotAfterOrEqualTo.php

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

src/Exception/MomentIsNotBefore.php

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

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.');
+    }
+}

src/Exception/MomentIsNotEqual.php

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