Merge pull request #1 from zentlix/feature/spiral-validator

Adding PhoneNumberChecker

.gitattributes

@@ -1,10 +1,11 @@
-/.github            export-ignore
-/.gitattributes     export-ignore
-/.gitignore         export-ignore
-/phpunit.xml.dist   export-ignore
-/tests              export-ignore
-/.editorconfig      export-ignore
-/.php_cs.dist.php   export-ignore
-/psalm.xml          export-ignore
-/psalm.xml.dist     export-ignore
-/UPGRADING.md       export-ignore
+/.github                export-ignore
+/.gitattributes         export-ignore
+/.gitignore             export-ignore
+/phpunit.xml.dist       export-ignore
+/tests                  export-ignore
+/.editorconfig          export-ignore
+/.php_cs.dist.php       export-ignore
+/.php-cs-fixer.dist.php export-ignore
+/psalm.xml              export-ignore
+/psalm.xml.dist         export-ignore
+/UPGRADING.md           export-ignore

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0 - 2023-02-01
+- **Other Features**
+  - Added `Spiral\PhoneNumber\Validator\Checker\PhoneNumberChecker` for the
+    [Spiral Validator](https://github.com/spiral/validator) package.
+
 ## 1.0.0 - 2023-01-08
 
-- initial release
+ - initial release

README.md

@@ -123,6 +123,8 @@ $utils->format($phoneNumber, PhoneNumberFormat::RFC3966); // tel:+1-650-253-0000
 
 ## Validation
 
+### Symfony Validator
+
 The package provides a `Spiral\PhoneNumber\Validator\Constraints\PhoneNumber` constraint that can be used to validate
 phone numbers using the `spiral-packages/symfony-validator` component.
 
@@ -165,6 +167,48 @@ class User
 }
 ```
 
+### Spiral Validator
+
+The package provides a `Spiral\PhoneNumber\Validator\Checker\PhoneNumberChecker` checker that can be used to validate
+phone numbers using the `spiral/validator` component.
+
+To use the `Spiral\PhoneNumber\Validator\Checker\PhoneNumberChecker` checker, you will first need to make sure that
+the `spiral/validator` package is installed and enabled in your Spiral Framework application.
+
+Once the `spiral/validator` package is installed and enabled, you can use the `PhoneNumberChecker`
+checker in your code like this:
+
+```php
+namespace App\Request;
+
+use Spiral\Filters\Attribute\Input\Post;
+use Spiral\Filters\Model\Filter;
+use Spiral\Filters\Model\FilterDefinitionInterface;
+use Spiral\Filters\Model\HasFilterDefinition;
+use Spiral\Validator\FilterDefinition;
+
+final class UserRequest extends Filter implements HasFilterDefinition
+{
+    #[Post]
+    public string $phone;
+
+    public function filterDefinition(): FilterDefinitionInterface
+    {
+        return new FilterDefinition([
+            'phone' => ['phone'],
+            // or with custom error message
+            'phone' => [
+                ['phone', 'error' => 'Custom error message.']
+            ]
+        ]);
+    }
+}
+```
+
+In this example, the `PhoneNumberChecker` checker is applied to the **$phone** property of the **UserRequest** class.
+This will cause the Validator to validate the **$phone** property as a phone number when the UserRequest object
+is validated. If the value of the $phone property is not a valid phone number, the validation will fail.
+
 ## Serialization
 
 The package provides a `Spiral\PhoneNumber\Serializer\Normalizer\PhoneNumberNormalizer` class that can be used

composer.json

@@ -22,11 +22,12 @@
         "roave/security-advisories": "dev-latest",
         "phpunit/phpunit": "^9.5.27",
         "friendsofphp/php-cs-fixer": "^3.8",
-        "spiral/testing": "^2.2.0",
+        "spiral/testing": "^2.2",
         "vimeo/psalm": "^4.30",
         "spiral/twig-bridge": "^2.0",
         "spiral-packages/symfony-serializer": "^1.0",
         "spiral-packages/symfony-validator": "^1.2",
+        "spiral/validator": "^1.2",
         "spiral/nyholm-bridge": "^1.3",
         "symfony/yaml": "^6.0"
     },

src/Bootloader/PhoneNumberBootloader.php

@@ -10,16 +10,19 @@
 use libphonenumber\PhoneNumberToTimeZonesMapper;
 use libphonenumber\PhoneNumberUtil;
 use libphonenumber\ShortNumberInfo;
+use Spiral\Boot\AbstractKernel;
 use Spiral\Boot\Bootloader\Bootloader;
 use Spiral\Config\ConfiguratorInterface;
 use Spiral\Core\Container;
 use Spiral\Core\FactoryInterface as ContainerFactory;
 use Spiral\PhoneNumber\Config\PhoneNumberConfig;
 use Spiral\PhoneNumber\Serializer\Normalizer\PhoneNumberNormalizer;
 use Spiral\PhoneNumber\Twig\Extension\PhoneNumberExtension;
+use Spiral\PhoneNumber\Validator\Checker\PhoneNumberChecker;
 use Spiral\Serializer\Symfony\NormalizersRegistry;
 use Spiral\Serializer\Symfony\NormalizersRegistryInterface;
 use Spiral\Twig\Bootloader\TwigBootloader;
+use Spiral\Validator\Bootloader\ValidatorBootloader;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 
 final class PhoneNumberBootloader extends Bootloader
@@ -42,10 +45,16 @@ public function init(): void
         $this->initConfig();
     }
 
-    public function boot(PhoneNumberConfig $config, Container $container, ContainerFactory $factory): void
-    {
+    public function boot(
+        PhoneNumberConfig $config,
+        Container $container,
+        ContainerFactory $factory,
+        AbstractKernel $kernel
+    ): void {
         $this->registerNormalizer($config, $container, $factory);
         $this->registerTwigExtension($container);
+
+        $kernel->booted(fn () => $this->registerValidator($container));
     }
 
     private function initConfig(): void
@@ -129,4 +138,15 @@ private function registerTwigExtension(Container $container): void
         $twig = $container->get(TwigBootloader::class);
         $twig->addExtension(PhoneNumberExtension::class);
     }
+
+    private function registerValidator(Container $container): void
+    {
+        if (!class_exists(ValidatorBootloader::class)) {
+            return;
+        }
+
+        $validator = $container->get(ValidatorBootloader::class);
+        $validator->addChecker('phone', PhoneNumberChecker::class);
+        $validator->addAlias('phone', 'phone::isValid');
+    }
 }

src/Validator/Checker/PhoneNumberChecker.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\PhoneNumber\Validator\Checker;
+
+use libphonenumber\PhoneNumber;
+use libphonenumber\PhoneNumberUtil;
+use Spiral\PhoneNumber\Config\PhoneNumberConfig;
+use Spiral\Validator\AbstractChecker;
+
+final class PhoneNumberChecker extends AbstractChecker
+{
+    public function __construct(
+        private readonly PhoneNumberConfig $config
+    ) {
+    }
+
+    public const MESSAGES = [
+        'isValid' => '[[This value is not a valid phone number.]]',
+    ];
+
+    public function isValid(string $number): bool
+    {
+        $phoneUtil = PhoneNumberUtil::getInstance();
+
+        try {
+            /** @var PhoneNumber $phoneNumber */
+            $phoneNumber = $phoneUtil->parse($number, $this->config->getDefaultRegion());
+
+            return $phoneUtil->isValidNumber($phoneNumber);
+        } catch (\Throwable) {
+            return false;
+        }
+    }
+}

tests/app/Request/OtherPhoneRequest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\PhoneNumber\Tests\App\Request;
+
+use Spiral\Filters\Attribute\Input\Post;
+use Spiral\Filters\Model\Filter;
+use Spiral\Filters\Model\FilterDefinitionInterface;
+use Spiral\Filters\Model\HasFilterDefinition;
+use Spiral\Validator\FilterDefinition;
+
+final class OtherPhoneRequest extends Filter implements HasFilterDefinition
+{
+    #[Post]
+    public string $phone;
+
+    #[Post(key: 'phone_with_custom_error')]
+    public string $phoneWithCustomError;
+
+    public function filterDefinition(): FilterDefinitionInterface
+    {
+        return new FilterDefinition([
+            'phone' => ['phone'],
+            'phoneWithCustomError' => [
+                ['phone', 'error' => 'Custom error.']
+            ]
+        ]);
+    }
+}

tests/src/Functional/Bootloader/PhoneNumberBootloaderTest.php

@@ -17,6 +17,7 @@
 use Spiral\Serializer\Symfony\NormalizersRegistryInterface;
 use Spiral\Twig\Config\TwigConfig;
 use Spiral\Twig\Extension\ContainerExtension;
+use Spiral\Validator\Config\ValidatorConfig;
 
 final class PhoneNumberBootloaderTest extends TestCase
 {
@@ -54,6 +55,24 @@ public function testNormalizerShouldBeRegistered(): void
         $this->assertTrue($registry->has(PhoneNumberNormalizer::class));
     }
 
+    public function testValidatorCheckerShouldBeRegistered(): void
+    {
+        $container = $this->getApp()->getContainer();
+        /** @var ValidatorConfig $config */
+        $config = $container->get(ValidatorConfig::class);
+
+        $this->assertTrue($config->hasChecker('phone'));
+    }
+
+    public function testValidatorAliasShouldBeRegistered(): void
+    {
+        $container = $this->getApp()->getContainer();
+        /** @var ValidatorConfig $config */
+        $config = $container->get(ValidatorConfig::class);
+
+        $this->assertSame('phone:isValid', $config->resolveAlias('phone'));
+    }
+
     public function testTwigExtensionShouldBeRegistered(): void
     {
         $this->assertConfigHasFragments(

tests/src/Functional/TestCase.php

@@ -11,7 +11,8 @@
 use Spiral\Serializer\Symfony\Bootloader\SerializerBootloader;
 use Spiral\Twig\Bootloader\TwigBootloader;
 use Spiral\Validation\Bootloader\ValidationBootloader;
-use Spiral\Validation\Symfony\Bootloader\ValidatorBootloader;
+use Spiral\Validation\Symfony\Bootloader\ValidatorBootloader as SymfonyValidator;
+use Spiral\Validator\Bootloader\ValidatorBootloader as SpiralValidator;
 
 abstract class TestCase extends \Spiral\Testing\TestCase
 {
@@ -30,7 +31,8 @@ public function defineBootloaders(): array
             NyholmBootloader::class,
             FiltersBootloader::class,
             ValidationBootloader::class,
-            ValidatorBootloader::class,
+            SymfonyValidator::class,
+            SpiralValidator::class,
         ];
     }
 }

tests/src/Functional/Validator/Checker/PhoneNumberCheckerTest.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\PhoneNumber\Tests\Functional\Validator\Constraints;
+
+use Psr\Http\Message\ServerRequestFactoryInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Spiral\Filters\Exception\ValidationException;
+use Spiral\PhoneNumber\Tests\App\Request\OtherPhoneRequest;
+use Spiral\PhoneNumber\Tests\Functional\TestCase;
+
+final class PhoneNumberCheckerTest extends TestCase
+{
+    public function testSuccessValidation(): void
+    {
+        $this->getContainer()->bind(
+            ServerRequestInterface::class,
+            $this->createRequest(['phone' => '+1 650 253 0000', 'phone_with_custom_error' => '+16502530000'])
+        );
+
+        $filter = $this->getContainer()->get(OtherPhoneRequest::class);
+
+        $this->assertSame('+1 650 253 0000', $filter->phone);
+        $this->assertSame('+16502530000', $filter->phoneWithCustomError);
+    }
+
+    public function testFailValidation(): void
+    {
+        $this->getContainer()->bind(
+            ServerRequestInterface::class,
+            $this->createRequest(['phone' => 'foo', 'phone_with_custom_error' => 'bar'])
+        );
+
+        $exception = null;
+        try {
+            $this->getContainer()->get(OtherPhoneRequest::class);
+        } catch (ValidationException $e) {
+            $exception = $e;
+        }
+
+        $this->assertInstanceOf(ValidationException::class, $exception);
+        $this->assertSame('This value is not a valid phone number.', $exception->errors['phone']);
+        $this->assertSame('Custom error.', $exception->errors['phone_with_custom_error']);
+    }
+
+    private function createRequest(array $data): ServerRequestInterface
+    {
+        $factory = $this->getContainer()->get(ServerRequestFactoryInterface::class);
+
+        return $factory->createServerRequest('POST', '/foo')->withParsedBody($data);
+    }
+}