Add options for renaming parameters in IncenteevParameterHandler

alcaeus · alcaeus · commit 94c13ac36467 · 2013-07-20T10:03:43.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.0.1
+
+* Add a rename map used to rename parameters when updating the parameters file
+
 ## 2.0.0 (2013-04-06)
 
 * BC BREAK the env map has been changed, inverting the keys and the values. Refs #14
diff --git a/README.md b/README.md
@@ -105,6 +105,33 @@ As environment variables can only be strings, they are also parsed as inline
 Yaml values to allows specifying ``null``, ``false``, ``true`` or numbers
 easily.
 
+## Renaming parameters
+
+If you are renaming a parameter, the new key will be set according to the usual
+routine (prompt if possible, use environment variables, use default).
+To have the parameters handler use the value of an (obsolete) parameter, specify
+a rename-map:
+```json
+{
+    "extra": {
+        "incenteev-parameters": {
+            "rename-map": {
+                "new_param_1": "old_param_1",
+                "new_param_2": "old_param_2"
+            }
+        }
+    }
+}
+```
+
+This will create the new parameters new_param_1 and new_param_2 while using the
+values from old_param_1 and old_param_2, respectively. It will not remove the
+old parameters unless you've also removed them from the dist version.
+
+If the old parameter is no longer present (maybe because it has been renamed and
+remove already), no parameters are overwritten. You don't need to remove obsolete
+parameters from the rename map once they have been renamed.
+
 Warning: This parameters handler will overwrite any comments or spaces into
 your parameters.yml file so handle with care. So if you want to give format
 and comments to your parameter's file you should do it on your dist version.
diff --git a/ScriptHandler.php b/ScriptHandler.php
@@ -67,6 +67,10 @@ public static function buildParameters(Event $event)
         }
         $actualParams = (array) $actualValues[$parameterKey];
 
+        // Grab values for parameters that were renamed
+        $renameMap = empty($extras['incenteev-parameters']['rename-map']) ? array() : (array) $extras['incenteev-parameters']['rename-map'];
+        $actualParams = array_replace($actualParams, self::getRenameValues($renameMap, $actualParams));
+
         if (!$keepOutdatedParams) {
             // Remove the outdated params
             foreach ($actualParams as $key => $value) {
@@ -99,6 +103,26 @@ private static function getEnvValues(array $envMap)
         return $params;
     }
 
+    private static function getRenameValues(array $renameMap, $actualParams)
+    {
+        $params = array();
+        foreach ($renameMap as $param => $oldParam) {
+            if (array_key_exists($param, $actualParams)) {
+                continue;
+            }
+
+            if (!array_key_exists($oldParam, $actualParams)) {
+                continue;
+            }
+
+            if ($actualParams[$oldParam]) {
+                $params[$param] = $actualParams[$oldParam];
+            }
+        }
+
+        return $params;
+    }
+
     private static function getParams(IOInterface $io, array $expectedParams, array $actualParams)
     {
         // Simply use the expectedParams value as default for the missing params.
