-
Notifications
You must be signed in to change notification settings - Fork 60
Add rector rules for cakephp/authentication 4.x upgrade #370
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
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 hidden or 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,9 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
|
|
||
| use Cake\Upgrade\Rector\Set\CakePHPSetList; | ||
| use Rector\Config\RectorConfig; | ||
|
|
||
| return static function (RectorConfig $rectorConfig): void { | ||
| $rectorConfig->sets([CakePHPSetList::AUTHENTICATION_40]); | ||
| }; |
This file contains hidden or 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,30 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
|
|
||
| use Cake\Upgrade\Rector\Rector\MethodCall\RemoveMethodCallRector; | ||
| use Cake\Upgrade\Rector\ValueObject\RemoveMethodCall; | ||
| use Rector\Config\RectorConfig; | ||
| use Rector\Renaming\Rector\Name\RenameClassRector; | ||
|
|
||
| /** | ||
| * @see https://github.com/cakephp/authentication/blob/4.x/docs/en/upgrade-3-to-4.rst | ||
| */ | ||
| return static function (RectorConfig $rectorConfig): void { | ||
| // URL checker class renames | ||
| // Note: Order matters - StringUrlChecker rename must come first to avoid | ||
| // CakeRouterUrlChecker -> DefaultUrlChecker -> StringUrlChecker chain | ||
| $rectorConfig->ruleWithConfiguration(RenameClassRector::class, [ | ||
| // Old DefaultUrlChecker renamed to StringUrlChecker | ||
| 'Authentication\UrlChecker\DefaultUrlChecker' => 'Authentication\UrlChecker\StringUrlChecker', | ||
| // CakeRouterUrlChecker renamed to DefaultUrlChecker | ||
| 'Authentication\UrlChecker\CakeRouterUrlChecker' => 'Authentication\UrlChecker\DefaultUrlChecker', | ||
| // Plugin class renamed | ||
| 'Authentication\Plugin' => 'Authentication\AuthenticationPlugin', | ||
| ]); | ||
|
|
||
| // Remove loadIdentifier() method calls from AuthenticationService | ||
| $rectorConfig->ruleWithConfiguration(RemoveMethodCallRector::class, [ | ||
| new RemoveMethodCall('Authentication\AuthenticationService', 'loadIdentifier'), | ||
| new RemoveMethodCall('Authentication\AuthenticationServiceInterface', 'loadIdentifier'), | ||
| ]); | ||
| }; | ||
This file contains hidden or 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
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.
If you run this more than once will all the UrlChecker references end up as
StringUrlChecker?Uh oh!
There was an error while loading. Please reload this page.
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.
Yeah, that is not really idempotent right now
I dont have any great ideas other than: Marker comment
and then skip it.
This could be a bit difficult with inline usage of FQCN.
Alternative: file-level docblock
once we run it.
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.
Or: we just drop the old Default one rename.
And only rename the cake to default one.
No one outside of cake would use the upgrade tool here, and the few cases of people using the "external" over the cake router internal one would be almost irrelevant I assume.
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.
Skipping the rename on the existing default checker could work. I agree that there are likely few references to it in application code.