Skip to content

Commit 6bc82f2

Browse files
TomasVotrubaTomasVotruba
authored
[code-quality] Add DirectInstanceOverMockArgRector (#609)
* [code-quality] Add DirectInstanceOverMockArgRector * add array item support to CreateStubOverCreateMockArgRector
1 parent 265b670 commit 6bc82f2

11 files changed

Lines changed: 365 additions & 4 deletions

File tree

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

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

55
use Rector\Config\RectorConfig;
6+
use Rector\PHPUnit\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector;
67
use Rector\PHPUnit\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector;
78
use Rector\PHPUnit\CodeQuality\Rector\Class_\AddReturnTypeToDependedRector;
89
use Rector\PHPUnit\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector;
@@ -120,6 +121,7 @@
120121
RemoveExpectAnyFromMockRector::class,
121122
SingleMockPropertyTypeRector::class,
122123
SimplerWithIsInstanceOfRector::class,
124+
DirectInstanceOverMockArgRector::class,
123125

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

‎rules-tests/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector/DirectInstanceOverMockArgRectorTest.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\CallLike\DirectInstanceOverMockArgRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class DirectInstanceOverMockArgRectorTest 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/CallLike/DirectInstanceOverMockArgRector/Fixture/handle_array_item.php.inc‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
use Symfony\Component\HttpFoundation\Request;
7+
8+
final class HandleArrayItem extends TestCase
9+
{
10+
public function testThat()
11+
{
12+
$args = [
13+
$this->createMock(Request::class),
14+
];
15+
}
16+
}
17+
18+
?>
19+
-----
20+
<?php
21+
22+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture;
23+
24+
use PHPUnit\Framework\TestCase;
25+
use Symfony\Component\HttpFoundation\Request;
26+
27+
final class HandleArrayItem extends TestCase
28+
{
29+
public function testThat()
30+
{
31+
$args = [
32+
new \Symfony\Component\HttpFoundation\Request(),
33+
];
34+
}
35+
}
36+
37+
?>

‎rules-tests/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector/Fixture/handle_static_call.php.inc‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
use Symfony\Component\HttpFoundation\Request;
7+
8+
final class HandleStaticCall extends TestCase
9+
{
10+
public function testThat()
11+
{
12+
AnyClass::staticRun(
13+
$this->createMock(Request::class),
14+
);
15+
}
16+
}
17+
18+
?>
19+
-----
20+
<?php
21+
22+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture;
23+
24+
use PHPUnit\Framework\TestCase;
25+
use Symfony\Component\HttpFoundation\Request;
26+
27+
final class HandleStaticCall extends TestCase
28+
{
29+
public function testThat()
30+
{
31+
AnyClass::staticRun(
32+
new \Symfony\Component\HttpFoundation\Request(),
33+
);
34+
}
35+
}
36+
37+
?>

‎rules-tests/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector/Fixture/skip_another_object.php.inc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
use Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Source\AnotherObject;
7+
use Symfony\Component\HttpFoundation\Request;
8+
9+
final class SkipAnotherObject extends TestCase
10+
{
11+
public function testThat()
12+
{
13+
AnyClass::staticRun(
14+
$this->createMock(AnotherObject::class),
15+
);
16+
}
17+
}

‎rules-tests/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector/Source/AnotherObject.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Source;
4+
5+
final class AnotherObject
6+
{
7+
8+
}

‎rules-tests/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector/config/configured_rule.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
use Rector\PHPUnit\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector;
7+
8+
return RectorConfig::configure()
9+
->withRules([DirectInstanceOverMockArgRector::class]);

‎rules-tests/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector/Fixture/handle_array_item.php.inc‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
final class HandleArrayItem extends TestCase
8+
{
9+
public function testThat()
10+
{
11+
$items = [
12+
$this->createMock(\stdClass::class),
13+
];
14+
}
15+
}
16+
17+
?>
18+
-----
19+
<?php
20+
21+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture;
22+
23+
use PHPUnit\Framework\TestCase;
24+
25+
final class HandleArrayItem extends TestCase
26+
{
27+
public function testThat()
28+
{
29+
$items = [
30+
$this->createStub(\stdClass::class),
31+
];
32+
}
33+
}
34+
35+
?>

‎rules/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector.php‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\CodeQuality\Rector\CallLike;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Arg;
9+
use PhpParser\Node\ArrayItem;
10+
use PhpParser\Node\Expr;
11+
use PhpParser\Node\Expr\MethodCall;
12+
use PhpParser\Node\Expr\New_;
13+
use PhpParser\Node\Expr\StaticCall;
14+
use PhpParser\Node\Name\FullyQualified;
15+
use Rector\PhpParser\Node\Value\ValueResolver;
16+
use Rector\PHPStan\ScopeFetcher;
17+
use Rector\PHPUnit\Enum\PHPUnitClassName;
18+
use Rector\Rector\AbstractRector;
19+
use Rector\Symfony\Enum\SymfonyClass;
20+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
21+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
22+
23+
/**
24+
* @see \Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\DirectInstanceOverMockArgRectorTest
25+
*/
26+
final class DirectInstanceOverMockArgRector extends AbstractRector
27+
{
28+
public function __construct(
29+
private readonly ValueResolver $valueResolver
30+
) {
31+
}
32+
33+
public function getRuleDefinition(): RuleDefinition
34+
{
35+
return new RuleDefinition(
36+
'Use direct object instance over mock for specific objects in arg of PHPUnit tests',
37+
[
38+
new CodeSample(
39+
<<<'CODE_SAMPLE'
40+
use PHPUnit\Framework\TestCase;
41+
use Symfony\Component\HttpFoundation\Request;
42+
43+
final class SomeTest extends TestCase
44+
{
45+
public function test()
46+
{
47+
$this->someMethod($this->createMock(Request::class));
48+
}
49+
50+
private function someMethod($someClass)
51+
{
52+
}
53+
}
54+
CODE_SAMPLE
55+
,
56+
<<<'CODE_SAMPLE'
57+
use PHPUnit\Framework\TestCase;
58+
use Symfony\Component\HttpFoundation\Request;
59+
60+
final class SomeTest extends TestCase
61+
{
62+
public function test()
63+
{
64+
$this->someMethod(new Request());
65+
}
66+
67+
private function someMethod($someClass)
68+
{
69+
}
70+
}
71+
CODE_SAMPLE
72+
),
73+
74+
]
75+
);
76+
}
77+
78+
/**
79+
* @return array<class-string<Node>>
80+
*/
81+
public function getNodeTypes(): array
82+
{
83+
return [StaticCall::class, MethodCall::class, New_::class, ArrayItem::class];
84+
}
85+
86+
/**
87+
* @param MethodCall|StaticCall|New_|ArrayItem $node
88+
*/
89+
public function refactor(Node $node): MethodCall|StaticCall|New_|ArrayItem|null
90+
{
91+
$scope = ScopeFetcher::fetch($node);
92+
if (! $scope->isInClass()) {
93+
return null;
94+
}
95+
96+
$classReflection = $scope->getClassReflection();
97+
if (! $classReflection->is(PHPUnitClassName::TEST_CASE)) {
98+
return null;
99+
}
100+
101+
$hasChanged = false;
102+
103+
if ($node instanceof ArrayItem) {
104+
105+
return $this->refactorArrayItem($node);
106+
}
107+
108+
foreach ($node->getArgs() as $arg) {
109+
$firstArg = $this->matchCreateMockMethodCallArg($arg->value);
110+
if (! $firstArg instanceof Arg) {
111+
continue;
112+
}
113+
114+
$className = $this->valueResolver->getValue($firstArg->value);
115+
if (! in_array($className, [SymfonyClass::REQUEST, SymfonyClass::REQUEST_STACK])) {
116+
continue;
117+
}
118+
119+
$arg->value = new New_(new FullyQualified($className));
120+
$hasChanged = true;
121+
}
122+
123+
if ($hasChanged) {
124+
return $node;
125+
}
126+
127+
return null;
128+
}
129+
130+
private function matchCreateMockMethodCallArg(Expr $expr): ?Arg
131+
{
132+
if (! $expr instanceof MethodCall) {
133+
return null;
134+
}
135+
136+
$methodCall = $expr;
137+
if (! $this->isName($methodCall->name, 'createMock')) {
138+
return null;
139+
}
140+
141+
if ($methodCall->isFirstClassCallable()) {
142+
return null;
143+
}
144+
145+
return $methodCall->getArgs()[0];
146+
}
147+
148+
private function refactorArrayItem(ArrayItem $arrayItem): ?ArrayItem
149+
{
150+
$mockedCallArg = $this->matchCreateMockMethodCallArg($arrayItem->value);
151+
if (! $mockedCallArg instanceof Arg) {
152+
return null;
153+
}
154+
155+
$className = $this->valueResolver->getValue($mockedCallArg->value);
156+
157+
if (! in_array($className, [SymfonyClass::REQUEST, SymfonyClass::REQUEST_STACK])) {
158+
return null;
159+
}
160+
161+
$arrayItem->value = new New_(new FullyQualified($className));
162+
163+
return $arrayItem;
164+
}
165+
}

0 commit comments

Comments
 (0)