feature #28473 [Validator] Check the BIC country with symfony/intl (sylfabre)

nicolas-grekas · nicolas-grekas · commit bf4d011b3d87 · 2018-09-20T14:02:31.000+02:00
This PR was merged into the 4.2-dev branch. Discussion ---------- [Validator] Check the BIC country with symfony/intl | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #28167 | License | MIT | Doc PR | N/A Check the BIC country code against the list from Intl component instead of a simple check alphabetical test. This PR uses the Intl component which is not part of the required dependencies of the Validator component (https://github.com/symfony/validator/blob/master/composer.json): `symfony/intl` is only required for dev. So I'm making a PR against master because it may break existing code. But `CountryValidator` does the same so it may not be an issue after all. Commits ------- 27bd3a8 [Validator] Check the BIC country with symfony/intl Fix #28167
diff --git a/src/Symfony/Component/Validator/Constraints/BicValidator.php b/src/Symfony/Component/Validator/Constraints/BicValidator.php
@@ -11,8 +11,10 @@
 
 namespace Symfony\Component\Validator\Constraints;
 
+use Symfony\Component\Intl\Intl;
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
  * @author Michael Hirschler <michael.vhirsch@gmail.com>
@@ -30,6 +32,10 @@ public function validate($value, Constraint $constraint)
             return;
         }
 
+        if (!is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {
+            throw new UnexpectedTypeException($value, 'string');
+        }
+
         $canonicalize = str_replace(' ', '', $value);
 
         // the bic must be either 8 or 11 characters long
@@ -63,7 +69,11 @@ public function validate($value, Constraint $constraint)
         }
 
         // next 2 letters must be alphabetic (country code)
-        if (!ctype_alpha(substr($canonicalize, 4, 2))) {
+        if (!class_exists(Intl::class)) {
+            throw new \LogicException('The "symfony/intl" component is required to use the Bic constraint.');
+        }
+        $countries = Intl::getRegionBundle()->getCountryNames();
+        if (!isset($countries[substr($canonicalize, 4, 2)])) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))
                 ->setCode(Bic::INVALID_COUNTRY_CODE_ERROR)
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/BicValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/BicValidatorTest.php
@@ -36,6 +36,14 @@ public function testEmptyStringIsValid()
         $this->assertNoViolation();
     }
 
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\UnexpectedTypeException
+     */
+    public function testExpectsStringCompatibleType()
+    {
+        $this->validator->validate(new \stdClass(), new Bic());
+    }
+
     /**
      * @dataProvider getValidBics
      */
@@ -92,6 +100,7 @@ public function getInvalidBics()
             array('DEUT12HH', Bic::INVALID_COUNTRY_CODE_ERROR),
             array('DSBAC6BXSHA', Bic::INVALID_COUNTRY_CODE_ERROR),
             array('DSBA5NBXSHA', Bic::INVALID_COUNTRY_CODE_ERROR),
+            array('DSBAAABXSHA', Bic::INVALID_COUNTRY_CODE_ERROR),
 
             // branch code error
             array('THISSVAL1D]', Bic::INVALID_CHARACTERS_ERROR),
