use module filter in module package loader and load module filter in …

…plugin entrypoint
artemeon · Nov 10, 2020 · f6fb7e2 · f6fb7e2
1 parent 686b0f9
commit f6fb7e2
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 11 deletions.
diff --git a/src/Module/ModulePackageLoader.php b/src/Module/ModulePackageLoader.php
@@ -6,6 +6,8 @@
 
 use Composer\IO\IOInterface;
 
+use function basename;
+use function dirname;
 use function glob;
 use function rtrim;
 use function sprintf;
@@ -18,11 +20,14 @@ final class ModulePackageLoader
 {
     private const MODULE_COMPOSER_FILE_PATTERN = 'module_*/composer.json';
 
+    private ModuleFilter $moduleFilter;
     private IOInterface $io;
+
     private array $modulePackageCache = [];
 
-    public function __construct(IOInterface $io)
+    public function __construct(ModuleFilter $moduleFilter, IOInterface $io)
     {
+        $this->moduleFilter = $moduleFilter;
         $this->io = $io;
     }
 
@@ -31,8 +36,20 @@ public function __construct(IOInterface $io)
      */
     public function load(string $basePath): iterable
     {
+        $this->io->debug(
+            sprintf(
+                'loading modules at <comment>%s</comment> using <comment>%s</comment>',
+                $basePath,
+                self::MODULE_COMPOSER_FILE_PATTERN
+            )
+        );
+
         foreach ($this->scanForComposerFiles($basePath) as $composerFile) {
-            yield $this->loadModule($composerFile);
+            $moduleName = basename(dirname($composerFile));
+
+            if ($this->moduleFilter->shouldLoad($moduleName)) {
+                yield $this->loadModule($composerFile);
+            }
         }
     }
 
@@ -44,7 +61,6 @@ private function scanForComposerFiles(string $basePath): iterable
             DIRECTORY_SEPARATOR,
             self::MODULE_COMPOSER_FILE_PATTERN
         );
-        $this->io->debug(sprintf('Loading modules using glob <comment>%s</comment>', $moduleComposerFilePattern));
 
         yield from glob($moduleComposerFilePattern, GLOB_NOSORT | GLOB_NOESCAPE);
     }

diff --git a/src/Plugin/MergePlugin.php b/src/Plugin/MergePlugin.php
@@ -4,6 +4,7 @@
 
 namespace Artemeon\Composer\Plugin;
 
+use Artemeon\Composer\Module\ModuleFilterLoader;
 use Artemeon\Composer\Module\ModulePackageLoader;
 use Composer\Composer;
 use Composer\DependencyResolver\Operation\InstallOperation;
@@ -25,6 +26,7 @@ final class MergePlugin implements PluginInterface, EventSubscriberInterface
     private const CALLBACK_PRIORITY = 50000;
     private const MODULES_BASE_PATH = '../core';
     private const OVERRIDDEN_MODULES = './module_*';
+    private const FILTER_CONFIGURATION_PATH = './packageconfig.json';
 
     private Composer $composer;
     private IOInterface $io;
@@ -36,7 +38,8 @@ public function activate(Composer $composer, IOInterface $io): void
     {
         $this->composer = $composer;
         $this->io = $io;
-        $this->modulePackageLoader = new ModulePackageLoader($io);
+        $moduleFilter = (new ModuleFilterLoader($io))->load(self::FILTER_CONFIGURATION_PATH);
+        $this->modulePackageLoader = new ModulePackageLoader($moduleFilter, $io);
     }
 
     public function deactivate(Composer $composer, IOInterface $io): void

diff --git a/tests/Unit/Module/ModulePackageLoaderTest.php b/tests/Unit/Module/ModulePackageLoaderTest.php
@@ -17,37 +17,37 @@ final class ModulePackageLoaderTest extends TestCase
 {
     use ProphecyTrait;
 
-    private IOInterface $nullIo;
+    private ModuleFilter $unrestrictedModuleFilter;
 
     protected function setUp(): void
     {
         parent::setUp();
-        $this->nullIo = new NullIO();
+        $this->unrestrictedModuleFilter = ModuleFilter::unrestricted(new NullIO());
     }
 
     public function testLoadsModulesAtTheGivenPath(): void
     {
-        $modulePackageLoader = new ModulePackageLoader($this->nullIo);
+        $modulePackageLoader = new ModulePackageLoader($this->unrestrictedModuleFilter, new NullIO());
         self::assertCount(2, $modulePackageLoader->load($this->fixturePath('two_modules')));
     }
 
     public function testOnlyLoadsModulesWhoseNameMatchesTheConvention(): void
     {
-        $modulePackageLoader = new ModulePackageLoader($this->nullIo);
+        $modulePackageLoader = new ModulePackageLoader($this->unrestrictedModuleFilter, new NullIO());
         self::assertCount(1, $modulePackageLoader->load($this->fixturePath('two_modules_one_invalid_name')));
     }
 
     public function testOnlyLoadsModulesWhichContainAPackageFile(): void
     {
-        $modulePackageLoader = new ModulePackageLoader($this->nullIo);
+        $modulePackageLoader = new ModulePackageLoader($this->unrestrictedModuleFilter, new NullIO());
         self::assertCount(1, $modulePackageLoader->load($this->fixturePath('one_module_and_one_directory')));
-        $modulePackageLoader = new ModulePackageLoader($this->nullIo);
+        $modulePackageLoader = new ModulePackageLoader($this->unrestrictedModuleFilter, new NullIO());
         self::assertCount(0, $modulePackageLoader->load($this->fixturePath('two_directories')));
     }
 
     public function testLoadsNothingIfNoModulesExistAtTheGivenPath(): void
     {
-        $modulePackageLoader = new ModulePackageLoader($this->nullIo);
+        $modulePackageLoader = new ModulePackageLoader($this->unrestrictedModuleFilter, new NullIO());
         self::assertCount(0, $modulePackageLoader->load($this->fixturePath('no_modules')));
     }