Detect when a class extends a class that has been flagged as @internal

Author: brambaud

extension.neon

@@ -76,6 +76,11 @@ services:
 	-
 		class: mglaman\PHPStanDrupal\Reflection\EntityFieldsViaMagicReflectionExtension
 		tags: [phpstan.broker.propertiesClassReflectionExtension]
+	-
+		class: mglaman\PHPStanDrupal\Rules\Classes\ClassExtendsInternalClassRule
+		tags: [phpstan.rules.rule]
+		arguments:
+			reflectionProvider: @reflectionProvider
 	-
 		class: mglaman\PHPStanDrupal\Rules\Drupal\LoadIncludes
 		tags: [phpstan.rules.rule]

src/Internal/NamespaceCheck.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Internal;
+
+use PhpParser\Node\Stmt\Class_;
+
+/**
+ * @internal
+ */
+final class NamespaceCheck
+{
+    public static function isDrupalNamespace(Class_ $class): bool
+    {
+        // @phpstan-ignore-next-line
+        if (!isset($class->namespacedName)) {
+            return false;
+        }
+
+        return 'Drupal' === (string) $class->namespacedName->slice(0, 1);
+    }
+
+    public static function isSharedNamespace(Class_ $class): bool
+    {
+        if (!isset($class->extends)) {
+            return false;
+        }
+
+        // @phpstan-ignore-next-line
+        if (!isset($class->namespacedName)) {
+            return false;
+        }
+
+        if (!self::isDrupalNamespace($class)) {
+            return false;
+        }
+
+        return (string) $class->namespacedName->slice(0, 2) === (string) $class->extends->slice(0, 2);
+    }
+}

src/Rules/Classes/ClassExtendsInternalClassRule.php

@@ -0,0 +1,75 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Rules\Classes;
+
+use mglaman\PHPStanDrupal\Internal\NamespaceCheck;
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+class ClassExtendsInternalClassRule implements Rule
+{
+    /**
+     * @var ReflectionProvider
+     */
+    private $reflectionProvider;
+
+    public function __construct(ReflectionProvider $reflectionProvider)
+    {
+        $this->reflectionProvider = $reflectionProvider;
+    }
+
+    public function getNodeType(): string
+    {
+        return Class_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        /** @var Class_ $node */
+        if (!isset($node->extends)) {
+            return [];
+        }
+
+        $extendedClassName = $node->extends->toString();
+        if (!$this->reflectionProvider->hasClass($extendedClassName)) {
+            return [];
+        }
+
+        $extendedClassReflection = $this->reflectionProvider->getClass($extendedClassName);
+        if (!$extendedClassReflection->isInternal()) {
+            return [];
+        }
+
+        // @phpstan-ignore-next-line
+        if (!isset($node->namespacedName)) {
+            return $this->buildError(null, $extendedClassName);
+        }
+
+        $currentClassName = $node->namespacedName->toString();
+
+        if (!NamespaceCheck::isDrupalNamespace($node)) {
+            return $this->buildError($currentClassName, $extendedClassName);
+        }
+
+        if (NamespaceCheck::isSharedNamespace($node)) {
+            return [];
+        }
+
+        return $this->buildError($currentClassName, $extendedClassName);
+    }
+
+    private function buildError(?string $currentClassName, string $extendedClassName): array
+    {
+        return [
+            RuleErrorBuilder::message(\sprintf(
+                '%s extends @internal class %s.',
+                $currentClassName !== null ? \sprintf('Class %s', $currentClassName) : 'Anonymous class',
+                $extendedClassName
+            ))->build()
+        ];
+    }
+}

tests/fixtures/drupal/modules/module_with_internal_classes/module_with_internal_classes.info.yml

@@ -0,0 +1,3 @@
+name: module_with_internal_classes
+type: module
+core: 8.x

tests/fixtures/drupal/modules/module_with_internal_classes/src/Foo/ExternalClass.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Drupal\module_with_internal_classes\Foo;
+
+class ExternalClass {
+
+}

tests/fixtures/drupal/modules/module_with_internal_classes/src/Foo/InternalClass.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace Drupal\module_with_internal_classes\Foo;
+
+/**
+ * @internal
+ */
+class InternalClass {
+
+}

tests/fixtures/drupal/modules/phpstan_fixtures/src/Internal/DoesNotExtendsAnyClass.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Drupal\phpstan_fixtures\Internal;
+
+final class DoesNotExtendsAnyClass {
+
+}

tests/fixtures/drupal/modules/phpstan_fixtures/src/Internal/ExtendsDrupalCoreExternalClass.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Drupal\phpstan_fixtures\Internal;
+
+use Drupal\Core\PHPStanDrupalTests\ExternalClass;
+
+final class ExtendsDrupalCoreExternalClass extends ExternalClass {
+
+}

tests/fixtures/drupal/modules/phpstan_fixtures/src/Internal/ExtendsDrupalCoreInternalClass.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Drupal\phpstan_fixtures\Internal;
+
+use Drupal\Core\InternalClass;
+
+final class ExtendsDrupalCoreInternalClass extends InternalClass {
+
+}

tests/fixtures/drupal/modules/phpstan_fixtures/src/Internal/ExtendsDrupalCorePHPStanDrupalTestsInternalClass.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Drupal\phpstan_fixtures\Internal;
+
+use Drupal\Core\PHPStanDrupalTests\InternalClass;
+
+final class ExtendsDrupalCorePHPStanDrupalTestsInternalClass extends InternalClass {
+
+}