Merge pull request #233 from mglaman/gh232

Use isSuperTypeOf to detect if module handler

Author: mglaman

src/Rules/Drupal/LoadIncludes.php

@@ -4,10 +4,11 @@
 
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use DrupalFinder\DrupalFinder;
+use mglaman\PHPStanDrupal\Drupal\ExtensionDiscovery;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
-use mglaman\PHPStanDrupal\Drupal\ExtensionDiscovery;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ObjectType;
 
@@ -53,17 +54,13 @@ public function processNode(Node $node, Scope $scope): array
         if (!is_string($var_name)) {
             throw new ShouldNotHappenException(sprintf('Expected string for variable in %s, please open an issue on GitHub https://github.com/mglaman/phpstan-drupal/issues', get_called_class()));
         }
-        $type = $scope->getVariableType($var_name);
-        assert($type instanceof ObjectType);
-        if (!class_exists($type->getClassName()) && !interface_exists($type->getClassName())) {
-            throw new ShouldNotHappenException(sprintf('Could not find class for %s from reflection.', get_called_class()));
+        $moduleHandlerInterfaceType = new ObjectType(ModuleHandlerInterface::class);
+        $variableType = $scope->getVariableType($var_name);
+        if (!$variableType->isSuperTypeOf($moduleHandlerInterfaceType)->yes()) {
+            return [];
         }
 
         try {
-            $reflected = new \ReflectionClass($type->getClassName());
-            if (!$reflected->implementsInterface(ModuleHandlerInterface::class)) {
-                return [];
-            }
             // Try to invoke it similarily as the module handler itself.
             $finder = new DrupalFinder();
             $finder->locateRoot($this->projectRoot);
@@ -97,9 +94,24 @@ public function processNode(Node $node, Scope $scope): array
                 require_once $file;
                 return [];
             }
-            return [sprintf('File %s could not be loaded from %s::loadInclude', $file, $type->getClassName())];
+            return [
+                RuleErrorBuilder::message(sprintf(
+                    'File %s could not be loaded from %s::loadInclude',
+                    $file,
+                    ModuleHandlerInterface::class
+                ))
+                    ->line($node->getLine())
+                    ->build()
+            ];
         } catch (\Throwable $e) {
-            return [sprintf('A file could not be loaded from %s::loadInclude', $type->getClassName())];
+            return [
+                RuleErrorBuilder::message(sprintf(
+                    'A file could not be loaded from %s::loadInclude',
+                    ModuleHandlerInterface::class
+                ))
+                    ->line($node->getLine())
+                    ->build()
+            ];
         }
     }
 }

tests/src/Rules/LoadIncludesRuleTest.php

@@ -26,4 +26,13 @@ public function testRule(): void
             ]);
     }
 
+    public function testFormStateLoadInclude(): void
+    {
+        $this->analyse([
+            __DIR__ . '/../../fixtures/drupal/core/tests/Drupal/Tests/Core/Form/FormStateTest.php'
+        ],
+            [
+            ]);
+    }
+
 }