Branch refactor

Author: jaumarar

src/DotEnv.php

@@ -2,6 +2,10 @@
 
 namespace DevCoder;
 
+use DevCoder\Processor\AbstractProcessor;
+use DevCoder\Processor\BooleanProcessor;
+use DevCoder\Processor\QuotedProcessor;
+
 class DotEnv
 {
     /**
@@ -14,36 +18,42 @@ class DotEnv
     /**
      * Configure the options on which the parsed will act
      *
-     * @var array
-     */
-    protected $options = [];
-
-    /**
-     * Process strings to obtain characteristics of it
-     *
-     * @var Processor
+     * @var string[]
      */
-    protected $processor;
+    protected $processors = [];
 
-    public function __construct(string $path, array $options = [])
+    public function __construct(string $path, array $processors = null)
     {
         if (!file_exists($path)) {
             throw new \InvalidArgumentException(sprintf('%s does not exist', $path));
         }
 
         $this->path = $path;
 
-        $this->processOptions($options);
-
-        $this->processor = new Processor();
+        $this->setProcessors($processors);
     }
 
-    private function processOptions(array $options) : void
+    private function setProcessors(array $processors = null) : DotEnv
     {
-        $this->options = array_merge([
-            Option::PROCESS_BOOLEANS => true,
-            Option::PROCESS_QUOTES => true
-        ], $options);
+        /**
+         * Fill with default processors
+         */
+        if ($processors === null){
+            $this->processors = [
+                BooleanProcessor::class,
+                QuotedProcessor::class
+            ];
+
+            return $this;
+        }
+
+        foreach ($processors as $processor) {
+            if (is_subclass_of($processor, AbstractProcessor::class)) {
+                $this->processors[] = $processor;
+            }
+        }
+
+        return $this;
     }
 
     /**
@@ -75,43 +85,31 @@ public function load() : void
         }
     }
 
+    /**
+     * Process the value with the configured processors
+     *
+     * @param string $value The value to process
+     * @return string|bool
+     */
     private function processValue(string $value)
     {
         /**
          * First trim spaces and quotes if configured
          */
-        $preprocessedValue = $this->preprocessValue($value);
+        $trimmedValue = trim($value);
 
-        /**
-         * If the value is a boolean resolve it as such
-         */
-        if (!empty($this->options[Option::PROCESS_BOOLEANS])) {
-            $isBoolean = $this->processor->isBoolean($preprocessedValue);
+        foreach ($this->processors as $processor) {
+            /** @var AbstractProcessor $processorInstance */
+            $processorInstance = new $processor($trimmedValue);
 
-            if ($isBoolean) {
-                return $this->processor->resolveAsBoolean($preprocessedValue);
+            if ($processorInstance->canBeProcessed()) {
+                return $processorInstance->execute();
             }
         }
 
         /**
          * Does not match any processor options, return as is
          */
-        return $preprocessedValue;
-    }
-
-    private function preprocessValue(string $value) : string
-    {
-        $trimmedValue = trim($value);
-
-        if (!empty($this->options[Option::PROCESS_QUOTES])) {
-            $wrappedBySingleQuotes = $this->processor->isWrappedByChar($trimmedValue, '\'');
-            $wrappedByDoubleQuotes = $this->processor->isWrappedByChar($trimmedValue, '"');
-
-            if ($wrappedBySingleQuotes || $wrappedByDoubleQuotes) {
-                return $this->processor->removeFirstAndLastChar($trimmedValue);
-            }
-        }
-
         return $trimmedValue;
     }
 }

src/Processor.php

@@ -0,0 +1,16 @@
+<?php
+namespace DevCoder\Processor;
+
+abstract class AbstractProcessor implements IProcessor
+{
+    /**
+     * The value to process
+     * @var string
+     */
+    protected $value;
+
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+}

src/Processor/AbstractProcessor.php

@@ -0,0 +1,17 @@
+<?php
+namespace DevCoder\Processor;
+
+class BooleanProcessor extends AbstractProcessor
+{
+    public function canBeProcessed(): bool
+    {
+        $loweredValue = strtolower($this->value);
+
+        return in_array($loweredValue, ['true', 'false'], true);
+    }
+
+    public function execute()
+    {
+        return strtolower($this->value) === 'true';
+    }
+}

src/Processor/BooleanProcessor.php

@@ -0,0 +1,11 @@
+<?php
+namespace DevCoder\Processor;
+
+interface IProcessor
+{
+    public function __construct(string $value);
+
+    public function canBeProcessed(): bool;
+
+    public function execute();
+}

src/Processor/IProcessor.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace DevCoder\Processor;
+
+class QuotedProcessor extends AbstractProcessor
+{
+    public function canBeProcessed(): bool
+    {
+        $wrappedByDoubleQuotes = $this->isWrappedByChar($this->value, '"');
+
+        if ($wrappedByDoubleQuotes) {
+            return true;
+        }
+
+        return $this->isWrappedByChar($this->value, '\'');
+    }
+
+    public function execute()
+    {
+        /**
+         * Since this function is used for the quote removal
+         * we don't need mb_substr
+         */
+        return substr($this->value, 1, -1);
+    }
+
+    public function isWrappedByChar(string $value, string $char) : bool
+    {
+        return $value[0] === $char && $value[-1] === $char;
+    }
+}

src/Processor/QuotedProcessor.php

@@ -4,6 +4,8 @@
 
 use DevCoder\DotEnv;
 use DevCoder\Option;
+use DevCoder\Processor\BooleanProcessor;
+use DevCoder\Processor\QuotedProcessor;
 use PHPUnit\Framework\TestCase;
 
 class DotenvTest extends TestCase
@@ -24,20 +26,26 @@ public function testLoad() {
         $this->assertEquals('password', getenv('DATABASE_PASSWORD'));
         $this->assertFalse(getenv('GOOGLE_API'));
         $this->assertFalse(getenv('GOOGLE_MANAGER_KEY'));
+        $this->assertEquals(true, getenv('BOOLEAN_LITERAL'));
+        $this->assertEquals('true', getenv('BOOLEAN_QUOTED'));
 
         $this->assertEquals('dev', $_ENV['APP_ENV']);
         $this->assertEquals('mysql:host=localhost;dbname=test;', $_ENV['DATABASE_DNS']);
         $this->assertEquals('root', $_ENV['DATABASE_USER']);
         $this->assertEquals('password', $_ENV['DATABASE_PASSWORD']);
         $this->assertFalse(array_key_exists('GOOGLE_API', $_ENV));
         $this->assertFalse(array_key_exists('GOOGLE_MANAGER_KEY', $_ENV));
+        $this->assertEquals(true, $_ENV['BOOLEAN_LITERAL']);
+        $this->assertEquals('true', $_ENV['BOOLEAN_QUOTED']);
 
         $this->assertEquals('dev', $_SERVER['APP_ENV']);
         $this->assertEquals('mysql:host=localhost;dbname=test;', $_SERVER['DATABASE_DNS']);
         $this->assertEquals('root', $_SERVER['DATABASE_USER']);
         $this->assertEquals('password', $_SERVER['DATABASE_PASSWORD']);
         $this->assertFalse(array_key_exists('GOOGLE_API', $_SERVER));
         $this->assertFalse(array_key_exists('GOOGLE_MANAGER_KEY', $_SERVER));
+        $this->assertEquals(true, $_SERVER['BOOLEAN_LITERAL']);
+        $this->assertEquals('true', $_SERVER['BOOLEAN_QUOTED']);
     }
 
     public function testFileNotExist() {
@@ -51,19 +59,19 @@ public function testFileNotExist() {
     public function testProcessBoolean()
     {
         (new DotEnv($this->env('.env.boolean'), [
-            Option::PROCESS_BOOLEANS => true
+            BooleanProcessor::class
         ]))->load();
 
         $this->assertEquals(false, $_ENV['FALSE1']);
         $this->assertEquals(false, $_ENV['FALSE2']);
         $this->assertEquals(false, $_ENV['FALSE3']);
-        $this->assertEquals(false, $_ENV['FALSE4']);
+        $this->assertEquals("'false'", $_ENV['FALSE4']); // Since we don't have the QuotedProcessor::class this will be the result
         $this->assertEquals('0', $_ENV['FALSE5']);
 
         $this->assertEquals(true, $_ENV['TRUE1']);
         $this->assertEquals(true, $_ENV['TRUE2']);
         $this->assertEquals(true, $_ENV['TRUE3']);
-        $this->assertEquals(true, $_ENV['TRUE4']);
+        $this->assertEquals("'true'", $_ENV['TRUE4']); // Since we don't have the QuotedProcessor::class this will be the result
         $this->assertEquals('1', $_ENV['TRUE5']);
     }
 
@@ -72,9 +80,7 @@ public function testProcessBoolean()
      */
     public function testDontProcessBoolean()
     {
-        (new DotEnv($this->env('.env.boolean'), [
-            Option::PROCESS_BOOLEANS => false
-        ]))->load();
+        (new DotEnv($this->env('.env.boolean'), []))->load();
 
         $this->assertEquals('false', $_ENV['FALSE1']);
 
@@ -87,7 +93,7 @@ public function testDontProcessBoolean()
     public function testProcessQuotes()
     {
         (new DotEnv($this->env('.env.quotes'), [
-            Option::PROCESS_QUOTES => true
+            QuotedProcessor::class
         ]))->load();
 
         $this->assertEquals('q1', $_ENV['QUOTED1']);
@@ -104,9 +110,7 @@ public function testProcessQuotes()
      */
     public function testDontProcessQuotes()
     {
-        (new DotEnv($this->env('.env.quotes'), [
-            Option::PROCESS_QUOTES => false
-        ]))->load();
+        (new DotEnv($this->env('.env.quotes'), []))->load();
 
         $this->assertEquals('"q1"', $_ENV['QUOTED1']);
         $this->assertEquals('\'q2\'', $_ENV['QUOTED2']);

tests/DotenvTest.php

@@ -4,4 +4,6 @@ DATABASE_DNS=mysql:host=localhost;dbname=test;
 DATABASE_USER=root
  DATABASE_PASSWORD = password
 #GOOGLE_API=DJfa7czhKaJ0Pig6j9XpSjT6NpXZUZwK
-   # GOOGLE_MANAGER_KEY=P7RkBUQHIkPUEPy3yCTT4gGYa2DjRth8
+   # GOOGLE_MANAGER_KEY=P7RkBUQHIkPUEPy3yCTT4gGYa2DjRth8
+BOOLEAN_LITERAL=true
+BOOLEAN_QUOTED="true"