Array universal key (#143)

JarJak · norberttech · commit 300c41a774b0 · 2019-02-08T09:29:14.000+01:00
* 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
diff --git a/README.md b/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": "@string@.isDateTime()",
+        "roles": [
+            "ROLE_USER",
+            @...@
+        ],
+        "attributes": {
+          "isAdmin": @boolean@,
+          "@*@": "@*@"
+        }
+      }
+    ],
+    @...@
+  }'
+);
+```
+
 ### Xml matching
 
 ```php
diff --git a/src/Lexer.php b/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
         ];
     }
 
diff --git a/src/Matcher/ArrayMatcher.php b/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;
     }
diff --git a/tests/LexerTest.php b/tests/LexerTest.php
@@ -181,6 +181,7 @@ public static function validMatcherTypePatterns()
             ['@integer@'],
             ['@number@'],
             ['@*@'],
+            ['@...@'],
             ['@wildcard@']
         ];
     }
diff --git a/tests/Matcher/ArrayMatcherTest.php b/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']],
diff --git a/tests/Matcher/JsonMatcherTest.php b/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","@*@":"@*@"},@...@]'
             ]
         ];
     }

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ protected function getCatchablePatterns() : array`
`32`	`32`	`'\\-?[0-9]\\.?[0-9]', // numbers`
`33`	`33`	`"'(?:[^']\|'')*'", // string between ' character`
`34`	`34`	`'"(?:[^"]\|"")*"', // string between " character,`
`35`		`- '@[a-zA-Z0-9\\*]+@', // type pattern`
	`35`	`+ '@[a-zA-Z0-9\\*.]+@', // type pattern`
`36`	`36`	`];`
`37`	`37`	`}`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ final class ArrayMatcher extends Matcher`
`15`	`15`	`{`
`16`	`16`	`const PATTERN = 'array';`
`17`	`17`	`const UNBOUNDED_PATTERN = '@...@';`
	`18`	`+ const UNIVERSAL_KEY = '@*@';`
`18`	`19`
`19`	`20`	`private $propertyMatcher;`
`20`	`21`
`@@ -70,18 +71,20 @@ private function iterateMatch(array $values, array $patterns, string $parentPath`
`70`	`71`	`foreach ($values as $key => $value) {`
`71`	`72`	`$path = $this->formatAccessPath($key);`
`72`	`73`
`73`		`- if ($this->shouldSkippValueMatchingFor($pattern)) {`
	`74`	`+ if ($this->shouldSkipValueMatchingFor($pattern)) {`
`74`	`75`	`continue;`
`75`	`76`	`}`
`76`	`77`
`77`	`78`	`if ($this->valueExist($path, $patterns)) {`
`78`	`79`	`$pattern = $this->getValueByPath($patterns, $path);`
	`80`	`+ } elseif (isset($patterns[self::UNIVERSAL_KEY])) {`
	`81`	`+ $pattern = $patterns[self::UNIVERSAL_KEY];`
`79`	`82`	`} else {`
`80`	`83`	`$this->setMissingElementInError('pattern', $this->formatFullPath($parentPath, $path));`
`81`	`84`	`return false;`
`82`	`85`	`}`
`83`	`86`
`84`		`- if ($this->shouldSkippValueMatchingFor($pattern)) {`
	`87`	`+ if ($this->shouldSkipValueMatchingFor($pattern)) {`
`85`	`88`	`continue;`
`86`	`89`	`}`
`87`	`90`
`@@ -138,9 +141,13 @@ function ($item) use ($skipPattern) {`
`138`	`141`	`return true;`
`139`	`142`	`}`
`140`	`143`
`141`		`- private function findNotExistingKeys(array $pattern, array $values) : array`
	`144`	`+ private function findNotExistingKeys(array $patterns, array $values) : array`
`142`	`145`	`{`
`143`		`- $notExistingKeys = \array_diff_key($pattern, $values);`
	`146`	`+ if (isset($patterns[self::UNIVERSAL_KEY])) {`
	`147`	`+ return [];`
	`148`	`+ }`
	`149`	`+`
	`150`	`+ $notExistingKeys = \array_diff_key($patterns, $values);`
`144`	`151`
`145`	`152`	`return \array_filter($notExistingKeys, function ($pattern) use ($values) {`
`146`	`153`	`if (\is_array($pattern)) {`
`@@ -230,7 +237,7 @@ private function formatFullPath(string $parentPath, string $path) : string`
`230`	`237`	`return \sprintf('%s%s', $parentPath, $path);`
`231`	`238`	`}`
`232`	`239`
`233`		`- private function shouldSkippValueMatchingFor($lastPattern) : bool`
	`240`	`+ private function shouldSkipValueMatchingFor($lastPattern) : bool`
`234`	`241`	`{`
`235`	`242`	`return $lastPattern === self::UNBOUNDED_PATTERN;`
`236`	`243`	`}`
Original file line number	Diff line number	Diff line change
`@@ -181,6 +181,7 @@ public static function validMatcherTypePatterns()`
`181`	`181`	`['@integer@'],`
`182`	`182`	`['@number@'],`
`183`	`183`	`['@*@'],`
	`184`	`+ ['@...@'],`
`184`	`185`	`['@wildcard@']`
`185`	`186`	`];`
`186`	`187`	`}`