#139 - use your own regex pattern

qossmic · May 15, 2018 · ad61b47 · ad61b47
1 parent 3b645f6
commit ad61b47
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -420,9 +420,11 @@ layers:
     collectors:
       - type: className
         regex: .*Controller.*
+        predefined_delimiter: true
 ```
 
-Every classname that matches the regular expression `.*Controller.*` becomes a part of the *controller* layer.
+Every class name that matches the regular expression `.*Controller.*` becomes a part of the *controller* layer.
+Set `predefined_delimiter` to `false` to use your own delimiters and/or modifiers.
 
 
 ### `directory` Collector
@@ -436,9 +438,11 @@ layers:
     collectors:
       - type: directory
         regex: src/Controller/.*
+        predefined_delimiter: true
 ```
 
 Every file path that matches the regular expression `src/Controller/.*` becomes a part of the *controller* layer.
+Set `predefined_delimiter` to `false` to use your own delimiters and/or modifiers.
 
 
 ### `bool` collector

diff --git a/src/Collector/ClassNameCollector.php b/src/Collector/ClassNameCollector.php
@@ -14,25 +14,28 @@ public function getType(): string
         return 'className';
     }
 
-    private function getRegexByConfiguration(array $configuration)
-    {
-        if (!isset($configuration['regex'])) {
-            throw new \LogicException('ClassNameCollector needs the regex configuration.');
-        }
-
-        return $configuration['regex'];
-    }
-
     public function satisfy(
         array $configuration,
         AstClassReferenceInterface $abstractClassReference,
         AstMap $astMap,
         CollectorFactory $collectorFactory,
         AstParserInterface $astParser
     ): bool {
-        return 1 === preg_match(
-            '/'.$this->getRegexByConfiguration($configuration).'/i',
-            $abstractClassReference->getClassName()
-        );
+        return 1 === preg_match($this->getPattern($configuration), $abstractClassReference->getClassName());
+    }
+
+    private function getPattern(array $configuration)
+    {
+        if (!isset($configuration['regex'])) {
+            throw new \LogicException('ClassNameCollector needs the regex configuration.');
+        }
+
+        $pattern = $configuration['regex'];
+
+        if ($configuration['predefined_delimiter'] ?? true) {
+            $pattern = '/'.$pattern.'/i';
+        }
+
+        return $pattern;
     }
 }
diff --git a/src/Collector/DirectoryCollector.php b/src/Collector/DirectoryCollector.php
@@ -25,18 +25,21 @@ public function satisfy(
         $fileReference = $abstractClassReference->getFileReference();
         assert($fileReference instanceof AstFileReference);
 
-        return 1 === preg_match(
-            '#'.$this->getRegexByConfiguration($configuration).'#i',
-            $fileReference->getFilepath()
-        );
+        return 1 === preg_match($this->getPattern($configuration), $fileReference->getFilepath());
     }
 
-    private function getRegexByConfiguration(array $configuration)
+    private function getPattern(array $configuration)
     {
         if (!isset($configuration['regex'])) {
             throw new \LogicException('DirectoryCollector needs the regex configuration.');
         }
 
-        return $configuration['regex'];
+        $pattern = $configuration['regex'];
+
+        if ($configuration['predefined_delimiter'] ?? true) {
+            $pattern = '#'.$pattern.'#i';
+        }
+
+        return $pattern;
     }
 }
diff --git a/src/Collector/MethodCollector.php b/src/Collector/MethodCollector.php
@@ -16,15 +16,6 @@ public function getType(): string
         return 'method';
     }
 
-    private function getMethodNameRegexByConfiguration(array $configuration)
-    {
-        if (!isset($configuration['name'])) {
-            throw new \LogicException('MethodCollector needs the name configuration.');
-        }
-
-        return $configuration['name'];
-    }
-
     public function satisfy(
         array $configuration,
         AstClassReferenceInterface $classReference,
@@ -40,16 +31,29 @@ public function satisfy(
 
         /** @var ClassMethod[] $classMethods */
         $classMethods = $astParser->findNodesOfType((array) $ast, ClassMethod::class);
+        $pattern = $this->getPattern($configuration);
 
         foreach ($classMethods as $classMethod) {
-            if (1 === preg_match(
-                '/'.$this->getMethodNameRegexByConfiguration($configuration).'/i',
-                $classMethod->name
-            )) {
+            if (1 === preg_match($pattern, $classMethod->name)) {
                 return true;
             }
         }
 
         return false;
     }
+
+    private function getPattern(array $configuration)
+    {
+        if (!isset($configuration['name'])) {
+            throw new \LogicException('MethodCollector needs the name configuration.');
+        }
+
+        $pattern = $configuration['name'];
+
+        if ($configuration['predefined_delimiter'] ?? true) {
+            $pattern = '/'.$pattern.'/i';
+        }
+
+        return $pattern;
+    }
 }
diff --git a/tests/Collector/ClassNameCollectorTest.php b/tests/Collector/ClassNameCollectorTest.php
@@ -11,10 +11,12 @@
 
 class ClassNameCollectorTest extends TestCase
 {
-    public function dataProviderStatisfy()
+    public function dataProviderSatisfy()
     {
         yield [['regex' => 'a'], 'foo\bar', true];
         yield [['regex' => 'a'], 'foo\bbr', false];
+        yield [['regex' => '/^Foo\\\\Bar$/i', 'predefined_delimiter' => false], 'Foo\\Bar', true];
+        yield [['regex' => '/^Foo\\\\Bar$/i', 'predefined_delimiter' => false], 'Foo\\Baz', false];
     }
 
     public function testType()
@@ -23,9 +25,9 @@ public function testType()
     }
 
     /**
-     * @dataProvider dataProviderStatisfy
+     * @dataProvider dataProviderSatisfy
      */
-    public function testStatisfy($configuration, $className, $expected)
+    public function testSatisfy(array $configuration, string $className, bool $expected)
     {
         $astClassReference = $this->prophesize(AstClassReferenceInterface::class);
         $astClassReference->getClassName()->willReturn($className);

diff --git a/tests/Collector/DirectoryCollectorTest.php b/tests/Collector/DirectoryCollectorTest.php
@@ -17,15 +17,17 @@ public function testType()
         $this->assertEquals('directory', (new DirectoryCollector())->getType());
     }
 
-    public function dataProviderStatisfy()
+    public function dataProviderSatisfy()
     {
         yield [['regex' => 'foo/layer1/.*'], 'foo/layer1/bar.php', true];
         yield [['regex' => 'foo/layer1/.*'], 'foo/layer1/dir/bar.php', true];
         yield [['regex' => 'foo/layer1/.*'], 'foo/layer2/bar.php', false];
+        yield [['regex' => '#^foo/bar.php$#','predefined_delimiter' => false], 'foo/bar.php', true];
+        yield [['regex' => '#^foo/bar.php$#','predefined_delimiter' => false], 'foo/baz.php', false];
     }
 
     /**
-     * @dataProvider dataProviderStatisfy
+     * @dataProvider dataProviderSatisfy
      */
     public function testSatisfy(array $configuration, string $filePath, bool $expected)
     {

diff --git a/tests/Collector/MethodCollectorTest.php b/tests/Collector/MethodCollectorTest.php
@@ -13,7 +13,7 @@
 
 class MethodCollectorTest extends TestCase
 {
-    public function dataProviderStatisfy()
+    public function dataProviderSatisfy()
     {
         yield [
             ['name' => 'abc'],
@@ -41,6 +41,18 @@ public function dataProviderStatisfy()
             ],
             false,
         ];
+
+        yield [
+            ['name' => '/^fooBar$/', 'predefined_delimiter' => false],
+            [$this->getClassMethod('fooBar')],
+            true,
+        ];
+
+        yield [
+            ['name' => '/^fooBar$/', 'predefined_delimiter' => false],
+            [$this->getClassMethod('fooBaz')],
+            false,
+        ];
     }
 
     public function testType()
@@ -57,7 +69,7 @@ private function getClassMethod($name)
     }
 
     /**
-     * @dataProvider dataProviderStatisfy
+     * @dataProvider dataProviderSatisfy
      */
     public function testStatisfy($configuration, $methods, $expected)
     {