Implement BootstrappingConfigurationProvider (#384)

docs/how-to/02-bootstrap-your-container.md

@@ -168,12 +168,14 @@ Perhaps you didn't name your configuration file the default, it is recommended y
 namespace Acme\Demo;
 
 use Cspray\AnnotatedContainer\Bootstrap\Bootstrap;
-use Cspray\AnnotatedContainer\Event\Emitter;use Cspray\AnnotatedContainer\Profiles;
+use Cspray\AnnotatedContainer\Bootstrap\XmlBootstrappingConfigurationProvider;use Cspray\AnnotatedContainer\Event\Emitter;use Cspray\AnnotatedContainer\Profiles;
 
 $container = Bootstrap::fromMinimalSetup(new Emitter)
-    ->bootstrapContainer(configurationFile: 'my-container.xml');
+    ->bootstrapContainer(bootstrappingConfigurationProvider: new XmlBootstrappingConfigurationProvider('my-container.xml'));
 ```
 
+If you require a configuration that is not the default XML files, you can implement your own `Cspray\AnnotatedContainer\Bootstrap\BootstrappingConfigurationProvider` instead.
+
 #### Constructing DefinitionProvider 
 
 There might be dependencies you need to determine what third-party services should be included in your `DefinitionProvider` implementations. If so, there's a `Cspray\AnnotatedContainer\Bootstrap\DefinitionProviderFactory` interface that you can implement and then pass that instance to the `Bootstrap::minimalSetup()` method.

src/Bootstrap/Bootstrap.php

@@ -96,13 +96,17 @@ public static function fromCompleteSetup(
 
     public function bootstrapContainer(
         Profiles $profiles = null,
-        string $configurationFile = 'annotated-container.xml'
+        BootstrappingConfigurationProvider $bootstrappingConfigurationProvider = new XmlBootstrappingConfigurationProvider()
     ) : AnnotatedContainer {
         $profiles ??= Profiles::defaultOnly();
 
         $this->stopwatch->start();
 
-        $configuration = $this->bootstrappingConfiguration($configurationFile);
+        $configuration = $bootstrappingConfigurationProvider->bootstrappingConfiguration(
+            $this->directoryResolver,
+            $this->parameterStoreFactory,
+            $this->definitionProviderFactory
+        );
         $analysisOptions = $this->analysisOptions($configuration);
 
         $this->emitter->emitBeforeBootstrap($configuration);
@@ -132,16 +136,6 @@ public function bootstrapContainer(
         return $container;
     }
 
-    private function bootstrappingConfiguration(string $configurationFile) : BootstrappingConfiguration {
-        $configFile = $this->directoryResolver->configurationPath($configurationFile);
-        return new XmlBootstrappingConfiguration(
-            $configFile,
-            parameterStoreFactory: $this->parameterStoreFactory,
-            definitionProviderFactory: $this->definitionProviderFactory
-        );
-    }
-
-
     private function analysisOptions(BootstrappingConfiguration $configuration) : ContainerDefinitionAnalysisOptions {
         $scanPaths = [];
         foreach ($configuration->scanDirectories() as $scanDirectory) {

src/Bootstrap/BootstrappingConfigurationProvider.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types=1);
+
+namespace Cspray\AnnotatedContainer\Bootstrap;
+
+interface BootstrappingConfigurationProvider {
+
+    public function bootstrappingConfiguration(
+        BootstrappingDirectoryResolver $directoryResolver,
+        ParameterStoreFactory $parameterStoreFactory,
+        DefinitionProviderFactory $definitionProviderFactory,
+    ) : BootstrappingConfiguration;
+}

src/Bootstrap/XmlBootstrappingConfigurationProvider.php

@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+
+namespace Cspray\AnnotatedContainer\Bootstrap;
+
+final class XmlBootstrappingConfigurationProvider implements BootstrappingConfigurationProvider {
+
+    public function __construct(
+        private readonly string $fileName = 'annotated-container.xml'
+    ) {
+    }
+
+    public function bootstrappingConfiguration(
+        BootstrappingDirectoryResolver $directoryResolver,
+        ParameterStoreFactory $parameterStoreFactory,
+        DefinitionProviderFactory $definitionProviderFactory,
+    ) : BootstrappingConfiguration {
+        $configFile = $directoryResolver->configurationPath($this->fileName);
+        return new XmlBootstrappingConfiguration(
+            $configFile,
+            $parameterStoreFactory,
+            $definitionProviderFactory
+        );
+    }
+}

src/Cli/Command/ValidateCommand.php

@@ -12,6 +12,7 @@
 use Cspray\AnnotatedContainer\Bootstrap\DefaultDefinitionProviderFactory;
 use Cspray\AnnotatedContainer\Bootstrap\DefaultParameterStoreFactory;
 use Cspray\AnnotatedContainer\Bootstrap\PostAnalysisObserver;
+use Cspray\AnnotatedContainer\Bootstrap\XmlBootstrappingConfigurationProvider;
 use Cspray\AnnotatedContainer\Cli\Command;
 use Cspray\AnnotatedContainer\Cli\Exception\ConfigurationNotFound;
 use Cspray\AnnotatedContainer\Cli\Input;
@@ -156,8 +157,8 @@ public function handle(Input $input, TerminalOutput $output) : int {
         $profiles = Profiles::fromList($inputProfiles);
 
         $bootstrap->bootstrapContainer(
-            profiles: $profiles,
-            configurationFile: $configOption
+            $profiles,
+            new XmlBootstrappingConfigurationProvider($configOption)
         );
         assert($containerDefinition instanceof ContainerDefinition);
 

test/Unit/BootstrapTest.php

@@ -13,6 +13,7 @@
 use Cspray\AnnotatedContainer\Bootstrap\ServiceFromServiceDefinition;
 use Cspray\AnnotatedContainer\Bootstrap\ServiceGatherer;
 use Cspray\AnnotatedContainer\Bootstrap\ServiceWiringListener;
+use Cspray\AnnotatedContainer\Bootstrap\XmlBootstrappingConfigurationProvider;
 use Cspray\AnnotatedContainer\ContainerFactory\AurynContainerFactory;
 use Cspray\AnnotatedContainer\ContainerFactory\ContainerFactory;
 use Cspray\AnnotatedContainer\Definition\ContainerDefinition;
@@ -247,7 +248,9 @@ public function testBootstrapSingleConcreteServiceUsesCustomFileName() : void {
             new DefaultDefinitionProviderFactory(),
             new Stopwatch()
         );
-        $container = $bootstrap->bootstrapContainer(configurationFile: 'my-container.xml.dist');
+        $container = $bootstrap->bootstrapContainer(
+            bootstrappingConfigurationProvider: new XmlBootstrappingConfigurationProvider('my-container.xml.dist')
+        );
 
         $service = $container->get(Fixtures::singleConcreteService()->fooImplementation()->getName());