Matcher modifiers

src/Exception/UnknownModifierClassException.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Coduo\PHPMatcher\Exception;
+
+class UnknownModifierClassException extends \Exception
+{
+    public function __construct(string $name, string $class)
+    {
+        parent::__construct(\sprintf(
+            'Unknown class %s for modifier %s',
+            $class,
+            $name
+        ));
+    }
+}

src/Exception/UnknownModifierException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Coduo\PHPMatcher\Exception;
+
+class UnknownModifierException extends Exception
+{
+}

src/Factory/SimpleFactory.php

@@ -21,12 +21,14 @@ protected function buildMatchers() : Matcher\ChainMatcher
         $scalarMatchers = $this->buildScalarMatchers();
         $orMatcher = $this->buildOrMatcher();
 
+        $parser = $this->buildParser();
+
         $chainMatcher = new Matcher\ChainMatcher([
             $scalarMatchers,
             $orMatcher,
-            new Matcher\JsonMatcher($orMatcher),
+            new Matcher\JsonMatcher($orMatcher, $parser),
             new Matcher\XmlMatcher($orMatcher),
-            new Matcher\TextMatcher($scalarMatchers, $this->buildParser())
+            new Matcher\TextMatcher($scalarMatchers, $parser)
         ]);
 
         return $chainMatcher;
@@ -76,6 +78,6 @@ protected function buildScalarMatchers() : Matcher\ChainMatcher
 
     protected function buildParser() : Parser
     {
-        return new Parser(new Lexer(), new Parser\ExpanderInitializer());
+        return new Parser(new Lexer(), new Parser\ExpanderInitializer(), new Parser\ModifiersRegistry());
     }
 }

src/Lexer.php

@@ -20,6 +20,7 @@ final class Lexer extends AbstractLexer
     const T_COMMA  = 10;
     const T_COLON = 11;
     const T_TYPE_PATTERN = 12;
+    const T_MODIFIERS_NAMES = 13;
 
     /**
      * Lexical catchable patterns.
@@ -33,6 +34,7 @@ protected function getCatchablePatterns() : array
             "'(?:[^']|'')*'", // string between ' character
             '"(?:[^"]|"")*"', // string between " character,
             '@[a-zA-Z0-9\\*]+@', // type pattern
+            Parser::MODIFIERS_REGEX, // modifiers names
         ];
     }
 
@@ -102,6 +104,10 @@ protected function getType(&$value) : int
             return self::T_EXPANDER_NAME;
         }
 
+        if ($this->isModifierNamesToken($value)) {
+            return self::T_MODIFIERS_NAMES;
+        }
+
         return $type;
     }
 
@@ -134,4 +140,9 @@ protected function isTypePatternToken(string $value) : bool
     {
         return \substr($value, 0, 1) === '@' && \substr($value, \strlen($value) - 1, 1) === '@' && \strlen($value) > 1;
     }
+
+    protected function isModifierNamesToken(string $value) : bool
+    {
+        return \substr($value, 0, 1) === '|' && \substr($value, \strlen($value) - 1, 1) === '|' && \strlen($value) > 2;
+    }
 }

src/Matcher/ArrayMatcher.php

@@ -5,27 +5,42 @@
 namespace Coduo\PHPMatcher\Matcher;
 
 use Coduo\PHPMatcher\Exception\Exception;
+use Coduo\PHPMatcher\Matcher\Modifier\CaseInsensitive;
+use Coduo\PHPMatcher\Matcher\Modifier\IgnoreExtraKeys;
+use Coduo\PHPMatcher\Matcher\Modifier\MatcherModifier;
 use Coduo\PHPMatcher\Parser;
 use Coduo\ToString\StringConverter;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\PropertyAccess\PropertyPath;
 
-final class ArrayMatcher extends Matcher
+final class ArrayMatcher extends ModifiableMatcher
 {
     const PATTERN = 'array';
     const UNBOUNDED_PATTERN = '@...@';
 
+    const SUPPORTED_MODIFIERS = [
+        IgnoreExtraKeys::NAME,
+        CaseInsensitive::NAME
+    ];
+
     private $propertyMatcher;
 
     private $accessor;
 
     private $parser;
 
+    /**
+     * @var bool
+     */
+    private $ignoreExtraKeys;
+
     public function __construct(ValueMatcher $propertyMatcher, Parser $parser)
     {
         $this->propertyMatcher = $propertyMatcher;
         $this->parser = $parser;
+
+        $this->ignoreExtraKeys = false;
     }
 
     public function match($value, $pattern) : bool
@@ -55,13 +70,32 @@ public function canMatch($pattern) : bool
         return \is_array($pattern) || $this->isArrayPattern($pattern);
     }
 
+    public function supportedModifiers(): array
+    {
+        return self::SUPPORTED_MODIFIERS;
+    }
+
+    public function getMatchers(): array
+    {
+        return [$this->propertyMatcher];
+    }
+
+    public function applyModifier(MatcherModifier $modifier)
+    {
+        switch ($modifier->getName()) {
+            case IgnoreExtraKeys::NAME:
+                $this->ignoreExtraKeys = true;
+                break;
+        }
+    }
+
     private function isArrayPattern($pattern) : bool
     {
         if (!\is_string($pattern)) {
             return false;
         }
 
-        return $this->parser->hasValidSyntax($pattern) && $this->parser->parse($pattern)->is(self::PATTERN);
+        return $this->parser->hasValidSyntax($pattern) && $this->parser->parseTypePattern($pattern)->is(self::PATTERN);
     }
 
     private function iterateMatch(array $values, array $patterns, string $parentPath = '') : bool
@@ -126,7 +160,7 @@ function ($item) use ($skipPattern) {
             );
 
             $notExistingKeys = $this->findNotExistingKeys($pattern, $values);
-            if (\count($notExistingKeys) > 0) {
+            if (\count($notExistingKeys) > 0 && !$this->ignoreExtraKeys) {
                 $keyNames = \array_keys($notExistingKeys);
                 $path = $this->formatFullPath($parentPath, $this->formatAccessPath($keyNames[0]));
                 $this->setMissingElementInError('value', $path);
@@ -148,7 +182,7 @@ private function findNotExistingKeys(array $pattern, array $values) : array
             }
 
             try {
-                $typePattern = $this->parser->parse($pattern);
+                $typePattern = $this->parser->parseTypePattern($pattern);
             } catch (Exception $e) {
                 return true;
             } catch (\Throwable $t) {
@@ -237,7 +271,7 @@ private function shouldSkippValueMatchingFor($lastPattern) : bool
 
     private function allExpandersMatch($value, $pattern) : bool
     {
-        $typePattern = $this->parser->parse($pattern);
+        $typePattern = $this->parser->parseTypePattern($pattern);
         if (!$typePattern->matchExpanders($value)) {
             $this->error = $typePattern->getError();
             return false;

src/Matcher/BooleanMatcher.php

@@ -34,6 +34,6 @@ public function canMatch($pattern) : bool
             return false;
         }
 
-        return $this->parser->hasValidSyntax($pattern) && $this->parser->parse($pattern)->is(self::PATTERN);
+        return $this->parser->hasValidSyntax($pattern) && $this->parser->parseTypePattern($pattern)->is(self::PATTERN);
     }
 }

src/Matcher/ChainMatcher.php

@@ -4,9 +4,11 @@
 
 namespace Coduo\PHPMatcher\Matcher;
 
+use Coduo\PHPMatcher\Matcher\Modifier\MatcherModifier;
+use Coduo\PHPMatcher\Parser\ModifiersRegistry;
 use Coduo\ToString\StringConverter;
 
-final class ChainMatcher extends Matcher
+final class ChainMatcher extends ModifiableMatcher
 {
     /**
      * @var ValueMatcher[]
@@ -53,4 +55,19 @@ public function canMatch($pattern) : bool
     {
         return true;
     }
+
+    public function supportedModifiers(): array
+    {
+        return \array_keys(ModifiersRegistry::BUILT_IN_MODIFIERS);
+    }
+
+    public function getMatchers(): array
+    {
+        return $this->matchers;
+    }
+
+    public function applyModifier(MatcherModifier $modifier)
+    {
+
+    }
 }

src/Matcher/DoubleMatcher.php

@@ -25,7 +25,7 @@ public function match($value, $pattern) : bool
             return false;
         }
 
-        $typePattern = $this->parser->parse($pattern);
+        $typePattern = $this->parser->parseTypePattern($pattern);
         if (!$typePattern->matchExpanders($value)) {
             $this->error = $typePattern->getError();
             return false;
@@ -40,6 +40,6 @@ public function canMatch($pattern) : bool
             return false;
         }
 
-        return $this->parser->hasValidSyntax($pattern) && $this->parser->parse($pattern)->is(self::PATTERN);
+        return $this->parser->hasValidSyntax($pattern) && $this->parser->parseTypePattern($pattern)->is(self::PATTERN);
     }
 }

src/Matcher/IntegerMatcher.php

@@ -25,7 +25,7 @@ public function match($value, $pattern) : bool
             return false;
         }
 
-        $typePattern = $this->parser->parse($pattern);
+        $typePattern = $this->parser->parseTypePattern($pattern);
         if (!$typePattern->matchExpanders($value)) {
             $this->error = $typePattern->getError();
             return false;
@@ -40,6 +40,6 @@ public function canMatch($pattern) : bool
             return false;
         }
 
-        return $this->parser->hasValidSyntax($pattern) && $this->parser->parse($pattern)->is(self::PATTERN);
+        return $this->parser->hasValidSyntax($pattern) && $this->parser->parseTypePattern($pattern)->is(self::PATTERN);
     }
 }

src/Matcher/JsonMatcher.php

@@ -4,15 +4,33 @@
 
 namespace Coduo\PHPMatcher\Matcher;
 
+use Coduo\PHPMatcher\Matcher\Modifier\CaseInsensitive;
+use Coduo\PHPMatcher\Matcher\Modifier\IgnoreExtraKeys;
+use Coduo\PHPMatcher\Matcher\Modifier\MatcherModifier;
 use Coduo\PHPMatcher\Matcher\Pattern\Assert\Json;
+use Coduo\PHPMatcher\Parser;
 
-final class JsonMatcher extends Matcher
+final class JsonMatcher extends ModifiableMatcher
 {
+    const SUPPORTED_MODIFIERS = [
+        IgnoreExtraKeys::NAME,
+        CaseInsensitive::NAME
+    ];
+
+    /**
+     * @var ValueMatcher
+     */
     private $matcher;
 
-    public function __construct(ValueMatcher $matcher)
+    /**
+     * @var Parser
+     */
+    private $parser;
+
+    public function __construct(ValueMatcher $matcher, Parser $parser)
     {
         $this->matcher = $matcher;
+        $this->parser = $parser;
     }
 
     public function match($value, $pattern) : bool
@@ -21,6 +39,12 @@ public function match($value, $pattern) : bool
             return true;
         }
 
+        foreach ($this->parser->parseModifiers($pattern) as $modifier) {
+            $this->modify($modifier);
+        }
+
+        $pattern = $this->parser->trimModifiers($pattern);
+
         if (!Json::isValid($value)) {
             $this->error = \sprintf('Invalid given JSON of value. %s', $this->getErrorMessage());
             return false;
@@ -43,9 +67,27 @@ public function match($value, $pattern) : bool
 
     public function canMatch($pattern) : bool
     {
+        if (\is_string($pattern)) {
+            $pattern = $this->parser->trimModifiers($pattern);
+        }
+
         return Json::isValidPattern($pattern);
     }
 
+    public function supportedModifiers(): array
+    {
+        return \array_keys(self::SUPPORTED_MODIFIERS);
+    }
+
+    public function getMatchers(): array
+    {
+        return [$this->matcher];
+    }
+
+    public function applyModifier(MatcherModifier $modifier)
+    {
+    }
+
     private function getErrorMessage()
     {
         switch (\json_last_error()) {