Skip to content

Commit c96f258

Browse files
TomasVotrubaTomasVotruba
committed
[code-quality] Add PreferPHPUnitSelfCallRector
1 parent b64beb8 commit c96f258

File tree

3 files changed

+92
-64
lines changed

3 files changed

+92
-64
lines changed

‎rules/CodeQuality/NodeAnalyser/AssertMethodAnalyzer.php‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\CodeQuality\NodeAnalyser;
6+
7+
use PhpParser\Node\Expr\MethodCall;
8+
use PhpParser\Node\Expr\StaticCall;
9+
use PHPStan\Reflection\ClassReflection;
10+
use Rector\NodeNameResolver\NodeNameResolver;
11+
use Rector\PHPUnit\CodeQuality\Enum\NonAssertStaticableMethods;
12+
use Rector\PHPUnit\Enum\PHPUnitClassName;
13+
use Rector\Reflection\ReflectionResolver;
14+
15+
final readonly class AssertMethodAnalyzer
16+
{
17+
public function __construct(
18+
private NodeNameResolver $nodeNameResolver,
19+
private ReflectionResolver $reflectionResolver,
20+
) {
21+
}
22+
23+
public function detectTestCaseCall(MethodCall|StaticCall $call): bool
24+
{
25+
$methodName = $this->nodeNameResolver->getName($call->name);
26+
if (! str_starts_with((string) $methodName, 'assert') && ! in_array(
27+
$methodName,
28+
NonAssertStaticableMethods::ALL
29+
)) {
30+
return false;
31+
}
32+
33+
$classReflection = $this->reflectionResolver->resolveClassReflection($call);
34+
if (! $classReflection instanceof ClassReflection) {
35+
return false;
36+
}
37+
38+
if ($call instanceof StaticCall && ! $this->nodeNameResolver->isNames($call->class, ['static', 'self'])) {
39+
return false;
40+
}
41+
42+
$extendedMethodReflection = $classReflection->getNativeMethod($methodName);
43+
44+
// only handle methods in TestCase or Assert class classes
45+
$declaringClassName = $extendedMethodReflection->getDeclaringClass()
46+
->getName();
47+
48+
return in_array($declaringClassName, [PHPUnitClassName::TEST_CASE, PHPUnitClassName::ASSERT]);
49+
}
50+
}

‎rules/CodeQuality/Rector/Class_/PreferPHPUnitSelfCallRector.php‎

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,9 @@
88
use PhpParser\Node\Expr\MethodCall;
99
use PhpParser\Node\Expr\StaticCall;
1010
use PhpParser\Node\Stmt\Class_;
11-
use PHPStan\Reflection\ClassReflection;
12-
use PHPStan\Type\ObjectType;
13-
use Rector\Enum\ClassName;
14-
use Rector\PHPUnit\CodeQuality\Enum\NonAssertStaticableMethods;
15-
use Rector\PHPUnit\Enum\PHPUnitClassName;
11+
use Rector\PHPUnit\CodeQuality\NodeAnalyser\AssertMethodAnalyzer;
1612
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
1713
use Rector\Rector\AbstractRector;
18-
use Rector\Reflection\ReflectionResolver;
1914
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
2015
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
2116

@@ -26,7 +21,7 @@ final class PreferPHPUnitSelfCallRector extends AbstractRector
2621
{
2722
public function __construct(
2823
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
29-
private readonly ReflectionResolver $reflectionResolver,
24+
private readonly AssertMethodAnalyzer $assertMethodAnalyzer,
3025
) {
3126
}
3227

@@ -84,44 +79,48 @@ public function refactor(Node $node): ?Node
8479
return null;
8580
}
8681

87-
$methodName = $this->getName($node->name);
88-
if (! is_string($methodName)) {
89-
return null;
90-
}
91-
92-
if (! str_starts_with($methodName, 'assert') && ! in_array($methodName, NonAssertStaticableMethods::ALL)) {
82+
if ($node->isFirstClassCallable()) {
9383
return null;
9484
}
9585

96-
if (! $this->isName($node->var, 'this')) {
97-
return null;
98-
}
99-
100-
if (! $this->isObjectType($node->var, new ObjectType(ClassName::TEST_CASE_CLASS))) {
86+
$methodName = $this->getName($node->name);
87+
// if (! is_string($methodName)) {
88+
// return null;
89+
// }
90+
//
91+
if (! $this->assertMethodAnalyzer->detectTestCaseCall($node)) {
10192
return null;
10293
}
10394

104-
$classReflection = $this->reflectionResolver->resolveClassReflection($node);
105-
if ($classReflection instanceof ClassReflection && $classReflection->hasNativeMethod($methodName)) {
106-
if ($node->isFirstClassCallable()) {
107-
return null;
108-
}
109-
110-
// only handle methods in TestCase class
111-
$methodReflection = $classReflection->getNativeMethod($methodName);
112-
if (! in_array(
113-
$methodReflection->getDeclaringClass()
114-
->getName(),
115-
[PHPUnitClassName::TEST_CASE, PHPUnitClassName::ASSERT]
116-
)) {
117-
return null;
118-
}
119-
120-
$hasChanged = true;
121-
return $this->nodeFactory->createStaticCall('self', $methodName, $node->getArgs());
122-
}
123-
124-
return null;
95+
// if (! str_starts_with($methodName, 'assert') && ! in_array($methodName, NonAssertStaticableMethods::ALL)) {
96+
// return null;
97+
// }
98+
//
99+
// if (! $this->isName($node->var, 'this')) {
100+
// return null;
101+
// }
102+
//
103+
// if (! $this->isObjectType($node->var, new ObjectType(ClassName::TEST_CASE_CLASS))) {
104+
// return null;
105+
//// }
106+
//
107+
// $classReflection = $this->reflectionResolver->resolveClassReflection($node);
108+
// if ($classReflection instanceof ClassReflection && $classReflection->hasNativeMethod($methodName)) {
109+
// // only handle methods in TestCase class
110+
// $methodReflection = $classReflection->getNativeMethod($methodName);
111+
// if (! in_array(
112+
// $methodReflection->getDeclaringClass()
113+
// ->getName(),
114+
// [PHPUnitClassName::TEST_CASE, PHPUnitClassName::ASSERT]
115+
// )) {
116+
// return null;
117+
// }
118+
//
119+
//
120+
// }
121+
122+
$hasChanged = true;
123+
return $this->nodeFactory->createStaticCall('self', $methodName, $node->getArgs());
125124
});
126125

127126
if ($hasChanged) {

‎rules/CodeQuality/Rector/Class_/PreferPHPUnitThisCallRector.php‎

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
use PhpParser\Node\Stmt\Class_;
1212
use PhpParser\Node\Stmt\ClassMethod;
1313
use PhpParser\NodeVisitor;
14-
use Rector\PHPUnit\CodeQuality\Enum\NonAssertStaticableMethods;
14+
use Rector\PHPUnit\CodeQuality\NodeAnalyser\AssertMethodAnalyzer;
1515
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
1616
use Rector\Rector\AbstractRector;
1717
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -22,23 +22,9 @@
2222
*/
2323
final class PreferPHPUnitThisCallRector extends AbstractRector
2424
{
25-
// /**
26-
// * @var string[]
27-
// */
28-
// private const NON_ASSERT_STATIC_METHODS = [
29-
// 'createMock',
30-
// 'atLeast',
31-
// 'atLeastOnce',
32-
// 'once',
33-
// 'never',
34-
// 'expectException',
35-
// 'expectExceptionMessage',
36-
// 'expectExceptionCode',
37-
// 'expectExceptionMessageMatches',
38-
// ];
39-
4025
public function __construct(
4126
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
27+
private readonly AssertMethodAnalyzer $assertMethodAnalyzer
4228
) {
4329
}
4430

@@ -106,18 +92,11 @@ public function refactor(Node $node): ?Node
10692
return null;
10793
}
10894

109-
$methodName = $this->getName($node->name);
110-
if (! is_string($methodName)) {
111-
return null;
112-
}
113-
114-
if (! $this->isNames($node->class, ['static', 'self'])) {
95+
if (! $this->assertMethodAnalyzer->detectTestCaseCall($node)) {
11596
return null;
11697
}
11798

118-
if (! str_starts_with($methodName, 'assert') && ! in_array($methodName, NonAssertStaticableMethods::ALL)) {
119-
return null;
120-
}
99+
$methodName = $this->getName($node->name);
121100

122101
$hasChanged = true;
123102
return $this->nodeFactory->createMethodCall('this', $methodName, $node->getArgs());

0 commit comments

Comments
 (0)