Merge branch 'release/4.0.1'

Author: WiktorPacer

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## v.4.0.1
+ - add post_code rule
+## v.4.0.0
+ - update dependencies for Laravel and Lumen 8.x.x compatibility
 ## v.3.0.0
  - update dependencies for Laravel and Lumen 7.x.x compatibility
 ## v.2.0.2

README.md

@@ -19,26 +19,27 @@ For customize validaiton messages run:
 
 ### Version compatibility
 #### Laravel
-Framework | Package
-:---------|:--------
-5.8.x | ^1.x.x
-6.0.x | ^2.x.x
-7.x.x | ^3.x.x
-8.x.x | ^4.x.x
+Framework | Package | Note
+:---------|:--------|:------
+5.8.x | ^1.x.x | No longer maintained.
+6.0.x | ^2.x.x |
+7.x.x | ^3.x.x |
+8.x.x | ^4.x.x |
 #### Lumen
-Framework | Package
-:---------|:--------
-5.8.x | ^1.x.x
-6.0.x | ^2.x.x
-7.x.x | ^3.x.x
-8.x.x | ^4.x.x
+Framework | Package | Note
+:---------|:--------|:------
+5.8.x | ^1.x.x | No longer maintained.
+6.0.x | ^2.x.x |
+7.x.x | ^3.x.x |
+8.x.x | ^4.x.x |
 
 ## Rules
 
 1. 'PESEL' - validate [PESEL](https://pl.wikipedia.org/wiki/PESEL) number
 2. 'REGON' - validate [REGON](https://pl.wikipedia.org/wiki/REGON) number
 3. 'NIP' - validate [NIP](https://pl.wikipedia.org/wiki/NIP) number
 4. 'id_card_number' - validate Polish ID Card number
+5. 'post_code' - validate Polish post codes (accept codes in format 00-000 and 00000),
 
 ## Code Authors
 

resources/lang/en/validation.php

@@ -6,5 +6,6 @@
  'REGON' => 'REGON number is not valid!',
  'NIP' => 'NIP number is not valid!',
  'id_card_number' => 'ID Card numner is not valid!',
+ 'post_code' => 'Post code not valid!',
 
 ];

resources/lang/pl/validation.php

@@ -6,5 +6,6 @@
  'REGON' => 'Numer REGON jest niepoprawny',
  'NIP' => 'Numer NIP jest niepoprawny!',
  'id_card_number' => 'Numer dowodu osobistego jest niepoprawny!',
+ 'post_code' => 'Kod pocztowy niepoprawny!',
 
 ];

src/Providers/LaravelPolishValidationRulesServiceProvider.php

@@ -7,6 +7,7 @@
 use PacerIT\LaravelPolishValidationRules\Rules\IDCardNumberRule;
 use PacerIT\LaravelPolishValidationRules\Rules\NIPRule;
 use PacerIT\LaravelPolishValidationRules\Rules\PESELRule;
+use PacerIT\LaravelPolishValidationRules\Rules\PostCodeRule;
 use PacerIT\LaravelPolishValidationRules\Rules\REGONRule;
 
 /**
@@ -47,22 +48,32 @@ private function registerRules()
  {
  Validator::extend(
  'PESEL',
- PESELRule::class.'@passes'
+ PESELRule::class.'@passes',
+ trans('polish-validation::validation.PESEL')
  );
 
  Validator::extend(
  'REGON',
- REGONRule::class.'@passes'
+ REGONRule::class.'@passes',
+ trans('polish-validation::validation.REGON')
  );
 
  Validator::extend(
  'NIP',
- NIPRule::class.'@passes'
+ NIPRule::class.'@passes',
+ trans('polish-validation::validation.NIP')
  );
 
  Validator::extend(
  'id_card_number',
- IDCardNumberRule::class.'@passes'
+ IDCardNumberRule::class.'@passes',
+ trans('polish-validation::validation.id_card_number')
+ );
+
+ Validator::extend(
+ 'post_code',
+ PostCodeRule::class.'@passes',
+ trans('polish-validation::validation.post_code')
  );
  }
 }

src/Rules/PostCodeRule.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace PacerIT\LaravelPolishValidationRules\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+/**
+ * Class PostCodeRule.
+ *
+ * @author Wiktor Pacer <kontakt@pacerit.pl>
+ *
+ * @since 09/09/2020
+ */
+class PostCodeRule implements Rule
+{
+ /**
+ * Determine if the validation rule passes.
+ *
+ * @param string $attribute
+ * @param mixed $value
+ *
+ * @return bool
+ */
+ public function passes($attribute, $value)
+ {
+ return $this->checkPostCode($value);
+ }
+
+ /**
+ * Validate post code.
+ *
+ * @param string|null $string
+ *
+ * @return bool
+ *
+ * @author Wiktor Pacer <kontakt@pacerit.pl>
+ *
+ * @since 09/09/2020
+ */
+ private function checkPostCode(?string $string): bool
+ {
+ if ($string === null) {
+ return false;
+ }
+
+ if (!preg_match('/^[0-9]{2}-?[0-9]{3}$/Du', $string)) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Get the validation error message.
+ *
+ * @return string|array
+ */
+ public function message()
+ {
+ return trans('polish-validation::validation.post_code');
+ }
+}

tests/Unit/PostCodeRuleTest.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Tests\Unit;
+
+use PacerIT\LaravelPolishValidationRules\Rules\PostCodeRule;
+
+/**
+ * Class PostCodeRuleTest.
+ *
+ * @author Wiktor Pacer <kontakt@pacerit.pl>
+ *
+ * @since 2019-08-12
+ */
+class PostCodeRuleTest extends AbstractRuleTest
+{
+ /**
+ * Set up test.
+ *
+ * @author Wiktor Pacer <kontakt@pacerit.pl>
+ *
+ * @since 2019-08-12
+ */
+ public function setUp(): void
+ {
+ parent::setUp();
+ $this->rule = new PostCodeRule();
+ }
+
+ /**
+ * Test valid PostCode number.
+ *
+ * @author Wiktor Pacer <kontakt@pacerit.pl>
+ *
+ * @since 2019-08-12
+ */
+ public function testValidPostCode()
+ {
+ $this->assertTrue($this->rule->passes('post_code', '72-200'));
+ $this->assertTrue($this->rule->passes('post_code', '72-200'));
+ }
+
+ /**
+ * Test not valid PostCode number.
+ *
+ * @author Wiktor Pacer <kontakt@pacerit.pl>
+ *
+ * @since 2019-08-12
+ */
+ public function testNotValidPostCode()
+ {
+ $this->assertFalse($this->rule->passes('post_code', '7220'));
+ }
+
+ /**
+ * Test null PostCode number.
+ *
+ * @author Wiktor Pacer <kontakt@pacerit.pl>
+ *
+ * @since 02/12/2019
+ */
+ public function testNullPostCode()
+ {
+ $this->assertFalse($this->rule->passes('post_code', null));
+ }
+}