Skip to content
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
9 changes: 9 additions & 0 deletions packages/CodingStyle/src/Naming/ClassNaming.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ final class ClassNaming
{
public function getShortName(string $fullyQualifiedName): string
{
$fullyQualifiedName = trim($fullyQualifiedName, '\\');

return Strings::after($fullyQualifiedName, '\\', -1) ?: $fullyQualifiedName;
}

public function getNamespace(string $fullyQualifiedName): ?string
{
$fullyQualifiedName = trim($fullyQualifiedName, '\\');

return Strings::before($fullyQualifiedName, '\\', -1) ?: null;
}
}
114 changes: 112 additions & 2 deletions src/Rector/Class_/RenameClassRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@
use PhpParser\Node;
use PhpParser\Node\Expr\New_;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Property;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\Stmt\UseUse;
use Rector\CodingStyle\Naming\ClassNaming;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PhpDoc\NodeAnalyzer\DocBlockManipulator;
use Rector\Rector\AbstractRector;
Expand All @@ -30,12 +34,26 @@ final class RenameClassRector extends AbstractRector
*/
private $docBlockManipulator;

/**
* @var string[]
*/
private $alreadyProcessedClasses = [];
/**
* @var ClassNaming
*/
private $classNaming;

/**
* @param string[] $oldToNewClasses
*/
public function __construct(DocBlockManipulator $docBlockManipulator, array $oldToNewClasses = [])
public function __construct(
DocBlockManipulator $docBlockManipulator,
ClassNaming $classNaming,
array $oldToNewClasses = []
)
{
$this->docBlockManipulator = $docBlockManipulator;
$this->classNaming = $classNaming;
$this->oldToNewClasses = $oldToNewClasses;
}

Expand Down Expand Up @@ -81,7 +99,14 @@ function someFunction(SomeNewClass $someOldClass): SomeNewClass
*/
public function getNodeTypes(): array
{
return [Name::class, Property::class, FunctionLike::class, Expression::class];
return [
Name::class,
Property::class,
FunctionLike::class,
Expression::class,
ClassLike::class,
Namespace_::class,
];
}

/**
Expand Down Expand Up @@ -112,6 +137,18 @@ public function refactor(Node $node): ?Node
return new FullyQualified($newName);
}

if ($node instanceof Namespace_) {
$node = $this->refactorNamespaceNode($node);
}

if ($node instanceof ClassLike) {
$node = $this->refactorClassLikeNode($node);
}

if (! $node) {
return null;
}

foreach ($this->oldToNewClasses as $oldType => $newType) {
$this->docBlockManipulator->changeType($node, $oldType, $newType);
}
Expand Down Expand Up @@ -176,4 +213,77 @@ private function isValidClassNameChange(Node $node, string $newName, Class_ $cla
}
return ! (in_array($node, $classNode->implements, true) && class_exists($newName));
}

private function refactorNamespaceNode(Namespace_ $node): ?Node
{
$name = $this->getName($node);
if ($name === null) {
return null;
}

$classNode = $this->getClassOfNamespaceToRefactor($node);
if (! $classNode) {
return null;
}

$newClassFqn = $this->oldToNewClasses[$this->getName($classNode)];
$newNamespace = $this->classNaming->getNamespace($newClassFqn);

// Renaming to class without namespace (example MyNamespace\DateTime -> DateTimeImmutable)
Comment thread
JanMikes marked this conversation as resolved.
if (! $newNamespace) {
$classNode->name = new Identifier($newClassFqn);

return $classNode;
}

$node->name = new Name($newNamespace);

return $node;
}

private function getClassOfNamespaceToRefactor(Namespace_ $namespace): ?ClassLike
{
$foundClass = $this->betterNodeFinder->findFirst($namespace, function (Node $node) {
if (! $node instanceof ClassLike) {
return false;
}

return isset($this->oldToNewClasses[$this->getName($node)]);
});

return $foundClass instanceof ClassLike ? $foundClass : null;
}

private function refactorClassLikeNode(ClassLike $classLike): ?Node
{
$name = $this->getName($classLike);
if ($name === null) {
return null;
}

$newName = $this->oldToNewClasses[$name] ?? null;
if (! $newName) {
return null;
}

// prevents re-iterating same class in endless loop
if (in_array($name, $this->alreadyProcessedClasses, true)) {
return null;
}

$this->alreadyProcessedClasses[] = $name;

$newName = $this->oldToNewClasses[$name];
$newClassNamePart = $this->classNaming->getShortName($newName);
$newNamespacePart = $this->classNaming->getNamespace($newName);

$classLike->name = new Identifier($newClassNamePart);

// Old class did not have any namespace, we need to wrap class with Namespace_ node
if ($newNamespacePart && ! $this->classNaming->getNamespace($name)) {
return new Namespace_(new Name($newNamespacePart), [$classLike]);
}

return $classLike;
}
}
5 changes: 5 additions & 0 deletions src/Testing/PHPUnit/AbstractRectorTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,11 @@ protected function doTestFiles(array $files): void
$this->autoloadTestFixture = true;
}

protected function doTestFile(string $file): void
{
$this->doTestFiles([$file]);
Comment thread
JanMikes marked this conversation as resolved.
}

protected function getTempPath(): string
{
return sys_get_temp_dir() . '/rector_temp_tests';
Expand Down
33 changes: 33 additions & 0 deletions tests/Rector/Class_/RenameClassRector/Fixture/rename_class.php.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

namespace MyNamespace;

class MyClass
{
/**
* @return MyClass
*/
public function createSelf(): MyClass
{
return new MyClass;
}
}

?>
-----
<?php

namespace MyNewNamespace;

class MyNewClass
{
/**
* @return \MyNewNamespace\MyNewClass
*/
public function createSelf(): \MyNewNamespace\MyNewClass
{
return new \MyNewNamespace\MyNewClass;
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

namespace MyNamespace;

class AnotherMyClass
{
/**
* @return AnotherMyClass
*/
public function createSelf(): AnotherMyClass
{
return new AnotherMyClass;
}
}

?>
-----
<?php

class MyNewClassWithoutNamespace
{
/**
* @return MyNewClassWithoutNamespace
*/
public function createSelf(): \MyNewClassWithoutNamespace
{
return new \MyNewClassWithoutNamespace;
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

class MyOldClass
{
/**
* @return MyOldClass
*/
public function createSelf(): MyOldClass
{
return new MyOldClass;
}
}

?>
-----
<?php

namespace MyNamespace;

class MyNewClass
{
/**
* @return \MyNamespace\MyNewClass
*/
public function createSelf(): \MyNamespace\MyNewClass
{
return new \MyNamespace\MyNewClass;
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

class AnotherMyOldClass
{
/**
* @return AnotherMyOldClass
*/
public function createSelf(): AnotherMyOldClass
{
return new AnotherMyOldClass;
}
}

?>
-----
<?php

class AnotherMyNewClass
{
/**
* @return AnotherMyNewClass
*/
public function createSelf(): \AnotherMyNewClass
{
return new \AnotherMyNewClass;
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

namespace MyNamespace;

interface MyInterface
{
/**
* @return MyInterface
*/
public function createSelf(): MyInterface;
}

?>
-----
<?php

namespace MyNewNamespace;

interface MyNewInterface
{
/**
* @return \MyNewNamespace\MyNewInterface
*/
public function createSelf(): \MyNewNamespace\MyNewInterface;
}

?>
19 changes: 19 additions & 0 deletions tests/Rector/Class_/RenameClassRector/Fixture/rename_trait.php.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

namespace MyNamespace;

trait MyTrait
{
}

?>
-----
<?php

namespace MyNewNamespace;

trait MyNewTrait
{
}

?>
Loading