Added match expander that allows to match nullable @JSON@ objects (#173)

* Added match expander that allows to match nullable @JSON@ objects

* Added failing scenario

* Fixed invalid test example

* Added another example of optional json element

Author: norberttech

README.md

@@ -68,6 +68,7 @@ $matcher->getError(); // returns null or error message
 * ``@*@`` || ``@wildcard@``
 * ``expr(expression)``
 * ``@uuid@``
+* ``@json@``
 * ``@strig@||@integer@`` - string OR integer
 
 ### Available pattern expanders
@@ -85,11 +86,12 @@ $matcher->getError(); // returns null or error message
 * ``lowerThan($boundry)``
 * ``greaterThan($boundry)``
 * ``inArray($value)``
-* ``oneOf(...$expanders)`` - example usage ``"@[email protected](contains('foo'), contains('bar'), contains('baz'))"``
-* ``matchRegex($regex)`` - example usage ``"@[email protected]('/^lorem.+/')"``
+* ``oneOf(...$expanders)`` - example ``"@[email protected](contains('foo'), contains('bar'), contains('baz'))"``
+* ``matchRegex($regex)`` - example ``"@[email protected]('/^lorem.+/')"``
 * ``optional()`` - work's only with ``ArrayMatcher``, ``JsonMatcher`` and ``XmlMatcher``
-* ``count()`` - work's only with ``ArrayMatcher`` - example usage ``"@[email protected](5)"``
-* ``repeat($pattern, $isStrict = true)`` - example usage ``'@[email protected]({"name": "foe"})'`` or ``"@[email protected]('@string@')"``
+* ``count()`` - work's only with ``ArrayMatcher`` - example ``"@[email protected](5)"``
+* ``repeat($pattern, $isStrict = true)`` - example ``'@[email protected]({"name": "foe"})'`` or ``"@[email protected]('@string@')"``
+* ``match($pattern)`` - example ``{"image":"@[email protected]({\"url\":\"@[email protected]()\"})"}``
 
 ## Example usage
 
@@ -358,6 +360,9 @@ $matcher->match(
           "isAdmin": false,
           "dateOfBirth" null,
           "hasEmailVerified": true
+        },
+        "avatar": {
+          "url": "http://avatar-image.com/avatar.png"
         }
       },
       {
@@ -369,7 +374,8 @@ $matcher->match(
           "isAdmin": true,
           "dateOfBirth" null,
           "hasEmailVerified": true
-        }
+        },
+        "avatar": null
       }
     ]
   }',
@@ -386,7 +392,8 @@ $matcher->match(
         "attributes": {
           "isAdmin": @boolean@,
           "@*@": "@*@"
-        }
+        },
+        "avatar": "@[email protected]({\"url\":\"@[email protected]()\"})"
       }
     ],
     @...@

src/Factory/MatcherFactory.php

@@ -21,13 +21,20 @@ protected function buildMatchers(Parser $parser) : Matcher\ChainMatcher
         $scalarMatchers = $this->buildScalarMatchers($parser);
         $arrayMatcher = $this->buildArrayMatcher($scalarMatchers, $parser);
 
+        // Matchers are registered in order of matching
+        // 1) all scalars
+        // 2) json/xml
+        // 3) array
+        // 4) or "||"
+        // 5) full text
+
         $chainMatcher = new Matcher\ChainMatcher([
             $scalarMatchers,
-            $arrayMatcher,
-            new Matcher\OrMatcher($scalarMatchers),
             new Matcher\JsonMatcher($arrayMatcher),
             new Matcher\XmlMatcher($arrayMatcher),
-            new Matcher\TextMatcher($scalarMatchers, $parser)
+            $arrayMatcher,
+            new Matcher\OrMatcher($scalarMatchers),
+            new Matcher\TextMatcher($scalarMatchers, $parser),
         ]);
 
         return $chainMatcher;
@@ -36,16 +43,15 @@ protected function buildMatchers(Parser $parser) : Matcher\ChainMatcher
     protected function buildArrayMatcher(Matcher\ChainMatcher $scalarMatchers, Parser $parser) : Matcher\ArrayMatcher
     {
         $orMatcher = new Matcher\OrMatcher($scalarMatchers);
-        $arrayMatcher = new Matcher\ArrayMatcher(
+
+        return new Matcher\ArrayMatcher(
             new Matcher\ChainMatcher([
                 $orMatcher,
                 $scalarMatchers,
                 new Matcher\TextMatcher($scalarMatchers, $parser)
             ]),
             $parser
         );
-
-        return $arrayMatcher;
     }
 
     protected function buildScalarMatchers(Parser $parser) : Matcher\ChainMatcher

src/Matcher/JsonMatcher.php

@@ -32,7 +32,7 @@ public function match($value, $pattern) : bool
             return false;
         }
 
-        $transformedPattern = Json::transformPattern($pattern);
+        $transformedPattern = Json::isValid($pattern) ? $pattern : Json::transformPattern($pattern);
 
         $match = $this->arrayMatcher->match(\json_decode($value, true), \json_decode($transformedPattern, true));
 

src/Matcher/Pattern/Assert/Json.php

@@ -29,7 +29,7 @@ public static function isValidPattern($value) : bool
             return false;
         }
 
-        return self::isValid(self::transformPattern($value));
+        return self::isValid($value) || self::isValid(self::transformPattern($value));
     }
 
     public static function transformPattern(string $pattern) : string

src/Matcher/Pattern/Expander/After.php

@@ -67,7 +67,7 @@ private function is_datetime(string $value) : bool
         }
     }
 
-    public function getError()
+    public function getError() : ?string
     {
         return $this->error;
     }

src/Matcher/Pattern/Expander/Before.php

@@ -66,7 +66,7 @@ private function is_datetime(string $value) : bool
         }
     }
 
-    public function getError()
+    public function getError() : ?string
     {
         return $this->error;
     }

src/Matcher/Pattern/Expander/Contains.php

@@ -47,7 +47,7 @@ public function match($value) : bool
         return true;
     }
 
-    public function getError()
+    public function getError() : ?string
     {
         return $this->error;
     }

src/Matcher/Pattern/Expander/Count.php

@@ -39,7 +39,7 @@ public function match($value) :bool
 
         return true;
     }
-    public function getError()
+    public function getError() : ?string
     {
         return $this->error;
     }

src/Matcher/Pattern/Expander/EndsWith.php

@@ -51,7 +51,7 @@ public function match($value) : bool
         return true;
     }
 
-    public function getError()
+    public function getError() : ?string
     {
         return $this->error;
     }

src/Matcher/Pattern/Expander/GreaterThan.php

@@ -44,7 +44,7 @@ public function match($value) : bool
         return $value > $this->boundary;
     }
 
-    public function getError()
+    public function getError() : ?string
     {
         return $this->error;
     }