[Routing] Ignore hidden directories when loading routes from annotations

jakzal · jakzal · commit d749406af040 · 2017-03-02T14:48:21.000Z
diff --git a/src/Symfony/Component/Routing/Loader/AnnotationDirectoryLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationDirectoryLoader.php
@@ -38,7 +38,15 @@ public function load($path, $type = null)
 
         $collection = new RouteCollection();
         $collection->addResource(new DirectoryResource($dir, '/\.php$/'));
-        $files = iterator_to_array(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($dir), \RecursiveIteratorIterator::LEAVES_ONLY));
+        $files = iterator_to_array(new \RecursiveIteratorIterator(
+            new RecursiveCallbackFilterIterator(
+                new \RecursiveDirectoryIterator($dir),
+                function (\SplFileInfo $current) {
+                    return '.' !== substr($current->getBasename(), 0, 1);
+                }
+            ),
+            \RecursiveIteratorIterator::LEAVES_ONLY
+        ));
         usort($files, function (\SplFileInfo $a, \SplFileInfo $b) {
             return (string) $a > (string) $b ? 1 : -1;
         });
@@ -79,3 +87,34 @@ public function supports($resource, $type = null)
         return is_dir($path) && (!$type || 'annotation' === $type);
     }
 }
+
+/**
+ * @internal To be removed in 3.1 as RecursiveCallbackFilterIterator is available since PHP 5.4
+ */
+class RecursiveCallbackFilterIterator extends \FilterIterator implements \RecursiveIterator
+{
+    private $iterator;
+    private $callback;
+
+    public function __construct(\Iterator $iterator, $callback)
+    {
+        $this->iterator = $iterator;
+        $this->callback = $callback;
+        parent::__construct($iterator);
+    }
+
+    public function accept()
+    {
+        return call_user_func($this->callback, $this->current(), $this->key(), $this->iterator);
+    }
+
+    public function hasChildren()
+    {
+        return $this->iterator->hasChildren();
+    }
+
+    public function getChildren()
+    {
+        return new static($this->iterator->getChildren(), $this->callback);
+    }
+}
diff --git a/src/Symfony/Component/Routing/Tests/Loader/AnnotationDirectoryLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/AnnotationDirectoryLoaderTest.php
@@ -40,6 +40,22 @@ public function testLoad()
         $this->loader->load(__DIR__.'/../Fixtures/AnnotatedClasses');
     }
 
+    public function testLoadIgnoresHiddenDirectories()
+    {
+        $this->expectAnnotationsToBeReadFrom(array(
+            'Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BarClass',
+            'Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\FooClass',
+        ));
+
+        $this->reader
+            ->expects($this->any())
+            ->method('getMethodAnnotations')
+            ->will($this->returnValue(array()))
+        ;
+
+        $this->loader->load(__DIR__.'/../Fixtures/AnnotatedClasses');
+    }
+
     public function testSupports()
     {
         $fixturesDir = __DIR__.'/../Fixtures';
@@ -50,4 +66,13 @@ public function testSupports()
         $this->assertTrue($this->loader->supports($fixturesDir, 'annotation'), '->supports() checks the resource type if specified');
         $this->assertFalse($this->loader->supports($fixturesDir, 'foo'), '->supports() checks the resource type if specified');
     }
+
+    private function expectAnnotationsToBeReadFrom(array $classes)
+    {
+        $this->reader->expects($this->exactly(count($classes)))
+            ->method('getClassAnnotation')
+            ->with($this->callback(function (\ReflectionClass $class) use ($classes) {
+                return in_array($class->getName(), $classes);
+            }));
+    }
 }
