Allow selection of a choice by the data of a choice

Author: matthiasnoback

features/interactive.feature

@@ -72,3 +72,22 @@ Feature: It is possible to interactively fill in a form from the CLI
           [color] => blue
       )
       """
+
+  @symfony27
+  Scenario: Select a value by its underlying data
+    When I run the command "form:color_with_choices_as_values" and I provide as input
+      """
+      red[enter]
+      """
+    Then the command has finished successfully
+    And the output should be
+    """
+      Select color [red]:
+        [0] Red
+        [1] Blue
+        [2] Yellow
+      > Array
+      (
+          [color] => red
+      )
+      """

src/Bridge/Transformer/ChoiceTransformer.php

@@ -11,12 +11,7 @@ public function transform(Form $form)
     {
         $formView = $form->createView();
 
-        $choices = [];
-        foreach ($formView->vars['choices'] as $choiceView) {
-            $choices[$choiceView->value] = $choiceView->label;
-        }
-
-        $question = new AlwaysReturnKeyOfChoiceQuestion($this->questionFrom($form), $choices, $this->defaultValueFrom($form));
+        $question = new AlwaysReturnKeyOfChoiceQuestion($this->questionFrom($form), $formView->vars['choices'], $this->defaultValueFrom($form));
 
         if ($form->getConfig()->getOption('multiple')) {
             $question->setMultiselect(true);

src/Console/Helper/Question/AlwaysReturnKeyOfChoiceQuestion.php

@@ -3,13 +3,34 @@
 namespace Matthias\SymfonyConsoleForm\Console\Helper\Question;
 
 use Symfony\Component\Console\Question\ChoiceQuestion;
+use Symfony\Component\Form\Extension\Core\View\ChoiceView;
 
 class AlwaysReturnKeyOfChoiceQuestion extends ChoiceQuestion
 {
+    /**
+     * @var ChoiceView[]
+     */
+    private $choiceViews;
     private $_multiselect = false;
 
     private $_errorMessage = 'Value "%s" is invalid';
 
+    public function __construct($question, array $choiceViews, $default = null)
+    {
+        \Assert\that($choiceViews)
+            ->all()
+            ->isInstanceOf(
+                'Symfony\Component\Form\Extension\Core\View\ChoiceView',
+                'Only a flat choice hierarchy is supported'
+            );
+
+        $this->choiceViews = $choiceViews;
+
+        parent::__construct($question, $this->prepareChoices(), $default);
+
+        $this->setAutocompleterValues($this->prepareAutocompleteValues());
+    }
+
     public function setMultiselect($multiselect)
     {
         $this->_multiselect = $multiselect;
@@ -26,18 +47,14 @@ public function setErrorMessage($errorMessage)
 
     public function getValidator()
     {
-        $choices = $this->getChoices();
-        $errorMessage = $this->_errorMessage;
-        $multiselect = $this->_multiselect;
-
-        return function ($selected) use ($choices, $errorMessage, $multiselect) {
+        return function ($selected) {
             // Collapse all spaces.
             $selectedChoices = str_replace(' ', '', $selected);
 
-            if ($multiselect) {
+            if ($this->_multiselect) {
                 // Check for a separated comma values
                 if (!preg_match('/^[a-zA-Z0-9_-]+(?:,[a-zA-Z0-9_-]+)*$/', $selectedChoices, $matches)) {
-                    throw new \InvalidArgumentException(sprintf($errorMessage, $selected));
+                    throw new \InvalidArgumentException(sprintf($this->_errorMessage, $selected));
                 }
                 $selectedChoices = explode(',', $selectedChoices);
             } else {
@@ -46,25 +63,58 @@ public function getValidator()
 
             $selectedKeys = array();
 
-            foreach ($selectedChoices as $value) {
-                if (array_key_exists($value, $choices)) {
-                    $selectedKeys[] = $value;
-                    continue;
-                }
-
-                $key = array_search($value, $choices);
-                if ($key === false) {
-                    throw new \InvalidArgumentException(sprintf($errorMessage, $value));
-                }
-
-                $selectedKeys[] = $key;
+            foreach ($selectedChoices as $selectedValue) {
+                $selectedKeys[] = $this->resolveChoiceViewValue($selectedValue);
             }
 
-            if ($multiselect) {
+            if ($this->_multiselect) {
                 return $selectedKeys;
             }
 
             return current($selectedKeys);
         };
     }
+
+    /**
+     * @param string $selectedValue The selected value
+     * @return string The corresponding value of the ChoiceView
+     */
+    private function resolveChoiceViewValue($selectedValue)
+    {
+        foreach ($this->choiceViews as $choiceView) {
+            if (in_array($selectedValue, [$choiceView->data, $choiceView->value, $choiceView->label])) {
+                return $choiceView->value;
+            }
+        }
+
+        throw new \InvalidArgumentException(sprintf($this->_errorMessage, $selectedValue));
+    }
+
+    private function prepareChoices()
+    {
+        $choices = [];
+        foreach ($this->choiceViews as $choiceView) {
+            $label = $choiceView->label;
+            if ($choiceView->data != $choiceView->value) {
+                $label .= ' (<comment>' . $choiceView->data . '</comment>)';
+            }
+
+            $choices[$choiceView->value] = $label;
+        }
+
+        return $choices;
+    }
+
+    private function prepareAutocompleteValues()
+    {
+        $autocompleteValues = array();
+
+        foreach ($this->choiceViews as $choiceView) {
+            $autocompleteValues[] = $choiceView->value;
+            $autocompleteValues[] = $choiceView->data;
+            $autocompleteValues[] = $choiceView->label;
+        }
+
+        return $autocompleteValues;
+    }
 }