Merge pull request #18 from tomphp/feature/di-config

Add feature to configure DI via the config
tomphp · Oct 10, 2015 · ec30b21 · ec30b21
2 parents e4ddbf9 + 7c38197
commit ec30b21
Show file tree

Hide file tree

Showing 13 changed files with 382 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+### 0.3.3 (2015-10-10)
+
+ * Added: Configuring DI via the config
+
 ### 0.3.2 (2015-09-24)
 
  * Added: Reading JSON config files via the `fromFiles` constructor

diff --git a/README.md b/README.md
@@ -120,6 +120,33 @@ class DatabaseConnectionProvider extends AbstractServiceProvider
 }
 ```
 
+### Configuring DI
+
+Another feature is the ability to add services to your container via the config.
+This is done by adding a `di` key to the config and using the following format:
+
+```php
+$appConfig = [
+    'di' => [
+        'logger' => [
+            'class'     => Logger::class,
+            'singleton' => true,
+            'arguments' => [
+                StdoutLogger::class
+            ],
+            'methods'   => [
+                'setMinLogLevel' => [ 'info' ]
+            ],
+        ],
+
+        StdoutLogger::class => [
+            'class' => StdoutLogger::class
+        ]
+    ]
+];
+
+```
+
 ### Configuring Inflectors
 
 It is also possible to set up

diff --git a/src/ConfigServiceProvider.php b/src/ConfigServiceProvider.php
@@ -11,6 +11,7 @@ final class ConfigServiceProvider extends AbstractServiceProvider implements
     const DEFAULT_PREFIX         = 'config';
     const DEFAULT_SEPARATOR      = '.';
     const DEFAULT_INFLECTORS_KEY = 'inflectors';
+    const DEFAULT_DI_KEY         = 'di';
 
     const SETTING_PREFIX    = 'prefix';
     const SETTING_SEPARATOR = 'separator';
@@ -49,7 +50,10 @@ public static function fromConfig(array $config, array $settings = [])
             $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([])]
+            [
+                self::DEFAULT_INFLECTORS_KEY => new InflectorConfigServiceProvider([]),
+                self::DEFAULT_DI_KEY         => new DIConfigServiceProvider([]),
+            ]
         );
     }
 
@@ -64,11 +68,11 @@ public static function fromConfig(array $config, array $settings = [])
     public static function fromFiles(array $patterns, array $settings = [])
     {
         $locator = new FileLocator();
-        $files = $locator->locate($patterns);
+        $files   = $locator->locate($patterns);
 
         $factory = new ReaderFactory([
             '.json' => 'TomPHP\ConfigServiceProvider\JSONFileReader',
-            '.php' => 'TomPHP\ConfigServiceProvider\PHPFileReader',
+            '.php'  => 'TomPHP\ConfigServiceProvider\PHPFileReader',
         ]);
 
         $configs = array_map(
@@ -167,7 +171,7 @@ private function expandSubGroup($key, $value)
 
         foreach ($value as $subkey => $subvalue) {
             $expanded += $this->expandSubGroup(
-                $key. $this->separator . $subkey,
+                $key . $this->separator . $subkey,
                 $subvalue
             );
         }

diff --git a/src/ConfigurableServiceProvider.php b/src/ConfigurableServiceProvider.php
@@ -8,6 +8,8 @@ interface ConfigurableServiceProvider extends ServiceProviderInterface
 {
     /**
      * @param array $config
+     *
+     * @return void
      */
     public function configure(array $config);
 }
diff --git a/src/DIConfigServiceProvider.php b/src/DIConfigServiceProvider.php
@@ -0,0 +1,95 @@
+<?php
+
+namespace TomPHP\ConfigServiceProvider;
+
+use League\Container\Definition\ClassDefinition;
+use League\Container\ServiceProvider\AbstractServiceProvider;
+use League\Container\ServiceProvider\BootableServiceProviderInterface;
+use TomPHP\ConfigServiceProvider\Exception\NotClassDefinitionException;
+
+final class DIConfigServiceProvider extends AbstractServiceProvider implements
+    BootableServiceProviderInterface,
+    ConfigurableServiceProvider
+{
+    /**
+     * @var array
+     */
+    private $config;
+
+    /**
+     * @api
+     *
+     * @param array  $config
+     */
+    public function __construct(array $config)
+    {
+        $this->configure($config);
+    }
+
+    /**
+     * @param array  $config
+     */
+    public function configure(array $config)
+    {
+        $this->provides = array_keys($config);
+        $this->config   = $config;
+    }
+
+    public function register()
+    {
+        foreach ($this->config as $name => $config) {
+            $this->registerService($name, $config);
+        }
+    }
+
+    public function boot()
+    {
+    }
+
+    /**
+     * @param string $name
+     * @param array  $config
+     */
+    private function registerService($name, array $config)
+    {
+        $singleton = array_key_exists('singleton', $config) && $config['singleton'];
+
+        $service = $this->getContainer()->add($name, $config['class'], $singleton);
+
+        if (!$service instanceof ClassDefinition) {
+            throw new NotClassDefinitionException(sprintf(
+                'DI config for %s does not create a class definition',
+                $name
+            ));
+        }
+
+        $this->addConstuctorArguments($service, $config);
+        $this->addMethodCalls($service, $config);
+    }
+
+    /**
+     * @param array $config
+     */
+    private function addConstuctorArguments(ClassDefinition $service, array $config)
+    {
+        if (!isset($config['arguments']) || !is_array($config['arguments'])) {
+            return;
+        }
+
+        $service->withArguments($config['arguments']);
+    }
+
+    /**
+     * @param array $config
+     */
+    private function addMethodCalls(ClassDefinition $service, array $config)
+    {
+        if (!isset($config['methods']) || !is_array($config['methods'])) {
+            return;
+        }
+
+        foreach ($config['methods'] as $method => $args) {
+            $service->withMethodCall($method, $args);
+        }
+    }
+}
diff --git a/src/Exception/NotClassDefinitionException.php b/src/Exception/NotClassDefinitionException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace TomPHP\ConfigServiceProvider\Exception;
+
+final class NotClassDefinitionException extends RuntimeException
+{
+}
diff --git a/src/JSONFileReader.php b/src/JSONFileReader.php
@@ -19,7 +19,7 @@ public function read($filename)
 
         if (json_last_error() !== JSON_ERROR_NONE) {
             throw new InvalidConfigException(
-                "Invalid JSON in $filename: " . $this->getJsonError()
+                sprintf('Invalid JSON in %s: %s', $filename, $this->getJsonError())
             );
         }
 
@@ -29,7 +29,7 @@ public function read($filename)
     private function assertFileExists()
     {
         if (!file_exists($this->filename)) {
-            throw new FileNotFoundException("{$this->filename} does not exist");
+            throw new FileNotFoundException(sprintf('%s does not exist', $this->filename));
         }
     }
 

diff --git a/src/PHPFileReader.php b/src/PHPFileReader.php
@@ -25,16 +25,14 @@ public function read($filename)
     private function assertFileExists()
     {
         if (!file_exists($this->filename)) {
-            throw new FileNotFoundException("{$this->filename} does not exist");
+            throw new FileNotFoundException($this->filename . ' does not exist');
         }
     }
 
     private function assertConfigIsValid($config)
     {
         if (!is_array($config)) {
-            throw new InvalidConfigException(
-                "{$this->filename} does not return a PHP array"
-            );
+            throw new InvalidConfigException($this->filename . ' does not return a PHP array');
         }
     }
 }
diff --git a/src/ReaderFactory.php b/src/ReaderFactory.php
@@ -47,20 +47,21 @@ public function create($filename)
      */
     private function getReaderClass($filename)
     {
-        $found = false;
+        $readerClass = null;
 
-        foreach ($this->config as $extension => $readerClass) {
+        foreach ($this->config as $extension => $className) {
             if ($this->endsWith($filename, $extension)) {
-                $found = true;
+                $readerClass = $className;
                 break;
             }
         }
 
-        if (!$found) {
-            throw new UnknownFileTypeException(
-                "Not reader class found for $filename; configured exceptions are "
-                . implode(', ', array_keys($this->config))
-            );
+        if ($readerClass === null) {
+            throw new UnknownFileTypeException(sprintf(
+                'No reader class found for %s; configured exceptions are %s',
+                $filename,
+                implode(', ', array_keys($this->config))
+            ));
         }
 
         return $readerClass;

diff --git a/tests/ConfigServiceProviderTest.php b/tests/ConfigServiceProviderTest.php
@@ -273,6 +273,29 @@ public function testItCanOverrideFromConfigDefaults()
         );
     }
 
+    /**
+     * @group from_config_factory
+     */
+    public function testItCanConfigureDI()
+    {
+        $config = [
+            'test_key' => 'test value',
+
+            'di' => [
+                'example_class' => [
+                    'class' => 'tests\mocks\ExampleClass',
+                ]
+            ]
+        ];
+
+        $this->container->addServiceProvider(ConfigServiceProvider::fromConfig($config));
+
+        $this->assertInstanceOf(
+            'tests\mocks\ExampleClass',
+            $this->container->get('example_class')
+        );
+    }
+
     /**
      * @group from_files_factory
      */