Merge pull request #1 from Kreyu/dev

Prefix requirement fixes and class aliases
Kreyu · Jul 25, 2019 · 94b4e53 · 94b4e53
2 parents 42be232 + beeebbe
commit 94b4e53
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,14 @@ class Company
 }
 ```
 
+##### Note:
+
+Constraint and validator classes are aliased to the `Tin` and `TinValidator` classes.
+
+- `Kreyu\Bundle\NipValidatorBundle\Validator\Constraints\Tin`
+- `Kreyu\Bundle\NipValidatorBundle\Validator\Constraints\TinValidator`
+
+
 ### Pattern validation
 
 By default, the only accepted format is a string of characters without the prefix nor dashes.
@@ -138,6 +146,13 @@ class Company
 }
 ```
 
+You can use the following parameters in this message:
+
+| Parameter | Description |
+| --- | --- |
+| `{{ value }}` | The current (invalid value) |
+| `{{ pattern }}` | The regular expression pattern used in the validation |
+
 #### Usage of a custom regular expression
 
 If the default functionality does not meet your needs, consider using the `pattern` option:
@@ -206,6 +221,12 @@ class Company
 }
 ```
 
+You can use the following parameters in this message:
+
+| Parameter | Description |
+| --- | --- |
+| `{{ value }}` | The current (invalid value) |
+
 ## License
 
 The MIT License (MIT). Please see [license file](LICENSE.md) for more information.
diff --git a/src/Validator/Constraints/Nip.php b/src/Validator/Constraints/Nip.php
@@ -39,3 +39,5 @@ class Nip extends Constraint
     public $requirePrefix = false;
     public $prefixLength = 2;
 }
+
+class_alias(Nip::class, 'Kreyu\Bundle\NipValidatorBundle\Validator\Constraints\Tin');
diff --git a/src/Validator/Constraints/NipValidator.php b/src/Validator/Constraints/NipValidator.php
@@ -24,9 +24,11 @@ class NipValidator extends ConstraintValidator
      */
     public function validate($value, Constraint $constraint)
     {
-        if (!preg_match($this->getPattern($constraint), $value)) {
+        if (!preg_match($pattern = $this->getPattern($constraint), $value)) {
             $this->context->buildViolation($constraint->patternMessage)
                 ->setParameter('{{ value }}', $this->formatValue($value))
+                ->setParameter('{{ pattern }}', $pattern)
+                ->setInvalidValue($value)
                 ->setCode(Nip::INVALID_PATTERN_ERROR)
                 ->addViolation();
 
@@ -36,6 +38,7 @@ public function validate($value, Constraint $constraint)
         if ($constraint->checksum && !$this->validateChecksum($value, $constraint)) {
             $this->context->buildViolation($constraint->checksumMessage)
                 ->setParameter('{{ value }}', $this->formatValue($value))
+                ->setInvalidValue($value)
                 ->setCode(Nip::INVALID_CHECKSUM_ERROR)
                 ->addViolation();
 
@@ -50,7 +53,7 @@ public function validate($value, Constraint $constraint)
      * @param  Constraint|Nip   $constraint
      * @return string
      */
-    protected function validateChecksum($value, Constraint $constraint)
+    public function validateChecksum($value, Constraint $constraint)
     {
         preg_match_all('!\d+!', $value, $matches);
 
@@ -69,7 +72,7 @@ protected function validateChecksum($value, Constraint $constraint)
      * @param  Constraint|Nip $constraint
      * @return string
      */
-    protected function getPattern(Constraint $constraint)
+    public function getPattern(Constraint $constraint)
     {
         if (null !== $constraint->pattern) {
             return $constraint->pattern;
@@ -81,7 +84,7 @@ protected function getPattern(Constraint $constraint)
         if ($constraint->prefixLength > 0 && ($constraint->requirePrefix || $constraint->allowPrefix)) {
             $pattern .= '([A-z]{' . $constraint->prefixLength . '})';
 
-            if ($constraint->allowPrefix) {
+            if (!$constraint->requirePrefix) {
                 $pattern .= '?';
             }
         }
@@ -105,3 +108,5 @@ protected function getPattern(Constraint $constraint)
         return $pattern;
     }
 }
+
+class_alias(NipValidator::class, 'Kreyu\Bundle\NipValidatorBundle\Validator\Constraints\TinValidator');
diff --git a/tests/Validator/Constraints/NipValidatorTest.php b/tests/Validator/Constraints/NipValidatorTest.php
@@ -13,8 +13,15 @@
 
 use Kreyu\Bundle\NipValidatorBundle\Validator\Constraints\Nip;
 use Kreyu\Bundle\NipValidatorBundle\Validator\Constraints\NipValidator;
+use Kreyu\Bundle\NipValidatorBundle\Validator\Constraints\Tin;
+use Kreyu\Bundle\NipValidatorBundle\Validator\Constraints\TinValidator;
 use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
 
+/**
+ * @property-read NipValidator $validator
+ *
+ * @author Sebastian Wróblewski <kontakt@swroblewski.pl>
+ */
 class NipValidatorTest extends ConstraintValidatorTestCase
 {
     protected function createValidator()
@@ -73,6 +80,7 @@ public function testCustomPatternWithInvalidChecksum($value)
 
         $this->buildViolation($constraint->checksumMessage)
             ->setParameter('{{ value }}', '"'.$value.'"')
+            ->setInvalidValue($value)
             ->setCode(Nip::INVALID_CHECKSUM_ERROR)
             ->assertRaised();
     }
@@ -127,6 +135,7 @@ public function testCustomChecksumMessage($value)
 
         $this->buildViolation('My custom checksum message')
             ->setParameter('{{ value }}', '"'.$value.'"')
+            ->setInvalidValue($value)
             ->setCode(Nip::INVALID_CHECKSUM_ERROR)
             ->assertRaised();
     }
@@ -145,6 +154,8 @@ public function testCustomPatternMessage($value)
 
         $this->buildViolation('My custom pattern message')
             ->setParameter('{{ value }}', '"'.$value.'"')
+            ->setParameter('{{ pattern }}', $this->validator->getPattern($constraint))
+            ->setInvalidValue($value)
             ->setCode(Nip::INVALID_PATTERN_ERROR)
             ->assertRaised();
     }
@@ -200,6 +211,8 @@ public function testRequiringDashesShouldNotAcceptWithout($value)
 
         $this->buildViolation($constraint->patternMessage)
             ->setParameter('{{ value }}', '"'.$value.'"')
+            ->setParameter('{{ pattern }}', $this->validator->getPattern($constraint))
+            ->setInvalidValue($value)
             ->setCode(Nip::INVALID_PATTERN_ERROR)
             ->assertRaised();
     }
@@ -256,19 +269,19 @@ public function testAllowingPrefixShouldAcceptBothWithAndWithout($value)
         $this->assertNoViolation();
     }
 
-    public function getWithPrefix()
+    public function getWithoutPrefix()
     {
         return [
-            ['PL 3774988224'],
-            ['EN 3784078972'],
-            ['DE 7745293711'],
-            ['AA 1239664059'],
-            ['BB 1589583841'],
+            ['3774988224'],
+            ['3784078972'],
+            ['7745293711'],
+            ['1239664059'],
+            ['1589583841'],
         ];
     }
 
     /**
-     * @dataProvider getWithPrefix
+     * @dataProvider getWithoutPrefix
      */
     public function testRequiringPrefixShouldNotAcceptWithout($value)
     {
@@ -281,6 +294,8 @@ public function testRequiringPrefixShouldNotAcceptWithout($value)
 
         $this->buildViolation($constraint->patternMessage)
             ->setParameter('{{ value }}', '"'.$value.'"')
+            ->setParameter('{{ pattern }}', $this->validator->getPattern($constraint))
+            ->setInvalidValue($value)
             ->setCode(Nip::INVALID_PATTERN_ERROR)
             ->assertRaised();
     }
@@ -327,7 +342,19 @@ public function testInvalidCustomPrefixLength($value)
 
         $this->buildViolation($constraint->patternMessage)
             ->setParameter('{{ value }}', '"'.$value.'"')
+            ->setParameter('{{ pattern }}', $this->validator->getPattern($constraint))
+            ->setInvalidValue($value)
             ->setCode(Nip::INVALID_PATTERN_ERROR)
             ->assertRaised();
     }
+
+    public function testNipConstraintClassAlias()
+    {
+        $this->assertInstanceOf(Nip::class, new Tin());
+    }
+
+    public function testNipValidatorClassAlias()
+    {
+        $this->assertInstanceOf(NipValidator::class, new TinValidator());
+    }
 }