Containerize sokil databases

The main focus of this change is to make those optional dependencies
more testable.

Unfortunately, some phpstan-ignores had to be included, since ::set
is not a PsrContainer method. We're only using it on tests though,
so it's fine. It targets our php-di container for testing purposes
only. The real implementation only relies on ::get.

This change also has the side effect of improving the performance
of those validators by not instantiating their databases each time
a iso validator is built, achieving massive improvements in those
scenarios. A small benchmark with no assertions was added to track
that improvement.

Author: alganet

src/ContainerRegistry.php

@@ -38,11 +38,17 @@
 use Respect\Validation\Message\Renderer;
 use Respect\Validation\Transformers\Prefix;
 use Respect\Validation\Transformers\Transformer;
+use Sokil\IsoCodes\Database\Countries;
+use Sokil\IsoCodes\Database\Currencies;
+use Sokil\IsoCodes\Database\Languages;
+use Sokil\IsoCodes\Database\Subdivisions;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
+use function class_exists;
 use function DI\autowire;
 use function DI\create;
 use function DI\factory;
+use function sprintf;
 
 final class ContainerRegistry
 {
@@ -94,6 +100,10 @@ public static function createContainer(array $definitions = []): Container
                 ),
                 $container->get(TranslatorInterface::class),
             )),
+            Subdivisions::class => factory(static::optional(Subdivisions::class)),
+            Countries::class => factory(static::optional(Countries::class)),
+            Languages::class => factory(static::optional(Languages::class)),
+            Currencies::class => factory(static::optional(Currencies::class)),
             ValidatorBuilder::class => factory(static fn(Container $container) => new ValidatorBuilder(
                 $container->get(ValidatorFactory::class),
                 $container->get(Renderer::class),
@@ -119,4 +129,17 @@ public static function setContainer(ContainerInterface $instance): void
     {
         self::$container = $instance;
     }
+
+    private static function optional(string $className): callable
+    {
+        return static function () use ($className) {
+            if (!class_exists($className)) {
+                throw new Exceptions\MissingClassException(
+                    sprintf('Class "%s" is required but not found.', $className),
+                );
+            }
+
+            return new $className();
+        };
+    }
 }

src/Exceptions/MissingClassException.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * SPDX-License-Identifier: MIT
+ * SPDX-FileCopyrightText: (c) Respect Project Contributors
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Validation\Exceptions;
+
+use Psr\Container\NotFoundExceptionInterface;
+
+final class MissingClassException extends ComponentException implements Exception, NotFoundExceptionInterface
+{
+}

src/Validators/CountryCode.php

@@ -18,14 +18,15 @@
 namespace Respect\Validation\Validators;
 
 use Attribute;
+use Psr\Container\NotFoundExceptionInterface;
+use Respect\Validation\ContainerRegistry;
 use Respect\Validation\Exceptions\InvalidValidatorException;
 use Respect\Validation\Exceptions\MissingComposerDependencyException;
 use Respect\Validation\Message\Template;
 use Respect\Validation\Result;
 use Respect\Validation\Validator;
 use Sokil\IsoCodes\Database\Countries;
 
-use function class_exists;
 use function in_array;
 use function is_string;
 
@@ -43,14 +44,6 @@ public function __construct(
         private string $set = 'alpha-2',
         Countries|null $countries = null,
     ) {
-        if (!class_exists(Countries::class)) {
-            throw new MissingComposerDependencyException(
-                'SubdivisionCode rule requires PHP ISO Codes',
-                'sokil/php-isocodes',
-                'sokil/php-isocodes-db-only',
-            );
-        }
-
         $availableOptions = ['alpha-2', 'alpha-3', 'numeric'];
         if (!in_array($set, $availableOptions, true)) {
             throw new InvalidValidatorException(
@@ -60,7 +53,15 @@ public function __construct(
             );
         }
 
-        $this->countries = $countries ?? new Countries();
+        try {
+            $this->countries = $countries ?? ContainerRegistry::getContainer()->get(Countries::class);
+        } catch (NotFoundExceptionInterface) {
+            throw new MissingComposerDependencyException(
+                'CountryCode rule requires PHP ISO Codes',
+                'sokil/php-isocodes',
+                'sokil/php-isocodes-db-only',
+            );
+        }
     }
 
     public function evaluate(mixed $input): Result

src/Validators/CurrencyCode.php

@@ -15,14 +15,15 @@
 namespace Respect\Validation\Validators;
 
 use Attribute;
+use Psr\Container\NotFoundExceptionInterface;
+use Respect\Validation\ContainerRegistry;
 use Respect\Validation\Exceptions\InvalidValidatorException;
 use Respect\Validation\Exceptions\MissingComposerDependencyException;
 use Respect\Validation\Message\Template;
 use Respect\Validation\Result;
 use Respect\Validation\Validator;
 use Sokil\IsoCodes\Database\Currencies;
 
-use function class_exists;
 use function in_array;
 
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
@@ -39,14 +40,6 @@ public function __construct(
         private string $set = 'alpha-3',
         Currencies|null $currencies = null,
     ) {
-        if (!class_exists(Currencies::class)) {
-            throw new MissingComposerDependencyException(
-                'CurrencyCode rule requires PHP ISO Codes',
-                'sokil/php-isocodes',
-                'sokil/php-isocodes-db-only',
-            );
-        }
-
         $availableSets = ['alpha-3', 'numeric'];
         if (!in_array($set, $availableSets, true)) {
             throw new InvalidValidatorException(
@@ -56,7 +49,15 @@ public function __construct(
             );
         }
 
-        $this->currencies = $currencies ?? new Currencies();
+        try {
+            $this->currencies = $currencies ?? ContainerRegistry::getContainer()->get(Currencies::class);
+        } catch (NotFoundExceptionInterface) {
+            throw new MissingComposerDependencyException(
+                'CurrencyCode rule requires PHP ISO Codes',
+                'sokil/php-isocodes',
+                'sokil/php-isocodes-db-only',
+            );
+        }
     }
 
     public function evaluate(mixed $input): Result

src/Validators/LanguageCode.php

@@ -15,15 +15,15 @@
 namespace Respect\Validation\Validators;
 
 use Attribute;
+use Psr\Container\NotFoundExceptionInterface;
+use Respect\Validation\ContainerRegistry;
 use Respect\Validation\Exceptions\InvalidValidatorException;
 use Respect\Validation\Exceptions\MissingComposerDependencyException;
 use Respect\Validation\Message\Template;
 use Respect\Validation\Result;
 use Respect\Validation\Validator;
-use Sokil\IsoCodes\Database\Countries;
 use Sokil\IsoCodes\Database\Languages;
 
-use function class_exists;
 use function in_array;
 use function is_string;
 
@@ -41,14 +41,6 @@ public function __construct(
         private readonly string $set = 'alpha-2',
         Languages|null $languages = null,
     ) {
-        if (!class_exists(Countries::class)) {
-            throw new MissingComposerDependencyException(
-                'LanguageCode rule requires PHP ISO Codes',
-                'sokil/php-isocodes',
-                'sokil/php-isocodes-db-only',
-            );
-        }
-
         $availableSets = ['alpha-2', 'alpha-3'];
         if (!in_array($set, $availableSets, true)) {
             throw new InvalidValidatorException(
@@ -58,7 +50,15 @@ public function __construct(
             );
         }
 
-        $this->languages = $languages ?? new Languages();
+        try {
+            $this->languages = $languages ?? ContainerRegistry::getContainer()->get(Languages::class);
+        } catch (NotFoundExceptionInterface) {
+            throw new MissingComposerDependencyException(
+                'LanguageCode rule requires PHP ISO Codes',
+                'sokil/php-isocodes',
+                'sokil/php-isocodes-db-only',
+            );
+        }
     }
 
     public function evaluate(mixed $input): Result

src/Validators/Phone.php

@@ -21,6 +21,8 @@
 use Attribute;
 use libphonenumber\NumberParseException;
 use libphonenumber\PhoneNumberUtil;
+use Psr\Container\NotFoundExceptionInterface;
+use Respect\Validation\ContainerRegistry;
 use Respect\Validation\Exceptions\InvalidValidatorException;
 use Respect\Validation\Exceptions\MissingComposerDependencyException;
 use Respect\Validation\Message\Template;
@@ -64,15 +66,16 @@ public function __construct(string|null $countryCode = null, Countries|null $cou
             return;
         }
 
-        if (!class_exists(Countries::class)) {
+        try {
+            $countries ??= ContainerRegistry::getContainer()->get(Countries::class);
+        } catch (NotFoundExceptionInterface) {
             throw new MissingComposerDependencyException(
                 'Phone rule with country code requires PHP ISO Codes',
                 'sokil/php-isocodes',
                 'sokil/php-isocodes-db-only',
             );
         }
 
-        $countries ??= new Countries();
         $this->country = $countries->getByAlpha2($countryCode);
         if ($this->country === null) {
             throw new InvalidValidatorException('Invalid country code %s', $countryCode);

src/Validators/SubdivisionCode.php

@@ -12,6 +12,8 @@
 namespace Respect\Validation\Validators;
 
 use Attribute;
+use Psr\Container\NotFoundExceptionInterface;
+use Respect\Validation\ContainerRegistry;
 use Respect\Validation\Exceptions\InvalidValidatorException;
 use Respect\Validation\Exceptions\MissingComposerDependencyException;
 use Respect\Validation\Helpers\CanValidateUndefined;
@@ -21,8 +23,6 @@
 use Sokil\IsoCodes\Database\Countries;
 use Sokil\IsoCodes\Database\Subdivisions;
 
-use function class_exists;
-
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 #[Template(
     '{{subject}} must be a subdivision code of {{countryName|trans}}',
@@ -41,22 +41,24 @@ public function __construct(
         Countries|null $countries = null,
         Subdivisions|null $subdivisions = null,
     ) {
-        if (!class_exists(Countries::class) || !class_exists(Subdivisions::class)) {
+        try {
+            $container = ContainerRegistry::getContainer();
+            $countries ??= $container->get(Countries::class);
+            $this->subdivisions = $subdivisions ?? $container->get(Subdivisions::class);
+        } catch (NotFoundExceptionInterface) {
             throw new MissingComposerDependencyException(
                 'SubdivisionCode rule requires PHP ISO Codes',
                 'sokil/php-isocodes',
                 'sokil/php-isocodes-db-only',
             );
         }
 
-        $countries ??= new Countries();
         $country = $countries->getByAlpha2($countryCode);
         if ($country === null) {
             throw new InvalidValidatorException('"%s" is not a supported country code', $countryCode);
         }
 
         $this->country = $country;
-        $this->subdivisions = $subdivisions ?? new Subdivisions();
     }
 
     public function evaluate(mixed $input): Result

tests/benchmark/IsoCodesBench.php

@@ -0,0 +1,69 @@
+<?php
+
+/*
+ * SPDX-License-Identifier: MIT
+ * SPDX-FileCopyrightText: (c) Respect Project Contributors
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Validation\Benchmarks;
+
+use PhpBench\Attributes as Bench;
+use Respect\Validation\Test\SmokeTestProvider;
+use Respect\Validation\ValidatorBuilder;
+
+class IsoCodesBench
+{
+    use SmokeTestProvider;
+
+    #[Bench\Iterations(10)]
+    #[Bench\RetryThreshold(5)]
+    #[Bench\Revs(5)]
+    #[Bench\Warmup(1)]
+    #[Bench\Subject]
+    public function subdivisionCode(): void
+    {
+        ValidatorBuilder::subdivisionCode('US')->evaluate('CA');
+    }
+
+    #[Bench\Iterations(10)]
+    #[Bench\RetryThreshold(5)]
+    #[Bench\Revs(5)]
+    #[Bench\Warmup(1)]
+    #[Bench\Subject]
+    public function countryCode(): void
+    {
+        ValidatorBuilder::countryCode()->evaluate('US');
+    }
+
+    #[Bench\Iterations(10)]
+    #[Bench\RetryThreshold(5)]
+    #[Bench\Revs(5)]
+    #[Bench\Warmup(1)]
+    #[Bench\Subject]
+    public function currencyCode(): void
+    {
+        ValidatorBuilder::currencyCode()->evaluate('USD');
+    }
+
+    #[Bench\Iterations(10)]
+    #[Bench\RetryThreshold(5)]
+    #[Bench\Revs(5)]
+    #[Bench\Warmup(1)]
+    #[Bench\Subject]
+    public function languageCode(): void
+    {
+        ValidatorBuilder::languageCode()->evaluate('en');
+    }
+
+    #[Bench\Iterations(10)]
+    #[Bench\RetryThreshold(5)]
+    #[Bench\Revs(5)]
+    #[Bench\Warmup(1)]
+    #[Bench\Subject]
+    public function phone(): void
+    {
+        ValidatorBuilder::phone('US')->evaluate('+1 202-555-0125');
+    }
+}