[Validator] Add alpha3 option to country constraint

maxperrimond · fabpot · commit d6f34a5df638 · 2020-01-31T09:29:00.000+01:00
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * added the `Hostname` constraint and validator
+ * added option `alpha3` to `Country` constraint
 
 5.0.0
 -----
diff --git a/src/Symfony/Component/Validator/Constraints/Country.php b/src/Symfony/Component/Validator/Constraints/Country.php
@@ -30,6 +30,7 @@ class Country extends Constraint
     ];
 
     public $message = 'This value is not a valid country.';
+    public $alpha3 = false;
 
     public function __construct($options = null)
     {
diff --git a/src/Symfony/Component/Validator/Constraints/CountryValidator.php b/src/Symfony/Component/Validator/Constraints/CountryValidator.php
@@ -43,7 +43,7 @@ public function validate($value, Constraint $constraint)
 
         $value = (string) $value;
 
-        if (!Countries::exists($value)) {
+        if ($constraint->alpha3 ? !Countries::alpha3CodeExists($value) : !Countries::exists($value)) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))
                 ->setCode(Country::NO_SUCH_COUNTRY_ERROR)
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/CountryValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/CountryValidatorTest.php
@@ -103,6 +103,55 @@ public function getInvalidCountries()
         ];
     }
 
+    /**
+     * @dataProvider getValidAlpha3Countries
+     */
+    public function testValidAlpha3Countries($country)
+    {
+        $this->validator->validate($country, new Country([
+            'alpha3' => true,
+        ]));
+
+        $this->assertNoViolation();
+    }
+
+    public function getValidAlpha3Countries()
+    {
+        return [
+            ['GBR'],
+            ['ATA'],
+            ['MYT'],
+        ];
+    }
+
+    /**
+     * @dataProvider getInvalidAlpha3Countries
+     */
+    public function testInvalidAlpha3Countries($country)
+    {
+        $constraint = new Country([
+            'alpha3' => true,
+            'message' => 'myMessage',
+        ]);
+
+        $this->validator->validate($country, $constraint);
+
+        $this->buildViolation('myMessage')
+            ->setParameter('{{ value }}', '"'.$country.'"')
+            ->setCode(Country::NO_SUCH_COUNTRY_ERROR)
+            ->assertRaised();
+    }
+
+    public function getInvalidAlpha3Countries()
+    {
+        return [
+            ['foobar'],
+            ['GB'],
+            ['ZZZ'],
+            ['zzz'],
+        ];
+    }
+
     public function testValidateUsingCountrySpecificLocale()
     {
         // in order to test with "en_GB"

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ class Country extends Constraint`
`30`	`30`	`];`
`31`	`31`
`32`	`32`	`public $message = 'This value is not a valid country.';`
	`33`	`+ public $alpha3 = false;`
`33`	`34`
`34`	`35`	`public function __construct($options = null)`
`35`	`36`	`{`