Deprecate use of Locale validation constraint without setting "canonicalize" option to true

phansys · phansys · commit 2229cecd0ea4 · 2018-02-07T11:15:57.000-03:00
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Deprecated the `checkDNS` and `dnsMessage` options of the `Url` constraint. They will be removed in 5.0.
  * added a `values` option to the `Expression` constraint
+ * Deprecated use of `Locale` constraint without setting `true` at "canonicalize" option, which will be the default value in 5.0
 
 4.0.0
 -----
diff --git a/src/Symfony/Component/Validator/Constraints/Locale.php b/src/Symfony/Component/Validator/Constraints/Locale.php
@@ -29,4 +29,13 @@ class Locale extends Constraint
 
     public $message = 'This value is not a valid locale.';
     public $canonicalize = false;
+
+    public function __construct($options = null)
+    {
+        if (!($options['canonicalize'] ?? false)) {
+            @trigger_error('"canonicalize" option with value `false` is deprecated since Symfony 4.1 and will be removed in 5.0. Use "canonicalize"=>true instead.', E_USER_DEPRECATED);
+        }
+
+        parent::__construct($options);
+    }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/LocaleValidator.php b/src/Symfony/Component/Validator/Constraints/LocaleValidator.php
@@ -30,7 +30,7 @@ class LocaleValidator extends ConstraintValidator
     public function validate($value, Constraint $constraint)
     {
         if (!$constraint instanceof Locale) {
-            throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\Locale');
+            throw new UnexpectedTypeException($constraint, Locale::class);
         }
 
         if (null === $value || '' === $value) {
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/LocaleValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/LocaleValidatorTest.php
@@ -22,57 +22,134 @@ protected function createValidator()
         return new LocaleValidator();
     }
 
-    public function testNullIsValid()
+    /**
+     * @group legacy
+     * @expectedDeprecation "canonicalize" option with value `false` is deprecated since Symfony 4.1 and will be removed in 5.0. Use "canonicalize"=>true instead.
+     *
+     * @dataProvider getValidLocales
+     */
+    public function testLegacyNullIsValid()
     {
         $this->validator->validate(null, new Locale());
 
         $this->assertNoViolation();
     }
 
-    public function testEmptyStringIsValid()
+    public function testNullIsValid()
+    {
+        $this->validator->validate(null, new Locale(array('canonicalize' => true)));
+
+        $this->assertNoViolation();
+    }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation "canonicalize" option with value `false` is deprecated since Symfony 4.1 and will be removed in 5.0. Use "canonicalize"=>true instead.
+     *
+     * @dataProvider getValidLocales
+     */
+    public function testLegacyEmptyStringIsValid()
     {
         $this->validator->validate('', new Locale());
 
         $this->assertNoViolation();
     }
 
+    public function testEmptyStringIsValid()
+    {
+        $this->validator->validate('', new Locale(array('canonicalize' => true)));
+
+        $this->assertNoViolation();
+    }
+
     /**
+     * @group legacy
+     * @expectedDeprecation "canonicalize" option with value `false` is deprecated since Symfony 4.1 and will be removed in 5.0. Use "canonicalize"=>true instead.
      * @expectedException \Symfony\Component\Validator\Exception\UnexpectedTypeException
      */
-    public function testExpectsStringCompatibleType()
+    public function testLegacyExpectsStringCompatibleType()
     {
         $this->validator->validate(new \stdClass(), new Locale());
     }
 
     /**
+     * @expectedException \Symfony\Component\Validator\Exception\UnexpectedTypeException
+     */
+    public function testExpectsStringCompatibleType()
+    {
+        $this->validator->validate(new \stdClass(), new Locale(array('canonicalize' => true)));
+    }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation "canonicalize" option with value `false` is deprecated since Symfony 4.1 and will be removed in 5.0. Use "canonicalize"=>true instead.
+     *
      * @dataProvider getValidLocales
      */
-    public function testValidLocales($locale)
+    public function testLegacyValidLocales($locale)
     {
         $this->validator->validate($locale, new Locale());
 
         $this->assertNoViolation();
     }
 
+    /**
+     * @dataProvider getValidLocales
+     */
+    public function testValidLocales(string $locale, array $options)
+    {
+        $this->validator->validate($locale, new Locale($options));
+
+        $this->assertNoViolation();
+    }
+
     public function getValidLocales()
     {
         return array(
-            array('en'),
-            array('en_US'),
-            array('pt'),
-            array('pt_PT'),
-            array('zh_Hans'),
-            array('fil_PH'),
+            array('en', array('canonicalize' => true)),
+            array('en_US', array('canonicalize' => true)),
+            array('pt', array('canonicalize' => true)),
+            array('pt_PT', array('canonicalize' => true)),
+            array('zh_Hans', array('canonicalize' => true)),
+            array('fil_PH', array('canonicalize' => true)),
+        );
+    }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation "canonicalize" option with value `false` is deprecated since Symfony 4.1 and will be removed in 5.0. Use "canonicalize"=>true instead.
+     * @dataProvider getLegacyInvalidLocales
+     */
+    public function testLegacyInvalidLocales($locale)
+    {
+        $constraint = new Locale(array(
+            'message' => 'myMessage',
+        ));
+
+        $this->validator->validate($locale, $constraint);
+
+        $this->buildViolation('myMessage')
+            ->setParameter('{{ value }}', '"'.$locale.'"')
+            ->setCode(Locale::NO_SUCH_LOCALE_ERROR)
+            ->assertRaised();
+    }
+
+    public function getLegacyInvalidLocales()
+    {
+        return array(
+            array('EN'),
+            array('foobar'),
         );
     }
 
     /**
      * @dataProvider getInvalidLocales
      */
-    public function testInvalidLocales($locale)
+    public function testInvalidLocales(string $locale)
     {
         $constraint = new Locale(array(
             'message' => 'myMessage',
+            'canonicalize' => true,
         ));
 
         $this->validator->validate($locale, $constraint);
@@ -86,12 +163,14 @@ public function testInvalidLocales($locale)
     public function getInvalidLocales()
     {
         return array(
-            array('EN'),
+            array('baz'),
             array('foobar'),
         );
     }
 
     /**
+     * @group legacy
+     * @expectedDeprecation "canonicalize" option with value `false` is deprecated since Symfony 4.1 and will be removed in 5.0. Use "canonicalize"=>true instead.
      * @dataProvider getUncanonicalizedLocales
      */
     public function testInvalidLocalesWithoutCanonicalization(string $locale)

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class LocaleValidator extends ConstraintValidator`
`30`	`30`	`public function validate($value, Constraint $constraint)`
`31`	`31`	`{`
`32`	`32`	`if (!$constraint instanceof Locale) {`
`33`		`- throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\Locale');`
	`33`	`+ throw new UnexpectedTypeException($constraint, Locale::class);`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`if (null === $value \|\| '' === $value) {`