-
Notifications
You must be signed in to change notification settings - Fork 57
Implement ClassAttributeRequiresPhpVersionRule #305
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
Open
staabm
wants to merge
1
commit into
phpstan:2.0.x
Choose a base branch
from
staabm:refac2
base: 2.0.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+139
−0
Open
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
44 changes: 44 additions & 0 deletions
44
src/Rules/PHPUnit/ClassAttributeRequiresPhpVersionRule.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,44 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Rules\PHPUnit; | ||
|
|
||
| use PhpParser\Node; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\Node\InClassNode; | ||
| use PHPStan\Rules\Rule; | ||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| /** | ||
| * @implements Rule<InClassNode> | ||
| */ | ||
| class ClassAttributeRequiresPhpVersionRule implements Rule | ||
| { | ||
|
|
||
| private AttributeVersionRequirementHelper $attributeVersionRequirementHelper; | ||
|
|
||
| public function __construct( | ||
| AttributeVersionRequirementHelper $attributeVersionRequirementHelper | ||
| ) | ||
| { | ||
| $this->attributeVersionRequirementHelper = $attributeVersionRequirementHelper; | ||
| } | ||
|
|
||
| public function getNodeType(): string | ||
| { | ||
| return InClassNode::class; | ||
| } | ||
|
|
||
| public function processNode(Node $node, Scope $scope): array | ||
| { | ||
| $classReflection = $scope->getClassReflection(); | ||
| if ($classReflection === null || $classReflection->is(TestCase::class) === false) { | ||
| return []; | ||
| } | ||
|
|
||
| return $this->attributeVersionRequirementHelper->checkRequiresPhpVersion( | ||
| $classReflection->getNativeReflection()->getBetterReflection()->getAttributesByName('PHPUnit\Framework\Attributes\RequiresPhp'), | ||
| $scope, | ||
| ); | ||
| } | ||
|
|
||
| } |
2 changes: 2 additions & 0 deletions
2
tests/Rules/PHPUnit/ClassAttributeRequiresPhpVersionRule.neon
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,2 @@ | ||
| parameters: | ||
| phpVersion: 80500 |
63 changes: 63 additions & 0 deletions
63
tests/Rules/PHPUnit/ClassAttributeRequiresPhpVersionRuleTest.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,63 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Rules\PHPUnit; | ||
|
|
||
| use PHPStan\Php\PhpVersion; | ||
| use PHPStan\Rules\Rule; | ||
| use PHPStan\Testing\RuleTestCase; | ||
|
|
||
| /** | ||
| * @extends RuleTestCase<ClassAttributeRequiresPhpVersionRule> | ||
| */ | ||
| final class ClassAttributeRequiresPhpVersionRuleTest extends RuleTestCase | ||
| { | ||
|
|
||
| private int $phpVersion = 80500; | ||
|
|
||
| private int $phpunitMajorVersion; | ||
|
|
||
| private int $phpunitMinorVersion; | ||
|
|
||
| private bool $warnAboutIncompleteVersion = false; | ||
|
|
||
| public function testWarnAboutIncompleteVersion(): void | ||
| { | ||
| $this->phpunitMajorVersion = 12; | ||
| $this->phpunitMinorVersion = 5; | ||
| $this->warnAboutIncompleteVersion = true; | ||
|
|
||
| $this->analyse([__DIR__ . '/data/requires-php-version-on-class.php'], [ | ||
| [ | ||
| 'Version requirement will always evaluate to false.', | ||
| 10, | ||
| ], | ||
| [ | ||
| 'Version requirement is incomplete.', | ||
| 10, | ||
| ], | ||
| ]); | ||
| } | ||
|
|
||
| protected function getRule(): Rule | ||
| { | ||
| $phpunitVersion = new PHPUnitVersion($this->phpunitMajorVersion, $this->phpunitMinorVersion); | ||
|
|
||
| return new ClassAttributeRequiresPhpVersionRule( | ||
| new AttributeVersionRequirementHelper( | ||
| $phpunitVersion, | ||
| false, | ||
| new PhpVersion($this->phpVersion), | ||
| true, | ||
| $this->warnAboutIncompleteVersion, | ||
| ), | ||
| ); | ||
| } | ||
|
|
||
| public static function getAdditionalConfigFiles(): array | ||
| { | ||
| return [ | ||
| __DIR__ . '/ClassAttributeRequiresPhpVersionRule.neon', | ||
| ]; | ||
| } | ||
|
|
||
| } |
24 changes: 24 additions & 0 deletions
24
tests/Rules/PHPUnit/data/requires-php-version-on-class.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,24 @@ | ||
| <?php | ||
|
|
||
| namespace RequiresPhpVersionOnClass; | ||
|
|
||
| use PHPUnit\Framework\Attributes\DataProvider; | ||
| use PHPUnit\Framework\Attributes\Test; | ||
| use PHPUnit\Framework\TestCase; | ||
| use PHPUnit\Framework\Attributes\RequiresPhp; | ||
|
|
||
| #[RequiresPhp('< 7.0')] | ||
| class RequiresPhpOnClass extends TestCase | ||
| { | ||
| public function testBar(): void { | ||
|
|
||
| } | ||
| } | ||
|
|
||
| #[RequiresPhp('>=8.0.0')] | ||
| class CorrectRequirementOnClass extends TestCase | ||
| { | ||
| public function testBar(): void { | ||
|
|
||
| } | ||
| } |
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.
technically its a new rule, but in the end we just add wiring for a pre-existing service (and its bleeding edge only).
therefore I feel confident merging, without a review from ondrej