Add support for dispatchSync to DispatchToHelperFunctionsRector rule (#355)

* Add support for dispatchSync -> dispatch_sync to DispatchToHelperFunctionsRector rule

* add docs

* Add support for dispatchSync -> dispatch_sync to DispatchToHelperFunctionsRector rule

* add docs

* lint

---------

Co-authored-by: Geni Jaho <[email protected]>

Author: pataar

docs/rector_rules_overview.md

@@ -593,6 +593,12 @@ Use the event or dispatch helpers instead of the static dispatch method.
 -ExampleJob::dispatch($email);
 +dispatch(new ExampleJob($email));
 ```
+<br>
+
+```diff
+-ExampleJob::dispatchSync($email);
++dispatch_sync(new ExampleJob($email));
+```
 
 <br>
 

src/Rector/StaticCall/DispatchToHelperFunctionsRector.php

@@ -42,6 +42,10 @@ public function getRuleDefinition(): RuleDefinition
                     'ExampleJob::dispatch($email);',
                     'dispatch(new ExampleJob($email));'
                 ),
+                new CodeSample(
+                    'ExampleJob::dispatchSync($email);',
+                    'dispatch_sync(new ExampleJob($email));'
+                ),
             ],
         );
     }
@@ -60,7 +64,7 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        if (! $this->isName($node->name, 'dispatch')) {
+        if (! $this->isName($node->name, 'dispatch') && ! $this->isName($node->name, 'dispatchSync')) {
             return null;
         }
 
@@ -76,6 +80,10 @@ public function refactor(Node $node): ?Node
         }
 
         if ($this->usesBusDispatchable($classReflection)) {
+            if ($this->isName($node->name, 'dispatchSync')) {
+                return $this->createDispatchableCall($node, 'dispatch_sync');
+            }
+
             return $this->createDispatchableCall($node, 'dispatch');
         }
 

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

@@ -5,6 +5,7 @@ namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\
 use RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestJob;
 
 TestJob::dispatch('param1', 'param2');
+TestJob::dispatchSync('param1', 'param2');
 -----
 <?php
 
@@ -13,3 +14,4 @@ namespace RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\
 use RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestJob;
 
 dispatch(new \RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestJob('param1', 'param2'));
+dispatch_sync(new \RectorLaravel\Tests\Rector\StaticCall\DispatchToHelperFunctionsRector\Source\TestJob('param1', 'param2'));