Provides ways to ignore configuration keys (and functions entirely) #11

src/Analyzers/ConfigAnalyzer.php

@@ -115,6 +115,13 @@ class ConfigAnalyzer
      */
     private $currentValues = [];
 
+    /**
+     * Indicates if function calls should be ignored.
+     *
+     * @var bool
+     */
+    private $ignoreFunctions = false;
+
     public function __construct()
     {
         $this->functionHandler = new FunctionHandler();
@@ -140,6 +147,16 @@ public function __construct()
         $this->parser = new Php7($this->lexer);
     }
 
+    /**
+     * Sets if function calls should be ignored.
+     *
+     * @param bool $ignoreFunctions
+     */
+    public function setIgnoreFunctions($ignoreFunctions)
+    {
+        $this->ignoreFunctions = $ignoreFunctions;
+    }
+
     /**
      * Sets the current configuration values.
      *
@@ -342,6 +359,10 @@ public function replaceNodeValue($key, Node $node, $completeReplace = false)
      */
     private function shouldProceedWithFunctionRewrite($key, $checkValue)
     {
+        if ($this->ignoreFunctions) {
+            return false;
+        }
+
         if ($checkValue === null) {
             return true;
         }

src/ConfigUpdater.php

@@ -43,13 +43,54 @@ class ConfigUpdater
      */
     private $transformer = null;
 
+    /**
+     * Specifies whether function calls should be ignored when updating configuration files.
+     *
+     * @var bool
+     */
+    private $ignoreFunctions = false;
+
+    /**
+     * A list of configuration keys that should be preserved.
+     * @var array
+     */
+    private $preserveKeys = [];
+
     public function __construct()
     {
         $this->transformer = new Transformer();
         $this->arrayAnalyzer = new ArrayAnalyzer();
         $this->analyzer = new ConfigAnalyzer();
     }
 
+    /**
+     * Sets whether function calls are ignored when updating the configuration.
+     *
+     * @param bool $ignore
+     * @return $this
+     */
+    public function setIgnoreFunctions($ignore)
+    {
+        $this->ignoreFunctions = $ignore;
+
+        $this->analyzer->setIgnoreFunctions($ignore);
+
+        return $this;
+    }
+
+    /**
+     * Sets a list of configuration keys that should always be preserved.
+     *
+     * @param array $keys
+     * @return $this
+     */
+    public function setPreserveKeys($keys)
+    {
+        $this->preserveKeys = $keys;
+
+        return $this;
+    }
+
     /**
      * Attempts to remove the key and its value from the configuration.
      *
@@ -135,6 +176,12 @@ public function replaceStructure($key, $newKey, $value, $docBlock, $forceNewLine
      */
     public function update(array $changes)
     {
+        if (! empty($this->preserveKeys)) {
+            foreach ($this->preserveKeys as $keyToPreserve) {
+                unset($changes[$keyToPreserve]);
+            }
+        }
+
         $changesToMake = $this->arrayAnalyzer->getChanges($changes);
 
         foreach ($changesToMake->insertions as $insert) {

src/Contracts/ConfigWriterContract.php

@@ -53,6 +53,21 @@ public function getFile($key);
      */
     public function guard($entry);
 
+    /**
+     * Indicates that all function calls should be ignored when updating configuration files.
+     *
+     * @return ConfigWriterContract
+     */
+    public function ignoreFunctionCalls();
+
+    /**
+     * Sets a list of configuration keys that should always be preserved.
+     *
+     * @param array $config
+     * @return mixed
+     */
+    public function preserve($config);
+
     /**
      * Attempts to update the source configuration and returns the modified document.
      *

src/LaravelConfigWriter.php

@@ -71,6 +71,19 @@ class LaravelConfigWriter implements ConfigWriterContract
      */
     protected $functionWriter = null;
 
+    /**
+     * Specifies whether function calls should be ignored when updating configuration files.
+     *
+     * @var bool
+     */
+    protected $ignoreFunctions = false;
+
+    /**
+     * A list of configuration keys that should be preserved.
+     * @var array
+     */
+    protected $preserveKeys = [];
+
     public function __construct(Application $app, Repository $configRepo)
     {
         $this->app = $app;
@@ -237,6 +250,31 @@ public function edit($namespace)
         return new ConfigUpdateWrapper($this, $namespace);
     }
 
+    /**
+     * Sets a list of configuration items that will never be updated.
+     *
+     * @param array $config The configuration keys to preserve.
+     * @return $this
+     */
+    public function preserve($config)
+    {
+        $this->preserveKeys = $config;
+
+        return $this;
+    }
+
+    /**
+     * Will indicate that all function calls should be ignored when updating the configuration file.
+     *
+     * @return $this
+     */
+    public function ignoreFunctionCalls()
+    {
+        $this->ignoreFunctions = true;
+
+        return $this;
+    }
+
     /**
      * Attempts to apply multiple changes to a configuration namespace.
      *
@@ -317,6 +355,8 @@ protected function getChanges($file, $namespace, array $changes)
         }
 
         $configUpdater = new ConfigUpdater();
+        $configUpdater->setIgnoreFunctions($this->ignoreFunctions)
+            ->setPreserveKeys($this->preserveKeys);
         $configUpdater->open($file);
         $configUpdater->update($changes);
 

src/Support/Facades/ConfigWriter.php

@@ -15,6 +15,8 @@
  * @method static void guard($entry)
  * @method static string preview($key, $value)
  * @method static string previewMany($configNamespace, array $values)
+ * @method static ConfigWriterContract ignoreFunctionCalls()
+ * @method static ConfigWriterContract preserve($config)
  * @method static ConfigUpdateWrapper edit($namespace)
  * @method static FunctionWriter f()
  *

tests/IgnoreConfigurationItemsTest.php

@@ -0,0 +1,46 @@
+<?php
+
+require_once 'ProteusTestCase.php';
+
+use Stillat\Proteus\ConfigUpdater;
+use Stillat\Proteus\Document\Transformer;
+
+class IgnoreConfigurationItemsTest extends ProteusTestCase
+{
+    public function testThatFunctionCallsWereIgnored()
+    {
+        $updater = new ConfigUpdater();
+        $updater->setIgnoreFunctions(true);
+        $updater->open(__DIR__ . '/configs/withenv.php');
+        $expected = Transformer::normalizeLineEndings(file_get_contents(__DIR__ . '/expected/withenv.php'));
+        $updater->update([
+            'some_key' => 'new-value',
+            'nested.key.value' => 'inserted-value'
+        ]);
+
+        $doc = $updater->getDocument();
+
+        $this->assertEquals($expected, $doc);
+    }
+
+    public function testConfigurationItemsCanBeIgnored()
+    {
+        $updater = new ConfigUpdater();
+        $updater->setPreserveKeys([
+            'some_key',
+            'nested.key.value'
+        ]);
+
+        $updater->open(__DIR__ . '/configs/withenv.php');
+        $expected = Transformer::normalizeLineEndings(file_get_contents(__DIR__ . '/expected/withenv_preserve.php'));
+        $updater->update([
+            'some_key' => 'new-value',
+            'nested.key.value' => 'inserted-value',
+            'nested.key.append' => 'Hello, universe!'
+        ]);
+
+        $doc = $updater->getDocument();
+
+        $this->assertEquals($expected, $doc);
+    }
+}

tests/configs/withenv.php

@@ -0,0 +1,12 @@
+<?php
+
+return [
+    'some_key' => env('SOME_ENV_KEY', false),
+
+    'nested' => [
+        'key' => [
+            'value' => 'test'
+        ],
+    ],
+
+];

tests/expected/withenv.php

@@ -0,0 +1,12 @@
+<?php
+
+return [
+    'some_key' => env('SOME_ENV_KEY', false),
+
+    'nested' => [
+        'key' => [
+            'value' => 'inserted-value'
+        ],
+    ],
+
+];

tests/expected/withenv_preserve.php

@@ -0,0 +1,12 @@
+<?php
+
+return [
+    'some_key' => env('SOME_ENV_KEY', false),
+
+    'nested' => [
+        'key' => [
+            'value' => 'test', 'append' => 'Hello, universe!'
+        ],
+    ],
+
+];