Merge pull request #54 from boesing/feature/component-excludes

Introduce `component-ignore-list`

Author: boesing

docs/book/index.md

@@ -183,6 +183,25 @@ This value should be an array of package names.
 
 This setting only works in the root package.
 
+## Excluding Packages from Being Auto-Installed
+
+At the root package level, you can also indicate that certain packages that supply
+config providers and/or modules should **NOT** automatically inject configuration,
+instead of prompting for installation, via the `component-ignore-list` setting.
+This value should be an array of package names.
+
+```json
+"extra": {
+    "laminas": {
+        "component-ignore-list": [
+            "laminas/laminas-db"
+        ]
+    }
+}
+```
+
+This setting only works in the root package.
+
 ## Why?
 
 When preparing laminas-mvc's version 3 release, we wanted to reduce the number of

src/ComponentInstaller.php

@@ -92,7 +92,8 @@
  * @internal
  *
  * @psalm-type ComposerExtraComponentInstallerProjectArrayType = array{
- *     component-auto-installs?: non-empty-list<non-empty-string>
+ *     component-auto-installs?: non-empty-list<non-empty-string>,
+ *     component-ignore-list?: non-empty-list<non-empty-string>
  * }
  * @psalm-type ComposerExtraComponentInstallerArrayType = array{
  *     component?:non-empty-array<non-empty-string>,
@@ -491,20 +492,27 @@ private function marshalInstallableComponents(array $extra, Collection $options)
     /**
      * Prompt for the user to select a configuration location to update.
      *
-     * @param non-empty-string $name
+     * @param non-empty-string             $name
      * @param Collection<int,ConfigOption> $options
      * @param InjectorInterface::TYPE_* $packageType
-     * @param non-empty-string $packageName
-     * @param list<non-empty-string> $autoInstallations
+     * @param non-empty-string             $packageName
+     * @param list<non-empty-string>       $autoInstallations
+     * @param list<non-empty-string>       $ignoreList
      */
     private function promptForConfigOption(
         string $name,
         Collection $options,
         int $packageType,
         string $packageName,
         array $autoInstallations,
-        bool $requireDev = false
+        array $ignoreList,
+        bool $requireDev
     ): InjectorInterface {
+        // If package is whitelisted, do not inject
+        if (in_array($packageName, $ignoreList, true)) {
+            return new Injector\NoopInjector();
+        }
+
         if ($cachedInjector = $this->getCachedInjector($packageType)) {
             return $cachedInjector;
         }
@@ -951,6 +959,7 @@ private function addPackageToConfig(
         $rootPackageExtra  = $this->composer->getPackage()->getExtra();
         $rootExtra         = $this->getExtraMetadata($rootPackageExtra, true);
         $autoInstallations = $rootExtra['component-auto-installs'] ?? [];
+        $ignoreList        = $rootExtra['component-ignore-list'] ?? [];
 
         $this->marshalInstallableComponents($extra, $options)
             // Create injectors
@@ -961,7 +970,8 @@ private function addPackageToConfig(
                 $requireDev,
                 $dependencies,
                 $applicationModules,
-                $autoInstallations
+                $autoInstallations,
+                $ignoreList
             ): void {
                 $packageType = $packageTypes->get($component);
 
@@ -971,6 +981,7 @@ private function addPackageToConfig(
                     $packageType,
                     $name,
                     $autoInstallations,
+                    $ignoreList,
                     $requireDev
                 );
 
@@ -1058,6 +1069,16 @@ private function filterComponentInstallerSpecificValuesFromComposerExtra(
                 = $maybeLaminasSpecificConfiguration['component-auto-installs'];
         }
 
+        if (
+            isset($maybeLaminasSpecificConfiguration['component-ignore-list'])
+            && $this->isNonEmptyListContainingNonEmptyStrings(
+                $maybeLaminasSpecificConfiguration['component-ignore-list']
+            )
+        ) {
+            $laminasSpecificConfiguration['component-ignore-list']
+                = $maybeLaminasSpecificConfiguration['component-ignore-list'];
+        }
+
         return $laminasSpecificConfiguration;
     }
 

test/ComponentInstallerTest.php

@@ -62,7 +62,14 @@ final class ComponentInstallerTest extends TestCase
     /** @var InstallationManager&MockObject */
     private $installationManager;
 
-    /** @var array{laminas?:array{component-auto-installs?:list<non-empty-string>}} */
+    /**
+     * @var array{
+     *  laminas?: array{
+     *      component-auto-installs?:list<non-empty-string>,
+     *      component-ignore-list?:list<non-empty-string>
+     *  }
+     * }
+     **/
     private $rootPackageExtra = [];
 
     protected function setUp(): void
@@ -216,7 +223,7 @@ private function prepareEventForPackageProviderDetection($event, string $package
     }
 
     /**
-     * @param array<int,string> $informations
+     * @param non-empty-list<string> $informations
      */
     private function createOutputAssertions(array $informations): void
     {
@@ -1735,6 +1742,42 @@ public function testInstallAutoInstallableDevModuleWithUniqueInjector(): void
         ], $modules);
     }
 
+    public function testOnPostPackageInstallDoesNotPromptForIgnoredPackages(): void
+    {
+        $this->createApplicationConfig();
+
+        $package = $this->createMock(PackageInterface::class);
+        $package->method('getName')->willReturn('some/component');
+        $package->method('getExtra')->willReturn([
+            'laminas' => [
+                'component' => 'Some\\Component',
+            ],
+        ]);
+
+        $operation = $this->createMock(InstallOperation::class);
+        $operation->method('getPackage')->willReturn($package);
+
+        $event = $this->createMock(PackageEvent::class);
+        $event->method('isDevMode')->willReturn(true);
+        $event->method('getOperation')->willReturn($operation);
+        $this->prepareEventForPackageProviderDetection($event, 'some/component');
+
+        $this->rootPackage->method('getName')->willReturn('some/component');
+        $this->rootPackageExtra = [
+            'laminas' => [
+                'component-ignore-list' => ['some/component'],
+            ],
+        ];
+
+        $this->io
+            ->expects(self::never())
+            ->method('ask');
+
+        $this->installer->onPostPackageInstall($event);
+        $config = file_get_contents(vfsStream::url('project/config/application.config.php'));
+        self::assertStringNotContainsString("'Some\Component'", $config);
+    }
+
     /**
      * @return array<non-empty-string,array{
      *     non-empty-string,
@@ -1861,7 +1904,7 @@ public function testOnPostPackageUpdateRemovesPackageWhenNewerVersionDoesNotCont
      * @psalm-param ComposerExtraLaminasConfiguration $previousExtra
      * @psalm-param ComposerExtraLaminasConfiguration $newExtra
      * @psalm-param list<AbstractQuestionAssertion> $inputAssertions
-     * @psalm-param list<non-empty-string> $outputAssertions
+     * @psalm-param non-empty-list<non-empty-string> $outputAssertions
      * @psalm-param list<non-empty-string> $expectedInstalledModules
      * @dataProvider packageUpdateScenarios
      */
@@ -1913,7 +1956,7 @@ public function testOnPostPackageUpdateAddsPackageWhenNewerVersionContainsDiffer
      *     1:ComposerExtraLaminasConfiguration,
      *     2:ComposerExtraLaminasConfiguration,
      *     3:list<AbstractQuestionAssertion>,
-     *     4:list<non-empty-string>,
+     *     4:non-empty-list<non-empty-string>,
      *     5:list<non-empty-string>
      * }>
      */