Skip to content

Commit 4ecc736

Browse files
authored
[Visibility] Retarget ChangeMethodVisibilityRector to Class_ node (#8831)
1 parent 9c32a8d commit 4ecc736

10 files changed

Lines changed: 88 additions & 75 deletions

File tree

‎composer.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,8 @@
7272
},
7373
"files": [
7474
"src/functions/node_helper.php",
75-
"src/functions/rule_doc_generator_class_aliases.php"
75+
"src/functions/rule_doc_generator_class_aliases.php",
76+
"src/functions/rule_class_aliases.php"
7677
]
7778
},
7879
"autoload-dev": {

‎rules-tests/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector/Fixture/fixture2.php.inc‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

rules-tests/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector/ChangeMethodVisibilityRectorTest.php renamed to rules-tests/Visibility/Rector/Class_/ChangeMethodVisibilityRector/ChangeMethodVisibilityRectorTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
declare(strict_types=1);
44

5-
namespace Rector\Tests\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector;
5+
namespace Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector;
66

77
use Iterator;
88
use PHPUnit\Framework\Attributes\DataProvider;

rules-tests/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector/Fixture/fixture.php.inc renamed to rules-tests/Visibility/Rector/Class_/ChangeMethodVisibilityRector/Fixture/fixture.php.inc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace Rector\Tests\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector\Fixture;
3+
namespace Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Fixture;
44

5-
use Rector\Tests\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector\Source\ParentObject;
5+
use Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Source\ParentObject;
66

77
class ClassThatInherits extends ParentObject
88
{
@@ -21,9 +21,9 @@ class ClassThatInherits extends ParentObject
2121
-----
2222
<?php
2323

24-
namespace Rector\Tests\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector\Fixture;
24+
namespace Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Fixture;
2525

26-
use Rector\Tests\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector\Source\ParentObject;
26+
use Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Source\ParentObject;
2727

2828
class ClassThatInherits extends ParentObject
2929
{
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
namespace Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Fixture;
4+
5+
use Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Source\ParentObject;
6+
7+
class ClassThatInherits2 extends ParentObject
8+
{
9+
static function toBePublicStaticMethod() {
10+
11+
}
12+
}
13+
14+
?>
15+
-----
16+
<?php
17+
18+
namespace Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Fixture;
19+
20+
use Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Source\ParentObject;
21+
22+
class ClassThatInherits2 extends ParentObject
23+
{
24+
public static function toBePublicStaticMethod() {
25+
26+
}
27+
}
28+
29+
?>

rules-tests/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector/Source/ParentObject.php renamed to rules-tests/Visibility/Rector/Class_/ChangeMethodVisibilityRector/Source/ParentObject.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
declare(strict_types=1);
44

5-
namespace Rector\Tests\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector\Source;
5+
namespace Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Source;
66

77
class ParentObject
88
{

rules-tests/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector/config/configured_rule.php renamed to rules-tests/Visibility/Rector/Class_/ChangeMethodVisibilityRector/config/configured_rule.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
declare(strict_types=1);
44

55
use Rector\Config\RectorConfig;
6-
use Rector\Tests\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector\Source\ParentObject;
6+
use Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\Source\ParentObject;
77
use Rector\ValueObject\Visibility;
8-
use Rector\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector;
8+
use Rector\Visibility\Rector\Class_\ChangeMethodVisibilityRector;
99
use Rector\Visibility\ValueObject\ChangeMethodVisibility;
1010

1111
return static function (RectorConfig $rectorConfig): void {

rules/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector.php renamed to rules/Visibility/Rector/Class_/ChangeMethodVisibilityRector.php

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22

33
declare(strict_types=1);
44

5-
namespace Rector\Visibility\Rector\ClassMethod;
5+
namespace Rector\Visibility\Rector\Class_;
66

77
use PhpParser\Node;
8-
use PhpParser\Node\Stmt\ClassMethod;
8+
use PhpParser\Node\Stmt\Class_;
9+
use PHPStan\Reflection\ClassReflection;
910
use Rector\Contract\Rector\ConfigurableRectorInterface;
10-
use Rector\NodeCollector\ScopeResolver\ParentClassScopeResolver;
11-
use Rector\PHPStan\ScopeFetcher;
1211
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
1312
use Rector\Rector\AbstractRector;
1413
use Rector\RuleDoc\CodeSample\ConfiguredCodeSample;
@@ -18,7 +17,7 @@
1817
use Webmozart\Assert\Assert;
1918

2019
/**
21-
* @see \Rector\Tests\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector\ChangeMethodVisibilityRectorTest
20+
* @see \Rector\Tests\Visibility\Rector\Class_\ChangeMethodVisibilityRector\ChangeMethodVisibilityRectorTest
2221
*/
2322
final class ChangeMethodVisibilityRector extends AbstractRector implements ConfigurableRectorInterface
2423
{
@@ -28,7 +27,6 @@ final class ChangeMethodVisibilityRector extends AbstractRector implements Confi
2827
private array $methodVisibilities = [];
2928

3029
public function __construct(
31-
private readonly ParentClassScopeResolver $parentClassScopeResolver,
3230
private readonly VisibilityManipulator $visibilityManipulator,
3331
) {
3432
}
@@ -82,43 +80,51 @@ protected function someMethod()
8280
*/
8381
public function getNodeTypes(): array
8482
{
85-
return [ClassMethod::class];
83+
return [Class_::class];
8684
}
8785

8886
/**
89-
* @param ClassMethod $node
87+
* @param Class_ $node
9088
*/
9189
public function refactor(Node $node): ?Node
9290
{
9391
if ($this->methodVisibilities === []) {
9492
return null;
9593
}
9694

97-
if (! $this->hasMatchingMethodName($node)) {
95+
$classReflection = $this->getClassReflection($node);
96+
if (! $classReflection instanceof ClassReflection) {
9897
return null;
9998
}
10099

101-
$scope = ScopeFetcher::fetch($node);
102-
$parentClassName = $this->parentClassScopeResolver->resolveParentClassName($scope);
103-
if ($parentClassName === null) {
100+
$parentClassReflection = $classReflection->getParentClass();
101+
if (! $parentClassReflection instanceof ClassReflection) {
104102
return null;
105103
}
106104

107-
foreach ($this->methodVisibilities as $methodVisibility) {
108-
if ($methodVisibility->getClass() !== $parentClassName) {
109-
continue;
110-
}
105+
$parentClassName = $parentClassReflection->getName();
111106

112-
if (! $this->isName($node, $methodVisibility->getMethod())) {
113-
continue;
114-
}
107+
$hasChanged = false;
108+
foreach ($node->getMethods() as $classMethod) {
109+
foreach ($this->methodVisibilities as $methodVisibility) {
110+
if ($methodVisibility->getClass() !== $parentClassName) {
111+
continue;
112+
}
115113

116-
$this->visibilityManipulator->changeNodeVisibility($node, $methodVisibility->getVisibility());
114+
if (! $this->isName($classMethod, $methodVisibility->getMethod())) {
115+
continue;
116+
}
117117

118-
return $node;
118+
$this->visibilityManipulator->changeNodeVisibility($classMethod, $methodVisibility->getVisibility());
119+
$hasChanged = true;
120+
}
119121
}
120122

121-
return null;
123+
if (! $hasChanged) {
124+
return null;
125+
}
126+
127+
return $node;
122128
}
123129

124130
/**
@@ -130,9 +136,4 @@ public function configure(array $configuration): void
130136

131137
$this->methodVisibilities = $configuration;
132138
}
133-
134-
private function hasMatchingMethodName(ClassMethod $classMethod): bool
135-
{
136-
return array_any($this->methodVisibilities, fn (ChangeMethodVisibility $methodVisibility): bool => $this->isName($classMethod, $methodVisibility->getMethod()));
137-
}
138139
}

‎src/NodeCollector/ScopeResolver/ParentClassScopeResolver.php‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,6 @@
99

1010
final class ParentClassScopeResolver
1111
{
12-
public function resolveParentClassName(Scope $scope): ?string
13-
{
14-
$parentClassReflection = $this->resolveParentClassReflection($scope);
15-
if (! $parentClassReflection instanceof ClassReflection) {
16-
return null;
17-
}
18-
19-
return $parentClassReflection->getName();
20-
}
21-
2212
public function resolveParentClassReflection(Scope $scope): ?ClassReflection
2313
{
2414
$classReflection = $scope->getClassReflection();
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\DeadCode\Rector\Class_\RemoveParentDelegatingClassMethodRector;
6+
use Rector\TypeDeclaration\Rector\Class_\ReturnTypeFromMockObjectRector;
7+
use Rector\TypeDeclaration\Rector\ClassLike\AddVoidReturnTypeWhereNoReturnRector;
8+
use Rector\Visibility\Rector\Class_\ChangeMethodVisibilityRector;
9+
10+
// backward-compatibility aliases for rules retargeted to Class_/ClassLike nodes and moved out of the ClassMethod namespace,
11+
// so configs and 3rd party sets referencing the former namespace keep working
12+
$ruleClassAliases = [
13+
ChangeMethodVisibilityRector::class => 'Rector\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector',
14+
RemoveParentDelegatingClassMethodRector::class => 'Rector\DeadCode\Rector\ClassMethod\RemoveParentDelegatingClassMethodRector',
15+
ReturnTypeFromMockObjectRector::class => 'Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromMockObjectRector',
16+
AddVoidReturnTypeWhereNoReturnRector::class => 'Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector',
17+
];
18+
19+
foreach ($ruleClassAliases as $currentClass => $legacyClass) {
20+
class_alias($currentClass, $legacyClass);
21+
}

0 commit comments

Comments
 (0)