[OptionsParser] Added method replaceDefaults()

symfony · fabpot · May 15, 2012 · Apr 17, 2012 · Apr 23, 2012 · May 10, 2012
commit 04522ca4ed80b27a864fee29bb4d84c74a853e79
diff --git a/src/Symfony/Component/OptionsParser/OptionsParser.php b/src/Symfony/Component/OptionsParser/OptionsParser.php
@@ -72,6 +72,29 @@ public function setDefaults(array $defaultValues)
        }
     }
 
+    /**
+     * Replaces default option values.
+     *
+     * Old defaults are erased, which means that closures passed here can't
+     * access the previous default value. This may be useful to improve
+     * performance if the previous default value is calculated by an expensive
+     * closure.
+     *
+     * @param array $options A list of option names as keys and default values
+     *                       as values. The option values may be closures
+     *                       of the following signature:
+     *
+     *                         - function (Options $options)
+     */
+    public function replaceDefaults(array $defaultValues)
+    {
+        foreach ($defaultValues as $option => $value) {
+            unset($this->defaultOptions[$option]);
+            $this->defaultOptions[$option] = $value;
+            $this->knownOptions[$option] = true;
+        }
+    }
+
     /**
      * Sets optional options.
      *

diff --git a/src/Symfony/Component/OptionsParser/Tests/OptionParserTest.php b/src/Symfony/Component/OptionsParser/Tests/OptionParserTest.php
@@ -145,6 +145,27 @@ public function testParseLazyDependencyOnRequired()
         ), $this->parser->parse($options));
     }
 
+    public function testParseLazyReplaceDefaults()
+    {
+        $test = $this;
+
+        $this->parser->setDefaults(array(
+            'one' => function (Options $options) use ($test) {
+                $test->fail('Previous closure should not be executed');
+            },
+        ));
+
+        $this->parser->replaceDefaults(array(
+            'one' => function (Options $options, $previousValue) {
+                return '1';
+            },
+        ));
+
+        $this->assertEquals(array(
+            'one' => '1',
+        ), $this->parser->parse(array()));
+    }
+
     /**
      * @expectedException Symfony\Component\OptionsParser\Exception\InvalidOptionsException
      */

diff --git a/src/Symfony/Component/OptionsParser/Tests/OptionsTest.php b/src/Symfony/Component/OptionsParser/Tests/OptionsTest.php
@@ -80,24 +80,24 @@ public function testLazyOption()
         $this->assertEquals('dynamic', $this->options['foo']);
     }
 
-    public function testLazyOptionWithEagerCurrentValue()
+    public function testLazyOptionWithEagerPreviousValue()
     {
         $test = $this;
 
         // defined by superclass
         $this->options['foo'] = 'bar';
 
         // defined by subclass
-        $this->options['foo'] = function (Options $options, $currentValue) use ($test) {
-           $test->assertEquals('bar', $currentValue);
+        $this->options['foo'] = function (Options $options, $previousValue) use ($test) {
+           $test->assertEquals('bar', $previousValue);
 
            return 'dynamic';
         };
 
         $this->assertEquals('dynamic', $this->options['foo']);
     }
 
-    public function testLazyOptionWithLazyCurrentValue()
+    public function testLazyOptionWithLazyPreviousValue()
     {
         $test = $this;
 
@@ -107,8 +107,8 @@ public function testLazyOptionWithLazyCurrentValue()
         };
 
         // defined by subclass
-        $this->options['foo'] = function (Options $options, $currentValue) use ($test) {
-           $test->assertEquals('bar', $currentValue);
+        $this->options['foo'] = function (Options $options, $previousValue) use ($test) {
+           $test->assertEquals('bar', $previousValue);
 
            return 'dynamic';
         };