Merge pull request #36 from igneus/fix-choicetype-unstringable-value

support ChoiceType with data which don't support conversion to string

Author: matthiasnoback

features/interactive.feature

@@ -251,3 +251,24 @@ Feature: It is possible to interactively fill in a form from the CLI
         [milk] =>
     )
     """
+
+  Scenario: Choice with options which cannot be converted to string
+    When I run the command "form:unstringable_choices" and I provide as input
+      """
+      1[enter]
+      """
+    Then the command has finished successfully
+    And the output should contain
+      """
+      Select address:
+        [0] 10 Downing Street
+        [1] 1600 Pennsylvania Ave NW
+        [2] 55 Rue du Faubourg Saint-Honoré
+       > Array
+      (
+        [address] => Matthias\SymfonyConsoleForm\Tests\Form\Data\Address Object
+          (
+            [street] => 1600 Pennsylvania Ave NW
+          )
+      )
+      """

src/Console/Helper/Question/AlwaysReturnKeyOfChoiceQuestion.php

@@ -117,8 +117,9 @@ private function prepareChoices()
         $choices = [];
         foreach ($this->choiceViews as $choiceView) {
             $label = $choiceView->label;
-            if ($choiceView->data != $choiceView->value) {
-                $label .= ' (<comment>'.$choiceView->data.'</comment>)';
+            $data = $choiceView->data;
+            if ($data != $choiceView->value && $this->canBeConvertedToString($data)) {
+                $label .= ' (<comment>' . $data . '</comment>)';
             }
 
             $choices[$choiceView->value] = $label;
@@ -136,7 +137,12 @@ private function prepareAutocompleteValues()
 
         foreach ($this->choiceViews as $choiceView) {
             $autocompleteValues[] = $choiceView->value;
-            $autocompleteValues[] = $choiceView->data;
+
+            $data = $choiceView->data;
+            if ($this->canBeConvertedToString($data)) {
+                $autocompleteValues[] = (string)$data;
+            }
+
             $autocompleteValues[] = $choiceView->label;
         }
 
@@ -156,4 +162,13 @@ private function assertFlatChoiceViewsArray(array $choiceViews)
             }
         }
     }
+
+    /**
+     * @param mixed $value
+     * @return bool
+     */
+    private function canBeConvertedToString($value)
+    {
+        return null === $value || is_scalar($value) || (\is_object($value) && method_exists($value, '__toString'));
+    }
 }

test/Form/UnstringableChoicesType.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Matthias\SymfonyConsoleForm\Tests\Form;
+
+use Matthias\SymfonyConsoleForm\Tests\Form\Data\Address;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+/**
+ * Demonstrates handling of choice data which does not support conversion to string (Address has no __toString())
+ */
+class UnstringableChoicesType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('address', ChoiceType::class, [
+                'label' => 'Select address',
+                'choices' => [
+                    new Address('10 Downing Street'),
+                    new Address('1600 Pennsylvania Ave NW'),
+                    new Address('55 Rue du Faubourg Saint-Honoré'),
+                ],
+                'choice_label' => function (Address $address) {
+                    return $address->street;
+                },
+            ]);
+    }
+}

test/config.yml

@@ -106,6 +106,14 @@ services:
         tags:
             - { name: console.command }
 
+    unstringable_choices_command:
+        class: Matthias\SymfonyConsoleForm\Tests\Command\PrintFormDataCommand
+        arguments:
+            - Matthias\SymfonyConsoleForm\Tests\Form\UnstringableChoicesType
+            - unstringable_choices
+        tags:
+            - { name: console.command }
+
 framework:
     form:
         csrf_protection: true