refactor: Create classes for matchers and generators

example/generators/consumer/tests/Service/GeneratorsTest.php

@@ -21,15 +21,15 @@ public function setUp(): void
         $this->matcher = new Matcher();
     }
 
-    public function testGetMatchers()
+    public function testGetGenerators(): void
     {
         $request = new ConsumerRequest();
         $request
             ->setMethod('GET')
             ->setPath('/generators')
             ->addHeader('Accept', 'application/json')
             ->setBody([
-                'id' => $this->matcher->fromProviderState($this->matcher->integer(), '${id}')
+                'id' => $this->matcher->fromProviderState($this->matcher->integerV3(), '${id}')
             ]);
 
         $response = new ProviderResponse();

example/generators/pacts/generatorsConsumer-generatorsProvider.json

@@ -14,7 +14,7 @@
       "request": {
         "body": {
           "content": {
-            "id": 13
+            "id": null
           },
           "contentType": "application/json",
           "encoded": false
@@ -41,7 +41,7 @@
               "combine": "AND",
               "matchers": [
                 {
-                  "match": "type"
+                  "match": "integer"
                 }
               ]
             }
@@ -114,6 +114,7 @@
               "type": "Time"
             },
             "$.uuid": {
+              "format": "lower-case-hyphenated",
               "type": "Uuid"
             }
           },

example/matchers/consumer/tests/Service/MatchersTest.php

@@ -20,7 +20,7 @@ public function setUp(): void
         $this->matcher = new Matcher();
     }
 
-    public function testGetMatchers()
+    public function testGetMatchers(): void
     {
         $request = new ConsumerRequest();
         $request

example/message/consumer/src/ExampleMessageConsumer.php

@@ -8,8 +8,12 @@ public function processMessage(string $message): void
     {
         $obj = \json_decode($message);
         print " [x] Processing \n";
-        print ' [x] Text: ' . \print_r($obj->contents->text, true) . "\n";
-        print ' [x] Number: ' . \print_r($obj->contents->number, true) . "\n";
+        print " [x] Contents: \n";
+        print ' [x]     Text: ' . \print_r($obj->contents->text, true) . "\n";
+        print ' [x]     Number: ' . \print_r($obj->contents->number, true) . "\n";
+        print " [x] Metadata: \n";
+        print ' [x]     Queue: ' . \print_r($obj->metadata->queue, true) . "\n";
+        print ' [x]     Routing Key: ' . \print_r($obj->metadata->routing_key, true) . "\n";
         print " [x] Processed \n";
     }
 }

src/PhpPact/Consumer/Matcher/Exception/GeneratorRequiredException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Exception;
+
+use Exception;
+
+class GeneratorRequiredException extends Exception
+{
+}

src/PhpPact/Consumer/Matcher/Exception/InvalidHttpStatusException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Exception;
+
+use Exception;
+
+class InvalidHttpStatusException extends Exception
+{
+}

src/PhpPact/Consumer/Matcher/Exception/InvalidRegexException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Exception;
+
+use Exception;
+
+class InvalidRegexException extends Exception
+{
+}

src/PhpPact/Consumer/Matcher/Exception/InvalidUuidFormatException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Exception;
+
+use Exception;
+
+class InvalidUuidFormatException extends Exception
+{
+}

src/PhpPact/Consumer/Matcher/Exception/MatcherNotSupportedException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Exception;
+
+use Exception;
+
+class MatcherNotSupportedException extends Exception
+{
+}

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

@@ -0,0 +1,32 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+use PhpPact\Consumer\Matcher\Model\GeneratorInterface;
+
+abstract class AbstractDateTime implements GeneratorInterface
+{
+    public function __construct(private ?string $format = null, private ?string $expression = null)
+    {
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function jsonSerialize(): array
+    {
+        $data = ['pact:generator:type' => $this->getType()];
+
+        if ($this->format !== null) {
+            $data['format'] = $this->format;
+        }
+
+        if ($this->expression !== null) {
+            $data['expression'] = $this->expression;
+        }
+
+        return $data;
+    }
+
+    abstract protected function getType(): string;
+}

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

@@ -0,0 +1,23 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+/**
+ * Generates a date value for the provided format.
+ * If no format is provided, ISO date format is used.
+ * If an expression is given, it will be evaluated to generate the date, otherwise 'today' will be used
+ *
+ * Example format: yyyy-MM-dd
+ * Example expression: +1 day
+ *
+ * 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
+{
+    protected function getType(): string
+    {
+        return 'Date';
+    }
+}

src/PhpPact/Consumer/Matcher/Generators/DateTime.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+/**
+ * Generates a datetime value for the provided format.
+ * If no format is provided, ISO format is used.
+ * If an expression is given, it will be evaluated to generate the datetime, otherwise 'now' will be used
+ *
+ * Example format: yyyy-MM-dd'T'HH:mm:ss
+ * Example expression: +1 day
+ *
+ * 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 DateTime extends AbstractDateTime
+{
+    protected function getType(): string
+    {
+        return 'DateTime';
+    }
+}

src/PhpPact/Consumer/Matcher/Generators/MockServerURL.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+use PhpPact\Consumer\Matcher\Model\GeneratorInterface;
+
+/**
+ * Generates a URL with the mock server as the base URL.
+ *
+ * Example regex: .*(/path)$
+ * Example example: http://localhost:1234/path
+ */
+class MockServerURL implements GeneratorInterface
+{
+    public function __construct(private string $regex, private string $example)
+    {
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'regex'               => $this->regex,
+            'example'             => $this->example,
+            'pact:generator:type' => 'MockServerURL',
+        ];
+    }
+}

src/PhpPact/Consumer/Matcher/Generators/ProviderState.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+use PhpPact\Consumer\Matcher\Model\GeneratorInterface;
+
+/**
+ * Generates a value that is looked up from the provider state context using the given expression
+ *
+ * Example expression: /products/${id}
+ */
+class ProviderState implements GeneratorInterface
+{
+    public function __construct(private string $expression)
+    {
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'expression'          => $this->expression,
+            'pact:generator:type' => 'ProviderState',
+        ];
+    }
+}

src/PhpPact/Consumer/Matcher/Generators/RandomBoolean.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+use PhpPact\Consumer\Matcher\Model\GeneratorInterface;
+
+/**
+ * Generates a random boolean value
+ */
+class RandomBoolean implements GeneratorInterface
+{
+    /**
+     * @return array<string, string>
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'pact:generator:type' => 'RandomBoolean',
+        ];
+    }
+}

src/PhpPact/Consumer/Matcher/Generators/RandomDecimal.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+use PhpPact\Consumer\Matcher\Model\GeneratorInterface;
+
+/**
+ * Generates a random big decimal value with the provided number of digits
+ */
+class RandomDecimal implements GeneratorInterface
+{
+    public function __construct(private int $digits = 10)
+    {
+    }
+
+    /**
+     * @return array<string, string|int>
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'digits'              => $this->digits,
+            'pact:generator:type' => 'RandomDecimal',
+        ];
+    }
+}

src/PhpPact/Consumer/Matcher/Generators/RandomHexadecimal.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+use PhpPact\Consumer\Matcher\Model\GeneratorInterface;
+
+/**
+ * Generates a random hexadecimal value of the given number of digits
+ */
+class RandomHexadecimal implements GeneratorInterface
+{
+    public function __construct(private int $digits = 10)
+    {
+    }
+
+    /**
+     * @return array<string, string|int>
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'digits'              => $this->digits,
+            'pact:generator:type' => 'RandomHexadecimal',
+        ];
+    }
+}

src/PhpPact/Consumer/Matcher/Generators/RandomInt.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+use PhpPact\Consumer\Matcher\Model\GeneratorInterface;
+
+/**
+ * Generates a random integer between the min and max values (inclusive)
+ */
+class RandomInt implements GeneratorInterface
+{
+    public function __construct(private int $min = 0, private int $max = 10)
+    {
+    }
+
+    /**
+     * @return array<string, string|int>
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'min'                 => $this->min,
+            'max'                 => $this->max,
+            'pact:generator:type' => 'RandomInt',
+        ];
+    }
+}

src/PhpPact/Consumer/Matcher/Generators/RandomString.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace PhpPact\Consumer\Matcher\Generators;
+
+use PhpPact\Consumer\Matcher\Model\GeneratorInterface;
+
+/**
+ * Generates a random alphanumeric string of the provided length
+ */
+class RandomString implements GeneratorInterface
+{
+    public function __construct(private int $size = 10)
+    {
+    }
+
+    /**
+     * @return array<string, string|int>
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'size'                => $this->size,
+            'pact:generator:type' => 'RandomString',
+        ];
+    }
+}