Merge pull request #1 from Maatwebsite/feature/add-getters

Added getEnv and getRawEnv methods on the Yamlenv.

Author: jochemfuchs

src/Loader.php

@@ -326,4 +326,32 @@ private function normalizeKey($key)
 
         return $key;
     }
+
+    /**
+     * @param string $key
+     *
+     * @return string|array|null
+     */
+    public function getYamlValue($key)
+    {
+        if (is_null($key)) {
+            return null;
+        }
+
+        if (isset($this->yamlVariables[$key])) {
+            return $this->yamlVariables[$key];
+        }
+
+        $array = $this->yamlVariables;
+
+        foreach (explode('.', $key) as $segment) {
+            if (! is_array($array) || ! array_key_exists($segment, $array)) {
+                return null;
+            }
+
+            $array = $array[$segment];
+        }
+
+        return $array;
+    }
 }

src/Yamlenv.php

@@ -73,16 +73,15 @@ public function required($variable)
     }
 
     /**
-     * Get loader instance
+     * Get loader instance.
      *
      * @throws LoaderException
      *
      * @return Loader
      */
     public function getLoader()
     {
-        if(!$this->loader)
-        {
+        if (!$this->loader) {
             throw new LoaderException('Loader has not been initialized yet.');
         }
 
@@ -135,4 +134,34 @@ protected function loadData($overload = false)
 
         return $this->loader->load();
     }
+
+    /**
+     * Get an environment value. Returns the default when it is null.
+     *
+     * @param string $key
+     * @param null   $default
+     *
+     * @return null|string
+     */
+    public function getEnv($key, $default = null)
+    {
+        $value = $this->getLoader()->getEnvironmentVariable($key);
+
+        return is_null($value) ? $default : $value;
+    }
+
+    /**
+     * Get the raw env value from the Yaml. Can be used to fetch associative arrays from the Yaml file.
+     *
+     * @param string $key
+     * @param null   $default
+     *
+     * @return array|null|string
+     */
+    public function getRawEnv($key, $default = null)
+    {
+        $value = $this->getLoader()->getYamlValue($key);
+
+        return is_null($value) ? $default : $value;
+    }
 }

tests/Yamlenv/LoaderTest.php

@@ -13,10 +13,12 @@ class LoaderTest extends PHPUnit_Framework_TestCase
      * @var \Yamlenv\Loader
      */
     private $immutableLoader;
+
     /**
      * @var array
      */
     private $keyVal;
+
     /**
      * @var \Yamlenv\Loader
      */
@@ -142,6 +144,34 @@ public function testFlattenNestedValuesThrowsExceptionWithDuplication()
         $immutableLoader->load();
     }
 
+    public function testItCanReturnAnAssociativeArray()
+    {
+        $expected = [
+            'ARRAY_ONE' => 1,
+            'ARRAY_TWO' => 2,
+        ];
+
+        $this->mutableLoader->load();
+
+        $actual = $this->mutableLoader->getYamlValue('NESTED');
+
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function testItCanReturnAnAssociativeArrayFromADeepLevel()
+    {
+        $expected = [
+            'ARRAY_ONE' => 1,
+            'ARRAY_TWO' => 2,
+        ];
+
+        $this->mutableLoader->load();
+
+        $actual = $this->mutableLoader->getYamlValue('MULTI.LEVEL.NESTED');
+
+        $this->assertEquals($expected, $actual);
+    }
+
     /**
      * Returns the key from keyVal(), without reset.
      *

tests/Yamlenv/YamlenvTest.php

@@ -129,7 +129,7 @@ public function testYamlenvRequiredArrayEnvironmentVars()
         $yamlenv = new Yamlenv($this->fixturesFolder);
         $yamlenv->load();
         $validator = $yamlenv->required(['FOO', 'BAR']);
--
+
         $this->assertInstanceOf(Validator::class, $validator);
     }
 
@@ -451,6 +451,36 @@ public function testGetLoaderGivesNullBeforeLoad()
         $yamlenv->getLoader();
     }
 
+    public function testGetEnvReturnsTheEnvValue()
+    {
+        $this->clearEnv();
+
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'env.yml');
+        $yamlenv->load();
+
+        $expected = 'bar';
+
+        $actual = $yamlenv->getEnv('FOO');
+
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function testGetRawEnvReturnsTheYamlValue()
+    {
+        $this->clearEnv();
+
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'env.yml');
+        $yamlenv->load();
+
+        $expected = [
+            'ARRAY_ONE' => 1,
+            'ARRAY_TWO' => 2,
+        ];
+
+        $actual = $yamlenv->getRawEnv('NESTED');
+
+        $this->assertEquals($expected, $actual);
+    }
 
     /**
      * Clear all env vars.

tests/fixtures/valid/env.yml

@@ -3,5 +3,13 @@
 FOO: bar
 BAR: baz
 SPACED: with spaces
+NESTED:
+  ARRAY_ONE: 1
+  ARRAY_TWO: 2
+MULTI:
+  LEVEL:
+    NESTED:
+      ARRAY_ONE: 1
+      ARRAY_TWO: 2
 
 EMPTY: