Array universal key (#143)

* Array universal key

* Remove unwanted Exception

* add test and remove dump

* revert invalid array key check

* remove not needed code samples

* Add more tests

* Update Readme with Universal Array Key example

Author: JarJak

README.md

@@ -334,6 +334,64 @@ $matcher->match(
 );
 ```
 
+### Json matching with unbounded arrays and objects
+
+```php
+<?php
+
+use Coduo\PHPMatcher\Factory\SimpleFactory;
+
+$factory = new SimpleFactory();
+$matcher = $factory->createMatcher();
+
+$matcher->match(
+  '{
+    "users":[
+      {
+        "firstName": "Norbert",
+        "lastName": "Orzechowicz",
+        "created": "2014-01-01",
+        "roles":["ROLE_USER", "ROLE_DEVELOPER"]},
+        "attributes": {
+          "isAdmin": false,
+          "dateOfBirth" null,
+          "hasEmailVerified": true
+        }
+      },
+      {
+        "firstName": "Michał",
+        "lastName": "Dąbrowski",
+        "created": "2014-01-01",
+        "roles":["ROLE_USER", "ROLE_DEVELOPER", "ROLE_ADMIN"]},
+        "attributes": {
+          "isAdmin": true,
+          "dateOfBirth" null,
+          "hasEmailVerified": true
+        }
+      }
+    ]
+  }',
+  '{
+    "users":[
+      {
+        "firstName": @string@,
+        "lastName": @string@,
+        "created": "@[email protected]()",
+        "roles": [
+            "ROLE_USER",
+            @...@
+        ],
+        "attributes": {
+          "isAdmin": @boolean@,
+          "@*@": "@*@"
+        }
+      }
+    ],
+    @...@
+  }'
+);
+```
+
 ### Xml matching
 
 ```php

src/Lexer.php

@@ -32,7 +32,7 @@ protected function getCatchablePatterns() : array
             '\\-?[0-9]*\\.?[0-9]*', // numbers
             "'(?:[^']|'')*'", // string between ' character
             '"(?:[^"]|"")*"', // string between " character,
-            '@[a-zA-Z0-9\\*]+@', // type pattern
+            '@[a-zA-Z0-9\\*.]+@', // type pattern
         ];
     }
 

src/Matcher/ArrayMatcher.php

@@ -15,6 +15,7 @@ final class ArrayMatcher extends Matcher
 {
     const PATTERN = 'array';
     const UNBOUNDED_PATTERN = '@...@';
+    const UNIVERSAL_KEY = '@*@';
 
     private $propertyMatcher;
 
@@ -70,18 +71,20 @@ private function iterateMatch(array $values, array $patterns, string $parentPath
         foreach ($values as $key => $value) {
             $path = $this->formatAccessPath($key);
 
-            if ($this->shouldSkippValueMatchingFor($pattern)) {
+            if ($this->shouldSkipValueMatchingFor($pattern)) {
                 continue;
             }
 
             if ($this->valueExist($path, $patterns)) {
                 $pattern = $this->getValueByPath($patterns, $path);
+            } elseif (isset($patterns[self::UNIVERSAL_KEY])) {
+                $pattern = $patterns[self::UNIVERSAL_KEY];
             } else {
                 $this->setMissingElementInError('pattern', $this->formatFullPath($parentPath, $path));
                 return false;
             }
 
-            if ($this->shouldSkippValueMatchingFor($pattern)) {
+            if ($this->shouldSkipValueMatchingFor($pattern)) {
                 continue;
             }
 
@@ -138,9 +141,13 @@ function ($item) use ($skipPattern) {
         return true;
     }
 
-    private function findNotExistingKeys(array $pattern, array $values) : array
+    private function findNotExistingKeys(array $patterns, array $values) : array
     {
-        $notExistingKeys = \array_diff_key($pattern, $values);
+        if (isset($patterns[self::UNIVERSAL_KEY])) {
+            return [];
+        }
+
+        $notExistingKeys = \array_diff_key($patterns, $values);
 
         return \array_filter($notExistingKeys, function ($pattern) use ($values) {
             if (\is_array($pattern)) {
@@ -230,7 +237,7 @@ private function formatFullPath(string $parentPath, string $path) : string
         return \sprintf('%s%s', $parentPath, $path);
     }
 
-    private function shouldSkippValueMatchingFor($lastPattern) : bool
+    private function shouldSkipValueMatchingFor($lastPattern) : bool
     {
         return $lastPattern === self::UNBOUNDED_PATTERN;
     }

tests/LexerTest.php

@@ -181,6 +181,7 @@ public static function validMatcherTypePatterns()
             ['@integer@'],
             ['@number@'],
             ['@*@'],
+            ['@...@'],
             ['@wildcard@']
         ];
     }

tests/Matcher/ArrayMatcherTest.php

@@ -158,9 +158,39 @@ public static function positiveMatchData()
             6.66
         ];
 
+        $simpleArrPatternWithUniversalKey = [
+            'users' => [
+                [
+                    'firstName' => '@string@',
+                    Matcher\ArrayMatcher::UNIVERSAL_KEY => '@*@'
+                ],
+                Matcher\ArrayMatcher::UNBOUNDED_PATTERN
+            ],
+            true,
+            false,
+            1,
+            6.66
+        ];
+
+        $simpleArrPatternWithUniversalKeyAndStringValue = [
+            'users' => [
+                [
+                    'firstName' => '@string@',
+                    Matcher\ArrayMatcher::UNIVERSAL_KEY => '@string@'
+                ],
+                Matcher\ArrayMatcher::UNBOUNDED_PATTERN
+            ],
+            true,
+            false,
+            1,
+            6.66
+        ];
+
         return [
             [$simpleArr, $simpleArr],
             [$simpleArr, $simpleArrPattern],
+            [$simpleArr, $simpleArrPatternWithUniversalKey],
+            [$simpleArr, $simpleArrPatternWithUniversalKeyAndStringValue],
             [[], []],
             [['foo' => null], ['foo' => null]],
             [['foo' => null], ['foo' => '@null@']],
@@ -224,8 +254,23 @@ public static function negativeMatchData()
             6.66
         ];
 
+        $simpleArrPatternWithUniversalKeyAndIntegerValue = [
+            'users' => [
+                [
+                    'firstName' => '@string@',
+                    Matcher\ArrayMatcher::UNIVERSAL_KEY => '@integer@'
+                ],
+                Matcher\ArrayMatcher::UNBOUNDED_PATTERN
+            ],
+            true,
+            false,
+            1,
+            6.66
+        ];
+
         return [
             [$simpleArr, $simpleDiff],
+            [$simpleArr, $simpleArrPatternWithUniversalKeyAndIntegerValue],
             [['status' => 'ok', 'data' => [['foo']]], ['status' => 'ok', 'data' => []]],
             [[1], []],
             [['key' => 'val'], ['key' => 'val2']],

tests/Matcher/JsonMatcherTest.php

@@ -200,9 +200,21 @@ public static function positiveMatches()
                 '{"users":[{"firstName":"Norbert","lastName":"Orzechowicz","roles":["ROLE_USER", "ROLE_DEVELOPER"]}]}',
                 '{"users":[{"firstName":"Norbert","lastName":"Orzechowicz","roles":"@wildcard@"}]}'
             ],
+            [
+                '{"users":[{"firstName":"Norbert","lastName":"Orzechowicz","roles":["ROLE_USER", "ROLE_DEVELOPER"]}]}',
+                '{"users":[{"firstName":"Norbert","@*@":"@*@"}]}'
+            ],
+            [
+                '{"users":[{"firstName":"Norbert","lastName":"Orzechowicz","roles":["ROLE_USER", "ROLE_DEVELOPER"]},{}]}',
+                '{"users":[{"firstName":"Norbert","@*@":"@*@"},@...@]}'
+            ],
             [
                 '[{"name": "Norbert"},{"name":"Michał"},{"name":"Bob"},{"name":"Martin"}]',
                 '[{"name": "Norbert"},@...@]'
+            ],
+            [
+                '[{"name": "Norbert","lastName":"Orzechowicz"},{"name":"Michał"},{"name":"Bob"},{"name":"Martin"}]',
+                '[{"name": "Norbert","@*@":"@*@"},@...@]'
             ]
         ];
     }