Added env parser tester, fixtures and load function test

Author: marinsagovac

Tests/EnvparserTest.php

@@ -10,5 +10,68 @@
  */
 class EnvparserTest extends \PHPUnit_Framework_TestCase
 {
-    
+    public $tmpPathEnv;
+    public $instance;
+
+    const DS = DIRECTORY_SEPARATOR;
+
+    protected function setUp()
+    {
+        $this->tmpPathEnv = sys_get_temp_dir().self::DS.'EvnmanagerTestEnv.env';
+
+        if (!touch($this->tmpPathEnv)) {
+            throw new \RuntimeException(sprintf('A test failed. Could not write a file to "%s" path', $this->tmpPathEnv));
+        }
+
+        $tmpData = <<<EOF
+FOO=bar
+EOF;
+
+        file_put_contents($this->tmpPathEnv, $tmpData);
+    }
+
+    public function testInstance()
+    {
+        $this->instance = new Envparser;
+        $instanceClass = $this->instance instanceof Envparser;
+
+        $this->assertEquals($instanceClass, true);
+    }
+
+    private function getFileTest($envFile)
+    {
+        return __DIR__.self::DS.'fixtures'.self::DS.$envFile;
+    }
+
+    public function testRead()
+    {
+        $envfile = $this->getFileTest('.env');
+
+        $this->assertTrue(is_readable($envfile));
+    }
+
+    public function testEnvLoadsFile()
+    {
+        $envfile = $this->getFileTest('.env');
+
+        $envparser = new Envparser($envfile);
+        $envparserLoader = $envparser->load();
+
+        $this->assertTrue($envparserLoader);
+    }
+
+    public function testEnvVar()
+    {
+        $envfile = $this->getFileTest('.env');
+
+        $envparser = new Envparser($envfile);
+        $envparserLoader = $envparser->load();
+
+        $envparser->run();
+
+        $envVar = $envparser->getValue('FOO');
+
+        $this->assertSame($envVar, 'bar');
+        $this->assertSame($envVar, getenv('FOO'));
+    }
 }

Tests/bootstrap.php

@@ -9,6 +9,6 @@
 error_reporting(E_ALL | E_STRICT);
 
 /**
- * Autloader
+ * Autoloader
  */
-require __DIR__.'../../vendor/autoload.php';
+require __DIR__.'../../../../../vendor/autoload.php';

Tests/fixtures/.env

@@ -0,0 +1 @@
+FOO=bar

docs/README.md

@@ -2,7 +2,7 @@
 
 The `Environment manager` parse, populates dot environment files to super global $_ENV files, HTTP request headers.
 
-It provides to edit environment file.
+It provides for editing environment file and manipulate them.
 
 ## Installation
 
@@ -12,12 +12,60 @@ It provides to edit environment file.
 
 ## Prerequisities
 
-PHP version requirements: _PHP >5.3_
+PHP version requirements: _PHP >7.0_
 
 Use `use Codervio\Environment\EnvParser` declaration for parsing dot env files.
 
 Use `use Codervio\Environment\EnvEditor` declaration for edit and manage dot env file.
 
+## Usage
+
+Example of fetching env variables and loading into global super variables like `$_ENV`, using function `getenv()` or directly using instance: 
+
+If on a file example.env contains a data: 
+
+```text
+FOO=bar
+```
+
+After loading instance it can be fetching a variable:
+
+```php
+use Codervio\Envmanager\Envparser;
+
+$envparser = new Envparser;
+$envparser->load();
+$envparser->run();
+
+$result = $parser->getValue('FOO');
+var_dump($result);
+```
+
+Returns a result will automatically detect type of getting env variables:
+
+```php
+(string) 'bar'
+```
+
+Or get a result using env variables globally:
+```php
+    echo apache_getenv('FOO')
+    echo getenv('FOO')
+    echo $_ENV('FOO')
+```
+
+## Returning a result
+
+A result returns in following orders:
+- using apache_getenv() if apache service is configured internally to use only Apache environment
+- using getenv() that most Unix systems supports
+- using PHP native super globals $_ENV function
+
+It will automatically parse to PHP env functions and super globals so you can access via:
+- superglobals functions $_ENV
+- superglobals $_SERVER variable
+- using getenv() if is enabled by system
+- using apache_getenv() if is enabled by Apache service
 
 ## Changelog
 
@@ -27,11 +75,13 @@ Status of core:
 | ------------- |:-------------------- |
 | `1.0`         | Release version      |
 
-PHP version above `5.3`.
+PHP version above `7.0`.
 Quality assurance: Unit tests provided
 
 ## Table of Contents
 
 ### EnvParser
 
+* [`load()`](load.md) - Load an environment .env  file or folder with .env files
+
 ### EnvEditor

docs/load.md

@@ -0,0 +1,75 @@
+# load
+
+Load an environment .env  file or folder with .env files
+
+## Description
+
+```php
+load($processEnvironment = true, $override = false)
+```
+
+Load and env file or files inside folders.
+ProcessEnvironment parses a variable and populate into ENV system variables.
+If a variable exists on system from .env file it can override value.
+
+By default it will load and automatically detect encoding type.
+
+## Parameters
+
+__processEnvironment__
+: Parse into system env variable from a file
+: Default: `true`
+
+__override__
+: Replace a value into environment system variable
+: Default: `false`
+
+## Return values
+
+__bool__
+: Returns `TRUE` if loaded a file or `FALSE` if is not loaded a file
+
+__Exception__
+1. Exception on `mb_string` encoding if not defined default mb_string values
+
+## Examples
+
+Example #1 Load a file
+```php
+use Codervio\Envmanager\Envparser;
+
+$envparser = new Envparser('.env');
+$envparser->load();
+```
+
+Example #2 Load a file from directory
+```php
+use Codervio\Envmanager\Envparser;
+
+$envparser = new Envparser(__DIR__);
+$envparser->load();
+```
+
+Example #3 Load a file and parse into ENV variable, don't override a variable into ENV system variable
+```php
+use Codervio\Envmanager\Envparser;
+
+$envparser = new Envparser(__DIR__);
+$envparser->load(true, false);
+```
+
+Example #4 Don't parse into global ENV variable, don't override a variable into ENV system variable 
+```php
+use Codervio\Envmanager\Envparser;
+
+$envparser = new Envparser(__DIR__);
+$envparser->load(false);
+```
+
+## Notes
+
+> This will not run ENV parser. It will only load a files. To run use `run()` function after `load()` a function that loaded a file or files.
+
+## See also
+
+_No documents._

src/Envparser.php

@@ -72,7 +72,10 @@ public function load($processEnvironment = true, $override = false)
 
         if ($this->loader->getLoadStatus()) {
             $this->context = $this->parseEncoding($this->loader->run());
+            return true;
         }
+
+        return false;
     }
 
     private function getParsed() : ParserCollector