PHP7 typehint refactoring, upgrading interfaces

Author: maschmann

.gitignore

@@ -1,6 +1,7 @@
 # dirs
 vendor
 tmp
+bin
 
 #files
 composer.lock

.travis.yml

@@ -2,8 +2,8 @@ language: php
 sudo: false
 
 php:
-  - 5.4
   - 5.5
+  - 5.6
   - 7
 
 env:

composer.json

@@ -12,16 +12,22 @@
     }
   ],
   "require": {
-    "php": ">=5.3.9",
-    "symfony/yaml": ">=2.6"
+    "php": "^7.0",
+    "symfony/yaml": "^3.0"
   },
   "require-dev": {
-    "phpunit\/phpunit": "^4.0",
+    "phpunit\/phpunit": "^5.0",
     "mikey179/vfsStream": "^1.0"
   },
   "autoload": {
     "psr-4": {
-      "Asm\\": ""
+      "Asm\\": "lib/"
     }
+  },
+  "config": {
+    "bin-dir": "bin"
+  },
+  "autoload-dev": {
+    "psr-4": { "Tests\\": "tests/" }
   }
 }

Config/AbstractConfig.php renamed to lib/Config/AbstractConfig.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * This file is part of the php-utilities package.
  *
@@ -10,19 +11,28 @@
 namespace Asm\Config;
 
 use Asm\Data\Data;
+use Asm\Exception\InvalidConfigFileException;
 use Symfony\Component\Yaml\Yaml;
 
 /**
  * Class AbstractConfig
  *
  * @package Asm\Config
- * @author marc aschmann <maschmann@gmail.com>
+ * @author Marc Aschmann <maschmann@gmail.com>
  * @codeCoverageIgnore
  * @uses Asm\Data\Data
  * @uses Symfony\Component\Yaml\Yaml
  */
 abstract class AbstractConfig extends Data
 {
+    const IMPORTS = 'imports';
+    const FILECHECK = 'filecheck';
+    const FILE = 'file';
+    const RESOURCE = 'resource';
+    const DEFAULT = 'default';
+    const DEFAULT_ENVIRONMENT = 'defaultEnv';
+    const ENVIRONMENT = 'env';
+
     /**
      * @var bool
      */
@@ -50,8 +60,8 @@ abstract class AbstractConfig extends Data
      */
     public function __construct(array $param)
     {
-        if (isset($param['filecheck'])) {
-            $this->filecheck = (bool)$param['filecheck'];
+        if (isset($param[self::FILECHECK])) {
+            $this->filecheck = (bool)$param[self::FILECHECK];
         }
 
         $this->setConfig($param['file']);
@@ -63,10 +73,13 @@ public function __construct(array $param)
      *
      * @param string $name name of property
      * @param string $file string $file absolute filepath/filename.ending
+     * @return $this
      */
-    public function addConfig($name, $file)
+    public function addConfig(string $name, string $file)
     {
         $this->set($name, $this->readConfig($file));
+
+        return $this;
     }
 
     /**
@@ -75,7 +88,7 @@ public function addConfig($name, $file)
      * @param  string $file absolute filepath/filename.ending
      * @return array config array
      */
-    public function readConfig($file)
+    public function readConfig(string $file) : array
     {
         $this->currentBasepath = dirname($file);
 
@@ -94,15 +107,18 @@ public function readConfig($file)
      * Add config to data storage.
      *
      * @param string $file absolute filepath/filename.ending
+     * @return $this
      */
-    public function setConfig($file)
+    public function setConfig(string $file)
     {
         $this->setByArray(
             array_replace_recursive(
                 $this->default,
                 $this->readConfig($file)
             )
         );
+
+        return $this;
     }
 
     /**
@@ -111,14 +127,14 @@ public function setConfig($file)
      * @param string $file path/filename
      * @return array
      */
-    private function readFile($file)
+    private function readFile(string $file) : array
     {
         if ($this->filecheck) {
             if (is_file($file)) {
                 $file = file_get_contents($file);
             } else {
-                throw new \InvalidArgumentException(
-                    'Config::Abstract() - Given config file ' . $file . ' does not exist!'
+                throw new InvalidConfigFileException(
+                    "Config::Abstract() - Given config file {$file} does not exist!"
                 );
             }
         }
@@ -132,13 +148,13 @@ private function readFile($file)
      * @param array $config
      * @return array
      */
-    private function extractImports(array $config)
+    private function extractImports(array $config) : array
     {
-        if (array_key_exists('imports', $config) && 0 < count($config['imports'])) {
+        if (array_key_exists(self::IMPORTS, $config) && 0 < count($config[self::IMPORTS])) {
             $this->imports = [];
-            foreach ($config['imports'] as $key => $import) {
-                if (false === empty($import['resource'])) {
-                    $include = $this->checkPath($import['resource']);
+            foreach ($config[self::IMPORTS] as $key => $import) {
+                if (false === empty($import[self::RESOURCE])) {
+                    $include = $this->checkPath($import[self::RESOURCE]);
 
                     $this->imports = array_replace_recursive(
                         $this->imports,
@@ -147,7 +163,7 @@ private function extractImports(array $config)
                 }
             }
 
-            unset($config['imports']);
+            unset($config[self::IMPORTS]);
         }
 
         return $config;
@@ -159,11 +175,11 @@ private function extractImports(array $config)
      * @param array $config
      * @return array
      */
-    private function extractDefault($config)
+    private function extractDefault(array $config) : array
     {
-        if (array_key_exists('default', $config)) {
-            $this->default = $config['default'];
-            unset($config['default']);
+        if (array_key_exists(self::DEFAULT, $config)) {
+            $this->default = $config[self::DEFAULT];
+            unset($config[self::DEFAULT]);
         }
 
         return $config;
@@ -183,7 +199,7 @@ private function mergeDefault()
      * @param string $include
      * @return string
      */
-    private function checkPath($include)
+    private function checkPath(string $include) : string
     {
         if (0 !== strpos($include, $this->currentBasepath)) {
             $include = $this->currentBasepath . '/' . $include;

Config/Config.php renamed to lib/Config/Config.php

@@ -9,14 +9,20 @@
  */
 namespace Asm\Config;
 
+use Asm\Exception\ConfigClassNotExistsException;
+use Asm\Exception\ConfigParameterMissingException;
+
 /**
  * Class Config
  *
  * @package Asm\Config
- * @author marc aschmann <maschmann@gmail.com>
+ * @author Marc Aschmann <maschmann@gmail.com>
  */
 final class Config
 {
+    const DEFAULT_CONFIG = 'ConfigDefault';
+    const DEFAULT_NAMESPACE = 'Asm';
+
     /**
      * Get object of specific class.
      *
@@ -26,22 +32,24 @@ final class Config
      * @throws \InvalidArgumentException
      * @return ConfigInterface
      */
-    public static function factory(array $param, $class = 'ConfigDefault')
+    public static function factory(array $param, string $class = self::DEFAULT_CONFIG) : ConfigInterface
     {
-        if (false === strpos($class, 'Asm')) {
+        if (false === strpos($class, self::DEFAULT_NAMESPACE)) {
             $class = __NAMESPACE__ . '\\' . $class;
         }
 
         if (class_exists($class)) {
             // allow config names without ending
             if (empty($param['file'])) {
-                throw new \InvalidArgumentException('Config::factory() - config filename missing in param array!');
+                throw new ConfigParameterMissingException(
+                    'Config::factory() - config filename missing in param array!'
+                );
             }
 
             return new $class($param);
         } else {
-            throw new \ErrorException(
-                'Config::factory() - could not instantiate ' . $class
+            throw new ConfigClassNotExistsException(
+                "Config::factory() - could not instantiate {$class}, does not exist!"
             );
         }
     }

Config/ConfigDefault.php renamed to lib/Config/ConfigDefault.php

@@ -13,7 +13,7 @@
  * Class ConfigDefault
  *
  * @package Asm\Config
- * @author marc aschmann <maschmann@gmail.com>
+ * @author Marc Aschmann <maschmann@gmail.com>
  */
 final class ConfigDefault extends AbstractConfig implements ConfigInterface
 {

Config/ConfigEnv.php renamed to lib/Config/ConfigEnv.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * This file is part of the php-utilities package.
  *
@@ -15,7 +16,7 @@
  * Class ConfigDefault
  *
  * @package Asm\Config
- * @author marc aschmann <maschmann@gmail.com>
+ * @author Marc Aschmann <maschmann@gmail.com>
  */
 final class ConfigEnv extends AbstractConfig implements ConfigInterface
 {
@@ -31,33 +32,32 @@ final class ConfigEnv extends AbstractConfig implements ConfigInterface
      */
     public function __construct(array $param)
     {
-        if (isset($param['filecheck'])) {
-            $this->filecheck = (bool)$param['filecheck'];
+        if (isset($param[self::FILECHECK])) {
+            $this->filecheck = (bool)$param[self::FILECHECK];
         }
 
-        if (!empty($param['defaultEnv'])) {
-            $this->defaultEnv = $param['defaultEnv'];
+        if (!empty($param[self::DEFAULT_ENVIRONMENT])) {
+            $this->defaultEnv = $param[self::DEFAULT_ENVIRONMENT];
         }
 
         $this->mergeEnvironments($param);
     }
 
     /**
      * Merge environments based on defaults array.
-     *
      * Merge order is prod -> lesser environment.
      *
      * @param array $param
      */
-    private function mergeEnvironments($param)
+    private function mergeEnvironments(array $param)
     {
         $config = new Data();
         $config->setByArray(
             $this->readConfig($param['file'])
         );
 
-        if (!empty($param['env']) && $this->defaultEnv !== $param['env']) {
-            $toMerge = $config->get($param['env'], []);
+        if (!empty($param[self::ENVIRONMENT]) && $this->defaultEnv !== $param[self::ENVIRONMENT]) {
+            $toMerge = $config->get($param[self::ENVIRONMENT], []);
             $merged = array_replace_recursive(
                 $config->get($this->defaultEnv),
                 $toMerge

Config/ConfigInterface.php renamed to lib/Config/ConfigInterface.php

@@ -15,7 +15,7 @@
  * Interface ConfigInterface
  *
  * @package Asm\Config
- * @author marc aschmann <maschmann@gmail.com>
+ * @author Marc Aschmann <maschmann@gmail.com>
  * @uses Asm\Data\DataInterface
  * @codeCoverageIgnore
  */
@@ -27,21 +27,23 @@ interface ConfigInterface extends DataInterface
      *
      * @param string $name name of property
      * @param string $file string $file absolute filepath/filename.ending
+     * @return $this
      */
-    public function addconfig($name, $file);
+    public function addConfig(string $name, string $file);
 
     /**
      * Add config to data storage.
      *
      * @param string $file absolute filepath/filename.ending
+     * @return $this
      */
-    public function setConfig($file);
+    public function setConfig(string $file);
 
     /**
      * Read config file via YAML parser.
      *
      * @param string $file absolute filepath/filename.ending
      * @return array  config array
      */
-    public function readConfig($file);
+    public function readConfig(string $file) : array;
 }