feat: add InternalClassExtendsRule with tests

Author: shyim

rules.neon

@@ -6,6 +6,7 @@ rules:
     - Shopware\PhpStan\Rule\SetForeignKeyRule
     - Shopware\PhpStan\Rule\MethodBecomesAbstractRule
     - Shopware\PhpStan\Rule\ScheduledTaskTooLowIntervalRule
+    - Shopware\PhpStan\Rule\InternalClassExtendsRule
 
 services:
     -

src/Rule/InternalClassExtendsRule.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Shopware\PhpStan\Rule;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/**
+ * @implements Rule<Class_>
+ *
+ * @internal
+ */
+class InternalClassExtendsRule implements Rule
+{
+    private ReflectionProvider $reflectionProvider;
+
+    public function __construct(ReflectionProvider $reflectionProvider)
+    {
+        $this->reflectionProvider = $reflectionProvider;
+    }
+
+    public function getNodeType(): string
+    {
+        return Class_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if ($node->extends === null) {
+            return [];
+        }
+
+        $parentClassName = (string) $node->extends;
+        $parentClassReflection = $this->reflectionProvider->getClass($parentClassName);
+
+        if ($parentClassReflection->isInternal()) {
+            return [
+                RuleErrorBuilder::message(sprintf('Class %s extends internal class %s. Please refrain from extending classes which are annotated with @internal.', (string) $node->name, $parentClassName))
+                    ->line($node->getLine())
+                    ->identifier('shopware.internal.class.extends')
+                    ->build(),
+            ];
+        }
+
+        return [];
+    }
+}

tests/Rule/InternalClassExtendsRuleTest.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Shopware\PhpStan\Tests\Rule;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use Shopware\PhpStan\Rule\InternalClassExtendsRule;
+
+class InternalClassExtendsRuleTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new InternalClassExtendsRule($this->createReflectionProvider());
+    }
+
+    public function testInternalClassExtendsRule(): void
+    {
+        $this->analyse([__DIR__ . '/../data/InternalClassExtendsRule/internal-class.php'], [
+            [
+                'Class PublicController extends internal class InternalController. Please refrain from extending classes which are annotated with @internal.',
+                8,
+            ],
+        ]);
+    }
+}

tests/data/InternalClassExtendsRule/internal-class.php

@@ -0,0 +1,8 @@
+<?php
+
+/**
+ * @internal
+ */
+class InternalController {}
+
+class PublicController extends InternalController {}