Handle aggregation and checks within load(), and expose read()

Author: GrahamCampbell

src/Dotenv.php

@@ -107,32 +107,71 @@ public static function createImmutable($paths, $names = null, $shortCircuit = tr
     }
 
     /**
-     * Load environment file in given directory.
+     * Read the environment file(s), and return their raw content only.
+     *
+     * We provide the file path as the key, and its content as the value. If
+     * short circuit mode is enabled, then the returned array with have length
+     * at most one. File paths that couldn't be read are omitted entirely.
+     *
+     * @return array<string,string>
+     */
+    public function read()
+    {
+        $output = [];
+
+        foreach ($this->filePaths as $filePath) {
+            $content = self::readFromFile($filePath);
+            if ($content->isDefined()) {
+                $output[$filePath] = $content->get();
+                if ($this->shortCircuit) {
+                    break;
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Read and load environment file(s).
      *
      * @throws \Dotenv\Exception\InvalidPathException|\Dotenv\Exception\InvalidFileException
      *
      * @return array<string,string|null>
      */
     public function load()
     {
-        return $this->loader->load($this->repository, self::findAndRead($this->filePaths, $this->shortCircuit));
+        if ($this->filePaths === []) {
+            throw new InvalidPathException('At least one environment file path must be provided.');
+        }
+
+        $content = self::aggregate($this->read());
+
+        if ($content->isDefined()) {
+            return $this->loader->load($this->repository, $content->get());
+        }
+
+        throw new InvalidPathException(
+            sprintf('Unable to read any of the environment file(s) at [%s].', implode(', ', $this->filePaths))
+        );
     }
 
     /**
-     * Load environment file in given directory, silently failing if it doesn't exist.
+     * Read and load environment file(s), silently failing if no files can be read.
      *
      * @throws \Dotenv\Exception\InvalidFileException
      *
      * @return array<string,string|null>
      */
     public function safeLoad()
     {
-        try {
-            return $this->load();
-        } catch (InvalidPathException $e) {
-            // suppressing exception
-            return [];
+        $content = self::aggregate($this->read());
+
+        if ($content->isDefined()) {
+            return $this->loader->load($this->repository, $content->get());
         }
+
+        return [];
     }
 
     /**
@@ -181,53 +220,34 @@ private static function getFilePaths(array $paths, $names)
     }
 
     /**
-     * Attempt to read the files in order.
-     *
-     * @param string[] $filePaths
-     * @param bool     $shortCircuit
+     * Read the given file.
      *
-     * @throws \Dotenv\Exception\InvalidPathException
+     * @param string $filePath
      *
-     * @return string
+     * @return \PhpOption\Option
      */
-    private static function findAndRead(array $filePaths, $shortCircuit)
+    private static function readFromFile($filePath)
     {
-        if ($filePaths === []) {
-            throw new InvalidPathException('At least one environment file path must be provided.');
-        }
-
-        $output = '';
-
-        foreach ($filePaths as $filePath) {
-            $content = self::readFromFile($filePath);
-            if ($content->isDefined()) {
-                $output .= $content->get()."\n";
-                if ($shortCircuit) {
-                    break;
-                }
-            }
-        }
-
-        if (!$output) {
-            throw new InvalidPathException(
-                sprintf('Unable to read any of the environment file(s) at [%s].', implode(', ', $filePaths))
-            );
-        }
+        $content = @file_get_contents($filePath);
 
-        return $output;
+        return Option::fromValue($content, false);
     }
 
     /**
-     * Read the given file.
+     * Aggregate the given raw file contents.
      *
-     * @param string $filePath
+     * @param array<string,string> $contents
      *
      * @return \PhpOption\Option
      */
-    private static function readFromFile($filePath)
+    private static function aggregate(array $contents)
     {
-        $content = @file_get_contents($filePath);
+        $output = '';
 
-        return Option::fromValue($content, false);
+        foreach ($contents as $content) {
+            $output .= $content."\n";
+        }
+
+        return Option::fromValue($output, '');
     }
 }

tests/Dotenv/DotenvTest.php

@@ -70,6 +70,31 @@ public function testDotenvLoadsEnvironmentVars()
         $this->assertEmpty(getenv('NULL'));
     }
 
+    public function testDotenvReadsEnvironmentVarsMultipleNotShortCircuitMode()
+    {
+        $dotenv = Dotenv::createImmutable($this->folder, ['.env', 'example.env']);
+
+        $this->assertSame(
+            [
+                $this->folder.DIRECTORY_SEPARATOR.'.env' => "FOO=bar\nBAR=baz\nSPACED=\"with spaces\"\n\nNULL=\n",
+            ],
+            $dotenv->read()
+        );
+    }
+
+    public function testDotenvReadsEnvironmentVarsMultipleWithShortCircuitMode()
+    {
+        $dotenv = Dotenv::createImmutable($this->folder, ['.env', 'example.env'], false);
+
+        $this->assertSame(
+            [
+                $this->folder.DIRECTORY_SEPARATOR.'.env' => "FOO=bar\nBAR=baz\nSPACED=\"with spaces\"\n\nNULL=\n",
+                $this->folder.DIRECTORY_SEPARATOR.'example.env' => "EG=\"example\"\n",
+            ],
+            $dotenv->read()
+        );
+    }
+
     public function testDotenvLoadsEnvironmentVarsMultipleNotShortCircuitMode()
     {
         $dotenv = Dotenv::createImmutable($this->folder, ['.env', 'example.env']);