feat: add method becomes abstract rule

Author: shyim

composer.json

@@ -21,7 +21,10 @@
   "autoload-dev": {
     "psr-4": {
       "Shopware\\PhpStan\\Tests\\": "tests/"
-    }
+    },
+    "classmap": [
+      "tests/data"
+    ]
   },
   "config": {
     "sort-packages": true,

rules.neon

@@ -4,3 +4,4 @@ rules:
     - Shopware\PhpStan\Rule\DisallowFunctionsRule
     - Shopware\PhpStan\Rule\DisallowDefaultContextCreation
     - Shopware\PhpStan\Rule\SetForeignKeyRule
+    - Shopware\PhpStan\Rule\MethodBecomesAbstractRule

src/Rule/MethodBecomesAbstractRule.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Shopware\PhpStan\Rule;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/**
+ * @implements Rule<Class_>
+ *
+ * @internal
+ */
+class MethodBecomesAbstractRule implements Rule
+{
+    public function __construct(private readonly ReflectionProvider $reflectionProvider)
+    {
+    }
+
+    public function getNodeType(): string
+    {
+        return Class_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if ($node->extends === null) {
+            return [];
+        }
+
+        $extendedClass = $this->reflectionProvider->getClass($node->extends->toString());
+
+        $errors = [];
+
+        $existingMethods = [];
+
+        foreach ($node->stmts as $stmt) {
+            if ($stmt instanceof ClassMethod) {
+                $existingMethods[] = (string)$stmt->name;
+            }
+        }
+
+        /** @var ClassReflection $parent */
+        foreach ([$extendedClass, ...$extendedClass->getParents()] as $parent) {
+            foreach ($parent->getNativeReflection()->getMethods() as $method) {
+                if (
+                    !$method->isAbstract() &&
+                    ($method->isPublic() || $method->isProtected()) &&
+                    str_contains($method->getDocComment(), '@abstract') &&
+                    !in_array($method->getName(), $existingMethods, true)
+                ) {
+                    $errors[] = RuleErrorBuilder::message(sprintf('Method %s::%s becomes abstract, but is not declared in the extending class. Implement the method for compatibility with next major version.', $parent->getName(), $method->getName()))
+                        ->line($node->getLine())
+                        ->identifier('shopware.method.becomes.abstract')
+                        ->build();
+                }
+            }
+        }
+
+
+        return $errors;
+    }
+}

tests/Rule/MethodBecomesAbstractRuleTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Shopware\PhpStan\Tests\Rule;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use Shopware\PhpStan\Rule\MethodBecomesAbstractRule;
+
+/**
+ * @internal
+ *
+ * @extends  RuleTestCase<MethodBecomesAbstractRule>
+ */
+class MethodBecomesAbstractRuleTest extends RuleTestCase
+{
+    public function testAnalyse(): void
+    {
+        $this->analyse([ __DIR__ . '/../data/MethodBecomesAbstractRule/impl.php'], [
+            [
+                <<<EOF
+Method EntityExtension::new becomes abstract, but is not declared in the extending class. Implement the method for compatibility with next major version.
+EOF,
+                18,
+            ],
+        ]);
+    }
+
+    public function testAnalyseWithNamespace(): void
+    {
+        $this->analyse([ __DIR__ . '/../data/MethodBecomesAbstractRule/ns-test.php'], [
+            [
+                <<<EOF
+Method MethodBecomesAbstractRule\AbstractClassLocation\EntityExtension::new becomes abstract, but is not declared in the extending class. Implement the method for compatibility with next major version.
+EOF,
+                17,
+            ],
+        ]);
+    }
+
+    protected function getRule(): Rule
+    {
+        return new MethodBecomesAbstractRule(self::createReflectionProvider());
+    }
+}

tests/data/MethodBecomesAbstractRule/impl.php

@@ -0,0 +1,23 @@
+<?php
+
+class EntityExtension
+{
+    public function old(): void
+    {
+    }
+
+    /**
+     * @abstract
+     */
+    public function new(): void
+    {
+
+    }
+}
+
+class Impl extends EntityExtension
+{
+    public function old(): void
+    {
+    }
+}

tests/data/MethodBecomesAbstractRule/ns-test.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace MethodBecomesAbstractRule\AbstractClassLocation;
+
+class EntityExtension
+{
+    public function old(): void {}
+
+    /**
+     * @abstract
+     */
+    public function new(): void {}
+}
+
+namespace MethodBecomesAbstractRule\UsageLocation;
+
+class Impl extends \MethodBecomesAbstractRule\AbstractClassLocation\EntityExtension
+{
+    public function old(): void {}
+}