Remove "IdentityCard" in favor of "PolishIdCard"

The only Identity Card we have is the Polish one, that said it makes more sense to have a specific rule that only validates that, rather than having a "IdentityCard" rule that only accepts one value. Signed-off-by: Henrique Moody <[email protected]>
ronanchilvers · May 11, 2019 · c522f62 · c522f62
1 parent f23b3a5
commit c522f62
Show file tree

Hide file tree

Showing 15 changed files with 58 additions and 185 deletions.
diff --git a/docs/list-of-rules.md b/docs/list-of-rules.md
@@ -102,7 +102,6 @@
 - [Cnh](rules/Cnh.md)
 - [Cnpj](rules/Cnpj.md)
 - [Cpf](rules/Cpf.md)
-- [IdentityCard](rules/IdentityCard.md)
 - [Imei](rules/Imei.md)
 - [Isbn](rules/Isbn.md)
 - [Luhn](rules/Luhn.md)
@@ -112,6 +111,7 @@
 - [Nip](rules/Nip.md)
 - [Pesel](rules/Pesel.md)
 - [Pis](rules/Pis.md)
+- [PolishIdCard](rules/PolishIdCard.md)
 
 ## Integrations
 
@@ -326,7 +326,6 @@
 - [HexRgbColor](rules/HexRgbColor.md)
 - [Iban](rules/Iban.md)
 - [Identical](rules/Identical.md)
-- [IdentityCard](rules/IdentityCard.md)
 - [Image](rules/Image.md)
 - [Imei](rules/Imei.md)
 - [In](rules/In.md)
@@ -381,6 +380,7 @@
 - [Phone](rules/Phone.md)
 - [PhpLabel](rules/PhpLabel.md)
 - [Pis](rules/Pis.md)
+- [PolishIdCard](rules/PolishIdCard.md)
 - [Positive](rules/Positive.md)
 - [PostalCode](rules/PostalCode.md)
 - [PrimeNumber](rules/PrimeNumber.md)

diff --git a/docs/rules/IdentityCard.md b/docs/rules/IdentityCard.md
diff --git a/docs/rules/Nip.md b/docs/rules/Nip.md
@@ -25,6 +25,6 @@ Version | Description
 ***
 See also:
 
-- [IdentityCard](IdentityCard.md)
 - [Pesel](Pesel.md)
+- [PolishIdCard](PolishIdCard.md)
 - [SubdivisionCode](SubdivisionCode.md)
diff --git a/docs/rules/Pesel.md b/docs/rules/Pesel.md
@@ -24,6 +24,6 @@ Version | Description
 ***
 See also:
 
-- [IdentityCard](IdentityCard.md)
 - [Nip](Nip.md)
+- [PolishIdCard](PolishIdCard.md)
 - [SubdivisionCode](SubdivisionCode.md)
diff --git a/docs/rules/PolishIdCard.md b/docs/rules/PolishIdCard.md
@@ -0,0 +1,29 @@
+# PolishIdCard
+
+- `PolishIdCard()`
+
+Validates whether the input is a Polish identity card (Dowód Osobisty).
+
+```php
+v::polishIdCard()->validate('AYW036733'); // true
+v::polishIdCard()->validate('APH505567'); // true
+v::polishIdCard()->validate('APH 505567'); // false
+v::polishIdCard()->validate('AYW036731'); // false
+```
+
+## Categorization
+
+- Identifications
+
+## Changelog
+
+Version | Description
+--------|-------------
+  2.0.0 | Created
+
+***
+See also:
+
+- [Nip](Nip.md)
+- [Pesel](Pesel.md)
+- [SubdivisionCode](SubdivisionCode.md)
diff --git a/docs/rules/SubdivisionCode.md b/docs/rules/SubdivisionCode.md
@@ -287,10 +287,10 @@ See also:
 
 - [CountryCode](CountryCode.md)
 - [CurrencyCode](CurrencyCode.md)
-- [IdentityCard](IdentityCard.md)
 - [KeyValue](KeyValue.md)
 - [Nip](Nip.md)
 - [Pesel](Pesel.md)
+- [PolishIdCard](PolishIdCard.md)
 - [Tld](Tld.md)
 
 [Creative Commons Attribution 3.0 License]: http://creativecommons.org/licenses/by/3.0 "Creative Commons Attribution 3.0 License"

diff --git a/library/Exceptions/IdentityCardException.php b/library/Exceptions/IdentityCardException.php
diff --git a/...ptions/Locale/PlIdentityCardException.php → library/Exceptions/PolishIdCardException.php b/...ptions/Locale/PlIdentityCardException.php → library/Exceptions/PolishIdCardException.php
@@ -11,14 +11,12 @@
 
 declare(strict_types=1);
 
-namespace Respect\Validation\Exceptions\Locale;
-
-use Respect\Validation\Exceptions\ValidationException;
+namespace Respect\Validation\Exceptions;
 
 /**
  * @author Henrique Moody <[email protected]>
  */
-final class PlIdentityCardException extends ValidationException
+final class PolishIdCardException extends ValidationException
 {
     /**
      * {@inheritDoc}

diff --git a/library/Factory.php b/library/Factory.php
@@ -35,15 +35,8 @@
  */
 final class Factory
 {
-    private const DEFAULT_RULES_NAMESPACES = [
-        'Respect\\Validation\\Rules',
-        'Respect\\Validation\\Rules\\Locale',
-    ];
-
-    private const DEFAULT_EXCEPTIONS_NAMESPACES = [
-        'Respect\\Validation\\Exceptions',
-        'Respect\\Validation\\Exceptions\\Locale',
-    ];
+    private const DEFAULT_RULES_NAMESPACES = ['Respect\\Validation\\Rules'];
+    private const DEFAULT_EXCEPTIONS_NAMESPACES = ['Respect\\Validation\\Exceptions'];
 
     /**
      * Default instance of the Factory.

diff --git a/library/Rules/AbstractLocaleWrapper.php b/library/Rules/AbstractLocaleWrapper.php
diff --git a/library/Rules/IdentityCard.php b/library/Rules/IdentityCard.php
diff --git a/library/Rules/Locale/PlIdentityCard.php → library/Rules/PolishIdCard.php b/library/Rules/Locale/PlIdentityCard.php → library/Rules/PolishIdCard.php
@@ -11,20 +11,19 @@
 
 declare(strict_types=1);
 
-namespace Respect\Validation\Rules\Locale;
+namespace Respect\Validation\Rules;
 
-use Respect\Validation\Rules\AbstractRule;
 use function ord;
 use function preg_match;
 
 /**
- * Validator for Polish identity card.
+ * Validates whether the input is a Polish identity card (Dowód Osobisty).
  *
  * @see https://en.wikipedia.org/wiki/Polish_identity_card
  *
  * @author Henrique Moody <[email protected]>
  */
-final class PlIdentityCard extends AbstractRule
+final class PolishIdCard extends AbstractRule
 {
     private const ASCII_CODE_0 = 48;
     private const ASCII_CODE_7 = 55;

diff --git a/library/Validator.php b/library/Validator.php
@@ -81,7 +81,6 @@
  * @method static Validator hexRgbColor()
  * @method static Validator iban()
  * @method static Validator identical($value)
- * @method static Validator identityCard(string $countryCode)
  * @method static Validator image(finfo $fileInfo = null)
  * @method static Validator imei()
  * @method static Validator in($haystack, bool $compareIdentical = false)
@@ -136,6 +135,7 @@
  * @method static Validator phone()
  * @method static Validator phpLabel()
  * @method static Validator pis()
+ * @method static Validator polishIdCard()
  * @method static Validator positive()
  * @method static Validator postalCode(string $countryCode)
  * @method static Validator primeNumber()

diff --git a/tests/integration/rules/identityCard.phpt → tests/integration/rules/polishIdCard.phpt b/tests/integration/rules/identityCard.phpt → tests/integration/rules/polishIdCard.phpt
@@ -7,37 +7,36 @@ declare(strict_types=1);
 
 require_once 'vendor/autoload.php';
 
-use Respect\Validation\Exceptions\IdentityCardException;
-use Respect\Validation\Exceptions\Locale\PlIdentityCardException;
 use Respect\Validation\Exceptions\NestedValidationException;
+use Respect\Validation\Exceptions\PolishIdCardException;
 use Respect\Validation\Validator as v;
 
 try {
-    v::identityCard('PL')->check('AYE205411');
-} catch (PlIdentityCardException $exception) {
+    v::polishIdCard()->check('AYE205411');
+} catch (PolishIdCardException $exception) {
     echo $exception->getMessage().PHP_EOL;
 }
 
 try {
-    v::not(v::identityCard('PL'))->check('AYE205410');
-} catch (IdentityCardException $exception) {
+    v::not(v::polishIdCard())->check('AYE205410');
+} catch (PolishIdCardException $exception) {
     echo $exception->getMessage().PHP_EOL;
 }
 
 try {
-    v::identityCard('PL')->assert('AYE205411');
+    v::polishIdCard()->assert('AYE205411');
 } catch (NestedValidationException $exception) {
     echo $exception->getFullMessage().PHP_EOL;
 }
 
 try {
-    v::not(v::identityCard('PL'))->assert('AYE205410');
+    v::not(v::polishIdCard())->assert('AYE205410');
 } catch (NestedValidationException $exception) {
     echo $exception->getFullMessage().PHP_EOL;
 }
 ?>
 --EXPECT--
 "AYE205411" must be a valid Polish Identity Card number
-"AYE205410" must not be a valid Identity Card number for "PL"
+"AYE205410" must not be a valid Polish Identity Card number
 - "AYE205411" must be a valid Polish Identity Card number
-- "AYE205410" must not be a valid Identity Card number for "PL"
+- "AYE205410" must not be a valid Polish Identity Card number