Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 3e139cb

Browse files
Check for boolean in while conditions
1 parent b20f78c commit 3e139cb

File tree

7 files changed

+184
-0
lines changed

7 files changed

+184
-0
lines changed

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
[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:
88

99
* Require booleans in `if`, `elseif`, ternary operator, after `!`, and on both sides of `&&` and `||`.
10+
* Require booleans in `while` and `do while` loop conditions.
1011
* Require numeric operands or arrays in `+` and numeric operands in `-`/`*`/`/`/`**`/`%`.
1112
* Require numeric operand in `$var++`, `$var--`, `++$var`and `--$var`.
1213
* These functions contain a `$strict` parameter for better type safety, it must be set to `true`:
@@ -64,6 +65,7 @@ parameters:
6465
strictRules:
6566
disallowedLooseComparison: false
6667
booleansInConditions: false
68+
booleansInLoopConditions: false
6769
uselessCast: false
6870
requireParentConstructorCall: false
6971
disallowedBacktick: false

‎rules.neon‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ parameters:
1515
allRules: true
1616
disallowedLooseComparison: %strictRules.allRules%
1717
booleansInConditions: %strictRules.allRules%
18+
booleansInLoopConditions: [%strictRules.allRules%, %featureToggles.bleedingEdge%]
1819
uselessCast: %strictRules.allRules%
1920
requireParentConstructorCall: %strictRules.allRules%
2021
disallowedBacktick: %strictRules.allRules%
@@ -37,6 +38,7 @@ parametersSchema:
3738
allRules: anyOf(bool(), arrayOf(bool())),
3839
disallowedLooseComparison: anyOf(bool(), arrayOf(bool())),
3940
booleansInConditions: anyOf(bool(), arrayOf(bool()))
41+
booleansInLoopConditions: anyOf(bool(), arrayOf(bool()))
4042
uselessCast: anyOf(bool(), arrayOf(bool()))
4143
requireParentConstructorCall: anyOf(bool(), arrayOf(bool()))
4244
disallowedBacktick: anyOf(bool(), arrayOf(bool()))
@@ -64,12 +66,16 @@ conditionalTags:
6466
phpstan.rules.rule: %strictRules.booleansInConditions%
6567
PHPStan\Rules\BooleansInConditions\BooleanInBooleanOrRule:
6668
phpstan.rules.rule: %strictRules.booleansInConditions%
69+
PHPStan\Rules\BooleansInConditions\BooleanInDoWhileConditionRule:
70+
phpstan.rules.rule: %strictRules.booleansInLoopConditions%
6771
PHPStan\Rules\BooleansInConditions\BooleanInElseIfConditionRule:
6872
phpstan.rules.rule: %strictRules.booleansInConditions%
6973
PHPStan\Rules\BooleansInConditions\BooleanInIfConditionRule:
7074
phpstan.rules.rule: %strictRules.booleansInConditions%
7175
PHPStan\Rules\BooleansInConditions\BooleanInTernaryOperatorRule:
7276
phpstan.rules.rule: %strictRules.booleansInConditions%
77+
PHPStan\Rules\BooleansInConditions\BooleanInWhileConditionRule:
78+
phpstan.rules.rule: %strictRules.booleansInLoopConditions%
7379
PHPStan\Rules\Cast\UselessCastRule:
7480
phpstan.rules.rule: %strictRules.uselessCast%
7581
PHPStan\Rules\Classes\RequireParentConstructCallRule:
@@ -163,6 +169,9 @@ services:
163169
-
164170
class: PHPStan\Rules\BooleansInConditions\BooleanInBooleanOrRule
165171

172+
-
173+
class: PHPStan\Rules\BooleansInConditions\BooleanInDoWhileConditionRule
174+
166175
-
167176
class: PHPStan\Rules\BooleansInConditions\BooleanInElseIfConditionRule
168177

@@ -172,6 +181,9 @@ services:
172181
-
173182
class: PHPStan\Rules\BooleansInConditions\BooleanInTernaryOperatorRule
174183

184+
-
185+
class: PHPStan\Rules\BooleansInConditions\BooleanInWhileConditionRule
186+
175187
-
176188
class: PHPStan\Rules\Cast\UselessCastRule
177189
arguments:
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Rules\BooleansInConditions;
4+
5+
use PhpParser\Node;
6+
use PHPStan\Analyser\Scope;
7+
use PHPStan\Rules\Rule;
8+
use PHPStan\Rules\RuleErrorBuilder;
9+
use PHPStan\Type\VerbosityLevel;
10+
use function sprintf;
11+
12+
/**
13+
* @implements Rule<Node\Stmt\Do_>
14+
*/
15+
class BooleanInDoWhileConditionRule implements Rule
16+
{
17+
18+
private BooleanRuleHelper $helper;
19+
20+
public function __construct(BooleanRuleHelper $helper)
21+
{
22+
$this->helper = $helper;
23+
}
24+
25+
public function getNodeType(): string
26+
{
27+
return Node\Stmt\Do_::class;
28+
}
29+
30+
public function processNode(Node $node, Scope $scope): array
31+
{
32+
if ($this->helper->passesAsBoolean($scope, $node->cond)) {
33+
return [];
34+
}
35+
36+
$conditionExpressionType = $scope->getType($node->cond);
37+
38+
return [
39+
RuleErrorBuilder::message(sprintf(
40+
'Only booleans are allowed in a do-while condition, %s given.',
41+
$conditionExpressionType->describe(VerbosityLevel::typeOnly()),
42+
))->identifier('doWhile.condNotBoolean')->build(),
43+
];
44+
}
45+
46+
}
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Rules\BooleansInConditions;
4+
5+
use PhpParser\Node;
6+
use PHPStan\Analyser\Scope;
7+
use PHPStan\Rules\Rule;
8+
use PHPStan\Rules\RuleErrorBuilder;
9+
use PHPStan\Type\VerbosityLevel;
10+
use function sprintf;
11+
12+
/**
13+
* @implements Rule<Node\Stmt\While_>
14+
*/
15+
class BooleanInWhileConditionRule implements Rule
16+
{
17+
18+
private BooleanRuleHelper $helper;
19+
20+
public function __construct(BooleanRuleHelper $helper)
21+
{
22+
$this->helper = $helper;
23+
}
24+
25+
public function getNodeType(): string
26+
{
27+
return Node\Stmt\While_::class;
28+
}
29+
30+
public function processNode(Node $node, Scope $scope): array
31+
{
32+
if ($this->helper->passesAsBoolean($scope, $node->cond)) {
33+
return [];
34+
}
35+
36+
$conditionExpressionType = $scope->getType($node->cond);
37+
38+
return [
39+
RuleErrorBuilder::message(sprintf(
40+
'Only booleans are allowed in a while condition, %s given.',
41+
$conditionExpressionType->describe(VerbosityLevel::typeOnly()),
42+
))->identifier('while.condNotBoolean')->build(),
43+
];
44+
}
45+
46+
}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Rules\BooleansInConditions;
4+
5+
use PHPStan\Rules\Rule;
6+
use PHPStan\Rules\RuleLevelHelper;
7+
use PHPStan\Testing\RuleTestCase;
8+
9+
/**
10+
* @extends RuleTestCase<BooleanInDoWhileConditionRule>
11+
*/
12+
class BooleanInDoWhileConditionRuleTest extends RuleTestCase
13+
{
14+
15+
protected function getRule(): Rule
16+
{
17+
return new BooleanInDoWhileConditionRule(
18+
new BooleanRuleHelper(
19+
self::getContainer()->getByType(RuleLevelHelper::class),
20+
),
21+
);
22+
}
23+
24+
public function testRule(): void
25+
{
26+
$this->analyse([__DIR__ . '/data/conditions.php'], [
27+
[
28+
'Only booleans are allowed in a do-while condition, string given.',
29+
60,
30+
],
31+
]);
32+
}
33+
34+
}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Rules\BooleansInConditions;
4+
5+
use PHPStan\Rules\Rule;
6+
use PHPStan\Rules\RuleLevelHelper;
7+
use PHPStan\Testing\RuleTestCase;
8+
9+
/**
10+
* @extends RuleTestCase<BooleanInWhileConditionRule>
11+
*/
12+
class BooleanInWhileConditionRuleTest extends RuleTestCase
13+
{
14+
15+
protected function getRule(): Rule
16+
{
17+
return new BooleanInWhileConditionRule(
18+
new BooleanRuleHelper(
19+
self::getContainer()->getByType(RuleLevelHelper::class),
20+
),
21+
);
22+
}
23+
24+
public function testRule(): void
25+
{
26+
$this->analyse([__DIR__ . '/data/conditions.php'], [
27+
[
28+
'Only booleans are allowed in a while condition, string given.',
29+
55,
30+
],
31+
]);
32+
}
33+
34+
}

‎tests/Rules/BooleansInConditions/data/conditions.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,13 @@
4848
$explicitMixed and $bool;
4949
$bool or $explicitMixed;
5050
$explicitMixed or $bool;
51+
52+
$someBool = true;
53+
$someString = 'string';
54+
while ($someBool) { $someBool = !$someBool; }
55+
while ($someString) { $someString = ''; }
56+
57+
$someBool = true;
58+
$someString = 'string';
59+
do { $someBool = !$someBool; } while ($someBool);
60+
do { $someString = ''; } while ($someString);

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /