Merge pull request #17 from tekreme73/master

Update for Laravel 5.4 and greater and Lumen support

Author: daftspunk

README.md

@@ -1,4 +1,4 @@
-## Laravel Config Writer
+# Laravel Config Writer
 
 Write to Laravel Config files and maintain file integrity.
 
@@ -8,26 +8,50 @@ You can rewrite array values inside a basic configuration file that returns a si
 
 The following value types are supported for writing: strings, integers, booleans and single-dimension arrays.
 
-### Usage Instructions
+Fork of `octobercms\laravel-config-writer`.
+
+## Support
+
+This provider is designed to be used in Laravel from `5.4` version.
+
+## Setup
+
+Install through composer:
+```
+composer require "tekreme73/laravel-config-writer"
+```
 
 Add this to `app/config/app.php` under the 'providers' key:
 
 ```php
-'October\Rain\Config\ConfigServiceProvider',
+Tekreme73\Laravel\ConfigWriter\ServiceProvider::class,
+```
+
+### Lumen case
+
+Add this to `bootstrap/app.php` in the 'service providers' section declaration:
+
+```php
+$app->register(Tekreme73\Laravel\ConfigWriter\ServiceProvider::class);
 ```
 
-You can now write to config files:
+## Usage
+
+You can write to config files like this:
 
 ```php
-Config::write('app.url', 'http://octobercms.com');
+Config::write('app.url', 'http://domain.com');
+
+app('config')->write('app.url', 'http://domain.com');
 ```
 
-### Usage outside Laravel
+
+### Outside Laravel
 
 The `Rewrite` class can be used anywhere.
 
 ```php
-$writeConfig = new October\Rain\Config\Rewrite;
+$writeConfig = new Tekreme73\Laravel\ConfigWriter\DataWriter\Rewrite;
 $writeConfig->toFile('path/to/config.php', [
     'item' => 'new value',
     'nested.config.item' => 'value',

composer.json

@@ -1,27 +1,26 @@
 {
-    "name": "october/config",
-    "description": "Configuration extension",
-    "homepage": "http://octobercms.com",
-    "keywords": ["october cms", "october", "laravel", "config", "write"],
+    "name": "tekreme73/laravel-config-writer",
+    "description": "Laravel provider to be able to rewrite configuration",
+    "keywords": ["laravel", "config", "write", "provider"],
     "license": "MIT",
     "authors": [
         {
-            "name": "Alexey Bobkov",
-            "email": "[email protected]"
-        },
-        {
-            "name": "Samuel Georges",
-            "email": "[email protected]"
+            "name": "Rémi Rebillard",
+            "email": "[email protected]"
         }
     ],
     "require": {
-        "php": ">=5.4.0",
+        "php": ">=7.1.0",
         "illuminate/config": "~5.0."
     },
+    "require-dev": {
+        "phpunit/phpunit": "^7.0"
+    },
     "autoload": {
         "psr-4": {
-            "October\\Rain\\Config\\": "src/"
+            "Tekreme73\\Laravel\\ConfigWriter\\": "src/"
         }
     },
-    "minimum-stability": "dev"
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

src/ConfigServiceProvider.php

@@ -1,6 +1,9 @@
-<?php namespace October\Rain\Config;
+<?php
+
+namespace Tekreme73\Laravel\ConfigWriter\DataWriter;
 
 use Illuminate\Filesystem\Filesystem;
+use Tekreme73\Laravel\ConfigWriter\DataWriter\Rewrite;
 
 class FileWriter
 {
@@ -21,48 +24,56 @@ class FileWriter
     /**
      * The config rewriter object.
      *
-     * @var \October\Rain\Config\Rewrite
+     * @var \Tekreme73\Laravel\ConfigWriter\DataWriter\Rewrite
      */
     protected $rewriter;
 
     /**
      * Create a new file configuration loader.
      *
-     * @param  \Illuminate\Filesystem\Filesystem  $files
-     * @param  string  $defaultPath
+     * @param  \Illuminate\Filesystem\Filesystem $files
+     * @param  string $defaultPath
      * @return void
      */
-    public function __construct(Filesystem $files, $defaultPath)
+    public function __construct(Filesystem $files, string $defaultPath)
     {
         $this->files = $files;
         $this->defaultPath = $defaultPath;
         $this->rewriter = new Rewrite;
     }
 
-    public function write($item, $value, $filename)
+    /**
+     * Write an item value in a file.
+     *
+     * @param  string $item
+     * @param  mixed $value
+     * @param  string $filename
+     * @return bool
+     */
+    public function write(string $item, $value, string $filename, string $fileExtension = '.php'): bool
     {
-        $path = $this->getPath($item, $filename);
-        if (!$path)
-            return false;
+        $path = $this->getPath($item, $filename, $fileExtension);
+
+        if (!$path) return false;
 
         $contents = $this->files->get($path);
         $contents = $this->rewriter->toContent($contents, [$item => $value]);
 
         return !($this->files->put($path, $contents) === false);
     }
 
-    private function getPath($item, $filename)
+    private function getPath(string $item, string $filename, string $ext = '.php'): string
     {
-        $file = "{$this->defaultPath}/{$filename}.php";
-        if ( $this->files->exists($file) &&
-            $this->hasKey($file, $item)
-        )
+        $file = "{$this->defaultPath}/{$filename}{$ext}";
+
+        if ($this->files->exists($file) && $this->hasKey($file, $item)) {
             return $file;
+        }
 
         return null;
     }
 
-    private function hasKey($path, $key)
+    private function hasKey(string $path, string $key): bool
     {
         $contents = file_get_contents($path);
         $vars = eval('?>'.$contents);
@@ -72,7 +83,7 @@ private function hasKey($path, $key)
         $isset = false;
         while ($key = array_shift($keys)) {
             $isset = isset($vars[$key]);
-            if (is_array($vars[$key])) $vars = $vars[$key]; // Go down the rabbit hole
+            if (is_array($vars[$key])) $vars = $vars[$key];
         }
 
         return $isset;

src/FileWriter.php renamed to src/DataWriter/FileWriter.php

@@ -1,4 +1,6 @@
-<?php namespace October\Rain\Config;
+<?php
+
+namespace Tekreme73\Laravel\ConfigWriter\DataWriter;
 
 use Exception;
 
@@ -26,15 +28,16 @@
 class Rewrite
 {
 
-    public function toFile($filePath, $newValues, $useValidation = true)
+    public function toFile(string $filePath, array $newValues, bool $useValidation = true): string
     {
         $contents = file_get_contents($filePath);
         $contents = $this->toContent($contents, $newValues, $useValidation);
         file_put_contents($filePath, $contents);
+
         return $contents;
     }
 
-    public function toContent($contents, $newValues, $useValidation = true)
+    public function toContent(string $contents, array $newValues, bool $useValidation = true): string
     {
         $contents = $this->parseContent($contents, $newValues);
 
@@ -65,7 +68,7 @@ public function toContent($contents, $newValues, $useValidation = true)
         return $contents;
     }
 
-    protected function parseContent($contents, $newValues)
+    protected function parseContent(string $contents, array $newValues): string
     {
         $result = $contents;
 
@@ -76,22 +79,22 @@ protected function parseContent($contents, $newValues)
         return $result;
     }
 
-    protected function parseContentValue($contents, $path, $value)
+    protected function parseContentValue(string $contents, string $path, $value): string
     {
         $result = $contents;
         $items = explode('.', $path);
         $key = array_pop($items);
         $replaceValue = $this->writeValueToPhp($value);
 
         $count = 0;
-        $patterns = array();
+        $patterns = [];
         $patterns[] = $this->buildStringExpression($key, $items);
         $patterns[] = $this->buildStringExpression($key, $items, '"');
         $patterns[] = $this->buildConstantExpression($key, $items);
         $patterns[] = $this->buildArrayExpression($key, $items);
 
         foreach ($patterns as $pattern) {
-            $result = preg_replace($pattern, '${1}${2}'.$replaceValue, $result, 1, $count);
+            $result = preg_replace($pattern, '${1}${2}' . $replaceValue, $result, 1, $count);
 
             if ($count > 0) {
                 break;
@@ -101,7 +104,7 @@ protected function parseContentValue($contents, $path, $value)
         return $result;
     }
 
-    protected function writeValueToPhp($value)
+    protected function writeValueToPhp($value): string
     {
         if (is_string($value) && strpos($value, "'") === false) {
             $replaceValue = "'".$value."'";
@@ -127,7 +130,7 @@ protected function writeValueToPhp($value)
         return $replaceValue;
     }
 
-    protected function writeArrayToPhp($array)
+    protected function writeArrayToPhp(array $array): array
     {
         $result = [];
 
@@ -142,9 +145,9 @@ protected function writeArrayToPhp($array)
         return $result;
     }
 
-    protected function buildStringExpression($targetKey, $arrayItems = array(), $quoteChar = "'")
+    protected function buildStringExpression(string $targetKey, array $arrayItems = [], string $quoteChar = "'"): string
     {
-        $expression = array();
+        $expression = [];
 
         // Opening expression for array items ($1)
         $expression[] = $this->buildArrayOpeningExpression($arrayItems);
@@ -164,9 +167,9 @@ protected function buildStringExpression($targetKey, $arrayItems = array(), $quo
     /**
      * Common constants only (true, false, null, integers)
      */
-    protected function buildConstantExpression($targetKey, $arrayItems = array())
+    protected function buildConstantExpression(string $targetKey, array $arrayItems = []): string
     {
-        $expression = array();
+        $expression = [];
 
         // Opening expression for array items ($1)
         $expression[] = $this->buildArrayOpeningExpression($arrayItems);
@@ -183,9 +186,9 @@ protected function buildConstantExpression($targetKey, $arrayItems = array())
     /**
      * Single level arrays only
      */
-    protected function buildArrayExpression($targetKey, $arrayItems = array())
+    protected function buildArrayExpression(string $targetKey, array $arrayItems = []): string
     {
-        $expression = array();
+        $expression = [];
 
         // Opening expression for array items ($1)
         $expression[] = $this->buildArrayOpeningExpression($arrayItems);
@@ -199,17 +202,17 @@ protected function buildArrayExpression($targetKey, $arrayItems = array())
         return '/' . implode('', $expression) . '/';
     }
 
-    protected function buildArrayOpeningExpression($arrayItems)
+    protected function buildArrayOpeningExpression(array $arrayItems): string
     {
         if (count($arrayItems)) {
-            $itemOpen = array();
+            $itemOpen = [];
             foreach ($arrayItems as $item) {
                 // The left hand array assignment
                 $itemOpen[] = '[\'|"]'.$item.'[\'|"]\s*=>\s*(?:[aA][rR]{2}[aA][yY]\(|[\[])';
             }
 
             // Capture all opening array (non greedy)
-            $result = '(' . implode('[\s\S]*', $itemOpen) . '[\s\S]*?)';
+            $result = '(' . implode('[\s\S]*?', $itemOpen) . '[\s\S]*?)';
         }
         else {
             // Gotta capture something for $1

src/Rewrite.php renamed to src/DataWriter/Rewrite.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Tekreme73\Laravel\ConfigWriter;
+
+use Laravel\Lumen\Application;
+use Tekreme73\Laravel\ConfigWriter\ServiceProvider;
+
+class LumenServiceProvider extends ServiceProvider
+{
+    /** @var  Application */
+    protected $app;
+
+    protected function getConfigPath(): string
+    {
+        return $this->app->getConfigurationPath();
+    }
+}