add rector to transform TableRegistry::get to TableRegistry::getTable…

…Locator()->get (#295)

config/rector/sets/cakephp50.php

@@ -3,6 +3,7 @@
 
 use Cake\Upgrade\Rector\Rector\MethodCall\OptionsArrayToNamedParametersRector;
 use Cake\Upgrade\Rector\Rector\MethodCall\RemoveMethodCallRector;
+use Cake\Upgrade\Rector\Rector\MethodCall\TableRegistryLocatorRector;
 use Cake\Upgrade\Rector\ValueObject\OptionsArrayToNamedParameters;
 use Cake\Upgrade\Rector\ValueObject\RemoveMethodCall;
 use PHPStan\Type\ArrayType;
@@ -113,4 +114,6 @@
         new RemoveMethodCall('Cake\TestSuite\TestCase', 'useCommandRunner'),
         new RemoveMethodCall('Cake\TestSuite\TestCase', 'useHttpServer'),
     ]);
+
+    $rectorConfig->rule(TableRegistryLocatorRector::class);
 };

src/Rector/Rector/MethodCall/TableRegistryLocatorRector.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cake\Upgrade\Rector\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\StaticCall;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class TableRegistryLocatorRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Refactor `TableRegistry::get()` to `TableRegistry::getTableLocator()->get()`', [
+            new ConfiguredCodeSample(
+                <<<'CODE_SAMPLE'
+TableRegistry::get('something');
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+TableRegistry::getTableLocator()->get('something');
+CODE_SAMPLE
+            )
+        ]);
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [StaticCall::class];
+    }
+
+    public function refactor(Node $node): ?Node
+    {
+        if(! $node instanceof StaticCall) {
+            return null;
+        }
+
+        // Ensure it's a static call we're looking for: TableRegistry::get(...)
+        if (! $this->isStaticCallMatch($node, 'Cake\ORM\TableRegistry', 'get')) {
+            return null;
+        }
+
+        // Create new static call TableRegistry::getTableLocator()->get(...)
+        return $this->nodeFactory->createMethodCall(
+            $this->nodeFactory->createStaticCall('Cake\ORM\TableRegistry', 'getTableLocator'),
+            'get',
+            $node->args
+        );
+    }
+
+    private function isStaticCallMatch(StaticCall $staticCall, string $className, string $methodName): bool
+    {
+        // Check if the static call is `TableRegistry::get`
+        return $this->isName($staticCall->class, $className) && $this->isName($staticCall->name, $methodName);
+    }
+}

tests/test_apps/original/RectorCommand-testApply50/src/SomeComponent.php

@@ -6,4 +6,9 @@ class SomeComponent extends \Cake\Controller\Component
     protected $components;
 
     protected $_defaultConfig = [];
+
+    public function tableRegistryTest(): void
+    {
+        \Cake\ORM\TableRegistry::get('MyTable');
+    }
 }

tests/test_apps/upgraded/RectorCommand-testApply50/src/SomeComponent.php

@@ -6,4 +6,9 @@ class SomeComponent extends \Cake\Controller\Component
     protected array $components;
 
     protected array $_defaultConfig = [];
+
+    public function tableRegistryTest(): void
+    {
+        \Cake\ORM\TableRegistry::getTableLocator()->get('MyTable');
+    }
 }