Handle custom operations

Author: loic425

psalm.xml

@@ -120,6 +120,7 @@
         <InvalidNullableReturnType>
             <errorLevel type="suppress">
                 <file name="src/Component/src/Metadata/Extractor/PhpFileMetadataExtractor.php" />
+                <file name="src/Component/src/Metadata/Operation/CustomPhpFileOperationUpdater.php" />
             </errorLevel>
         </InvalidNullableReturnType>
 
@@ -188,6 +189,7 @@
         <NullableReturnStatement>
             <errorLevel type="suppress">
                 <file name="src/Component/src/Metadata/Extractor/PhpFileMetadataExtractor.php" />
+                <file name="src/Component/src/Metadata/Operation/CustomPhpFileOperationUpdater.php" />
             </errorLevel>
         </NullableReturnStatement>
 
@@ -336,6 +338,7 @@
         <UnresolvableInclude>
             <errorLevel type="suppress">
                 <file name="src/Component/src/Metadata/Extractor/PhpFileMetadataExtractor.php" />
+                <file name="src/Component/src/Metadata/Operation/CustomPhpFileOperationUpdater.php" />
             </errorLevel>
         </UnresolvableInclude>
 

src/Bundle/Resources/config/services/metadata/resource_metadata_collection.xml

@@ -22,6 +22,11 @@
             <argument type="service" id="service_container" />
         </service>
 
+        <service id="sylius.operation.metadata_updater.custom_php_file" class="Sylius\Resource\Metadata\Operation\CustomPhpFileOperationUpdater">
+            <argument>%sylius.resource.mapping%</argument>
+            <argument type="service" id="service_container" />
+        </service>
+
         <service id="sylius.resource_metadata_collection.factory" alias="sylius.resource_metadata_collection.factory.php_file" />
         <service id="Sylius\Resource\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface" alias="sylius.resource_metadata_collection.factory.php_file" />
 
@@ -41,6 +46,15 @@
             <argument type="service" id=".inner" />
         </service>
 
+        <service id="sylius.resource_metadata_collection.factory.custom"
+                 class="Sylius\Resource\Metadata\Resource\Factory\CustomResourceMetadataCollectionFactory"
+                 decorates="sylius.resource_metadata_collection.factory"
+                 decoration-priority="350"
+        >
+            <argument type="service" id="sylius.operation.metadata_updater.custom_php_file" />
+            <argument type="service" id=".inner" />
+        </service>
+
         <service id="sylius.resource_metadata_collection.factory.state_machine"
                  class="Sylius\Resource\Metadata\Resource\Factory\StateMachineResourceMetadataCollectionFactory"
                  decorates="sylius.resource_metadata_collection.factory.attributes"

src/Component/src/Metadata/Operation/CustomPhpFileOperationUpdater.php

@@ -0,0 +1,94 @@
+<?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\Metadata\Operation;
+
+use Sylius\Resource\Metadata\Operation;
+use Symfony\Component\Finder\Finder;
+
+final class CustomPhpFileOperationUpdater implements OperationUpdaterInterface
+{
+    public function __construct(
+        private readonly array $resourceMapping,
+    ) {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function update(Operation $operation): Operation
+    {
+        foreach ($this->getResourceFilePaths() as $filePath) {
+            if (!is_readable($filePath)) {
+                continue;
+            }
+
+            $resource = $this->getPHPFileClosure($filePath)();
+
+            if (!$resource instanceof \Closure) {
+                continue;
+            }
+
+            $resourceReflection = new \ReflectionFunction($resource);
+
+            if (1 !== $resourceReflection->getNumberOfParameters()) {
+                continue;
+            }
+
+            $firstParameterType = ($resourceReflection->getParameters()[0] ?? null)?->getType();
+
+            if (!$firstParameterType instanceof \ReflectionNamedType) {
+                continue;
+            }
+
+            // Check if the closure parameter is an operation
+            if (!is_a($firstParameterType->getName(), Operation::class, true)) {
+                continue;
+            }
+
+            $operation = $resource($operation);
+        }
+
+        return $operation;
+    }
+
+    private function getResourceFilePaths(): iterable
+    {
+        foreach ($this->createFinder() as $file) {
+            yield $file->getPathname();
+        }
+    }
+
+    private function createFinder(): Finder
+    {
+        $finder = (new Finder())->files();
+
+        foreach ($this->resourceMapping['imports'] ?? [] as $path) {
+            $finder->in($path);
+        }
+
+        return $finder->files();
+    }
+
+    /**
+     * Scope isolated include.
+     *
+     * Prevents access to $this/self from included files.
+     */
+    private function getPHPFileClosure(string $filePath): \Closure
+    {
+        return \Closure::bind(function () use ($filePath): mixed {
+            return require $filePath;
+        }, null, null);
+    }
+}

src/Component/src/Metadata/Operation/OperationUpdaterInterface.php

@@ -0,0 +1,21 @@
+<?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\Metadata\Operation;
+
+use Sylius\Resource\Metadata\Operation;
+
+interface OperationUpdaterInterface
+{
+    public function update(Operation $operation): Operation;
+}

src/Component/src/Metadata/Resource/Factory/CustomResourceMetadataCollectionFactory.php

@@ -0,0 +1,58 @@
+<?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\Metadata\Resource\Factory;
+
+use Sylius\Resource\Metadata\Operation;
+use Sylius\Resource\Metadata\Operation\OperationUpdaterInterface;
+use Sylius\Resource\Metadata\Operations;
+use Sylius\Resource\Metadata\Resource\ResourceMetadataCollection;
+use Sylius\Resource\Metadata\ResourceMetadata;
+use Webmozart\Assert\Assert;
+
+final class CustomResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
+{
+    use OperationDefaultsTrait;
+
+    public function __construct(
+        private readonly OperationUpdaterInterface $metadataUpdater,
+        private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
+    ) {
+    }
+
+    public function create(string $resourceClass): ResourceMetadataCollection
+    {
+        $resourceMetadataCollection = new ResourceMetadataCollection();
+        if ($this->decorated) {
+            $resourceMetadataCollection = $this->decorated->create($resourceClass);
+        }
+
+        $newMetadataCollection = new ResourceMetadataCollection();
+
+        /** @var ResourceMetadata $resourceMetadata */
+        foreach ($resourceMetadataCollection as $resourceMetadata) {
+            $operations = $resourceMetadata->getOperations() ?? new Operations();
+
+            /** @var Operation $operation */
+            foreach ($operations as $operation) {
+                $operationName = $operation->getName();
+                Assert::notNull($operationName);
+                $operations->add($operationName, $this->metadataUpdater->update($operation));
+            }
+
+            $newMetadataCollection[] = $resourceMetadata->withOperations($operations);
+        }
+
+        return $newMetadataCollection;
+    }
+}

src/Component/src/Symfony/Routing/Factory/Resource/ResourceRouteCollectionFactory.php

@@ -39,10 +39,11 @@ public function __construct(
     public function createRouteCollectionForClass(string $className): RouteCollection
     {
         $routeCollection = new RouteCollection();
-        $resourceMetadata = $this->resourceMetadataFactory->create($className);
+
+        $resourceMetadataCollection = $this->resourceMetadataFactory->create($className);
 
         /** @var ResourceMetadata $resource */
-        foreach ($resourceMetadata->getIterator() as $resource) {
+        foreach ($resourceMetadataCollection->getIterator() as $resource) {
             $this->createRoutesForResource($routeCollection, $resource);
         }
 

tests/Application/config/sylius/resources/custom_speaker_create.php

@@ -0,0 +1,26 @@
+<?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);
+
+use Sylius\Resource\Metadata\Create;
+use Sylius\Resource\Metadata\Operation;
+
+return static function (Operation $operation): Operation {
+    if (
+        !$operation instanceof Create ||
+        'app_admin_speaker_create' !== $operation->getName()
+    ) {
+        return $operation;
+    }
+
+    return $operation->withPath('speakers/register');
+};

tests/Application/config/sylius/resources/speaker_update.php

@@ -0,0 +1,27 @@
+<?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);
+
+use App\Conference\Entity\Speaker;
+use Sylius\Resource\Metadata\Operations;
+use Sylius\Resource\Metadata\ResourceMetadata;
+use Sylius\Resource\Metadata\Update;
+
+return (new ResourceMetadata())
+    ->withRoutePrefix('/admin')
+    ->withClass(Speaker::class)
+    ->withSection('admin')
+    ->withTemplatesDir('crud')
+    ->withOperations(new Operations([
+        new Update(),
+    ]))
+;