move helpers to base class

Author: mglaman

extension.neon

@@ -16,7 +16,7 @@ parameters:
 	scanFiles:
 		- stubs/Twig/functions.stub
 	drupal:
-		drupal_root: ~
+		drupal_root:
 		bleedingEdge:
 			checkDeprecatedHooksInApiFiles: false
 			checkCoreDeprecatedHooksInApiFiles: false

src/Rules/Deprecations/ConfigEntityConfigExportRule.php

@@ -4,8 +4,6 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
-use PHPStan\PhpDoc\ResolvedPhpDocBlock;
-use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\ShouldNotHappenException;
 use function preg_match;
@@ -23,7 +21,7 @@ protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $
         $phpDoc = $reflection->getResolvedPhpDoc();
         // Plugins should always be annotated, but maybe this class is missing its
         // annotation since it swaps an existing one.
-        if ($phpDoc === null || !$this->isAnnotated($phpDoc)) {
+        if ($phpDoc === null || !$this->isAnnotated($phpDoc, '@ConfigEntityType')) {
             return [];
         }
         $hasMatch = preg_match('/config_export\s?=\s?{/', $phpDoc->getPhpDocString());
@@ -37,16 +35,4 @@ protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $
         }
         return [];
     }
-
-    private function isAnnotated(ResolvedPhpDocBlock $phpDoc): bool
-    {
-        foreach ($phpDoc->getPhpDocNodes() as $docNode) {
-            foreach ($docNode->children as $childNode) {
-                if (($childNode instanceof PhpDocTagNode) && $childNode->name === '@ConfigEntityType') {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
 }

src/Rules/Deprecations/DeprecatedAnnotationsRuleBase.php

@@ -4,9 +4,14 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\PhpDoc\ResolvedPhpDocBlock;
+use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use ReflectionAttribute;
+use ReflectionClass;
+use ReflectionException;
 
 /**
  * @implements Rule<Node\Stmt\Class_>
@@ -64,4 +69,28 @@ public function processNode(Node $node, Scope $scope): array
 
         return $this->doProcessNode($reflection, $node, $scope);
     }
+
+    protected function isAnnotated(ResolvedPhpDocBlock $phpDoc, string $annotationId): bool
+    {
+        foreach ($phpDoc->getPhpDocNodes() as $docNode) {
+            foreach ($docNode->children as $childNode) {
+                if (($childNode instanceof PhpDocTagNode) && $childNode->name === $annotationId) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    protected function getPluginAttribute(ClassReflection $reflection, string $attributeName): ?ReflectionAttribute
+    {
+        try {
+            $nativeReflection = new ReflectionClass($reflection->getName());
+            $attribute = $nativeReflection->getAttributes($attributeName);
+        } catch (ReflectionException) {
+            return null;
+        }
+
+        return $attribute[0] ?? null;
+    }
 }

src/Rules/Deprecations/FieldTypeCategoryRule.php

@@ -9,11 +9,8 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\PhpDoc\ResolvedPhpDocBlock;
-use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 use PHPStan\Reflection\ClassReflection;
 use ReflectionAttribute;
-use ReflectionClass;
-use ReflectionException;
 use function array_key_exists;
 use function preg_match;
 
@@ -42,12 +39,12 @@ protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $
 
         $phpDoc = $reflection->getResolvedPhpDoc();
         if ($phpDoc instanceof ResolvedPhpDocBlock) {
-            if ($this->hasFieldTypeAnnotation($phpDoc) && preg_match('/category\s?=\s?@Translation/', $phpDoc->getPhpDocString()) === 1) {
+            if ($this->isAnnotated($phpDoc, '@FieldType') && preg_match('/category\s?=\s?@Translation/', $phpDoc->getPhpDocString()) === 1) {
                 $errors[] = self::DEPRECATION_MESSAGE;
             }
         }
 
-        $fieldTypeAttributes = $this->getFieldTypeAttributes($reflection);
+        $fieldTypeAttributes = $this->getPluginAttribute($reflection, FieldType::class);
         if ($fieldTypeAttributes instanceof ReflectionAttribute) {
             $arguments = $fieldTypeAttributes->getArguments();
             if (array_key_exists('category', $arguments) && $arguments['category'] instanceof TranslatableMarkup) {
@@ -57,47 +54,4 @@ protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $
 
         return $errors;
     }
-
-    /**
-     * Checks whether a PHP doc block contains a field type annotation.
-     *
-     * @param \PHPStan\PhpDoc\ResolvedPhpDocBlock $phpDoc
-     *   The PHP doc block object.
-     *
-     * @return bool
-     *   True if it does, otherwise false.
-     */
-    private function hasFieldTypeAnnotation(ResolvedPhpDocBlock $phpDoc): bool
-    {
-        foreach ($phpDoc->getPhpDocNodes() as $docNode) {
-            foreach ($docNode->children as $childNode) {
-                if (($childNode instanceof PhpDocTagNode) && $childNode->name === '@FieldType') {
-                    return true;
-                }
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Checks whether a given class has a field type attribute.
-     *
-     * @param \PHPStan\Reflection\ClassReflection $reflection
-     *   The class reflection object.
-     *
-     * @return ReflectionAttribute|null
-     *   The attribute, or null.
-     */
-    private function getFieldTypeAttributes(ClassReflection $reflection): ?ReflectionAttribute
-    {
-        try {
-            $nativeReflection = new ReflectionClass($reflection->getName());
-            $attribute = $nativeReflection->getAttributes(FieldType::class);
-        } catch (ReflectionException $e) {
-            return null;
-        }
-
-        return $attribute[0] ?? null;
-    }
 }