BooleanInBooleanAndRule, BooleanInBooleanOrRule - different identifier and description for logical operators

Author: ondrejmirtes

rules.neon

@@ -142,12 +142,16 @@ services:
 
 	-
 		class: PHPStan\Rules\BooleansInConditions\BooleanInBooleanAndRule
+		arguments:
+			bleedingEdge: %featureToggles.bleedingEdge%
 
 	-
 		class: PHPStan\Rules\BooleansInConditions\BooleanInBooleanNotRule
 
 	-
 		class: PHPStan\Rules\BooleansInConditions\BooleanInBooleanOrRule
+		arguments:
+			bleedingEdge: %featureToggles.bleedingEdge%
 
 	-
 		class: PHPStan\Rules\BooleansInConditions\BooleanInElseIfConditionRule

src/Rules/BooleansInConditions/BooleanInBooleanAndRule.php

@@ -19,9 +19,13 @@ class BooleanInBooleanAndRule implements Rule
 	/** @var BooleanRuleHelper */
 	private $helper;
 
-	public function __construct(BooleanRuleHelper $helper)
+	/** @var bool */
+	private $bleedingEdge;
+
+	public function __construct(BooleanRuleHelper $helper, bool $bleedingEdge)
 	{
 		$this->helper = $helper;
+		$this->bleedingEdge = $bleedingEdge;
 	}
 
 	public function getNodeType(): string
@@ -33,21 +37,25 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		$originalNode = $node->getOriginalNode();
 		$messages = [];
+		$nodeText = $this->bleedingEdge ? $originalNode->getOperatorSigil() : '&&';
+		$identifierType = $originalNode instanceof Node\Expr\BinaryOp\BooleanAnd ? 'booleanAnd' : 'logicalAnd';
 		if (!$this->helper->passesAsBoolean($scope, $originalNode->left)) {
 			$leftType = $scope->getType($originalNode->left);
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Only booleans are allowed in &&, %s given on the left side.',
+				'Only booleans are allowed in %s, %s given on the left side.',
+				$nodeText,
 				$leftType->describe(VerbosityLevel::typeOnly())
-			))->identifier('booleanAnd.leftNotBoolean')->build();
+			))->identifier(sprintf('%s.leftNotBoolean', $identifierType))->build();
 		}
 
 		$rightScope = $node->getRightScope();
 		if (!$this->helper->passesAsBoolean($rightScope, $originalNode->right)) {
 			$rightType = $rightScope->getType($originalNode->right);
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Only booleans are allowed in &&, %s given on the right side.',
+				'Only booleans are allowed in %s, %s given on the right side.',
+				$nodeText,
 				$rightType->describe(VerbosityLevel::typeOnly())
-			))->identifier('booleanAnd.rightNotBoolean')->build();
+			))->identifier(sprintf('%s.rightNotBoolean', $identifierType))->build();
 		}
 
 		return $messages;

src/Rules/BooleansInConditions/BooleanInBooleanOrRule.php

@@ -19,9 +19,13 @@ class BooleanInBooleanOrRule implements Rule
 	/** @var BooleanRuleHelper */
 	private $helper;
 
-	public function __construct(BooleanRuleHelper $helper)
+	/** @var bool */
+	private $bleedingEdge;
+
+	public function __construct(BooleanRuleHelper $helper, bool $bleedingEdge)
 	{
 		$this->helper = $helper;
+		$this->bleedingEdge = $bleedingEdge;
 	}
 
 	public function getNodeType(): string
@@ -33,21 +37,25 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		$originalNode = $node->getOriginalNode();
 		$messages = [];
+		$nodeText = $this->bleedingEdge ? $originalNode->getOperatorSigil() : '||';
+		$identifierType = $originalNode instanceof Node\Expr\BinaryOp\BooleanOr ? 'booleanOr' : 'logicalOr';
 		if (!$this->helper->passesAsBoolean($scope, $originalNode->left)) {
 			$leftType = $scope->getType($originalNode->left);
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Only booleans are allowed in ||, %s given on the left side.',
+				'Only booleans are allowed in %s, %s given on the left side.',
+				$nodeText,
 				$leftType->describe(VerbosityLevel::typeOnly())
-			))->identifier('booleanOr.leftNotBoolean')->build();
+			))->identifier(sprintf('%s.leftNotBoolean', $identifierType))->build();
 		}
 
 		$rightScope = $node->getRightScope();
 		if (!$this->helper->passesAsBoolean($rightScope, $originalNode->right)) {
 			$rightType = $rightScope->getType($originalNode->right);
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Only booleans are allowed in ||, %s given on the right side.',
+				'Only booleans are allowed in %s, %s given on the right side.',
+				$nodeText,
 				$rightType->describe(VerbosityLevel::typeOnly())
-			))->identifier('booleanOr.rightNotBoolean')->build();
+			))->identifier(sprintf('%s.rightNotBoolean', $identifierType))->build();
 		}
 
 		return $messages;

tests/Rules/BooleansInConditions/BooleanInBooleanAndRuleTest.php

@@ -17,7 +17,8 @@ protected function getRule(): Rule
 		return new BooleanInBooleanAndRule(
 			new BooleanRuleHelper(
 				self::getContainer()->getByType(RuleLevelHelper::class)
-			)
+			),
+			true
 		);
 	}
 
@@ -44,6 +45,14 @@ public function testRule(): void
 				'Only booleans are allowed in &&, mixed given on the right side.',
 				19,
 			],
+			[
+				'Only booleans are allowed in and, mixed given on the right side.',
+				47,
+			],
+			[
+				'Only booleans are allowed in and, mixed given on the left side.',
+				48,
+			],
 		]);
 	}
 
@@ -61,11 +70,11 @@ public function testLogicalAnd(): void
 	{
 		$this->analyse([__DIR__ . '/data/logical-and.php'], [
 			[
-				'Only booleans are allowed in &&, string|false given on the left side.',
+				'Only booleans are allowed in and, string|false given on the left side.',
 				14,
 			],
 			[
-				'Only booleans are allowed in &&, mixed given on the right side.',
+				'Only booleans are allowed in and, mixed given on the right side.',
 				14,
 			],
 		]);

tests/Rules/BooleansInConditions/BooleanInBooleanOrRuleTest.php

@@ -17,7 +17,8 @@ protected function getRule(): Rule
 		return new BooleanInBooleanOrRule(
 			new BooleanRuleHelper(
 				self::getContainer()->getByType(RuleLevelHelper::class)
-			)
+			),
+			true
 		);
 	}
 
@@ -40,6 +41,14 @@ public function testRule(): void
 				'Only booleans are allowed in ||, mixed given on the right side.',
 				29,
 			],
+			[
+				'Only booleans are allowed in or, mixed given on the right side.',
+				49,
+			],
+			[
+				'Only booleans are allowed in or, mixed given on the left side.',
+				50,
+			],
 		]);
 	}
 

tests/Rules/BooleansInConditions/data/conditions.php

@@ -43,3 +43,8 @@
 $bool ? 1 : 2;
 $string ? 1 : 2;
 $string ?: null;
+
+$bool and $explicitMixed;
+$explicitMixed and $bool;
+$bool or $explicitMixed;
+$explicitMixed or $bool;