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 ``"@string@.oneOf(contains('foo'), contains('bar'), contains('baz'))"``
 * ``matchRegex($regex)`` - example usage ``"@string@.matchRegex('/^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' => '@integer@.greaterThan(0)',
               'firstName' => '@string@',
               'lastName' => 'Orzechowicz',
-              'roles' => '@array@'
+              'roles' => '@array@',
+              'position' => '@string@.optional()'
           ),
           array(
               'id' => '@integer@',
@@ -303,7 +306,8 @@ $matcher->match(
         "firstName": @string@,
         "lastName": @string@,
         "created": "@string@.isDateTime()",
-        "roles": @array@
+        "roles": @array@,
+        "posiiton": "@string@.optional()"
       }
     ]
   }'
@@ -347,6 +351,7 @@ XML
   <m:GetStockPrice>
     <m:StockName>@string@</m:StockName>
     <m:StockValue>@string@</m:StockValue>
+    <m:StockQty>@integer@.optional()</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

@@ -62,4 +62,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'contains';
+    }
 }

src/Matcher/Pattern/Expander/Count.php

@@ -51,4 +51,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'count';
+    }
 }

src/Matcher/Pattern/Expander/EndsWith.php

@@ -77,4 +77,12 @@ protected function matchValue($value)
             ? mb_substr(mb_strtolower($value), -mb_strlen(mb_strtolower($this->stringEnding))) === mb_strtolower($this->stringEnding)
             : mb_substr($value, -mb_strlen($this->stringEnding)) === $this->stringEnding;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'endsWith';
+    }
 }

src/Matcher/Pattern/Expander/GreaterThan.php

@@ -55,4 +55,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'greaterThan';
+    }
 }

src/Matcher/Pattern/Expander/InArray.php

@@ -51,4 +51,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'inArray';
+    }
 }

src/Matcher/Pattern/Expander/IsDateTime.php

@@ -52,4 +52,12 @@ protected function matchValue($value)
             return false;
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'isDateTime';
+    }
 }

src/Matcher/Pattern/Expander/IsEmail.php

@@ -51,4 +51,12 @@ protected function matchValue($value)
             return false;
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'isEmail';
+    }
 }

src/Matcher/Pattern/Expander/IsEmpty.php

@@ -32,4 +32,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'isEmpty';
+    }
 }

src/Matcher/Pattern/Expander/IsNotEmpty.php

@@ -30,4 +30,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'isNotEmpty';
+    }
 }

src/Matcher/Pattern/Expander/IsUrl.php

@@ -51,4 +51,12 @@ protected function matchValue($value)
             return false;
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'isUrl';
+    }
 }

src/Matcher/Pattern/Expander/LowerThan.php

@@ -55,4 +55,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'lowerThan';
+    }
 }

src/Matcher/Pattern/Expander/MatchRegex.php

@@ -62,4 +62,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'matchRegex';
+    }
 }

src/Matcher/Pattern/Expander/OneOf.php

@@ -51,4 +51,12 @@ public function getError()
     {
         return $this->error;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'oneOf';
+    }
 }

src/Matcher/Pattern/Expander/Optional.php

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

src/Matcher/Pattern/Expander/StartsWith.php

@@ -67,6 +67,14 @@ public function getError()
         return $this->error;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'startsWith';
+    }
+
     /**
      * @param $value
      * @return bool

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/PatternExpander.php

@@ -14,4 +14,11 @@ public function match($value);
      * @return string|null
      */
     public function getError();
+
+    /**
+     * Returns the name by which the expander is identified.
+     *
+     * @return string The name of the expander
+     */
+    public function getName();
 }

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->getName() === $expanderName) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

src/Parser/ExpanderInitializer.php

@@ -28,7 +28,7 @@ final class ExpanderInitializer
         "count" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\Count",
         "contains" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\Contains",
         "matchRegex" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\MatchRegex",
-
+        "optional" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\Optional",
         "oneOf" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\OneOf"
     );