-
Notifications
You must be signed in to change notification settings - Fork 61
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
src/Rector/Rector/MethodCall/TableRegistryLocatorRector.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) { | ||
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); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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