Allow to mark JSON properties & XML nodes as optional

README.md

@@ -83,6 +83,7 @@ $matcher->getError(); // returns null or error message
 * ``inArray($value)``
 * ``oneOf(...$expanders)`` - example usage ``"@[email protected](contains('foo'), contains('bar'), contains('baz'))"``
 * ``matchRegex($regex)`` - example usage ``"@[email protected]('/^lorem.+/')"``
+* ``optional()`` - work's only with ``ArrayMatcher``, ``JsonMatcher`` and ``XmlMatcher``
 
 ##Example usage
 
@@ -237,7 +238,8 @@ $matcher->match(
               'id' => 1,
               'firstName' => 'Norbert',
               'lastName' => 'Orzechowicz',
-              'roles' => array('ROLE_USER')
+              'roles' => array('ROLE_USER'),
+              'position' => 'Developer',
           ),
           array(
               'id' => 2,
@@ -261,7 +263,8 @@ $matcher->match(
               'id' => '@[email protected](0)',
               'firstName' => '@string@',
               'lastName' => 'Orzechowicz',
-              'roles' => '@array@'
+              'roles' => '@array@',
+              'position' => '@[email protected]()'
           ),
           array(
               'id' => '@integer@',
@@ -303,7 +306,8 @@ $matcher->match(
         "firstName": @string@,
         "lastName": @string@,
         "created": "@[email protected]()",
-        "roles": @array@
+        "roles": @array@,
+        "posiiton": "@[email protected]()"
       }
     ]
   }'
@@ -347,6 +351,7 @@ XML
   <m:GetStockPrice>
     <m:StockName>@string@</m:StockName>
     <m:StockValue>@string@</m:StockValue>
+    <m:StockQty>@[email protected]()</m:StockQty>
   </m:GetStockPrice>
 </soap:Body>
 

src/Matcher/ArrayMatcher.php

@@ -2,6 +2,7 @@
 
 namespace Coduo\PHPMatcher\Matcher;
 
+use Coduo\PHPMatcher\Exception\Exception;
 use Coduo\PHPMatcher\Parser;
 use Coduo\ToString\StringConverter;
 use Symfony\Component\PropertyAccess\PropertyAccess;
@@ -153,19 +154,46 @@ function ($item) use ($skipPattern) {
                 }
             );
 
-            $notExistingKeys = array_diff_key($pattern, $values);
-
+            $notExistingKeys = $this->findNotExistingKeys($pattern, $values);
             if (count($notExistingKeys) > 0) {
                 $keyNames = array_keys($notExistingKeys);
                 $path = $this->formatFullPath($parentPath, $this->formatAccessPath($keyNames[0]));
                 $this->setMissingElementInError('value', $path);
+
                 return false;
             }
         }
 
         return true;
     }
 
+    /**
+     * Finds not existing keys
+     * Excludes keys with pattern which includes Optional Expander
+     *
+     * @param $pattern
+     * @param $values
+     * @return array
+     */
+    private function findNotExistingKeys($pattern, $values)
+    {
+        $notExistingKeys = array_diff_key($pattern, $values);
+
+        return array_filter($notExistingKeys, function ($pattern) use ($values) {
+            if (is_array($pattern)) {
+                return !$this->match($values, $pattern);
+            }
+
+            try {
+                $typePattern = $this->parser->parse($pattern);
+            } catch (Exception $e) {
+                return true;
+            }
+
+            return !$typePattern->hasExpander('optional');
+        });
+    }
+
     /**
      * @param $value
      * @param $pattern

src/Matcher/Pattern/Expander/Contains.php

@@ -7,6 +7,8 @@
 
 final class Contains implements PatternExpander
 {
+    const NAME = 'contains';
+
     /**
      * @var null|string
      */

src/Matcher/Pattern/Expander/Count.php

@@ -7,6 +7,8 @@
 
 final class Count implements PatternExpander
 {
+    const NAME = 'count';
+
     /**
      * @var null|string
      */

src/Matcher/Pattern/Expander/EndsWith.php

@@ -7,6 +7,8 @@
 
 final class EndsWith implements PatternExpander
 {
+    const NAME = 'endsWith';
+
     /**
      * @var
      */

src/Matcher/Pattern/Expander/GreaterThan.php

@@ -7,6 +7,8 @@
 
 final class GreaterThan implements PatternExpander
 {
+    const NAME = 'greaterThan';
+
     /**
      * @var
      */

src/Matcher/Pattern/Expander/InArray.php

@@ -7,6 +7,8 @@
 
 final class InArray implements PatternExpander
 {
+    const NAME = 'inArray';
+
     /**
      * @var null|string
      */

src/Matcher/Pattern/Expander/IsDateTime.php

@@ -7,6 +7,8 @@
 
 final class IsDateTime implements PatternExpander
 {
+    const NAME = 'isDateTime';
+
     /**
      * @var null|string
      */

src/Matcher/Pattern/Expander/IsEmail.php

@@ -7,6 +7,8 @@
 
 final class IsEmail implements PatternExpander
 {
+    const NAME = 'isEmail';
+
     /**
      * @var null|string
      */

src/Matcher/Pattern/Expander/IsEmpty.php

@@ -7,6 +7,8 @@
 
 final class IsEmpty implements PatternExpander
 {
+    const NAME = 'isEmpty';
+
     private $error;
 
     /**

src/Matcher/Pattern/Expander/IsNotEmpty.php

@@ -7,6 +7,8 @@
 
 final class IsNotEmpty implements PatternExpander
 {
+    const NAME = 'isNotEmpty';
+
     private $error;
 
     /**

src/Matcher/Pattern/Expander/IsUrl.php

@@ -7,6 +7,8 @@
 
 final class IsUrl implements PatternExpander
 {
+    const NAME = 'isUrl';
+
     /**
      * @var null|string
      */

src/Matcher/Pattern/Expander/LowerThan.php

@@ -7,6 +7,8 @@
 
 final class LowerThan implements PatternExpander
 {
+    const NAME = 'lowerThan';
+
     /**
      * @var
      */

src/Matcher/Pattern/Expander/MatchRegex.php

@@ -7,6 +7,8 @@
 
 final class MatchRegex implements PatternExpander
 {
+    const NAME = 'matchRegex';
+
     /**
      * @var null|string
      */

src/Matcher/Pattern/Expander/OneOf.php

@@ -7,6 +7,8 @@
 
 final class OneOf implements PatternExpander
 {
+    const NAME = 'oneOf';
+
     /**
      * @var PatternExpander[]
      */

src/Matcher/Pattern/Expander/Optional.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Coduo\PHPMatcher\Matcher\Pattern\Expander;
+
+use Coduo\PHPMatcher\Matcher\Pattern\PatternExpander;
+
+final class Optional implements PatternExpander
+{
+    const NAME = 'optional';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function match($value)
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getError()
+    {
+        return null;
+    }
+}

src/Matcher/Pattern/Expander/StartsWith.php

@@ -7,6 +7,8 @@
 
 final class StartsWith implements PatternExpander
 {
+    const NAME = 'startsWith';
+
     /**
      * @var
      */

src/Matcher/Pattern/Pattern.php

@@ -21,4 +21,13 @@ public function matchExpanders($value);
      * @return null|string
      */
     public function getError();
+
+    /**
+     * Checks whether a Pattern has added Expander.
+     *
+     * @param string $expanderName The name of the expander
+     *
+     * @return bool true if the specified pattern has expander, false otherwise
+     */
+    public function hasExpander(string $expanderName);
 }

src/Matcher/Pattern/TypePattern.php

@@ -69,10 +69,24 @@ public function matchExpanders($value)
     }
 
     /**
-     * @return null|string
+     * {@inheritdoc}
      */
     public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasExpander(string $expanderName)
+    {
+        foreach ($this->expanders as $expander) {
+            if ($expander::NAME === $expanderName) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

src/Parser/ExpanderInitializer.php

@@ -2,35 +2,36 @@
 
 namespace Coduo\PHPMatcher\Parser;
 
-use Coduo\PHPMatcher\AST\Expander;
+use Coduo\PHPMatcher\AST\Expander as ExpanderNode;
 use Coduo\PHPMatcher\Exception\InvalidArgumentException;
 use Coduo\PHPMatcher\Exception\InvalidExpanderTypeException;
 use Coduo\PHPMatcher\Exception\UnknownExpanderClassException;
 use Coduo\PHPMatcher\Exception\UnknownExpanderException;
 use Coduo\PHPMatcher\Matcher\Pattern\PatternExpander;
+use Coduo\PHPMatcher\Matcher\Pattern\Expander;
 
 final class ExpanderInitializer
 {
     /**
      * @var array
      */
-    private $expanderDefinitions = array(
-        "startsWith" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\StartsWith",
-        "endsWith" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\EndsWith",
-        "isNotEmpty" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\IsNotEmpty",
-        "isEmpty" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\IsEmpty",
-        "isDateTime" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\IsDateTime",
-        "isEmail" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\IsEmail",
-        "isUrl" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\IsUrl",
-        "lowerThan" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\LowerThan",
-        "greaterThan" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\GreaterThan",
-        "inArray" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\InArray",
-        "count" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\Count",
-        "contains" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\Contains",
-        "matchRegex" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\MatchRegex",
-
-        "oneOf" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\OneOf"
-    );
+    private $expanderDefinitions = [
+        Expander\Contains::NAME => Expander\Contains::class,
+        Expander\Count::NAME => Expander\Count::class,
+        Expander\EndsWith::NAME => Expander\EndsWith::class,
+        Expander\GreaterThan::NAME => Expander\GreaterThan::class,
+        Expander\InArray::NAME => Expander\InArray::class,
+        Expander\IsDateTime::NAME => Expander\IsDateTime::class,
+        Expander\IsEmail::NAME => Expander\IsEmail::class,
+        Expander\IsEmpty::NAME => Expander\IsEmpty::class,
+        Expander\IsNotEmpty::NAME => Expander\IsNotEmpty::class,
+        Expander\IsUrl::NAME => Expander\IsUrl::class,
+        Expander\LowerThan::NAME => Expander\LowerThan::class,
+        Expander\MatchRegex::NAME => Expander\MatchRegex::class,
+        Expander\OneOf::NAME => Expander\OneOf::class,
+        Expander\Optional::NAME => Expander\Optional::class,
+        Expander\StartsWith::NAME => Expander\StartsWith::class,
+    ];
 
     /**
      * @param string $expanderName
@@ -70,12 +71,12 @@ public function getExpanderDefinition($expanderName)
     }
 
     /**
-     * @param Expander $expanderNode
+     * @param ExpanderNode $expanderNode
      * @throws InvalidExpanderTypeException
      * @throws UnknownExpanderException
      * @return PatternExpander
      */
-    public function initialize(Expander $expanderNode)
+    public function initialize(ExpanderNode $expanderNode)
     {
         if (!array_key_exists($expanderNode->getName(), $this->expanderDefinitions)) {
             throw new UnknownExpanderException(sprintf("Unknown expander \"%s\"", $expanderNode->getName()));
@@ -86,7 +87,7 @@ public function initialize(Expander $expanderNode)
         if ($expanderNode->hasArguments()) {
             $arguments = array();
             foreach ($expanderNode->getArguments() as $argument) {
-                $arguments[] = ($argument instanceof Expander)
+                $arguments[] = ($argument instanceof ExpanderNode)
                     ? $this->initialize($argument)
                     : $argument;
             }