-
Notifications
You must be signed in to change notification settings - Fork 63
[PHPUnit 12] Add CreateStubOverCreateMockArgRector #608
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
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
...ctor/CallLike/CreateStubOverCreateMockArgRector/CreateStubOverCreateMockArgRectorTest.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\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector; | ||
|
|
||
| use Iterator; | ||
| use PHPUnit\Framework\Attributes\DataProvider; | ||
| use Rector\Testing\PHPUnit\AbstractRectorTestCase; | ||
|
|
||
| final class CreateStubOverCreateMockArgRectorTest 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
...t120/Rector/CallLike/CreateStubOverCreateMockArgRector/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\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Utils\PHPStan\Tests\Rule\PHPUnit\StubOverMockArgRule\Source\AnyClass; | ||
|
|
||
| class HandleStaticCall extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| AnyClass::staticRun( | ||
| $this->createMock(\stdClass::class), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| ?> | ||
| ----- | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Utils\PHPStan\Tests\Rule\PHPUnit\StubOverMockArgRule\Source\AnyClass; | ||
|
|
||
| class HandleStaticCall extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| AnyClass::staticRun( | ||
| $this->createStub(\stdClass::class), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| ?> |
41 changes: 41 additions & 0 deletions
41
...20/Rector/CallLike/CreateStubOverCreateMockArgRector/Fixture/some_file_with_mocks.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,41 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Utils\PHPStan\Tests\Rule\PHPUnit\StubOverMockArgRule\Source\AnyClass; | ||
|
|
||
| class SomeFileWithMocks extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| $anyClass = new AnyClass(); | ||
| $anyClass->run( | ||
| $this->createMock(\stdClass::class), | ||
| $this->createMock(\stdClass::class) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| ?> | ||
| ----- | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Utils\PHPStan\Tests\Rule\PHPUnit\StubOverMockArgRule\Source\AnyClass; | ||
|
|
||
| class SomeFileWithMocks extends TestCase | ||
| { | ||
| public function testThat() | ||
| { | ||
| $anyClass = new AnyClass(); | ||
| $anyClass->run( | ||
| $this->createStub(\stdClass::class), | ||
| $this->createStub(\stdClass::class) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| ?> |
9 changes: 9 additions & 0 deletions
9
...s/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector/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\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector; | ||
|
|
||
| return RectorConfig::configure() | ||
| ->withRules([CreateStubOverCreateMockArgRector::class]); |
2 changes: 1 addition & 1 deletion
2
...d/AddDoesNotPerformAssertionToNonAssertingTestRector/Fixture/skip_abstract_method.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
2 changes: 1 addition & 1 deletion
2
...ssertingTestRector/Fixture/skip_call_expect_not_to_perform_assertions_method_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
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
112 changes: 112 additions & 0 deletions
112
rules/PHPUnit120/Rector/CallLike/CreateStubOverCreateMockArgRector.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,112 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Rector\PHPUnit\PHPUnit120\Rector\CallLike; | ||
|
|
||
| use PhpParser\Node; | ||
| use PhpParser\Node\Expr\MethodCall; | ||
| use PhpParser\Node\Expr\New_; | ||
| use PhpParser\Node\Expr\StaticCall; | ||
| use PhpParser\Node\Identifier; | ||
| use Rector\PHPStan\ScopeFetcher; | ||
| use Rector\PHPUnit\Enum\PHPUnitClassName; | ||
| use Rector\Rector\AbstractRector; | ||
| use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; | ||
| use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; | ||
|
|
||
| /** | ||
| * Related change in PHPUnit 12 https://phpunit.expert/articles/testing-with-and-without-dependencies.html | ||
| * | ||
| * @see \Rector\PHPUnit\Tests\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector\CreateStubOverCreateMockArgRectorTest | ||
| */ | ||
| final class CreateStubOverCreateMockArgRector extends AbstractRector | ||
| { | ||
| public function getRuleDefinition(): RuleDefinition | ||
| { | ||
| return new RuleDefinition( | ||
| 'Use createStub() over createMock() when used as argument and does not add any mock requirements', | ||
| [ | ||
| new CodeSample( | ||
| <<<'CODE_SAMPLE' | ||
| use PHPUnit\Framework\TestCase; | ||
| final class SomeTest extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $this->someMethod($this->createMock(SomeClass::class)); | ||
| } | ||
|
|
||
| private function someMethod($someClass) | ||
| { | ||
| } | ||
| } | ||
| CODE_SAMPLE | ||
| , | ||
| <<<'CODE_SAMPLE' | ||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| final class SomeTest extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $this->someMethod($this->createStub(SomeClass::class)); | ||
| } | ||
|
|
||
| private function someMethod($someClass) | ||
| { | ||
| } | ||
| } | ||
| CODE_SAMPLE | ||
| ), | ||
|
|
||
| ] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @return array<class-string<Node>> | ||
| */ | ||
| public function getNodeTypes(): array | ||
| { | ||
| return [StaticCall::class, MethodCall::class, New_::class]; | ||
| } | ||
|
|
||
| /** | ||
| * @param MethodCall|StaticCall|New_ $node | ||
| */ | ||
| public function refactor(Node $node): MethodCall|StaticCall|New_|null | ||
| { | ||
| $scope = ScopeFetcher::fetch($node); | ||
| if (! $scope->isInClass()) { | ||
| return null; | ||
| } | ||
|
|
||
| $classReflection = $scope->getClassReflection(); | ||
| if (! $classReflection->is(PHPUnitClassName::TEST_CASE)) { | ||
| return null; | ||
| } | ||
|
|
||
| $hasChanges = false; | ||
|
|
||
| foreach ($node->getArgs() as $arg) { | ||
| if (! $arg->value instanceof MethodCall) { | ||
| continue; | ||
| } | ||
|
|
||
| $methodCall = $arg->value; | ||
| if (! $this->isName($methodCall->name, 'createMock')) { | ||
| continue; | ||
| } | ||
|
|
||
| $methodCall->name = new Identifier('createStub'); | ||
| $hasChanges = true; | ||
| } | ||
|
|
||
| if ($hasChanges) { | ||
| return $node; | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
| } | ||
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.
first class callable check needs to be checked early here
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:
to fix it.