-
Notifications
You must be signed in to change notification settings - Fork 555
Fix phpstan/phpstan#14252: Enum case outside of enum should be reported #5188
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
phpstan-bot
wants to merge
2
commits into
phpstan:2.1.x
Choose a base branch
from
phpstan-bot:create-pull-request/patch-43pdpis
base: 2.1.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.
+120
−0
Open
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Rules\EnumCases; | ||
|
|
||
| use PhpParser\Node; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\DependencyInjection\RegisteredRule; | ||
| use PHPStan\Rules\Rule; | ||
| use PHPStan\Rules\RuleErrorBuilder; | ||
|
|
||
| /** | ||
| * @implements Rule<Node\Stmt\EnumCase> | ||
| */ | ||
| #[RegisteredRule(level: 0)] | ||
| final class EnumCaseOutsideEnumRule implements Rule | ||
| { | ||
|
|
||
| public function getNodeType(): string | ||
| { | ||
| return Node\Stmt\EnumCase::class; | ||
| } | ||
|
|
||
| public function processNode(Node $node, Scope $scope): array | ||
| { | ||
| if ($scope->isInTrait()) { | ||
| return [ | ||
| RuleErrorBuilder::message('Enum case can only be used in enums.') | ||
| ->nonIgnorable() | ||
| ->identifier('enum.caseOutsideOfEnum') | ||
| ->build(), | ||
| ]; | ||
| } | ||
|
|
||
| if (!$scope->isInClass()) { | ||
| return []; | ||
| } | ||
|
|
||
| $classReflection = $scope->getClassReflection(); | ||
| if ($classReflection->isEnum()) { | ||
| return []; | ||
| } | ||
|
|
||
| return [ | ||
| RuleErrorBuilder::message('Enum case can only be used in enums.') | ||
| ->nonIgnorable() | ||
| ->identifier('enum.caseOutsideOfEnum') | ||
| ->build(), | ||
| ]; | ||
| } | ||
|
|
||
| } |
39 changes: 39 additions & 0 deletions
39
tests/PHPStan/Rules/EnumCases/EnumCaseOutsideEnumRuleTest.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,39 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Rules\EnumCases; | ||
|
|
||
| use PHPStan\Rules\Rule; | ||
| use PHPStan\Testing\RuleTestCase; | ||
| use PHPUnit\Framework\Attributes\RequiresPhp; | ||
|
|
||
| /** | ||
| * @extends RuleTestCase<EnumCaseOutsideEnumRule> | ||
| */ | ||
| class EnumCaseOutsideEnumRuleTest extends RuleTestCase | ||
| { | ||
|
|
||
| protected function getRule(): Rule | ||
| { | ||
| return new EnumCaseOutsideEnumRule(); | ||
| } | ||
|
|
||
| #[RequiresPhp('>= 8.1')] | ||
| public function testRule(): void | ||
| { | ||
| $this->analyse([__DIR__ . '/data/bug-14252.php'], [ | ||
| [ | ||
| 'Enum case can only be used in enums.', | ||
| 9, | ||
| ], | ||
| [ | ||
| 'Enum case can only be used in enums.', | ||
| 14, | ||
| ], | ||
| [ | ||
| 'Enum case can only be used in enums.', | ||
| 19, | ||
| ], | ||
| ]); | ||
| } | ||
|
|
||
| } |
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,30 @@ | ||
| <?php // lint >= 8.1 | ||
|
|
||
| declare(strict_types = 1); | ||
|
|
||
| namespace Bug14252; | ||
|
|
||
| class Foo | ||
| { | ||
| case Active; | ||
| } | ||
|
|
||
| interface Bar | ||
| { | ||
| case Active; | ||
| } | ||
|
|
||
| trait Baz | ||
| { | ||
| case Active; | ||
| } | ||
|
|
||
| class BazConsumer | ||
| { | ||
| use Baz; | ||
| } | ||
|
|
||
| enum Qux | ||
| { | ||
| case Active; | ||
| } | ||
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.
Misses a test for a trait which uses a enum case
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.
Tests completed successfully (the one failure is the pre-existing
RawErrorFormatterTestissue, unrelated to our changes). Everything is committed and pushed.