Merge pull request #238 from oanhnn/features/change-specific-for-env-vars

Change specific requirement for env vars

src/Server/Environment.php

@@ -7,6 +7,8 @@
 
 namespace Deployer\Server;
 
+use Deployer\Type\DotArray;
+
 class Environment
 {
     const DEPLOY_PATH = 'deploy_path';
@@ -14,15 +16,23 @@ class Environment
     /**
      * Globally defaults values.
      *
-     * @var array
+     * @var \Deployer\Type\DotArray
      */
-    static private $defaults = [];
+    static private $defaults = null;
 
     /**
      * Array of env values.
-     * @var array
+     * @var \Deployer\Type\DotArray
      */
-    private $values = [];
+    private $values = null;
+    
+    /**
+     * Constructor
+     */
+    public function __construct()
+    {
+        $this->values = new DotArray();
+    }
 
     /**
      * @param string $name
@@ -41,17 +51,17 @@ class Environment
      */
     public function get($name, $default = null)
     {
-        if (array_key_exists($name, $this->values)) {
+        if ($this->values->hasKey($name)) {
             $value = $this->values[$name];
         } else {
-            if (isset(self::$defaults[$name])) {
+            if (null !== self::$defaults && isset(self::$defaults[$name])) {
                 if (is_callable(self::$defaults[$name])) {
                     $value = $this->values[$name] = call_user_func(self::$defaults[$name]);
                 } else {
                     $value = $this->values[$name] = self::$defaults[$name];
                 }
             } else {
-                if ($default === null) {
+                if (null === $default) {
                     throw new \RuntimeException("Environment parameter `$name` does not exists.");
                 } else {
                     $value = $default;
@@ -67,6 +77,9 @@ class Environment
      */
     public static function getDefault($name)
     {
+        if (null === self::$defaults) {
+            self::$defaults = new DotArray();
+        }
         return self::$defaults[$name];
     }
 
@@ -76,6 +89,9 @@ class Environment
      */
     public static function setDefault($name, $value)
     {
+        if (null === self::$defaults) {
+            self::$defaults = new DotArray();
+        }
         self::$defaults[$name] = $value;
     }
 
@@ -88,7 +104,7 @@ class Environment
     public function parse($value)
     {
         if (is_string($value)) {
-            $value = preg_replace_callback('/\{\{\s*(\w+)\s*\}\}/', [$this, 'parseCallback'], $value);
+            $value = preg_replace_callback('/\{\{\s*([\w\.]+)\s*\}\}/', [$this, 'parseCallback'], $value);
         }
 
         return $value;

src/Type/DotArray.php

@@ -0,0 +1,166 @@
+<?php
+/* (c) Anton Medvedev <anton@elfet.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Deployer\Type;
+
+/**
+ * DotArray
+ * Allow access $array['abc.xyz'] same $array['abc']['xyz']
+ *
+ * Thank Glynn Forrest with https://github.com/glynnforrest/Crutches
+ *
+ * @author OanhNN <oanhnn@rikkeisoft.com>
+ * @version 1.0
+ */
+class DotArray implements \ArrayAccess
+{
+
+    /**
+     * Storage array
+     *
+     * @var array
+     */
+    protected $array = [];
+
+    /**
+     * Validate key
+     *
+     * @param string $key
+     * @return bool
+     */
+    public function validateKey($key)
+    {
+        return (bool) preg_match('/^(\w|\.)+$/', $key);
+    }
+
+    /**
+     * Check has key
+     *
+     * @param string $key
+     * @return bool
+     * @throws \RuntimeException
+     */
+    public function hasKey($key)
+    {
+        if (!$this->validateKey($key)) {
+            throw new \RuntimeException("Key `$key` is invalid");
+        }
+
+        $parts = explode('.', $key);
+        $scope = &$this->array;
+        $count = count($parts) - 1;
+        for ($i = 0; $i < $count; $i++) {
+            if (!isset($scope[$parts[$i]])) {
+                return false;
+            }
+            $scope = &$scope[$parts[$i]];
+        }
+        
+        return array_key_exists($parts[$i], $scope);
+    }
+
+    /**
+     * Get all value as array
+     *
+     * @return array
+     */
+    public function toArray()
+    {
+        return $this->array;
+    }
+
+    /**
+     * Check exist key . Like isset(), a value of null is considered not set.
+     * isset($array['abc.xyz']) same isset($array['abc']['xyz'])
+     *
+     * @param string $key
+     * @return bool
+     */
+    public function offsetExists($key)
+    {
+        return null !== $this->offsetGet($key);
+    }
+
+    /**
+     * Get an array value
+     * $array['abc.xyz'] same $array['abc']['xyz']
+     *
+     * @param string $key
+     * @return mixed NULL will be returned if the key is not found.
+     * @throws \RuntimeException
+     */
+    public function offsetGet($key)
+    {
+        if (!$this->validateKey($key)) {
+            throw new \RuntimeException("Key `$key` is invalid");
+        }
+
+        $parts = explode('.', $key);
+        $scope = &$this->array;
+        $count = count($parts) - 1;
+        for ($i = 0; $i < $count; $i++) {
+            if (!isset($scope[$parts[$i]])) {
+                return null;
+            }
+            $scope = &$scope[$parts[$i]];
+        }
+        
+        return isset($scope[$parts[$i]]) ? $scope[$parts[$i]] : null;
+    }
+
+    /**
+     * Set an array value
+     * $array['abc.xyz'] = 'value' same $array['abc']['xyz'] = 'value'
+     *
+     * @param string $key
+     * @param mixed $value
+     * @throws \RuntimeException
+     */
+    public function offsetSet($key, $value)
+    {
+        if (!$this->validateKey($key)) {
+            throw new \RuntimeException("Key `$key` is invalid");
+        }
+
+        $parts = explode('.', $key);
+        //loop through each part, create it if not present.
+        $scope = &$this->array;
+        $count = count($parts) - 1;
+        for ($i = 0; $i < $count; $i++) {
+            if (!isset($scope[$parts[$i]])) {
+                $scope[$parts[$i]] = [];
+            }
+            $scope = &$scope[$parts[$i]];
+        }
+        $scope[$parts[$i]] = $value;
+    }
+
+    /**
+     * Unset an array value
+     * unset($array['abc.xyz']) same unset($array['abc']['xyz'])
+     * 
+     * @param string $key
+     */
+    public function offsetUnset($key)
+    {
+        if (!$this->validateKey($key)) {
+            throw new \RuntimeException("Key `$key` is invalid");
+        }
+
+        $parts = explode('.', $key);
+        $scope = &$this->array;
+        $count = count($parts) - 1;
+        for ($i = 0; $i < $count; $i++) {
+            if (!isset($scope[$parts[$i]])) {
+                return;
+            }
+            $scope = &$scope[$parts[$i]];
+        }
+        unset($scope[$parts[$i]]);
+    }
+
+}

test/src/Type/DotArrayTest.php

@@ -0,0 +1,70 @@
+<?php
+
+/* (c) Anton Medvedev <anton@elfet.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Deployer\Type;
+
+use Deployer\Type\DotArray;
+
+/**
+ * DotArrayTest class
+ * 
+ * @author OanhNN <oanhnn@rikkeisoft.com>
+ * @version 1.0
+ */
+class DotArrayTest extends \PHPUnit_Framework_TestCase
+{
+
+    public function testDotArray()
+    {
+        $array     = [
+            'abc1'      => [
+                'xyz1' => 1,
+                'xyz2' => [1, 2, 3],
+            ],
+            'abc2.xyz1' => 2,
+            'abc2.xyz2' => [4, 5, 6],
+            'callable'  => function() {
+            echo 'hello world';
+        },
+            'abc.null' => null,
+        ];
+
+        $dotArray = new DotArray();
+        foreach ($array as $key => $value) {
+            $dotArray[$key] = $value;
+        }
+
+        foreach ($array as $key => $value) {
+            $this->assertSame($value, $dotArray[$key]);
+        }
+
+        $this->assertSame(isset($array['abc9.xyz']), isset($dotArray['abc9.xyz']));
+        $this->assertSame(isset($array['abc1']['xyz1']), isset($dotArray['abc1.xyz1']));
+        
+        $this->assertSame($dotArray['abc1']['xyz1'], $dotArray['abc1.xyz1']);
+        $this->assertSame($array['abc2.xyz1'], $dotArray['abc2']['xyz1']);
+
+        $this->assertSame(false, $dotArray->hasKey('abc1.null'));
+        $this->assertSame(true, $dotArray->hasKey('abc1.xyz2'));
+        $this->assertSame(true, $dotArray->hasKey('abc.null'));
+        
+        $this->assertSame(false, isset($dotArray['abc.null']));
+        $this->assertSame(false, isset($dotArray['abc']['null']));
+
+        $this->assertSame(['xyz1' => 2, 'xyz2' => [4, 5, 6]], $dotArray['abc2']);
+        
+        unset($dotArray['abc.null']);
+        $this->assertSame(false, isset($dotArray['abc']['null']));
+        $this->assertSame(false, $dotArray->hasKey('abc.null'));
+        
+        unset($dotArray['abc2']);
+        $this->assertSame(false, isset($dotArray['abc2']['xyz1']));
+        $this->assertSame(false, $dotArray->hasKey('abc2.xyz1'));
+    }
+
+}