Merge pull request consolidation#446 from consolidation-org/config-cl…

…eanup Clean up Config class initialization / global input option handling.
easychen · Sep 12, 2016 · a7205a5 · a7205a5
2 parents fecc4e3 + 3099c48
commit a7205a5
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 15 deletions.
diff --git a/src/Application.php b/src/Application.php
@@ -19,7 +19,7 @@ public function __construct($name, $version)
             );
         $this->getDefinition()
             ->addOption(
-                new InputOption('--progress-delay', null, InputOption::VALUE_REQUIRED, 'Number of seconds before progress bar is displayed in long-running task collections. Default: 2s.')
+                new InputOption('--progress-delay', null, InputOption::VALUE_REQUIRED, 'Number of seconds before progress bar is displayed in long-running task collections. Default: 2s.', Config::DEFAULT_PROGRESS_DELAY)
             );
         $this->getDefinition()
             ->addOption(

diff --git a/src/Config.php b/src/Config.php
@@ -4,47 +4,66 @@
 class Config
 {
     const PROGRESS_BAR_AUTO_DISPLAY_INTERVAL = 'progress-delay';
+    const DEFAULT_PROGRESS_DELAY = 2;
     const SIMULATE = 'simulate';
     const SUPRESS_MESSAGES = 'supress-messages';
     const DECORATED = 'decorated';
 
     protected $config = [];
 
-    public function get($key, $default = null)
+    /**
+     * Fet a configuration value
+     * @param string $key Which config item to look up
+     * @param string|null $defaultOverride Override usual default value with a different default
+     * @return mixed
+     */
+    public function get($key, $defaultOverride = null)
     {
-        return isset($this->config[$key]) ? $this->config[$key] : $default;
+        if (isset($this->config[$key])) {
+            return $this->config[$key];
+        }
+        return $this->getDefault($key, $defaultOverride);
     }
 
+    /**
+     * Set a configu value
+     * @param string $key
+     * @param mixed $value
+     * @return Config
+     */
     public function set($key, $value)
     {
         $this->config[$key] = $value;
         return $this;
     }
 
+    /**
+     * Return an associative array containing all of the global configuration
+     * options and their default values.
+     * @return array
+     */
     public function getGlobalOptionDefaultValues()
     {
         $globalOptions =
         [
-            self::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL => 2,
+            self::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL => self::DEFAULT_PROGRESS_DELAY,
             self::SIMULATE => false,
             self::SUPRESS_MESSAGES => false,
         ];
 
         return $globalOptions;
     }
 
-    public function setGlobalOptions($input)
+    /**
+     * Return the default value for a given configuration item.
+     * @param string $key
+     * @param string|null $defaultOverride
+     * @return mixed
+     */
+    public function getDefault($key, $defaultOverride = null)
     {
         $globalOptions = $this->getGlobalOptionDefaultValues();
-
-        foreach ($globalOptions as $option => $default) {
-            $value = $input->hasOption($option) ? $input->getOption($option) : null;
-            // Unfortunately, the `?:` operator does not differentate between `0` and `null`
-            if (!isset($value)) {
-                $value = $default;
-            }
-            $this->set($option, $value);
-        }
+        return isset($globalOptions[$key]) ? $globalOptions[$key] : $defaultOverride;
     }
 
     public function isSimulated()

diff --git a/src/GlobalOptionsEventListener.php b/src/GlobalOptionsEventListener.php
@@ -29,6 +29,17 @@ public static function getSubscribedEvents()
      */
     public function setGlobalOptions(ConsoleCommandEvent $event)
     {
-        $this->getConfig()->setGlobalOptions($event->getInput());
+        $config = $this->getConfig();
+        $input = $event->getInput();
+        $globalOptions = $config->getGlobalOptionDefaultValues();
+
+        foreach ($globalOptions as $option => $default) {
+            $value = $input->hasOption($option) ? $input->getOption($option) : null;
+            // Unfortunately, the `?:` operator does not differentate between `0` and `null`
+            if (!isset($value)) {
+                $value = $default;
+            }
+            $config->set($option, $value);
+        }
     }
 }