[Console] Add InvalidOptionException to replace generic \InvalidArgumentException

GromNaN · GromNaN · commit bd025a33a602 · 2015-06-06T17:33:20.000+02:00
diff --git a/src/Symfony/Component/Console/Exception/InvalidOptionException.php b/src/Symfony/Component/Console/Exception/InvalidOptionException.php
@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Exception;
+
+/**
+ * Represents an incorrect option name typed in the console.
+ */
+class InvalidOptionException extends \InvalidArgumentException
+{
+}
diff --git a/src/Symfony/Component/Console/Input/ArrayInput.php b/src/Symfony/Component/Console/Input/ArrayInput.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Console\Input;
 
+use Symfony\Component\Console\Exception\InvalidOptionException;
+
 /**
  * ArrayInput represents an input provided as an array.
  *
@@ -153,12 +155,12 @@ protected function parse()
      * @param string $shortcut The short option key
      * @param mixed  $value    The value for the option
      *
-     * @throws \InvalidArgumentException When option given doesn't exist
+     * @throws InvalidOptionException When option given doesn't exist
      */
     private function addShortOption($shortcut, $value)
     {
         if (!$this->definition->hasShortcut($shortcut)) {
-            throw new \InvalidArgumentException(sprintf('The "-%s" option does not exist.', $shortcut));
+            throw new InvalidOptionException(sprintf('The "-%s" option does not exist.', $shortcut));
         }
 
         $this->addLongOption($this->definition->getOptionForShortcut($shortcut)->getName(), $value);
@@ -170,20 +172,20 @@ private function addShortOption($shortcut, $value)
      * @param string $name  The long option key
      * @param mixed  $value The value for the option
      *
-     * @throws \InvalidArgumentException When option given doesn't exist
-     * @throws \InvalidArgumentException When a required value is missing
+     * @throws InvalidOptionException When option given doesn't exist
+     * @throws InvalidOptionException When a required value is missing
      */
     private function addLongOption($name, $value)
     {
         if (!$this->definition->hasOption($name)) {
-            throw new \InvalidArgumentException(sprintf('The "--%s" option does not exist.', $name));
+            throw new InvalidOptionException(sprintf('The "--%s" option does not exist.', $name));
         }
 
         $option = $this->definition->getOption($name);
 
         if (null === $value) {
             if ($option->isValueRequired()) {
-                throw new \InvalidArgumentException(sprintf('The "--%s" option requires a value.', $name));
+                throw new InvalidOptionException(sprintf('The "--%s" option requires a value.', $name));
             }
 
             $value = $option->isValueOptional() ? $option->getDefault() : true;
diff --git a/src/Symfony/Component/Console/Tests/Command/CommandTest.php b/src/Symfony/Component/Console/Tests/Command/CommandTest.php
@@ -241,7 +241,7 @@ public function testExecuteMethodNeedsToBeOverridden()
     }
 
     /**
-     * @expectedException        \InvalidArgumentException
+     * @expectedException        Symfony\Component\Console\Exception\InvalidOptionException
      * @expectedExceptionMessage The "--bar" option does not exist.
      */
     public function testRunWithInvalidOption()
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_renderexception2.txt b/src/Symfony/Component/Console/Tests/Fixtures/application_renderexception2.txt
@@ -1,9 +1,9 @@
 
 
-                                      
-  [InvalidArgumentException]          
-  The "--foo" option does not exist.  
-                                      
+                                                                
+  [Symfony\Component\Console\Exception\InvalidOptionException]  
+  The "--foo" option does not exist.                            
+                                                                
 
 
 list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Console\Input;`
`13`	`13`
	`14`	`+use Symfony\Component\Console\Exception\InvalidOptionException;`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* ArrayInput represents an input provided as an array.`
`16`	`18`	`*`
`@@ -153,12 +155,12 @@ protected function parse()`
`153`	`155`	`* @param string $shortcut The short option key`
`154`	`156`	`* @param mixed $value The value for the option`
`155`	`157`	`*`
`156`		`- * @throws \InvalidArgumentException When option given doesn't exist`
	`158`	`+ * @throws InvalidOptionException When option given doesn't exist`
`157`	`159`	`*/`
`158`	`160`	`private function addShortOption($shortcut, $value)`
`159`	`161`	`{`
`160`	`162`	`if (!$this->definition->hasShortcut($shortcut)) {`
`161`		`- throw new \InvalidArgumentException(sprintf('The "-%s" option does not exist.', $shortcut));`
	`163`	`+ throw new InvalidOptionException(sprintf('The "-%s" option does not exist.', $shortcut));`
`162`	`164`	`}`
`163`	`165`
`164`	`166`	`$this->addLongOption($this->definition->getOptionForShortcut($shortcut)->getName(), $value);`
`@@ -170,20 +172,20 @@ private function addShortOption($shortcut, $value)`
`170`	`172`	`* @param string $name The long option key`
`171`	`173`	`* @param mixed $value The value for the option`
`172`	`174`	`*`
`173`		`- * @throws \InvalidArgumentException When option given doesn't exist`
`174`		`- * @throws \InvalidArgumentException When a required value is missing`
	`175`	`+ * @throws InvalidOptionException When option given doesn't exist`
	`176`	`+ * @throws InvalidOptionException When a required value is missing`
`175`	`177`	`*/`
`176`	`178`	`private function addLongOption($name, $value)`
`177`	`179`	`{`
`178`	`180`	`if (!$this->definition->hasOption($name)) {`
`179`		`- throw new \InvalidArgumentException(sprintf('The "--%s" option does not exist.', $name));`
	`181`	`+ throw new InvalidOptionException(sprintf('The "--%s" option does not exist.', $name));`
`180`	`182`	`}`
`181`	`183`
`182`	`184`	`$option = $this->definition->getOption($name);`
`183`	`185`
`184`	`186`	`if (null === $value) {`
`185`	`187`	`if ($option->isValueRequired()) {`
`186`		`- throw new \InvalidArgumentException(sprintf('The "--%s" option requires a value.', $name));`
	`188`	`+ throw new InvalidOptionException(sprintf('The "--%s" option requires a value.', $name));`
`187`	`189`	`}`
`188`	`190`
`189`	`191`	`$value = $option->isValueOptional() ? $option->getDefault() : true;`
Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,7 @@ public function testExecuteMethodNeedsToBeOverridden()`
`241`	`241`	`}`
`242`	`242`
`243`	`243`	`/**`
`244`		`- * @expectedException \InvalidArgumentException`
	`244`	`+ * @expectedException Symfony\Component\Console\Exception\InvalidOptionException`
`245`	`245`	`* @expectedExceptionMessage The "--bar" option does not exist.`
`246`	`246`	`*/`
`247`	`247`	`public function testRunWithInvalidOption()`