-
-
Notifications
You must be signed in to change notification settings - Fork 346
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
[Renaming] Add RenameAttributeRector #6009
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
31 changes: 31 additions & 0 deletions
31
rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/fixture.php.inc
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,31 @@ | ||
<?php | ||
|
||
namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Fixture; | ||
|
||
use Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute; | ||
|
||
final class SomeClass | ||
{ | ||
#[SimpleRoute()] | ||
public function subscribe() | ||
{ | ||
} | ||
} | ||
|
||
?> | ||
----- | ||
<?php | ||
|
||
namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Fixture; | ||
|
||
use Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute; | ||
|
||
final class SomeClass | ||
{ | ||
#[\Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\NextRoute()] | ||
public function subscribe() | ||
{ | ||
} | ||
} | ||
|
||
?> |
33 changes: 33 additions & 0 deletions
33
rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Fixture/multiple-places.php.inc
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,33 @@ | ||
<?php | ||
|
||
namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Fixture; | ||
|
||
use Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute; | ||
|
||
final class MultiplePlaces | ||
{ | ||
#[SimpleRoute()] | ||
#[SimpleRoute('another')] | ||
public function subscribe() | ||
{ | ||
} | ||
} | ||
|
||
?> | ||
----- | ||
<?php | ||
|
||
namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Fixture; | ||
|
||
use Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute; | ||
|
||
final class MultiplePlaces | ||
{ | ||
#[\Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\NextRoute()] | ||
#[\Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\NextRoute('another')] | ||
public function subscribe() | ||
{ | ||
} | ||
} | ||
|
||
?> |
28 changes: 28 additions & 0 deletions
28
rules-tests/Renaming/Rector/Class_/RenameAttributeRector/RenameAttributeRectorTest.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,28 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector; | ||
|
||
use Iterator; | ||
use PHPUnit\Framework\Attributes\DataProvider; | ||
use Rector\Testing\PHPUnit\AbstractRectorTestCase; | ||
|
||
final class RenameAttributeRectorTest extends AbstractRectorTestCase | ||
{ | ||
#[DataProvider('provideData')] | ||
public function test(string $filePath): void | ||
{ | ||
$this->doTestFile($filePath); | ||
} | ||
|
||
public static function provideData(): Iterator | ||
{ | ||
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture'); | ||
} | ||
|
||
public function provideConfigFilePath(): string | ||
{ | ||
return __DIR__ . '/config/configured_rule.php'; | ||
} | ||
} |
8 changes: 8 additions & 0 deletions
8
rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/NextRoute.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,8 @@ | ||
<?php | ||
|
||
namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source; | ||
|
||
#[\Attribute] | ||
class NextRoute | ||
{ | ||
} |
8 changes: 8 additions & 0 deletions
8
rules-tests/Renaming/Rector/Class_/RenameAttributeRector/Source/SimpleRoute.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,8 @@ | ||
<?php | ||
|
||
namespace Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source; | ||
|
||
#[\Attribute] | ||
class SimpleRoute | ||
{ | ||
} |
16 changes: 16 additions & 0 deletions
16
rules-tests/Renaming/Rector/Class_/RenameAttributeRector/config/configured_rule.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,16 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
use Rector\Config\RectorConfig; | ||
use Rector\Renaming\Rector\Class_\RenameAttributeRector; | ||
|
||
return static function (RectorConfig $rectorConfig): void { | ||
$rectorConfig | ||
->ruleWithConfiguration(RenameAttributeRector::class, [ | ||
new \Rector\Renaming\ValueObject\RenameAttribute( | ||
'Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\SimpleRoute', | ||
'Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\Source\NextRoute' | ||
), | ||
]); | ||
}; |
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,105 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Rector\Renaming\Rector\Class_; | ||
|
||
use PhpParser\Node; | ||
use PhpParser\Node\Name\FullyQualified; | ||
use PhpParser\Node\Stmt\Class_; | ||
use PhpParser\Node\Stmt\ClassMethod; | ||
use PhpParser\Node\Stmt\Property; | ||
use Rector\Contract\Rector\ConfigurableRectorInterface; | ||
use Rector\Rector\AbstractRector; | ||
use Rector\Renaming\ValueObject\RenameAttribute; | ||
use Rector\ValueObject\PhpVersionFeature; | ||
use Rector\VersionBonding\Contract\MinPhpVersionInterface; | ||
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample; | ||
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; | ||
use Webmozart\Assert\Assert; | ||
|
||
/** | ||
* @see \Rector\Tests\Renaming\Rector\Class_\RenameAttributeRector\RenameAttributeRectorTest | ||
*/ | ||
final class RenameAttributeRector extends AbstractRector implements ConfigurableRectorInterface, MinPhpVersionInterface | ||
{ | ||
/** | ||
* @var RenameAttribute[] | ||
*/ | ||
private array $renameAttributes = []; | ||
|
||
public function getRuleDefinition(): RuleDefinition | ||
{ | ||
return new RuleDefinition( | ||
'Rename attribute class names', | ||
[ | ||
new ConfiguredCodeSample( | ||
<<<'CODE_SAMPLE' | ||
#[SimpleRoute()] | ||
class SomeClass | ||
{ | ||
} | ||
CODE_SAMPLE | ||
, | ||
<<<'CODE_SAMPLE' | ||
#[BasicRoute()] | ||
class SomeClass | ||
{ | ||
} | ||
CODE_SAMPLE | ||
, | ||
[] | ||
), | ||
] | ||
); | ||
} | ||
|
||
/** | ||
* @return array<class-string<Node>> | ||
*/ | ||
public function getNodeTypes(): array | ||
{ | ||
return [Class_::class, ClassMethod::class, Property::class]; | ||
} | ||
|
||
/** | ||
* @param Class_|ClassMethod|Property $node | ||
*/ | ||
public function refactor(Node $node): ?\PhpParser\Node | ||
{ | ||
$hasChanged = false; | ||
|
||
foreach ($node->attrGroups as $attrGroup) { | ||
foreach ($attrGroup->attrs as $attr) { | ||
foreach ($this->renameAttributes as $renameAttribute) { | ||
if ($this->isName($attr->name, $renameAttribute->getOldAttribute())) { | ||
$attr->name = new FullyQualified($renameAttribute->getNewAttribute()); | ||
|
||
$hasChanged = true; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Here needs There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Got it, thanks 👍 |
||
} | ||
} | ||
} | ||
} | ||
|
||
if ($hasChanged) { | ||
return $node; | ||
} | ||
|
||
return null; | ||
} | ||
|
||
/** | ||
* @param mixed[] $configuration | ||
*/ | ||
public function configure(array $configuration): void | ||
{ | ||
Assert::allIsAOf($configuration, RenameAttribute::class); | ||
|
||
$this->renameAttributes = $configuration; | ||
} | ||
|
||
public function provideMinPhpVersion(): int | ||
{ | ||
return PhpVersionFeature::ATTRIBUTES; | ||
} | ||
} |
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,27 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Rector\Renaming\ValueObject; | ||
|
||
/** | ||
* @api | ||
*/ | ||
final readonly class RenameAttribute | ||
{ | ||
public function __construct( | ||
private string $oldAttribute, | ||
private string $newAttribute | ||
) { | ||
} | ||
|
||
public function getOldAttribute(): string | ||
{ | ||
return $this->oldAttribute; | ||
} | ||
|
||
public function getNewAttribute(): string | ||
{ | ||
return $this->newAttribute; | ||
} | ||
} |
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.
configurable code example should have entry example
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.
Thanks 👍 Fixed in next commit