Skip to content

add rector to transform TableRegistry::get to TableRegistry::getTableLocator()->get() #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions config/rector/sets/cakephp50.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -114,4 +115,6 @@
new RemoveMethodCall('Cake\TestSuite\TestCase', 'useCommandRunner'),
new RemoveMethodCall('Cake\TestSuite\TestCase', 'useHttpServer'),
]);

$rectorConfig->rule(TableRegistryLocatorRector::class);
};
59 changes: 59 additions & 0 deletions src/Rector/Rector/MethodCall/TableRegistryLocatorRector.php
Original file line number Diff line number Diff line change
@@ -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) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be run through the phpcs autofixer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we should remove the exclude for the src/Rector folder from the phpcs.xml

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);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,9 @@ class SomeComponent extends \Cake\Controller\Component
protected $components;

protected $_defaultConfig = [];

public function tableRegistryTest(): void
{
\Cake\ORM\TableRegistry::get('MyTable');
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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');
}
}
Loading