Merge pull request #16 from pfilsx/feature/DPC-11

DPC-11 argument resolver
pfilsx · May 30, 2022 · a9d8222 · a9d8222
2 parents b7b5274 + 425040e
commit a9d8222
Show file tree

Hide file tree

Showing 28 changed files with 976 additions and 193 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,6 @@ Requirement
 -----------
 * PHP 7.4+
 * Symfony 4.4+|5.3+|6.0+
-* SensioFrameworkExtraBundle
 
 Installation
 ------------
@@ -38,7 +37,7 @@ You need to add the following lines in your deps :
 ```json
 {
     "require": {
-        "pfilsx/dto-param-converter-bundle": "^1.0"
+        "pfilsx/dto-param-converter-bundle": "^2.0"
     }
 }
 ```
@@ -166,16 +165,16 @@ Or You can configure converter for each action
 
 ```php
 /**
-* @ParamConverter("someDto", options={
-*    DtoParamConverter::OPTION_SERIALIZER_CONTEXT: {},
-*    DtoParamConverter::OPTION_VALIDATOR_GROUPS: {},
-*    DtoParamConverter::OPTION_PRELOAD_ENTITY: true,
-*    DtoParamConverter::OPTION_STRICT_PRELOAD_ENTITY: true,
-*    DtoParamConverter::OPTION_ENTITY_ID_ATTRIBUTE: null,
-*    DtoParamConverter::OPTION_ENTITY_MANAGER: null,
-*    DtoParamConverter::OPTION_ENTITY_MAPPING: {}
-*    DtoParamConverter::OPTION_ENTITY_EXPR: null,
-*    DtoParamConverter::OPTION_VALIDATE: false
+* @DtoResolver("someDto", options={
+*    DtoArgumentResolver::OPTION_SERIALIZER_CONTEXT: {},
+*    DtoArgumentResolver::OPTION_VALIDATOR_GROUPS: {},
+*    DtoArgumentResolver::OPTION_PRELOAD_ENTITY: true,
+*    DtoArgumentResolver::OPTION_STRICT_PRELOAD_ENTITY: true,
+*    DtoArgumentResolver::OPTION_ENTITY_ID_ATTRIBUTE: null,
+*    DtoArgumentResolver::OPTION_ENTITY_MANAGER: null,
+*    DtoArgumentResolver::OPTION_ENTITY_MAPPING: {}
+*    DtoArgumentResolver::OPTION_ENTITY_EXPR: null,
+*    DtoArgumentResolver::OPTION_VALIDATE: false
 * })
 */
 public function someAction(SomeDto $someDto): Response

diff --git a/composer.json b/composer.json
@@ -21,7 +21,6 @@
         "php": "^7.4 || ^8.0",
         "symfony/framework-bundle": "^4.4|^5.3|^6.0",
         "doctrine/annotations": "^1.0",
-        "sensio/framework-extra-bundle": "^5.6|^6.1",
         "symfony/serializer": "^4.4|^5.3|^6.0",
         "symfony/property-access": "^4.4|^5.3|^6.0",
         "symfony/property-info": "^4.4|^5.3|^6.0"
@@ -36,7 +35,8 @@
         "symfony/phpunit-bridge": "^6.0",
         "phpunit/phpunit": "^9.5",
         "symfony/yaml": "^5.3|^6.0",
-        "symfony/browser-kit": "^5.3|^6.0"
+        "symfony/browser-kit": "^5.3|^6.0",
+        "dg/bypass-finals": "^1.3"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="./vendor/autoload.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="./tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
   <php>
     <server name="KERNEL_CLASS" value="Pfilsx\DtoParamConverter\Tests\Fixtures\TestKernel" />
     <server name="KERNEL_DIR" value="tests/Fixtures/" />

diff --git a/src/Annotation/Dto.php b/src/Annotation/Dto.php
@@ -4,13 +4,26 @@
 
 namespace Pfilsx\DtoParamConverter\Annotation;
 
+use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
 use Doctrine\Common\Annotations\Annotation\Target;
 
 /**
  * @Annotation
+ * @NamedArgumentConstructor
  * @Target({"CLASS"})
  */
+#[\Attribute(\Attribute::TARGET_CLASS)]
 final class Dto
 {
-    public ?string $linkedEntity = null;
+    private ?string $linkedEntity;
+
+    public function __construct(?string $linkedEntity = null)
+    {
+        $this->linkedEntity = $linkedEntity;
+    }
+
+    public function getLinkedEntity(): ?string
+    {
+        return $this->linkedEntity;
+    }
 }
diff --git a/src/Annotation/DtoResolver.php b/src/Annotation/DtoResolver.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\DtoParamConverter\Annotation;
+
+use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
+
+/**
+ * @Annotation
+ * @NamedArgumentConstructor
+ */
+#[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_METHOD)]
+final class DtoResolver
+{
+    private array $options;
+
+    public function __construct(array $options = [])
+    {
+        $this->options = $options;
+    }
+
+    public function getOptions(): array
+    {
+        return $this->options;
+    }
+}
diff --git a/src/Contract/DtoMapperInterface.php b/src/Contract/DtoMapperInterface.php
@@ -8,7 +8,15 @@ interface DtoMapperInterface
 {
     public static function getDtoClassName(): string;
 
-    public function mapToDto(object $entity, object $dto): void;
+    /**
+     * @param mixed $entity
+     * @param mixed $dto
+     */
+    public function mapToDto($entity, $dto): void;
 
-    public function mapToEntity(object $dto, object $entity): void;
+    /**
+     * @param mixed $dto
+     * @param mixed $entity
+     */
+    public function mapToEntity($dto, $entity): void;
 }
diff --git a/src/DependencyInjection/Compiler/AddExpressionLanguageProvidersPass.php b/src/DependencyInjection/Compiler/AddExpressionLanguageProvidersPass.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\DtoParamConverter\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+final class AddExpressionLanguageProvidersPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->hasDefinition('pfilsx.dto_converter.expression_language.default')) {
+            $definition = $container->findDefinition('pfilsx.dto_converter.expression_language.default');
+            foreach ($container->findTaggedServiceIds('security.expression_language_provider') as $id => $attributes) {
+                $definition->addMethodCall('registerProvider', [new Reference($id)]);
+            }
+        }
+    }
+}
diff --git a/...ection/Compiler/DtoParamConverterPass.php → ...ction/Compiler/AddMapperFactoriesPass.php b/...ection/Compiler/DtoParamConverterPass.php → ...ction/Compiler/AddMapperFactoriesPass.php
@@ -9,7 +9,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-final class DtoParamConverterPass implements CompilerPassInterface
+final class AddMapperFactoriesPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)
     {

diff --git a/src/DependencyInjection/DtoParamConverterExtension.php b/src/DependencyInjection/DtoParamConverterExtension.php
@@ -6,9 +6,11 @@
 
 use Pfilsx\DtoParamConverter\Contract\DtoMapperInterface;
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Config\Resource\ClassExistenceResource;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 final class DtoParamConverterExtension extends Extension
@@ -17,11 +19,24 @@ public function load(array $configs, ContainerBuilder $container)
     {
         $this->loadConfiguration($configs, $container);
 
+        $definitionsToRemove = [];
+
+        $container->addResource(new ClassExistenceResource(ExpressionLanguage::class));
+        if (class_exists(ExpressionLanguage::class)) {
+            $container->setAlias('pfilsx.dto_converter.expression_language', new Alias('pfilsx.dto_converter.expression_language.default', false));
+        } else {
+            $definitionsToRemove[] = 'pfilsx.dto_converter.expression_language.default';
+        }
+
         $container->registerForAutoconfiguration(DtoMapperInterface::class)
             ->addTag('pfilsx.dto_converter.dto_mapper');
 
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.xml');
+
+        foreach ($definitionsToRemove as $definition) {
+            $container->removeDefinition($definition);
+        }
     }
 
     private function loadConfiguration(array $configs, ContainerBuilder $container)

diff --git a/src/DtoParamConverterBundle.php b/src/DtoParamConverterBundle.php
@@ -4,7 +4,8 @@
 
 namespace Pfilsx\DtoParamConverter;
 
-use Pfilsx\DtoParamConverter\DependencyInjection\Compiler\DtoParamConverterPass;
+use Pfilsx\DtoParamConverter\DependencyInjection\Compiler\AddExpressionLanguageProvidersPass;
+use Pfilsx\DtoParamConverter\DependencyInjection\Compiler\AddMapperFactoriesPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -13,6 +14,7 @@ final class DtoParamConverterBundle extends Bundle
     public function build(ContainerBuilder $container)
     {
         parent::build($container);
-        $container->addCompilerPass(new DtoParamConverterPass());
+        $container->addCompilerPass(new AddMapperFactoriesPass());
+        $container->addCompilerPass(new AddExpressionLanguageProvidersPass());
     }
 }
diff --git a/src/EventSubscriber/ControllerEventSubscriber.php b/src/EventSubscriber/ControllerEventSubscriber.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\DtoParamConverter\EventSubscriber;
+
+use Pfilsx\DtoParamConverter\Provider\RouteMetadataProvider;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+final class ControllerEventSubscriber implements EventSubscriberInterface
+{
+    private RouteMetadataProvider $routeMetadataProvider;
+
+    public function __construct(RouteMetadataProvider $routeMetadataProvider)
+    {
+        $this->routeMetadataProvider = $routeMetadataProvider;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::CONTROLLER => 'onKernelController',
+        ];
+    }
+
+    public function onKernelController(KernelEvent $event): void
+    {
+        $controller = $event->getController();
+
+        if (!\is_array($controller) && method_exists($controller, '__invoke')) {
+            $controller = [$controller, '__invoke'];
+        }
+
+        if (!\is_array($controller)) {
+            return;
+        }
+
+        $route = $event->getRequest()->attributes->get('_route');
+
+        if (empty($route)) {
+            return;
+        }
+
+        $this->routeMetadataProvider->createMetadata($route, $controller);
+    }
+}
diff --git a/src/Provider/DtoMetadataProvider.php b/src/Provider/DtoMetadataProvider.php
@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\DtoParamConverter\Provider;
+
+use Doctrine\Common\Annotations\Reader;
+use Pfilsx\DtoParamConverter\Annotation\Dto;
+use ReflectionClass;
+
+final class DtoMetadataProvider
+{
+    private Reader $reader;
+
+    /**
+     * @var array<string, null|Dto>
+     */
+    private array $localCollection = [];
+
+    public function __construct(Reader $reader)
+    {
+        $this->reader = $reader;
+    }
+
+    public function getDtoMetadata(string $className): ?Dto
+    {
+        if (array_key_exists($className, $this->localCollection)) {
+            return $this->localCollection[$className];
+        }
+
+        try {
+            $refClass = new ReflectionClass($className);
+        } catch (\ReflectionException $e) {
+            $this->localCollection[$className] = null;
+
+            return null;
+        }
+
+        $metadata = $this->reader->getClassAnnotation($refClass, Dto::class);
+
+        if ($metadata !== null) {
+            $this->localCollection[$className] = $metadata;
+
+            return $metadata;
+        }
+
+        if (\PHP_VERSION_ID >= 80000) {
+            $metadata = array_map(
+                function (\ReflectionAttribute $attribute) {
+                    return $attribute->newInstance();
+                },
+                $refClass->getAttributes(Dto::class, \ReflectionAttribute::IS_INSTANCEOF)
+            )[0] ?? null;
+
+            if ($metadata !== null) {
+                $this->localCollection[$className] = $metadata;
+
+                return $metadata;
+            }
+        }
+
+        return null;
+    }
+}