Allow to mark JSON properties & XML nodes as optional (#102)

* Add optional expander definition

* Add hasExpander method for Pattern

* Allow mark JSON properties & xml nodes as optional

* Use intuitive matcher type definition in Xml test stock qty node definition

* Add information about optional Expander to README

* Remove return type declaration

* Catch PHPMatcher Exception when parsing pattern for optional values

* Add getName to PatternExpander interface

* Remove unncessary ExpanderInitializer dependency in TypePattern

* Use constants for expander name instead of method

* Redeclare $expanderDefinitions using constants

* Add static is($name) method to PatternExpander interface

Author: teklakct

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
      */
@@ -22,6 +24,14 @@ final class Contains implements PatternExpander
      */
     private $ignoreCase;
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function is(string $name)
+    {
+        return self::NAME === $name;
+    }
+
     /**
      * @param $string
      * @param bool $ignoreCase

src/Matcher/Pattern/Expander/Count.php

@@ -7,6 +7,8 @@
 
 final class Count implements PatternExpander
 {
+    const NAME = 'count';
+
     /**
      * @var null|string
      */
@@ -17,6 +19,14 @@ final class Count implements PatternExpander
      */
     private $value;
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function is(string $name)
+    {
+        return self::NAME === $name;
+    }
+
     /**
      * @param $value
      */

src/Matcher/Pattern/Expander/EndsWith.php

@@ -7,6 +7,8 @@
 
 final class EndsWith implements PatternExpander
 {
+    const NAME = 'endsWith';
+
     /**
      * @var
      */
@@ -22,6 +24,14 @@ final class EndsWith implements PatternExpander
      */
     private $ignoreCase;
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function is(string $name)
+    {
+        return self::NAME === $name;
+    }
+
     /**
      * @param string $stringEnding
      * @param bool $ignoreCase

src/Matcher/Pattern/Expander/GreaterThan.php

@@ -7,6 +7,8 @@
 
 final class GreaterThan implements PatternExpander
 {
+    const NAME = 'greaterThan';
+
     /**
      * @var
      */
@@ -17,6 +19,14 @@ final class GreaterThan implements PatternExpander
      */
     private $error;
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function is(string $name)
+    {
+        return self::NAME === $name;
+    }
+
     /**
      * @param $boundary
      */

src/Matcher/Pattern/Expander/InArray.php

@@ -7,6 +7,8 @@
 
 final class InArray implements PatternExpander
 {
+    const NAME = 'inArray';
+
     /**
      * @var null|string
      */
@@ -17,6 +19,14 @@ final class InArray implements PatternExpander
      */
     private $value;
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function is(string $name)
+    {
+        return self::NAME === $name;
+    }
+
     /**
      * @param $value
      */

src/Matcher/Pattern/Expander/IsDateTime.php

@@ -7,11 +7,21 @@
 
 final class IsDateTime implements PatternExpander
 {
+    const NAME = 'isDateTime';
+
     /**
      * @var null|string
      */
     private $error;
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function is(string $name)
+    {
+        return self::NAME === $name;
+    }
+
     /**
      * @param string $value
      * @return boolean

src/Matcher/Pattern/Expander/IsEmail.php

@@ -7,11 +7,21 @@
 
 final class IsEmail implements PatternExpander
 {
+    const NAME = 'isEmail';
+
     /**
      * @var null|string
      */
     private $error;
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function is(string $name)
+    {
+        return self::NAME === $name;
+    }
+
     /**
      * @param string $value
      * @return boolean

src/Matcher/Pattern/Expander/IsEmpty.php

@@ -7,8 +7,18 @@
 
 final class IsEmpty implements PatternExpander
 {
+    const NAME = 'isEmpty';
+
     private $error;
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function is(string $name)
+    {
+        return self::NAME === $name;
+    }
+
     /**
      * @param mixed $value
      *