|
| 1 | +<?php |
| 2 | + |
| 3 | +declare (strict_types=1); |
| 4 | +namespace Rector\PHPUnit\CodeQuality\Rector\Class_; |
| 5 | + |
| 6 | +use PhpParser\Node; |
| 7 | +use PhpParser\Node\Expr\Assign; |
| 8 | +use PhpParser\Node\Expr\MethodCall; |
| 9 | +use PhpParser\Node\Expr\PropertyFetch; |
| 10 | +use PhpParser\Node\Stmt\Class_; |
| 11 | +use PhpParser\Node\Stmt\ClassMethod; |
| 12 | +use PhpParser\Node\Stmt\Expression; |
| 13 | +use PhpParser\Node\Stmt\Property; |
| 14 | +use Rector\PHPUnit\CodeQuality\NodeAnalyser\MockObjectExprDetector; |
| 15 | +use Rector\PHPUnit\CodeQuality\NodeAnalyser\MockObjectPropertyDetector; |
| 16 | +use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer; |
| 17 | +use Rector\Rector\AbstractRector; |
| 18 | +use Rector\ValueObject\MethodName; |
| 19 | +use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; |
| 20 | +use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; |
| 21 | +/** |
| 22 | + * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveNeverUsedMockPropertyRector\RemoveNeverUsedMockPropertyRectorTest |
| 23 | + */ |
| 24 | +final class RemoveNeverUsedMockPropertyRector extends AbstractRector |
| 25 | +{ |
| 26 | + /** |
| 27 | + * @readonly |
| 28 | + */ |
| 29 | + private TestsNodeAnalyzer $testsNodeAnalyzer; |
| 30 | + /** |
| 31 | + * @readonly |
| 32 | + */ |
| 33 | + private MockObjectPropertyDetector $mockObjectPropertyDetector; |
| 34 | + /** |
| 35 | + * @readonly |
| 36 | + */ |
| 37 | + private MockObjectExprDetector $mockObjectExprDetector; |
| 38 | + public function __construct(TestsNodeAnalyzer $testsNodeAnalyzer, MockObjectPropertyDetector $mockObjectPropertyDetector, MockObjectExprDetector $mockObjectExprDetector) |
| 39 | + { |
| 40 | + $this->testsNodeAnalyzer = $testsNodeAnalyzer; |
| 41 | + $this->mockObjectPropertyDetector = $mockObjectPropertyDetector; |
| 42 | + $this->mockObjectExprDetector = $mockObjectExprDetector; |
| 43 | + } |
| 44 | + public function getRuleDefinition(): RuleDefinition |
| 45 | + { |
| 46 | + return new RuleDefinition('Remove never used property mock, only to set expectations', [new CodeSample(<<<'CODE_SAMPLE' |
| 47 | +use PHPUnit\Framework\TestCase; |
| 48 | +
|
| 49 | +final class SomeTest extends TestCase |
| 50 | +{ |
| 51 | + private $mockProperty = null; |
| 52 | +
|
| 53 | + protected function setUp(): void |
| 54 | + { |
| 55 | + $this->mockProperty = $this->createMock(SomeClass::class); |
| 56 | + $this->mockProperty->expects($this->once()) |
| 57 | + ->method('someMethod') |
| 58 | + ->willReturn('someValue'); |
| 59 | + } |
| 60 | +} |
| 61 | +CODE_SAMPLE |
| 62 | +, <<<'CODE_SAMPLE' |
| 63 | +use PHPUnit\Framework\TestCase; |
| 64 | +
|
| 65 | +final class SomeTest extends TestCase |
| 66 | +{ |
| 67 | + protected function setUp(): void |
| 68 | + { |
| 69 | + } |
| 70 | +} |
| 71 | +CODE_SAMPLE |
| 72 | +)]); |
| 73 | + } |
| 74 | + /** |
| 75 | + * @return array<class-string<Node>> |
| 76 | + */ |
| 77 | + public function getNodeTypes(): array |
| 78 | + { |
| 79 | + return [Class_::class]; |
| 80 | + } |
| 81 | + /** |
| 82 | + * @param Class_ $node |
| 83 | + */ |
| 84 | + public function refactor(Node $node): ?Node |
| 85 | + { |
| 86 | + if (!$this->testsNodeAnalyzer->isInTestClass($node)) { |
| 87 | + return null; |
| 88 | + } |
| 89 | + $setUpClassMethod = $node->getMethod(MethodName::SET_UP); |
| 90 | + if (!$setUpClassMethod instanceof ClassMethod) { |
| 91 | + return null; |
| 92 | + } |
| 93 | + $propertyNamesToCreateMockMethodCalls = $this->mockObjectPropertyDetector->collectFromClassMethod($setUpClassMethod); |
| 94 | + if ($propertyNamesToCreateMockMethodCalls === []) { |
| 95 | + return null; |
| 96 | + } |
| 97 | + $propertyNamesToRemove = []; |
| 98 | + foreach (array_keys($propertyNamesToCreateMockMethodCalls) as $propertyName) { |
| 99 | + if ($this->mockObjectExprDetector->isPropertyMockObjectPassedAsArgument($node, $propertyName)) { |
| 100 | + continue; |
| 101 | + } |
| 102 | + $propertyNamesToRemove[] = $propertyName; |
| 103 | + } |
| 104 | + if ($propertyNamesToRemove === []) { |
| 105 | + return null; |
| 106 | + } |
| 107 | + // remove never used mock properties |
| 108 | + foreach ($propertyNamesToRemove as $propertyNameToRemove) { |
| 109 | + // 1. remove property |
| 110 | + $this->removePropertyFromClass($node, $propertyNameToRemove); |
| 111 | + // 2. remove assign from setUp() |
| 112 | + $this->removeMockPropertyFromSetUpMethod($setUpClassMethod, $propertyNameToRemove); |
| 113 | + // 3. remove expression method calls on this property |
| 114 | + foreach ($node->getMethods() as $classMethod) { |
| 115 | + foreach ((array) $classMethod->stmts as $key => $classMethodStmt) { |
| 116 | + if (!$classMethodStmt instanceof Expression) { |
| 117 | + continue; |
| 118 | + } |
| 119 | + if (!$classMethodStmt->expr instanceof MethodCall) { |
| 120 | + continue; |
| 121 | + } |
| 122 | + $methodCall = $classMethodStmt->expr; |
| 123 | + $currentMethodCall = $methodCall; |
| 124 | + while ($currentMethodCall->var instanceof MethodCall) { |
| 125 | + $currentMethodCall = $currentMethodCall->var; |
| 126 | + } |
| 127 | + if (!$currentMethodCall->var instanceof PropertyFetch) { |
| 128 | + continue; |
| 129 | + } |
| 130 | + $propertyFetch = $currentMethodCall->var; |
| 131 | + if (!$this->isName($propertyFetch->name, $propertyNameToRemove)) { |
| 132 | + continue; |
| 133 | + } |
| 134 | + unset($classMethod->stmts[$key]); |
| 135 | + } |
| 136 | + } |
| 137 | + } |
| 138 | + return $node; |
| 139 | + } |
| 140 | + private function removeMockPropertyFromSetUpMethod(ClassMethod $setUpClassMethod, string $propertyName): void |
| 141 | + { |
| 142 | + foreach ((array) $setUpClassMethod->stmts as $key => $classStmt) { |
| 143 | + if (!$classStmt instanceof Expression) { |
| 144 | + continue; |
| 145 | + } |
| 146 | + if (!$classStmt->expr instanceof Assign) { |
| 147 | + continue; |
| 148 | + } |
| 149 | + $assign = $classStmt->expr; |
| 150 | + if (!$assign->var instanceof PropertyFetch) { |
| 151 | + continue; |
| 152 | + } |
| 153 | + $assignedPropertyFetch = $assign->var; |
| 154 | + if (!$this->isName($assignedPropertyFetch->name, $propertyName)) { |
| 155 | + continue; |
| 156 | + } |
| 157 | + unset($setUpClassMethod->stmts[$key]); |
| 158 | + return; |
| 159 | + } |
| 160 | + } |
| 161 | + private function removePropertyFromClass(Class_ $class, string $propertyNameToRemove): void |
| 162 | + { |
| 163 | + foreach ($class->stmts as $key => $stmt) { |
| 164 | + if (!$stmt instanceof Property) { |
| 165 | + continue; |
| 166 | + } |
| 167 | + if (!$this->isName($stmt, $propertyNameToRemove)) { |
| 168 | + continue; |
| 169 | + } |
| 170 | + unset($class->stmts[$key]); |
| 171 | + } |
| 172 | + } |
| 173 | +} |
0 commit comments