Skip to content

Commit 265b670

Browse files
TomasVotrubaTomasVotruba
authored
[PHPUnit 12] Add CreateStubOverCreateMockArgRector (#608)
1 parent dde04a8 commit 265b670

9 files changed

Lines changed: 238 additions & 4 deletions

File tree

‎config/sets/phpunit120.php‎

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

55
use Rector\Config\RectorConfig;
6+
use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
67
use Rector\PHPUnit\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector;
78
use Rector\PHPUnit\PHPUnit120\Rector\Class_\RemoveOverrideFinalConstructTestCaseRector;
89

910
return static function (RectorConfig $rectorConfig): void {
10-
$rectorConfig->rules([RemoveOverrideFinalConstructTestCaseRector::class, AssertIsTypeMethodCallRector::class]);
11+
$rectorConfig->rules([
12+
RemoveOverrideFinalConstructTestCaseRector::class,
13+
AssertIsTypeMethodCallRector::class,
14+
15+
// stubs over mocks
16+
CreateStubOverCreateMockArgRector::class,
17+
]);
1118
};

‎rules-tests/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector/CreateStubOverCreateMockArgRectorTest.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\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class CreateStubOverCreateMockArgRectorTest 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/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector/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\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
use Utils\PHPStan\Tests\Rule\PHPUnit\StubOverMockArgRule\Source\AnyClass;
7+
8+
class HandleStaticCall extends TestCase
9+
{
10+
public function testThat()
11+
{
12+
AnyClass::staticRun(
13+
$this->createMock(\stdClass::class),
14+
);
15+
}
16+
}
17+
18+
?>
19+
-----
20+
<?php
21+
22+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture;
23+
24+
use PHPUnit\Framework\TestCase;
25+
use Utils\PHPStan\Tests\Rule\PHPUnit\StubOverMockArgRule\Source\AnyClass;
26+
27+
class HandleStaticCall extends TestCase
28+
{
29+
public function testThat()
30+
{
31+
AnyClass::staticRun(
32+
$this->createStub(\stdClass::class),
33+
);
34+
}
35+
}
36+
37+
?>

‎rules-tests/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector/Fixture/some_file_with_mocks.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\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
use Utils\PHPStan\Tests\Rule\PHPUnit\StubOverMockArgRule\Source\AnyClass;
7+
8+
class SomeFileWithMocks extends TestCase
9+
{
10+
public function testThat()
11+
{
12+
$anyClass = new AnyClass();
13+
$anyClass->run(
14+
$this->createMock(\stdClass::class),
15+
$this->createMock(\stdClass::class)
16+
);
17+
}
18+
}
19+
20+
?>
21+
-----
22+
<?php
23+
24+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture;
25+
26+
use PHPUnit\Framework\TestCase;
27+
use Utils\PHPStan\Tests\Rule\PHPUnit\StubOverMockArgRule\Source\AnyClass;
28+
29+
class SomeFileWithMocks extends TestCase
30+
{
31+
public function testThat()
32+
{
33+
$anyClass = new AnyClass();
34+
$anyClass->run(
35+
$this->createStub(\stdClass::class),
36+
$this->createStub(\stdClass::class)
37+
);
38+
}
39+
}
40+
41+
?>

‎rules-tests/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector/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\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
7+
8+
return RectorConfig::configure()
9+
->withRules([CreateStubOverCreateMockArgRector::class]);

‎rules-tests/PHPUnit60/Rector/ClassMethod/AddDoesNotPerformAssertionToNonAssertingTestRector/Fixture/skip_abstract_method.php.inc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace Rector\PHPUnit\Tests\Rector\ClassMethod\AddDoesNotPerformAssertionToNonAssertingTestRector\Fixture;
3+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\AddDoesNotPerformAssertionToNonAssertingTestRector\Fixture;
44

55
use PHPUnit\Framework\TestCase;
66

‎rules-tests/PHPUnit60/Rector/ClassMethod/AddDoesNotPerformAssertionToNonAssertingTestRector/Fixture/skip_call_expect_not_to_perform_assertions_method_call.php.inc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace Rector\PHPUnit\Tests\Rector\ClassMethod\AddDoesNotPerformAssertionToNonAssertingTestRector\Fixture;
3+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\AddDoesNotPerformAssertionToNonAssertingTestRector\Fixture;
44

55
use Rector\PHPUnit\Tests\PHPUnit60\Rector\ClassMethod\AddDoesNotPerformAssertionToNonAssertingTestRector\Source\Factory;
66

‎rules-tests/PHPUnit60/Rector/ClassMethod/AddDoesNotPerformAssertionToNonAssertingTestRector/Fixture/skip_mock_expectations.php.inc‎

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\PHPUnit\Tests\Rector\ClassMethod\AddDoesNotPerformAssertionToNonAssertingTestRector\Fixture;
5+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\ClassMethod\AddDoesNotPerformAssertionToNonAssertingTestRector\Fixture;
66

77
use PHPUnit\Framework\MockObject\MockObject;
88
use PHPUnit\Framework\TestCase;

‎rules/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector.php‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\PHPUnit120\Rector\CallLike;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Expr\MethodCall;
9+
use PhpParser\Node\Expr\New_;
10+
use PhpParser\Node\Expr\StaticCall;
11+
use PhpParser\Node\Identifier;
12+
use Rector\PHPStan\ScopeFetcher;
13+
use Rector\PHPUnit\Enum\PHPUnitClassName;
14+
use Rector\Rector\AbstractRector;
15+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
16+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
17+
18+
/**
19+
* Related change in PHPUnit 12 https://phpunit.expert/articles/testing-with-and-without-dependencies.html
20+
*
21+
* @see \Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\CreateStubOverCreateMockArgRectorTest
22+
*/
23+
final class CreateStubOverCreateMockArgRector extends AbstractRector
24+
{
25+
public function getRuleDefinition(): RuleDefinition
26+
{
27+
return new RuleDefinition(
28+
'Use createStub() over createMock() when used as argument and does not add any mock requirements',
29+
[
30+
new CodeSample(
31+
<<<'CODE_SAMPLE'
32+
use PHPUnit\Framework\TestCase;
33+
final class SomeTest extends TestCase
34+
{
35+
public function test()
36+
{
37+
$this->someMethod($this->createMock(SomeClass::class));
38+
}
39+
40+
private function someMethod($someClass)
41+
{
42+
}
43+
}
44+
CODE_SAMPLE
45+
,
46+
<<<'CODE_SAMPLE'
47+
use PHPUnit\Framework\TestCase;
48+
49+
final class SomeTest extends TestCase
50+
{
51+
public function test()
52+
{
53+
$this->someMethod($this->createStub(SomeClass::class));
54+
}
55+
56+
private function someMethod($someClass)
57+
{
58+
}
59+
}
60+
CODE_SAMPLE
61+
),
62+
63+
]
64+
);
65+
}
66+
67+
/**
68+
* @return array<class-string<Node>>
69+
*/
70+
public function getNodeTypes(): array
71+
{
72+
return [StaticCall::class, MethodCall::class, New_::class];
73+
}
74+
75+
/**
76+
* @param MethodCall|StaticCall|New_ $node
77+
*/
78+
public function refactor(Node $node): MethodCall|StaticCall|New_|null
79+
{
80+
$scope = ScopeFetcher::fetch($node);
81+
if (! $scope->isInClass()) {
82+
return null;
83+
}
84+
85+
$classReflection = $scope->getClassReflection();
86+
if (! $classReflection->is(PHPUnitClassName::TEST_CASE)) {
87+
return null;
88+
}
89+
90+
$hasChanges = false;
91+
92+
foreach ($node->getArgs() as $arg) {
93+
if (! $arg->value instanceof MethodCall) {
94+
continue;
95+
}
96+
97+
$methodCall = $arg->value;
98+
if (! $this->isName($methodCall->name, 'createMock')) {
99+
continue;
100+
}
101+
102+
$methodCall->name = new Identifier('createStub');
103+
$hasChanges = true;
104+
}
105+
106+
if ($hasChanges) {
107+
return $node;
108+
}
109+
110+
return null;
111+
}
112+
}

0 commit comments

Comments
 (0)