Numeric operands in arithmetic operations - more verbose error messages, don't skip mixed when the other side is wrong

ondrejmirtes · ondrejmirtes · commit c58d3392cfdf · 2018-05-31T11:34:11.000+02:00
diff --git a/src/Rules/Operators/OperandsInArithmeticAdditionRule.php b/src/Rules/Operators/OperandsInArithmeticAdditionRule.php
@@ -4,6 +4,7 @@
 
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\VerbosityLevel;
 
 class OperandsInArithmeticAdditionRule implements \PHPStan\Rules\Rule
 {
@@ -22,18 +23,27 @@ public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scop
 	{
 		$leftType = $scope->getType($node->left);
 		$rightType = $scope->getType($node->right);
-
-		if (OperatorRuleHelper::isValidForArithmeticOperation($leftType, $rightType)) {
-			return [];
-		}
-
 		$mixedArrayType = new ArrayType(new MixedType(), new MixedType());
 
 		if ($mixedArrayType->isSuperTypeOf($leftType)->yes() && $mixedArrayType->isSuperTypeOf($rightType)->yes()) {
 			return [];
 		}
 
-		return ['Only numeric types or arrays are allowed in arithmetic addition.'];
+		$messages = [];
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($leftType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in +, %s given on the left side.',
+				$leftType->describe(VerbosityLevel::typeOnly())
+			);
+		}
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($rightType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in +, %s given on the right side.',
+				$rightType->describe(VerbosityLevel::typeOnly())
+			);
+		}
+
+		return $messages;
 	}
 
 }
diff --git a/src/Rules/Operators/OperandsInArithmeticDivisionRule.php b/src/Rules/Operators/OperandsInArithmeticDivisionRule.php
@@ -2,6 +2,8 @@
 
 namespace PHPStan\Rules\Operators;
 
+use PHPStan\Type\VerbosityLevel;
+
 class OperandsInArithmeticDivisionRule implements \PHPStan\Rules\Rule
 {
 
@@ -17,14 +19,24 @@ public function getNodeType(): string
 	 */
 	public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array
 	{
+		$messages = [];
 		$leftType = $scope->getType($node->left);
-		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($leftType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in /, %s given on the left side.',
+				$leftType->describe(VerbosityLevel::typeOnly())
+			);
+		}
 
-		if (OperatorRuleHelper::isValidForArithmeticOperation($leftType, $rightType)) {
-			return [];
+		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($rightType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in /, %s given on the right side.',
+				$rightType->describe(VerbosityLevel::typeOnly())
+			);
 		}
 
-		return ['Only numeric types are allowed in arithmetic division.'];
+		return $messages;
 	}
 
 }
diff --git a/src/Rules/Operators/OperandsInArithmeticExponentiationRule.php b/src/Rules/Operators/OperandsInArithmeticExponentiationRule.php
@@ -2,6 +2,8 @@
 
 namespace PHPStan\Rules\Operators;
 
+use PHPStan\Type\VerbosityLevel;
+
 class OperandsInArithmeticExponentiationRule implements \PHPStan\Rules\Rule
 {
 
@@ -17,14 +19,24 @@ public function getNodeType(): string
 	 */
 	public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array
 	{
+		$messages = [];
 		$leftType = $scope->getType($node->left);
-		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($leftType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in **, %s given on the left side.',
+				$leftType->describe(VerbosityLevel::typeOnly())
+			);
+		}
 
-		if (OperatorRuleHelper::isValidForArithmeticOperation($leftType, $rightType)) {
-			return [];
+		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($rightType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in **, %s given on the right side.',
+				$rightType->describe(VerbosityLevel::typeOnly())
+			);
 		}
 
-		return ['Only numeric types are allowed in arithmetic exponentiation.'];
+		return $messages;
 	}
 
 }
diff --git a/src/Rules/Operators/OperandsInArithmeticModuloRule.php b/src/Rules/Operators/OperandsInArithmeticModuloRule.php
@@ -2,6 +2,8 @@
 
 namespace PHPStan\Rules\Operators;
 
+use PHPStan\Type\VerbosityLevel;
+
 class OperandsInArithmeticModuloRule implements \PHPStan\Rules\Rule
 {
 
@@ -17,14 +19,24 @@ public function getNodeType(): string
 	 */
 	public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array
 	{
+		$messages = [];
 		$leftType = $scope->getType($node->left);
-		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($leftType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in %%, %s given on the left side.',
+				$leftType->describe(VerbosityLevel::typeOnly())
+			);
+		}
 
-		if (OperatorRuleHelper::isValidForArithmeticOperation($leftType, $rightType)) {
-			return [];
+		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($rightType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in %%, %s given on the right side.',
+				$rightType->describe(VerbosityLevel::typeOnly())
+			);
 		}
 
-		return ['Only numeric types are allowed in arithmetic modulo.'];
+		return $messages;
 	}
 
 }
diff --git a/src/Rules/Operators/OperandsInArithmeticMultiplicationRule.php b/src/Rules/Operators/OperandsInArithmeticMultiplicationRule.php
@@ -2,6 +2,8 @@
 
 namespace PHPStan\Rules\Operators;
 
+use PHPStan\Type\VerbosityLevel;
+
 class OperandsInArithmeticMultiplicationRule implements \PHPStan\Rules\Rule
 {
 
@@ -17,14 +19,24 @@ public function getNodeType(): string
 	 */
 	public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array
 	{
+		$messages = [];
 		$leftType = $scope->getType($node->left);
-		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($leftType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in *, %s given on the left side.',
+				$leftType->describe(VerbosityLevel::typeOnly())
+			);
+		}
 
-		if (OperatorRuleHelper::isValidForArithmeticOperation($leftType, $rightType)) {
-			return [];
+		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($rightType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in *, %s given on the right side.',
+				$rightType->describe(VerbosityLevel::typeOnly())
+			);
 		}
 
-		return ['Only numeric types are allowed in arithmetic multiplication.'];
+		return $messages;
 	}
 
 }
diff --git a/src/Rules/Operators/OperandsInArithmeticSubtractionRule.php b/src/Rules/Operators/OperandsInArithmeticSubtractionRule.php
@@ -2,6 +2,8 @@
 
 namespace PHPStan\Rules\Operators;
 
+use PHPStan\Type\VerbosityLevel;
+
 class OperandsInArithmeticSubtractionRule implements \PHPStan\Rules\Rule
 {
 
@@ -17,14 +19,24 @@ public function getNodeType(): string
 	 */
 	public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array
 	{
+		$messages = [];
 		$leftType = $scope->getType($node->left);
-		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($leftType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in -, %s given on the left side.',
+				$leftType->describe(VerbosityLevel::typeOnly())
+			);
+		}
 
-		if (OperatorRuleHelper::isValidForArithmeticOperation($leftType, $rightType)) {
-			return [];
+		$rightType = $scope->getType($node->right);
+		if (!OperatorRuleHelper::isValidForArithmeticOperation($rightType)) {
+			$messages[] = sprintf(
+				'Only numeric types are allowed in -, %s given on the right side.',
+				$rightType->describe(VerbosityLevel::typeOnly())
+			);
 		}
 
-		return ['Only numeric types are allowed in arithmetic subtraction.'];
+		return $messages;
 	}
 
 }
diff --git a/src/Rules/Operators/OperatorRuleHelper.php b/src/Rules/Operators/OperatorRuleHelper.php
@@ -11,15 +11,15 @@
 class OperatorRuleHelper
 {
 
-	public static function isValidForArithmeticOperation(Type $leftType, Type $rightType): bool
+	public static function isValidForArithmeticOperation(Type $type): bool
 	{
-		if ($leftType instanceof MixedType || $rightType instanceof MixedType) {
+		if ($type instanceof MixedType) {
 			return true;
 		}
 
 		$acceptedType = new UnionType([new IntegerType(), new FloatType()]);
 
-		return $acceptedType->isSuperTypeOf($leftType)->yes() && $acceptedType->isSuperTypeOf($rightType)->yes();
+		return $acceptedType->isSuperTypeOf($type)->yes();
 	}
 
 }
diff --git a/tests/Rules/Operators/OperandsInArithmeticAdditionRuleTest.php b/tests/Rules/Operators/OperandsInArithmeticAdditionRuleTest.php
@@ -16,33 +16,45 @@ public function testRule(): void
 	{
 		$this->analyse([__DIR__ . '/data/operators.php'], [
 			[
-				'Only numeric types or arrays are allowed in arithmetic addition.',
+				'Only numeric types are allowed in +, string given on the right side.',
 				25,
 			],
 			[
-				'Only numeric types or arrays are allowed in arithmetic addition.',
+				'Only numeric types are allowed in +, array given on the right side.',
 				26,
 			],
 			[
-				'Only numeric types or arrays are allowed in arithmetic addition.',
+				'Only numeric types are allowed in +, stdClass given on the right side.',
 				27,
 			],
 			[
-				'Only numeric types or arrays are allowed in arithmetic addition.',
+				'Only numeric types are allowed in +, null given on the right side.',
 				28,
 			],
 			[
-				'Only numeric types or arrays are allowed in arithmetic addition.',
+				'Only numeric types are allowed in +, null given on the right side.',
 				29,
 			],
 			[
-				'Only numeric types or arrays are allowed in arithmetic addition.',
+				'Only numeric types are allowed in +, string given on the right side.',
 				29,
 			],
 			[
-				'Only numeric types or arrays are allowed in arithmetic addition.',
+				'Only numeric types are allowed in +, array given on the right side.',
 				30,
 			],
+			[
+				'Only numeric types are allowed in +, array given on the left side.',
+				30,
+			],
+			[
+				'Only numeric types are allowed in +, string given on the right side.',
+				101,
+			],
+			[
+				'Only numeric types are allowed in +, string given on the left side.',
+				102,
+			],
 		]);
 	}
 
diff --git a/tests/Rules/Operators/OperandsInArithmeticDivisionRuleTest.php b/tests/Rules/Operators/OperandsInArithmeticDivisionRuleTest.php
@@ -16,31 +16,35 @@ public function testRule(): void
 	{
 		$this->analyse([__DIR__ . '/data/operators.php'], [
 			[
-				'Only numeric types are allowed in arithmetic division.',
+				'Only numeric types are allowed in /, string given on the right side.',
 				64,
 			],
 			[
-				'Only numeric types are allowed in arithmetic division.',
+				'Only numeric types are allowed in /, array given on the right side.',
 				65,
 			],
 			[
-				'Only numeric types are allowed in arithmetic division.',
+				'Only numeric types are allowed in /, stdClass given on the right side.',
 				66,
 			],
 			[
-				'Only numeric types are allowed in arithmetic division.',
+				'Only numeric types are allowed in /, null given on the right side.',
 				67,
 			],
 			[
-				'Only numeric types are allowed in arithmetic division.',
+				'Only numeric types are allowed in /, null given on the right side.',
 				68,
 			],
 			[
-				'Only numeric types are allowed in arithmetic division.',
+				'Only numeric types are allowed in /, string given on the right side.',
 				68,
 			],
 			[
-				'Only numeric types are allowed in arithmetic division.',
+				'Only numeric types are allowed in /, array given on the right side.',
+				69,
+			],
+			[
+				'Only numeric types are allowed in /, array given on the left side.',
 				69,
 			],
 		]);
diff --git a/tests/Rules/Operators/OperandsInArithmeticExponentiationRuleTest.php b/tests/Rules/Operators/OperandsInArithmeticExponentiationRuleTest.php
@@ -16,31 +16,35 @@ public function testRule(): void
 	{
 		$this->analyse([__DIR__ . '/data/operators.php'], [
 			[
-				'Only numeric types are allowed in arithmetic exponentiation.',
+				'Only numeric types are allowed in **, string given on the right side.',
 				77,
 			],
 			[
-				'Only numeric types are allowed in arithmetic exponentiation.',
+				'Only numeric types are allowed in **, array given on the right side.',
 				78,
 			],
 			[
-				'Only numeric types are allowed in arithmetic exponentiation.',
+				'Only numeric types are allowed in **, stdClass given on the right side.',
 				79,
 			],
 			[
-				'Only numeric types are allowed in arithmetic exponentiation.',
+				'Only numeric types are allowed in **, null given on the right side.',
 				80,
 			],
 			[
-				'Only numeric types are allowed in arithmetic exponentiation.',
+				'Only numeric types are allowed in **, string given on the left side.',
 				81,
 			],
 			[
-				'Only numeric types are allowed in arithmetic exponentiation.',
+				'Only numeric types are allowed in **, null given on the right side.',
+				81,
+			],
+			[
+				'Only numeric types are allowed in **, array given on the left side.',
 				82,
 			],
 			[
-				'Only numeric types are allowed in arithmetic exponentiation.',
+				'Only numeric types are allowed in **, array given on the left side.',
 				82,
 			],
 		]);
diff --git a/tests/Rules/Operators/OperandsInArithmeticModuloRuleTest.php b/tests/Rules/Operators/OperandsInArithmeticModuloRuleTest.php
diff --git a/tests/Rules/Operators/OperandsInArithmeticMultiplicationRuleTest.php b/tests/Rules/Operators/OperandsInArithmeticMultiplicationRuleTest.php
diff --git a/tests/Rules/Operators/OperandsInArithmeticSubtractionRuleTest.php b/tests/Rules/Operators/OperandsInArithmeticSubtractionRuleTest.php
diff --git a/tests/Rules/Operators/data/operators.php b/tests/Rules/Operators/data/operators.php

Original file line number	Diff line number	Diff line change
`@@ -11,15 +11,15 @@`
`11`	`11`	`class OperatorRuleHelper`
`12`	`12`	`{`
`13`	`13`
`14`		`- public static function isValidForArithmeticOperation(Type $leftType, Type $rightType): bool`
	`14`	`+ public static function isValidForArithmeticOperation(Type $type): bool`
`15`	`15`	`{`
`16`		`- if ($leftType instanceof MixedType \|\| $rightType instanceof MixedType) {`
	`16`	`+ if ($type instanceof MixedType) {`
`17`	`17`	`return true;`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`$acceptedType = new UnionType([new IntegerType(), new FloatType()]);`
`21`	`21`
`22`		`- return $acceptedType->isSuperTypeOf($leftType)->yes() && $acceptedType->isSuperTypeOf($rightType)->yes();`
	`22`	`+ return $acceptedType->isSuperTypeOf($type)->yes();`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,31 +16,35 @@ public function testRule(): void`
`16`	`16`	`{`
`17`	`17`	`$this->analyse([__DIR__ . '/data/operators.php'], [`
`18`	`18`	`[`
`19`		`- 'Only numeric types are allowed in arithmetic division.',`
	`19`	`+ 'Only numeric types are allowed in /, string given on the right side.',`
`20`	`20`	`64,`
`21`	`21`	`],`
`22`	`22`	`[`
`23`		`- 'Only numeric types are allowed in arithmetic division.',`
	`23`	`+ 'Only numeric types are allowed in /, array given on the right side.',`
`24`	`24`	`65,`
`25`	`25`	`],`
`26`	`26`	`[`
`27`		`- 'Only numeric types are allowed in arithmetic division.',`
	`27`	`+ 'Only numeric types are allowed in /, stdClass given on the right side.',`
`28`	`28`	`66,`
`29`	`29`	`],`
`30`	`30`	`[`
`31`		`- 'Only numeric types are allowed in arithmetic division.',`
	`31`	`+ 'Only numeric types are allowed in /, null given on the right side.',`
`32`	`32`	`67,`
`33`	`33`	`],`
`34`	`34`	`[`
`35`		`- 'Only numeric types are allowed in arithmetic division.',`
	`35`	`+ 'Only numeric types are allowed in /, null given on the right side.',`
`36`	`36`	`68,`
`37`	`37`	`],`
`38`	`38`	`[`
`39`		`- 'Only numeric types are allowed in arithmetic division.',`
	`39`	`+ 'Only numeric types are allowed in /, string given on the right side.',`
`40`	`40`	`68,`
`41`	`41`	`],`
`42`	`42`	`[`
`43`		`- 'Only numeric types are allowed in arithmetic division.',`
	`43`	`+ 'Only numeric types are allowed in /, array given on the right side.',`
	`44`	`+ 69,`
	`45`	`+ ],`
	`46`	`+ [`
	`47`	`+ 'Only numeric types are allowed in /, array given on the left side.',`
`44`	`48`	`69,`
`45`	`49`	`],`
`46`	`50`	`]);`