Fix: Adjust Methods\FinalInAbstractClassRule to ignore Doctrine embeddables and entities

CHANGELOG.md

@@ -11,6 +11,7 @@ For a full diff see [`2.5.0...main`][2.5.0...main].
 ### Fixed
 
 - Returned rule with error identifier ([#882]), by [@localheinz]
+- Adjusted `Methods\FinalInAbstractClassRule` to ignore Doctrine embeddables and entities ([#396]), by [@localheinz]
 
 ## [`2.5.0`][2.5.0]
 
@@ -531,6 +532,7 @@ For a full diff see [`362c7ea...0.1.0`][362c7ea...0.1.0].
 [#294]: https://github.com/ergebnis/phpstan-rules/pull/294
 [#381]: https://github.com/ergebnis/phpstan-rules/pull/381
 [#395]: https://github.com/ergebnis/phpstan-rules/pull/395
+[#396]: https://github.com/ergebnis/phpstan-rules/pull/396
 [#496]: https://github.com/ergebnis/phpstan-rules/pull/496
 [#498]: https://github.com/ergebnis/phpstan-rules/pull/498
 [#499]: https://github.com/ergebnis/phpstan-rules/pull/498

README.md

@@ -345,6 +345,11 @@ parameters:
 
 This rule reports an error when a concrete `public` or `protected `method in an `abstract` class is not `final`.
 
+:bulb: This rule ignores
+
+- Doctrine embeddables
+- Doctrine entities
+
 ##### Disabling the rule
 
 You can set the the `enabled` parameter to `false` to disable this rule.

composer-require-checker.json

@@ -26,6 +26,8 @@
     "PhpParser\\Node\\UnionType",
     "PHPStan\\Analyser\\Scope",
     "PHPStan\\Node\\FileNode",
+    "PHPStan\\PhpDoc\\ResolvedPhpDocBlock",
+    "PHPStan\\PhpDocParser\\Ast\\PhpDoc\\PhpDocTagNode",
     "PHPStan\\Reflection\\ClassReflection",
     "PHPStan\\Reflection\\ReflectionProvider",
     "PHPStan\\Rules\\Rule",

src/Methods/FinalInAbstractClassRule.php

@@ -16,6 +16,8 @@
 use Ergebnis\PHPStan\Rules\ErrorIdentifier;
 use PhpParser\Node;
 use PHPStan\Analyser;
+use PHPStan\PhpDoc;
+use PHPStan\PhpDocParser;
 use PHPStan\Reflection;
 use PHPStan\Rules;
 
@@ -24,6 +26,19 @@
  */
 final class FinalInAbstractClassRule implements Rules\Rule
 {
+    private const DOCTRINE_ATTRIBUTE_NAMES = [
+        'Doctrine\\ORM\\Mapping\\Embeddable',
+        'Doctrine\\ORM\\Mapping\\Entity',
+    ];
+    private const DOCTRINE_TAG_NAMES = [
+        '@ORM\\Mapping\\Embeddable',
+        '@ORM\\Embeddable',
+        '@Embeddable',
+        '@ORM\\Mapping\\Entity',
+        '@ORM\\Entity',
+        '@Entity',
+    ];
+
     public function getNodeType(): string
     {
         return Node\Stmt\ClassMethod::class;
@@ -36,6 +51,10 @@ public function processNode(
         /** @var Reflection\ClassReflection $containingClass */
         $containingClass = $scope->getClassReflection();
 
+        if (self::isDoctrineEntity($containingClass)) {
+            return [];
+        }
+
         if (!$containingClass->isAbstract()) {
             return [];
         }
@@ -70,4 +89,33 @@ public function processNode(
             $ruleErrorBuilder->identifier(ErrorIdentifier::finalInAbstractClass()->toString())->build(),
         ];
     }
+
+    private static function isDoctrineEntity(Reflection\ClassReflection $containingClass): bool
+    {
+        $attributes = $containingClass->getNativeReflection()->getAttributes();
+
+        foreach ($attributes as $attribute) {
+            if (\in_array($attribute->getName(), self::DOCTRINE_ATTRIBUTE_NAMES, true)) {
+                return true;
+            }
+        }
+
+        $resolvedPhpDocBlock = $containingClass->getResolvedPhpDoc();
+
+        if ($resolvedPhpDocBlock instanceof PhpDoc\ResolvedPhpDocBlock) {
+            foreach ($resolvedPhpDocBlock->getPhpDocNodes() as $phpDocNode) {
+                foreach ($phpDocNode->children as $child) {
+                    if (!$child instanceof PhpDocParser\Ast\PhpDoc\PhpDocTagNode) {
+                        continue;
+                    }
+
+                    if (\in_array($child->name, self::DOCTRINE_TAG_NAMES, true)) {
+                        return true;
+                    }
+                }
+            }
+        }
+
+        return false;
+    }
 }

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndEmbeddableAnnotationInInlineDocBlock.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/** @Embeddable */
+abstract class AbstractClassWithProtectedMethodAndEmbeddableAnnotationInInlineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndEmbeddableAnnotationInMultilineDocBlock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/**
+ * @Embeddable
+ */
+abstract class AbstractClassWithProtectedMethodAndEmbeddableAnnotationInMultilineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndEmbeddableAttribute.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+use Doctrine\ORM;
+
+#[ORM\Mapping\Embeddable]
+abstract class AbstractClassWithProtectedMethodAndEmbeddableAttribute
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndEntityAnnotationInInlineDocBlock.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/** @Entity */
+abstract class AbstractClassWithProtectedMethodAndEntityAnnotationInInlineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndEntityAnnotationInMultilineDocBlock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/**
+ * @Entity
+ */
+abstract class AbstractClassWithProtectedMethodAndEntityAnnotationInMultilineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndEntityAttribute.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+use Doctrine\ORM;
+
+#[ORM\Mapping\Entity]
+abstract class AbstractClassWithProtectedMethodAndEntityAttribute
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndOrmEmbeddableAnnotationInInlineDocBlock.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/** @ORM\Embeddable */
+abstract class AbstractClassWithProtectedMethodAndOrmEmbeddableAnnotationInInlineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndOrmEmbeddableAnnotationInMultilineDocBlock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/**
+ * @ORM\Embeddable
+ */
+abstract class AbstractClassWithProtectedMethodAndOrmEmbeddableAnnotationInMultilineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndOrmEntityAnnotationInInlineDocBlock.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/** @ORM\Entity */
+abstract class AbstractClassWithProtectedMethodAndOrmEntityAnnotationInInlineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndOrmEntityAnnotationInMultilineDocBlock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/**
+ * @ORM\Entity
+ */
+abstract class AbstractClassWithProtectedMethodAndOrmEntityAnnotationInMultilineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndOrmMappingEmbeddableAnnotationInInlineDocBlock.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/** @ORM\Mapping\Embeddable */
+abstract class AbstractClassWithProtectedMethodAndOrmMappingEmbeddableAnnotationInInlineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndOrmMappingEmbeddableAnnotationInMultilineDocBlock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/**
+ * @ORM\Mapping\Embeddable
+ */
+abstract class AbstractClassWithProtectedMethodAndOrmMappingEmbeddableAnnotationInMultilineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndOrmMappingEntityAnnotationInInlineDocBlock.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/** @ORM\Mapping\Entity */
+abstract class AbstractClassWithProtectedMethodAndOrmMappingEntityAnnotationInInlineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithProtectedMethodAndOrmMappingEntityAnnotationInMultilineDocBlock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/**
+ * @ORM\Mapping\Entity
+ */
+abstract class AbstractClassWithProtectedMethodAndOrmMappingEntityAnnotationInMultilineDocBlock
+{
+    protected function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithPublicMethodAndEmbeddableAnnotationInInlineDocBlock.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/** @Embeddable */
+abstract class AbstractClassWithPublicMethodAndEmbeddableAnnotationInInlineDocBlock
+{
+    public function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithPublicMethodAndEmbeddableAnnotationInMultilineDocBlock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/**
+ * @Embeddable
+ */
+abstract class AbstractClassWithPublicMethodAndEmbeddableAnnotationInMultilineDocBlock
+{
+    public function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithPublicMethodAndEmbeddableAttribute.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+use Doctrine\ORM;
+
+#[ORM\Mapping\Embeddable]
+abstract class AbstractClassWithPublicMethodAndEmbeddableAttribute
+{
+    public function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithPublicMethodAndEntityAnnotationInInlineDocBlock.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/** @Entity */
+abstract class AbstractClassWithPublicMethodAndEntityAnnotationInInlineDocBlock
+{
+    public function method(): void
+    {
+    }
+}

test/Fixture/Methods/FinalInAbstractClassRule/Success/AbstractClassWithPublicMethodAndEntityAnnotationInMultilineDocBlock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ergebnis\PHPStan\Rules\Test\Fixture\Methods\FinalInAbstractClassRule\Success;
+
+/**
+ * @Entity
+ */
+abstract class AbstractClassWithPublicMethodAndEntityAnnotationInMultilineDocBlock
+{
+    public function method(): void
+    {
+    }
+}