[Routing] PSR-4 directory loader

derrabus · derrabus · commit 3f84bc319e0b · 2022-10-19T19:07:31.000+02:00
diff --git a/Loader/Psr4DirectoryLoader.php b/Loader/Psr4DirectoryLoader.php
@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Loader;
+
+use Symfony\Component\Config\FileLocatorInterface;
+use Symfony\Component\Config\Loader\FileLoader;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * A loader that discovers controller classes in a directory that follows PSR-4.
+ *
+ * @author Alexander M. Turek <me@derrabus.de>
+ */
+final class Psr4DirectoryLoader extends FileLoader
+{
+    public function __construct(FileLocatorInterface $locator)
+    {
+        // PSR-4 directory loader has no env-aware logic, so we drop the $env constructor parameter.
+        parent::__construct($locator);
+    }
+
+    public function load(mixed $resource, string $type = null): ?RouteCollection
+    {
+        $path = $this->locator->locate($resource);
+        if (!is_dir($path)) {
+            return new RouteCollection();
+        }
+
+        return $this->loadFromDirectory($path, trim(substr($type, 10), ' \\'));
+    }
+
+    public function supports(mixed $resource, string $type = null): bool
+    {
+        return \is_string($resource) && null !== $type && str_starts_with($type, 'attribute@');
+    }
+
+    private function loadFromDirectory(string $directory, string $psr4Prefix): RouteCollection
+    {
+        $collection = new RouteCollection();
+
+        /** @var \SplFileInfo $file */
+        foreach (new \FilesystemIterator($directory) as $file) {
+            if ($file->isDir()) {
+                $collection->addCollection($this->loadFromDirectory($file->getPathname(), $psr4Prefix.'\\'.$file->getFilename()));
+
+                continue;
+            }
+            if ('php' !== $file->getExtension() || !class_exists($className = $psr4Prefix.'\\'.$file->getBasename('.php'))) {
+                continue;
+            }
+
+            $collection->addCollection($this->import($className, 'attribute'));
+        }
+
+        return $collection;
+    }
+}
diff --git a/Tests/Fixtures/Psr4Controllers/MyController.php b/Tests/Fixtures/Psr4Controllers/MyController.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+
+#[Route('/my/route', name: 'my_route')]
+final class MyController
+{
+    public function __invoke(): Response
+    {
+        return new Response(status: Response::HTTP_NO_CONTENT);
+    }
+}
diff --git a/Tests/Fixtures/Psr4Controllers/MyUnannotatedController.php b/Tests/Fixtures/Psr4Controllers/MyUnannotatedController.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers;
+
+use Symfony\Component\HttpFoundation\Response;
+
+final class MyUnannotatedController
+{
+    public function myAction(): Response
+    {
+        return new Response(status: Response::HTTP_NO_CONTENT);
+    }
+}
diff --git a/Tests/Fixtures/Psr4Controllers/SubNamespace/EvenDeeperNamespace/MyOtherController.php b/Tests/Fixtures/Psr4Controllers/SubNamespace/EvenDeeperNamespace/MyOtherController.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\SubNamespace\EvenDeeperNamespace;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+
+#[Route('/my/other/route', name: 'my_other_controller_', methods: ['PUT'])]
+final class MyOtherController
+{
+    #[Route('/first', name: 'one')]
+    public function firstAction(): Response
+    {
+        return new Response(status: Response::HTTP_NO_CONTENT);
+    }
+
+    #[Route('/second', name: 'two')]
+    public function secondAction(): Response
+    {
+        return new Response(status: Response::HTTP_NO_CONTENT);
+    }
+}
diff --git a/Tests/Fixtures/Psr4Controllers/SubNamespace/IrrelevantInterface.php b/Tests/Fixtures/Psr4Controllers/SubNamespace/IrrelevantInterface.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\SubNamespace;
+
+interface IrrelevantInterface
+{
+}
diff --git a/Tests/Fixtures/Psr4Controllers/SubNamespace/MyControllerWithATrait.php b/Tests/Fixtures/Psr4Controllers/SubNamespace/MyControllerWithATrait.php
@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\SubNamespace;
+
+use Symfony\Component\Routing\Annotation\Route;
+
+#[Route('/my/controller/with/a/trait', name: 'my_controller_')]
+final class MyControllerWithATrait implements IrrelevantInterface
+{
+    use SomeSharedImplementation;
+}
diff --git a/Tests/Fixtures/Psr4Controllers/SubNamespace/SomeSharedImplementation.php b/Tests/Fixtures/Psr4Controllers/SubNamespace/SomeSharedImplementation.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\SubNamespace;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+
+trait SomeSharedImplementation
+{
+    #[Route('/a/route/from/a/trait', name: 'with_a_trait')]
+    public function someAction(): Response
+    {
+        return new Response(status: Response::HTTP_NO_CONTENT);
+    }
+}
diff --git a/Tests/Fixtures/class-attributes.xml b/Tests/Fixtures/class-attributes.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        https://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <import resource="Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\MyController" prefix="/my-prefix"
+            type="attribute" />
+</routes>
diff --git a/Tests/Fixtures/class-attributes.yaml b/Tests/Fixtures/class-attributes.yaml
@@ -0,0 +1,4 @@
+my_controllers:
+    resource: Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\MyController
+    type: attribute
+    prefix: /my-prefix
diff --git a/Tests/Fixtures/psr4-attributes.xml b/Tests/Fixtures/psr4-attributes.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        https://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <import resource="./Psr4Controllers" prefix="/my-prefix"
+            type="attribute@Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers" />
+</routes>
diff --git a/Tests/Fixtures/psr4-attributes.yaml b/Tests/Fixtures/psr4-attributes.yaml
@@ -0,0 +1,4 @@
+my_controllers:
+    resource: ./Psr4Controllers
+    type: attribute@Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers
+    prefix: /my-prefix
diff --git a/Tests/Loader/Psr4DirectoryLoaderTest.php b/Tests/Loader/Psr4DirectoryLoaderTest.php
@@ -0,0 +1,107 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Tests\Loader;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Config\Loader\DelegatingLoader;
+use Symfony\Component\Config\Loader\LoaderResolver;
+use Symfony\Component\Routing\Loader\AnnotationClassLoader;
+use Symfony\Component\Routing\Loader\Psr4DirectoryLoader;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+use Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\MyController;
+use Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\SubNamespace\EvenDeeperNamespace\MyOtherController;
+use Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\SubNamespace\MyControllerWithATrait;
+
+class Psr4DirectoryLoaderTest extends TestCase
+{
+    public function testTopLevelController()
+    {
+        $route = $this->loadPsr4Controllers()->get('my_route');
+
+        $this->assertSame('/my/route', $route->getPath());
+        $this->assertSame(MyController::class.'::__invoke', $route->getDefault('_controller'));
+    }
+
+    public function testNestedController()
+    {
+        $collection = $this->loadPsr4Controllers();
+
+        $route = $collection->get('my_other_controller_one');
+        $this->assertSame('/my/other/route/first', $route->getPath());
+        $this->assertSame(['PUT'], $route->getMethods());
+        $this->assertSame(MyOtherController::class.'::firstAction', $route->getDefault('_controller'));
+
+        $route = $collection->get('my_other_controller_two');
+        $this->assertSame('/my/other/route/second', $route->getPath());
+        $this->assertSame(['PUT'], $route->getMethods());
+        $this->assertSame(MyOtherController::class.'::secondAction', $route->getDefault('_controller'));
+    }
+
+    public function testTraitController()
+    {
+        $route = $this->loadPsr4Controllers()->get('my_controller_with_a_trait');
+
+        $this->assertSame('/my/controller/with/a/trait/a/route/from/a/trait', $route->getPath());
+        $this->assertSame(MyControllerWithATrait::class.'::someAction', $route->getDefault('_controller'));
+    }
+
+    /**
+     * @dataProvider provideResourceTypesThatNeedTrimming
+     */
+    public function testPsr4NamespaceTrim(string $resourceType)
+    {
+        $route = $this->getLoader()
+            ->load('Psr4Controllers', $resourceType)
+            ->get('my_route');
+
+        $this->assertSame('/my/route', $route->getPath());
+        $this->assertSame(MyController::class.'::__invoke', $route->getDefault('_controller'));
+    }
+
+    public function provideResourceTypesThatNeedTrimming(): array
+    {
+        return [
+            ['attribute@ Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers'],
+            ['attribute@\\Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers'],
+            ['attribute@Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\\'],
+            ['attribute@\\Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\\'],
+            ['attribute@   \\Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers'],
+        ];
+    }
+
+    private function loadPsr4Controllers(): RouteCollection
+    {
+        return $this->getLoader()->load(
+            'Psr4Controllers',
+            'attribute@Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers'
+        );
+    }
+
+    private function getLoader(): DelegatingLoader
+    {
+        $locator = new FileLocator(\dirname(__DIR__).'/Fixtures');
+
+        return new DelegatingLoader(
+            new LoaderResolver([
+                new Psr4DirectoryLoader($locator),
+                new class() extends AnnotationClassLoader {
+                    protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                    {
+                        $route->setDefault('_controller', $class->getName().'::'.$method->getName());
+                    }
+                },
+            ])
+        );
+    }
+}
diff --git a/Tests/Loader/XmlFileLoaderTest.php b/Tests/Loader/XmlFileLoaderTest.php
@@ -13,11 +13,15 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Config\Loader\LoaderResolver;
 use Symfony\Component\Config\Resource\FileResource;
+use Symfony\Component\Routing\Loader\AnnotationClassLoader;
+use Symfony\Component\Routing\Loader\Psr4DirectoryLoader;
 use Symfony\Component\Routing\Loader\XmlFileLoader;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
 use Symfony\Component\Routing\Tests\Fixtures\CustomXmlFileLoader;
+use Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\MyController;
 
 class XmlFileLoaderTest extends TestCase
 {
@@ -592,4 +596,40 @@ public function testImportingAliases()
 
         $this->assertEquals($expectedRoutes('xml'), $routes);
     }
+
+    public function testImportAttributesWithPsr4Prefix()
+    {
+        $locator = new FileLocator(\dirname(__DIR__).'/Fixtures');
+        new LoaderResolver([
+            $loader = new XmlFileLoader($locator),
+            new Psr4DirectoryLoader($locator),
+            new class() extends AnnotationClassLoader {
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                {
+                    $route->setDefault('_controller', $class->getName().'::'.$method->getName());
+                }
+            },
+        ]);
+
+        $route = $loader->load('psr4-attributes.xml')->get('my_route');
+        $this->assertSame('/my-prefix/my/route', $route->getPath());
+        $this->assertSame(MyController::class.'::__invoke', $route->getDefault('_controller'));
+    }
+
+    public function testImportAttributesFromClass()
+    {
+        new LoaderResolver([
+            $loader = new XmlFileLoader(new FileLocator(\dirname(__DIR__).'/Fixtures')),
+            new class() extends AnnotationClassLoader {
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                {
+                    $route->setDefault('_controller', $class->getName().'::'.$method->getName());
+                }
+            },
+        ]);
+
+        $route = $loader->load('class-attributes.xml')->get('my_route');
+        $this->assertSame('/my-prefix/my/route', $route->getPath());
+        $this->assertSame(MyController::class.'::__invoke', $route->getDefault('_controller'));
+    }
 }
diff --git a/Tests/Loader/YamlFileLoaderTest.php b/Tests/Loader/YamlFileLoaderTest.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<?php
++
 +namespace Symfony\Component\Routing\Tests\Fixtures\Psr4Controllers\SubNamespace;
++
 +interface IrrelevantInterface
 +{
 +}