added HasProperty pattern expander (#185)

norberttech · web-flow · commit 9e2e519ec0fa · 2019-11-23T15:48:01.000+01:00
* added HasProperty pattern expander

* CS Fixes
diff --git a/README.md b/README.md
@@ -90,6 +90,7 @@ $matcher->getError(); // returns null or error message
 * ``lowerThan($boundry)``
 * ``greaterThan($boundry)``
 * ``inArray($value)``
+* ``hasProperty($propertyName)`` - example ``"@json@.hasProperty(\"property_name\")"``
 * ``oneOf(...$expanders)`` - example ``"@string@.oneOf(contains('foo'), contains('bar'), contains('baz'))"``
 * ``matchRegex($regex)`` - example ``"@string@.matchRegex('/^lorem.+/')"``
 * ``optional()`` - work's only with ``ArrayMatcher``, ``JsonMatcher`` and ``XmlMatcher``
diff --git a/src/Matcher/Pattern/Expander/After.php b/src/Matcher/Pattern/Expander/After.php
@@ -9,7 +9,7 @@
 
 final class After implements PatternExpander
 {
-    const NAME = 'after';
+    public const NAME = 'after';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/Before.php b/src/Matcher/Pattern/Expander/Before.php
@@ -9,7 +9,7 @@
 
 final class Before implements PatternExpander
 {
-    const NAME = 'before';
+    public const NAME = 'before';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/Contains.php b/src/Matcher/Pattern/Expander/Contains.php
@@ -9,7 +9,7 @@
 
 final class Contains implements PatternExpander
 {
-    const NAME = 'contains';
+    public const NAME = 'contains';
 
     use BacktraceBehavior;
 
@@ -51,7 +51,7 @@ public function match($value) : bool
         }
 
         $this->backtrace->expanderSucceed(self::NAME, $value);
-        
+
         return true;
     }
 
diff --git a/src/Matcher/Pattern/Expander/Count.php b/src/Matcher/Pattern/Expander/Count.php
@@ -9,7 +9,7 @@
 
 final class Count implements PatternExpander
 {
-    const NAME = 'count';
+    public const NAME = 'count';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/EndsWith.php b/src/Matcher/Pattern/Expander/EndsWith.php
@@ -9,7 +9,7 @@
 
 final class EndsWith implements PatternExpander
 {
-    const NAME = 'endsWith';
+    public const NAME = 'endsWith';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/GreaterThan.php b/src/Matcher/Pattern/Expander/GreaterThan.php
@@ -9,7 +9,7 @@
 
 final class GreaterThan implements PatternExpander
 {
-    const NAME = 'greaterThan';
+    public const NAME = 'greaterThan';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/HasProperty.php b/src/Matcher/Pattern/Expander/HasProperty.php
@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Coduo\PHPMatcher\Matcher\Pattern\Expander;
+
+use Coduo\PHPMatcher\Matcher\Pattern\Assert\Json;
+use Coduo\PHPMatcher\Matcher\Pattern\PatternExpander;
+use Coduo\ToString\StringConverter;
+
+final class HasProperty implements PatternExpander
+{
+    public const NAME = 'hasProperty';
+
+    use BacktraceBehavior;
+
+    private $propertyName;
+    private $error;
+
+    public function __construct($propertyName)
+    {
+        $this->propertyName = $propertyName;
+    }
+
+    public static function is(string $name): bool
+    {
+        return self::NAME === $name;
+    }
+
+    public function match($value): bool
+    {
+        $this->backtrace->expanderEntrance(self::NAME, $value);
+
+        if (\is_array($value)) {
+            $hasProperty = \array_key_exists($this->propertyName, $value);
+
+            if (!$hasProperty) {
+                $this->error = \sprintf('"json" object "%s" does not have "%s" propety.', new StringConverter($value), new StringConverter($this->propertyName));
+                $this->backtrace->expanderFailed(self::NAME, $value, $this->error);
+
+                return false;
+            }
+
+            $this->backtrace->expanderSucceed(self::NAME, $value);
+
+            return true;
+        }
+
+        if (!Json::isValid($value)) {
+            $this->error = \sprintf('HasProperty expander require valid "json" string, got "%s".', new StringConverter($value));
+            $this->backtrace->expanderFailed(self::NAME, $value, $this->error);
+
+            return false;
+        }
+
+        $jsonArray = \json_decode(Json::reformat($value), true);
+
+        $hasProperty = \array_key_exists($this->propertyName, $jsonArray);
+
+        if (!$hasProperty) {
+            $this->error = \sprintf('"json" object "%s" does not have "%s" propety.', new StringConverter($value), new StringConverter($this->propertyName));
+            $this->backtrace->expanderFailed(self::NAME, $value, $this->error);
+
+            return false;
+        }
+
+        $this->backtrace->expanderSucceed(self::NAME, $value);
+
+        return true;
+    }
+
+    public function getError(): ?string
+    {
+        return $this->error;
+    }
+}
diff --git a/src/Matcher/Pattern/Expander/InArray.php b/src/Matcher/Pattern/Expander/InArray.php
@@ -9,7 +9,7 @@
 
 final class InArray implements PatternExpander
 {
-    const NAME = 'inArray';
+    public const NAME = 'inArray';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/IsDateTime.php b/src/Matcher/Pattern/Expander/IsDateTime.php
@@ -9,7 +9,7 @@
 
 final class IsDateTime implements PatternExpander
 {
-    const NAME = 'isDateTime';
+    public const NAME = 'isDateTime';
 
     use BacktraceBehavior;
 
@@ -39,7 +39,7 @@ public function match($value) : bool
         }
 
         $this->backtrace->expanderSucceed(self::NAME, $value);
-        
+
         return true;
     }
 
diff --git a/src/Matcher/Pattern/Expander/IsEmail.php b/src/Matcher/Pattern/Expander/IsEmail.php
@@ -9,7 +9,7 @@
 
 final class IsEmail implements PatternExpander
 {
-    const NAME = 'isEmail';
+    public const NAME = 'isEmail';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/IsEmpty.php b/src/Matcher/Pattern/Expander/IsEmpty.php
@@ -9,7 +9,7 @@
 
 final class IsEmpty implements PatternExpander
 {
-    const NAME = 'isEmpty';
+    public const NAME = 'isEmpty';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/IsIp.php b/src/Matcher/Pattern/Expander/IsIp.php
@@ -9,7 +9,7 @@
 
 final class IsIp implements PatternExpander
 {
-    const NAME = 'isIp';
+    public const NAME = 'isIp';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/IsNotEmpty.php b/src/Matcher/Pattern/Expander/IsNotEmpty.php
@@ -9,7 +9,7 @@
 
 final class IsNotEmpty implements PatternExpander
 {
-    const NAME = 'isNotEmpty';
+    public const NAME = 'isNotEmpty';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/IsUrl.php b/src/Matcher/Pattern/Expander/IsUrl.php
@@ -9,7 +9,7 @@
 
 final class IsUrl implements PatternExpander
 {
-    const NAME = 'isUrl';
+    public const NAME = 'isUrl';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/LowerThan.php b/src/Matcher/Pattern/Expander/LowerThan.php
@@ -9,7 +9,7 @@
 
 final class LowerThan implements PatternExpander
 {
-    const NAME = 'lowerThan';
+    public const NAME = 'lowerThan';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/Match.php b/src/Matcher/Pattern/Expander/Match.php
@@ -9,7 +9,7 @@
 
 final class Match implements Matcher\Pattern\PatternExpander
 {
-    const NAME = 'match';
+    public const NAME = 'match';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/MatchRegex.php b/src/Matcher/Pattern/Expander/MatchRegex.php
@@ -9,7 +9,7 @@
 
 final class MatchRegex implements PatternExpander
 {
-    const NAME = 'matchRegex';
+    public const NAME = 'matchRegex';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/NotContains.php b/src/Matcher/Pattern/Expander/NotContains.php
@@ -9,7 +9,7 @@
 
 final class NotContains implements PatternExpander
 {
-    const NAME = 'notContains';
+    public const NAME = 'notContains';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/OneOf.php b/src/Matcher/Pattern/Expander/OneOf.php
@@ -9,7 +9,7 @@
 
 final class OneOf implements PatternExpander
 {
-    const NAME = 'oneOf';
+    public const NAME = 'oneOf';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/Optional.php b/src/Matcher/Pattern/Expander/Optional.php
@@ -8,7 +8,7 @@
 
 final class Optional implements PatternExpander
 {
-    const NAME = 'optional';
+    public const NAME = 'optional';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/Repeat.php b/src/Matcher/Pattern/Expander/Repeat.php
@@ -11,7 +11,7 @@
 
 final class Repeat implements PatternExpander
 {
-    const NAME = 'repeat';
+    public const NAME = 'repeat';
 
     use BacktraceBehavior;
 
diff --git a/src/Matcher/Pattern/Expander/StartsWith.php b/src/Matcher/Pattern/Expander/StartsWith.php
@@ -9,7 +9,7 @@
 
 final class StartsWith implements PatternExpander
 {
-    const NAME = 'startsWith';
+    public const NAME = 'startsWith';
 
     use BacktraceBehavior;
 
diff --git a/src/Parser/ExpanderInitializer.php b/src/Parser/ExpanderInitializer.php
@@ -36,7 +36,8 @@ final class ExpanderInitializer
         Expander\Optional::NAME => Expander\Optional::class,
         Expander\StartsWith::NAME => Expander\StartsWith::class,
         Expander\Repeat::NAME => Expander\Repeat::class,
-        Expander\Match::NAME => Expander\Match::class
+        Expander\Match::NAME => Expander\Match::class,
+        Expander\HasProperty::NAME => Expander\HasProperty::class
     ];
 
     private $backtrace;
diff --git a/tests/Matcher/JsonObjectMatcherTest.php b/tests/Matcher/JsonObjectMatcherTest.php
@@ -57,6 +57,10 @@ public static function positiveMatches()
                 '{"users":["Norbert","Michał"]}',
                 '@json@.contains("users")'
             ],
+            [
+                '{"users":["Norbert","Michał"]}',
+                '@json@.hasProperty("users")'
+            ],
             [
                 [1, 2, 3],
                 '@json@',
diff --git a/tests/Matcher/Pattern/Expander/HasPropertyTest.php b/tests/Matcher/Pattern/Expander/HasPropertyTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Coduo\PHPMatcher\Tests\Matcher\Pattern\Expander;
+
+use Coduo\PHPMatcher\Backtrace;
+use Coduo\PHPMatcher\Matcher\Pattern\Expander\HasProperty;
+use PHPUnit\Framework\TestCase;
+
+class HasPropertyTest extends TestCase
+{
+    /**
+     * @dataProvider examplesProvider
+     */
+    public function test_examples($propertyName, $value, $expectedResult)
+    {
+        $expander = new HasProperty($propertyName);
+        $expander->setBacktrace(new Backtrace());
+        $this->assertEquals($expectedResult, $expander->match($value));
+    }
+
+    public static function examplesProvider()
+    {
+        return [
+            ['property','{"property":1}',true],
+            ['property','{"property_02":1}',false],
+            ['property',['property' => 1],true],
+            ['property',['property_02' => 1],false],
+            ['property','{"object_nested":{"property": 1}}',false],
+        ];
+    }
+}
diff --git a/tests/MatcherTest.php b/tests/MatcherTest.php
@@ -211,6 +211,34 @@ public static function nullExamples()
     public function jsonDataProvider()
     {
         return [
+            [
+                '{"data": {"createUserFormSchema":{"formData":"test","schema":"test","uiSchema":"test"}}}',
+                '{"data": {"createUserFormSchema":"@json@.hasProperty(\"formData\").hasProperty(\"schema\").hasProperty(\"uiSchema\")"}}'
+            ],
+            [
+                /** @lang JSON */
+                '{
+                    "users":[
+                        {
+                            "id": 131,
+                            "firstName": "Norbert",
+                            "lastName": "Orzechowicz",
+                            "enabled": true,
+                            "roles": ["ROLE_DEVELOPER"]
+                        },
+                        {
+                            "id": 132,
+                            "firstName": "Michał",
+                            "lastName": "Dąbrowski",
+                            "enabled": false,
+                            "roles": ["ROLE_DEVELOPER"]
+                        }
+                    ],
+                    "prevPage": "http:\/\/example.com\/api\/users\/1?limit=2",
+                    "nextPage": "http:\/\/example.com\/api\/users\/3?limit=2"
+                }',
+                '@json@.hasProperty("users")'
+            ],
             [
                 /** @lang JSON */
                 '{

-Original file line number
+Diff line change
 * ``lowerThan($boundry)``
 * ``greaterThan($boundry)``
 * ``inArray($value)``
 +* ``hasProperty($propertyName)`` - example ``"@[email protected](\"property_name\")"``
 * ``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``
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`final class After implements PatternExpander`
`11`	`11`	`{`
`12`		`- const NAME = 'after';`
	`12`	`+ public const NAME = 'after';`
`13`	`13`
`14`	`14`	`use BacktraceBehavior;`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`final class Optional implements PatternExpander`
`10`	`10`	`{`
`11`		`- const NAME = 'optional';`
	`11`	`+ public const NAME = 'optional';`
`12`	`12`
`13`	`13`	`use BacktraceBehavior;`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`final class Repeat implements PatternExpander`
`13`	`13`	`{`
`14`		`- const NAME = 'repeat';`
	`14`	`+ public const NAME = 'repeat';`
`15`	`15`
`16`	`16`	`use BacktraceBehavior;`
`17`	`17`