Switch to standard PSR-12 with spaces instead of tab

- in case the unit test is run as root, skip test for cannot read (0000)
- set read (0664) for all must read files
- write .env file int all folders for test so that __DIR__ base will
  always find one

.gitattributes

@@ -0,0 +1,6 @@
+test/ export-ignore
+phpstan.neon	export-ignore
+phpunit.xml	export-ignore
+psalm.xml	export-ignore
+.phan/	export-ignore
+.*	export-ignore

.gitignore

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

.phan/config.php

@@ -77,6 +77,8 @@ return [
 	// A list of directories holding code that we want
 	// to parse, but not analyze
 	"exclude_analysis_directory_list" => [
+		'vendor',
+		'test'
 	],
 	'exclude_file_list' => [
 	],

Readme.md

@@ -1,12 +1,28 @@
 # dotenv: readEnvFile()
 
-A single function implementation of <https://github.com/vlucas/phpdotenv>
+A simple implementation of <https://github.com/vlucas/phpdotenv>
 
 This is not a functional replacement, but a very simple implementation of the basic functions.
 
 It is recommended to create a `.env.example` example file that is checked into the
 repository. The `.env` should *NEVER* be checked into anything
 
+## How to install
+
+`composer require gullevek/dotEnv`
+
+## Run it
+
+Create a `.env` file in the current folder.
+Create a file like below
+
+```php
+require '../vendor/autoload.php';
+gullevek\dotEnv\DotEnv::readEnvFile(__DIR__);
+```
+
+All data will be in the `$_ENV` array
+
 ## How it works
 
 Put the function where it is needed or put it in a file and load it.
@@ -44,3 +60,19 @@ ESCAPE="String \" inside \" other "
 DOUBLE="I will be used"
 DOUBLE="This will be ignored"
 ```
+
+## 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

@@ -0,0 +1,32 @@
+{
+    "name": "gullevek/dotenv",
+    "description": "Simple .env file processing and storing in _ENV array",
+    "keywords": [".env", "dotenv", "_ENV", "environment variables"],
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "gullevek\\dotEnv\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Clemens Schwaighofer",
+            "email": "gullevek@gullevek.org",
+            "homepage": "http://gullevek.org"
+        }
+    ],
+    "homepage": "https://github.com/gullevek/dotEnv",
+    "minimum-stability": "dev",
+    "require": {
+		"php": ">=7.4.0"
+	},
+    "archive": {
+        "exclude": ["/test/", "/test/*", "/phpstan.neon", "/psalm.xml", "/.phan/", "/.vscode/", "/phpunit.xml"]
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9",
+        "phpstan/phpstan": "1.10.x-dev",
+        "phan/phan": "v5.x-dev"
+    }
+}

phpstan.neon

@@ -5,3 +5,6 @@ parameters:
 	level: max
 	paths:
 		- %currentWorkingDirectory%
+	excludePaths:
+		- vendor
+		- test

phpunit.xml

@@ -0,0 +1,5 @@
+<phpunit
+    colors="true"
+    verbose="true"
+>
+</phpunit>

psalm.xml

@@ -1,14 +1,16 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="1"
+    errorLevel="8"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 >
     <projectFiles>
-        <directory name="src" />
+        <directory name="." />
         <ignoreFiles>
+            <directory name="vendor" />
+            <directory name="test" />
         </ignoreFiles>
     </projectFiles>
 </psalm>

src/DotEnv.php

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

src/read_env_file.php

@@ -1,82 +0,0 @@
-<?php
-
-/**
- * parses .env file
- *
- * Rules for .env file
- * variable is any alphanumeric string followed by = on the same line
- * content starts with the first non space part
- * strings can be contained in "
- * strings MUST be contained in " if they are multiline
- * if string starts with " it will match until another " is found
- * anything AFTER " is ignored
- * if there are two variables with the same name only the first is used
- * variables are case sensitive
- *
- * @param  string $path     Folder to file, default is __DIR__
- * @param  string $env_file What file to load, default is .env
- * @return int              0 for success full load
- *                          1 for file loadable, but no data inside
- *                          2 for file not readable
- *                          3 for file not found
- */
-function readEnvFile(string $path = __DIR__, string $env_file = '.env'): int
-{
-	$env_file_target = $path . DIRECTORY_SEPARATOR . $env_file;
-	// this is not a file -> abort
-	if (!is_file($env_file_target)) {
-		$status = 3;
-		return $status;
-	}
-	// cannot open file -> abort
-	if (($fp = fopen($env_file_target, 'r')) === false) {
-		$status = 2;
-		return $status;
-	}
-	// set to readable but not yet any data loaded
-	$status = 1;
-	$block = false;
-	$var = '';
-	while ($line = fgets($fp)) {
-		// main match for variable = value part
-		if (preg_match("/^\s*([\w_.]+)\s*=\s*((\"?).*)/", $line, $matches)) {
-			$var = $matches[1];
-			$value = $matches[2];
-			$quotes = $matches[3];
-			// wirte only if env is not set yet, and write only the first time
-			if (empty($_ENV[$var])) {
-				if (!empty($quotes)) {
-					// match greedy for first to last so we move any " if there are
-					if (preg_match('/^"(.*[^\\\])"/U', $value, $matches)) {
-						$value = $matches[1];
-					} else {
-						// this is a multi line
-						$block = true;
-						// first " in string remove
-						// 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;
-				// set successful load
-				$status = 0;
-			}
-		} elseif ($block === true) {
-			// read line until there is a unescaped "
-			// this also strips everything after the last "
-			if (preg_match("/(.*[^\\\])\"/", $line, $matches)) {
-				$block = false;
-				// strip ending " and EVERYTHING that follows after that
-				$line = $matches[1];
-			}
-			// strip line of slashes
-			/** @psalm-suppress MixedOperand */
-			$_ENV[$var] .= stripslashes($line);
-		}
-	}
-	fclose($fp);
-	return $status;
-}
-
-// __END__

test/.env

@@ -1,28 +0,0 @@
-# enviroment file
-SOMETHING=A
-OTHER="B IS B"
-Complex="A B \"D is F"
-# COMMENT
-HAS_SPACE= "ABC";
-FAILURE = ABC
-SIMPLEBOX= A B  C
-TITLE=1
-FOO=1.2
-SOME.TEST=Test Var
-SOME.LIVE=Live Var
-Test="A"
-TEST="B"
-TEST="D"
-LINE="ABC
-DEF"
-OTHERLINE="ABC
-AF\"ASFASDF
-MORESHIT"
-SUPERLINE=
-"asfasfasf"
-   __FOO_BAR_1 = b
-	__FOOFOO	=	f     
-123123=number
-EMPTY=
-= flase
-asfasdf

test/phpUnitTests/DotEnvTest.php

@@ -0,0 +1,209 @@
+<?php
+
+declare(strict_types=1);
+
+namespace tests;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Test class for DotEnv
+ * @coversDefaultClass \gullevek\DotEnv
+ * @testdox \gullevek\DotEnv method tests
+ */
+final class DotEnvTest extends TestCase
+{
+    /**
+     * setup the .env files before test run
+     *
+     * @return void
+     */
+    public static function setUpBeforeClass(): void
+    {
+        // create .env files
+        $file_content = __DIR__ . DIRECTORY_SEPARATOR
+            . 'dotenv' . DIRECTORY_SEPARATOR
+            . 'test.env';
+        // copy to all folder levels
+        $env_files = [
+            __DIR__ . DIRECTORY_SEPARATOR
+                . 'dotenv' . DIRECTORY_SEPARATOR
+                . '.env',
+            __DIR__ . DIRECTORY_SEPARATOR
+                . '.env',
+            __DIR__ . DIRECTORY_SEPARATOR
+                . '..' . DIRECTORY_SEPARATOR
+                . '.env',
+        ];
+        // if not found, skip -> all will fail
+        if (is_file($file_content)) {
+            foreach ($env_files as $env_file) {
+                copy($file_content, $env_file);
+            }
+        }
+    }
+
+    /**
+     * Undocumented function
+     *
+     * @return array
+     */
+    public function envFileProvider(): array
+    {
+        $dot_env_content = [
+            'SOMETHING' => 'A',
+            'OTHER' => 'B IS B',
+            'Complex' => 'A B \"D is F',
+            'HAS_SPACE' => 'ABC',
+            'HAS_COMMENT_QUOTES_SPACE' => 'Comment at end with quotes and space',
+            'HAS_COMMENT_QUOTES_NO_SPACE' => 'Comment at end with quotes no space',
+            'HAS_COMMENT_NO_QUOTES_SPACE' => 'Comment at end no quotes and space',
+            'HAS_COMMENT_NO_QUOTES_NO_SPACE' => 'Comment at end no quotes no space',
+            'COMMENT_IN_TEXT_QUOTES' => 'Foo bar # comment in here',
+            'FAILURE' => 'ABC',
+            'SIMPLEBOX' => 'A B  C',
+            'TITLE' => '1',
+            'FOO' => '1.2',
+            'SOME.TEST' => 'Test Var',
+            'SOME.LIVE' => 'Live Var',
+            'A_TEST1' => 'foo',
+            'A_TEST2' => '${TEST1:-bar}',
+            'A_TEST3' => '${TEST4:-bar}',
+            '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' => [],
+                // 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/test.env

@@ -0,0 +1,49 @@
+# enviroment file
+SOMETHING=A
+OTHER="B IS B"
+Complex="A B \"D is F"
+# COMMENT
+HAS_SPACE= "ABC";
+# COMMENT AT END
+HAS_COMMENT_QUOTES_SPACE="Comment at end with quotes and space" # Comment QE
+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"
+FAILURE = ABC
+SIMPLEBOX= A B  C
+TITLE=1
+FOO=1.2
+SOME.TEST=Test Var
+SOME.LIVE=Live Var
+# VAR TESTS -
+A_TEST1 = foo
+A_TEST2 = ${TEST1:-bar} # TEST1 is set so the value of TEST2 = foo
+A_TEST3 = ${TEST4:-bar} # TEST4 is not set so the value of TEST3 = bar
+A_TEST5 = null
+A_TEST6 = ${TEST5-bar} # TEST5 is set but empty so the value of TEST6 = null
+A_TEST7 = ${TEST6:-bar} # TEST5 is set and empty so the value of TEST7 = bar
+# VAR TESTS =
+B_TEST1 = foo
+B_TEST2 = ${TEST1:=bar} # TEST1 is set so the value of TEST2 = foo
+B_TEST3 = ${TEST4:=bar} # TEST4 is not set so the value of TEST3 = bar and TEST4 = bar
+B_TEST5 = null
+B_TEST6 = ${TEST5=bar} # TEST5 is set but emtpy so the value of TEST6 = null
+B_TEST7 = ${TEST6=bar} # TEST5 is set and empty so the value of TEST7 = bar and TEST5 = bar
+# VAR TEST END
+Test="A"
+TEST="B"
+TEST="D"
+LINE="ABC
+DEF"
+OTHERLINE="ABC
+AF\"ASFASDF
+MORESHIT"
+SUPERLINE=
+"asfasfasf"
+   __FOO_BAR_1 = b
+	__FOOFOO	=	f     
+123123=number
+EMPTY=
+= flase
+asfasdf

test/read_env_file.php

@@ -1,13 +1,32 @@
-<?php // phpcs:ignore PSR1.Files.SideEffects
+<?php
 
-// test read .env file
+// composer auto loader
+$loader = require '../vendor/autoload.php';
+// need to add this or it will not load here
+$loader->addPsr4('gullevek\\', __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'src');
+use gullevek\dotEnv\DotEnv;
 
-require '../src/read_env_file.php';
+// copy test file to .env file in env folder
+$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");
+}
 
 print "BASE: " . __DIR__ . "<br>";
-print "ORIG: <pre>" . file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '.env') . "</pre>";
+print "ENV: " . $env_file . "<br>";
+print "ORIG: <pre>" . file_get_contents($env_file) . "</pre>";
 
-$status = readEnvFile(__DIR__);
+$status = DotEnv::readEnvFile(__DIR__ . DIRECTORY_SEPARATOR . 'env');
 
 print "STATUS: " . (string)$status . "<br>";
 print "ENV: <pre>" . print_r($_ENV, true) . "</pre><br>";