Merge pull request #61 from blazarecki/match-expander

Add Match expander

Author: Norbert Orzechowicz

README.md

@@ -58,6 +58,7 @@ $match = $matcher->match("lorem ipsum dolor", "@string@")
 * ``greaterThan($boundry)``
 * ``inArray($value)``
 * ``oneOf(...$expanders)`` - example usage ``"@[email protected](contains('foo'), contains('bar'), contains('baz'))"``
+* ``matchRegex($regex)`` - example usage ``"@[email protected]('/^lorem.+/')"``
 
 ##Example usage
 

src/Coduo/PHPMatcher/Matcher/Pattern/Expander/MatchRegex.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Coduo\PHPMatcher\Matcher\Pattern\Expander;
+
+use Coduo\PHPMatcher\Matcher\Pattern\PatternExpander;
+use Coduo\ToString\StringConverter;
+
+/**
+ * @author Benjamin Lazarecki <[email protected]>
+ */
+class MatchRegex implements PatternExpander
+{
+    /**
+     * @var null|string
+     */
+    private $error;
+
+    /**
+     * @var string
+     */
+    private $pattern;
+
+    /**
+     * @param string $pattern
+     */
+    public function __construct($pattern)
+    {
+        if (!is_string($pattern)) {
+            throw new \InvalidArgumentException("Regex pattern must be a string.");
+        }
+
+        if (!is_string($pattern) || @preg_match($pattern, '') === false) {
+            throw new \InvalidArgumentException("Regex pattern must be a valid one.");
+        }
+
+        $this->pattern = $pattern;
+    }
+
+    /**
+     * @param string $value
+     *
+     * @return boolean
+     */
+    public function match($value)
+    {
+        if (false === is_string($value)) {
+            $this->error = sprintf("Match expander require \"string\", got \"%s\".", new StringConverter($value));
+
+            return false;
+        }
+
+        if (1 !== preg_match($this->pattern, $value)) {
+            $this->error = sprintf("string \"%s\" don't match pattern %s.", $value, $this->pattern);
+
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getError()
+    {
+        return $this->error;
+    }
+}

src/Coduo/PHPMatcher/Parser/ExpanderInitializer.php

@@ -26,6 +26,7 @@ class ExpanderInitializer
         "greaterThan" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\GreaterThan",
         "inArray" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\InArray",
         "contains" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\Contains",
+        "match" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\MatchRegex",
 
         "oneOf" => "Coduo\\PHPMatcher\\Matcher\\Pattern\\Expander\\OneOf"
     );

tests/Coduo/PHPMatcher/Matcher/Pattern/Expander/MatchRegexTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Coduo\PHPMatcher\Tests\Matcher\Pattern\Expander;
+
+use Coduo\PHPMatcher\Matcher\Pattern\Expander\MatchRegex;
+
+/**
+ * @author Benjamin Lazarecki <[email protected]>
+ */
+class MatchRegexTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider examplesProvider
+     */
+    public function test_match_expander($expectedResult, $expectedError, $pattern, $value)
+    {
+        $expander = new MatchRegex($pattern);
+        $this->assertEquals($expectedResult, $expander->match($value));
+        $this->assertSame($expectedError, $expander->getError());
+    }
+
+    public static function examplesProvider()
+    {
+        return array(
+            array(true, null, '/^\w$/', 'a'),
+            array(false, 'string "aa" don\'t match pattern /^\w$/.', '/^\w$/', 'aa'),
+            array(false, 'Match expander require "string", got "Array(0)".', '/^\w$/', array()),
+        );
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Regex pattern must be a string.
+     */
+    public function test_that_it_only_work_with_string()
+    {
+        new MatchRegex(null);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Regex pattern must be a valid one.
+     */
+    public function test_that_it_only_work_with_valid_pattern()
+    {
+        new MatchRegex('///');
+    }
+}

tests/Coduo/PHPMatcher/MatcherTest.php

@@ -259,6 +259,8 @@ public static function expanderExamples()
             array(array('foo'), "@[email protected]()", false),
             array("lorem ipsum", "@[email protected](contains(\"lorem\"), contains(\"test\"))", true),
             array("lorem ipsum", "@[email protected](contains(\"lorem\"), contains(\"test\")).endsWith(\"ipsum\")", true),
+            array("lorem ipsum", "@[email protected](\"/^lorem \\w+$/\")", true),
+            array("lorem ipsum", "@[email protected](\"/^foo/\")", false),
         );
     }
 }