Added rule identifiers (#706)

staabm · Nov 7, 2024 · a152c34 · a152c34
1 parent 61a6233
commit a152c34
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 27 deletions.
diff --git a/src/Rules/DoctrineKeyValueStyleRule.php b/src/Rules/DoctrineKeyValueStyleRule.php
@@ -10,8 +10,8 @@
 use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Name\FullyQualified;
 use PHPStan\Analyser\Scope;
+use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
-use PHPStan\Rules\RuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\IntegerRangeType;
@@ -65,7 +65,7 @@ public function getNodeType(): string
     }
 
     /**
-     * @return RuleError[]
+     * @return list<IdentifierRuleError>
      */
     public function processNode(Node $callLike, Scope $scope): array
     {
@@ -114,7 +114,7 @@ public function processNode(Node $callLike, Scope $scope): array
         $tableNames = $tableType->getConstantStrings();
         if (\count($tableNames) === 0) {
             return [
-                RuleErrorBuilder::message('Argument #0 expects a constant string, got ' . $tableType->describe(VerbosityLevel::precise()))->line($callLike->getStartLine())->build(),
+                RuleErrorBuilder::message('Argument #0 expects a constant string, got ' . $tableType->describe(VerbosityLevel::precise()))->identifier('dba.keyValue')->line($callLike->getStartLine())->build(),
             ];
         }
 
@@ -185,7 +185,7 @@ public function processNode(Node $callLike, Scope $scope): array
 
         $ruleErrors = [];
         foreach ($errors as $error) {
-            $ruleErrors[] = RuleErrorBuilder::message('Query error: ' . $error)->line($callLike->getStartLine())->build();
+            $ruleErrors[] = RuleErrorBuilder::message('Query error: ' . $error)->identifier('dba.keyValue')->line($callLike->getStartLine())->build();
         }
         return $ruleErrors;
     }

diff --git a/src/Rules/PdoStatementExecuteMethodRule.php b/src/Rules/PdoStatementExecuteMethodRule.php
@@ -9,8 +9,8 @@
 use PhpParser\Node\Expr\MethodCall;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
-use PHPStan\Rules\RuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\Constant\ConstantIntegerType;
@@ -55,7 +55,7 @@ public function processNode(Node $methodCall, Scope $scope): array
     }
 
     /**
-     * @return RuleError[]
+     * @return list<IdentifierRuleError>
      */
     private function checkErrors(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): array
     {
@@ -97,7 +97,7 @@ private function checkErrors(MethodReflection $methodReflection, MethodCall $met
             $parameters = $queryReflection->resolveParameters($parameterTypes) ?? [];
         } catch (UnresolvableQueryException $exception) {
             return [
-                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->line($methodCall->getStartLine())->build(),
+                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->identifier('dba.unresolvableQuery')->line($methodCall->getStartLine())->build(),
             ];
         }
 
@@ -110,13 +110,13 @@ private function checkErrors(MethodReflection $methodReflection, MethodCall $met
             }
         } catch (UnresolvableQueryException $exception) {
             return [
-                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->line($methodCall->getStartLine())->build(),
+                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->identifier('dba.unresolvableQuery')->line($methodCall->getStartLine())->build(),
             ];
         }
 
         $ruleErrors = [];
         foreach ($errors as $error) {
-            $ruleErrors[] = RuleErrorBuilder::message($error)->line($methodCall->getStartLine())->build();
+            $ruleErrors[] = RuleErrorBuilder::message($error)->identifier('dba.invalidPlaceholder')->line($methodCall->getStartLine())->build();
         }
 
         return $ruleErrors;

diff --git a/src/Rules/QueryPlanAnalyzerRule.php b/src/Rules/QueryPlanAnalyzerRule.php
@@ -10,8 +10,8 @@
 use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Name\FullyQualified;
 use PHPStan\Analyser\Scope;
+use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
-use PHPStan\Rules\RuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ObjectType;
@@ -92,15 +92,15 @@ public function processNode(Node $callLike, Scope $scope): array
             return $this->analyze($callLike, $scope);
         } catch (UnresolvableQueryException $exception) {
             return [
-                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->line($callLike->getStartLine())->build(),
+                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->identifier('dba.unresolvableQuery')->line($callLike->getStartLine())->build(),
             ];
         }
     }
 
     /**
      * @param MethodCall|New_ $callLike
      *
-     * @return RuleError[]
+     * @return list<IdentifierRuleError>
      */
     private function analyze(CallLike $callLike, Scope $scope): array
     {
@@ -144,6 +144,7 @@ private function analyze(CallLike $callLike, Scope $scope): array
                             $table
                         )
                     )
+                        ->identifier('dba.missingIndex')
                         ->line($callLike->getStartLine())
                         ->tip('see Mysql Docs https://dev.mysql.com/doc/refman/8.0/en/select-optimization.html')
                         ->build();
@@ -156,6 +157,7 @@ private function analyze(CallLike $callLike, Scope $scope): array
                             $table
                         )
                     )
+                        ->identifier('dba.tableScan')
                         ->line($callLike->getStartLine())
                         ->tip('see Mysql Docs https://dev.mysql.com/doc/refman/8.0/en/table-scan-avoidance.html')
                         ->build();
@@ -168,6 +170,7 @@ private function analyze(CallLike $callLike, Scope $scope): array
                             $table
                         )
                     )
+                        ->identifier('dba.unindexedReads')
                         ->line($callLike->getStartLine())
                         ->tip('see Mysql Docs https://dev.mysql.com/doc/refman/8.0/en/select-optimization.html')
                         ->build();

diff --git a/src/Rules/SyntaxErrorInDibiPreparedStatementMethodRule.php b/src/Rules/SyntaxErrorInDibiPreparedStatementMethodRule.php
@@ -11,8 +11,8 @@
 use PhpParser\Node\Name\FullyQualified;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
-use PHPStan\Rules\RuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\Constant\ConstantArrayType;
@@ -92,7 +92,7 @@ public function processNode(Node $callLike, Scope $scope): array
     /**
      * @param MethodCall|New_ $callLike
      *
-     * @return RuleError[]
+     * @return list<IdentifierRuleError>
      */
     private function checkErrors(CallLike $callLike, Scope $scope, MethodReflection $methodReflection): array
     {
@@ -171,7 +171,7 @@ private function checkErrors(CallLike $callLike, Scope $scope, MethodReflection
                 }
 
                 return [
-                    RuleErrorBuilder::message($placeholderExpectation . ', ' . $parameterActual . '.')->line($callLike->getStartLine())->build(),
+                    RuleErrorBuilder::message($placeholderExpectation . ', ' . $parameterActual . '.')->identifier('dba.placeholderMismatch')->line($callLike->getStartLine())->build(),
                 ];
             }
         }
@@ -196,7 +196,7 @@ private function checkErrors(CallLike $callLike, Scope $scope, MethodReflection
         $validity = $queryReflection->validateQueryString($queryParameters[0]);
 
         if (null !== $validity) {
-            return [RuleErrorBuilder::message($validity->asRuleMessage())->line($callLike->getStartLine())->build()];
+            return [RuleErrorBuilder::message($validity->asRuleMessage())->identifier('dba.syntaxError')->line($callLike->getStartLine())->build()];
         }
 
         $result = $queryReflection->getResultType($queryParameters[0], QueryReflector::FETCH_TYPE_BOTH);
@@ -206,11 +206,11 @@ private function checkErrors(CallLike $callLike, Scope $scope, MethodReflection
             $columnsInResult = \count($result->getValueTypes()) / 2;
 
             if ('fetchPairs' === $methodReflection->getName() && 2 !== $columnsInResult) {
-                return [RuleErrorBuilder::message('fetchPairs requires exactly 2 selected columns, got ' . $columnsInResult . '.')->line($callLike->getStartLine())->build()];
+                return [RuleErrorBuilder::message('fetchPairs requires exactly 2 selected columns, got ' . $columnsInResult . '.')->identifier('dba.error')->line($callLike->getStartLine())->build()];
             }
 
             if ('fetchSingle' === $methodReflection->getName() && 1 !== $columnsInResult) {
-                return [RuleErrorBuilder::message('fetchSingle requires exactly 1 selected column, got ' . $columnsInResult . '.')->line($callLike->getStartLine())->build()];
+                return [RuleErrorBuilder::message('fetchSingle requires exactly 1 selected column, got ' . $columnsInResult . '.')->identifier('dba.error')->line($callLike->getStartLine())->build()];
             }
         }
 

diff --git a/src/Rules/SyntaxErrorInPreparedStatementMethodRule.php b/src/Rules/SyntaxErrorInPreparedStatementMethodRule.php
@@ -10,8 +10,8 @@
 use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Name\FullyQualified;
 use PHPStan\Analyser\Scope;
+use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
-use PHPStan\Rules\RuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ObjectType;
@@ -89,7 +89,7 @@ public function processNode(Node $callLike, Scope $scope): array
     /**
      * @param MethodCall|New_ $callLike
      *
-     * @return RuleError[]
+     * @return list<IdentifierRuleError>
      */
     private function checkErrors(CallLike $callLike, Scope $scope): array
     {
@@ -113,7 +113,7 @@ private function checkErrors(CallLike $callLike, Scope $scope): array
                 $parameters = $queryReflection->resolveParameters($parameterTypes) ?? [];
             } catch (UnresolvableQueryException $exception) {
                 return [
-                    RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->line($callLike->getStartLine())->build(),
+                    RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->identifier('dba.unresolvableQuery')->line($callLike->getStartLine())->build(),
                 ];
             }
         }
@@ -144,13 +144,13 @@ private function checkErrors(CallLike $callLike, Scope $scope): array
 
             $ruleErrors = [];
             foreach ($errors as $error) {
-                $ruleErrors[] = RuleErrorBuilder::message($error)->line($callLike->getStartLine())->build();
+                $ruleErrors[] = RuleErrorBuilder::message($error)->identifier('dba.syntaxError')->line($callLike->getStartLine())->build();
             }
 
             return $ruleErrors;
         } catch (UnresolvableQueryException $exception) {
             return [
-                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->line($callLike->getStartLine())->build(),
+                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->identifier('dba.unresolvableQuery')->line($callLike->getStartLine())->build(),
             ];
         }
     }

diff --git a/src/Rules/SyntaxErrorInQueryFunctionRule.php b/src/Rules/SyntaxErrorInQueryFunctionRule.php
@@ -96,13 +96,13 @@ public function processNode(Node $node, Scope $scope): array
                 $queryError = $queryReflection->validateQueryString($queryString);
                 if (null !== $queryError) {
                     return [
-                        RuleErrorBuilder::message($queryError->asRuleMessage())->line($node->getStartLine())->build(),
+                        RuleErrorBuilder::message($queryError->asRuleMessage())->identifier('dba.syntaxError')->line($node->getStartLine())->build(),
                     ];
                 }
             }
         } catch (UnresolvableQueryException $exception) {
             return [
-                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->line($node->getStartLine())->build(),
+                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->identifier('dba.unresolvableQuery')->line($node->getStartLine())->build(),
             ];
         }
 

diff --git a/src/Rules/SyntaxErrorInQueryMethodRule.php b/src/Rules/SyntaxErrorInQueryMethodRule.php
@@ -91,13 +91,13 @@ public function processNode(Node $node, Scope $scope): array
                 $queryError = $queryReflection->validateQueryString($queryString);
                 if (null !== $queryError) {
                     return [
-                        RuleErrorBuilder::message($queryError->asRuleMessage())->line($node->getStartLine())->build(),
+                        RuleErrorBuilder::message($queryError->asRuleMessage())->identifier('dba.syntaxError')->line($node->getStartLine())->build(),
                     ];
                 }
             }
         } catch (UnresolvableQueryException $exception) {
             return [
-                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->line($node->getStartLine())->build(),
+                RuleErrorBuilder::message($exception->asRuleMessage())->tip($exception::getTip())->identifier('dba.unresolvableQuery')->line($node->getStartLine())->build(),
             ];
         }