deprecate the "allowEmptyString" option

xabbuh · xabbuh · commit 8d40237f310c · 2020-05-20T20:05:50.000+02:00
diff --git a/UPGRADE-5.2.md b/UPGRADE-5.2.md
@@ -0,0 +1,7 @@
+UPGRADE FROM 5.1 to 5.2
+=======================
+
+Validator
+---------
+
+ * Deprecated the `allowEmptyString` option of the `Length` constraint.
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -113,6 +113,11 @@ Security
  * Removed `LogoutSuccessHandlerInterface` and `LogoutHandlerInterface`, register a listener on the `LogoutEvent` event instead.
  * Removed `DefaultLogoutSuccessHandler` in favor of `DefaultLogoutListener`.
 
+Validator
+---------
+
+ * Removed the `allowEmptyString` option from the `Length` constraint.
+
 Yaml
 ----
 
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.2.0
+-----
+
+ * deprecated the `allowEmptyString` option of the `Length` constraint
+
 5.1.0
 -----
 
diff --git a/src/Symfony/Component/Validator/Constraints/Length.php b/src/Symfony/Component/Validator/Constraints/Length.php
@@ -64,5 +64,9 @@ public function __construct($options = null)
         if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
             throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', get_debug_type($this->normalizer)));
         }
+
+        if (isset($options['allowEmptyString'])) {
+            trigger_deprecation('symfony/validator', '5.2', sprintf('The "allowEmptyString" option of the "%s" constraint is deprecated.', self::class));
+        }
     }
 }
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/LengthTest.php b/src/Symfony/Component/Validator/Tests/Constraints/LengthTest.php
@@ -12,13 +12,16 @@
 namespace Symfony\Component\Validator\Tests\Constraints;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\Validator\Constraints\Length;
 
 /**
  * @author Renan Taranto <renantaranto@gmail.com>
  */
 class LengthTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     public function testNormalizerCanBeSet()
     {
         $length = new Length(['min' => 0, 'max' => 10, 'normalizer' => 'trim']);
@@ -39,4 +42,23 @@ public function testInvalidNormalizerObjectThrowsException()
         $this->expectExceptionMessage('The "normalizer" option must be a valid callable ("stdClass" given).');
         new Length(['min' => 0, 'max' => 10, 'normalizer' => new \stdClass()]);
     }
+
+    /**
+     * @group legacy
+     * @dataProvider allowEmptyStringOptionData
+     */
+    public function testDoNotAllowEmptyStringWithoutMinLength(bool $value)
+    {
+        $this->expectDeprecation('Since symfony/validator 5.2: The "allowEmptyString" option of the "Symfony\Component\Validator\Constraints\Length" constraint is deprecated.');
+
+        new Length(['allowEmptyString' => $value, 'max' => 5]);
+    }
+
+    public function allowEmptyStringOptionData()
+    {
+        return [
+            [true],
+            [false],
+        ];
+    }
 }
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/LengthValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/LengthValidatorTest.php
@@ -29,6 +29,9 @@ public function testNullIsValid()
         $this->assertNoViolation();
     }
 
+    /**
+     * @group legacy
+     */
     public function testAllowEmptyString()
     {
         $this->validator->validate('', new Length(['value' => 6, 'allowEmptyString' => true]));

Original file line number	Diff line number	Diff line change
`@@ -64,5 +64,9 @@ public function __construct($options = null)`
`64`	`64`	`if (null !== $this->normalizer && !\is_callable($this->normalizer)) {`
`65`	`65`	`throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', get_debug_type($this->normalizer)));`
`66`	`66`	`}`
	`67`	`+`
	`68`	`+ if (isset($options['allowEmptyString'])) {`
	`69`	`+ trigger_deprecation('symfony/validator', '5.2', sprintf('The "allowEmptyString" option of the "%s" constraint is deprecated.', self::class));`
	`70`	`+ }`
`67`	`71`	`}`
`68`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,9 @@ public function testNullIsValid()`
`29`	`29`	`$this->assertNoViolation();`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ /**`
	`33`	`+ * @group legacy`
	`34`	`+ */`
`32`	`35`	`public function testAllowEmptyString()`
`33`	`36`	`{`
`34`	`37`	`$this->validator->validate('', new Length(['value' => 6, 'allowEmptyString' => true]));`