Make the discovered Drupal extensions accessible via a service

Author: brambaud

extension.neon

@@ -46,6 +46,8 @@ rules:
 services:
 	-
 		class: mglaman\PHPStanDrupal\Drupal\ServiceMap
+	-
+		class: mglaman\PHPStanDrupal\Drupal\ExtensionMap
 	-
 		class: mglaman\PHPStanDrupal\Drupal\EntityDataRepository
 		arguments:

src/Drupal/DrupalAutoloader.php

@@ -196,6 +196,9 @@ class: Drupal\jsonapi\Routing\JsonApiParamEnhancer
             && class_exists('Drupal\TestTools\PhpUnitCompatibility\PhpUnit8\ClassWriter')) {
             \Drupal\TestTools\PhpUnitCompatibility\PhpUnit8\ClassWriter::mutateTestBase($this->autoloader);
         }
+
+        $extension_map = $container->getByType(ExtensionMap::class);
+        $extension_map->setExtensions($this->moduleData, $this->themeData, $profiles);
     }
 
     protected function loadLegacyIncludes(): void

src/Drupal/Extension.php

@@ -2,6 +2,8 @@
 
 namespace mglaman\PHPStanDrupal\Drupal;
 
+use Symfony\Component\Yaml\Yaml;
+
 /**
  * Defines an extension (file) object.
  *
@@ -58,6 +60,16 @@ class Extension
      */
     public $origin = '';
 
+    /**
+     * @var array|null
+     */
+    private $info;
+
+    /**
+     * @var string[]|null
+     */
+    private $dependencies;
+
     /**
      * Constructs a new Extension object.
      *
@@ -167,4 +179,49 @@ public function load(): bool
         }
         return false;
     }
+
+    /**
+     * @return string[]
+     */
+    public function getDependencies(): array
+    {
+        if (\is_array($this->dependencies)) {
+            return $this->dependencies;
+        }
+
+        $info = $this->parseInfo();
+        $dependencies = $info['dependencies'] ?? [];
+
+        if ($dependencies === []) {
+            return $this->dependencies = $dependencies;
+        }
+
+        $this->dependencies = [];
+
+        // @see \Drupal\Core\Extension\Dependency::createFromString().
+        foreach ($dependencies as $dependency) {
+            if (\strpos($dependency, ':') !== false) {
+                [, $dependency] = \explode(':', $dependency);
+            }
+
+            $parts = \explode('(', $dependency, 2);
+            $this->dependencies[] = \trim($parts[0]);
+        }
+
+        return $this->dependencies;
+    }
+
+    private function parseInfo(): array
+    {
+        if (\is_array($this->info)) {
+            return $this->info;
+        }
+
+        $infoContent = \file_get_contents(\sprintf('%s/%s', $this->root, $this->getPathname()));
+        if (false === $infoContent) {
+            throw new \RuntimeException(\sprintf('Cannot read "%s', $this->getPathname()));
+        }
+
+        return $this->info = Yaml::parse($infoContent);
+    }
 }

src/Drupal/ExtensionMap.php

@@ -0,0 +1,66 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Drupal;
+
+final class ExtensionMap
+{
+    /** @var Extension[]  */
+    private static $modules = [];
+
+    /** @var Extension[]  */
+    private static $themes = [];
+
+    /** @var Extension[]  */
+    private static $profiles = [];
+
+    /**
+     * @return Extension[]
+     */
+    public function getModules(): array
+    {
+        return self::$modules;
+    }
+
+    public function getModule(string $name): ?Extension
+    {
+        return self::$modules[$name] ?? null;
+    }
+
+    /**
+     * @return Extension[]
+     */
+    public function getThemes(): array
+    {
+        return self::$themes;
+    }
+
+    public function getTheme(string $name): ?Extension
+    {
+        return self::$themes[$name] ?? null;
+    }
+
+    /**
+     * @return Extension[]
+     */
+    public function getProfiles(): array
+    {
+        return self::$profiles;
+    }
+
+    public function getProfile(string $name): ?Extension
+    {
+        return self::$profiles[$name] ?? null;
+    }
+
+    /**
+     * @param Extension[] $modules
+     * @param Extension[] $themes
+     * @param Extension[] $profiles
+     */
+    public function setExtensions(array $modules, array $themes, array $profiles): void
+    {
+        self::$modules = $modules;
+        self::$themes = $themes;
+        self::$profiles = $profiles;
+    }
+}

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

@@ -0,0 +1,7 @@
+name: module_with_dependencies
+type: module
+core_version_requirement: ^8 || ^9
+dependencies:
+  - drupal:node
+  - foo:bar (>=2.0.x)
+  - service_map

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

@@ -0,0 +1,3 @@
+name: module_without_dependencies
+type: module
+core_version_requirement: ^8 || ^9

tests/src/Drupal/ExtensionTest.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Drupal;
+
+use mglaman\PHPStanDrupal\Drupal\Extension;
+use PHPUnit\Framework\TestCase;
+
+final class ExtensionTest extends TestCase
+{
+
+    /**
+     * @dataProvider dependenciesProvider
+     */
+    public function testDependencies(array $dependencies, string $pathInfoFile): void
+    {
+        self::assertSame(
+            $dependencies,
+            (new Extension(__DIR__ . '/../../fixtures/drupal', 'module', $pathInfoFile))->getDependencies()
+        );
+    }
+
+    public function dependenciesProvider(): \Generator
+    {
+        yield [
+            [
+                'node',
+                'bar',
+                'service_map',
+            ],
+            '/modules/module_with_dependencies/module_with_dependencies.info.yml',
+        ];
+        yield [
+            [],
+            '/modules/module_without_dependencies/module_without_dependencies.info.yml'
+        ];
+    }
+}