Add Suggestion class for more advanced completion suggestion

wouterj · wouterj · commit f5667b0d71aa · 2021-11-23T16:43:56.000+01:00
diff --git a/src/Symfony/Component/Console/Completion/CompletionSuggestions.php b/src/Symfony/Component/Console/Completion/CompletionSuggestions.php
@@ -26,25 +26,29 @@ class CompletionSuggestions
     /**
      * Add a suggested value for an input option or argument.
      *
+     * @param string|Suggestion $value
+     *
      * @return $this
      */
-    public function suggestValue(string $value): self
+    public function suggestValue($value): self
     {
-        $this->valueSuggestions[] = $value;
+        $this->valueSuggestions[] = !$value instanceof Suggestion ? new Suggestion($value) : false;
 
         return $this;
     }
 
     /**
      * Add multiple suggested values at once for an input option or argument.
      *
-     * @param string[] $values
+     * @param list<string|Suggestion> $values
      *
      * @return $this
      */
     public function suggestValues(array $values): self
     {
-        $this->valueSuggestions = array_merge($this->valueSuggestions, $values);
+        foreach ($values as $value) {
+            $this->suggestValue($value);
+        }
 
         return $this;
     }
@@ -86,7 +90,7 @@ public function getOptionSuggestions(): array
     }
 
     /**
-     * @return string[]
+     * @return Suggestion[]
      */
     public function getValueSuggestions(): array
     {
diff --git a/src/Symfony/Component/Console/Completion/Output/BashCompletionOutput.php b/src/Symfony/Component/Console/Completion/Output/BashCompletionOutput.php
@@ -21,10 +21,10 @@ class BashCompletionOutput implements CompletionOutputInterface
 {
     public function write(CompletionSuggestions $suggestions, OutputInterface $output): void
     {
-        $options = $suggestions->getValueSuggestions();
+        $suggestions = $suggestions->getValueSuggestions();
         foreach ($suggestions->getOptionSuggestions() as $option) {
-            $options[] = '--'.$option->getName();
+            $suggestions[] = '--'.$option->getName();
         }
-        $output->writeln(implode("\n", $options));
+        $output->writeln(implode("\n", $suggestions));
     }
 }
diff --git a/src/Symfony/Component/Console/Completion/Suggestion.php b/src/Symfony/Component/Console/Completion/Suggestion.php
@@ -0,0 +1,37 @@
+<?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\Completion;
+
+/**
+ * Represents a single suggested value.
+ *
+ * @author Wouter de Jong <wouter@wouterj.nl>
+ */
+class Suggestion
+{
+    private string $value;
+
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    public function __toString(): string
+    {
+        return $this->getValue();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -26,25 +26,29 @@ class CompletionSuggestions`
`26`	`26`	`/**`
`27`	`27`	`* Add a suggested value for an input option or argument.`
`28`	`28`	`*`
	`29`	`+ * @param string\|Suggestion $value`
	`30`	`+ *`
`29`	`31`	`* @return $this`
`30`	`32`	`*/`
`31`		`- public function suggestValue(string $value): self`
	`33`	`+ public function suggestValue($value): self`
`32`	`34`	`{`
`33`		`- $this->valueSuggestions[] = $value;`
	`35`	`+ $this->valueSuggestions[] = !$value instanceof Suggestion ? new Suggestion($value) : false;`
`34`	`36`
`35`	`37`	`return $this;`
`36`	`38`	`}`
`37`	`39`
`38`	`40`	`/**`
`39`	`41`	`* Add multiple suggested values at once for an input option or argument.`
`40`	`42`	`*`
`41`		`- * @param string[] $values`
	`43`	`+ * @param list<string\|Suggestion> $values`
`42`	`44`	`*`
`43`	`45`	`* @return $this`
`44`	`46`	`*/`
`45`	`47`	`public function suggestValues(array $values): self`
`46`	`48`	`{`
`47`		`- $this->valueSuggestions = array_merge($this->valueSuggestions, $values);`
	`49`	`+ foreach ($values as $value) {`
	`50`	`+ $this->suggestValue($value);`
	`51`	`+ }`
`48`	`52`
`49`	`53`	`return $this;`
`50`	`54`	`}`
`@@ -86,7 +90,7 @@ public function getOptionSuggestions(): array`
`86`	`90`	`}`
`87`	`91`
`88`	`92`	`/**`
`89`		`- * @return string[]`
	`93`	`+ * @return Suggestion[]`
`90`	`94`	`*/`
`91`	`95`	`public function getValueSuggestions(): array`
`92`	`96`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,10 @@ class BashCompletionOutput implements CompletionOutputInterface`
`21`	`21`	`{`
`22`	`22`	`public function write(CompletionSuggestions $suggestions, OutputInterface $output): void`
`23`	`23`	`{`
`24`		`- $options = $suggestions->getValueSuggestions();`
	`24`	`+ $suggestions = $suggestions->getValueSuggestions();`
`25`	`25`	`foreach ($suggestions->getOptionSuggestions() as $option) {`
`26`		`- $options[] = '--'.$option->getName();`
	`26`	`+ $suggestions[] = '--'.$option->getName();`
`27`	`27`	`}`
`28`		`- $output->writeln(implode("\n", $options));`
	`28`	`+ $output->writeln(implode("\n", $suggestions));`
`29`	`29`	`}`
`30`	`30`	`}`