Introduce tests for serialization of validators

This commit introduces a new feature test: SerializableTest, that
tests several validators for their ability to be serialized and
unserialized.

It also makes it so that the same list of validators can be used
by both simple benchmarks and "smoke tests" of all kinds, including
this serialize/unserialize one.

Additionally, the FilterVar validator was modified. Previously, due
to the use of Callback, it was not serializable, but now it is.

Author: alganet

library/Validators/FilterVar.php

@@ -12,12 +12,11 @@
 use Attribute;
 use Respect\Validation\Exceptions\InvalidValidatorException;
 use Respect\Validation\Message\Template;
-use Respect\Validation\Validators\Core\Envelope;
+use Respect\Validation\Result;
+use Respect\Validation\Validator;
 
 use function array_key_exists;
 use function filter_var;
-use function is_array;
-use function is_int;
 
 use const FILTER_VALIDATE_BOOLEAN;
 use const FILTER_VALIDATE_DOMAIN;
@@ -33,7 +32,7 @@
     '{{subject}} must be valid',
     '{{subject}} must not be valid',
 )]
-final class FilterVar extends Envelope
+final readonly class FilterVar implements Validator
 {
     private const array ALLOWED_FILTERS = [
         FILTER_VALIDATE_BOOLEAN => 'is_bool',
@@ -46,21 +45,22 @@ final class FilterVar extends Envelope
         FILTER_VALIDATE_URL => 'is_string',
     ];
 
-    public function __construct(int $filter, mixed $options = null)
+    public function __construct(private int $filter, private mixed $options = null)
     {
         if (!array_key_exists($filter, self::ALLOWED_FILTERS)) {
             throw new InvalidValidatorException('Cannot accept the given filter');
         }
+    }
 
-        $arguments = [$filter];
-        if (is_array($options) || is_int($options)) {
-            $arguments[] = $options;
-        }
-
-        parent::__construct(new Callback(static function ($input) use ($filter, $arguments) {
-            return (self::ALLOWED_FILTERS[$filter])(
-                filter_var($input, ...$arguments),
-            );
-        }));
+    public function evaluate(mixed $input): Result
+    {
+        return Result::of(
+            (self::ALLOWED_FILTERS[$this->filter])(match ($this->options) {
+                null => filter_var($input, $this->filter),
+                default => filter_var($input, $this->filter, $this->options),
+            }),
+            $input,
+            $this,
+        );
     }
 }

phpbench.json.dist

@@ -1,6 +1,6 @@
 {
     "$schema": "./vendor/phpbench/phpbench/phpbench.schema.json",
-    "runner.bootstrap": "vendor/autoload.php",
+    "runner.bootstrap": "tests/bootstrap.php",
     "runner.path": "tests/benchmark",
     "runner.file_pattern": "*Bench.php"
 }

phpstan.neon.dist

@@ -21,6 +21,8 @@ parameters:
       path: tests/feature/Validators/SizeTest.php
     - message: '/Property Respect\\Validation\\Test\\Stubs\\.+::\$[a-zA-Z]+ is never read, only written./'
       path: tests/library/Stubs
+    - message: '/Call to an undefined method Pest\\PendingCalls\\TestCall|Pest\\Support\\HigherOrderTapProxy::with\(\)./'
+      path: tests/feature/SerializableTest.php
   level: 8
   treatPhpDocTypesAsCertain: false
   paths:

tests/benchmark/ValidatorBench.php

@@ -1,22 +1,24 @@
 <?php
 
-declare(strict_types=1);
-
-namespace Respect\Validation\Benchmarks;
-
 /*
  * Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
  * SPDX-License-Identifier: MIT
  */
 
-use Generator;
+declare(strict_types=1);
+
+namespace Respect\Validation\Benchmarks;
+
 use PhpBench\Attributes as Bench;
+use Respect\Validation\Test\SmokeTestProvider;
 use Respect\Validation\Validator;
-use Respect\Validation\ValidatorBuilder as v;
 
 class ValidatorBench
 {
-    /** @param array<Validator, mixed> $params */    #[Bench\Iterations(10)]
+    use SmokeTestProvider;
+
+    /** @param array<Validator, mixed> $params */
+    #[Bench\Iterations(10)]
     #[Bench\RetryThreshold(10)]
     #[Bench\Revs(5)]
     #[Bench\ParamProviders(['provideValidatorInput'])]
@@ -25,91 +27,4 @@ public function benchValidate(array $params): void
         [$v, $input] = $params;
         $v->validate($input);
     }
-
-    public function provideValidatorInput(): Generator
-    {
-        yield 'AllOf' => [v::allOf(v::intVal(), v::greaterThan(0)), 5];
-        yield 'Alnum' => [v::alnum(), 'abc123'];
-        yield 'Alpha' => [v::alpha(), 'abc'];
-        yield 'AnyOf' => [v::anyOf(v::intVal(), v::stringVal()), 5];
-        yield 'ArrayType' => [v::arrayType(), []];
-        yield 'ArrayVal' => [v::arrayVal(), []];
-        yield 'Between' => [v::between(1, 10), 5];
-        yield 'BetweenExclusive' => [v::betweenExclusive(1, 10), 5];
-        yield 'BoolType' => [v::boolType(), true];
-        yield 'BoolVal' => [v::boolVal(), true];
-        yield 'Bsn' => [v::bsn(), '612890053'];
-        yield 'Call' => [v::call('array_keys', v::each(v::stringType())), ['a' => 'b']];
-        yield 'Charset' => [v::charset('UTF-8'), 'example'];
-        yield 'Circuit' => [v::circuit(v::intVal(), v::trueVal()), 123];
-        yield 'Cnpj' => [v::cnpj(), '11444777000161'];
-        yield 'Consonant' => [v::consonant(), 'bcdf'];
-        yield 'Contains' => [v::contains('needle'), 'haystack needle'];
-        yield 'ContainsAny' => [v::containsAny(['a', 'b']), 'abc'];
-        yield 'ContainsCount' => [v::containsCount('a', 3), 'banana'];
-        yield 'Control' => [v::control(), "\n\r"];
-        yield 'Countable' => [v::countable(), []];
-        yield 'CountryCode' => [v::countryCode(), 'US'];
-        yield 'Cpf' => [v::cpf(), '11598647644'];
-        yield 'CurrencyCode' => [v::currencyCode(), 'USD'];
-        yield 'Date' => [v::date(), '2020-01-01'];
-        yield 'DateTime' => [v::dateTime(), '2020-01-01 12:00:00'];
-        yield 'Decimal' => [v::decimal(2), '1.23'];
-        yield 'Digit' => [v::digit(), '7'];
-        yield 'Domain' => [v::domain(), 'example.com'];
-        yield 'Each' => [v::each(v::stringType()), ['a', 'b']];
-        yield 'Email' => [v::email(), 'bob@example.com'];
-        yield 'EndsWith' => [v::endsWith('.com'), 'example.com'];
-        yield 'Equals' => [v::equals('x'), 'x'];
-        yield 'Even' => [v::even(), 2];
-        yield 'Executable' => [v::executable(), 'tests/fixtures/executable'];
-        yield 'Exists' => [v::exists(), 'tests/fixtures/valid-image.png'];
-        yield 'FalseVal' => [v::falseVal(), false];
-        yield 'Fibonacci' => [v::fibonacci(), 13];
-        yield 'File' => [v::file(), __FILE__];
-        yield 'FloatType' => [v::floatType(), 1.23];
-        yield 'FloatVal' => [v::floatVal(), 1.23];
-        yield 'GreaterThan' => [v::greaterThan(0), 1];
-        yield 'GreaterThanOrEqual' => [v::greaterThanOrEqual(1), 1];
-        yield 'Hetu' => [v::hetu(), '010106A9012'];
-        yield 'Iban' => [v::iban(), 'SE35 5000 0000 0549 1000 0003'];
-        yield 'Identical' => [v::identical(123), 123];
-        yield 'In' => [v::in(['a', 'b']), 'a'];
-        yield 'IntType' => [v::intType(), 123];
-        yield 'IntVal' => [v::intVal(), 123];
-        yield 'Ip' => [v::ip(), '127.0.0.1'];
-        yield 'IterableVal' => [v::iterableVal(), []];
-        yield 'LanguageCode' => [v::languageCode(), 'en'];
-        yield 'LessThan' => [v::lessThan(10), 5];
-        yield 'LessThanOrEqual' => [v::lessThanOrEqual(10), 10];
-        yield 'Lowercase' => [v::lowercase(), 'abc'];
-        yield 'Luhn' => [v::luhn(), '2222400041240011'];
-        yield 'MacAddress' => [v::macAddress(), '00:11:22:33:44:55'];
-        yield 'Negative' => [v::negative(), -1];
-        yield 'Nip' => [v::nip(), '1645865777'];
-        yield 'Not' => [v::not(v::trueVal()), false];
-        yield 'NullType' => [v::nullType(), null];
-        yield 'NumericVal' => [v::numericVal(), '123'];
-        yield 'Odd' => [v::odd(), 3];
-        yield 'PerfectSquare' => [v::perfectSquare(), 16];
-        yield 'Pesel' => [v::pesel(), '21120209256'];
-        yield 'Property' => [v::property('email', v::endsWith('@example.com')), (object) ['email' => 'a@example.com']];
-        yield 'PropertyExists' => [v::propertyExists('email'), (object) ['email' => 'a@example.com']];
-        yield 'PropertyOptional' => [v::propertyOptional('missing', v::email()), (object) ['email' => 'a@example.com']];
-        yield 'Readable' => [v::readable(), 'tests/fixtures/valid-image.png'];
-        yield 'ScalarVal' => [v::scalarVal(), 'example'];
-        yield 'Slug' => [v::slug(), 'a-valid-slug'];
-        yield 'StartsWith' => [v::startsWith('ex'), 'example'];
-        yield 'StringType' => [v::stringType(), 'example'];
-        yield 'StringVal' => [v::stringVal(), 'example'];
-        yield 'SymbolicLink' => [v::symbolicLink(), 'tests/fixtures/symbolic-link'];
-        yield 'Time' => [v::time(), '12:34:56'];
-        yield 'TrueVal' => [v::trueVal(), true];
-        yield 'Unique' => [v::unique(), [1, 2, 3]];
-        yield 'Uppercase' => [v::uppercase(), 'ABC'];
-        yield 'Uuid' => [v::uuid(), '123e4567-e89b-12d3-a456-426655440000'];
-        yield 'When' => [v::when(v::trueVal(), v::intVal()), 123];
-        yield 'Writable' => [v::writable(), 'tests/fixtures/valid-image.png'];
-        yield 'Xdigit' => [v::xdigit(), 'AF'];
-    }
 }

tests/feature/SerializableTest.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+use Respect\Validation\Test\SmokeTestProvider;
+
+test('Can be serialized and unserialized', function ($validator, $input): void {
+    expect(
+        unserialize(serialize($validator))->validate($input)->isValid(),
+    )->toBeTrue();
+})->with(fn(): Generator => (new class {
+    use SmokeTestProvider {
+        provideValidatorInput as public __invoke;
+    }
+})());