Add sub-providers

CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.3.0 (2015-09-23)
+
+ * Added: `ConfigServiceProvider::fromConfig()` factory method
+ * Added: Sub providers
+ * Updated: `TomPHP\ConfigServiceProvider\InflectorConfigServiceProvider` is
+   now a sub provider
+ * Removed: `TomPHP\ConfigServiceProvider\Config` static factory
+
 ### 0.2.1 (2015-09-21)
 
  * Added: Support to set up inflectors via configuration

README.md

@@ -25,7 +25,7 @@ $ composer require tomphp/config-service-provider
 
 use League\Container\Container;
 use League\Container\ServiceProvider\AbstractServiceProvider;
-use TomPHP\ConfigServiceProvider\Config;
+use TomPHP\ConfigServiceProvider\ConfigServiceProvider;
 
 class DatabaseConnectionProvider extends AbstractServiceProvider
 {
@@ -55,7 +55,7 @@ $appConfig = [
 
 $container = new Container();
 
-Config::addToContainer($container, $appConfig);
+$container->addServiceProvider(ConfigServiceProvider::fromConfig($appConfig));
 $container->addServiceProvider(new DatabaseConnectionProvider());
 
 $db = $container->get('database_connection');
@@ -113,31 +113,23 @@ $appConfig = [
 ];
 ```
 
-## Advanced Usage
+### Extra Settings
 
-`Config::addToContainer` makes some assumptions about how your config is
-arranged. If you need to customise this then you can create the service
-providers directly.
+You can provide an array of extra settings as a second parameter to
+`TomPHP\ConfigServiceProvider\ConfigServiceProvider::fromConfig()`.
 
-### The Config Service Provider
+Current valid keys are:
 
-You can change the config root name and the separator by creating an instance
-of `TomPHP\ConfigServiceProvider\ConfigServiceProvider` directly.
+| Name        | Effect                                        |
+|-------------|-----------------------------------------------|
+| `prefix`    | Changes `config` prefix given to config keys. |
+| `separator` | Changes `.` separator in config keys.         |
 
-```php
-ConfigServiceProvider::__construct(array $config, $prefix = 'config', $separator = '.')
-```
-
-### Inflector Config Service Provider
-
-The configuring of inflectors is done using a separate service provider:
+Example:
 
 ```php
-$inflectorConfig = [
-    LoggerAwareInterface::class => [
-        'setLogger' => ['Some\Logger']
-    ]
-];
-
-$container->addServiceProvider(new InflectorConfigServiceProvider($inflectorConfig));
+$provider = ConfigServiceProvider::fromConfig($appConfig, [
+    'prefix'    => 'settings',
+    'separator' => '/'
+]);
 ```

phpunit.xml

@@ -1,7 +1,7 @@
 <phpunit colors="true">
     <testsuites>
-        <testsuite name="Tests">
-            <directory>tests/</directory>
+        <testsuite name="">
+            <directory>tests</directory>
         </testsuite>
     </testsuites>
 </phpunit>

src/ConfigServiceProvider.php

@@ -3,9 +3,19 @@
 namespace TomPHP\ConfigServiceProvider;
 
 use League\Container\ServiceProvider\AbstractServiceProvider;
+use League\Container\ServiceProvider\BootableServiceProviderInterface;
+use TomPHP\ConfigServiceProvider\InflectorConfigServiceProvider;
 
-class ConfigServiceProvider extends AbstractServiceProvider
+class ConfigServiceProvider extends AbstractServiceProvider implements
+    BootableServiceProviderInterface
 {
+    const DEFAULT_PREFIX         = 'config';
+    const DEFAULT_SEPARATOR      = '.';
+    const DEFAULT_INFLECTORS_KEY = 'inflectors';
+
+    const SETTING_PREFIX    = 'prefix';
+    const SETTING_SEPARATOR = 'separator';
+
     /**
      * @var array
      */
@@ -21,30 +31,80 @@ class ConfigServiceProvider extends AbstractServiceProvider
      */
     private $separator;
 
+    /**
+     * @var ConfigurableServiceProvider[]
+     */
+    private $subProviders;
+
     /**
      * @api
      *
-     * @param array  $config
-     * @param string $prefix
-     * @param string $separator
+     * @param array $config
+     * @param array $settings
+     *
+     * @return ConfigServiceProvider
      */
-    public function __construct(array $config, $prefix = 'config', $separator = '.')
+    public static function fromConfig(array $config, array $settings = [])
     {
-        $this->prefix    = $prefix;
-        $this->separator = $separator;
+        return new self(
+            $config,
+            self::getSettingOrDefault(self::SETTING_PREFIX, $settings, self::DEFAULT_PREFIX),
+            self::getSettingOrDefault(self::SETTING_SEPARATOR, $settings, self::DEFAULT_SEPARATOR),
+            [self::DEFAULT_INFLECTORS_KEY => new InflectorConfigServiceProvider([])]
+        );
+    }
+
+    /**
+     * @api
+     *
+     * @param array                         $config
+     * @param string                        $prefix
+     * @param string                        $separator
+     * @param ConfigurableServiceProvider[] $subProviders
+     */
+    public function __construct(
+        array $config,
+        $prefix = self::DEFAULT_PREFIX,
+        $separator = self::DEFAULT_SEPARATOR,
+        array $subProviders = []
+    ) {
+        $this->prefix       = $prefix;
+        $this->separator    = $separator;
+        $this->subProviders = $subProviders;
 
         $config = $this->expandSubGroups($config);
 
         $this->provides = $this->getKeys($config);
 
         $this->config = array_combine($this->provides, array_values($config));
+
+        foreach ($this->subProviders as $key => $provider) {
+            $this->configureSubProvider($key, $config, $provider);
+        }
     }
 
     public function register()
     {
         foreach ($this->config as $key => $value) {
             $this->getContainer()->add($key, $value);
         }
+
+        foreach ($this->subProviders as $provider) {
+            $provider->setContainer($this->getContainer());
+            $provider->register();
+        }
+    }
+
+    public function boot()
+    {
+        foreach ($this->subProviders as $provider) {
+            if (!$provider instanceof BootableServiceProviderInterface) {
+                continue;
+            }
+
+            $provider->setContainer($this->getContainer());
+            $provider->boot();
+        }
     }
 
     /**
@@ -113,4 +173,30 @@ function ($key) {
             $keys
         );
     }
+
+    /**
+     * @param string $key
+     */
+    private function configureSubProvider($key, $config, ConfigurableServiceProvider $provider)
+    {
+        if (!array_key_exists($key, $config)) {
+            return;
+        }
+
+        $provider->configure($config[$key]);
+
+        $this->provides = array_merge($this->provides, $provider->provides());
+    }
+
+    /**
+     * @param string $name
+     * @param array  $settings
+     * @param mixed  $default
+     *
+     * @return mixed
+     */
+    private static function getSettingOrDefault($name, array $settings, $default)
+    {
+        return isset($settings[$name]) ? $settings[$name] : $default;
+    }
 }

src/ConfigurableServiceProvider.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace TomPHP\ConfigServiceProvider;
+
+use League\Container\ServiceProvider\ServiceProviderInterface;
+
+interface ConfigurableServiceProvider extends ServiceProviderInterface
+{
+    /**
+     * @param array $config
+     */
+    public function configure(array $config);
+}

src/InflectorConfigServiceProvider.php

@@ -6,7 +6,8 @@
 use League\Container\ServiceProvider\BootableServiceProviderInterface;
 
 class InflectorConfigServiceProvider extends AbstractServiceProvider implements
-    BootableServiceProviderInterface
+    BootableServiceProviderInterface,
+    ConfigurableServiceProvider
 {
     /**
      * @var array
@@ -23,6 +24,14 @@ public function __construct(array $config)
         $this->config = $config;
     }
 
+    /**
+     * @param array  $config
+     */
+    public function configure(array $config)
+    {
+        $this->config = $config;
+    }
+
     public function register()
     {
     }