League event: change dispatch string events to objects

config/set/league-event-30.php

@@ -8,6 +8,7 @@
 use Rector\Composer\Rector\ChangePackageVersionComposerRector;
 use Rector\Composer\ValueObject\PackageAndVersion;
 use Rector\Core\Configuration\Option;
+use Rector\LeagueEvent\Rector\MethodCall\DispatchStringToObjectRector;
 use Rector\Removing\Rector\Class_\RemoveInterfacesRector;
 use Rector\Removing\Rector\Class_\RemoveParentRector;
 use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
@@ -80,7 +81,7 @@
     $services->set(AddInterfaceByParentRector::class)
         ->call('configure', [[
             AddInterfaceByParentRector::INTERFACE_BY_PARENT => [
-                'League\Event\AbstractEvent' => 'League\Event\HasEventName',
+                'League\Event\Event' => 'League\Event\HasEventName',
                 'League\Event\AbstractListener' => 'League\Event\Listener',
             ],
         ]]);
@@ -98,4 +99,6 @@
                 'League\Event\AbstractListener',
             ],
         ]]);
+
+    $services->set(DispatchStringToObjectRector::class);
 };

rules-tests/LeagueEvent/Rector/MethodCall/DispatchStringToObjectRector/DispatchStringToObjectRectorTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Rector\Tests\LeagueEvent\Rector\MethodCall\DispatchStringToObjectRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class DispatchStringToObjectRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
+

rules-tests/LeagueEvent/Rector/MethodCall/DispatchStringToObjectRector/Fixture/fixture.php.inc

@@ -0,0 +1,39 @@
+<?php
+
+namespace Rector\Tests\LeagueEvent\Rector\MethodCall\DispatchStringToObjectRector\Fixture;
+
+class Fixture
+{
+    /** @var \League\Event\EventDispatcher */
+    private $dispatcher;
+
+    public function run()
+    {
+        $this->dispatcher->dispatch('my-event');
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\LeagueEvent\Rector\MethodCall\DispatchStringToObjectRector\Fixture;
+
+class Fixture
+{
+    /** @var \League\Event\EventDispatcher */
+    private $dispatcher;
+
+    public function run()
+    {
+        $this->dispatcher->dispatch(new class implements \League\Event\HasEventName
+        {
+            public function eventName(): string
+            {
+                return 'my-event';
+            }
+        });
+    }
+}
+
+?>

rules-tests/LeagueEvent/Rector/MethodCall/DispatchStringToObjectRector/config/configured_rule.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\LeagueEvent\Rector\MethodCall\DispatchStringToObjectRector;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $services = $containerConfigurator->services();
+
+    $services->set(DispatchStringToObjectRector::class);
+};

rules/LeagueEvent/Rector/MethodCall/DispatchStringToObjectRector.php

@@ -0,0 +1,137 @@
+<?php
+
+namespace Rector\LeagueEvent\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Return_;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\StringType;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\LeagueEvent\Rector\MethodCall\DispatchStringToObjectRector\DispatchStringToObjectRectorTest
+ */
+final class DispatchStringToObjectRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Change string events to anonymous class which implement \League\Event\HasEventName', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    /** @var \League\Event\EventDispatcher */
+    private $dispatcher;
+
+    public function run()
+    {
+        $this->dispatcher->dispatch('my-event');
+    }
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    /** @var \League\Event\EventDispatcher */
+    private $dispatcher;
+
+    public function run()
+    {
+        $this->dispatcher->dispatch(new class implements \League\Event\HasEventName
+        {
+            public function eventName(): string
+            {
+                return 'my-event';
+            }
+        });
+    }
+}
+CODE_SAMPLE
+            )
+        ]);
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+    }
+
+    /**
+     * @param MethodCall $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if ($this->shouldSkip($node)) {
+            return null;
+        }
+
+        return $this->updateNode($node);
+    }
+
+    private function shouldSkip(MethodCall $methodCall): bool
+    {
+        if (! $this->isNames($methodCall->name, ['dispatch', 'emit'])) {
+            return true;
+        }
+
+        if ($this->isObjectType($methodCall->var, new ObjectType('League\Event\EventDispatcher'))) {
+            return false;
+        }
+
+        if ($this->isObjectType($methodCall->var, new ObjectType('League\Event\Emitter'))) {
+            return false;
+        }
+
+        if (! $this->getStaticType($methodCall->args[0]->value) instanceof StringType) {
+            return true;
+        }
+
+        return true;
+    }
+
+    private function updateNode(MethodCall $methodCall): MethodCall
+    {
+        $methodCall->args[0] = new Arg($this->createNewAnonymousEventClass($methodCall->args[0]->value));
+        return $methodCall;
+    }
+
+    private function createNewAnonymousEventClass(Expr $eventName): New_
+    {
+        $implements = [
+            new FullyQualified('League\Event\HasEventName')
+        ];
+
+        return new New_(new Class_(null, [
+            'implements' => $implements,
+            'stmts' => $this->createAnonymousEventClassBody($eventName),
+        ]));
+    }
+
+    /**
+     * @param Expr $eventName
+     * @return Stmt[]
+     */
+    private function createAnonymousEventClassBody(Expr $eventName): array
+    {
+        return [
+            new ClassMethod('eventName', [
+                'flags' => Class_::MODIFIER_PUBLIC,
+                'returnType' => 'string',
+                'stmts' => [
+                    new Return_($eventName),
+                ],
+            ]),
+        ];
+    }
+}

rules/Transform/Rector/Class_/AddInterfaceByParentRector.php

@@ -70,6 +70,7 @@ public function refactor(Node $node): ?Node
     {
         /** @var Scope $scope */
         $scope = $node->getAttribute(AttributeKey::SCOPE);
+
         $classReflection = $scope->getClassReflection();
         if (! $classReflection instanceof ClassReflection) {
             return null;