From 81e96e5a310a23859e995110464e1d1d0921751d Mon Sep 17 00:00:00 2001 From: Vincent Langlet Date: Thu, 23 Jan 2025 00:35:21 +0100 Subject: [PATCH 1/4] Check for boolean in while conditions --- rules.neon | 10 ++++ .../BooleanInDoWhileConditionRule.php | 47 +++++++++++++++++++ .../BooleanInWhileConditionRule.php | 47 +++++++++++++++++++ .../BooleanInDoWhileConditionRuleTest.php | 36 ++++++++++++++ .../BooleanInWhileConditionRuleTest.php | 36 ++++++++++++++ .../BooleansInConditions/data/conditions.php | 10 ++++ 6 files changed, 186 insertions(+) create mode 100644 src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php create mode 100644 src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php create mode 100644 tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php create mode 100644 tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php diff --git a/rules.neon b/rules.neon index 61b49854..3af67367 100644 --- a/rules.neon +++ b/rules.neon @@ -64,12 +64,16 @@ conditionalTags: phpstan.rules.rule: %strictRules.booleansInConditions% PHPStan\Rules\BooleansInConditions\BooleanInBooleanOrRule: phpstan.rules.rule: %strictRules.booleansInConditions% + PHPStan\Rules\BooleansInConditions\BooleanInDoWhileConditionRule: + phpstan.rules.rule: %strictRules.booleansInConditions% PHPStan\Rules\BooleansInConditions\BooleanInElseIfConditionRule: phpstan.rules.rule: %strictRules.booleansInConditions% PHPStan\Rules\BooleansInConditions\BooleanInIfConditionRule: phpstan.rules.rule: %strictRules.booleansInConditions% PHPStan\Rules\BooleansInConditions\BooleanInTernaryOperatorRule: phpstan.rules.rule: %strictRules.booleansInConditions% + PHPStan\Rules\BooleansInConditions\BooleanInWhileConditionRule: + phpstan.rules.rule: %strictRules.booleansInConditions% PHPStan\Rules\Cast\UselessCastRule: phpstan.rules.rule: %strictRules.uselessCast% PHPStan\Rules\Classes\RequireParentConstructCallRule: @@ -163,6 +167,9 @@ services: - class: PHPStan\Rules\BooleansInConditions\BooleanInBooleanOrRule + - + class: PHPStan\Rules\BooleansInConditions\BooleanInDoWhileConditionRule + - class: PHPStan\Rules\BooleansInConditions\BooleanInElseIfConditionRule @@ -172,6 +179,9 @@ services: - class: PHPStan\Rules\BooleansInConditions\BooleanInTernaryOperatorRule + - + class: PHPStan\Rules\BooleansInConditions\BooleanInWhileConditionRule + - class: PHPStan\Rules\Cast\UselessCastRule arguments: diff --git a/src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php b/src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php new file mode 100644 index 00000000..4298c6d4 --- /dev/null +++ b/src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php @@ -0,0 +1,47 @@ + + */ +class BooleanInDoWhileConditionRule implements Rule +{ + + private BooleanRuleHelper $helper; + + public function __construct(BooleanRuleHelper $helper) + { + $this->helper = $helper; + } + + public function getNodeType(): string + { + return 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(), + ]; + } + +} diff --git a/src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php b/src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php new file mode 100644 index 00000000..47c82dd4 --- /dev/null +++ b/src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php @@ -0,0 +1,47 @@ + + */ +class BooleanInWhileConditionRule implements Rule +{ + + private BooleanRuleHelper $helper; + + public function __construct(BooleanRuleHelper $helper) + { + $this->helper = $helper; + } + + public function getNodeType(): string + { + return 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(), + ]; + } + +} diff --git a/tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php b/tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php new file mode 100644 index 00000000..7f9c4118 --- /dev/null +++ b/tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php @@ -0,0 +1,36 @@ + + */ +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, + ], + ]); + } + +} diff --git a/tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php b/tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php new file mode 100644 index 00000000..76cf1a88 --- /dev/null +++ b/tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php @@ -0,0 +1,36 @@ + + */ +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, + ], + ]); + } + +} diff --git a/tests/Rules/BooleansInConditions/data/conditions.php b/tests/Rules/BooleansInConditions/data/conditions.php index 968867ff..f69808ac 100644 --- a/tests/Rules/BooleansInConditions/data/conditions.php +++ b/tests/Rules/BooleansInConditions/data/conditions.php @@ -48,3 +48,13 @@ $explicitMixed and $bool; $bool or $explicitMixed; $explicitMixed or $bool; + +$someBool = true; +$someString = 'string'; +while ($someBool) { $someBool = !$someBool; } +while ($someString) { $someString = ''; } + +$someBool = true; +$someString = 'string'; +do { $someBool = !$someBool; } while ($someBool); +do { $someString = ''; } while ($someString); From c9218d4901c0c0d76cd4121fe41dcd69b5d73e7d Mon Sep 17 00:00:00 2001 From: Vincent Langlet Date: Sat, 15 Feb 2025 23:55:55 +0100 Subject: [PATCH 2/4] Fix cs --- .../BooleansInConditions/BooleanInDoWhileConditionRule.php | 5 ++--- .../BooleansInConditions/BooleanInWhileConditionRule.php | 5 ++--- .../BooleanInDoWhileConditionRuleTest.php | 2 -- .../BooleansInConditions/BooleanInWhileConditionRuleTest.php | 2 -- 4 files changed, 4 insertions(+), 10 deletions(-) diff --git a/src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php b/src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php index 4298c6d4..d0db2962 100644 --- a/src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php +++ b/src/Rules/BooleansInConditions/BooleanInDoWhileConditionRule.php @@ -3,7 +3,6 @@ namespace PHPStan\Rules\BooleansInConditions; use PhpParser\Node; -use PhpParser\Node\Stmt\Do_; use PHPStan\Analyser\Scope; use PHPStan\Rules\Rule; use PHPStan\Rules\RuleErrorBuilder; @@ -11,7 +10,7 @@ use function sprintf; /** - * @implements Rule + * @implements Rule */ class BooleanInDoWhileConditionRule implements Rule { @@ -25,7 +24,7 @@ public function __construct(BooleanRuleHelper $helper) public function getNodeType(): string { - return Do_::class; + return Node\Stmt\Do_::class; } public function processNode(Node $node, Scope $scope): array diff --git a/src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php b/src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php index 47c82dd4..2f1661a6 100644 --- a/src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php +++ b/src/Rules/BooleansInConditions/BooleanInWhileConditionRule.php @@ -3,7 +3,6 @@ namespace PHPStan\Rules\BooleansInConditions; use PhpParser\Node; -use PhpParser\Node\Stmt\While_; use PHPStan\Analyser\Scope; use PHPStan\Rules\Rule; use PHPStan\Rules\RuleErrorBuilder; @@ -11,7 +10,7 @@ use function sprintf; /** - * @implements Rule + * @implements Rule */ class BooleanInWhileConditionRule implements Rule { @@ -25,7 +24,7 @@ public function __construct(BooleanRuleHelper $helper) public function getNodeType(): string { - return While_::class; + return Node\Stmt\While_::class; } public function processNode(Node $node, Scope $scope): array diff --git a/tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php b/tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php index 7f9c4118..a19b0a31 100644 --- a/tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php +++ b/tests/Rules/BooleansInConditions/BooleanInDoWhileConditionRuleTest.php @@ -2,8 +2,6 @@ namespace PHPStan\Rules\BooleansInConditions; -use PHPStan\Rules\BooleansInConditions\BooleanInDoWhileConditionRule; -use PHPStan\Rules\BooleansInConditions\BooleanRuleHelper; use PHPStan\Rules\Rule; use PHPStan\Rules\RuleLevelHelper; use PHPStan\Testing\RuleTestCase; diff --git a/tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php b/tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php index 76cf1a88..82a8a4ed 100644 --- a/tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php +++ b/tests/Rules/BooleansInConditions/BooleanInWhileConditionRuleTest.php @@ -2,8 +2,6 @@ namespace PHPStan\Rules\BooleansInConditions; -use PHPStan\Rules\BooleansInConditions\BooleanInWhileConditionRule; -use PHPStan\Rules\BooleansInConditions\BooleanRuleHelper; use PHPStan\Rules\Rule; use PHPStan\Rules\RuleLevelHelper; use PHPStan\Testing\RuleTestCase; From 1f818d401a55df5f74f2ade5b4e60c82028ea94a Mon Sep 17 00:00:00 2001 From: Vincent Langlet Date: Fri, 28 Feb 2025 09:54:21 +0100 Subject: [PATCH 3/4] Bleeding edge --- rules.neon | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rules.neon b/rules.neon index 3af67367..dd20b8d1 100644 --- a/rules.neon +++ b/rules.neon @@ -15,6 +15,7 @@ parameters: allRules: true disallowedLooseComparison: %strictRules.allRules% booleansInConditions: %strictRules.allRules% + booleansInLoopConditions: [%strictRules.allRules%, %featureToggles.bleedingEdge%] uselessCast: %strictRules.allRules% requireParentConstructorCall: %strictRules.allRules% disallowedBacktick: %strictRules.allRules% @@ -37,6 +38,7 @@ parametersSchema: allRules: anyOf(bool(), arrayOf(bool())), disallowedLooseComparison: anyOf(bool(), arrayOf(bool())), booleansInConditions: anyOf(bool(), arrayOf(bool())) + booleansInLoopConditions: anyOf(bool(), arrayOf(bool())) uselessCast: anyOf(bool(), arrayOf(bool())) requireParentConstructorCall: anyOf(bool(), arrayOf(bool())) disallowedBacktick: anyOf(bool(), arrayOf(bool())) @@ -65,7 +67,7 @@ conditionalTags: PHPStan\Rules\BooleansInConditions\BooleanInBooleanOrRule: phpstan.rules.rule: %strictRules.booleansInConditions% PHPStan\Rules\BooleansInConditions\BooleanInDoWhileConditionRule: - phpstan.rules.rule: %strictRules.booleansInConditions% + phpstan.rules.rule: %strictRules.booleansInLoopConditions% PHPStan\Rules\BooleansInConditions\BooleanInElseIfConditionRule: phpstan.rules.rule: %strictRules.booleansInConditions% PHPStan\Rules\BooleansInConditions\BooleanInIfConditionRule: @@ -73,7 +75,7 @@ conditionalTags: PHPStan\Rules\BooleansInConditions\BooleanInTernaryOperatorRule: phpstan.rules.rule: %strictRules.booleansInConditions% PHPStan\Rules\BooleansInConditions\BooleanInWhileConditionRule: - phpstan.rules.rule: %strictRules.booleansInConditions% + phpstan.rules.rule: %strictRules.booleansInLoopConditions% PHPStan\Rules\Cast\UselessCastRule: phpstan.rules.rule: %strictRules.uselessCast% PHPStan\Rules\Classes\RequireParentConstructCallRule: From fa0879cbc29bb0726ce5233ae0ecf70da05ecdf7 Mon Sep 17 00:00:00 2001 From: Vincent Langlet Date: Fri, 28 Feb 2025 09:55:51 +0100 Subject: [PATCH 4/4] Update readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 14ade92e..88b7e96f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ [PHPStan](https://phpstan.org/) focuses on finding bugs in your code. But in PHP there's a lot of leeway in how stuff can be written. This repository contains additional rules that revolve around strictly and strongly typed code with no loose casting for those who want additional safety in extremely defensive programming: * Require booleans in `if`, `elseif`, ternary operator, after `!`, and on both sides of `&&` and `||`. +* Require booleans in `while` and `do while` loop conditions. * Require numeric operands or arrays in `+` and numeric operands in `-`/`*`/`/`/`**`/`%`. * Require numeric operand in `$var++`, `$var--`, `++$var`and `--$var`. * These functions contain a `$strict` parameter for better type safety, it must be set to `true`: @@ -64,6 +65,7 @@ parameters: strictRules: disallowedLooseComparison: false booleansInConditions: false + booleansInLoopConditions: false uselessCast: false requireParentConstructorCall: false disallowedBacktick: false