Skip to content

Commit ce0d4e5

Browse files
TomasVotrubaactions-user
TomasVotruba
and
actions-user
authored
[code-quality] Add SimplerWithIsInstanceOfRector (#577)
* [code-quality] Add SimplerWithIstInstanceOfRector * register rule * [ci-review] Rector Rectify --------- Co-authored-by: GitHub Action <actions@github.com>
1 parent da50241 commit ce0d4e5

8 files changed

Lines changed: 342 additions & 0 deletions

File tree

‎config/sets/phpunit-code-quality.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
use Rector\PHPUnit\CodeQuality\Rector\MethodCall\NarrowSingleWillReturnCallbackRector;
4343
use Rector\PHPUnit\CodeQuality\Rector\MethodCall\RemoveExpectAnyFromMockRector;
4444
use Rector\PHPUnit\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector;
45+
use Rector\PHPUnit\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector;
4546
use Rector\PHPUnit\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector;
4647
use Rector\PHPUnit\CodeQuality\Rector\MethodCall\StringCastAssertStringContainsStringRector;
4748
use Rector\PHPUnit\CodeQuality\Rector\MethodCall\UseSpecificWillMethodRector;
@@ -120,6 +121,7 @@
120121
*/
121122
RemoveExpectAnyFromMockRector::class,
122123
SingleMockPropertyTypeRector::class,
124+
SimplerWithIsInstanceOfRector::class,
123125

124126
FinalizeTestCaseClassRector::class,
125127
DeclareStrictTypesTestsRector::class,

‎rules-tests/CodeQuality/Rector/MethodCall/SimplerWithIsInstanceOfRector/Fixture/separated_lines.php.inc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
final class SeparatedLines extends TestCase
8+
{
9+
public function test()
10+
{
11+
$someMock = $this->getMockBuilder('AnyType')->getMock();
12+
13+
$someMock->expects($this->any())
14+
->method('trans')
15+
->with($this->callback(function ($args): bool {
16+
$this->assertInstanceOf(\stdClass::class, $args);
17+
return true;
18+
}));
19+
}
20+
}
21+
22+
?>
23+
-----
24+
<?php
25+
26+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector\Fixture;
27+
28+
use PHPUnit\Framework\TestCase;
29+
30+
final class SeparatedLines extends TestCase
31+
{
32+
public function test()
33+
{
34+
$someMock = $this->getMockBuilder('AnyType')->getMock();
35+
36+
$someMock->expects($this->any())
37+
->method('trans')
38+
->with($this->isInstanceOf(\stdClass::class));
39+
}
40+
}
41+
42+
?>

‎rules-tests/CodeQuality/Rector/MethodCall/SimplerWithIsInstanceOfRector/Fixture/skip_different_assert.php.inc‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
final class SkipDifferentAssert extends TestCase
8+
{
9+
public function test()
10+
{
11+
$someMock = $this->getMockBuilder('AnyType')->getMock();
12+
13+
$someMock->expects($this->any())
14+
->method('trans')
15+
->with($this->callback(function ($args): bool {
16+
$this->assertCount(50, $args);
17+
return true;
18+
}));
19+
}
20+
}

‎rules-tests/CodeQuality/Rector/MethodCall/SimplerWithIsInstanceOfRector/Fixture/skip_multiple_lines.php.inc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
final class SkipMultipleLines extends TestCase
8+
{
9+
public function test()
10+
{
11+
$someMock = $this->getMockBuilder('AnyType')->getMock();
12+
13+
$someMock->expects($this->any())
14+
->method('trans')
15+
->with($this->callback(function ($args): bool {
16+
$this->assertCount(1, (array) $args);
17+
18+
return $args instanceof \stdClass;
19+
}));
20+
}
21+
}

‎rules-tests/CodeQuality/Rector/MethodCall/SimplerWithIsInstanceOfRector/Fixture/some_file.php.inc‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
final class SomeFile extends TestCase
8+
{
9+
public function test()
10+
{
11+
$someMock = $this->getMockBuilder('AnyType')->getMock();
12+
13+
$someMock->expects($this->any())
14+
->method('trans')
15+
->with($this->callback(function ($args): bool {
16+
return $args instanceof \stdClass;
17+
}));
18+
}
19+
}
20+
21+
?>
22+
-----
23+
<?php
24+
25+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector\Fixture;
26+
27+
use PHPUnit\Framework\TestCase;
28+
29+
final class SomeFile extends TestCase
30+
{
31+
public function test()
32+
{
33+
$someMock = $this->getMockBuilder('AnyType')->getMock();
34+
35+
$someMock->expects($this->any())
36+
->method('trans')
37+
->with($this->isInstanceOf(\stdClass::class));
38+
}
39+
}
40+
41+
?>

‎rules-tests/CodeQuality/Rector/MethodCall/SimplerWithIsInstanceOfRector/SimplerWithIsInstanceOfRectorTest.php‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class SimplerWithIsInstanceOfRectorTest extends AbstractRectorTestCase
12+
{
13+
#[DataProvider('provideData')]
14+
public function test(string $filePath): void
15+
{
16+
$this->doTestFile($filePath);
17+
}
18+
19+
public static function provideData(): Iterator
20+
{
21+
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
22+
}
23+
24+
public function provideConfigFilePath(): string
25+
{
26+
return __DIR__ . '/config/configured_rule.php';
27+
}
28+
}

‎rules-tests/CodeQuality/Rector/MethodCall/SimplerWithIsInstanceOfRector/config/configured_rule.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
use Rector\PHPUnit\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector;
7+
8+
return static function (RectorConfig $rectorConfig): void {
9+
$rectorConfig->rule(SimplerWithIsInstanceOfRector::class);
10+
};

‎rules/CodeQuality/Rector/MethodCall/SimplerWithIsInstanceOfRector.php‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\CodeQuality\Rector\MethodCall;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Arg;
9+
use PhpParser\Node\Expr;
10+
use PhpParser\Node\Expr\Closure;
11+
use PhpParser\Node\Expr\Instanceof_;
12+
use PhpParser\Node\Expr\MethodCall;
13+
use PhpParser\Node\Name;
14+
use PhpParser\Node\Stmt\Expression;
15+
use PhpParser\Node\Stmt\Return_;
16+
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
17+
use Rector\Rector\AbstractRector;
18+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
19+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
20+
21+
/**
22+
* @see \Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SimplerWithIsInstanceOfRector\SimplerWithIsInstanceOfRectorTest
23+
*/
24+
final class SimplerWithIsInstanceOfRector extends AbstractRector
25+
{
26+
public function __construct(
27+
private readonly TestsNodeAnalyzer $testsNodeAnalyzer
28+
) {
29+
}
30+
31+
public function getRuleDefinition(): RuleDefinition
32+
{
33+
return new RuleDefinition(
34+
'Replaces use of with, callable and instance assert to simple isInstanceOf() method',
35+
[
36+
new CodeSample(
37+
<<<'CODE_SAMPLE'
38+
use PHPUnit\Framework\TestCase
39+
40+
final class SomeClass extends TestCase
41+
{
42+
public function test()
43+
{
44+
$someMock = $this->createMock(SomeClass::class)
45+
->method('someMethod')
46+
->with($this->callable(function ($arg): bool {
47+
return $arg instanceof SomeType;
48+
}));
49+
}
50+
}
51+
CODE_SAMPLE
52+
,
53+
<<<'CODE_SAMPLE'
54+
use PHPUnit\Framework\TestCase;
55+
56+
final class SomeClass extends TestCase
57+
{
58+
public function test()
59+
{
60+
$someMock = $this->createMock(SomeClass::class)
61+
->method('someMethod')
62+
->with($this->isInstanceOf(SomeType::class));
63+
}
64+
}
65+
CODE_SAMPLE
66+
),
67+
]
68+
);
69+
}
70+
71+
public function getNodeTypes(): array
72+
{
73+
return [MethodCall::class];
74+
}
75+
76+
/**
77+
* @param MethodCall $node
78+
*/
79+
public function refactor(Node $node): MethodCall|null
80+
{
81+
if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
82+
return null;
83+
}
84+
85+
if ($node->isFirstClassCallable()) {
86+
return null;
87+
}
88+
89+
if (! $this->isName($node->name, 'with')) {
90+
return null;
91+
}
92+
93+
$withFirstArgValue = $node->getArgs()[0]
94+
->value;
95+
if (! $withFirstArgValue instanceof MethodCall || ! $this->isName($withFirstArgValue->name, 'callback')) {
96+
return null;
97+
}
98+
99+
$callableMethodCall = $withFirstArgValue;
100+
$callableFirstArgValue = $callableMethodCall->getArgs()[0]
101+
->value;
102+
103+
$innerClosure = $callableFirstArgValue;
104+
if (! $innerClosure instanceof Closure) {
105+
return null;
106+
}
107+
108+
$instanceCheckedClassName = $this->matchSoleInstanceofCheckClassName($innerClosure);
109+
110+
if (! $instanceCheckedClassName instanceof Node) {
111+
return null;
112+
}
113+
114+
// convert name to expr
115+
if ($instanceCheckedClassName instanceof Name) {
116+
$instanceCheckedClassName = $this->nodeFactory->createClassConstFetch(
117+
$instanceCheckedClassName->toString(),
118+
'class'
119+
);
120+
}
121+
122+
$node->args = [
123+
new Arg($this->nodeFactory->createMethodCall('this', 'isInstanceOf', [$instanceCheckedClassName])),
124+
];
125+
126+
return $node;
127+
}
128+
129+
private function matchSoleInstanceofCheckClassName(Closure $innerClosure): Node|null|Expr|Name
130+
{
131+
// return + instancecheck only
132+
$innerClosureStmts = $innerClosure->getStmts();
133+
if (count($innerClosureStmts) === 2) {
134+
if (! $innerClosureStmts[1] instanceof Return_) {
135+
return null;
136+
}
137+
138+
$firstStmt = $innerClosureStmts[0];
139+
if (! $firstStmt instanceof Expression) {
140+
return null;
141+
}
142+
143+
$firstStmtExpr = $firstStmt->expr;
144+
if (! $firstStmtExpr instanceof MethodCall) {
145+
return null;
146+
}
147+
148+
if (! $this->isName($firstStmtExpr->name, 'assertInstanceOf')) {
149+
return null;
150+
}
151+
152+
return $firstStmtExpr->getArgs()[0]
153+
->value;
154+
}
155+
156+
if (count($innerClosureStmts) === 1) {
157+
$onlyStmt = $innerClosureStmts[0];
158+
if (! $onlyStmt instanceof Return_) {
159+
return null;
160+
}
161+
162+
$returnExpr = $onlyStmt->expr;
163+
if (! $returnExpr instanceof Instanceof_) {
164+
return null;
165+
}
166+
167+
$instanceofExpr = $returnExpr;
168+
if (! $instanceofExpr->class instanceof Name) {
169+
return null;
170+
}
171+
172+
return $instanceofExpr->class;
173+
}
174+
175+
return null;
176+
177+
}
178+
}

0 commit comments

Comments
 (0)