Merge pull request #394 from tienvx/add-date-matcher-class

refactor: Add Date matcher class

src/PhpPact/Consumer/Matcher/Matchers/AbstractDateTime.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Matchers;
+
+abstract class AbstractDateTime extends GeneratorAwareMatcher
+{
+    public function __construct(protected string $format, private ?string $value = null)
+    {
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    protected function getAttributesData(): array
+    {
+        return ['format' => $this->format];
+    }
+
+    protected function getValue(): ?string
+    {
+        return $this->value;
+    }
+}

src/PhpPact/Consumer/Matcher/Matchers/Date.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Matchers;
+
+use PhpPact\Consumer\Matcher\Generators\Date as DateGenerator;
+
+/**
+ * Matches the string representation of a value against the date format.
+ *
+ * NOTE: Java's datetime format is used, not PHP's datetime format
+ * For Java one, see https://www.digitalocean.com/community/tutorials/java-simpledateformat-java-date-format#patterns
+ * For PHP one, see https://www.php.net/manual/en/datetime.format.php#refsect1-datetime.format-parameters
+ */
+class Date extends AbstractDateTime
+{
+    public function __construct(string $format = 'yyyy-MM-dd', ?string $value = null)
+    {
+        if ($value === null) {
+            $this->setGenerator(new DateGenerator($format));
+        }
+        parent::__construct($format, $value);
+    }
+
+    public function getType(): string
+    {
+        return 'date';
+    }
+}

tests/PhpPact/Consumer/Matcher/Matchers/DateTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace PhpPactTest\Consumer\Matcher\Matchers;
+
+use PhpPact\Consumer\Matcher\Matchers\Date;
+
+class DateTest extends GeneratorAwareMatcherTestCase
+{
+    protected function setUp(): void
+    {
+        $this->matcher = new Date();
+    }
+
+    /**
+     * @testWith [null,         "{\"pact:matcher:type\":\"date\",\"pact:generator:type\":\"Date\",\"format\":\"yyyy-MM-dd\"}"]
+     *           ["1995-02-04", "{\"pact:matcher:type\":\"date\",\"format\":\"yyyy-MM-dd\",\"value\":\"1995-02-04\"}"]
+     */
+    public function testSerialize(?string $value, string $json): void
+    {
+        $format = 'yyyy-MM-dd';
+        $this->matcher = new Date($format, $value);
+        $this->assertSame($json, json_encode($this->matcher));
+    }
+}