fix: Generate valid BIC/SWIFT numbers (#902)

- swiftBicNumber now accepts an optional $countryCode argument to localize the generated value
- using Symfony Validator in tests

CHANGELOG.md

@@ -4,7 +4,8 @@
 
 - Removed domain `gmail.com.au` from `Provider\en_AU\Internet` (#886)
 - Refreshed ISO currencies (#919)
--
+- Generate valid BIC/SWIFT numnbers (#902)
+
 ## [2024-11-09, v1.24.0](https://github.com/FakerPHP/Faker/compare/v1.23.1..v1.24.0)
 
 - Fix internal deprecations in Doctrine's populator by @gnutix in (#889)

src/Faker/Generator.php

@@ -443,7 +443,7 @@
  *
  * @property string $swiftBicNumber
  *
- * @method string swiftBicNumber()
+ * @method string swiftBicNumber($countryCode = null)
  *
  * @property string $name
  *

src/Faker/Provider/Payment.php

@@ -297,16 +297,22 @@ public static function iban($countryCode = null, $prefix = '', $length = null)
     }
 
     /**
-     * Return the String of a SWIFT/BIC number
+     * Return the String of a SWIFT/BIC number.
      *
      * @example 'RZTIAT22263'
      *
      * @see    http://en.wikipedia.org/wiki/ISO_9362
      *
+     * @param null|string $countryCode ISO 3166-1 alpha-2 country code
+     *
      * @return string Swift/Bic number
      */
-    public static function swiftBicNumber()
+    public static function swiftBicNumber($countryCode = null)
     {
-        return self::regexify('^([A-Z]){4}([A-Z]){2}([0-9A-Z]){2}([0-9A-Z]{3})?$');
+        if (!is_null($countryCode) && 1 !== preg_match('/^[A-Z]{2}$/', $countryCode)) {
+            throw new \InvalidArgumentException('Invalid country code.');
+        }
+
+        return self::regexify('^([A-Z]){4}' . ($countryCode ?? Miscellaneous::countryCode()) . '([0-9A-Z]){2}([0-9A-Z]{3})?$');
     }
 }

test/Faker/Provider/PaymentTest.php

@@ -9,6 +9,8 @@
 use Faker\Provider\Payment as PaymentProvider;
 use Faker\Provider\Person as PersonProvider;
 use Faker\Test\TestCase;
+use Symfony\Component\Validator\Constraints as Assert;
+use Symfony\Component\Validator\Validation;
 
 /**
  * @group legacy
@@ -197,4 +199,20 @@ protected function getProviders(): iterable
 
         yield new PaymentProvider($this->faker);
     }
+
+    public function testSwiftBicNumber(): void
+    {
+        self::assertMatchesRegularExpression(
+            '/^([A-Z]){4}([A-Z]){2}([0-9A-Z]){2}([0-9A-Z]{3})?$/',
+            $this->faker->swiftBicNumber()
+        );
+    }
+
+    public function testLocalizedSwiftBicNumber(): void
+    {
+        self::assertMatchesRegularExpression(
+            '/^([A-Z]){4}DE([0-9A-Z]){2}([0-9A-Z]{3})?$/',
+            $this->faker->swiftBicNumber('DE')
+        );
+    }
 }