add event_class to RenameEventNamesInEventSubscriberRector

2025-01-18 05:48:21 +01:00 · 2019-02-09 18:23:03 +01:00 · 2019-02-09 18:23:03 +01:00 · e8c2165e17
commit e8c2165e17
parent 1adc55d74f
9 changed files with 350 additions and 116 deletions
--- a/ecs.yml
+++ b/ecs.yml
@ -83,6 +83,7 @@ parameters:
            - 'packages/NodeTypeResolver/src/Php/AbstractTypeInfo.php'
            # example in description
            - 'src/Rector/Annotation/AnnotationReplacerRector.php'
+            - 'packages/NetteToSymfony/src/Event/EventInfosFactory.php'

        Symplify\CodingStandard\Sniffs\CleanCode\ForbiddenStaticFunctionSniff:
            # required by Composer interface
--- a/packages/NetteToSymfony/config/config.yaml
+++ b/packages/NetteToSymfony/config/config.yaml
@ -5,4 +5,4 @@ services:

    Rector\NetteToSymfony\:
        resource: '../src'
-        exclude: '../src/{Annotation,Route/RouteInfo.php}'
+        exclude: '../src/{Annotation,Route/RouteInfo.php,Event/EventInfo.php}'
--- a/packages/NetteToSymfony/src/Event/EventInfo.php
+++ b/packages/NetteToSymfony/src/Event/EventInfo.php
@ -0,0 +1,80 @@
+<?php declare(strict_types=1);
+
+namespace Rector\NetteToSymfony\Event;
+
+final class EventInfo
+{
+    /**
+     * @var string[]
+     */
+    private $oldStringAliases = [];
+
+    /**
+     * @var string[]
+     */
+    private $oldClassConstAlaises = [];
+
+    /**
+     * @var string
+     */
+    private $class;
+
+    /**
+     * @var string
+     */
+    private $constant;
+
+    /**
+     * @var string
+     */
+    private $eventClass;
+
+    /**
+     * @param string[] $oldStringAliases
+     * @param string[] $oldClassConstAlaises
+     */
+    public function __construct(
+        array $oldStringAliases,
+        array $oldClassConstAlaises,
+        string $class,
+        string $constant,
+        string $eventClass
+    ) {
+        $this->oldStringAliases = $oldStringAliases;
+        $this->oldClassConstAlaises = $oldClassConstAlaises;
+        $this->class = $class;
+        $this->constant = $constant;
+        $this->eventClass = $eventClass;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getOldStringAliases(): array
+    {
+        return $this->oldStringAliases;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getOldClassConstAlaises(): array
+    {
+        return $this->oldClassConstAlaises;
+    }
+
+    public function getClass(): string
+    {
+        return $this->class;
+    }
+
+    public function getConstant(): string
+    {
+        return $this->constant;
+    }
+
+    public function getEventClass(): string
+    {
+        return $this->eventClass;
+    }
+}
--- a/packages/NetteToSymfony/src/Event/EventInfosFactory.php
+++ b/packages/NetteToSymfony/src/Event/EventInfosFactory.php
@ -0,0 +1,89 @@
+<?php declare(strict_types=1);
+
+namespace Rector\NetteToSymfony\Event;
+
+final class EventInfosFactory
+{
+    /**
+     * @return EventInfo[]
+     */
+    public function create(): array
+    {
+        $eventInfos = [];
+        $eventInfos[] = new EventInfo(
+            ['nette.application.startup', 'nette.application.request'],
+            [
+                'Contributte\Events\Extra\Event\Application\StartupEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\RequestEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_REQUEST',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_STARTUP',
+            ],
+            'Symfony\Component\HttpKernel\KernelEvents',
+            'REQUEST',
+            'Symfony\Component\HttpKernel\Event\GetResponseEvent',
+        );
+
+        $eventInfos[] = new EventInfo(
+            ['nette.application.startup', 'nette.application.request'],
+            [
+                'Contributte\Events\Extra\Event\Application\StartupEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\RequestEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_REQUEST',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_STARTUP',
+            ],
+            'Symfony\Component\HttpKernel\KernelEvents',
+            'REQUEST',
+            'Symfony\Component\HttpKernel\Event\GetResponseEvent'
+        );
+
+        $eventInfos[] = new EventInfo(
+            ['nette.application.shutdown'],
+            [
+                'Contributte\Events\Extra\Event\Application\PresenterShutdownEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_SHUTDOWN',
+            ],
+            'Symfony\Component\HttpKernel\KernelEvents',
+            'TERMINATE',
+            'Symfony\Component\HttpKernel\Event\PostResponseEvent'
+        );
+
+        $eventInfos[] = new EventInfo(
+            ['nette.application.presenter', 'nette.application.presenter.startup'],
+            [
+                'Contributte\Events\Extra\Event\Application\PresenterEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\PresenterStartupEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\PresenterShutdownEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_PRESENTER_SHUTDOWN',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_PRESENTER_STARTUP',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_PRESENTER',
+            ],
+            'Symfony\Component\HttpKernel\KernelEvents',
+            'CONTROLLER',
+            'Symfony\Component\HttpKernel\Event\FilterControllerEvent',
+        );
+
+        $eventInfos[] = new EventInfo(
+            ['nette.application.error'],
+            [
+                'Contributte\Events\Extra\Event\Application\ErrorEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_ERROR',
+            ],
+            'Symfony\Component\HttpKernel\KernelEvents',
+            'EXCEPTION',
+            'Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent'
+        );
+
+        $eventInfos[] = new EventInfo(
+            ['nette.application.response'],
+            [
+                'Contributte\Events\Extra\Event\Application\ResponseEvent::NAME',
+                'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_RESPONSE',
+            ],
+            'Symfony\Component\HttpKernel\KernelEvents',
+            'RESPONSE',
+            'Symfony\Component\HttpKernel\Event\FilterResponseEvent'
+        );
+
+        return $eventInfos;
+    }
+}
--- a/packages/NetteToSymfony/src/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector.php
+++ b/packages/NetteToSymfony/src/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector.php
@ -2,6 +2,7 @@

 namespace Rector\NetteToSymfony\Rector\ClassMethod;

+use Composer\Script\Event;
 use PhpParser\Node;
 use PhpParser\Node\Expr\Array_;
 use PhpParser\Node\Expr\ArrayItem;
@ -10,6 +11,9 @@ use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Return_;
+use Rector\NetteToSymfony\Event\EventInfo;
+use Rector\NetteToSymfony\Event\EventInfosFactory;
+use Rector\NodeTypeResolver\Application\FunctionLikeNodeCollector;
 use Rector\NodeTypeResolver\Node\Attribute;
 use Rector\PhpParser\Node\BetterNodeFinder;
 use Rector\Rector\AbstractRector;
@ -19,97 +23,34 @@ use Rector\RectorDefinition\RectorDefinition;
 /**
 * @see https://github.com/contributte/event-dispatcher-extra/blob/master/.docs/README.md#bridge-wrench
 * @see https://symfony.com/doc/current/reference/events.html
+ * @see https://symfony.com/doc/current/components/http_kernel.html#creating-an-event-listener
+ * @see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpKernel/KernelEvents.php
 */
 final class RenameEventNamesInEventSubscriberRector extends AbstractRector
 {
    /**
-     * @var string[][]
+     * @var EventInfo[]
     */
-    private $netteStringNamesToSymfonyClassConstMap = [
-        'nette.application.startup' => ['Symfony\Component\HttpKernel\KernelEvents', 'REQUEST'],
-        'nette.application.shutdown' => ['Symfony\Component\HttpKernel\KernelEvents', 'TERMINATE'],
-        'nette.application.request' => ['Symfony\Component\HttpKernel\KernelEvents', 'REQUEST'],
-        'nette.application.presenter' => ['Symfony\Component\HttpKernel\KernelEvents', 'CONTROLLER'],
-        'nette.application.presenter.startup' => ['Symfony\Component\HttpKernel\KernelEvents', 'CONTROLLER'],
-        'nette.application.presenter.shutdown' => ['Symfony\Component\HttpKernel\KernelEvents', 'CONTROLLER'],
-        'nette.application.response' => ['Symfony\Component\HttpKernel\KernelEvents', 'RESPONSE'],
-        'nette.application.error' => ['Symfony\Component\HttpKernel\KernelEvents', 'EXCEPTION'],
-    ];
-
-    /**
-     * @var string[][]
-     */
-    private $netteClassConstToSymfonyClassConstMap = [
-        'Contributte\Events\Extra\Event\Application\StartupEvent::NAME' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'REQUEST',
-        ],
-        'Contributte\Events\Extra\Event\Application\PresenterShutdownEvent::NAME' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'TERMINATE',
-        ],
-        'Contributte\Events\Extra\Event\Application\RequestEvent::NAME' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'REQUEST',
-        ],
-        'Contributte\Events\Extra\Event\Application\PresenterEvent::NAME' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'CONTROLLER',
-        ],
-        'Contributte\Events\Extra\Event\Application\PresenterStartupEvent::NAME' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'CONTROLLER',
-        ],
-        'Contributte\Events\Extra\Event\Application\ResponseEvent::NAME' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'RESPONSE',
-        ],
-        'Contributte\Events\Extra\Event\Application\ErrorEvent::NAME' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'EXCEPTION',
-        ],
-        'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_STARTUP' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'REQUEST',
-        ],
-        'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_SHUTDOWN' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'TERMINATE',
-        ],
-        'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_REQUEST' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'REQUEST',
-        ],
-        'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_PRESENTER' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'CONTROLLER',
-        ],
-        'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_PRESENTER_STARTUP' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'CONTROLLER',
-        ],
-        'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_PRESENTER_SHUTDOWN' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'CONTROLLER',
-        ],
-        'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_RESPONSE' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'RESPONSE',
-        ],
-        'Contributte\Events\Extra\Event\Application\ApplicationEvents::ON_ERROR' => [
-            'Symfony\Component\HttpKernel\KernelEvents',
-            'EXCEPTION',
-        ],
-    ];
+    private $symfonyClassConstWithAliases = [];

    /**
     * @var BetterNodeFinder
     */
    private $betterNodeFinder;

-    public function __construct(BetterNodeFinder $betterNodeFinder)
-    {
+    /**
+     * @var FunctionLikeNodeCollector
+     */
+    private $functionLikeNodeCollector;
+
+    public function __construct(
+        BetterNodeFinder $betterNodeFinder,
+        EventInfosFactory $eventInfosFactory,
+        FunctionLikeNodeCollector $functionLikeNodeCollector
+    ) {
        $this->betterNodeFinder = $betterNodeFinder;
+        $this->symfonyClassConstWithAliases = $eventInfosFactory->create();
+        $this->functionLikeNodeCollector = $functionLikeNodeCollector;
    }

    public function getDefinition(): RectorDefinition
@ -191,45 +132,86 @@ CODE_SAMPLE
        }

        foreach ($returnNode->expr->items as $arrayItem) {
-            $this->renameStringKeys($arrayItem);
-            $this->renameClassConstKeys($arrayItem);
-        }
-    }
-
-    private function renameStringKeys(ArrayItem $arrayItem): void
-    {
-        if (! $arrayItem->key instanceof String_) {
-            return;
-        }
-
-        foreach ($this->netteStringNamesToSymfonyClassConstMap as $netteStringName => $symfonyClassConst) {
-            if (! $this->isValue($arrayItem->key, $netteStringName)) {
-                return;
+            $eventInfo = $this->matchStringKeys($arrayItem);
+            if ($eventInfo === null) {
+                $eventInfo = $this->matchClassConstKeys($arrayItem);
            }

-            $arrayItem->key = new ClassConstFetch(new FullyQualified(
-                $symfonyClassConst[0]
-            ), $symfonyClassConst[1]);
-
-            return;
-        }
-    }
-
-    private function renameClassConstKeys(ArrayItem $arrayItem): void
-    {
-        if (! $arrayItem->key instanceof ClassConstFetch) {
-            return;
-        }
-
-        foreach ($this->netteClassConstToSymfonyClassConstMap as $netteClassConst => $symfonyClassConst) {
-            $classConstFetchNode = $arrayItem->key;
-            if (! $this->isName($classConstFetchNode, $netteClassConst)) {
+            if ($eventInfo === null) {
                continue;
            }

            $arrayItem->key = new ClassConstFetch(new FullyQualified(
-                $symfonyClassConst[0]
-            ), $symfonyClassConst[1]);
+                $eventInfo->getClass()
+            ), $eventInfo->getConstant());
+
+            // method name
+            $className = (string) $returnNode->getAttribute(Attribute::CLASS_NAME);
+            $methodName = (string) $this->getValue($arrayItem->value);
+            $this->processMethodArgument($className, $methodName, $eventInfo);
        }
    }
+
+    private function matchStringKeys(ArrayItem $arrayItem): ?EventInfo
+    {
+        if (! $arrayItem->key instanceof String_) {
+            return null;
+        }
+
+        foreach ($this->symfonyClassConstWithAliases as $symfonyClassConst) {
+            foreach ($symfonyClassConst->getOldStringAliases() as $netteStringName) {
+                if ($this->isValue($arrayItem->key, $netteStringName)) {
+                    return $symfonyClassConst;
+                }
+            }
+        }
+
+        return null;
+    }
+
+    private function matchClassConstKeys(ArrayItem $arrayItem): ?EventInfo
+    {
+        if (! $arrayItem->key instanceof ClassConstFetch) {
+            return null;
+        }
+
+        foreach ($this->symfonyClassConstWithAliases as $symfonyClassConst) {
+            $isMatch = $this->resolveClassConstAliasMatch($arrayItem, $symfonyClassConst);
+            if ($isMatch) {
+                return $symfonyClassConst;
+            }
+        }
+
+        return null;
+    }
+
+    private function resolveClassConstAliasMatch(ArrayItem $arrayItem, EventInfo $eventInfo): bool
+    {
+        foreach ($eventInfo->getOldClassConstAlaises() as $netteClassConst) {
+            $classConstFetchNode = $arrayItem->key;
+            if ($classConstFetchNode === null) {
+                continue;
+            }
+
+            if ($this->isName($classConstFetchNode, $netteClassConst)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    private function processMethodArgument(string $class, string $method, EventInfo $eventInfo): void
+    {
+        $classMethodNode = $this->functionLikeNodeCollector->findMethod($method, $class);
+        if ($classMethodNode === null) {
+            return;
+        }
+
+        if (count((array) $classMethodNode->params) !== 1) {
+            return;
+        }
+
+        $classMethodNode->params[0]->type = new FullyQualified($eventInfo->getEventClass());
+    }
 }
--- a/packages/NetteToSymfony/tests/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector/Fixture/event_class.php.inc
+++ b/packages/NetteToSymfony/tests/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector/Fixture/event_class.php.inc
@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\NetteToSymfony\Tests\Rector\ClassMethod\RenameEventNamesInEventSubscriberRector\Fixture;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+final class EventClass implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents()
+    {
+        return [
+            'nette.application.startup' => 'someMethod',
+        ];
+    }
+
+    public function someMethod(OldEvent $event)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\NetteToSymfony\Tests\Rector\ClassMethod\RenameEventNamesInEventSubscriberRector\Fixture;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+final class EventClass implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents()
+    {
+        return [
+            \Symfony\Component\HttpKernel\KernelEvents::REQUEST => 'someMethod',
+        ];
+    }
+
+    public function someMethod(\Symfony\Component\HttpKernel\Event\GetResponseEvent $event)
+    {
+    }
+}
+
+?>
--- a/packages/NetteToSymfony/tests/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector/Fixture/fixture.php.inc
+++ b/packages/NetteToSymfony/tests/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector/Fixture/fixture.php.inc
@ -12,7 +12,6 @@ final class SomeClass implements EventSubscriberInterface
        return [
            'nette.application.startup' => 'someMethod',
            \Contributte\Events\Extra\Event\Application\StartupEvent::NAME => 'someMethod',
-            PresenterStartupEvent::NAME => 'someMethod',
        ];
    }
 }
@ -33,7 +32,6 @@ final class SomeClass implements EventSubscriberInterface
        return [
            \Symfony\Component\HttpKernel\KernelEvents::REQUEST => 'someMethod',
            \Symfony\Component\HttpKernel\KernelEvents::REQUEST => 'someMethod',
-            \Symfony\Component\HttpKernel\KernelEvents::CONTROLLER => 'someMethod',
        ];
    }
 }
--- a/packages/NetteToSymfony/tests/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector/Fixture/presenter_startup.php.inc
+++ b/packages/NetteToSymfony/tests/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector/Fixture/presenter_startup.php.inc
@ -0,0 +1,37 @@
+<?php
+
+namespace Rector\NetteToSymfony\Tests\Rector\ClassMethod\RenameEventNamesInEventSubscriberRector\Fixture;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Contributte\Events\Extra\Event\Application\PresenterStartupEvent;
+
+final class PresenterStartup implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents()
+    {
+        return [
+            PresenterStartupEvent::NAME => 'someMethod',
+        ];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\NetteToSymfony\Tests\Rector\ClassMethod\RenameEventNamesInEventSubscriberRector\Fixture;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Contributte\Events\Extra\Event\Application\PresenterStartupEvent;
+
+final class PresenterStartup implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents()
+    {
+        return [
+            \Symfony\Component\HttpKernel\KernelEvents::CONTROLLER => 'someMethod',
+        ];
+    }
+}
+
+?>
--- a/packages/NetteToSymfony/tests/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector/RenameEventNamesInEventSubscriberRectorTest.php
+++ b/packages/NetteToSymfony/tests/Rector/ClassMethod/RenameEventNamesInEventSubscriberRector/RenameEventNamesInEventSubscriberRectorTest.php
@ -9,7 +9,11 @@ final class RenameEventNamesInEventSubscriberRectorTest extends AbstractRectorTe
 {
    public function test(): void
    {
-        $this->doTestFiles([__DIR__ . '/Fixture/fixture.php.inc']);
+        $this->doTestFiles([
+            __DIR__ . '/Fixture/fixture.php.inc',
+            __DIR__ . '/Fixture/presenter_startup.php.inc',
+            __DIR__ . '/Fixture/event_class.php.inc',
+        ]);
    }

    protected function getRectorClass(): string