Add rule to convert MyJob::dispatch() to dispatch(new MyJob()) (#193)

* Add `DispatchToHelperFunctionsRector`

* Extract classes to `Source` directory/namespace

Author: bram-pkg

docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 57 Rules Overview
+# 58 Rules Overview
 
 ## AddArgumentDefaultValueRector
 
@@ -450,6 +450,26 @@ Dispatch non ShouldQueue jobs to dispatchSync
 
 <br>
 
+## DispatchToHelperFunctionsRector
+
+Use the event or dispatch helpers instead of the static dispatch method.
+
+- class: [`RectorLaravel\Rector\StaticCall\DispatchToHelperFunctionsRector`](../src/Rector/StaticCall/DispatchToHelperFunctionsRector.php)
+
+```diff
+-ExampleEvent::dispatch($email);
++event(new ExampleEvent($email));
+```
+
+<br>
+
+```diff
+-ExampleJob::dispatch($email);
++dispatch(new ExampleJob($email));
+```
+
+<br>
+
 ## EloquentMagicMethodToQueryBuilderRector
 
 The EloquentMagicMethodToQueryBuilderRule is designed to automatically transform certain magic method calls on Eloquent Models into corresponding Query Builder method calls.

src/Rector/StaticCall/DispatchToHelperFunctionsRector.php

@@ -0,0 +1,135 @@
+<?php
+
+namespace RectorLaravel\Rector\StaticCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Name;
+use PHPStan\Broker\ClassNotFoundException;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Type\ObjectType;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\Exception\PoorDocumentationException;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\DispatchToHelperFunctionsRectorTest
+ */
+final class DispatchToHelperFunctionsRector extends AbstractRector
+{
+    public function __construct(
+        private readonly ReflectionProvider $reflectionProvider,
+    ) {
+    }
+
+    /**
+     * @throws PoorDocumentationException
+     */
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Use the event or dispatch helpers instead of the static dispatch method.',
+            [
+                new CodeSample(
+                    'ExampleEvent::dispatch($email);',
+                    'event(new ExampleEvent($email));'
+                ),
+                new CodeSample(
+                    'ExampleJob::dispatch($email);',
+                    'dispatch(new ExampleJob($email));'
+                ),
+            ],
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [StaticCall::class];
+    }
+
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node instanceof StaticCall) {
+            return null;
+        }
+
+        if (! $this->isName($node->name, 'dispatch')) {
+            return null;
+        }
+
+        $class = $node->class;
+
+        if (! $class instanceof Name) {
+            return null;
+        }
+
+        $classReflection = $this->getClassReflection($node);
+        if (! $classReflection instanceof ClassReflection) {
+            return null;
+        }
+
+        if ($this->usesBusDispatchable($classReflection)) {
+            return $this->createDispatchableCall($node, 'dispatch');
+        }
+
+        if ($this->usesEventDispatchable($classReflection)) {
+            return $this->createDispatchableCall($node, 'event');
+        }
+
+        return null;
+    }
+
+    private function getClassReflection(StaticCall $staticCall): ?ClassReflection
+    {
+        $type = $this->getType($staticCall->class);
+        if (! $type instanceof ObjectType) {
+            return null;
+        }
+
+        try {
+            return $this->reflectionProvider->getClass(
+                $type->getClassName()
+            );
+        } catch (ClassNotFoundException) {
+        }
+
+        return null;
+    }
+
+    private function usesBusDispatchable(ClassReflection $classReflection): bool
+    {
+        $traits = array_keys($classReflection->getTraits(true));
+
+        return in_array('Illuminate\Foundation\Bus\Dispatchable', $traits, true);
+    }
+
+    private function usesEventDispatchable(ClassReflection $classReflection): bool
+    {
+        $traits = array_keys($classReflection->getTraits(true));
+
+        return in_array('Illuminate\Foundation\Events\Dispatchable', $traits, true);
+    }
+
+    private function createDispatchableCall(StaticCall $staticCall, string $method): ?FuncCall
+    {
+        $class = $staticCall->class;
+        if (! $class instanceof Name) {
+            return null;
+        }
+
+        return new FuncCall(
+            new Name($method),
+            [
+                new Arg(new New_(new Name($class), $staticCall->args)),
+            ],
+        );
+    }
+}

stubs/Illuminate/Foundation/Events/Dispatchable.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Illuminate\Foundation\Events;
+
+if (class_exists('Illuminate\Foundation\Events\Dispatchable')) {
+    return;
+}
+trait Dispatchable
+{
+    public static function dispatch(...$arguments)
+    {
+    }
+
+    public static function dispatchIf($boolean, ...$arguments)
+    {
+    }
+
+    public static function dispatchUnless($boolean, ...$arguments)
+    {
+    }
+
+    public static function broadcast()
+    {
+    }
+}

tests/Rector/StaticCall/DispatchToHelperFunctionsRector/DispatchToHelperFunctionsRectorTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+class DispatchToHelperFunctionsRectorTest extends AbstractRectorTestCase
+{
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    /**
+     * @test
+     */
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

tests/Rector/StaticCall/DispatchToHelperFunctionsRector/Fixture/bus_dispatchable.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Fixture;
+
+use RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestJob;
+
+TestJob::dispatch('param1', 'param2');
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Fixture;
+
+use RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestJob;
+
+dispatch(new RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestJob('param1', 'param2'));

tests/Rector/StaticCall/DispatchToHelperFunctionsRector/Fixture/event_dispatchable.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Fixture;
+
+use RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestEvent;
+
+TestEvent::dispatch('param1', 'param2');
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Fixture;
+
+use RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestEvent;
+
+event(new RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestEvent('param1', 'param2'));

tests/Rector/StaticCall/DispatchToHelperFunctionsRector/Fixture/skip_other.php.inc

@@ -0,0 +1,7 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Fixture;
+
+use RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\OtherDispatchable;
+
+OtherDispatchable::dispatch('param1', 'param2');

tests/Rector/StaticCall/DispatchToHelperFunctionsRector/Source/OtherDispatchable.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source;
+
+use Some\Other\Dispatchable;
+
+class OtherDispatchable
+{
+    use Dispatchable;
+
+    public function __construct(
+        private string $param1,
+        private string $param2,
+    ) {
+    }
+}

tests/Rector/StaticCall/DispatchToHelperFunctionsRector/Source/TestEvent.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source;
+
+use Illuminate\Foundation\Events\Dispatchable;
+
+class TestEvent
+{
+    use Dispatchable;
+
+    public function __construct(
+        private string $param1,
+        private string $param2,
+    ) {
+    }
+}

tests/Rector/StaticCall/DispatchToHelperFunctionsRector/Source/TestJob.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source;
+
+use Illuminate\Foundation\Bus\Dispatchable;
+
+class TestJob
+{
+    use Dispatchable;
+
+    public function __construct(
+        private string $param1,
+        private string $param2,
+    ) {
+    }
+}