fix: use pitch/annotation for Graceful annotation

Author: ph-fritsche

composer.json

@@ -22,9 +22,10 @@
     },
     "require": {
         "php": ">=7.4",
+        "composer/composer": "^1 || ^2",
+        "pitch/annotation": "^1.0",
         "symfony/config": "^5",
-        "symfony/http-kernel": "^5",
-        "composer/composer": "^1 || ^2"
+        "symfony/http-kernel": "^5"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

composer.lock

@@ -4,13 +4,14 @@
 use Attribute;
 use Doctrine\Common\Annotations\Annotation;
 use Doctrine\Common\Annotations\Annotation\Target;
+use Pitch\Annotation\AbstractAnnotation;
 
 /**
  * @Annotation
  * @Target({"METHOD"})
  */
 #[Attribute(Attribute::IS_REPEATABLE | Attribute::TARGET_METHOD)]
-class Graceful extends ConfigurationAnnotation
+class Graceful extends AbstractAnnotation
 {
     public ?string $value = null;
 

src/Configuration/ConfigurationAnnotation.php

@@ -1,68 +1,29 @@
 <?php
 namespace Pitch\AdrBundle\EventSubscriber;
 
-use Doctrine\Common\Annotations\Reader;
 use Pitch\AdrBundle\Action\ActionProxy;
 use Pitch\AdrBundle\Configuration\Graceful;
-use ReflectionAttribute;
-use ReflectionMethod;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
-use Symfony\Component\HttpKernel\Event\ControllerEvent;
 
 class ControllerSubscriber implements EventSubscriberInterface
 {
-    private ?Reader $reader;
     private array $globalGraceful;
 
     public function __construct(
-        ?Reader $reader,
         ?array $globalGraceful
     ) {
-        $this->reader = $reader;
         $this->globalGraceful = \array_map(fn($g) => new Graceful($g), (array) $globalGraceful);
     }
 
     public static function getSubscribedEvents()
     {
         return [
-            KernelEvents::CONTROLLER => ['onKernelController', -1024],
             KernelEvents::CONTROLLER_ARGUMENTS => ['onKernelControllerArguments', -1024],
         ];
     }
 
-    public function onKernelController(ControllerEvent $event)
-    {
-        $controller = $event->getController();
-
-        if (\is_object($controller)) {
-            $controller = [$controller, '__invoke'];
-        }
-
-        $reflMethod = new ReflectionMethod($controller[0], $controller[1]);
-
-        $annotations = $this->reader
-            ? $this->reader->getMethodAnnotations($reflMethod)
-            : [];
-
-        $attributes = PHP_MAJOR_VERSION >= 8
-            ? \array_map(
-                function (ReflectionAttribute $a) {
-                    $class = $a->getName();
-                    $args = $a->getArguments();
-                    if (isset($args[0]) && \is_array($args[0])) {
-                        return $a->newInstance();
-                    }
-                    return new $class(['value' => $args[0], 'not' => $args['not']]);
-                },
-                $reflMethod->getAttributes(Graceful::class, ReflectionAttribute::IS_INSTANCEOF),
-            )
-            : [];
-
-        $event->getRequest()->attributes->set('_' . Graceful::class, [...$annotations, ...$attributes]);
-    }
-
     public function onKernelControllerArguments(ControllerArgumentsEvent $event)
     {
 

src/Configuration/Graceful.php

@@ -1,62 +1,14 @@
 <?php
 namespace Pitch\AdrBundle\EventSubscriber;
 
-use Doctrine\Common\Annotations\AnnotationReader;
 use Pitch\AdrBundle\Action\ActionProxy;
 use Pitch\AdrBundle\Configuration\Graceful;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
-use Symfony\Component\HttpKernel\Event\ControllerEvent;
 
 class ControllerSubscriberTest extends EventSubscriberTest
 {
-    public function testReadAnnotations()
-    {
-        $event = $this->getControllerEvent(new class {
-            /**
-             * @Graceful("Foo")
-             * @Graceful("Bar", not={"Baz"})
-             */
-            public function __invoke()
-            {
-            }
-        });
-
-        // without Doctrine Annotations
-        $this->getSubscriberObject([], false)->onKernelController($event);
-        $this->assertEquals([], $event->getRequest()->attributes->get('_' . Graceful::class));
-
-        // with Doctrine Annotations
-        $this->getSubscriberObject([], true)->onKernelController($event);
-        $this->assertEquals([
-            new Graceful(['value' => 'Foo']),
-            new Graceful(['value' => 'Bar', 'not' => 'Baz']),
-        ], $event->getRequest()->attributes->get('_' . Graceful::class));
-    }
-
-    public function testReadAttributes()
-    {
-        $event = $this->getControllerEvent(new class {
-            #[Graceful(['value' => 'Foo'])]
-            #[Graceful('Bar', not: 'Baz')]
-            public function __invoke()
-            {
-            }
-        });
-
-        $this->getSubscriberObject([], false)->onKernelController($event);
-        $this->assertEquals(
-            PHP_MAJOR_VERSION >= 8
-            ? [
-                new Graceful(['value' => 'Foo']),
-                new Graceful(['value' => 'Bar', 'not' => 'Baz']),
-            ]
-            : [],
-            $event->getRequest()->attributes->get('_' . Graceful::class)
-        );
-    }
-
     public function provideGraceful(): array
     {
         return [
@@ -129,17 +81,6 @@ protected function getGracefulForArray(
         return \array_map(fn($g) => new Graceful($g), $gracefulList);
     }
 
-    protected function getControllerEvent(
-        callable $controller
-    ): ControllerEvent {
-        return new ControllerEvent(
-            $this->createMock(HttpKernelInterface::class),
-            $controller,
-            new Request(),
-            HttpKernelInterface::MASTER_REQUEST,
-        );
-    }
-
     /**
      * @param Graceful[] $controllerGraceful
      */
@@ -149,8 +90,11 @@ protected function getControllerArgumentsEvent(
         $request = new Request();
         $request->attributes->set('_' . Graceful::class, $controllerGraceful);
 
+        /** @var HTTPKernelInterface */
+        $httpKernel = $this->createMock(HttpKernelInterface::class);
+
         return  new ControllerArgumentsEvent(
-            $this->createMock(HttpKernelInterface::class),
+            $httpKernel,
             function () {
             },
             [],
@@ -164,7 +108,6 @@ protected function getSubscriberObject(
         bool $reader = false
     ): ControllerSubscriber {
         return new ControllerSubscriber(
-            $reader ? new AnnotationReader() : null,
             $globalGraceful,
         );
     }

src/EventSubscriber/ControllerSubscriber.php

@@ -16,6 +16,7 @@ public function testAddCompilerPass()
 
         $bundle = new PitchAdrBundle();
 
+        /** @var ContainerBuilder $container */
         $bundle->build($container);
     }