allow non-compound form and nested values

cristoforocervino · cristoforocervino · commit d06ebd6b6e8c · 2022-02-21T12:40:29.000+01:00
diff --git a/features/non-interactive.feature b/features/non-interactive.feature
@@ -83,3 +83,35 @@ Feature: It is possible to interactively fill in a form from the CLI
           [0] => blue
       )
       """
+
+  Scenario: Nested form type in non-interactive mode
+    When I run a command non-interactively with parameters
+      | Parameter               | Value                    |
+      | command                 | form:nested              |
+      | --user[name]            | mario                    |
+      | --user[lastname]        | rossi                    |
+      | --user[password]        | test                     |
+      | --anotherUser[name]     | luigi                    |
+      | --anotherUser[lastname] | verdi                    |
+      | --anotherUser[password] | test2                    |
+      | --color                 | blue                     |
+    Then the command has finished successfully
+    And the output should contain
+      """
+      Array
+      (
+          [user] => Array
+          (
+              [name] => mario
+              [lastname] => rossi
+              [password] => test
+          )
+          [anotherUser] => Array
+          (
+              [name] => luigi
+              [lastname] => verdi
+              [password] => test2
+          )
+          [color] => blue
+      )
+      """
diff --git a/src/Bridge/FormFactory/ConsoleFormFactory.php b/src/Bridge/FormFactory/ConsoleFormFactory.php
@@ -8,4 +8,6 @@
 interface ConsoleFormFactory
 {
     public function create(string $formType, InputInterface $input, array $options = []): FormInterface;
+
+    public function createNamed(string $name, string $formType, InputInterface $input, array $options = []): FormInterface;
 }
diff --git a/src/Bridge/FormFactory/ConsoleFormWithDefaultValuesAndOptionsFactory.php b/src/Bridge/FormFactory/ConsoleFormWithDefaultValuesAndOptionsFactory.php
@@ -6,10 +6,10 @@
 use Symfony\Component\Form\Exception\TransformationFailedException;
 use Symfony\Component\Form\Extension\Core\Type\FormType;
 use Symfony\Component\Form\Extension\Csrf\Type\FormTypeCsrfExtension;
+use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormRegistryInterface;
-use Symfony\Component\Form\Test\FormBuilderInterface;
 
 final class ConsoleFormWithDefaultValuesAndOptionsFactory implements ConsoleFormFactory
 {
@@ -29,39 +29,72 @@ public function __construct(FormFactoryInterface $formFactory, FormRegistryInter
         $this->formRegistry = $formRegistry;
     }
 
+    public function createNamed(
+        string $name,
+        string $formType,
+        InputInterface $input,
+        array $options = []
+    ): FormInterface {
+        $options = $this->addDefaultOptions($options);
+
+        $formBuilder = $this->formFactory->createNamedBuilder($name, $formType, null, $options);
+
+        $this->createChild($formBuilder, $input, $options);
+
+        return $formBuilder->getForm();
+    }
+
     public function create(string $formType, InputInterface $input, array $options = []): FormInterface
     {
         $options = $this->addDefaultOptions($options);
 
         $formBuilder = $this->formFactory->createBuilder($formType, null, $options);
 
-        foreach ($formBuilder as $name => $childBuilder) {
+        $this->createChild($formBuilder, $input, $options);
+
+        return $formBuilder->getForm();
+    }
+
+    protected function createChild(
+        FormBuilderInterface $formBuilder,
+        InputInterface $input,
+        array $options,
+        ?string $name = null
+    ): void {
+        if ($formBuilder->getCompound()) {
             /** @var FormBuilderInterface $childBuilder */
+            foreach ($formBuilder as $childName => $childBuilder) {
+                $this->createChild(
+                    $childBuilder,
+                    $input,
+                    $options,
+                    $name === null ? $childName : $name . '[' . $childName . ']'
+                );
+            }
+        } else {
+            $name = $name ?? $formBuilder->getName();
             if (!$input->hasOption($name)) {
-                continue;
+                return;
             }
 
             $providedValue = $input->getOption($name);
             if ($providedValue === null) {
-                continue;
+                return;
             }
 
             $value = $providedValue;
-
             try {
-                foreach ($childBuilder->getViewTransformers() as $viewTransformer) {
+                foreach ($formBuilder->getViewTransformers() as $viewTransformer) {
                     $value = $viewTransformer->reverseTransform($value);
                 }
-                foreach ($childBuilder->getModelTransformers() as $modelTransformer) {
+                foreach ($formBuilder->getModelTransformers() as $modelTransformer) {
                     $value = $modelTransformer->reverseTransform($value);
                 }
             } catch (TransformationFailedException) {
             }
 
-            $childBuilder->setData($value);
+            $formBuilder->setData($value);
         }
-
-        return $formBuilder->getForm();
     }
 
     private function addDefaultOptions(array $options): array
diff --git a/src/Bridge/Interaction/NonInteractiveRootInteractor.php b/src/Bridge/Interaction/NonInteractiveRootInteractor.php
@@ -31,26 +31,36 @@ public function interactWith(
         }
 
         /*
-         * We need to adjust the input values for repeated types by copying the provided value to both of the repeated
-         * fields. We only loop through the top-level fields, since there are no command options for deeper lying fields
-         * anyway.
+         * We need to adjust the input values for repeated types by copying the provided value to both of the
+         * repeated fields.
          *
          * The fix was provided by @craigh
          *
          * P.S. If we need to add another fix like this, we should move this out to dedicated "input fixer" classes.
          */
-        foreach ($form->all() as $child) {
-            $config = $child->getConfig();
-            $name = $child->getName();
-            if ($config->getType()->getInnerType() instanceof RepeatedType && $input->hasOption($name)) {
+        $this->fixInputForField($input, $form);
+
+        // use the original input as the submitted data
+        return $input;
+    }
+
+    private function fixInputForField(InputInterface $input, FormInterface $form, ?string $name = null): void
+    {
+        $config = $form->getConfig();
+        $isRepeatedField = $config->getType()->getInnerType() instanceof RepeatedType;
+        if (!$isRepeatedField && $config->getCompound()) {
+            foreach ($form->all() as $childName => $field) {
+                $subName = $name === null ? $childName : $name . '[' . $childName . ']';
+                $this->fixInputForField($input, $field, $subName);
+            }
+        } else {
+            $name = $name ?? $form->getName();
+            if ($isRepeatedField && $input->hasOption($name)) {
                 $input->setOption($name, [
                     $config->getOption('first_name') => $input->getOption($name),
                     $config->getOption('second_name') => $input->getOption($name),
                 ]);
             }
         }
-
-        // use the original input as the submitted data
-        return $input;
     }
 }
diff --git a/src/Console/Helper/FormHelper.php b/src/Console/Helper/FormHelper.php
@@ -36,7 +36,8 @@ public function getName(): string
      *
      * @return mixed
      */
-    public function interactUsingForm(
+    public function interactUsingNamedForm(
+        ?string $name,
         string $formType,
         InputInterface $input,
         OutputInterface $output,
@@ -46,8 +47,14 @@ public function interactUsingForm(
         $validFormFields = [];
 
         do {
-            $form = $this->formFactory->create($formType, $input, $options);
-            $form->setData($data);
+            if ($name === null) {
+                $form = $this->formFactory->create($formType, $input, $options);
+            } else {
+                $form = $this->formFactory->createNamed($name, $formType, $input, $options);
+            }
+            if ($data !== null) {
+                $form->setData($data);
+            }
 
             // if we are rerunning the form for invalid data we don't need the fields that are already valid.
             foreach ($validFormFields as $validFormField) {
@@ -90,6 +97,21 @@ function (FormInterface $formField) use (&$validFormFields) {
         return $data;
     }
 
+    /**
+     * @param mixed $data
+     *
+     * @return mixed
+     */
+    public function interactUsingForm(
+        string $formType,
+        InputInterface $input,
+        OutputInterface $output,
+        array $options = [],
+        $data = null
+    ) {
+        return $this->interactUsingNamedForm(null, $formType, $input, $output, $options, $data);
+    }
+
     protected function noErrorsCanBeFixed(FormErrorIterator $errors): bool
     {
         // none of the remaining errors is related to a value of a form field
diff --git a/src/Console/Input/FormBasedInputDefinitionFactory.php b/src/Console/Input/FormBasedInputDefinitionFactory.php
@@ -35,41 +35,27 @@ public function createForFormType(string $formType, array &$resources = []): Inp
 
         $inputDefinition = new InputDefinition();
 
-        if (!$form->getConfig()->getCompound()) {
-            $this->addFormToInputDefinition($form->getName(), $form, $inputDefinition);
-        }
-
-        foreach ($form->all() as $name => $field) {
-            $this->addFormToInputDefinition($name, $field, $inputDefinition);
-        }
+        $this->addFormToInputDefinition($inputDefinition, $form);
 
         return $inputDefinition;
     }
 
-    private function addFormToInputDefinition(string $name, FormInterface $form, InputDefinition $inputDefinition): void
-    {
-        if (!$this->isFormFieldSupported($form)) {
-            return;
-        }
-
-        $type = InputOption::VALUE_REQUIRED;
-        $default = $this->resolveDefaultValue($form);
-        $description = FormUtil::label($form);
-
-        $inputDefinition->addOption(new InputOption($name, null, $type, $description, $default));
-    }
-
-    private function isFormFieldSupported(FormInterface $field): bool
+    private function addFormToInputDefinition(InputDefinition $inputDefinition, FormInterface $form, ?string $name = null): void
     {
-        if ($field->getConfig()->getCompound()) {
-            if ($field->getConfig()->getType()->getInnerType() instanceof RepeatedType) {
-                return true;
+        $repeatedField = $form->getConfig()->getType()->getInnerType() instanceof RepeatedType;
+        if (!$repeatedField && $form->getConfig()->getCompound()) {
+            foreach ($form->all() as $childName => $field) {
+                $subName = $name === null ? $childName : $name . '[' . $childName . ']';
+                $this->addFormToInputDefinition($inputDefinition, $field, $subName);
             }
+        } else {
+            $name = $name ?? $form->getName();
+            $type = InputOption::VALUE_REQUIRED;
+            $default = $this->resolveDefaultValue($form);
+            $description = FormUtil::label($form);
 
-            return false;
+            $inputDefinition->addOption(new InputOption($name, null, $type, $description, $default));
         }
-
-        return true;
     }
 
     private function resolveDefaultValue(FormInterface $field): string | bool | int | float | array | null
diff --git a/src/Form/EventListener/UseInputOptionsAsEventDataEventSubscriber.php b/src/Form/EventListener/UseInputOptionsAsEventDataEventSubscriber.php
@@ -4,6 +4,7 @@
 
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\Extension\Core\Type\RepeatedType;
 use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\FormEvents;
 use Symfony\Component\Form\FormInterface;
@@ -27,14 +28,24 @@ public function onPreSubmit(FormEvent $event): void
         $event->setData($this->convertInputToSubmittedData($input, $event->getForm()));
     }
 
-    private function convertInputToSubmittedData(InputInterface $input, FormInterface $form): array
+    private function convertInputToSubmittedData(InputInterface $input, FormInterface $form, ?string $name = null): mixed
     {
-        $submittedData = [];
-
-        // we don't need to do this recursively, since command options are one-dimensional (or are they?)
-        foreach ($form->all() as $name => $field) {
+        $submittedData = null;
+        if ($form->getConfig()->getCompound()) {
+            $submittedData = [];
+            $repeatedField = $form->getConfig()->getType()->getInnerType() instanceof RepeatedType;
+            foreach ($form->all() as $childName => $field) {
+                if ($repeatedField) {
+                    $submittedData = $this->convertInputToSubmittedData($input, $field, $name ?? $form->getName());
+                } else {
+                    $subName = $name === null ? $childName : $name . '[' . $childName . ']';
+                    $submittedData[$childName] = $this->convertInputToSubmittedData($input, $field, $subName);
+                }
+            }
+        } else {
+            $name = $name ?? $form->getName();
             if ($input->hasOption($name)) {
-                $submittedData[$name] = $input->getOption($name);
+                return $input->getOption($name);
             }
         }
 
diff --git a/test/Form/NestedType.php b/test/Form/NestedType.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Matthias\SymfonyConsoleForm\Tests\Form;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class NestedType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('user', UserType::class)
+            ->add('anotherUser', UserType::class)
+            ->add('color', NonCompoundColorType::class);
+    }
+}
diff --git a/test/Form/UserType.php b/test/Form/UserType.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Matthias\SymfonyConsoleForm\Tests\Form;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\BirthdayType;
+use Symfony\Component\Form\Extension\Core\Type\DateType;
+use Symfony\Component\Form\Extension\Core\Type\PasswordType;
+use Symfony\Component\Form\Extension\Core\Type\RepeatedType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class UserType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('name', TextType::class)
+            ->add('lastname', TextType::class)
+            ->add('password', RepeatedType::class, [
+                'type' => PasswordType::class,
+                'invalid_message' => 'The password fields must match.',
+                'first_options' => ['label' => 'Admin Password'],
+                'second_options' => ['label' => 'Repeat Password'],
+            ]);
+    }
+}
diff --git a/test/config.yml b/test/config.yml
@@ -146,6 +146,14 @@ services:
         tags:
             - { name: console.command }
 
+    nested_command:
+        class: Matthias\SymfonyConsoleForm\Tests\Command\PrintFormDataCommand
+        arguments:
+            - Matthias\SymfonyConsoleForm\Tests\Form\NestedType
+            - nested
+        tags:
+            - { name: console.command }
+
 framework:
     form:
         csrf_protection: true

Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,6 @@`
`8`	`8`	`interface ConsoleFormFactory`
`9`	`9`	`{`
`10`	`10`	`public function create(string $formType, InputInterface $input, array $options = []): FormInterface;`
	`11`	`+`
	`12`	`+ public function createNamed(string $name, string $formType, InputInterface $input, array $options = []): FormInterface;`
`11`	`13`	`}`