[Enhancement] Add ArrayFile & EnvFile Parsing, replace ConfigWriter internal logic

composer.json

@@ -42,6 +42,7 @@
         "laravel/tinker": "^2.7",
         "league/csv": "~9.1",
         "nesbot/carbon": "^2.0",
+        "nikic/php-parser": "^4.10",
         "scssphp/scssphp": "~1.0",
         "symfony/yaml": "^6.0",
         "twig/twig": "~3.0",
@@ -51,7 +52,7 @@
     "require-dev": {
         "phpunit/phpunit": "^9.5.8",
         "mockery/mockery": "^1.4.4",
-        "squizlabs/php_codesniffer": "3.*",
+        "squizlabs/php_codesniffer": "^3.2",
         "php-parallel-lint/php-parallel-lint": "^1.0",
         "meyfa/phpunit-assert-gd": "^2.0.0|^3.0.0",
         "dms/phpunit-arraysubset-asserts": "^0.1.0|^0.2.1"

src/Config/ConfigWriter.php

@@ -2,217 +2,49 @@
 
 use Exception;
 
+use PhpParser\Error;
+use PhpParser\Lexer\Emulative;
+use PhpParser\ParserFactory;
+use Winter\Storm\Exception\SystemException;
+use Winter\Storm\Parse\PHP\ArrayFile;
+
 /**
  * Configuration rewriter
  *
- * https://github.com/daftspunk/laravel-config-writer
+ * @see https://wintercms.com/docs/services/parser#data-file-array
  *
  * This class lets you rewrite array values inside a basic configuration file
  * that returns a single array definition (a Laravel config file) whilst maintaining
  * the integrity of the file, leaving comments and advanced settings intact.
- *
- * The following value types are supported for writing:
- * - strings
- * - integers
- * - booleans
- * - nulls
- * - single-dimension arrays
- *
- * To do:
- * - When an entry does not exist, provide a way to create it
- *
- * Pro Regextip: Use [\s\S] instead of . for multiline support
  */
 class ConfigWriter
 {
-    public function toFile($filePath, $newValues, $useValidation = true)
-    {
-        $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)
-    {
-        $contents = $this->parseContent($contents, $newValues);
-
-        if (!$useValidation) {
-            return $contents;
-        }
-
-        $result = eval('?>'.$contents);
-
-        foreach ($newValues as $key => $expectedValue) {
-            $parts = explode('.', $key);
-
-            $array = $result;
-            foreach ($parts as $part) {
-                if (!is_array($array) || !array_key_exists($part, $array)) {
-                    throw new Exception(sprintf('Unable to rewrite key "%s" in config, does it exist?', $key));
-                }
-
-                $array = $array[$part];
-            }
-            $actualValue = $array;
-
-            if ($actualValue != $expectedValue) {
-                throw new Exception(sprintf('Unable to rewrite key "%s" in config, rewrite failed', $key));
-            }
-        }
-
-        return $contents;
-    }
-
-    protected function parseContent($contents, $newValues)
-    {
-        $result = $contents;
-
-        foreach ($newValues as $path => $value) {
-            $result = $this->parseContentValue($result, $path, $value);
-        }
-
-        return $result;
-    }
-
-    protected function parseContentValue($contents, $path, $value)
-    {
-        $result = $contents;
-        $items = explode('.', $path);
-        $key = array_pop($items);
-        $replaceValue = $this->writeValueToPhp($value);
-
-        $count = 0;
-        $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);
-
-            if ($count > 0) {
-                break;
-            }
-        }
-
-        return $result;
-    }
-
-    protected function writeValueToPhp($value)
-    {
-        if (is_string($value) && strpos($value, "'") === false) {
-            $replaceValue = "'".$value."'";
-        }
-        elseif (is_string($value) && strpos($value, '"') === false) {
-            $replaceValue = '"'.$value.'"';
-        }
-        elseif (is_bool($value)) {
-            $replaceValue = ($value ? 'true' : 'false');
-        }
-        elseif (is_null($value)) {
-            $replaceValue = 'null';
-        }
-        elseif (is_array($value) && count($value) === count($value, COUNT_RECURSIVE)) {
-            $replaceValue = $this->writeArrayToPhp($value);
-        }
-        else {
-            $replaceValue = $value;
-        }
-
-        $replaceValue = str_replace('$', '\$', $replaceValue);
-
-        return $replaceValue;
-    }
-
-    protected function writeArrayToPhp($array)
+    public function toFile(string $filePath, array $newValues): string
     {
-        $result = [];
-
-        foreach ($array as $value) {
-            if (!is_array($value)) {
-                $result[] = $this->writeValueToPhp($value);
-            }
-        }
-
-        return '['.implode(', ', $result).']';
+        $arrayFile = ArrayFile::open($filePath)->set($newValues);
+        $arrayFile->write();
+        return $arrayFile->render();
     }
 
-    protected function buildStringExpression($targetKey, $arrayItems = [], $quoteChar = "'")
+    public function toContent(string $contents, $newValues): string
     {
-        $expression = [];
-
-        // Opening expression for array items ($1)
-        $expression[] = $this->buildArrayOpeningExpression($arrayItems);
-
-        // The target key opening
-        $expression[] = '([\'|"]'.$targetKey.'[\'|"]\s*=>\s*)['.$quoteChar.']';
-
-        // The target value to be replaced ($2)
-        $expression[] = '([^'.$quoteChar.']*)';
-
-        // The target key closure
-        $expression[] = '['.$quoteChar.']';
-
-        return '/' . implode('', $expression) . '/';
-    }
+        $lexer = new Emulative([
+            'usedAttributes' => [
+                'comments',
+                'startTokenPos',
+                'startLine',
+                'endTokenPos',
+                'endLine'
+            ]
+        ]);
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7, $lexer);
 
-    /**
-     * Common constants only (true, false, null, integers)
-     */
-    protected function buildConstantExpression($targetKey, $arrayItems = [])
-    {
-        $expression = [];
-
-        // Opening expression for array items ($1)
-        $expression[] = $this->buildArrayOpeningExpression($arrayItems);
-
-        // The target key opening ($2)
-        $expression[] = '([\'|"]'.$targetKey.'[\'|"]\s*=>\s*)';
-
-        // The target value to be replaced ($3)
-        $expression[] = '([tT][rR][uU][eE]|[fF][aA][lL][sS][eE]|[nN][uU][lL]{2}|[\d]+)';
-
-        return '/' . implode('', $expression) . '/';
-    }
-
-    /**
-     * Single level arrays only
-     */
-    protected function buildArrayExpression($targetKey, $arrayItems = [])
-    {
-        $expression = [];
-
-        // Opening expression for array items ($1)
-        $expression[] = $this->buildArrayOpeningExpression($arrayItems);
-
-        // The target key opening ($2)
-        $expression[] = '([\'|"]'.$targetKey.'[\'|"]\s*=>\s*)';
-
-        // The target value to be replaced ($3)
-        $expression[] = '(?:[aA][rR]{2}[aA][yY]\(|[\[])([^\]|)]*)[\]|)]';
-
-        return '/' . implode('', $expression) . '/';
-    }
-
-    protected function buildArrayOpeningExpression($arrayItems)
-    {
-        if (count($arrayItems)) {
-            $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]*?)';
-        }
-        else {
-            // Gotta capture something for $1
-            $result = '()';
+        try {
+            $ast = $parser->parse($contents);
+        } catch (Error $e) {
+            throw new SystemException($e);
         }
 
-        return $result;
+        return (new ArrayFile($ast, $lexer, null))->set($newValues)->render();
     }
 }

src/Foundation/Console/KeyGenerateCommand.php

@@ -1,82 +1,48 @@
 <?php namespace Winter\Storm\Foundation\Console;
 
-use Illuminate\Filesystem\Filesystem;
 use Illuminate\Foundation\Console\KeyGenerateCommand as KeyGenerateCommandBase;
+use Winter\Storm\Parse\EnvFile;
 
 class KeyGenerateCommand extends KeyGenerateCommandBase
 {
     /**
-     * Create a new key generator command.
+     * Write a new environment file with the given key.
      *
-     * @param  \Illuminate\Filesystem\Filesystem  $files
+     * @param  string  $key
      * @return void
      */
-    public function __construct(Filesystem $files)
+    protected function writeNewEnvironmentFileWith($key)
     {
-        parent::__construct();
-
-        $this->files = $files;
+        $env = EnvFile::open($this->laravel->environmentFilePath());
+        $env->set('APP_KEY', $key);
+        $env->write();
     }
 
     /**
-     * Execute the console command.
+     * Confirm before proceeding with the action.
      *
-     * @return void
-     */
-    public function handle()
-    {
-        $key = $this->generateRandomKey();
-
-        if ($this->option('show')) {
-            return $this->line('<comment>'.$key.'</comment>');
-        }
-
-        // Next, we will replace the application key in the config file so it is
-        // automatically setup for this developer. This key gets generated using a
-        // secure random byte generator and is later base64 encoded for storage.
-        if (!$this->setKeyInConfigFile($key)) {
-            return;
-        }
-
-        $this->laravel['config']['app.key'] = $key;
-
-        $this->info("Application key [$key] set successfully.");
-    }
-
-    /**
-     * Set the application key in the config file.
+     * This method only asks for confirmation in production.
      *
-     * @param  string  $key
+     * @param  string  $warning
+     * @param  \Closure|bool|null  $callback
      * @return bool
      */
-    protected function setKeyInConfigFile($key)
+    public function confirmToProceed($warning = 'Application In Production!', $callback = null)
     {
-        if (!$this->confirmToProceed()) {
-            return false;
+        if ($this->hasOption('force') && $this->option('force')) {
+            return true;
         }
 
-        $currentKey = $this->laravel['config']['app.key'];
+        $this->alert('An application key is already set!');
 
-        list($path, $contents) = $this->getKeyFile();
+        $confirmed = $this->confirm('Do you really wish to run this command?');
 
-        $contents = str_replace($currentKey, $key, $contents);
+        if (!$confirmed) {
+            $this->comment('Command Canceled!');
 
-        $this->files->put($path, $contents);
+            return false;
+        }
 
         return true;
     }
-
-    /**
-     * Get the key file and contents.
-     *
-     * @return array
-     */
-    protected function getKeyFile()
-    {
-        $env = $this->option('env') ? $this->option('env').'/' : '';
-
-        $contents = $this->files->get($path = $this->laravel['path.config']."/{$env}app.php");
-
-        return [$path, $contents];
-    }
 }

src/Parse/Contracts/DataFileInterface.php

@@ -0,0 +1,24 @@
+<?php namespace Winter\Storm\Parse\Contracts;
+
+interface DataFileInterface
+{
+    /**
+     * Return a new instance of `DataFileInterface` ready for modification of the provided filepath.
+     */
+    public static function open(string $filePath): static;
+
+    /**
+     * Set a property within the data.
+     */
+    public function set(string|array $key, $value = null): static;
+
+    /**
+     * Write the current data to a file
+     */
+    public function write(?string $filePath = null): void;
+
+    /**
+     * Get the printed data
+     */
+    public function render(): string;
+}