feature #19257 [Validator][Choice] Make strict the default option for choice validation (peterrehm)

This PR was squashed before being merged into the 3.2-dev branch (closes #19257).

Discussion
----------

[Validator][Choice] Make strict the default option for choice validation

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

This is just the WIP as there are two options.

1. Just change default which would only possible to introduce in 4.x or in 3.2 if this BC break is considered as acceptable

2. Add a new option e.g. `strictComparison` which defaults to true in 4.x and deprecate the usage of the strict option for 3.2.

3. Just deprecate strict = false and remove the option but I would be against that as we remove flexibility which might be wanted.

As per discussion I went ahead with option 3. We can then still decide if we want to remove the option entirely or eventually reenable setting strict to false in a later release.

Commits
-------

177c513 [Validator][Choice] Make strict the default option for choice validation

Author: fabpot

UPGRADE-3.2.md

@@ -94,6 +94,22 @@ Validator
    }
    ```
 
+ * Setting the strict option of the `Choice` Constraint to `false` has been
+   deprecated and the option will be changed to `true` as of 4.0.
+
+   ```php
+   // ...
+   use Symfony\Component\Validator\Constraints as Assert;
+
+   class MyEntity
+   {
+       /**
+        * @Assert\Choice(choices={"MR", "MRS"}, strict=true)
+        */
+       private $salutation;
+   }
+   ```
+
 Yaml
 ----
 

UPGRADE-4.0.md

@@ -290,3 +290,7 @@ Validator
        // ...
    }
    ```
+   
+ * The default value of the strict option of the `Choice` Constraint has been
+   changed to `true` as of 4.0. If you need the the previous behaviour ensure to 
+   set the option to `false`.

src/Symfony/Component/Validator/Constraints/ChoiceValidator.php

@@ -57,6 +57,10 @@ public function validate($value, Constraint $constraint)
             $choices = $constraint->choices;
         }
 
+        if (false === $constraint->strict) {
+            @trigger_error('Setting the strict option of the Choice constraint to false is deprecated since version 3.2 and will be removed in 4.0.', E_USER_DEPRECATED);
+        }
+
         if ($constraint->multiple) {
             foreach ($value as $_value) {
                 if (!in_array($_value, $choices, $constraint->strict)) {

src/Symfony/Component/Validator/Tests/Constraints/ChoiceValidatorTest.php

@@ -40,14 +40,23 @@ public function testExpectArrayIfMultipleIsTrue()
         $constraint = new Choice(array(
             'choices' => array('foo', 'bar'),
             'multiple' => true,
+            'strict' => true,
         ));
 
         $this->validator->validate('asdf', $constraint);
     }
 
     public function testNullIsValid()
     {
-        $this->validator->validate(null, new Choice(array('choices' => array('foo', 'bar'))));
+        $this->validator->validate(
+            null,
+            new Choice(
+                array(
+                    'choices' => array('foo', 'bar'),
+                    'strict' => true,
+                )
+            )
+        );
 
         $this->assertNoViolation();
     }
@@ -57,20 +66,20 @@ public function testNullIsValid()
      */
     public function testChoicesOrCallbackExpected()
     {
-        $this->validator->validate('foobar', new Choice());
+        $this->validator->validate('foobar', new Choice(array('strict' => true)));
     }
 
     /**
      * @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
      */
     public function testValidCallbackExpected()
     {
-        $this->validator->validate('foobar', new Choice(array('callback' => 'abcd')));
+        $this->validator->validate('foobar', new Choice(array('callback' => 'abcd', 'strict' => true)));
     }
 
     public function testValidChoiceArray()
     {
-        $constraint = new Choice(array('choices' => array('foo', 'bar')));
+        $constraint = new Choice(array('choices' => array('foo', 'bar'), 'strict' => true));
 
         $this->validator->validate('bar', $constraint);
 
@@ -79,7 +88,7 @@ public function testValidChoiceArray()
 
     public function testValidChoiceCallbackFunction()
     {
-        $constraint = new Choice(array('callback' => __NAMESPACE__.'\choice_callback'));
+        $constraint = new Choice(array('callback' => __NAMESPACE__.'\choice_callback', 'strict' => true));
 
         $this->validator->validate('bar', $constraint);
 
@@ -88,9 +97,14 @@ public function testValidChoiceCallbackFunction()
 
     public function testValidChoiceCallbackClosure()
     {
-        $constraint = new Choice(array('callback' => function () {
-            return array('foo', 'bar');
-        }));
+        $constraint = new Choice(
+            array(
+                'strict' => true,
+                'callback' => function () {
+                    return array('foo', 'bar');
+                },
+            )
+        );
 
         $this->validator->validate('bar', $constraint);
 
@@ -99,7 +113,7 @@ public function testValidChoiceCallbackClosure()
 
     public function testValidChoiceCallbackStaticMethod()
     {
-        $constraint = new Choice(array('callback' => array(__CLASS__, 'staticCallback')));
+        $constraint = new Choice(array('callback' => array(__CLASS__, 'staticCallback'), 'strict' => true));
 
         $this->validator->validate('bar', $constraint);
 
@@ -111,7 +125,7 @@ public function testValidChoiceCallbackContextMethod()
         // search $this for "staticCallback"
         $this->setObject($this);
 
-        $constraint = new Choice(array('callback' => 'staticCallback'));
+        $constraint = new Choice(array('callback' => 'staticCallback', 'strict' => true));
 
         $this->validator->validate('bar', $constraint);
 
@@ -123,6 +137,7 @@ public function testMultipleChoices()
         $constraint = new Choice(array(
             'choices' => array('foo', 'bar', 'baz'),
             'multiple' => true,
+            'strict' => true,
         ));
 
         $this->validator->validate(array('baz', 'bar'), $constraint);
@@ -135,6 +150,7 @@ public function testInvalidChoice()
         $constraint = new Choice(array(
             'choices' => array('foo', 'bar'),
             'message' => 'myMessage',
+            'strict' => true,
         ));
 
         $this->validator->validate('baz', $constraint);
@@ -152,6 +168,7 @@ public function testInvalidChoiceEmptyChoices()
             // the DB or the model
             'choices' => array(),
             'message' => 'myMessage',
+            'strict' => true,
         ));
 
         $this->validator->validate('baz', $constraint);
@@ -168,6 +185,7 @@ public function testInvalidChoiceMultiple()
             'choices' => array('foo', 'bar'),
             'multipleMessage' => 'myMessage',
             'multiple' => true,
+            'strict' => true,
         ));
 
         $this->validator->validate(array('foo', 'baz'), $constraint);
@@ -186,6 +204,7 @@ public function testTooFewChoices()
             'multiple' => true,
             'min' => 2,
             'minMessage' => 'myMessage',
+            'strict' => true,
         ));
 
         $value = array('foo');
@@ -209,6 +228,7 @@ public function testTooManyChoices()
             'multiple' => true,
             'max' => 2,
             'maxMessage' => 'myMessage',
+            'strict' => true,
         ));
 
         $value = array('foo', 'bar', 'moo');
@@ -225,6 +245,9 @@ public function testTooManyChoices()
             ->assertRaised();
     }
 
+    /**
+     * @group legacy
+     */
     public function testNonStrict()
     {
         $constraint = new Choice(array(
@@ -266,6 +289,9 @@ public function testStrictDisallowsDifferentType()
             ->assertRaised();
     }
 
+    /**
+     * @group legacy
+     */
     public function testNonStrictWithMultipleChoices()
     {
         $constraint = new Choice(array(