-
Notifications
You must be signed in to change notification settings - Fork 63
[code-quality] Add DirectInstanceOverMockArgRector #609
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
...y/Rector/CallLike/DirectInstanceOverMockArgRector/DirectInstanceOverMockArgRectorTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector; | ||
|
|
||
| use Iterator; | ||
| use PHPUnit\Framework\Attributes\DataProvider; | ||
| use Rector\Testing\PHPUnit\AbstractRectorTestCase; | ||
|
|
||
| final class DirectInstanceOverMockArgRectorTest extends AbstractRectorTestCase | ||
| { | ||
| #[DataProvider('provideData')] | ||
| public function test(string $filePath): void | ||
| { | ||
| $this->doTestFile($filePath); | ||
| } | ||
|
|
||
| public static function provideData(): Iterator | ||
| { | ||
| return self::yieldFilesFromDirectory(__DIR__ . '/Fixture'); | ||
| } | ||
|
|
||
| public function provideConfigFilePath(): string | ||
| { | ||
| return __DIR__ . '/config/configured_rule.php'; | ||
| } | ||
| } |
37 changes: 37 additions & 0 deletions
37
...Quality/Rector/CallLike/DirectInstanceOverMockArgRector/Fixture/handle_array_item.php.inc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| final class HandleArrayItem extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| $args = [ | ||
| $this->createMock(Request::class), | ||
| ]; | ||
| } | ||
| } | ||
|
|
||
| ?> | ||
| ----- | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| final class HandleArrayItem extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| $args = [ | ||
| new \Symfony\Component\HttpFoundation\Request(), | ||
| ]; | ||
| } | ||
| } | ||
|
|
||
| ?> |
37 changes: 37 additions & 0 deletions
37
...uality/Rector/CallLike/DirectInstanceOverMockArgRector/Fixture/handle_static_call.php.inc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| final class HandleStaticCall extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| AnyClass::staticRun( | ||
| $this->createMock(Request::class), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| ?> | ||
| ----- | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| final class HandleStaticCall extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| AnyClass::staticRun( | ||
| new \Symfony\Component\HttpFoundation\Request(), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| ?> |
17 changes: 17 additions & 0 deletions
17
...ality/Rector/CallLike/DirectInstanceOverMockArgRector/Fixture/skip_another_object.php.inc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Source\AnotherObject; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| final class SkipAnotherObject extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| AnyClass::staticRun( | ||
| $this->createMock(AnotherObject::class), | ||
| ); | ||
| } | ||
| } |
8 changes: 8 additions & 0 deletions
8
...ests/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector/Source/AnotherObject.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\Source; | ||
|
|
||
| final class AnotherObject | ||
| { | ||
|
|
||
| } |
9 changes: 9 additions & 0 deletions
9
...ts/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector/config/configured_rule.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| use Rector\Config\RectorConfig; | ||
| use Rector\PHPUnit\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector; | ||
|
|
||
| return RectorConfig::configure() | ||
| ->withRules([DirectInstanceOverMockArgRector::class]); |
35 changes: 35 additions & 0 deletions
35
...it120/Rector/CallLike/CreateStubOverCreateMockArgRector/Fixture/handle_array_item.php.inc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| final class HandleArrayItem extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| $items = [ | ||
| $this->createMock(\stdClass::class), | ||
| ]; | ||
| } | ||
| } | ||
|
|
||
| ?> | ||
| ----- | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| final class HandleArrayItem extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| $items = [ | ||
| $this->createStub(\stdClass::class), | ||
| ]; | ||
| } | ||
| } | ||
|
|
||
| ?> |
165 changes: 165 additions & 0 deletions
165
rules/CodeQuality/Rector/CallLike/DirectInstanceOverMockArgRector.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Rector\PHPUnit\CodeQuality\Rector\CallLike; | ||
|
|
||
| use PhpParser\Node; | ||
| use PhpParser\Node\Arg; | ||
| use PhpParser\Node\ArrayItem; | ||
| use PhpParser\Node\Expr; | ||
| use PhpParser\Node\Expr\MethodCall; | ||
| use PhpParser\Node\Expr\New_; | ||
| use PhpParser\Node\Expr\StaticCall; | ||
| use PhpParser\Node\Name\FullyQualified; | ||
| use Rector\PhpParser\Node\Value\ValueResolver; | ||
| use Rector\PHPStan\ScopeFetcher; | ||
| use Rector\PHPUnit\Enum\PHPUnitClassName; | ||
| use Rector\Rector\AbstractRector; | ||
| use Rector\Symfony\Enum\SymfonyClass; | ||
| use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; | ||
| use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; | ||
|
|
||
| /** | ||
| * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\CallLike\DirectInstanceOverMockArgRector\DirectInstanceOverMockArgRectorTest | ||
| */ | ||
| final class DirectInstanceOverMockArgRector extends AbstractRector | ||
| { | ||
| public function __construct( | ||
| private readonly ValueResolver $valueResolver | ||
| ) { | ||
| } | ||
|
|
||
| public function getRuleDefinition(): RuleDefinition | ||
| { | ||
| return new RuleDefinition( | ||
| 'Use direct object instance over mock for specific objects in arg of PHPUnit tests', | ||
| [ | ||
| new CodeSample( | ||
| <<<'CODE_SAMPLE' | ||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| final class SomeTest extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $this->someMethod($this->createMock(Request::class)); | ||
| } | ||
|
|
||
| private function someMethod($someClass) | ||
| { | ||
| } | ||
| } | ||
| CODE_SAMPLE | ||
| , | ||
| <<<'CODE_SAMPLE' | ||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| final class SomeTest extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $this->someMethod(new Request()); | ||
| } | ||
|
|
||
| private function someMethod($someClass) | ||
| { | ||
| } | ||
| } | ||
| CODE_SAMPLE | ||
| ), | ||
|
|
||
| ] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @return array<class-string<Node>> | ||
| */ | ||
| public function getNodeTypes(): array | ||
| { | ||
| return [StaticCall::class, MethodCall::class, New_::class, ArrayItem::class]; | ||
| } | ||
|
|
||
| /** | ||
| * @param MethodCall|StaticCall|New_|ArrayItem $node | ||
| */ | ||
| public function refactor(Node $node): MethodCall|StaticCall|New_|ArrayItem|null | ||
| { | ||
| $scope = ScopeFetcher::fetch($node); | ||
| if (! $scope->isInClass()) { | ||
| return null; | ||
| } | ||
|
|
||
| $classReflection = $scope->getClassReflection(); | ||
| if (! $classReflection->is(PHPUnitClassName::TEST_CASE)) { | ||
| return null; | ||
| } | ||
|
|
||
| $hasChanged = false; | ||
|
|
||
| if ($node instanceof ArrayItem) { | ||
|
|
||
| return $this->refactorArrayItem($node); | ||
| } | ||
|
|
||
| foreach ($node->getArgs() as $arg) { | ||
| $firstArg = $this->matchCreateMockMethodCallArg($arg->value); | ||
| if (! $firstArg instanceof Arg) { | ||
| continue; | ||
| } | ||
|
|
||
| $className = $this->valueResolver->getValue($firstArg->value); | ||
| if (! in_array($className, [SymfonyClass::REQUEST, SymfonyClass::REQUEST_STACK])) { | ||
| continue; | ||
| } | ||
|
|
||
| $arg->value = new New_(new FullyQualified($className)); | ||
| $hasChanged = true; | ||
| } | ||
|
|
||
| if ($hasChanged) { | ||
| return $node; | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private function matchCreateMockMethodCallArg(Expr $expr): ?Arg | ||
| { | ||
| if (! $expr instanceof MethodCall) { | ||
| return null; | ||
| } | ||
|
|
||
| $methodCall = $expr; | ||
| if (! $this->isName($methodCall->name, 'createMock')) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($methodCall->isFirstClassCallable()) { | ||
| return null; | ||
| } | ||
|
|
||
| return $methodCall->getArgs()[0]; | ||
| } | ||
|
|
||
| private function refactorArrayItem(ArrayItem $arrayItem): ?ArrayItem | ||
| { | ||
| $mockedCallArg = $this->matchCreateMockMethodCallArg($arrayItem->value); | ||
| if (! $mockedCallArg instanceof Arg) { | ||
| return null; | ||
| } | ||
|
|
||
| $className = $this->valueResolver->getValue($mockedCallArg->value); | ||
|
|
||
| if (! in_array($className, [SymfonyClass::REQUEST, SymfonyClass::REQUEST_STACK])) { | ||
| return null; | ||
| } | ||
|
|
||
| $arrayItem->value = new New_(new FullyQualified($className)); | ||
|
|
||
| return $arrayItem; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
->isFirstClassCallable()should be checked early before->getArgs()There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I created PR
for it.