Skip to content

Commit a1dc81d

Browse files
authored
[PHPUnit120] Add MockObjectVarToStubRector (#689)
* [PHPUnit120] Add MockObjectVarToStubRector to update @var docblock when property changed to Stub * Restrict MockObjectVarToStubRector to PHPUnit TestCase scope, add skip fixture
1 parent 2f1c4bc commit a1dc81d

10 files changed

Lines changed: 302 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
@@ -57,6 +57,7 @@
5757
use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
5858
use Rector\PHPUnit\PHPUnit120\Rector\Class_\PropertyCreateMockToCreateStubRector;
5959
use Rector\PHPUnit\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector;
60+
use Rector\PHPUnit\PHPUnit120\Rector\Property\MockObjectVarToStubRector;
6061
use Rector\PHPUnit\PHPUnit60\Rector\MethodCall\GetMockBuilderGetMockToCreateMockRector;
6162
use Rector\PHPUnit\PHPUnit90\Rector\MethodCall\ReplaceAtMethodWithDesiredMatcherRector;
6263
use Rector\Privatization\Rector\Class_\FinalizeTestCaseClassRector;
@@ -136,6 +137,7 @@
136137
CreateStubOverCreateMockArgRector::class,
137138
ExpressionCreateMockToCreateStubRector::class,
138139
PropertyCreateMockToCreateStubRector::class,
140+
MockObjectVarToStubRector::class,
139141
InlineStubPropertyToCreateStubMethodCallRector::class,
140142

141143
// @test first, enable later

‎config/sets/phpunit-mock-to-stub.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
88
use Rector\PHPUnit\PHPUnit120\Rector\Class_\PropertyCreateMockToCreateStubRector;
99
use Rector\PHPUnit\PHPUnit120\Rector\ClassMethod\ExpressionCreateMockToCreateStubRector;
10+
use Rector\PHPUnit\PHPUnit120\Rector\Property\MockObjectVarToStubRector;
1011

1112
return static function (RectorConfig $rectorConfig): void {
1213
$rectorConfig->rules([
@@ -15,5 +16,6 @@
1516
CreateStubInCoalesceArgRector::class,
1617
ExpressionCreateMockToCreateStubRector::class,
1718
PropertyCreateMockToCreateStubRector::class,
19+
MockObjectVarToStubRector::class,
1820
]);
1921
};
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\MockObjectVarToStubRector\Fixture;
4+
5+
use PHPUnit\Framework\MockObject\MockObject;
6+
use PHPUnit\Framework\TestCase;
7+
8+
final class IntersectionTypeTest extends TestCase
9+
{
10+
/**
11+
* @var FieldModel&MockObject
12+
*/
13+
private \PHPUnit\Framework\MockObject\Stub $leadFieldModel;
14+
}
15+
16+
?>
17+
-----
18+
<?php
19+
20+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\MockObjectVarToStubRector\Fixture;
21+
22+
use PHPUnit\Framework\MockObject\MockObject;
23+
use PHPUnit\Framework\TestCase;
24+
25+
final class IntersectionTypeTest extends TestCase
26+
{
27+
/**
28+
* @var FieldModel&Stub
29+
*/
30+
private \PHPUnit\Framework\MockObject\Stub $leadFieldModel;
31+
}
32+
33+
?>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\MockObjectVarToStubRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
final class SkipNoMockObjectTest extends TestCase
8+
{
9+
/**
10+
* @var FieldModel
11+
*/
12+
private \PHPUnit\Framework\MockObject\Stub $leadFieldModel;
13+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\MockObjectVarToStubRector\Fixture;
4+
5+
use PHPUnit\Framework\MockObject\MockObject;
6+
use PHPUnit\Framework\TestCase;
7+
8+
final class SkipNonStubNativeTypeTest extends TestCase
9+
{
10+
/**
11+
* @var FieldModel|MockObject
12+
*/
13+
private \PHPUnit\Framework\MockObject\MockObject $leadFieldModel;
14+
}
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\MockObjectVarToStubRector\Fixture;
4+
5+
final class SkipNonTestClass
6+
{
7+
/**
8+
* @var FieldModel|MockObject
9+
*/
10+
private \PHPUnit\Framework\MockObject\Stub $leadFieldModel;
11+
}
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\MockObjectVarToStubRector\Fixture;
4+
5+
use PHPUnit\Framework\MockObject\MockObject;
6+
use PHPUnit\Framework\TestCase;
7+
8+
final class UnionTypeTest extends TestCase
9+
{
10+
/**
11+
* @var FieldModel|MockObject
12+
*/
13+
private \PHPUnit\Framework\MockObject\Stub $leadFieldModel;
14+
}
15+
16+
?>
17+
-----
18+
<?php
19+
20+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\MockObjectVarToStubRector\Fixture;
21+
22+
use PHPUnit\Framework\MockObject\MockObject;
23+
use PHPUnit\Framework\TestCase;
24+
25+
final class UnionTypeTest extends TestCase
26+
{
27+
/**
28+
* @var FieldModel|Stub
29+
*/
30+
private \PHPUnit\Framework\MockObject\Stub $leadFieldModel;
31+
}
32+
33+
?>
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\Property\MockObjectVarToStubRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class MockObjectVarToStubRectorTest 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+
}
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\Property\MockObjectVarToStubRector;
7+
8+
return RectorConfig::configure()
9+
->withRules(rules: [MockObjectVarToStubRector::class]);
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\PHPUnit120\Rector\Property;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Identifier;
9+
use PhpParser\Node\IntersectionType;
10+
use PhpParser\Node\Name;
11+
use PhpParser\Node\Stmt\Property;
12+
use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
13+
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
14+
use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
15+
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
16+
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
17+
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
18+
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
19+
use Rector\PHPUnit\Enum\PHPUnitClassName;
20+
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
21+
use Rector\Rector\AbstractRector;
22+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
23+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
24+
25+
/**
26+
* @see \Rector\PHPUnit\Tests\PHPUnit120\Rector\Property\MockObjectVarToStubRector\MockObjectVarToStubRectorTest
27+
*/
28+
final class MockObjectVarToStubRector extends AbstractRector
29+
{
30+
public function __construct(
31+
private readonly PhpDocInfoFactory $phpDocInfoFactory,
32+
private readonly DocBlockUpdater $docBlockUpdater,
33+
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
34+
) {
35+
}
36+
37+
public function getNodeTypes(): array
38+
{
39+
return [Property::class];
40+
}
41+
42+
/**
43+
* @param Property $node
44+
*/
45+
public function refactor(Node $node): ?Property
46+
{
47+
// only inside PHPUnit TestCase scope
48+
if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
49+
return null;
50+
}
51+
52+
// only properties already converted to a Stub native type
53+
if (! $this->isStubNativeType($node->type)) {
54+
return null;
55+
}
56+
57+
$phpDocInfo = $this->phpDocInfoFactory->createFromNode($node);
58+
if (! $phpDocInfo instanceof PhpDocInfo) {
59+
return null;
60+
}
61+
62+
$varTagValueNode = $phpDocInfo->getVarTagValueNode();
63+
if (! $varTagValueNode instanceof VarTagValueNode) {
64+
return null;
65+
}
66+
67+
if (! $this->replaceMockObjectWithStub($varTagValueNode)) {
68+
return null;
69+
}
70+
71+
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
72+
73+
return $node;
74+
}
75+
76+
public function getRuleDefinition(): RuleDefinition
77+
{
78+
return new RuleDefinition(
79+
'Update the @var docblock of a property changed to a Stub native type, from MockObject to Stub',
80+
[
81+
new CodeSample(
82+
<<<'CODE_SAMPLE'
83+
/**
84+
* @var FieldModel|MockObject
85+
*/
86+
private \PHPUnit\Framework\MockObject\Stub $leadFieldModel;
87+
CODE_SAMPLE
88+
,
89+
<<<'CODE_SAMPLE'
90+
/**
91+
* @var FieldModel|Stub
92+
*/
93+
private \PHPUnit\Framework\MockObject\Stub $leadFieldModel;
94+
CODE_SAMPLE
95+
),
96+
]
97+
);
98+
}
99+
100+
private function isStubNativeType(?Node $typeNode): bool
101+
{
102+
if ($typeNode instanceof IntersectionType) {
103+
return array_any($typeNode->types, fn (Identifier|Name $innerType): bool => $this->isStubName($innerType));
104+
}
105+
106+
return $this->isStubName($typeNode);
107+
}
108+
109+
private function isStubName(?Node $node): bool
110+
{
111+
return $node instanceof Node && $this->getName($node) === PHPUnitClassName::STUB;
112+
}
113+
114+
private function replaceMockObjectWithStub(VarTagValueNode $varTagValueNode): bool
115+
{
116+
$typeNode = $varTagValueNode->type;
117+
118+
// fresh nodes (without original token positions) are re-printed, mutating in place is not
119+
if ($typeNode instanceof UnionTypeNode || $typeNode instanceof IntersectionTypeNode) {
120+
$hasChanged = false;
121+
foreach ($typeNode->types as $key => $innerType) {
122+
if ($innerType instanceof IdentifierTypeNode && $this->isMockObjectIdentifier($innerType)) {
123+
$typeNode->types[$key] = new IdentifierTypeNode($this->resolveStubName($innerType->name));
124+
$hasChanged = true;
125+
}
126+
}
127+
128+
return $hasChanged;
129+
}
130+
131+
if ($typeNode instanceof IdentifierTypeNode && $this->isMockObjectIdentifier($typeNode)) {
132+
$varTagValueNode->type = new IdentifierTypeNode($this->resolveStubName($typeNode->name));
133+
return true;
134+
}
135+
136+
return false;
137+
}
138+
139+
private function isMockObjectIdentifier(IdentifierTypeNode $identifierTypeNode): bool
140+
{
141+
$lastBackslashPosition = strrpos($identifierTypeNode->name, '\\');
142+
$shortName = $lastBackslashPosition === false
143+
? $identifierTypeNode->name
144+
: substr($identifierTypeNode->name, $lastBackslashPosition + 1);
145+
146+
return $shortName === 'MockObject';
147+
}
148+
149+
private function resolveStubName(string $name): string
150+
{
151+
$lastBackslashPosition = strrpos($name, '\\');
152+
153+
return $lastBackslashPosition === false
154+
? 'Stub'
155+
: substr($name, 0, $lastBackslashPosition + 1) . 'Stub';
156+
}
157+
}

0 commit comments

Comments
 (0)