Handling final for abstract classes (#11)

Author: floriankraemer

data/Service/AbstractServiceClass.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace App\Service;
+
+abstract class AbstractServiceClass
+{
+    abstract public function doSomething(): void;
+}

docs/Rules.md

@@ -79,10 +79,14 @@ Ensures that classes matching specified patterns are declared as `final`.
         class: Phauthentic\PHPStanRules\Architecture\ClassMustBeFinalRule
         arguments:
             patterns: ['/^App\\Service\\/']
+            ignoreAbstractClasses: true
         tags:
             - phpstan.rules.rule
 ```
 
+- `patterns`: Array of regex patterns to match against class names.
+- `ignoreAbstractClasses`: Whether to ignore abstract classes (default: `true`).
+
 ## Namespace Class Pattern Rule {#namespace-class-pattern-rule}
 
 Ensures that classes inside namespaces matching a given regex must have names matching at least one of the provided patterns.

src/Architecture/ClassMustBeFinalRule.php

@@ -29,7 +29,8 @@ class ClassMustBeFinalRule implements Rule
      * Each pattern should be a valid PCRE regex.
      */
     public function __construct(
-        protected array $patterns
+        protected array $patterns,
+        protected bool $ignoreAbstractClasses = true
     ) {
     }
 
@@ -47,6 +48,11 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
+        // Skip abstract classes if configured to ignore them
+        if ($this->ignoreAbstractClasses && $node->isAbstract()) {
+            return [];
+        }
+
         $className = $node->name->toString();
         $namespaceName = $scope->getNamespace() ?? '';
         $fullClassName = $namespaceName . '\\' . $className;

tests/TestCases/Architecture/ClassMustBeFinalRuleTest.php

@@ -28,4 +28,9 @@ public function testRule(): void
             ],
         ]);
     }
+
+    public function testRuleIgnoresAbstractClassesByDefault(): void
+    {
+        $this->analyse([__DIR__ . '/../../../data/Service/AbstractServiceClass.php'], []);
+    }
 }

tests/TestCases/Architecture/ClassMustBeFinalRuleWithAbstractClassesTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phauthentic\PHPStanRules\Tests\TestCases\Architecture;
+
+use Phauthentic\PHPStanRules\Architecture\ClassMustBeFinalRule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<ClassMustBeFinalRule>
+ */
+class ClassMustBeFinalRuleWithAbstractClassesTest extends RuleTestCase
+{
+    protected function getRule(): \PHPStan\Rules\Rule
+    {
+        return new ClassMustBeFinalRule([
+            '/ServiceClass$/', // all classes that end with "ServiceClass"
+        ], false); // Don't ignore abstract classes
+    }
+
+    public function testRuleWithAbstractClassesNotIgnored(): void
+    {
+        $this->analyse([__DIR__ . '/../../../data/Service/AbstractServiceClass.php'], [
+            [
+                'Class App\Service\AbstractServiceClass must be final.',
+                5,
+            ],
+        ]);
+    }
+
+
+}