bug #41535 [Console] Fix negated options not accessible (jderusse)

chalasr · chalasr · commit 7d2e06803df8 · 2021-06-04T13:17:01.000+02:00
This PR was merged into the 5.3 branch.

Discussion
----------

[Console] Fix negated options not accessible

| Q             | A
| ------------- | ---
| Branch?       | 5.3
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Tickets       | Fix #41531
| License       | MIT
| Doc PR        | -

Removing the `--no-ansi` option to only let the negatable option `--ansi` breaks applications that expects calling `$input-&gt;getOption('no-ansi')`

This PR provides a fallback to return the negative value of the negatable options

Commits
-------

440bd5f1c7 [Console] Fix negated options not accessible
diff --git a/Input/Input.php b/Input/Input.php
@@ -146,6 +146,14 @@ public function getOptions()
      */
     public function getOption(string $name)
     {
+        if ($this->definition->hasNegation($name)) {
+            if (null === $value = $this->getOption($this->definition->negationToName($name))) {
+                return $value;
+            }
+
+            return !$value;
+        }
+
         if (!$this->definition->hasOption($name)) {
             throw new InvalidArgumentException(sprintf('The "%s" option does not exist.', $name));
         }
@@ -158,7 +166,11 @@ public function getOption(string $name)
      */
     public function setOption(string $name, $value)
     {
-        if (!$this->definition->hasOption($name)) {
+        if ($this->definition->hasNegation($name)) {
+            $this->options[$this->definition->negationToName($name)] = !$value;
+
+            return;
+        } elseif (!$this->definition->hasOption($name)) {
             throw new InvalidArgumentException(sprintf('The "%s" option does not exist.', $name));
         }
 
@@ -170,7 +182,7 @@ public function setOption(string $name, $value)
      */
     public function hasOption(string $name)
     {
-        return $this->definition->hasOption($name);
+        return $this->definition->hasOption($name) || $this->definition->hasNegation($name);
     }
 
     /**
diff --git a/Tests/Input/InputTest.php b/Tests/Input/InputTest.php
@@ -45,6 +45,20 @@ public function testOptions()
         $input = new ArrayInput(['--name' => 'foo', '--bar' => null], new InputDefinition([new InputOption('name'), new InputOption('bar', '', InputOption::VALUE_OPTIONAL, '', 'default')]));
         $this->assertNull($input->getOption('bar'), '->getOption() returns null for options explicitly passed without value (or an empty value)');
         $this->assertEquals(['name' => 'foo', 'bar' => null], $input->getOptions(), '->getOptions() returns all option values');
+
+        $input = new ArrayInput(['--name' => null], new InputDefinition([new InputOption('name', null, InputOption::VALUE_NEGATABLE)]));
+        $this->assertTrue($input->hasOption('name'));
+        $this->assertTrue($input->hasOption('no-name'));
+        $this->assertTrue($input->getOption('name'));
+        $this->assertFalse($input->getOption('no-name'));
+
+        $input = new ArrayInput(['--no-name' => null], new InputDefinition([new InputOption('name', null, InputOption::VALUE_NEGATABLE)]));
+        $this->assertFalse($input->getOption('name'));
+        $this->assertTrue($input->getOption('no-name'));
+
+        $input = new ArrayInput([], new InputDefinition([new InputOption('name', null, InputOption::VALUE_NEGATABLE)]));
+        $this->assertNull($input->getOption('name'));
+        $this->assertNull($input->getOption('no-name'));
     }
 
     public function testSetInvalidOption()

Original file line number	Diff line number	Diff line change
`@@ -146,6 +146,14 @@ public function getOptions()`
`146`	`146`	`*/`
`147`	`147`	`public function getOption(string $name)`
`148`	`148`	`{`
	`149`	`+ if ($this->definition->hasNegation($name)) {`
	`150`	`+ if (null === $value = $this->getOption($this->definition->negationToName($name))) {`
	`151`	`+ return $value;`
	`152`	`+ }`
	`153`	`+`
	`154`	`+ return !$value;`
	`155`	`+ }`
	`156`	`+`
`149`	`157`	`if (!$this->definition->hasOption($name)) {`
`150`	`158`	`throw new InvalidArgumentException(sprintf('The "%s" option does not exist.', $name));`
`151`	`159`	`}`
`@@ -158,7 +166,11 @@ public function getOption(string $name)`
`158`	`166`	`*/`
`159`	`167`	`public function setOption(string $name, $value)`
`160`	`168`	`{`
`161`		`- if (!$this->definition->hasOption($name)) {`
	`169`	`+ if ($this->definition->hasNegation($name)) {`
	`170`	`+ $this->options[$this->definition->negationToName($name)] = !$value;`
	`171`	`+`
	`172`	`+ return;`
	`173`	`+ } elseif (!$this->definition->hasOption($name)) {`
`162`	`174`	`throw new InvalidArgumentException(sprintf('The "%s" option does not exist.', $name));`
`163`	`175`	`}`
`164`	`176`
`@@ -170,7 +182,7 @@ public function setOption(string $name, $value)`
`170`	`182`	`*/`
`171`	`183`	`public function hasOption(string $name)`
`172`	`184`	`{`
`173`		`- return $this->definition->hasOption($name);`
	`185`	`+ return $this->definition->hasOption($name) \|\| $this->definition->hasNegation($name);`
`174`	`186`	`}`
`175`	`187`
`176`	`188`	`/**`