Field type deprecated translated category

src/Drupal/DrupalAutoloader.php

@@ -101,7 +101,6 @@ public function register(Container $container): void
             throw new RuntimeException("Unable to detect Drupal with webflo/drupal-finder.");
         }
         $this->drupalRoot = $drupalRoot;
-
         $this->autoloader = include $drupalVendorRoot . '/autoload.php';
 
         $this->serviceYamls['core'] = $drupalRoot . '/core/core.services.yml';

src/Rules/Deprecations/FieldTypeCategoryRule.php

@@ -0,0 +1,103 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Rules\Deprecations;
+
+use Drupal;
+use Drupal\Core\Field\Attribute\FieldType;
+use Drupal\Core\Field\FieldItemInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+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;
+
+/**
+ * Defines a rule for catching translated categories on field types.
+ *
+ * @see https://www.drupal.org/node/3375748
+ */
+final class FieldTypeCategoryRule extends DeprecatedAnnotationsRuleBase
+{
+
+    private const DEPRECATION_MESSAGE = 'Using a translatable string as a category for field type is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. See https://www.drupal.org/node/3375748';
+
+    protected function getExpectedInterface(): string
+    {
+        return FieldItemInterface::class;
+    }
+
+    protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $node, Scope $scope): array
+    {
+        if (version_compare(Drupal::VERSION, '10.2.0', '<')) {
+            return [];
+        }
+
+        $errors = [];
+
+        $phpDoc = $reflection->getResolvedPhpDoc();
+        if ($phpDoc instanceof ResolvedPhpDocBlock) {
+            if ($this->hasFieldTypeAnnotation($phpDoc) && preg_match('/category\s?=\s?@Translation/', $phpDoc->getPhpDocString()) === 1) {
+                $errors[] = self::DEPRECATION_MESSAGE;
+            }
+        }
+
+        $fieldTypeAttributes = $this->getFieldTypeAttributes($reflection);
+        if ($fieldTypeAttributes instanceof ReflectionAttribute) {
+            $arguments = $fieldTypeAttributes->getArguments();
+            if (array_key_exists('category', $arguments) && $arguments['category'] instanceof TranslatableMarkup) {
+                $errors[] = self::DEPRECATION_MESSAGE;
+            }
+        }
+
+        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;
+    }
+}

tests/fixtures/drupal/modules/phpstan_fixtures/src/Plugin/Field/FieldType/FieldTypeWithStringCategoryAttribute.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Drupal\phpstan_fixtures\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\Attribute\FieldType;
+use Drupal\Core\Field\Plugin\Field\FieldType\DecimalItem;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+/**
+ * Represents a field type with a translated category argument.
+ */
+#[FieldType(
+    id: "field_type_with_valid_attribute",
+    label: new TranslatableMarkup("Field Type With Valid Attribute"),
+    description: [
+        new TranslatableMarkup("This attribute is valid because the category is a string."),
+    ],
+    category: "number",
+    weight: -10,
+    default_widget: "number",
+    default_formatter: "number_decimal"
+)]
+class FieldTypeWithStringCategoryAttribute extends DecimalItem
+{
+
+}

tests/fixtures/drupal/modules/phpstan_fixtures/src/Plugin/Field/FieldType/FieldTypeWithTranslatedCategoryAnnotation.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Drupal\phpstan_fixtures\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\Plugin\Field\FieldType\DecimalItem;
+
+/**
+ * An invalid field type using annotations.
+ *
+ * @FieldType(
+ *   id = "field_type_with_invalid_annotation",
+ *   label = @Translation("Field Type With Invalid Annotation"),
+ *   description = @Translation("This field type annotation is invalid because the category is not a string."),
+ *   category = @Translation("Number"),
+ *   default_widget = "number",
+ *   default_formatter = "number_decimal"
+ * )
+ */
+class FieldTypeWithTranslatedCategoryAnnotation extends DecimalItem
+{
+
+}

tests/fixtures/drupal/modules/phpstan_fixtures/src/Plugin/Field/FieldType/FieldTypeWithTranslatedCategoryAttribute.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Drupal\phpstan_fixtures\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\Attribute\FieldType;
+use Drupal\Core\Field\Plugin\Field\FieldType\DecimalItem;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+/**
+ * Represents a field type with a translated category argument.
+ */
+#[FieldType(
+    id: "field_type_with_invalid_attribute",
+    label: new TranslatableMarkup("Field Type With Invalid Attribute"),
+    description: [
+        new TranslatableMarkup("This attribute is invalid because the category is not a string."),
+    ],
+    category: new TranslatableMarkup("Number"),
+    weight: -10,
+    default_widget: "number",
+    default_formatter: "number_decimal"
+)]
+class FieldTypeWithTranslatedCategoryAttribute extends DecimalItem
+{
+
+}

tests/src/Rules/FieldTypeCategoryRuleTest.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace mglaman\PHPStanDrupal\Tests\Rules;
+
+use Drupal;
+use Generator;
+use mglaman\PHPStanDrupal\Rules\Deprecations\FieldTypeCategoryRule;
+use mglaman\PHPStanDrupal\Tests\DrupalRuleTestCase;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+
+/**
+ * Test the rule to detect translated field type categories.
+ */
+class FieldTypeCategoryRuleTest extends DrupalRuleTestCase
+{
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getRule(): Rule
+    {
+        return new FieldTypeCategoryRule(
+            self::getContainer()->getByType(ReflectionProvider::class)
+        );
+    }
+
+    /**
+     * @dataProvider ruleData
+     */
+    public function testRule(string $path, array $errorMessages): void
+    {
+        $this->analyse([$path], $errorMessages);
+    }
+
+    public static function ruleData(): Generator
+    {
+        if (version_compare(Drupal::VERSION, '10.2.0', '>=')) {
+            yield [
+                __DIR__ . '/../../fixtures/drupal/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/FloatItem.php',
+                [],
+            ];
+
+            yield [
+                __DIR__ . '/../../fixtures/drupal/modules/phpstan_fixtures/src/Plugin/Field/FieldType/FieldTypeWithTranslatedCategoryAnnotation.php',
+                [
+                    [
+                        'Using a translatable string as a category for field type is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. See https://www.drupal.org/node/3375748',
+                        19,
+                    ],
+                ]
+            ];
+
+            yield [
+                __DIR__ . '/../../fixtures/drupal/modules/phpstan_fixtures/src/Plugin/Field/FieldType/FieldTypeWithStringCategoryAttribute.php',
+                []
+            ];
+
+            yield [
+                __DIR__ . '/../../fixtures/drupal/modules/phpstan_fixtures/src/Plugin/Field/FieldType/FieldTypeWithTranslatedCategoryAttribute.php',
+                [
+                    [
+                        'Using a translatable string as a category for field type is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. See https://www.drupal.org/node/3375748',
+                        12,
+                    ],
+                ]
+            ];
+        }
+    }
+}