StripCountryCode to StripPrefix

brick · Sep 23, 2024 · 0913002 · 0913002
1 parent 6a111e0
commit 0913002
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 33 deletions.
diff --git a/src/FormatHelper/StripCountryCode.php → src/FormatHelper/StripPrefix.php b/src/FormatHelper/StripCountryCode.php → src/FormatHelper/StripPrefix.php
@@ -13,20 +13,22 @@
  * Thus providing you with the correct format without the country code prefix in it.
  *
  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Belgium
+ *
+ * @internal
  */
-trait StripCountryCode
+trait StripPrefix
 {
     /**
      * @param string $postcode
-     * @param int $validCountryCodeLength
+     * @param string $prefix
      * @return string
      */
-    public function stripCountryCode(string $postcode, int $validCountryCodeLength = 1): string
+    public function stripPrefix(string $postcode, string $prefix): string
     {
-        $code = substr((new \ReflectionClass($this))->getShortName(), 0, $validCountryCodeLength);
+        $prefixLength = strlen($prefix);
 
-        if (substr($postcode, 0, $validCountryCodeLength) === $code) {
-            $postcode = substr($postcode, $validCountryCodeLength);
+        if (substr($postcode, 0, $prefixLength) === $prefix) {
+            $postcode = substr($postcode, $prefixLength);
         }
 
         return $postcode;

diff --git a/src/Formatter/ATFormatter.php b/src/Formatter/ATFormatter.php
@@ -5,7 +5,7 @@
 namespace Brick\Postcode\Formatter;
 
 use Brick\Postcode\CountryPostcodeFormatter;
-use Brick\Postcode\FormatHelper\StripCountryCode;
+use Brick\Postcode\FormatHelper\StripPrefix;
 
 /**
  * Validates and formats postcodes in Austria.
@@ -17,11 +17,11 @@
  */
 class ATFormatter implements CountryPostcodeFormatter
 {
-    use StripCountryCode;
+    use StripPrefix;
 
     public function format(string $postcode) : ?string
     {
-        $postcode = $this->stripCountryCode($postcode);
+        $postcode = $this->stripPrefix($postcode, 'A');
 
         if (preg_match('/^[1-9][0-9]{3}$/', $postcode) !== 1) {
 

diff --git a/src/Formatter/BEFormatter.php b/src/Formatter/BEFormatter.php
@@ -5,7 +5,7 @@
 namespace Brick\Postcode\Formatter;
 
 use Brick\Postcode\CountryPostcodeFormatter;
-use Brick\Postcode\FormatHelper\StripCountryCode;
+use Brick\Postcode\FormatHelper\StripPrefix;
 
 /**
  * Validates and formats postcodes in Belgium.
@@ -17,11 +17,11 @@
  */
 class BEFormatter implements CountryPostcodeFormatter
 {
-    use StripCountryCode;
+    use StripPrefix;
 
     public function format(string $postcode) : ?string
     {
-        $postcode = $this->stripCountryCode($postcode);
+        $postcode = $this->stripPrefix($postcode, 'B');
 
         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
             return null;

diff --git a/src/Formatter/LUFormatter.php b/src/Formatter/LUFormatter.php
@@ -5,7 +5,7 @@
 namespace Brick\Postcode\Formatter;
 
 use Brick\Postcode\CountryPostcodeFormatter;
-use Brick\Postcode\FormatHelper\StripCountryCode;
+use Brick\Postcode\FormatHelper\StripPrefix;
 
 /**
  * Validates and formats postcodes in Luxembourg.
@@ -17,11 +17,11 @@
  */
 class LUFormatter implements CountryPostcodeFormatter
 {
-    use StripCountryCode;
+    use StripPrefix;
 
     public function format(string $postcode) : ?string
     {
-        $postcode = $this->stripCountryCode($postcode);
+        $postcode = $this->stripPrefix($postcode, 'L');
 
         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
             return null;

diff --git a/src/InvalidPostcodeException.php b/src/InvalidPostcodeException.php
@@ -36,11 +36,11 @@ public function getPostcode(): string
     }
 
     /**
-     * Get the country code associated with this exception.
+     * Get the country ISO2 code associated with this exception.
      *
      * @return string
      */
-    public function getCountryCode(): string
+    public function getCountry(): string
     {
         return $this->country;
     }

diff --git a/src/UnknownCountryException.php b/src/UnknownCountryException.php
@@ -23,11 +23,11 @@ public function __construct(string $country)
     }
 
     /**
-     * Get the unknown country code associated with this exception.
+     * Get the unknown country ISO2 code associated with this exception.
      *
      * @return string
      */
-    public function getCountryCode(): string
+    public function getCountry(): string
     {
         return $this->country;
     }

diff --git a/tests/Formatter/ATFormatterTest.php b/tests/Formatter/ATFormatterTest.php
@@ -37,6 +37,11 @@ public function providerFormat() : array
             ['ABCD', null],
             ['ABCDE', null],
             ['ABCDEF', null],
+
+            ['A-8084', '8084'],
+            ['a-8084', '8084'],
+            ['X-8084', null],
+            ['x-8084', null],
         ];
     }
 }
diff --git a/tests/Formatter/BEFormatterTest.php b/tests/Formatter/BEFormatterTest.php
@@ -36,6 +36,11 @@ public function providerFormat() : array
             ['ABCD', null],
             ['ABCDE', null],
             ['ABCDEF', null],
+
+            ['B-8084', '8084'],
+            ['b-8084', '8084'],
+            ['X-8084', null],
+            ['x-8084', null],
         ];
     }
 }
diff --git a/tests/Formatter/LUFormatterTest.php b/tests/Formatter/LUFormatterTest.php
@@ -34,6 +34,12 @@ public function providerFormat() : array
             ['ABC', null],
             ['ABCD', null],
             ['ABCDE', null],
+
+
+            ['L-8084', '8084'],
+            ['l-8084', '8084'],
+            ['X-8084', null],
+            ['x-8084', null],
         ];
     }
 }
diff --git a/tests/PostcodeFormatterTest.php b/tests/PostcodeFormatterTest.php
@@ -15,9 +15,6 @@
  */
 class PostcodeFormatterTest extends TestCase
 {
-    /**
-     * @throws InvalidPostcodeException
-     */
     public function testFormatUnknownCountry() : void
     {
         $formatter = new PostcodeFormatter();
@@ -33,7 +30,6 @@ public function testFormatUnknownCountry() : void
      * @param string $postcode
      *
      * @return void
-     * @throws UnknownCountryException
      */
     public function testFormatInvalidPostcode(string $country, string $postcode) : void
     {
@@ -53,9 +49,6 @@ public function providerFormatInvalidPostcode() : array
             ['FR', '123456'],
             ['GB', 'ABCDEFG'],
             ['PL', '12*345'],
-            ['AT', 'T-8084'],
-            ['BE', 'E-1245'],
-            ['LU', 'X2556'],
         ];
     }
 
@@ -67,8 +60,6 @@ public function providerFormatInvalidPostcode() : array
      * @param string $expectedOutput
      *
      * @return void
-     * @throws InvalidPostcodeException
-     * @throws UnknownCountryException
      */
     public function testFormat(string $country, string $postcode, string $expectedOutput) : void
     {
@@ -85,10 +76,7 @@ public function providerFormat() : array
         return [
             ['GB', 'WC2E9RZ', 'WC2E 9RZ'],
             ['gb', 'wc-2E9RZ', 'WC2E 9RZ'],
-            ['PL', '12345', '12-345'],
-            ['AT', 'A-8084', '8084'],
-            ['BE', 'B-1245', '1245'],
-            ['LU', 'L2556', '2556'],
+            ['PL', '12345', '12-345']
         ];
     }
 
@@ -118,4 +106,4 @@ public function providerIsSupportedCountry() : array
             ['UnknownCountry', false],
         ];
     }
-}
+}