error message improvements (#63)

Co-authored-by: Markus Staab <[email protected]>

Author: staabm

src/Rules/PdoStatementExecuteErrorMethodRule.php

@@ -76,8 +76,13 @@ private function checkErrors(MethodReflection $methodReflection, MethodCall $met
                 return [];
             }
 
+            $placeholderExpectation = sprintf('Query expects %s placeholder', $placeholderCount);
+            if ($placeholderCount > 1) {
+                $placeholderExpectation = sprintf('Query expects %s placeholders', $placeholderCount);
+            }
+
             return [
-                RuleErrorBuilder::message(sprintf('Query expects %s placeholders, but no values are given to execute().', $placeholderCount))->line($methodCall->getLine())->build(),
+                RuleErrorBuilder::message(sprintf($placeholderExpectation.', but no values are given to execute().', $placeholderCount))->line($methodCall->getLine())->build(),
             ];
         }
 
@@ -100,14 +105,18 @@ private function checkParameterValues(MethodCall $methodCall, Scope $scope, stri
         $parameterCount = \count($parameters);
 
         if ($parameterCount !== $placeholderCount) {
-            if (1 === $parameterCount) {
-                return [
-                    RuleErrorBuilder::message(sprintf('Query expects %s placeholders, but %s value is given to execute().', $placeholderCount, $parameterCount))->line($methodCall->getLine())->build(),
-                ];
+            $placeholderExpectation = sprintf('Query expects %s placeholder', $placeholderCount);
+            if ($placeholderCount > 1) {
+                $placeholderExpectation = sprintf('Query expects %s placeholders', $placeholderCount);
+            }
+
+            $parameterActual = sprintf('but %s value is given to execute()', $parameterCount);
+            if ($parameterCount > 1) {
+                $parameterActual = sprintf('but %s values are given to execute()', $parameterCount);
             }
 
             return [
-                RuleErrorBuilder::message(sprintf('Query expects %s placeholders, but %s values are given to execute().', $placeholderCount, $parameterCount))->line($methodCall->getLine())->build(),
+                RuleErrorBuilder::message($placeholderExpectation.', '.$parameterActual.'.')->line($methodCall->getLine())->build(),
             ];
         }
 
@@ -121,7 +130,7 @@ private function checkParameterValues(MethodCall $methodCall, Scope $scope, stri
 
         foreach ($parameters as $placeholderKey => $value) {
             if (!\in_array($placeholderKey, $namedPlaceholders)) {
-                $errors[] = RuleErrorBuilder::message(sprintf('Value %s is given to execute(), but the query does not containt this placeholder.', $placeholderKey))->line($methodCall->getLine())->build();
+                $errors[] = RuleErrorBuilder::message(sprintf('Value %s is given to execute(), but the query does not contain this placeholder.', $placeholderKey))->line($methodCall->getLine())->build();
             }
         }
 

tests/PdoStatementExecuteErrorMethodRuleTest.php

@@ -16,7 +16,7 @@ protected function getRule(): Rule
         return $this->getRuleFromConfig(PdoStatementExecuteErrorMethodRule::class, __DIR__.'/../config/dba.neon');
     }
 
-    public function testSyntaxErrorInQueryRule(): void
+    public function testParameterErrors(): void
     {
         require_once __DIR__.'/data/pdo-stmt-execute-error.php';
 
@@ -26,15 +26,15 @@ public function testSyntaxErrorInQueryRule(): void
                 12,
             ],
             [
-                'Value :wrongParamName is given to execute(), but the query does not containt this placeholder.',
+                'Value :wrongParamName is given to execute(), but the query does not contain this placeholder.',
                 12,
             ],
             [
                 'Query expects placeholder :adaid, but it is missing from values given to execute().',
                 15,
             ],
             [
-                'Value :wrongParamName is given to execute(), but the query does not containt this placeholder.',
+                'Value :wrongParamName is given to execute(), but the query does not contain this placeholder.',
                 15,
             ],
             /*
@@ -43,12 +43,12 @@ public function testSyntaxErrorInQueryRule(): void
                 18,
             ],
             [
-                'Value :wrongParamValue is given to execute(), but the query does not containt this placeholder.',
+                'Value :wrongParamValue is given to execute(), but the query does not contain this placeholder.',
                 18,
             ],
             */
             [
-                'Query expects 1 placeholders, but no values are given to execute().',
+                'Query expects 1 placeholder, but no values are given to execute().',
                 21,
             ],
             [