feature symfony#59871 [Form] Add support for displaying nested options in DebugCommand (yceruto)

This PR was merged into the 7.3 branch.

Discussion
----------

[Form] Add support for displaying nested options in `DebugCommand`

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | -
| License       | MIT

Addressing symfony#59618 (comment)

```bash
$ bin/console debug:form FooType baz --format=json
```
being `baz` a nested option of the `FooType`, output example in JSON format:
```json
{
    "required": false,
    "default": [],
    "is_lazy": false,
    "has_normalizer": false,
    "has_nested_options": true,
    "nested_options": {
        "foo": {
            "required": true,
            "default": true,
            "is_lazy": false,
            "has_normalizer": false,
            "has_nested_options": false
        },
        "bar": {
            "required": false,
            "default": true,
            "is_lazy": false,
            "has_normalizer": false,
            "has_nested_options": false
        }
    }
}
```
The new additions here are the `has_nested_options` and `nested_options` entries.

Cheers!

Commits
-------

2a6d2d4 Add support for displaying nested options in DebugCommand

Author: fabpot

src/Symfony/Component/Form/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Add support for displaying nested options in DebugCommand
+
 7.2
 ---
 

src/Symfony/Component/Form/Console/Descriptor/Descriptor.php

@@ -118,6 +118,7 @@ protected function getOptionDefinition(OptionsResolver $optionsResolver, string
             'allowedValues' => 'getAllowedValues',
             'normalizers' => 'getNormalizers',
             'deprecation' => 'getDeprecation',
+            'nestedOptions' => 'getNestedOptions',
         ];
 
         foreach ($map as $key => $method) {

src/Symfony/Component/Form/Console/Descriptor/JsonDescriptor.php

@@ -62,6 +62,12 @@ protected function describeResolvedFormType(ResolvedFormTypeInterface $resolvedF
     }
 
     protected function describeOption(OptionsResolver $optionsResolver, array $options): void
+    {
+        $data = $this->getOptionDescription($optionsResolver, $options);
+        $this->writeData($data, $options);
+    }
+
+    private function getOptionDescription(OptionsResolver $optionsResolver, array $options): array
     {
         $definition = $this->getOptionDefinition($optionsResolver, $options['option']);
 
@@ -90,7 +96,17 @@ protected function describeOption(OptionsResolver $optionsResolver, array $optio
         }
         $data['has_normalizer'] = isset($definition['normalizers']);
 
-        $this->writeData($data, $options);
+        if ($data['has_nested_options'] = isset($definition['nestedOptions'])) {
+            $nestedResolver = new OptionsResolver();
+            foreach ($definition['nestedOptions'] as $nestedOption) {
+                $nestedOption($nestedResolver, $optionsResolver);
+            }
+            foreach ($nestedResolver->getDefinedOptions() as $option) {
+                $data['nested_options'][$option] = $this->getOptionDescription($nestedResolver, ['option' => $option]);
+            }
+        }
+
+        return $data;
     }
 
     private function writeData(array $data, array $options): void

src/Symfony/Component/Form/Console/Descriptor/TextDescriptor.php

@@ -118,12 +118,19 @@ protected function describeOption(OptionsResolver $optionsResolver, array $optio
             'Allowed types' => 'allowedTypes',
             'Allowed values' => 'allowedValues',
             'Normalizers' => 'normalizers',
+            'Nested Options' => 'nestedOptions',
         ];
         $rows = [];
         foreach ($map as $label => $name) {
             $value = \array_key_exists($name, $definition) ? $dump($definition[$name]) : '-';
             if ('default' === $name && isset($definition['lazy'])) {
                 $value = "Value: $value\n\nClosure(s): ".$dump($definition['lazy']);
+            } elseif ('nestedOptions' === $name && isset($definition['nestedOptions'])) {
+                $nestedResolver = new OptionsResolver();
+                foreach ($definition['nestedOptions'] as $nestedOption) {
+                    $nestedOption($nestedResolver, $optionsResolver);
+                }
+                $value = $dump($nestedResolver->getDefinedOptions());
             }
 
             $rows[] = ["<info>$label</info>", $value];

src/Symfony/Component/Form/Tests/Command/DebugCommandTest.php

@@ -179,6 +179,8 @@ class:%s
                      }       %s
                    ]         %s
  ---------------- -----------%s
+  Nested Options   -         %s
+ ---------------- -----------%s
 
 TXT
             , $tester->getDisplay(true));

src/Symfony/Component/Form/Tests/Console/Descriptor/AbstractDescriptorTestCase.php

@@ -130,6 +130,11 @@ public static function getDescribeOptionTestData()
         $options['option'] = 'bar';
         $options['show_deprecated'] = true;
         yield [$resolvedType->getOptionsResolver(), $options, 'deprecated_option'];
+
+        $resolvedType = new ResolvedFormType(new FooType(), [], $parent);
+        $options['type'] = $resolvedType->getInnerType();
+        $options['option'] = 'baz';
+        yield [$resolvedType->getOptionsResolver(), $options, 'nested_option'];
     }
 
     abstract protected function getDescriptor();
@@ -172,5 +177,9 @@ public function configureOptions(OptionsResolver $resolver): void
         $resolver->setAllowedTypes('foo', 'string');
         $resolver->setAllowedValues('foo', ['bar', 'baz']);
         $resolver->setNormalizer('foo', fn (Options $options, $value) => (string) $value);
+        $resolver->setOptions('baz', function (OptionsResolver $baz) {
+            $baz->setRequired('foo');
+            $baz->setDefaults(['foo' => true, 'bar' => true]);
+        });
     }
 }

src/Symfony/Component/Form/Tests/Fixtures/Descriptor/default_option_with_normalizer.json

@@ -7,5 +7,6 @@
         "bool",
         "string"
     ],
-    "has_normalizer": true
+    "has_normalizer": true,
+    "has_nested_options": false
 }

src/Symfony/Component/Form/Tests/Fixtures/Descriptor/default_option_with_normalizer.txt

@@ -25,4 +25,6 @@ Symfony\Component\Form\Extension\Core\Type\ChoiceType (choice_translation_domain
                      }       %s
                    ]         %s
  ---------------- -----------%s
+  Nested Options   -         %s
+ ---------------- -----------%s
 

src/Symfony/Component/Form/Tests/Fixtures/Descriptor/deprecated_option.json

@@ -2,5 +2,6 @@
     "deprecated": true,
     "deprecation_message": "The option \"bar\" is deprecated.",
     "required": false,
-    "has_normalizer": false
+    "has_normalizer": false,
+    "has_nested_options": false
 }

src/Symfony/Component/Form/Tests/Fixtures/Descriptor/deprecated_option.txt

@@ -21,4 +21,6 @@ Symfony\Component\Form\Tests\Console\Descriptor\FooType (bar)
   Allowed values        -                                  
  --------------------- ----------------------------------- 
   Normalizers           -                                  
- --------------------- -----------------------------------
+ --------------------- ----------------------------------- 
+  Nested Options        -                                  
+ --------------------- -----------------------------------