Add Resource Route Collection Factory

loic425 · loic425 · commit 44087559e0a8 · 2025-03-03T09:16:54.000+01:00
diff --git a/psalm.xml b/psalm.xml
@@ -46,11 +46,20 @@
         <DeprecatedClass>
             <errorLevel type="info">
                 <referencedClass name="Doctrine\ORM\Event\LifecycleEventArgs" /> <!-- deprecated in doctrine/orm 2.14 -->
+            </errorLevel>
+            <errorLevel type="suppress">
                 <referencedClass name="Sylius\Component\Resource\Exception\VariantWithNoOptionsValuesException" />
                 <referencedClass name="Sylius\Resource\Exception\VariantWithNoOptionsValuesException" />
+                <referencedClass name="Sylius\Resource\Symfony\Routing\Factory\AttributesOperationRouteFactory" />
             </errorLevel>
         </DeprecatedClass>
 
+        <DeprecatedInterface>
+            <errorLevel type="suppress">
+                <referencedClass name="Sylius\Resource\Symfony\Routing\Factory\AttributesOperationRouteFactoryInterface" />
+            </errorLevel>
+        </DeprecatedInterface>
+
         <DeprecatedMethod>
             <errorLevel type="suppress">
                 <referencedMethod name="Symfony\Component\EventDispatcher\Event::isPropagationStopped" />
diff --git a/src/Bundle/Resources/config/services/routing.xml b/src/Bundle/Resources/config/services/routing.xml
@@ -12,6 +12,10 @@
 -->
 
 <container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <imports>
+        <import resource="routing/**/**.xml" />
+    </imports>
+
     <services>
         <defaults public="true" />
 
@@ -99,10 +103,14 @@
         <service id="sylius.routing.factory.route_attributes" class="Sylius\Bundle\ResourceBundle\Routing\RouteAttributesFactory" public="false" />
         <service id="Sylius\Bundle\ResourceBundle\Routing\RouteAttributesFactoryInterface" alias="sylius.routing.factory.route_attributes" />
 
-        <service id="sylius.routing.factory.attributes_operation_route" class="Sylius\Resource\Symfony\Routing\Factory\AttributesOperationRouteFactory" public="false">
+        <service id="sylius.routing.factory.attributes_operation_route"
+                 class="Sylius\Resource\Symfony\Routing\Factory\AttributesOperationRouteFactory"
+                 public="false"
+        >
             <argument type="service" id="sylius.resource_registry" />
             <argument type="service" id="sylius.routing.factory.operation_route" />
             <argument type="service" id="sylius.resource_metadata_collection.factory.attributes" />
+            <deprecated package="sylius/resource-bundle" version="1.13">The "%service_id%" service is deprecated since sylius/resource-bundle 1.13 and will be removed in sylius/resource-bundle 2.0. Use sylius.routing.resource.route_collection_factory instead.</deprecated>
         </service>
         <service id="Sylius\Resource\Symfony\Routing\Factory\AttributesOperationRouteFactoryInterface" alias="sylius.routing.factory.attributes_operation_route" />
 
diff --git a/src/Bundle/Resources/config/services/routing/loader.xml b/src/Bundle/Resources/config/services/routing/loader.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+ This file is part of the Sylius package.
+
+ (c) Sylius Sp. z o.o.
+
+ For the full copyright and license information, please view the LICENSE
+ file that was distributed with this source code.
+
+-->
+
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service id="sylius.symfony.routing.loader.resource" class="Sylius\Resource\Symfony\Routing\Loader\ResourceLoader">
+            <argument type="service" id="sylius.metadata.resource_class_list.factory" />
+            <argument type="service" id="sylius.routing.resource.route_collection_factory" />
+            <tag name="routing.route_loader" />
+        </service>
+        <service id="Sylius\Resource\Symfony\Routing\Loader\ResourceLoader" alias="sylius.symfony.routing.loader.resource" />
+    </services>
+</container>
diff --git a/src/Bundle/Resources/config/services/routing/resource.xml b/src/Bundle/Resources/config/services/routing/resource.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+ This file is part of the Sylius package.
+
+ (c) Sylius Sp. z o.o.
+
+ For the full copyright and license information, please view the LICENSE
+ file that was distributed with this source code.
+
+-->
+
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service id="sylius.routing.resource.route_collection_factory" class="Sylius\Resource\Symfony\Routing\Factory\Resource\ResourceRouteCollectionFactory">
+            <argument type="service" id="sylius.routing.factory.operation_route" />
+            <argument type="service" id="sylius.resource_metadata_collection.factory.attributes" />
+            <argument type="service" id="sylius.resource_registry" />
+        </service>
+        <service id="Sylius\Resource\Symfony\Routing\Factory\Resource\ResourceRouteCollectionFactoryInterface" alias="sylius.routing.resource.route_collection_factory" />
+    </services>
+</container>
diff --git a/src/Component/composer.json b/src/Component/composer.json
@@ -34,6 +34,7 @@
         "pagerfanta/core": "^3.7 || ^4.0",
         "symfony/event-dispatcher": "^6.4 || ^7.1",
         "symfony/form": "^6.4 || ^7.1",
+        "symfony/framework-bundle": "^6.4 || ^7.1",
         "symfony/http-foundation": "^6.4 || ^7.1",
         "symfony/http-kernel": "^6.4 || ^7.1",
         "symfony/property-access": "^6.4 || ^7.1",
diff --git a/src/Component/src/Metadata/Resource/Factory/AttributesResourceClassListFactory.php b/src/Component/src/Metadata/Resource/Factory/AttributesResourceClassListFactory.php
@@ -38,7 +38,6 @@ public function __construct(
      */
     public function create(): ResourceClassList
     {
-        /** @var class-string[] $classes */
         $classes = [];
 
         if ($this->decorated) {
diff --git a/src/Component/src/Symfony/Routing/Factory/AttributesOperationRouteFactory.php b/src/Component/src/Symfony/Routing/Factory/AttributesOperationRouteFactory.php
@@ -19,10 +19,14 @@
 use Sylius\Resource\Metadata\RegistryInterface;
 use Sylius\Resource\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use Sylius\Resource\Metadata\ResourceMetadata;
+use Sylius\Resource\Symfony\Routing\Factory\Resource\ResourceRouteCollectionFactory;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
 use Webmozart\Assert\Assert;
 
+/**
+ * @deprecated use ResourceRouteCollectionFactory instead
+ */
 final class AttributesOperationRouteFactory implements AttributesOperationRouteFactoryInterface
 {
     public function __construct(
diff --git a/src/Component/src/Symfony/Routing/Factory/AttributesOperationRouteFactoryInterface.php b/src/Component/src/Symfony/Routing/Factory/AttributesOperationRouteFactoryInterface.php
@@ -13,8 +13,14 @@
 
 namespace Sylius\Resource\Symfony\Routing\Factory;
 
+use Sylius\Resource\Symfony\Routing\Factory\Resource\ResourceRouteCollectionFactoryInterface;
 use Symfony\Component\Routing\RouteCollection;
 
+trigger_deprecation('sylius/resource', '1.13', '"%s" is deprecated, use "%s" instead.', AttributesOperationRouteFactoryInterface::class, ResourceRouteCollectionFactoryInterface::class);
+
+/**
+ * @deprecated
+ */
 interface AttributesOperationRouteFactoryInterface
 {
     /** @psalm-param class-string $className */
diff --git a/src/Component/src/Symfony/Routing/Factory/Resource/ResourceRouteCollectionFactory.php b/src/Component/src/Symfony/Routing/Factory/Resource/ResourceRouteCollectionFactory.php
@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Symfony\Routing\Factory\Resource;
+
+use Sylius\Resource\Metadata\HttpOperation;
+use Sylius\Resource\Metadata\MetadataInterface;
+use Sylius\Resource\Metadata\Operations;
+use Sylius\Resource\Metadata\RegistryInterface;
+use Sylius\Resource\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use Sylius\Resource\Metadata\ResourceMetadata;
+use Sylius\Resource\Symfony\Routing\Factory\OperationRouteFactoryInterface;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+use Webmozart\Assert\Assert;
+
+/**
+ * @experimental
+ */
+final class ResourceRouteCollectionFactory implements ResourceRouteCollectionFactoryInterface
+{
+    public function __construct(
+        private OperationRouteFactoryInterface $operationRouteFactory,
+        private ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory,
+        private RegistryInterface $resourceRegistry,
+    ) {
+    }
+
+    public function createRouteCollectionForClass(string $className): RouteCollection
+    {
+        $routeCollection = new RouteCollection();
+        $resourceMetadata = $this->resourceMetadataFactory->create($className);
+
+        /** @var ResourceMetadata $resource */
+        foreach ($resourceMetadata->getIterator() as $resource) {
+            $this->createRoutesForResource($routeCollection, $resource);
+        }
+
+        return $routeCollection;
+    }
+
+    private function createRoutesForResource(RouteCollection $routeCollection, ResourceMetadata $resource): void
+    {
+        foreach ($resource->getOperations() ?? new Operations() as $operation) {
+            if (!$operation instanceof HttpOperation) {
+                continue;
+            }
+
+            $this->addRouteForOperation($routeCollection, $resource, $operation);
+        }
+    }
+
+    private function addRouteForOperation(RouteCollection $routeCollection, ResourceMetadata $resource, HttpOperation $operation): void
+    {
+        $metadata = $this->resourceRegistry->get($resource->getAlias() ?? '');
+        $routeName = $operation->getRouteName();
+
+        Assert::notNull($routeName, sprintf('Operation %s has no route name. Please define one.', $operation::class));
+
+        $route = $this->createRoute($metadata, $resource, $operation);
+        $routeCollection->add($routeName, $route);
+    }
+
+    private function createRoute(MetadataInterface $metadata, ResourceMetadata $resource, HttpOperation $operation): Route
+    {
+        return $this->operationRouteFactory->create($metadata, $resource, $operation);
+    }
+}
diff --git a/src/Component/src/Symfony/Routing/Factory/Resource/ResourceRouteCollectionFactoryInterface.php b/src/Component/src/Symfony/Routing/Factory/Resource/ResourceRouteCollectionFactoryInterface.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Symfony\Routing\Factory\Resource;
+
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * @experimental
+ */
+interface ResourceRouteCollectionFactoryInterface
+{
+    /** @psalm-param class-string $className */
+    public function createRouteCollectionForClass(string $className): RouteCollection;
+}
diff --git a/src/Component/src/Symfony/Routing/Loader/ResourceLoader.php b/src/Component/src/Symfony/Routing/Loader/ResourceLoader.php
@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Symfony\Routing\Loader;
+
+use Sylius\Resource\Metadata\Resource\Factory\ResourceClassListFactoryInterface;
+use Sylius\Resource\Symfony\Routing\Factory\Resource\ResourceRouteCollectionFactoryInterface;
+use Symfony\Bundle\FrameworkBundle\Routing\RouteLoaderInterface;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * @experimental
+ */
+final class ResourceLoader implements RouteLoaderInterface
+{
+    public function __construct(
+        private readonly ResourceClassListFactoryInterface $resourceClassListCollectionFactory,
+        private readonly ResourceRouteCollectionFactoryInterface $resourceRouteCollectionFactory,
+    ) {
+    }
+
+    public function __invoke(): RouteCollection
+    {
+        $routeCollection = new RouteCollection();
+
+        $resourceClasses = $this->resourceClassListCollectionFactory->create();
+
+        /**
+         * @var class-string $classes
+         */
+        foreach ($resourceClasses as $classes) {
+            $routeCollection->addCollection($this->resourceRouteCollectionFactory->createRouteCollectionForClass($classes));
+        }
+
+        return $routeCollection;
+    }
+}
diff --git a/src/Component/tests/Metadata/Resource/Factory/AttributesResourceClassListFactoryTest.php b/src/Component/tests/Metadata/Resource/Factory/AttributesResourceClassListFactoryTest.php
@@ -20,15 +20,15 @@
 
 final class AttributesResourceClassListFactoryTest extends TestCase
 {
-    public function testCreateAResourceClassListForResourcesWithAsResourceAttribute(): void
+    public function testCreateWithInstanceOfApiResource(): void
     {
-        $attributesResourceClassListFactory = new AttributesResourceClassListFactory(
+        $attributesResourceNameCollectionFactory = new AttributesResourceClassListFactory(
             mapping: ['paths' => [dirname(__DIR__, 3) . '/Dummy']],
         );
 
-        $list = $attributesResourceClassListFactory->create();
+        $collection = $attributesResourceNameCollectionFactory->create();
 
-        $this->assertContains(DummyResource::class, $list->getIterator());
-        $this->assertNotContains(PullRequest::class, $list->getIterator());
+        $this->assertContains(DummyResource::class, $collection->getIterator());
+        $this->assertNotContains(PullRequest::class, $collection->getIterator());
     }
 }
diff --git a/src/Component/tests/Symfony/Routing/Factory/Resource/ResourceRouteCollectionFactoryTest.php b/src/Component/tests/Symfony/Routing/Factory/Resource/ResourceRouteCollectionFactoryTest.php
@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Tests\Symfony\Routing\Factory\Resource;
+
+use PHPUnit\Framework\TestCase;
+use Sylius\Component\Resource\Tests\Dummy\DummyResourceWithOperations;
+use Sylius\Resource\Metadata\MetadataInterface;
+use Sylius\Resource\Metadata\RegistryInterface;
+use Sylius\Resource\Metadata\Resource\Factory\AttributesResourceMetadataCollectionFactory;
+use Sylius\Resource\Symfony\Routing\Factory\OperationRouteFactory;
+use Sylius\Resource\Symfony\Routing\Factory\Resource\ResourceRouteCollectionFactory;
+use Sylius\Resource\Symfony\Routing\Factory\RouteName\OperationRouteNameFactory;
+use Sylius\Resource\Symfony\Routing\Factory\RoutePath\OperationRoutePathFactoryInterface;
+
+final class ResourceRouteCollectionFactoryTest extends TestCase
+{
+    private ResourceRouteCollectionFactory $factory;
+
+    private RegistryInterface $resourceRegistry;
+
+    private OperationRoutePathFactoryInterface $routePathFactory;
+
+    protected function setUp(): void
+    {
+        $this->resourceRegistry = $this->createMock(RegistryInterface::class);
+        $this->routePathFactory = $this->createMock(OperationRoutePathFactoryInterface::class);
+
+        $this->factory = new ResourceRouteCollectionFactory(
+            new OperationRouteFactory($this->routePathFactory),
+            new AttributesResourceMetadataCollectionFactory(
+                $this->resourceRegistry,
+                new OperationRouteNameFactory(),
+            ),
+            $this->resourceRegistry,
+        );
+    }
+
+    public function testItCreatesRoutesWithOperations(): void
+    {
+        $metadata = $this->createMock(MetadataInterface::class);
+        $metadata->method('getServiceId')->with('repository')->willReturn('app.repository.dummy');
+        $metadata->method('getClass')->willReturnMap([
+            ['form', 'App\Form'],
+            ['model', 'App\Dummy'],
+        ]);
+        $metadata->method('getApplicationName')->willReturn('app');
+        $metadata->method('getName')->willReturn('dummy');
+        $metadata->method('getPluralName')->willReturn('dummies');
+
+        $this->resourceRegistry->method('get')->with('app.dummy')->willReturn($metadata);
+
+        $routeCollection = $this->factory->createRouteCollectionForClass(DummyResourceWithOperations::class);
+
+        $this->assertEquals(4, $routeCollection->count());
+        $this->assertNotNull($routeCollection->get('app_dummy_index'), 'Route "app_dummy_index" not found but it should.');
+        $this->assertNotNull($routeCollection->get('app_dummy_create'), 'Route "app_dummy_create" not found but it should.');
+        $this->assertNotNull($routeCollection->get('app_dummy_update'), 'Route "app_dummy_update" not found but it should.');
+        $this->assertNotNull($routeCollection->get('app_dummy_show'), 'Route "app_dummy_show" not found but it should.');
+    }
+}
diff --git a/src/Component/tests/Symfony/Routing/Loader/ResourceLoaderTest.php b/src/Component/tests/Symfony/Routing/Loader/ResourceLoaderTest.php
diff --git a/tests/Application/config/routes/sylius_resource.yaml b/tests/Application/config/routes/sylius_resource.yaml

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,6 @@ public function __construct(`
`38`	`38`	`*/`
`39`	`39`	`public function create(): ResourceClassList`
`40`	`40`	`{`
`41`		`- /** @var class-string[] $classes */`
`42`	`41`	`$classes = [];`
`43`	`42`
`44`	`43`	`if ($this->decorated) {`