Implementing inline import and default values

Author: Marc Aschmann

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## v2.0.0
+
+* Dropping php 5.3 support
+* architectural changes
+
+## v1.2.0
+
+* improved overall code quality (scrutinizer suggestions)
+* improved code coverage
+* reworked __construct() behavior of Config classes
+
+## v1.1.0
+
+* Moved to PSR-4, closed extension points
+
+## v1.0.0
+
+* First stable draft release

Config/ConfigAbstract.php

@@ -28,6 +28,16 @@ abstract class ConfigAbstract extends Data
      */
     protected $filecheck = true;
 
+    /**
+     * @var null
+     */
+    protected $imports;
+
+    /**
+     * @var null
+     */
+    protected $default;
+
     /**
      * Default constructor.
      *
@@ -61,6 +71,31 @@ public function addConfig($name, $file)
      * @return array config array
      */
     public function readConfig($file)
+    {
+        $config = $this->readFile($file);
+        $config = $this->extractDefault($config);
+        $config = $this->extractImports($config);
+
+        return $config;
+    }
+
+    /**
+     * Add config to data storage.
+     *
+     * @param string $file absolute filepath/filename.ending
+     */
+    public function setConfig($file)
+    {
+        $this->setByArray($this->readConfig($file));
+    }
+
+    /**
+     * Read yaml files.
+     *
+     * @param string $file path/filename
+     * @return array
+     */
+    private function readFile($file)
     {
         if ($this->filecheck && !is_file($file)) {
             throw new \InvalidArgumentException(
@@ -72,12 +107,32 @@ public function readConfig($file)
     }
 
     /**
-     * Add config to data storage.
-     *
-     * @param string $file absolute filepath/filename.ending
+     * @param array $config
+     * @return array
      */
-    public function setConfig($file)
+    protected function extractImports(array $config)
     {
-        $this->setByArray($this->readConfig($file));
+        if (array_key_exists('imports', $config) && 0 < count($config['imports'])) {
+            $this->imports = [];
+            foreach ($config['imports'] as $import) {
+                if (false !== empty($import['resource'])) {
+                    array_replace_recursive(
+                        $this->imports,
+                        $this->readFile($import['resource'])
+                    );
+                }
+            }
+        }
+
+        return $config;
+    }
+
+    /**
+     * @param array $config
+     * @return array
+     */
+    protected function extractDefault($config)
+    {
+        return $config;
     }
 }

Config/ConfigEnvExtended.php

@@ -0,0 +1,71 @@
+<?php
+/*
+ * This file is part of the php-utilities package.
+ *
+ * (c) Marc Aschmann <maschmann@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace Asm\Config;
+
+use Asm\Data\Data;
+
+/**
+ * Class ConfigDefault
+ *
+ * @package Asm\Config
+ * @author marc aschmann <maschmann@gmail.com>
+ */
+final class ConfigEnv extends ConfigAbstract implements ConfigInterface
+{
+    /**
+     * @var string
+     */
+    private $defaultEnv = 'prod';
+
+    /**
+     * Default constructor.
+     *
+     * @param array $param
+     */
+    public function __construct(array $param)
+    {
+        if (isset($param['filecheck'])) {
+            $this->filecheck = (bool)$param['filecheck'];
+        }
+
+        if (!empty($param['defaultEnv'])) {
+            $this->defaultEnv = $param['defaultEnv'];
+        }
+
+        $this->mergeEnvironments($param);
+    }
+
+    /**
+     * Merge environments based on defaults array.
+     *
+     * Merge order is prod -> lesser environment.
+     *
+     * @param array $param
+     */
+    private function mergeEnvironments($param)
+    {
+        $config = new Data();
+        $config->setByArray(
+            $this->readConfig($param['file'])
+        );
+
+        if (!empty($param['env']) && $this->defaultEnv !== $param['env']) {
+            $toMerge = $config->get($param['env'], []);
+            $merged = array_replace_recursive(
+                $config->get($this->defaultEnv),
+                $toMerge
+            );
+        } else {
+            $merged = $config->get($this->defaultEnv);
+        }
+
+        $this->setByArray($merged);
+    }
+}

README.md

@@ -26,8 +26,19 @@ Here you get a static factory which is able to produce three types of configurat
 Available types are:
 * ConfigDefault - basic config object, stores the yaml content "as is", provides get/set.
 * ConfigEnv - provides the possibility to get an environment-merged config. Based on the currently provided env, you'll have e.g. prod -> dev merged, with prod node as a master.
+* ConfigEnvExtended - same as ConfigEnv, adds the possibility to have "default" node on env-level, which will be the merge-base before prod. Merge: default -> prod -> $env
 * ConfigTimer is a specialised for of config to provide pre-generated DateTime objects for the Timer class.
 
+Configs now also support the "imports" syntax from symfony configs.
+
+```
+imports:
+    - { resource: defaults.yml }
+```
+
+Imported configs will be treated just like the "default" node and become the base for merging.
+The order of merges is import -> default -> prod -> $env.
+
 ### Timer
 Provides functionality to check if there's a current holiday, has configurable "timers" to check uf e.g. your hotline should be available etc.
 Extensive examples can be found within both, the TestData and UnitTests :-)

Test/TestData.php

@@ -20,6 +20,10 @@ class TestData
     public static function getYamlConfigFile()
     {
         return <<<EOT
+imports:
+    - { resource: testimport.yml }
+default:
+    testkey_4: 'default test'
 prod:
     testkey_1: 'testvalue'
     testkey_2: