-
Notifications
You must be signed in to change notification settings - Fork 51
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
Check for boolean in while conditions #260
Merged
Merged
Changes from 2 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 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
46 changes: 46 additions & 0 deletions
46
src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php
This file contains 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,46 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\BooleansInConditions; | ||
|
||
use PhpParser\Node; | ||
use PHPStan\Analyser\Scope; | ||
use PHPStan\Rules\Rule; | ||
use PHPStan\Rules\RuleErrorBuilder; | ||
use PHPStan\Type\VerbosityLevel; | ||
use function sprintf; | ||
|
||
/** | ||
* @implements Rule<Node\Stmt\Do_> | ||
*/ | ||
class BooleanInDoWhileConditionRule implements Rule | ||
{ | ||
|
||
private BooleanRuleHelper $helper; | ||
|
||
public function __construct(BooleanRuleHelper $helper) | ||
{ | ||
$this->helper = $helper; | ||
} | ||
|
||
public function getNodeType(): string | ||
{ | ||
return Node\Stmt\Do_::class; | ||
} | ||
|
||
public function processNode(Node $node, Scope $scope): array | ||
{ | ||
if ($this->helper->passesAsBoolean($scope, $node->cond)) { | ||
return []; | ||
} | ||
|
||
$conditionExpressionType = $scope->getType($node->cond); | ||
|
||
return [ | ||
RuleErrorBuilder::message(sprintf( | ||
'Only booleans are allowed in a do-while condition, %s given.', | ||
$conditionExpressionType->describe(VerbosityLevel::typeOnly()), | ||
))->identifier('doWhile.condNotBoolean')->build(), | ||
]; | ||
} | ||
|
||
} |
46 changes: 46 additions & 0 deletions
46
src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php
This file contains 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,46 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\BooleansInConditions; | ||
|
||
use PhpParser\Node; | ||
use PHPStan\Analyser\Scope; | ||
use PHPStan\Rules\Rule; | ||
use PHPStan\Rules\RuleErrorBuilder; | ||
use PHPStan\Type\VerbosityLevel; | ||
use function sprintf; | ||
|
||
/** | ||
* @implements Rule<Node\Stmt\While_> | ||
*/ | ||
class BooleanInWhileConditionRule implements Rule | ||
{ | ||
|
||
private BooleanRuleHelper $helper; | ||
|
||
public function __construct(BooleanRuleHelper $helper) | ||
{ | ||
$this->helper = $helper; | ||
} | ||
|
||
public function getNodeType(): string | ||
{ | ||
return Node\Stmt\While_::class; | ||
} | ||
|
||
public function processNode(Node $node, Scope $scope): array | ||
{ | ||
if ($this->helper->passesAsBoolean($scope, $node->cond)) { | ||
return []; | ||
} | ||
|
||
$conditionExpressionType = $scope->getType($node->cond); | ||
|
||
return [ | ||
RuleErrorBuilder::message(sprintf( | ||
'Only booleans are allowed in a while condition, %s given.', | ||
$conditionExpressionType->describe(VerbosityLevel::typeOnly()), | ||
))->identifier('while.condNotBoolean')->build(), | ||
]; | ||
} | ||
|
||
} |
34 changes: 34 additions & 0 deletions
34
tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php
This file contains 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,34 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\BooleansInConditions; | ||
|
||
use PHPStan\Rules\Rule; | ||
use PHPStan\Rules\RuleLevelHelper; | ||
use PHPStan\Testing\RuleTestCase; | ||
|
||
/** | ||
* @extends RuleTestCase<BooleanInDoWhileConditionRule> | ||
*/ | ||
class BooleanInDoWhileConditionRuleTest extends RuleTestCase | ||
{ | ||
|
||
protected function getRule(): Rule | ||
{ | ||
return new BooleanInDoWhileConditionRule( | ||
new BooleanRuleHelper( | ||
self::getContainer()->getByType(RuleLevelHelper::class), | ||
), | ||
); | ||
} | ||
|
||
public function testRule(): void | ||
{ | ||
$this->analyse([__DIR__ . '/data/conditions.php'], [ | ||
[ | ||
'Only booleans are allowed in a do-while condition, string given.', | ||
60, | ||
], | ||
]); | ||
} | ||
|
||
} |
34 changes: 34 additions & 0 deletions
34
tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php
This file contains 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,34 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\BooleansInConditions; | ||
|
||
use PHPStan\Rules\Rule; | ||
use PHPStan\Rules\RuleLevelHelper; | ||
use PHPStan\Testing\RuleTestCase; | ||
|
||
/** | ||
* @extends RuleTestCase<BooleanInWhileConditionRule> | ||
*/ | ||
class BooleanInWhileConditionRuleTest extends RuleTestCase | ||
{ | ||
|
||
protected function getRule(): Rule | ||
{ | ||
return new BooleanInWhileConditionRule( | ||
new BooleanRuleHelper( | ||
self::getContainer()->getByType(RuleLevelHelper::class), | ||
), | ||
); | ||
} | ||
|
||
public function testRule(): void | ||
{ | ||
$this->analyse([__DIR__ . '/data/conditions.php'], [ | ||
[ | ||
'Only booleans are allowed in a while condition, string given.', | ||
55, | ||
], | ||
]); | ||
} | ||
|
||
} |
This file contains 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.
This is a new rule. It has to be part of bleeding edge. See how this was done in 1.x:
phpstan-strict-rules/rules.neon
Line 20 in b564ca4
This also means this needs a new config parameter. Something like booleansInLoopConditions?
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.
Sure, should be ok now