-
Notifications
You must be signed in to change notification settings - Fork 63
[code-quality] Add ScalarArgumentToExpectedParamTypeRector #533
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
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
35 changes: 35 additions & 0 deletions
35
...tor/MethodCall/ScalarArgumentToExpectedParamTypeRector/Fixture/simple_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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Source\SomeClassWithSetter; | ||
|
|
||
| final class SimpleMethodCall extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $someClassWithSetter = new SomeClassWithSetter(); | ||
| $someClassWithSetter->setPhoneNumber(123456); | ||
| } | ||
| } | ||
|
|
||
| ?> | ||
| ----- | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Source\SomeClassWithSetter; | ||
|
|
||
| final class SimpleMethodCall extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $someClassWithSetter = new SomeClassWithSetter(); | ||
| $someClassWithSetter->setPhoneNumber('123456'); | ||
| } | ||
| } | ||
|
|
||
| ?> |
15 changes: 15 additions & 0 deletions
15
...tor/MethodCall/ScalarArgumentToExpectedParamTypeRector/Fixture/skip_docblock_type.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,15 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Source\SomeClassWithSetter; | ||
|
|
||
| final class SkipDocblockType extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $someClassWithSetter = new SomeClassWithSetter(); | ||
| $someClassWithSetter->setMagicType(123456); | ||
| } | ||
| } |
15 changes: 15 additions & 0 deletions
15
...Rector/MethodCall/ScalarArgumentToExpectedParamTypeRector/Fixture/skip_union_type.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,15 @@ | ||
| <?php | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Fixture; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Source\SomeClassWithSetter; | ||
|
|
||
| final class SkipUnionType extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $someClassWithSetter = new SomeClassWithSetter(); | ||
| $someClassWithSetter->setUnionType(123456); | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
...l/ScalarArgumentToExpectedParamTypeRector/ScalarArgumentToExpectedParamTypeRectorTest.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\MethodCall\ScalarArgumentToExpectedParamTypeRector; | ||
|
|
||
| use Iterator; | ||
| use PHPUnit\Framework\Attributes\DataProvider; | ||
| use Rector\Testing\PHPUnit\AbstractRectorTestCase; | ||
|
|
||
| final class ScalarArgumentToExpectedParamTypeRectorTest 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'; | ||
| } | ||
| } |
25 changes: 25 additions & 0 deletions
25
.../Rector/MethodCall/ScalarArgumentToExpectedParamTypeRector/Source/SomeClassWithSetter.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,25 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\Source; | ||
|
|
||
| final class SomeClassWithSetter | ||
| { | ||
| public function setPhoneNumber(string $phoneNumber) | ||
| { | ||
| } | ||
|
|
||
| /** | ||
| * @param string $passportId | ||
| */ | ||
| public function setMagicType($passportId) | ||
| { | ||
|
|
||
| } | ||
|
|
||
| public function setUnionType(int|string $unionValue) | ||
| { | ||
|
|
||
| } | ||
| } |
10 changes: 10 additions & 0 deletions
10
...lity/Rector/MethodCall/ScalarArgumentToExpectedParamTypeRector/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,10 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| use Rector\Config\RectorConfig; | ||
| use Rector\PHPUnit\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector; | ||
|
|
||
| return static function (RectorConfig $rectorConfig): void { | ||
| $rectorConfig->rule(ScalarArgumentToExpectedParamTypeRector::class); | ||
| }; |
158 changes: 158 additions & 0 deletions
158
rules/CodeQuality/Rector/MethodCall/ScalarArgumentToExpectedParamTypeRector.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,158 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Rector\PHPUnit\CodeQuality\Rector\MethodCall; | ||
|
|
||
| use PhpParser\Node; | ||
| use PhpParser\Node\Expr\MethodCall; | ||
| use PhpParser\Node\Expr\StaticCall; | ||
| use PhpParser\Node\Scalar; | ||
| use PhpParser\Node\Scalar\Int_; | ||
| use PhpParser\Node\Scalar\String_; | ||
| use PHPStan\Type\IntegerType; | ||
| use PHPStan\Type\StringType; | ||
| use PHPStan\Type\Type; | ||
| use Rector\PHPUnit\CodeQuality\Reflection\MethodParametersAndReturnTypesResolver; | ||
| use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer; | ||
| use Rector\Rector\AbstractRector; | ||
| use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; | ||
| use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; | ||
|
|
||
| /** | ||
| * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\ScalarArgumentToExpectedParamTypeRector\ScalarArgumentToExpectedParamTypeRectorTest | ||
| */ | ||
| final class ScalarArgumentToExpectedParamTypeRector extends AbstractRector | ||
| { | ||
| public function __construct( | ||
| private readonly TestsNodeAnalyzer $testsNodeAnalyzer, | ||
| private readonly MethodParametersAndReturnTypesResolver $methodParametersAndReturnTypesResolver, | ||
| ) { | ||
| } | ||
|
|
||
| public function getRuleDefinition(): RuleDefinition | ||
| { | ||
| return new RuleDefinition( | ||
| 'Correct expected type in setter of tests, if param type is strictly defined', | ||
| [ | ||
| new CodeSample( | ||
| <<<'CODE_SAMPLE' | ||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| class SomeTest extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $someClass = new SomeClass(); | ||
| $someClass->setPhone(12345); | ||
| } | ||
| } | ||
|
|
||
| final class SomeClass | ||
| { | ||
| public function setPhone(string $phone) | ||
| { | ||
| } | ||
| } | ||
| CODE_SAMPLE | ||
| , | ||
| <<<'CODE_SAMPLE' | ||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| class SomeTest extends TestCase | ||
| { | ||
| public function test() | ||
| { | ||
| $someClass = new SomeClass(); | ||
| $someClass->setPhone('12345'); | ||
| } | ||
| } | ||
|
|
||
| final class SomeClass | ||
| { | ||
| public function setPhone(string $phone) | ||
| { | ||
| } | ||
| } | ||
| CODE_SAMPLE | ||
| ), | ||
| ] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @return array<class-string<Node>> | ||
| */ | ||
| public function getNodeTypes(): array | ||
| { | ||
| return [MethodCall::class, StaticCall::class]; | ||
| } | ||
|
|
||
| /** | ||
| * @param MethodCall|StaticCall $node | ||
| */ | ||
| public function refactor(Node $node): ?Node | ||
| { | ||
| if (! $this->testsNodeAnalyzer->isInTestClass($node)) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($node->isFirstClassCallable()) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($node->getArgs() === []) { | ||
| return null; | ||
| } | ||
|
|
||
| $hasChanged = false; | ||
|
|
||
| if (! $this->hasStringOrNumberArguments($node)) { | ||
| return null; | ||
| } | ||
|
|
||
| $callParameterTypes = $this->methodParametersAndReturnTypesResolver->resolveCallParameterTypes($node); | ||
|
|
||
| foreach ($node->getArgs() as $key => $arg) { | ||
| if (! $arg->value instanceof Scalar) { | ||
| continue; | ||
| } | ||
|
|
||
| $knownParameterType = $callParameterTypes[$key] ?? null; | ||
| if (! $knownParameterType instanceof Type) { | ||
| continue; | ||
| } | ||
|
|
||
| if ($knownParameterType instanceof StringType && $arg->value instanceof Int_) { | ||
| $arg->value = new String_((string) $arg->value->value); | ||
| $hasChanged = true; | ||
| } | ||
|
|
||
| if ($knownParameterType instanceof IntegerType && $arg->value instanceof String_) { | ||
| $arg->value = new Int_((int) $arg->value->value); | ||
| $hasChanged = true; | ||
| } | ||
| } | ||
|
|
||
| if (! $hasChanged) { | ||
| return null; | ||
| } | ||
|
|
||
| return $node; | ||
| } | ||
|
|
||
| private function hasStringOrNumberArguments(StaticCall|MethodCall $call): bool | ||
| { | ||
| foreach ($call->getArgs() as $arg) { | ||
| if ($arg->value instanceof Int_) { | ||
| return true; | ||
| } | ||
|
|
||
| if ($arg->value instanceof String_) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| } |
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
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.
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.
#534