[Form][OptionsResolver] Show deprecated options definition on debug:form command #27667

yceruto · 2018-06-20T23:12:04Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

Next move after #27277.

It will look like this:

Use --show-deprecated option to show form types with deprecated options (example):

Use --show-deprecated option to show deprecated options of the given form type (example):

Deprecated option (example):

linaori · 2018-06-21T07:16:44Z

Will it be possible to use this command to find all form types that have a deprecated option, and see which of those options are deprecated per type? That would make fixing them a walk in the park!

yceruto · 2018-06-21T12:56:02Z

@iltar sure, I'll add an option --show-deprecated to filter the result on debug:form and debug:form <type>.

Status: Needs Work

yceruto · 2018-06-24T22:21:52Z

Added --show-deprecated option to the comand:

Use the --show-deprecated option to display form types with deprecated options or the deprecated options of the given form type:

php %command.full_name% --show-deprecated
php %command.full_name% ChoiceType --show-deprecated

Status: Needs Review

(Travis failures aren't related)

yceruto · 2018-07-07T12:36:06Z

Any update about this?

@ogizanagi you're working on this command in the past, so will be great to have your opinion on this! thanks. :)

ogizanagi

Makes sense. Thanks @yceruto for working on this!

ogizanagi · 2018-07-07T16:42:50Z

src/Symfony/Component/OptionsResolver/Debug/OptionsResolverIntrospector.php

+    /**
+     * @return string|\Closure
+     *
+     * @throws NoConfigurationException on no configured normalizer


on no configured deprecation

ogizanagi · 2018-07-15T12:23:04Z

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

        return $definition;
    }

+    protected function filterTypesByDeprecated(array $types): array


To be consistent with current code, should this rather live in the command and pass deprecated types & options to the descriptor as $options, so the descriptors' responsibility sticks to handling output?

I agree, but in that case should we to move collectOptions(), getParentOptionsResolver(), etc, too?

I guess it's okay as we aim to describe OptionResolver and ResolvedFormTypeInterface instances. What is a bit weird here to me is injecting the form registry as an option.
But no strong opinion.

Okay, done.

ogizanagi · 2018-07-15T12:35:12Z

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

+        for ($i = 0; $i < $count; ++$i) {
+            $cells = array();
+            foreach (array_keys($headers) as $group) {
+                if (isset($options[$group][$i])) {


Could be simplified a bit I guess:

diff --git a/src/Symfony/Component/Form/Console/Descriptor/TextDescriptor.php b/src/Symfony/Component/Form/Console/Descriptor/TextDescriptor.php index 1e63aa0c68..3702d2f6b1 100644 --- a/src/Symfony/Component/Form/Console/Descriptor/TextDescriptor.php +++ b/src/Symfony/Component/Form/Console/Descriptor/TextDescriptor.php @@ -130,17 +130,12 @@ class TextDescriptor extends Descriptor for ($i = 0; $i < $count; ++$i) { $cells = array(); foreach (array_keys($headers) as $group) { - if (isset($options[$group][$i])) { - $option = $options[$group][$i]; - - if (\is_string($option) && \in_array($option, $this->requiredOptions, true)) { - $option .= ' <info>(required)</info>'; - } - - $cells[] = $option; - } else { - $cells[] = null; + $option = $options[$group][$i] ?? null; + if (\is_string($option) && \in_array($option, $this->requiredOptions, true)) { + $option .= ' <info>(required)</info>'; } + + $cells[] = $option; } $tableRows[] = $cells; }

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

yceruto · 2018-07-15T18:36:08Z

Thanks for the review @ogizanagi! I've fixed most comments. (AppVeyor & Travis failures are unrelated)

yceruto · 2018-07-30T20:19:29Z

Rebased and ready.

fabpot

with minor comments

fabpot · 2018-09-04T10:02:56Z

src/Symfony/Component/Form/Command/DebugCommand.php

@@ -58,6 +58,7 @@ protected function configure()
            ->setDefinition(array(
                new InputArgument('class', InputArgument::OPTIONAL, 'The form type class'),
                new InputArgument('option', InputArgument::OPTIONAL, 'The form type option'),
+                new InputOption('show-deprecated', null, InputOption::VALUE_NONE, 'Used to show deprecated options in form types'),


Display deprecated options in form types

fabpot · 2018-09-04T10:03:08Z

src/Symfony/Component/Form/Command/DebugCommand.php

@@ -75,6 +76,11 @@ protected function configure()

  <info>php %command.full_name% ChoiceType choice_value</info>

+Use the <info>--show-deprecated</info> option to display form types with deprecated options or the deprecated options of the given form type:


Should be cut at around 80 chars

yceruto · 2018-09-04T14:34:26Z

@fabpot comments addressed, thanks! (AppVeyor failure is unrelated)

fabpot · 2018-09-04T15:16:20Z

Thank you @yceruto.

…tion on debug:form command (yceruto) This PR was merged into the 4.2-dev branch. Discussion ---------- [Form][OptionsResolver] Show deprecated options definition on debug:form command | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Next move after #27277. It will look like this: Use `--show-deprecated` option to show form types with deprecated options (example): ![debug_types_with_deprecated_options](https://user-images.githubusercontent.com/2028198/41823977-970c7c98-77d6-11e8-9e97-30dcedc316ac.png) Use `--show-deprecated` option to show deprecated options of the given form type (example): ![debug_deprecated_options_from_type](https://user-images.githubusercontent.com/2028198/41823980-a4d6bd8e-77d6-11e8-95ed-39926ffd6235.png) Deprecated option (example): ![debug_deprecated_option_text](https://user-images.githubusercontent.com/2028198/41689091-04e6b7dc-74bd-11e8-87d0-90729eac4bb3.png) ![debug_deprecated_option_json](https://user-images.githubusercontent.com/2028198/41689105-142b5c5c-74bd-11e8-9232-1f30237bcf69.png) Commits ------- 87c209d Show deprecated options definition on debug:form command

carsonbot added Status: Needs Review Form OptionsResolver Feature labels Jun 20, 2018

yceruto force-pushed the debug_deprecated_options branch 2 times, most recently from b252112 to e2e05f9 Compare June 21, 2018 01:23

nicolas-grekas added this to the next milestone Jun 21, 2018

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jun 21, 2018

yceruto force-pushed the debug_deprecated_options branch 2 times, most recently from 69cf93f to 150c14d Compare June 24, 2018 21:45

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jun 24, 2018

yceruto force-pushed the debug_deprecated_options branch 2 times, most recently from a42dfa2 to 64f444b Compare July 3, 2018 11:06

ogizanagi self-requested a review July 7, 2018 16:36

ogizanagi reviewed Jul 15, 2018

View reviewed changes

yceruto force-pushed the debug_deprecated_options branch from 64f444b to f02ee12 Compare July 15, 2018 18:31

yceruto force-pushed the debug_deprecated_options branch 4 times, most recently from 676e79d to cde4c4b Compare July 15, 2018 21:07

yceruto force-pushed the debug_deprecated_options branch 2 times, most recently from b2cf002 to 856578c Compare July 30, 2018 19:49

fabpot approved these changes Sep 4, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 4, 2018

Show deprecated options definition on debug:form command

87c209d

yceruto force-pushed the debug_deprecated_options branch from 856578c to 87c209d Compare September 4, 2018 13:42

fabpot merged commit 87c209d into symfony:master Sep 4, 2018

yceruto deleted the debug_deprecated_options branch September 4, 2018 15:29

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

ogizanagi mentioned this pull request Aug 12, 2020

[Validator] Debug validator command #37706

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Form][OptionsResolver] Show deprecated options definition on debug:form command #27667

[Form][OptionsResolver] Show deprecated options definition on debug:form command #27667

yceruto commented Jun 20, 2018 •

edited

Loading

linaori commented Jun 21, 2018

yceruto commented Jun 21, 2018 •

edited

Loading

yceruto commented Jun 24, 2018

yceruto commented Jul 7, 2018

ogizanagi left a comment

ogizanagi Jul 7, 2018

ogizanagi Jul 15, 2018

yceruto Jul 15, 2018

ogizanagi Jul 15, 2018 •

edited

Loading

yceruto Jul 15, 2018 •

edited

Loading

ogizanagi Jul 15, 2018 •

edited

Loading

yceruto commented Jul 15, 2018 •

edited

Loading

yceruto commented Jul 30, 2018

fabpot left a comment

fabpot Sep 4, 2018

fabpot Sep 4, 2018

yceruto commented Sep 4, 2018

fabpot commented Sep 4, 2018

		@@ -75,6 +76,11 @@ protected function configure()

		<info>php %command.full_name% ChoiceType choice_value</info>

		Use the <info>--show-deprecated</info> option to display form types with deprecated options or the deprecated options of the given form type:

[Form][OptionsResolver] Show deprecated options definition on debug:form command #27667

[Form][OptionsResolver] Show deprecated options definition on debug:form command #27667

Conversation

yceruto commented Jun 20, 2018 • edited Loading

linaori commented Jun 21, 2018

yceruto commented Jun 21, 2018 • edited Loading

yceruto commented Jun 24, 2018

yceruto commented Jul 7, 2018

ogizanagi left a comment

Choose a reason for hiding this comment

ogizanagi Jul 7, 2018

Choose a reason for hiding this comment

ogizanagi Jul 15, 2018

Choose a reason for hiding this comment

yceruto Jul 15, 2018

Choose a reason for hiding this comment

ogizanagi Jul 15, 2018 • edited Loading

Choose a reason for hiding this comment

yceruto Jul 15, 2018 • edited Loading

Choose a reason for hiding this comment

ogizanagi Jul 15, 2018 • edited Loading

Choose a reason for hiding this comment

yceruto commented Jul 15, 2018 • edited Loading

yceruto commented Jul 30, 2018

fabpot left a comment

Choose a reason for hiding this comment

fabpot Sep 4, 2018

Choose a reason for hiding this comment

fabpot Sep 4, 2018

Choose a reason for hiding this comment

yceruto commented Sep 4, 2018

fabpot commented Sep 4, 2018

yceruto commented Jun 20, 2018 •

edited

Loading

yceruto commented Jun 21, 2018 •

edited

Loading

ogizanagi Jul 15, 2018 •

edited

Loading

yceruto Jul 15, 2018 •

edited

Loading

ogizanagi Jul 15, 2018 •

edited

Loading

yceruto commented Jul 15, 2018 •

edited

Loading