[Form] fixed BC break with pre selection of choices with `ChoiceType` and its children #18180

HeahDude · 2016-03-15T16:46:54Z

Q	A
Branch	2.7+
Bugfix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#18173, #14712, #17789
License	MIT
Doc PR	-

f7eea72 reverts BC break introduced in [2.7] [Form] fix choice value "false" in ChoiceType #17760
58e8ed0 fixes pre selection of choice with model values such as false, null or empty string without BC break.

ChoiceType now always use ChoiceToValueTransformer or ChoicesToValuesTransformer depending on multiple option.
Hence CheckboxListMapper and RadioListMapper don't handle the transformation anymore.

HeahDude · 2016-03-15T16:49:14Z

src/Symfony/Component/Form/Tests/Extension/Core/Type/ChoiceTypeTest.php

@@ -1247,7 +1279,7 @@ public function testSubmitSingleExpandedWithEmptyChild()

        $form->submit('');

-        $this->assertNull($form->getData());
+        $this->assertEmpty($form->getData());


This looks like a collateral fix to me :)

@webmozart you need to read this test in particular, the others are just using an empty string instead of null as viewData but this one concerns the data.

Also this PR fixes the failed tests added originally in #17760 (ref https://github.com/symfony/symfony/pull/17760/files#diff-533d45d8bb41e489890ad12df7a1a4b7R163).

This time it just doesn't break the data transformers call :)

javiereguiluz · 2016-03-15T17:01:47Z

@HeahDude thanks for this fix (and for everything you do for the Form component).

Just a minor comment: it seems that the | Bug fix? | yes/no row disappeared from the PR description table (it is usually displayed after the Branch? row). This information is important for mergers. Could you please include it? Thanks!

HeahDude · 2016-03-15T17:02:43Z

@javiereguiluz done :)

This fixes "false" choice pre selection when `ChoiceType` is `expanded` and not `multiple`

HeahDude · 2016-03-16T10:29:11Z

src/Symfony/Component/Form/Extension/Core/DataMapper/RadioListMapper.php

    {
+        if (!is_string($choice)) {


Should I test null of force a string casting before throwing here ?

@webmozart I re-check the code and here the view data should always be a string.

In contrary, since mapsFormsToData() happens before transformation we should accept null there as well.

Do you agree or am I missing something ? Thanks.

HeahDude · 2016-03-16T10:31:02Z

Failures seem unrelated.

nakashu · 2016-03-17T11:49:20Z

👍

stof · 2016-03-17T11:52:02Z

src/Symfony/Component/Form/Extension/Core/DataMapper/CheckboxListMapper.php

        }

        foreach ($checkboxes as $checkbox) {
            $value = $checkbox->getConfig()->getOption('value');
-            $checkbox->setData(isset($valueMap[$value]) ? true : false);
+            $checkbox->setData(in_array($value, $choices, true) ? true : false);


the ternary operator turning a boolean into the same boolean looks weird to me

@stof I first felt the same, as you can see I did to match the previous style (in both checkbox and radio list mappers).

I guess it's a kind of explicit casting since this is where choices string values are converted to their boolean "selected" state values.

Thanks for the review.

But technically

in_array($value, $choices, true) ? true : false

is the same as

in_array($value, $choices, true)

or am I missing something? :)

I would indeed remove those unneeded ternary operators when the left side is already a bool.

Fair enough then.

HeahDude · 2016-03-17T13:18:20Z

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

-                ? new CheckboxListMapper($options['choice_list'])
-                : new RadioListMapper($options['choice_list']));
+                ? new CheckboxListMapper()
+                : new RadioListMapper());


Little detail, it's now short enough to be inlined here imho, isn't it ?

It could have been inlined before as well :)

HeahDude · 2016-03-17T13:36:48Z

Comments addressed.

HeahDude · 2016-03-17T16:15:21Z

TwigBridge dependency to EventDispatcher seems to be broken with php 7 build in travis.

xabbuh · 2016-03-19T09:23:38Z

@HeahDude Can you check if rebasing fixes the tests?

HeahDude · 2016-03-19T12:31:25Z

@xabbuh It did. Thanks!

webmozart · 2016-03-29T10:02:53Z

src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

-            }
-        } elseif ($options['multiple']) {
-            // <select> tag with "multiple" option
+        if ($options['multiple']) {


I don't fully understand why this is necessary. It seems to me the transformer and the data mappers are doing the same thing already. Can you add some explanation?

HeahDude · 2016-04-01T08:44:47Z

src/Symfony/Component/Form/Extension/Core/DataMapper/CheckboxListMapper.php

-                $e->getCode(),
-                $e
-            );
+            throw new UnexpectedTypeException($choices, 'array');


HeahDude · 2016-04-01T08:58:39Z

Ok there was a reason why I use assertEmpty, it's because $extraData in as empty array while $viewData is an empty string.

I fixed the assertions accordingly.

Rebased and squashed! Needs a final review here. Thanks!

HeahDude · 2016-04-01T09:24:03Z

There is a little failure in Doctrine bridge because it needs that PR to be merged first.

I've updated the dependency to 2.7.12 but travis does not seem to be aware of it yet.

Is it OK ?

xabbuh · 2016-04-01T10:57:54Z

src/Symfony/Bridge/Doctrine/composer.json

@@ -22,7 +22,7 @@
    "require-dev": {
        "symfony/stopwatch": "~2.2",
        "symfony/dependency-injection": "~2.2",
-        "symfony/form": "~2.7,>=2.7.1",
+        "symfony/form": "~2.7,>=2.7.12",


Can you try ~2.7.12|~2.8.5 please?

HeahDude · 2016-04-01T11:16:56Z

@xabbuh Done, let's wait & see :)

HeahDude · 2016-04-01T11:21:48Z

Nope :(

HeahDude · 2016-04-01T11:26:05Z

@xabbuh Can this be related to the last releases messed tags ?

xabbuh · 2016-04-01T11:44:43Z

@HeahDude This looks good now (the deps=low job is passing).

HeahDude · 2016-04-01T11:46:48Z

Great!

dmaicher · 2016-04-08T16:47:50Z

Any news here? Waiting for this fix so I can upgrade to Symfony 2.8.* :)

closes symfony#18173. This reverts commit 8f918e5.

fixes symfony#14712 and symfony#17789. `ChoiceType` now always use `ChoiceToValueTransformer` or `ChoicesToValuesTransformer` depending on `multiple` option. Hence `CheckboxListMapper` and `RadioListMapper` don’t handle the transformation anymore. Fixes pre selection of choice with model values such as `null`, `false` or empty string.

fabpot · 2016-04-28T09:51:24Z

Thank you @HeahDude.

…ChoiceType` and its children (HeahDude) This PR was merged into the 2.7 branch. Discussion ---------- [Form] fixed BC break with pre selection of choices with `ChoiceType` and its children | Q | A | ------------- | --- | Branch | 2.7+ | Bugfix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #18173, #14712, #17789 | License | MIT | Doc PR | - - f7eea72 reverts BC break introduced in #17760 - 58e8ed0 fixes pre selection of choice with model values such as `false`, `null` or empty string without BC break. `ChoiceType` now always use `ChoiceToValueTransformer` or `ChoicesToValuesTransformer` depending on `multiple` option. Hence `CheckboxListMapper` and `RadioListMapper` don't handle the transformation anymore. Commits ------- ea5375c [Form] refactor CheckboxListMapper and RadioListMapper 71841c7 Revert "[Form] refactor `RadioListMapper::mapDataToForm()`"

This PR was submitted for the master branch but it was merged into the 3.0 branch instead (closes #18663). Discussion ---------- [Form] Fix tests added in #18180 | Q | A | ------------- | --- | Branch? | 3.0+ | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | ~ | License | MIT | Doc PR | ~ Commits ------- c45a435 [Form] Fix tests added in #18180

* 3.0: [Form] Fix tests added in #18180

HeahDude · 2016-04-28T17:36:04Z

@dmaicher, happy upgrade! :)

carsonbot added the Status: Needs Review label Mar 15, 2016

HeahDude reviewed Mar 15, 2016
View reviewed changes

HeahDude force-pushed the fix-form-radio_list_mapper branch 2 times, most recently from 137bf44 to 5cc6bb4 Compare March 15, 2016 16:55

javiereguiluz added the Form label Mar 15, 2016

javiereguiluz added the Bug label Mar 15, 2016

HeahDude force-pushed the fix-form-radio_list_mapper branch from 5cc6bb4 to 76e265c Compare March 15, 2016 17:19

dmaicher mentioned this pull request Mar 15, 2016

[Form] ChoiceType error since update to 2.7.10 #18173

Closed

HeahDude referenced this pull request Mar 16, 2016

[Form] refactor RadioListMapper::mapDataToForm()

8f918e5

This fixes "false" choice pre selection when `ChoiceType` is `expanded` and not `multiple`

HeahDude force-pushed the fix-form-radio_list_mapper branch from 76e265c to 01b8101 Compare March 16, 2016 10:24

HeahDude reviewed Mar 16, 2016
View reviewed changes

stof reviewed Mar 17, 2016
View reviewed changes

HeahDude force-pushed the fix-form-radio_list_mapper branch 2 times, most recently from aa6fae7 to 695b5b1 Compare March 17, 2016 13:09

HeahDude reviewed Mar 17, 2016
View reviewed changes

HeahDude force-pushed the fix-form-radio_list_mapper branch 2 times, most recently from 3f2b402 to 103566e Compare March 17, 2016 13:35

HeahDude force-pushed the fix-form-radio_list_mapper branch from 103566e to 58e8ed0 Compare March 19, 2016 12:09

webmozart reviewed Mar 29, 2016
View reviewed changes

HeahDude reviewed Apr 1, 2016
View reviewed changes

HeahDude force-pushed the fix-form-radio_list_mapper branch from 58e8ed0 to b3fa216 Compare April 1, 2016 08:51

HeahDude force-pushed the fix-form-radio_list_mapper branch from b3fa216 to c77ae14 Compare April 1, 2016 09:12

HeahDude changed the title ~~[Form] fix pre selection of choices with ChoiceType~~ [Form] [BC Break] fix pre selection of choices with ChoiceType Apr 1, 2016

HeahDude changed the title ~~[Form] [BC Break] fix pre selection of choices with ChoiceType~~ [Form] fixed BC break with pre selection of choices with ChoiceType and its children Apr 1, 2016

xabbuh reviewed Apr 1, 2016
View reviewed changes

HeahDude added 2 commits April 9, 2016 15:28

Revert "[Form] refactor RadioListMapper::mapDataToForm()"

71841c7

closes symfony#18173. This reverts commit 8f918e5.

HeahDude force-pushed the fix-form-radio_list_mapper branch from 9d2dc37 to ea5375c Compare April 9, 2016 13:29

fabpot merged commit ea5375c into symfony:2.7 Apr 28, 2016

HeahDude deleted the fix-form-radio_list_mapper branch April 28, 2016 10:31

HeahDude added a commit to HeahDude/symfony that referenced this pull request Apr 28, 2016

[Form] Fix tests added in symfony#18180

41ce402

fabpot pushed a commit that referenced this pull request Apr 28, 2016

[Form] Fix tests added in #18180

c45a435

fabpot added a commit that referenced this pull request Apr 28, 2016

Merge branch '3.0'

731d7a6

* 3.0: [Form] Fix tests added in #18180

This was referenced Apr 29, 2016

Release v2.7.12 #18670

Merged

Release v2.8.5 #18674

Merged

Release v3.0.5 #18697

Merged

alexislefebvre mentioned this pull request May 9, 2016

Form: choice with expanded=true does not retain boolean values #15573

Closed

[Form] fixed BC break with pre selection of choices with ChoiceType and its children #18180

[Form] fixed BC break with pre selection of choices with ChoiceType and its children #18180

Conversation

HeahDude commented Mar 15, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javiereguiluz commented Mar 15, 2016

HeahDude commented Mar 15, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HeahDude commented Mar 16, 2016

nakashu commented Mar 17, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HeahDude commented Mar 17, 2016

HeahDude commented Mar 17, 2016

xabbuh commented Mar 19, 2016

HeahDude commented Mar 19, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HeahDude commented Apr 1, 2016

HeahDude commented Apr 1, 2016

Choose a reason for hiding this comment

HeahDude commented Apr 1, 2016

HeahDude commented Apr 1, 2016

HeahDude commented Apr 1, 2016

xabbuh commented Apr 1, 2016

HeahDude commented Apr 1, 2016

dmaicher commented Apr 8, 2016

fabpot commented Apr 28, 2016

HeahDude commented Apr 28, 2016

[Form] fixed BC break with pre selection of choices with `ChoiceType` and its children #18180

[Form] fixed BC break with pre selection of choices with `ChoiceType` and its children #18180