phpstan 2.0 upgrade and fixes

Now blocks can be set as prefix names for variables via [Block Name] type
grouping.

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+run-name: ${{ github.actor}} runs CI
+
+on: [push]
+
+jobs:
+  ci-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: php-actions/composer@v6
+        env:
+          COMPOSER_ROOT_VERSION: dev-master
+      - name: "Restore result cache"
+        uses: actions/cache/restore@v4
+        with:
+          path: ./tmp
+          key: "result-cache-v1-${{ matrix.php-version }}-${{ github.run_id }}"
+          restore-keys: |
+            result-cache-v1-${{ matrix.php-version }}-
+      - name: PHPStan Static Analysis
+        uses: php-actions/phpstan@v3
+        with:
+          path: src/
+          configuration: phpstan.neon
+      - name: "Save result cache"
+        uses: actions/cache/save@v4
+        if: always()
+        with:
+          path: ./tmp
+          key: "result-cache-v1-${{ matrix.php-version }}-${{ github.run_id }}"
+          # We need to use phpunit from the self install to get the class paths
+      - name: PHPunit Tests
+        run: |
+          vendor/bin/phpunit

.gitignore

@@ -1,3 +1,4 @@
 vendor
 .phpunit.result.cache
+.phplint-cache
 composer.lock

.phan/config.php

@@ -26,72 +26,73 @@
 // use Phan\Config;
 
 return [
-	// If true, missing properties will be created when
+    // If true, missing properties will be created when
-	// they are first seen. If false, we'll report an
+    // they are first seen. If false, we'll report an
-	// error message.
+    // error message.
-	"allow_missing_properties" => false,
+    "allow_missing_properties" => false,
 
-	// Allow null to be cast as any type and for any
+    // Allow null to be cast as any type and for any
-	// type to be cast to null.
+    // type to be cast to null.
-	"null_casts_as_any_type" => false,
+    "null_casts_as_any_type" => false,
 
-	// Backwards Compatibility Checking
+    // Backwards Compatibility Checking
-	'backward_compatibility_checks' => true,
+    'backward_compatibility_checks' => true,
 
-	// Run a quick version of checks that takes less
+    // Run a quick version of checks that takes less
-	// time
+    // time
-	"quick_mode" => false,
+    "quick_mode" => false,
 
-	// Only emit critical issues to start with
+    // Only emit critical issues to start with
-	// (0 is low severity, 5 is normal severity, 10 is critical)
+    // (0 is low severity, 5 is normal severity, 10 is critical)
-	"minimum_severity" => 10,
+    "minimum_severity" => 10,
 
-	// default false for include path check
+    // default false for include path check
-	"enable_include_path_checks" => true,
+    "enable_include_path_checks" => true,
-	"include_paths" => [
+    "include_paths" => [
-	],
+    ],
-	'ignore_undeclared_variables_in_global_scope' => true,
+    'ignore_undeclared_variables_in_global_scope' => true,
 
-	"file_list" => [
+    "file_list" => [
-	],
+    ],
 
-	// A list of directories that should be parsed for class and
+    // A list of directories that should be parsed for class and
-	// method information. After excluding the directories
+    // method information. After excluding the directories
-	// defined in exclude_analysis_directory_list, the remaining
+    // defined in exclude_analysis_directory_list, the remaining
-	// files will be statically analyzed for errors.
+    // files will be statically analyzed for errors.
-	//
+    //
-	// Thus, both first-party and third-party code being used by
+    // Thus, both first-party and third-party code being used by
-	// your application should be included in this list.
+    // your application should be included in this list.
-	'directory_list' => [
+    'directory_list' => [
-		// Change this to include the folders you wish to analyze
+        // Change this to include the folders you wish to analyze
-		// (and the folders of their dependencies)
+        // (and the folders of their dependencies)
-		'.'
+        '.'
-		// 'www',
+        // 'www',
-		// To speed up analysis, we recommend going back later and
+        // To speed up analysis, we recommend going back later and
-		// limiting this to only the vendor/ subdirectories your
+        // limiting this to only the vendor/ subdirectories your
-		// project depends on.
+        // project depends on.
-		// `phan --init` will generate a list of folders for you
+        // `phan --init` will generate a list of folders for you
-	],
+    ],
 
 
-	// A list of directories holding code that we want
+    // A list of directories holding code that we want
-	// to parse, but not analyze
+    // to parse, but not analyze
-	"exclude_analysis_directory_list" => [
+    "exclude_analysis_directory_list" => [
-		'vendor',
+        'vendor',
-		'test'
+        'test',
-	],
+        'tmp'
-	'exclude_file_list' => [
+    ],
-	],
+    'exclude_file_list' => [
+    ],
 
-	// what not to show as problem
+    // what not to show as problem
-	'suppress_issue_types' => [
+    'suppress_issue_types' => [
-		// 'PhanUndeclaredMethod',
+        // 'PhanUndeclaredMethod',
-		'PhanEmptyFile',
+        'PhanEmptyFile',
-	],
+    ],
 
-	// Override to hardcode existence and types of (non-builtin) globals in the global scope.
+    // Override to hardcode existence and types of (non-builtin) globals in the global scope.
-	// Class names should be prefixed with `\`.
+    // Class names should be prefixed with `\`.
-	//
+    //
-	// (E.g. `['_FOO' => '\FooClass', 'page' => '\PageClass', 'userId' => 'int']`)
+    // (E.g. `['_FOO' => '\FooClass', 'page' => '\PageClass', 'userId' => 'int']`)
-	'globals_type_map' => [],
+    'globals_type_map' => [],
 ];

Readme.md

@@ -60,3 +60,42 @@ ESCAPE="String \" inside \" other "
 DOUBLE="I will be used"
 DOUBLE="This will be ignored"
 ```
+
+A prefix name can be set with `[PrefixName]`. Tne name rules are like for variables, but spaces
+are allowed, but will be converted to "_".
+The prefix is valid from the time set until the next prefix block appears or the file ends.
+
+Example
+
+```ini
+FOO="bar"
+FOOBAR="bar bar"
+[SecitonA]
+FOO="other bar"
+FOOBAR="other bar bar"
+```
+
+Will have environmen variables as
+
+```php
+$_ENV["FOO"];
+$_ENV["FOOBAR"];
+$_ENV["SecitonA.FOO"];
+$_ENV["SecitonA.FOOBAR"];
+```
+
+## Development
+
+### Phan
+
+`vendor/bin/phan --analyze-twice`
+
+### PHPstan
+
+`vendor/bin/phpstan`
+
+### PHPUnit
+
+Unit tests have to be run from base folder with
+
+`vendor/bin/phpunit test/phpUnitTests/`

composer.json

@@ -6,7 +6,8 @@
     "license": "MIT",
     "autoload": {
         "psr-4": {
-            "gullevek\\dotEnv\\": "src/"
+            "gullevek\\dotEnv\\": "src/",
+            "gullevek\\dotenv\\": "src/"
         }
     },
     "authors": [
@@ -25,6 +26,10 @@
         "exclude": ["/test/", "/test/*", "/phpstan.neon", "/psalm.xml", "/.phan/", "/.vscode/", "/phpunit.xml"]
     },
     "require-dev": {
-        "phpunit/phpunit": "^9"
+        "phpunit/phpunit": "^9",
+        "phan/phan": "^5.4",
+		"phpstan/phpstan": "^2.0",
+		"phpstan/phpdoc-parser": "^2.0",
+		"phpstan/phpstan-deprecation-rules": "^2.0"
     }
 }

phpstan.neon

@@ -1,10 +1,10 @@
 # PHP Stan Config
 
 parameters:
-	tmpDir: /tmp/phpstan-codeblocks-dotenv
+	tmpDir: %currentWorkingDirectory%/tmp/phpstan-codeblocks-dotenv
 	level: max
 	paths:
-		- %currentWorkingDirectory%
+		- %currentWorkingDirectory%/src
 	excludePaths:
 		- vendor
 		- test

phpunit.xml

@@ -2,4 +2,9 @@
     colors="true"
     verbose="true"
 >
+    <testsuites>
+        <testsuite name="unit">
+            <directory>test/phpUnitTests/</directory>
+        </testsuite>
+    </testsuites>
 </phpunit>

src/DotEnv.php

@@ -6,105 +6,115 @@ namespace gullevek\dotEnv;
 
 class DotEnv
 {
-	/** @var string constant comment char, set to # */
+    /** @var string constant comment char, set to # */
-	private const COMMENT_CHAR = '#';
+    private const COMMENT_CHAR = '#';
 
-	/**
+    /**
-	 * parses .env file
+     * parses .env file
-	 *
+     *
-	 * Rules for .env file
+     * Rules for .env file
-	 * variable is any alphanumeric string followed by = on the same line
+     * variable is any alphanumeric string followed by = on the same line
-	 * content starts with the first non space part
+     * content starts with the first non space part
-	 * strings can be contained in "
+     * strings can be contained in "
-	 * strings MUST be contained in " if they are multiline
+     * strings MUST be contained in " if they are multiline
-	 * if string starts with " it will match until another " is found
+     * if string starts with " it will match until another " is found
-	 * anything AFTER " is ignored
+     * anything AFTER " is ignored
-	 * if there are two variables with the same name only the first is used
+     * if there are two variables with the same name only the first is used
-	 * variables are case sensitive
+     * variables are case sensitive
-	 *
+     *
-	 * @param  string $path     Folder to file, default is __DIR__
+     * [] Grouping Block Name as prefix until next or end if set,
-	 * @param  string $env_file What file to load, default is .env
+     * space replaced by _, all other var rules apply
-	 * @return int              -1 other error
+     *
-	 *                          0 for success full load
+     * @param  string $path     Folder to file, default is __DIR__
-	 *                          1 for file loadable, no data or data already loaded
+     * @param  string $env_file What file to load, default is .env
-	 *                          2 for file not readable or open failed
+     * @return int              -1 other error
-	 *                          3 for file not found
+     *                          0 for success full load
-	 */
+     *                          1 for file loadable, no data or data already loaded
-	public static function readEnvFile(
+     *                          2 for file not readable or open failed
-		string $path = __DIR__,
+     *                          3 for file not found
-		string $env_file = '.env'
+     */
-	): int {
+    public static function readEnvFile(
-		// default -1;
+        string $path = __DIR__,
-		$status = -1;
+        string $env_file = '.env'
-		$env_file_target = $path . DIRECTORY_SEPARATOR . $env_file;
+    ): int {
-		// this is not a file -> abort
+        // default -1;
-		if (!is_file($env_file_target)) {
+        $status = -1;
-			$status = 3;
+        $env_file_target = $path . DIRECTORY_SEPARATOR . $env_file;
-			return $status;
+        // this is not a file -> abort
-		}
+        if (!is_file($env_file_target)) {
-		// cannot open file -> abort
+            $status = 3;
-		if (!is_readable($env_file_target)) {
+            return $status;
-			$status = 2;
+        }
-			return $status;
+        // cannot open file -> abort
-		}
+        if (!is_readable($env_file_target)) {
-		// open file
+            $status = 2;
-		if (($fp = fopen($env_file_target, 'r')) === false) {
+            return $status;
-			$status = 2;
+        }
-			return $status;
+        // open file
-		}
+        if (($fp = fopen($env_file_target, 'r')) === false) {
-		// set to readable but not yet any data loaded
+            $status = 2;
-		$status = 1;
+            return $status;
-		$block = false;
+        }
-		$var = '';
+        // set to readable but not yet any data loaded
-		while ($line = fgets($fp)) {
+        $status = 1;
-			// main match for variable = value part
+        $block = false;
-			if (preg_match("/^\s*([\w_.]+)\s*=\s*((\"?).*)/", $line, $matches)) {
+        $var = '';
-				$var = $matches[1];
+        $prefix_name = '';
-				$value = $matches[2];
+        while (($line = fgets($fp)) !== false) {
-				$quotes = $matches[3];
+            // [] block must be a single line, or it will be ignored
-				// write only if env is not set yet, and write only the first time
+            if (preg_match("/^\s*\[([\w_.\s]+)\]/", $line, $matches)) {
-				if (empty($_ENV[$var])) {
+                $prefix_name = preg_replace("/\s+/", "_", $matches[1]) . ".";
-					if (!empty($quotes)) {
+            } elseif (preg_match("/^\s*([\w_.]+)\s*=\s*((\"?).*)/", $line, $matches)) {
-						// match greedy for first to last so we move any " if there are
+                // main match for variable = value part
-						if (preg_match('/^"(.*[^\\\])"/U', $value, $matches)) {
+                $var = $prefix_name . $matches[1];
-							$value = $matches[1];
+                $value = $matches[2];
-						} else {
+                $quotes = $matches[3];
-							// this is a multi line
+                // write only if env is not set yet, and write only the first time
-							$block = true;
+                if (empty($_ENV[$var])) {
-							// first " in string remove
+                    if (!empty($quotes)) {
-							// add removed new line back because this is a multi line
+                        // match greedy for first to last so we move any " if there are
-							$value = ltrim($value, '"') . PHP_EOL;
+                        if (preg_match('/^"(.*[^\\\])"/U', $value, $matches)) {
-						}
+                            $value = $matches[1];
-					} else {
+                        } else {
-						// strip any quotes at end for unquoted single line
+                            // this is a multi line
-						// an right hand spaces are removed too
+                            $block = true;
-						$value = false !== ($pos = strpos($value, self::COMMENT_CHAR)) ?
+                            // first " in string remove
-							rtrim(substr($value, 0, $pos)) : $value;
+                            // add removed new line back because this is a multi line
-					}
+                            $value = ltrim($value, '"') . PHP_EOL;
-					// if block is set, we strip line of slashes
+                        }
-					$_ENV[$var] = $block === true ? stripslashes($value) : $value;
+                    } else {
-					// set successful load
+                        // strip any quotes at end for unquoted single line
-					$status = 0;
+                        // an right hand spaces are removed too
-				}
+                        $value = false !== ($pos = strpos($value, self::COMMENT_CHAR)) ?
-			} elseif ($block === true) {
+                            rtrim(substr($value, 0, $pos)) : $value;
-				// read line until there is a unescaped "
+                    }
-				// this also strips everything after the last "
+                    // if block is set, we strip line of slashes
-				if (preg_match("/(.*[^\\\])\"/", $line, $matches)) {
+                    $_ENV[$var] = $block === true ? stripslashes($value) : $value;
-					$block = false;
+                    // set successful load
-					// strip ending " and EVERYTHING that follows after that
+                    $status = 0;
-					$line = $matches[1];
+                }
-				}
+            } elseif ($block === true) {
-				// just be sure it is init before we fill
+                // read line until there is a unescaped "
-				if (!isset($_ENV[$var])) {
+                // this also strips everything after the last "
-					$_ENV[$var] = '';
+                if (preg_match("/(.*[^\\\])\"/", $line, $matches)) {
-				}
+                    $block = false;
-				// strip line of slashes
+                    // strip ending " and EVERYTHING that follows after that
-				$_ENV[$var] .= stripslashes($line);
+                    $line = $matches[1];
-			}
+                }
-		}
+                // just be sure it is init before we fill
-		fclose($fp);
+                if (!isset($_ENV[$var])) {
-		return $status;
+                    $_ENV[$var] = '';
-	}
+                } elseif (!is_string($_ENV[$var])) {
+                    // if this is not string, skip
+                    continue;
+                }
+                // strip line of slashes
+                $_ENV[$var] .= stripslashes($line);
+            }
+        }
+        fclose($fp);
+        return $status;
+    }
 }
 
 // __END__

test/.env

@@ -1 +0,0 @@
-phpUnitTests/dotenv/test.env

test/phpUnitTests/DotEnvTest.php

@@ -13,149 +13,201 @@ use PHPUnit\Framework\TestCase;
  */
 final class DotEnvTest extends TestCase
 {
-	/**
+    /**
-	 * Undocumented function
+     * setup the .env files before test run
-	 *
+     *
-	 * @return array
+     * @return void
-	 */
+     */
-	public function envFileProvider(): array
+    public static function setUpBeforeClass(): void
-	{
+    {
-		$dot_env_content = [
+        // create .env files
-			'SOMETHING' => 'A',
+        $file_content = __DIR__ . DIRECTORY_SEPARATOR
-			'OTHER' => 'B IS B',
+            . 'dotenv' . DIRECTORY_SEPARATOR
-			'Complex' => 'A B \"D is F',
+            . 'test.env';
-			'HAS_SPACE' => 'ABC',
+        // copy to all folder levels
-			'HAS_COMMENT_QUOTES_SPACE' => 'Comment at end with quotes and space',
+        $env_files = [
-			'HAS_COMMENT_QUOTES_NO_SPACE' => 'Comment at end with quotes no space',
+            __DIR__ . DIRECTORY_SEPARATOR
-			'HAS_COMMENT_NO_QUOTES_SPACE' => 'Comment at end no quotes and space',
+                . 'dotenv' . DIRECTORY_SEPARATOR
-			'HAS_COMMENT_NO_QUOTES_NO_SPACE' => 'Comment at end no quotes no space',
+                . '.env',
-			'COMMENT_IN_TEXT_QUOTES' => 'Foo bar # comment in here',
+            __DIR__ . DIRECTORY_SEPARATOR
-			'FAILURE' => 'ABC',
+                . '.env',
-			'SIMPLEBOX' => 'A B  C',
+            __DIR__ . DIRECTORY_SEPARATOR
-			'TITLE' => '1',
+                . '..' . DIRECTORY_SEPARATOR
-			'FOO' => '1.2',
+                . '.env',
-			'SOME.TEST' => 'Test Var',
+        ];
-			'SOME.LIVE' => 'Live Var',
+        // if not found, skip -> all will fail
-			'A_TEST1' => 'foo',
+        if (is_file($file_content)) {
-			'A_TEST2' => '${TEST1:-bar}',
+            foreach ($env_files as $env_file) {
-			'A_TEST3' => '${TEST4:-bar}',
+                copy($file_content, $env_file);
-			'A_TEST5' => 'null',
+            }
-			'A_TEST6' => '${TEST5-bar}',
+        }
-			'A_TEST7' => '${TEST6:-bar}',
+    }
-			'B_TEST1' => 'foo',
-			'B_TEST2' => '${TEST1:=bar}',
-			'B_TEST3' => '${TEST4:=bar}',
-			'B_TEST5' => 'null',
-			'B_TEST6' => '${TEST5=bar}',
-			'B_TEST7' => '${TEST6=bar}',
-			'Test' => 'A',
-			'TEST' => 'B',
-			'LINE' => "ABC\nDEF",
-			'OTHERLINE' => "ABC\nAF\"ASFASDF\nMORESHIT",
-			'SUPERLINE' => '',
-			'__FOO_BAR_1' => 'b',
-			'__FOOFOO' => 'f     ',
-			123123 => 'number',
-			'EMPTY' => '',
-		];
-		// 0: folder relative to test folder, if unset __DIR__
-		// 1: file, if unset .env
-		// 2: status to be returned
-		// 3: _ENV file content to be set
-		// 4: override chmod as octect in string
-		return [
-			'default' => [
-				'folder' => null,
-				'file' => null,
-				'status' => 3,
-				'content' => [],
-				'chmod' => null,
-			],
-			'cannot open file' => [
-				'folder' => __DIR__ . DIRECTORY_SEPARATOR . 'dotenv',
-				'file' => 'cannot_read.env',
-				'status' => 2,
-				'content' => [],
-				'chmod' => '000',
-			],
-			'empty file' => [
-				'folder' => __DIR__ . DIRECTORY_SEPARATOR . 'dotenv',
-				'file' => 'empty.env',
-				'status' => 1,
-				'content' => [],
-				'chmod' => null,
-			],
-			'override all' => [
-				'folder' => __DIR__ . DIRECTORY_SEPARATOR . 'dotenv',
-				'file' => 'test.env',
-				'status' => 0,
-				'content' => $dot_env_content,
-				'chmod' => null,
-			],
-			'override directory' => [
-				'folder' => __DIR__ . DIRECTORY_SEPARATOR . 'dotenv',
-				'file' => null,
-				'status' => 0,
-				'content' => $dot_env_content,
-				'chmod' => null,
-			],
-		];
-	}
 
-	/**
+    /**
-	 * test read .env file
+     * Undocumented function
-	 *
+     *
-	 * @covers ::readEnvFile
+     * @return array
-	 * @dataProvider envFileProvider
+     */
-	 * @testdox Read _ENV file from $folder / $file with expected status: $expected_status [$_dataName]
+    public function envFileProvider(): array
-	 *
+    {
-	 * @param  string|null $folder
+        $dot_env_content = [
-	 * @param  string|null $file
+            'SOMETHING' => 'A',
-	 * @param  int         $expected_status
+            'OTHER' => 'B IS B',
-	 * @param  array       $expected_env
+            'Complex' => 'A B \"D is F',
-	 * @param  string|null $chmod
+            'HAS_SPACE' => 'ABC',
-	 * @return void
+            'HAS_COMMENT_QUOTES_SPACE' => 'Comment at end with quotes and space',
-	 */
+            'HAS_COMMENT_QUOTES_NO_SPACE' => 'Comment at end with quotes no space',
-	public function testReadEnvFile(
+            'HAS_COMMENT_NO_QUOTES_SPACE' => 'Comment at end no quotes and space',
-		?string $folder,
+            'HAS_COMMENT_NO_QUOTES_NO_SPACE' => 'Comment at end no quotes no space',
-		?string $file,
+            'COMMENT_IN_TEXT_QUOTES' => 'Foo bar # comment in here',
-		int $expected_status,
+            'HAS_EQUAL_NO_QUITES' => 'Is This = Valid',
-		array $expected_env,
+            'HAS_EQUAL_QUITES' => 'Is This = Valid',
-		?string $chmod
+            'FAILURE' => 'ABC',
-	): void {
+            'SIMPLEBOX' => 'A B  C',
-		// if we have file + chmod set
+            'TITLE' => '1',
-		$old_chmod = null;
+            'FOO' => '1.2',
-		if (
+            'SOME.TEST' => 'Test Var',
-			is_file($folder . DIRECTORY_SEPARATOR . $file) &&
+            'SOME.LIVE' => 'Live Var',
-			!empty($chmod)
+            'A_TEST1' => 'foo',
-		) {
+            'A_TEST2' => '${TEST1:-bar}',
-			// get the old permissions
+            'A_TEST3' => '${TEST4:-bar}',
-			$old_chmod = fileperms($folder . DIRECTORY_SEPARATOR . $file);
+            'A_TEST5' => 'null',
-			chmod($folder . DIRECTORY_SEPARATOR . $file, octdec($chmod));
+            'A_TEST6' => '${TEST5-bar}',
-		}
+            'A_TEST7' => '${TEST6:-bar}',
-		if ($folder !== null && $file !== null) {
+            'B_TEST1' => 'foo',
-			$status = \gullevek\dotEnv\DotEnv::readEnvFile($folder, $file);
+            'B_TEST2' => '${TEST1:=bar}',
-		} elseif ($folder !== null) {
+            'B_TEST3' => '${TEST4:=bar}',
-			$status = \gullevek\dotEnv\DotEnv::readEnvFile($folder);
+            'B_TEST5' => 'null',
-		} else {
+            'B_TEST6' => '${TEST5=bar}',
-			$status = \gullevek\dotEnv\DotEnv::readEnvFile();
+            'B_TEST7' => '${TEST6=bar}',
-		}
+            'Test' => 'A',
-		$this->assertEquals(
+            'TEST' => 'B',
-			$status,
+            'LINE' => "ABC\nDEF",
-			$expected_status,
+            'OTHERLINE' => "ABC\nAF\"ASFASDF\nMORESHIT",
-			'Assert returned status equal'
+            'SUPERLINE' => '',
-		);
+            '__FOO_BAR_1' => 'b',
-		// now assert read data
+            '__FOOFOO' => 'f     ',
-		$this->assertEquals(
+            123123 => 'number',
-			$_ENV,
+            'EMPTY' => '',
-			$expected_env,
+            'Var_Test.TEST' => 'Block 1 D',
-			'Assert _ENV correct'
+            'OtherSet.TEST' => 'Block 2 D',
-		);
+        ];
-		// if we have file and chmod unset
+        // 0: folder relative to test folder, if unset __DIR__
-		if ($old_chmod !== null) {
+        // 1: file, if unset .env
-			chmod($folder . DIRECTORY_SEPARATOR . $file, $old_chmod);
+        // 2: status to be returned
-		}
+        // 3: _ENV file content to be set
-	}
+        // 4: override chmod as octect in string
+        return [
+            'default' => [
+                'folder' => null,
+                'file' => null,
+                'status' => 3,
+                'content' => [],
+                'chmod' => null,
+            ],
+            'cannot open file' => [
+                'folder' => __DIR__ . DIRECTORY_SEPARATOR . 'dotenv',
+                'file' => 'cannot_read.env',
+                'status' => 2,
+                'content' => [],
+                // 0000
+                'chmod' => '100000',
+            ],
+            'empty file' => [
+                'folder' => __DIR__ . DIRECTORY_SEPARATOR . 'dotenv',
+                'file' => 'empty.env',
+                'status' => 1,
+                'content' => [],
+                // 0664
+                'chmod' => '100664',
+            ],
+            'override all' => [
+                'folder' => __DIR__ . DIRECTORY_SEPARATOR . 'dotenv',
+                'file' => 'test.env',
+                'status' => 0,
+                'content' => $dot_env_content,
+                // 0664
+                'chmod' => '100664',
+            ],
+            'override directory' => [
+                'folder' => __DIR__ . DIRECTORY_SEPARATOR . 'dotenv',
+                'file' => null,
+                'status' => 0,
+                'content' => $dot_env_content,
+                'chmod' => null,
+            ],
+        ];
+    }
+
+    /**
+     * test read .env file
+     *
+     * @covers ::readEnvFile
+     * @dataProvider envFileProvider
+     * @testdox Read _ENV file from $folder / $file with expected status: $expected_status [$_dataName]
+     *
+     * @param  string|null $folder
+     * @param  string|null $file
+     * @param  int         $expected_status
+     * @param  array       $expected_env
+     * @param  string|null $chmod
+     * @return void
+     */
+    public function testReadEnvFile(
+        ?string $folder,
+        ?string $file,
+        int $expected_status,
+        array $expected_env,
+        ?string $chmod
+    ): void {
+        // skip if chmod is set to 10000 (000 no rights) if we are root
+        // as root there is no stop reading a file
+        if (
+            !empty($chmod) &&
+            $chmod == '100000' &&
+            getmyuid() == 0
+        ) {
+            $this->markTestSkipped(
+                "Skip cannot read file test because run user is root"
+            );
+            return;
+        }
+        // reset $_ENV for clean compare
+        $_ENV = [];
+        // previous file perm
+        $old_chmod = null;
+        // if we have change permission for file
+        if (
+            is_file($folder . DIRECTORY_SEPARATOR . $file) &&
+            !empty($chmod)
+        ) {
+            // get the old permissions
+            $old_chmod = fileperms($folder . DIRECTORY_SEPARATOR . $file);
+            chmod($folder . DIRECTORY_SEPARATOR . $file, octdec($chmod));
+        }
+        if ($folder !== null && $file !== null) {
+            $status = \gullevek\dotEnv\DotEnv::readEnvFile($folder, $file);
+        } elseif ($folder !== null) {
+            $status = \gullevek\dotEnv\DotEnv::readEnvFile($folder);
+        } else {
+            $status = \gullevek\dotEnv\DotEnv::readEnvFile();
+        }
+        $this->assertEquals(
+            $status,
+            $expected_status,
+            'Assert returned status equal'
+        );
+        // now assert read data
+        $this->assertEquals(
+            $_ENV,
+            $expected_env,
+            'Assert _ENV correct'
+        );
+        // if we have file and chmod unset
+        if ($old_chmod !== null) {
+            chmod($folder . DIRECTORY_SEPARATOR . $file, $old_chmod);
+        }
+    }
 }
 
 // __END__

test/phpUnitTests/dotenv/.env

@@ -1 +0,0 @@
-test.env

test/phpUnitTests/dotenv/test.env

@@ -10,6 +10,8 @@ HAS_COMMENT_QUOTES_NO_SPACE="Comment at end with quotes no space"# Comment QES
 HAS_COMMENT_NO_QUOTES_SPACE=Comment at end no quotes and space # Comment NQE
 HAS_COMMENT_NO_QUOTES_NO_SPACE=Comment at end no quotes no space# Comment NQES
 COMMENT_IN_TEXT_QUOTES="Foo bar # comment in here"
+HAS_EQUAL_NO_QUITES=Is This = Valid
+HAS_EQUAL_QUITES="Is This = Valid"
 FAILURE = ABC
 SIMPLEBOX= A B  C
 TITLE=1
@@ -47,3 +49,10 @@ SUPERLINE=
 EMPTY=
 = flase
 asfasdf
+# BLOCK TESTS
+[Var Test]
+TEST="Block 1 D"
+[OtherSet]
+TEST="Block 2 D"
+[Ignore-Invalid-Block]
+TEST="Block 3 D"

test/read_env_file.php

@@ -6,12 +6,33 @@ $loader = require '../vendor/autoload.php';
 $loader->addPsr4('gullevek\\', __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'src');
 use gullevek\dotEnv\DotEnv;
 
-print "BASE: " . __DIR__ . "<br>";
+// copy test file to .env file in env folder
-print "ORIG: <pre>" . file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '.env') . "</pre>";
+$file_content = __DIR__ . DIRECTORY_SEPARATOR
+    . 'phpUnitTests' . DIRECTORY_SEPARATOR
+    . 'dotenv' . DIRECTORY_SEPARATOR
+    . 'test.env';
+// env folder
+$env_file = __DIR__ . DIRECTORY_SEPARATOR
+    . 'env' . DIRECTORY_SEPARATOR
+    . '.env';
+if (!is_file($file_content)) {
+    die("Cannot read $file_content");
+}
+if (copy($file_content, $env_file) === false) {
+    die("Cannot copy $file_content to $env_file");
+}
 
-$status = DotEnv::readEnvFile(__DIR__);
+print "BASE: " . __DIR__ . "<br>";
+print "ENV: " . $env_file . "<br>";
+print "ORIG: <pre>" . file_get_contents($env_file) . "</pre>";
+
+$status = DotEnv::readEnvFile(__DIR__ . DIRECTORY_SEPARATOR . 'env');
 
 print "STATUS: " . (string)$status . "<br>";
 print "ENV: <pre>" . print_r($_ENV, true) . "</pre><br>";
 
+$status = gullevek\dotenv\DotEnv::readEnvFile(__DIR__ . DIRECTORY_SEPARATOR . 'env');
+print "STATUS B: " . (string)$status . "<br>";
+print "ENV B: <pre>" . print_r($_ENV, true) . "</pre><br>";
+
 // __END__

tmp/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore