Add ExpectsParamToMockObjectRector for private test method params - #753
Merged
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds
ExpectsParamToMockObjectRector(PHPUnit 11+), that changes the param type of a private test-case method toMockObject, whenexpects()is called on that param.Since PHPUnit 10,
expects()only exists onMockObject, not on the plain class type. Passing a mock into a helper method typed with the original class forces@phpstan-ignore-next-lineon everyexpects()call:use PHPUnit\Framework\TestCase; final class SomeTest extends TestCase { - private function prepareUserMock(SomeUser $user): void + private function prepareUserMock(\PHPUnit\Framework\MockObject\MockObject $user): void { - // @phpstan-ignore-next-line $user->expects($this->once()) ->method('getId') ->willReturn(1); } }(the rule only changes the type; leftover ignore comments are removed by other tooling)
Only params with an actual
expects()call are changed:Skipped:
MockObject, incl. intersection types likeSomeUser&MockObject@paramdocblock tag, to avoid a native type contradicting the docblockRegistered in the composer-based set, bound to
phpunit/phpunit >=11.0, next to the relatedMockObjectArgCreateStubToCreateMockRector.