[DotEnv] Add a new loadForEnv() method mimicking Ruby's dotenv behavior

dunglas · dunglas · commit 1000890c7e0d · 2018-09-21T08:56:56.000+02:00
diff --git a/src/Symfony/Component/Dotenv/Dotenv.php b/src/Symfony/Component/Dotenv/Dotenv.php
@@ -21,6 +21,7 @@
  * Manages .env files.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ * @author Kévin Dunglas <dunglas@gmail.com>
  */
 final class Dotenv
 {
@@ -50,6 +51,32 @@ public function load(string $path, string ...$paths): void
         $this->doLoad(false, $path, $paths);
     }
 
+    /**
+     * Loads one or several .env and the corresponding env.local, env.$env and env.$env.local files if they exist.
+     *
+     * The env.test.local is always ignored because tests should produce the same results for everyone.
+     *
+     * @param string    $path  A file to load
+     * @param ...string $paths A list of additional files to load
+     *
+     * @throws FormatException when a file has a syntax error
+     * @throws PathException   when a file does not exist or is not readable
+     *
+     * @see https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use
+     */
+    public function loadForEnv(string $env, string $path, string ...$paths): void
+    {
+        array_unshift($paths, $path);
+        foreach ($paths as $p) {
+            $pathList = ["$p.$env"];
+            if ($env !== 'test') {
+                $pathList[] = "$p.local";
+            }
+            $pathList[] = "$p.$env.local";
+
+            $this->doLoad(false, $p, $pathList, true);
+        }
+    }
     /**
      * Loads one or several .env files and enables override existing vars.
      *
@@ -405,16 +432,24 @@ private function createFormatException($message)
         return new FormatException($message, new FormatExceptionContext($this->data, $this->path, $this->lineno, $this->cursor));
     }
 
-    private function doLoad(bool $overrideExistingVars, string $path, array $paths): void
+    /**
+     * @param bool $envMode Silently ignore not existing files in $paths (but not the one in $path)
+     */
+    private function doLoad(bool $overrideExistingVars, string $path, array $paths, bool $envMode = false): void
     {
         array_unshift($paths, $path);
 
+        $silent = false;
         foreach ($paths as $path) {
             if (!is_readable($path) || is_dir($path)) {
+                if ($silent) {
+                    continue;
+                }
                 throw new PathException($path);
             }
 
             $this->populate($this->parse(file_get_contents($path), $path), $overrideExistingVars);
+            $silent = $envMode;
         }
     }
 }
diff --git a/src/Symfony/Component/Dotenv/Tests/DotenvTest.php b/src/Symfony/Component/Dotenv/Tests/DotenvTest.php
@@ -186,6 +186,64 @@ public function testLoad()
         $this->assertSame('BAZ', $bar);
     }
 
+    public function testLoadForEnv()
+    {
+        unset($_ENV['FOO']);
+        unset($_ENV['BAR']);
+        unset($_SERVER['FOO']);
+        unset($_SERVER['BAR']);
+        putenv('FOO');
+        putenv('BAR');
+
+        @mkdir($tmpdir = sys_get_temp_dir().'/dotenv');
+
+        $path1 = tempnam($tmpdir, 'sf-');
+        $path2 = tempnam($tmpdir, 'sf-');
+
+        file_put_contents($path1, 'FOO=BAR');
+        file_put_contents($path2, 'BAR=BAZ');
+
+        // .env
+
+        (new DotEnv())->loadForEnv('dev', $path1, $path2);
+
+        $this->assertSame('BAR', getenv('FOO'));
+        $this->assertSame('BAZ', getenv('BAR'));
+
+        // .env.dev
+
+        file_put_contents("$path1.dev", 'FOO=devBAR');
+        (new DotEnv())->loadForEnv('dev', $path1, $path2);
+        $this->assertSame('devBAR', getenv('FOO'));
+
+        // .env.local
+
+        file_put_contents("$path1.local", 'FOO=localBAR');
+        (new DotEnv())->loadForEnv('dev', $path1, $path2);
+        $this->assertSame('localBAR', getenv('FOO'));
+
+        // special case for test
+
+        file_put_contents("$path1.local", 'FOO=testBAR');
+        (new DotEnv())->loadForEnv('test', $path1, $path2);
+        $this->assertSame('BAR', getenv('FOO'));
+
+        // .env.dev.local
+
+        file_put_contents("$path1.dev.local", 'FOO=devlocalBAR');
+        (new DotEnv())->loadForEnv('dev', $path1, $path2);
+        $this->assertSame('devlocalBAR', getenv('FOO'));
+
+        putenv('FOO');
+        putenv('BAR');
+        unlink($path1);
+        unlink("$path1.dev");
+        unlink("$path1.local");
+        unlink("$path1.dev.local");
+        unlink($path2);
+        rmdir($tmpdir);
+    }
+
     public function testOverload()
     {
         unset($_ENV['FOO']);
