ValidatorTest.php$4 ➔ skipOnEmptyDataProvider() - Code Metrics - Inspection of "Add ability to pass predefined result" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#599)

by Sergei
created 2023-04-04 10:55 UTC
ValidatorTest.php$4 ➔ skipOnEmptyDataProvider() B

↳ Parent: ValidatorTest
Complexity

Conditions
Size

Total Lines
554
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
c	0
b	0
f	0
dl	0
loc	554
cc	1
rs	8
How to fix Long Method

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Tests;

use InvalidArgumentException;
use PHPUnit\Framework\TestCase;
use stdClass;
use Yiisoft\Validator\AttributeTranslator\NullAttributeTranslator;
use Yiisoft\Validator\DataSet\ArrayDataSet;
use Yiisoft\Validator\DataSet\ObjectDataSet;
use Yiisoft\Validator\DataSet\SingleValueDataSet;
use Yiisoft\Validator\DataSetInterface;
use Yiisoft\Validator\EmptyCondition\WhenEmpty;
use Yiisoft\Validator\EmptyCondition\WhenNull;
use Yiisoft\Validator\Error;
use Yiisoft\Validator\Exception\RuleHandlerInterfaceNotImplementedException;
use Yiisoft\Validator\Exception\RuleHandlerNotFoundException;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule\AtLeast;
use Yiisoft\Validator\Rule\BooleanValue;
use Yiisoft\Validator\Rule\Compare;
use Yiisoft\Validator\Rule\Integer;
use Yiisoft\Validator\Rule\Length;
use Yiisoft\Validator\Rule\In;
use Yiisoft\Validator\Rule\StringValue;
use Yiisoft\Validator\Rule\TrueValue;
use Yiisoft\Validator\Rule\Number;
use Yiisoft\Validator\Rule\Required;
use Yiisoft\Validator\RuleInterface;
use Yiisoft\Validator\RulesProviderInterface;
use Yiisoft\Validator\Tests\Rule\RuleWithBuiltInHandler;
use Yiisoft\Validator\Tests\Support\Data\EachNestedObjects\Foo;
use Yiisoft\Validator\Tests\Support\Data\IteratorWithBooleanKey;
use Yiisoft\Validator\Tests\Support\Data\ObjectWithAttributesOnly;
use Yiisoft\Validator\Tests\Support\Data\ObjectWithDataSet;
use Yiisoft\Validator\Tests\Support\Data\ObjectWithDataSetAndRulesProvider;
use Yiisoft\Validator\Tests\Support\Data\ObjectWithDifferentPropertyVisibility;
use Yiisoft\Validator\Tests\Support\Data\DataSetWithPostValidationHook;
use Yiisoft\Validator\Tests\Support\Data\ObjectWithPostValidationHook;
use Yiisoft\Validator\Tests\Support\Data\ObjectWithRulesProvider;
use Yiisoft\Validator\Tests\Support\Data\SimpleDto;
use Yiisoft\Validator\Tests\Support\Data\SimpleForm;
use Yiisoft\Validator\Tests\Support\Rule\NotNullRule\NotNull;
use Yiisoft\Validator\Tests\Support\Rule\StubRule\StubRuleWithOptions;
use Yiisoft\Validator\ValidationContext;
use Yiisoft\Validator\Validator;
use Yiisoft\Validator\ValidatorInterface;

class ValidatorTest extends TestCase
{
    public function testBase(): void
    {
        $validator = new Validator();

        $result = $validator->validate(new ObjectWithAttributesOnly());

        $this->assertFalse($result->isValid());
        $this->assertSame(
            ['name' => ['This value must contain at least 5 characters.']],
            $result->getErrorMessagesIndexedByPath()
        );
    }

    public function testWithDefaultSkipOnEmptyCondition(): void
    {
        $data = '';
        $rule = new Length(1);
        $validator = new Validator();

        $result = $validator->validate($data, $rule);
        $this->assertFalse($result->isValid());

        $newValidator = $validator->withDefaultSkipOnEmptyCondition(true);
        $this->assertNotSame($validator, $newValidator);

        $result = $newValidator->validate($data, $rule);
        $this->assertTrue($result->isValid());
    }

    public function dataDataAndRulesCombinations(): array
    {
        return [
            'pure-object-and-array-of-rules' => [
                [
                    'number' => ['Value must be no less than 77.'],
                ],
                new ObjectWithDifferentPropertyVisibility(),
                [
                    'age' => new Number(max: 100),
                    'number' => new Number(min: 77),
                ],
            ],
            'pure-object-and-no-rules' => [
                [
                    'name' => ['Value cannot be blank.'],
                    'age' => ['Value must be no less than 21.'],
                ],
                new ObjectWithDifferentPropertyVisibility(),
                null,
            ],
            'dataset-object-and-array-of-rules' => [
                [
                    'key1' => ['Value must be no less than 21.'],
                ],
                new ObjectWithDataSet(),
                [
                    'key1' => new Number(min: 21),
                ],
            ],
            'dataset-object-and-no-rules' => [
                [],
                new ObjectWithDataSet(),
                null,
            ],
            'rules-provider-object-and-array-of-rules' => [
                [
                    'number' => ['Value must be no greater than 7.'],
                ],
                new ObjectWithRulesProvider(),
                [
                    'age' => new Number(max: 100),
                    'number' => new Number(max: 7),
                ],
            ],
            'rules-provider-object-and-no-rules' => [
                [
                    'age' => ['Value must be equal to "25".'],
                ],
                new ObjectWithRulesProvider(),
                null,
            ],
            'rules-provider-and-dataset-object-and-array-of-rules' => [
                [
                    'key2' => ['Value must be no greater than 7.'],
                ],
                new ObjectWithDataSetAndRulesProvider(),
                [
                    'key2' => new Number(max: 7),
                ],
            ],
            'rules-provider-and-dataset-object-and-no-rules' => [
                [
                    'key2' => ['Value must be equal to "99".'],
                ],
                new ObjectWithDataSetAndRulesProvider(),
                null,
            ],
            'array-and-array-of-rules' => [
                [
                    'key2' => ['Value must be no greater than 7.'],
                ],
                ['key1' => 15, 'key2' => 99],
                [
                    'key1' => new Number(max: 100),
                    'key2' => new Number(max: 7),
                ],
            ],
            'array-and-no-rules' => [
                [],
                ['key1' => 15, 'key2' => 99],
                null,
            ],
            'scalar-and-array-of-rules' => [
                [
                    '' => ['Value must be no greater than 7.'],
                ],
                42,
                [
                    new Number(max: 7),
                ],
            ],
            'scalar-and-no-rules' => [
                [],
                42,
                null,
            ],
            'array-and-rules-provider' => [
                [
                    'age' => ['Value must be no less than 18.'],
                ],
                [
                    'age' => 17,
                ],
                new class () implements RulesProviderInterface {
                    public function getRules(): iterable
                    {
                        return [
                            'age' => [new Number(min: 18)],
                        ];
                    }
                },
            ],
            'array-and-object' => [
                [
                    'name' => ['Value not passed.'],
                    'bars' => ['Value must be array or iterable.'],
                ],
                [],
                new Foo(),
            ],
            'array-and-callable' => [
                ['' => ['test message']],
                [],
                static fn (): Result => (new Result())->addError('test message'),
            ],
        ];
    }

    /**
     * @dataProvider dataDataAndRulesCombinations
     */
    public function testDataAndRulesCombinations(
        array $expectedErrorMessages,
        mixed $data,
        iterable|object|callable|null $rules,
    ): void {
        $validator = new Validator();
        $result = $validator->validate($data, $rules);
        $this->assertSame($expectedErrorMessages, $result->getErrorMessagesIndexedByAttribute());
    }

    public function dataWithEmptyArrayOfRules(): array
    {
        return [
            'pure-object-and-no-rules' => [new ObjectWithDifferentPropertyVisibility()],
            'dataset-object-and-no-rules' => [new ObjectWithDataSet()],
            'rules-provider-object' => [new ObjectWithRulesProvider()],
            'rules-provider-and-dataset-object' => [new ObjectWithDataSetAndRulesProvider()],
            'array' => [['key1' => 15, 'key2' => 99]],
            'scalar' => [42],
        ];
    }

    /**
     * @dataProvider dataWithEmptyArrayOfRules
     */
    public function testWithEmptyArrayOfRules(mixed $data): void
    {
        $validator = new Validator();
        $result = $validator->validate($data, []);

        $this->assertTrue($result->isValid());
    }

    public function testAddingRulesViaConstructor(): void
    {
        $dataObject = new ArrayDataSet(['bool' => true, 'int' => 41]);
        $validator = new Validator();
        $result = $validator->validate($dataObject, [
            'bool' => [new BooleanValue()],
            'int' => [
                new Integer(),
                new Integer(min: 44),
                static function (mixed $value): Result {
                    $result = new Result();
                    if ($value !== 42) {
                        $result->addError('Value should be 42!', ['int']);
                    }

                    return $result;
                },
            ],
        ]);

        $this->assertTrue($result->isAttributeValid('bool'));
        $this->assertFalse($result->isAttributeValid('int'));
    }

    public function diverseTypesDataProvider(): array
    {
        $class = new stdClass();
        $class->property = true;

        return [
            'object' => [new ObjectDataSet($class, useCache: false)],
            'true' => [true],
            'non-empty-string' => ['true'],
            'integer' => [12345],
            'float' => [12.345],
            'false' => [false],
        ];
    }

    /**
     * @dataProvider diverseTypesDataProvider
     */
    public function testDiverseTypes($dataSet): void
    {
        $validator = new Validator();
        $result = $validator->validate($dataSet, [new Required()]);

        $this->assertTrue($result->isValid());
    }

    public function testNullAsDataSet(): void
    {
        $validator = new Validator();
        $result = $validator->validate(null, ['property' => [new Compare()]]);

        $this->assertTrue($result->isValid());
    }

    public function testPreValidation(): void
    {
        $validator = new Validator();
        $result = $validator->validate(
            new ArrayDataSet(['property' => '']),
            ['property' => [new Required(when: static fn (mixed $value, ?ValidationContext $context): bool => false)]],
            ['property' => [new Required(when: static fn (mixed $value, /** @scrutinizer ignore-unused */ ?ValidationContext $context): bool => false)]],
        );

        $this->assertTrue($result->isValid());
    }

    public function testRuleHandlerWithoutImplement(): void
    {
        $ruleHandler = new class () {
        };
        $validator = new Validator();

        $this->expectException(RuleHandlerInterfaceNotImplementedException::class);
        $validator->validate(new ArrayDataSet(['property' => '']), [
            'property' => [
                new class ($ruleHandler) implements RuleInterface {
                    public function __construct(private $ruleHandler)
                    {
                    }

                    public function getName(): string
                    {
                        return 'test';
                    }

                    public function getHandler(): string
                    {
                        return $this->ruleHandler::class;
                    }
                },
            ],
        ]);
    }

    public function testRuleWithoutHandler(): void
    {
        $this->expectException(RuleHandlerNotFoundException::class);

        $validator = new Validator();
        $validator->validate(new ArrayDataSet(['property' => '']), [
            'property' => [
                new class () implements RuleInterface {
                    public function getName(): string
                    {
                        return 'test';
                    }

                    public function getHandler(): string
                    {
                        return 'NonExistClass';
                    }
                },
            ],
        ]);
    }

    public function requiredDataProvider(): array
    {
        $strictRules = [
            'orderBy' => [new Required()],
            'sort' => [
                new In(
                    ['asc', 'desc'],
                    skipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $isAttributeMissing
                ),
            ],
        ];
        $notStrictRules = [
            'orderBy' => [new Required()],
            'sort' => [
                new In(
                    ['asc', 'desc'],
                    skipOnEmpty: static fn (
                        mixed $value,
                        bool $isAttributeMissing
                    ): bool => $isAttributeMissing || $value === ''
                ),
            ],
        ];

        return [
            [
                ['merchantId' => [new Required(), new Integer()]],
                new ArrayDataSet(['merchantId' => null]),
                [
                    new Error(
                        'Value cannot be blank.',
                        ['attribute' => 'merchantId'],
                        ['merchantId']
                    ),
                    new Error(
                        'The allowed types are integer, float and string.',
                        ['attribute' => 'merchantId', 'type' => 'null'],
                        ['merchantId']
                    ),
                ],
            ],
            [
                ['merchantId' => [new Required(), new Integer(skipOnError: true)]],
                new ArrayDataSet(['merchantId' => null]),
                [new Error('Value cannot be blank.', [ 'attribute' => 'merchantId'], ['merchantId'])],
            ],
            [
                ['merchantId' => [new Required(), new Integer(skipOnError: true)]],
                new ArrayDataSet(['merchantIdd' => 1]),
                [new Error('Value not passed.', ['attribute' => 'merchantId'], ['merchantId'])],
            ],

            [
                $strictRules,
                new ArrayDataSet(['orderBy' => 'name', 'sort' => 'asc']),
                [],
            ],
            [
                $notStrictRules,
                new ArrayDataSet(['orderBy' => 'name', 'sort' => 'asc']),
                [],
            ],

            [
                $strictRules,
                new ArrayDataSet(['orderBy' => 'name', 'sort' => 'desc']),
                [],
            ],
            [
                $notStrictRules,
                new ArrayDataSet(['orderBy' => 'name', 'sort' => 'desc']),
                [],
            ],

            [
                $strictRules,
                new ArrayDataSet(['orderBy' => 'name', 'sort' => 'up']),
                [new Error('This value is not in the list of acceptable values.', ['attribute' => 'sort'], ['sort'])],
            ],
            [
                $notStrictRules,
                new ArrayDataSet(['orderBy' => 'name', 'sort' => 'up']),
                [new Error('This value is not in the list of acceptable values.', ['attribute' => 'sort'], ['sort'])],
            ],

            [
                $strictRules,
                new ArrayDataSet(['orderBy' => 'name', 'sort' => '']),
                [new Error('This value is not in the list of acceptable values.', ['attribute' => 'sort'], ['sort'])],
            ],
            [
                $notStrictRules,
                new ArrayDataSet(['orderBy' => 'name', 'sort' => '']),
                [],
            ],

            [
                $strictRules,
                new ArrayDataSet(['orderBy' => 'name']),
                [],
            ],
            [
                $notStrictRules,
                new ArrayDataSet(['orderBy' => 'name']),
                [],
            ],

            [
                $strictRules,
                new ArrayDataSet(['orderBy' => '']),
                [new Error('Value cannot be blank.', ['attribute' => 'orderBy'], ['orderBy'])],
            ],
            [
                $notStrictRules,
                new ArrayDataSet(['orderBy' => '']),
                [new Error('Value cannot be blank.', ['attribute' => 'orderBy'], ['orderBy'])],
            ],

            [
                $strictRules,
                new ArrayDataSet([]),
                [new Error('Value not passed.', ['attribute' => 'orderBy'], ['orderBy'])],
            ],
            [
                $notStrictRules,
                new ArrayDataSet([]),
                [new Error('Value not passed.', ['attribute' => 'orderBy'], ['orderBy'])],
            ],
            [
                [
                    'name' => [new Required(), new Length(min: 3, skipOnError: true)],
                    'description' => [new Required(), new Length(min: 5, skipOnError: true)],
                ],
                new ObjectDataSet(
                    new class () {
                        private string $title = '';

                        private string $description = 'abc123';

                    }
                ),
                [new Error('Value not passed.', ['attribute' => 'name'], ['name'])],
            ],
            [
                null,
                new ObjectDataSet(new ObjectWithDataSet()),
                [],
            ],
        ];
    }

    /**
     * @link https://github.com/yiisoft/validator/issues/173
     * @link https://github.com/yiisoft/validator/issues/289
     * @dataProvider requiredDataProvider
     */
    public function testRequired(array|null $rules, DataSetInterface $dataSet, array $expectedErrors): void
    {
        $validator = new Validator();
        $result = $validator->validate($dataSet, $rules);
        $this->assertEquals($expectedErrors, $result->getErrors());
    }

    public function skipOnEmptyDataProvider(): array
    {
        $validator = new Validator();
        $rules = [
            'name' => [new Length(min: 8)],
            'age' => [new Integer(min: 18)],
        ];
        $stringLessThanMinMessage = 'This value must contain at least 8 characters.';
        $incorrectNumberMessage = 'The allowed types are integer, float and string.';
        $intMessage = 'Value must be an integer.';
        $intLessThanMinMessage = 'Value must be no less than 18.';

        return [
            'rule / validator, skipOnEmpty: false, value not passed' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($incorrectNumberMessage, [
                        'attribute' => 'age',
                        'type' => 'null',
                    ], ['age']),
                ],
            ],
            'rule / validator, skipOnEmpty: false, value is empty' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => null,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($incorrectNumberMessage, [
                        'attribute' => 'age',
                        'type' => 'null',
                    ], ['age']),
                ],
            ],
            'rule / validator, skipOnEmpty: false, value is not empty' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 17,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],

            'rule, skipOnEmpty: true, value not passed' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [new Integer(min: 18, skipOnEmpty: true)],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'rule, skipOnEmpty: true, value is empty (null)' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => null,
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [new Integer(min: 18, skipOnEmpty: true)],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'rule, skipOnEmpty: true, value is empty (empty string after trimming), trimString is false' => [
                $validator,
                new ArrayDataSet([
                    'name' => ' ',
                    'age' => 17,
                ]),
                [
                    'name' => [new Length(min: 8, skipOnEmpty: true)],
                    'age' => [new Integer(min: 18)],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 1,
                    ], ['name']),
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],
            'rule, skipOnEmpty: SkipOnEmpty, value is empty (empty string after trimming), trimString is true' => [
                $validator,
                new ArrayDataSet([
                    'name' => ' ',
                    'age' => 17,
                ]),
                [
                    'name' => [new Length(min: 8, skipOnEmpty: new WhenEmpty(trimString: true))],
                    'age' => [new Integer(min: 18)],
                ],
                [
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],
            'rule, skipOnEmpty: true, value is not empty' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 17,
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [new Integer(min: 18, skipOnEmpty: true)],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],

            'rule, skipOnEmpty: SkipOnNull, value not passed' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [new Integer(min: 18, skipOnEmpty: new WhenNull())],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'rule, skipOnEmpty: SkipOnNull, value is empty' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => null,
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [new Integer(min: 18, skipOnEmpty: new WhenNull())],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'rule, skipOnEmpty: SkipOnNull, value is not empty' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 17,
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [new Integer(min: 18, skipOnEmpty: new WhenNull())],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],
            'rule, skipOnEmpty: SkipOnNull, value is not empty (empty string)' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => '',
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [new Integer(min: 18, skipOnEmpty: new WhenNull())],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intMessage, [
                        'attribute' => 'age',
                        'value' => '',
                    ], ['age']),
                ],
            ],

            'rule, skipOnEmpty: custom callback, value not passed' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [
                        new Integer(
                            min: 18,
                            skipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $value === 0
                            skipOnEmpty: static fn (mixed $value, /** @scrutinizer ignore-unused */ bool $isAttributeMissing): bool => $value === 0
                        ),
                    ],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($incorrectNumberMessage, [
                        'attribute' => 'age',
                        'type' => 'null',
                    ], ['age']),
                ],
            ],
            'rule, skipOnEmpty: custom callback, value is empty' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 0,
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [
                        new Integer(
                            min: 18,
                            skipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $value === 0
                            skipOnEmpty: static fn (mixed $value, /** @scrutinizer ignore-unused */ bool $isAttributeMissing): bool => $value === 0
                        ),
                    ],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'rule, skipOnEmpty, custom callback, value is not empty' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 17,
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [
                        new Integer(
                            min: 18,
                            skipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $value === 0
                            skipOnEmpty: static fn (mixed $value, /** @scrutinizer ignore-unused */ bool $isAttributeMissing): bool => $value === 0
                        ),
                    ],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],
            'rule, skipOnEmpty, custom callback, value is not empty (null)' => [
                $validator,
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => null,
                ]),
                [
                    'name' => [new Length(min: 8)],
                    'age' => [
                        new Integer(
                            min: 18,
                            skipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $value === 0
                            skipOnEmpty: static fn (mixed $value, /** @scrutinizer ignore-unused */ bool $isAttributeMissing): bool => $value === 0
                        ),
                    ],
                ],
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($incorrectNumberMessage, [
                        'attribute' => 'age',
                        'type' => 'null',
                    ], ['age']),
                ],
            ],

            'validator, skipOnEmpty: true, value not passed' => [
                new Validator(defaultSkipOnEmpty: true),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'validator, skipOnEmpty: true, value is empty' => [
                new Validator(defaultSkipOnEmpty: true),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => null,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'validator, skipOnEmpty: true, value is not empty' => [
                new Validator(defaultSkipOnEmpty: true),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 17,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],

            'validator, skipOnEmpty: SkipOnNull, value not passed' => [
                new Validator(defaultSkipOnEmpty: new WhenNull()),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'validator, skipOnEmpty: SkipOnNull, value is empty' => [
                new Validator(defaultSkipOnEmpty: new WhenNull()),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => null,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'validator, skipOnEmpty: SkipOnNull, value is not empty' => [
                new Validator(defaultSkipOnEmpty: new WhenNull()),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 17,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],
            'validator, skipOnEmpty: SkipOnNull, value is not empty (empty string)' => [
                new Validator(defaultSkipOnEmpty: new WhenNull()),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => '',
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intMessage, [
                        'attribute' => 'age',
                        'value' => '',
                    ], ['age']),
                ],
            ],

            'validator, skipOnEmpty: custom callback, value not passed' => [
                new Validator(
                    defaultSkipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $value === 0
                    defaultSkipOnEmpty: static fn (mixed $value, /** @scrutinizer ignore-unused */ bool $isAttributeMissing): bool => $value === 0
                ),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($incorrectNumberMessage, [
                        'attribute' => 'age',
                        'type' => 'null',
                    ], ['age']),
                ],
            ],
            'validator, skipOnEmpty: custom callback, value is empty' => [
                new Validator(
                    defaultSkipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $value === 0
                    defaultSkipOnEmpty: static fn (mixed $value, /** @scrutinizer ignore-unused */ bool $isAttributeMissing): bool => $value === 0
                ),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 0,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                ],
            ],
            'validator, skipOnEmpty: custom callback, value is not empty' => [
                new Validator(
                    defaultSkipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $value === 0
                    defaultSkipOnEmpty: static fn (mixed $value, /** @scrutinizer ignore-unused */ bool $isAttributeMissing): bool => $value === 0
                ),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => 17,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($intLessThanMinMessage, [
                        'min' => 18,
                        'attribute' => 'age',
                        'value' => 17,
                    ], ['age']),
                ],
            ],
            'validator, skipOnEmpty: custom callback, value is not empty (null)' => [
                new Validator(
                    defaultSkipOnEmpty: static fn (mixed $value, bool $isAttributeMissing): bool => $value === 0
                    defaultSkipOnEmpty: static fn (mixed $value, /** @scrutinizer ignore-unused */ bool $isAttributeMissing): bool => $value === 0
                ),
                new ArrayDataSet([
                    'name' => 'Dmitriy',
                    'age' => null,
                ]),
                $rules,
                [
                    new Error($stringLessThanMinMessage, [
                        'min' => 8,
                        'attribute' => 'name',
                        'number' => 7,
                    ], ['name']),
                    new Error($incorrectNumberMessage, [
                        'attribute' => 'age',
                        'type' => 'null',
                    ], ['age']),
                ],
            ],
        ];
    }

    /**
     * @param StubRuleWithOptions[] $rules
     * @param Error[] $expectedErrors
     *
     * @dataProvider skipOnEmptyDataProvider
     */
    public function testSkipOnEmpty(Validator $validator, ArrayDataSet $data, array $rules, array $expectedErrors): void
    {
        $result = $validator->validate($data, $rules);
        $this->assertEquals($expectedErrors, $result->getErrors());
    }

    public function initSkipOnEmptyDataProvider(): array
    {
        return [
            'null' => [
                null,
                new class () {
                    #[Number]
                    public ?string $name = null;
                },
                false,
            ],
            'false' => [
                false,
                new class () {
                    #[Number]
                    public ?string $name = null;
                },
                false,
            ],
            'true' => [
                true,
                new class () {
                    #[Number]
                    public ?string $name = null;
                },
                true,
            ],
            'callable' => [
                new WhenNull(),
                new class () {
                    #[Number]
                    public ?string $name = null;
                },
                true,
            ],
            'do-not-override-rule' => [
                false,
                new class () {
                    #[Number(skipOnEmpty: true)]
                    public string $name = '';
                },
                true,
            ],
        ];
    }

    /**
     * @dataProvider initSkipOnEmptyDataProvider
     */
    public function testInitSkipOnEmpty(
        bool|callable|null $skipOnEmpty,
        mixed $data,
        bool $expectedResult,
    ): void {
        $validator = new Validator(defaultSkipOnEmpty: $skipOnEmpty);

        $result = $validator->validate($data);

        $this->assertSame($expectedResult, $result->isValid());
    }

    public function testObjectWithAttributesOnly(): void
    {
        $object = new ObjectWithAttributesOnly();

        $validator = new Validator();

        $result = $validator->validate($object);

        $this->assertFalse($result->isValid());
        $this->assertCount(1, $result->getErrorMessages());
        $this->assertStringStartsWith('This value must contain at least', $result->getErrorMessages()[0]);
    }

    public function testRuleWithoutSkipOnEmpty(): void
    {
        $validator = new Validator(defaultSkipOnEmpty: new WhenNull());

        $data = new class () {
            #[NotNull]
            public ?string $name = null;
        };

        $result = $validator->validate($data);

        $this->assertFalse($result->isValid());
    }

    public function testValidateWithSingleRule(): void
    {
        $result = (new Validator())->validate(3, new Number(min: 5));

        $this->assertFalse($result->isValid());
        $this->assertSame(
            ['' => ['Value must be no less than 5.']],
            $result->getErrorMessagesIndexedByPath(),
        );
    }

    public function testComposition(): void
    {
        $validator = new class () implements ValidatorInterface {
            private Validator $validator;

            public function __construct()
            {
                $this->validator = new Validator();
            }

            public function validate(
                mixed $data,
                callable|iterable|object|string|null $rules = null,
                ?ValidationContext $context = null
            ): Result {
                $context ??= new ValidationContext();

                $result = $this->validator->validate($data, $rules, $context);

                return $context->getParameter('forceSuccess') === true ? new Result() : $result;
            }
        };

        $rules = [
            static function ($value, $rule, ValidationContext $context) {
                $context->setParameter('forceSuccess', true);
                return (new Result())->addError('fail');
            },
        ];

        $result = $validator->validate([], $rules);

        $this->assertTrue($result->isValid());
    }

    public function testRulesWithWrongKey(): void
    {
        $validator = new Validator();

        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('An attribute can only have an integer or a string type. bool given.');
        $validator->validate([], new IteratorWithBooleanKey());
    }

    public function testRulesWithWrongRule(): void
    {
        $validator = new Validator();

        $this->expectException(InvalidArgumentException::class);
        $message = 'Rule must be either an instance of Yiisoft\Validator\RuleInterface or a callable, int given.';
        $this->expectExceptionMessage($message);
        $validator->validate([], [new BooleanValue(), 1]);
    }

    public function testRulesAsObjectNameWithRuleAttributes(): void
    {
        $validator = new Validator();
        $result = $validator->validate(['name' => 'Test name'], ObjectWithAttributesOnly::class);
        $this->assertTrue($result->isValid());
    }

    public function testRulesAsObjectWithRuleAttributes(): void
    {
        $validator = new Validator();
        $result = $validator->validate(['name' => 'Test name'], new ObjectWithAttributesOnly());
        $this->assertTrue($result->isValid());
    }

    public function testDataSetWithPostValidationHook(): void
    {
        $validator = new Validator();
        $dataSet = new DataSetWithPostValidationHook();

        $result = $validator->validate($dataSet);

        $this->assertTrue($result->isValid());
        $this->assertTrue($dataSet->hookCalled);
    }

    public function testObjectWithPostValidationHook(): void
    {
        $validator = new Validator();
        $object = new ObjectWithPostValidationHook();

        $result = $validator->validate($object);

        $this->assertTrue($result->isValid());
        $this->assertTrue($object->hookCalled);
    }

    public function testSkippingRuleInPreValidate(): void
    {
        $data = ['agree' => false, 'viewsCount' => -1];
        $rules = [
            'agree' => [new BooleanValue(skipOnEmpty: static fn (): bool => true), new TrueValue()],
            'viewsCount' => [new Integer(min: 0)],
        ];
        $validator = new Validator();

        $result = $validator->validate($data, $rules);
        $this->assertSame(
            [
                'agree' => ['The value must be "1".'],
                'viewsCount' => ['Value must be no less than 0.'],
            ],
            $result->getErrorMessagesIndexedByPath(),
        );
    }

    public function testDefaultTranslatorWithIntl(): void
    {
        $data = ['number' => 3];
        $rules = [
            'number' => new Integer(
                max: 2,
                greaterThanMaxMessage: '{value, selectordinal, one{#-one} two{#-two} few{#-few} other{#-other}}',
            ),
        ];
        $validator = new Validator();

        $result = $validator->validate($data, $rules);
        $this->assertSame(['number' => ['3-few']], $result->getErrorMessagesIndexedByPath());
    }

    public function dataSimpleForm(): array
    {
        return [
            [
                [
                    'name' => [
                        'Имя плохое.',
                    ],
                    'mail' => [
                        'This value is not a valid email address.',
                    ],
                ],
                null,
            ],
            [
                [
                    'name' => [
                        'name плохое.',
                    ],
                    'mail' => [
                        'This value is not a valid email address.',
                    ],
                ],
                new ValidationContext(attributeTranslator: new NullAttributeTranslator()),
            ],
        ];
    }

    /**
     * @dataProvider dataSimpleForm
     */
    public function testSimpleForm(array $expectedMessages, ?ValidationContext $validationContext): void
    {
        $form = new SimpleForm();

        $result = (new Validator())->validate($form, context: $validationContext);

        $this->assertSame(
            $expectedMessages,
            $result->getErrorMessagesIndexedByPath()
        );
    }

    public function dataOriginalValueUsage(): array
    {
        $data = [
            'null' => [null, null],
            'string' => ['hello', 'hello'],
            'integer' => [42, 42],
            'array' => [['param' => 7], ['param' => 7]],
            'array-data-set' => [['param' => 42], new ArrayDataSet(['param' => 42])],
            'single-value-data-set' => [7, new SingleValueDataSet(7)],
        ];

        $object = new stdClass();
        $data['object'] = [$object, $object];

        $simpleDto = new SimpleDto();
        $data['object-data-set'] = [$simpleDto, new ObjectDataSet($simpleDto)];

        return $data;
    }

    /**
     * @dataProvider dataOriginalValueUsage
     */
    public function testOriginalValueUsage(mixed $expectedValue, mixed $value): void
    {
        $valueHandled = false;
        $valueInHandler = null;

        (new Validator())->validate(
            $value,
            static function ($value) use (&$valueHandled, &$valueInHandler): Result {
                $valueHandled = true;
                $valueInHandler = $value;
                return new Result();
            },
        );

        $this->assertTrue($valueHandled);
        $this->assertSame($expectedValue, $valueInHandler);
    }

    public function testRuleWithBuiltInHandler(): void
    {
        $rule = new RuleWithBuiltInHandler();

        $result = (new Validator())->validate(19, $rule);

        $this->assertSame(
            ['' => ['Value must be 42.']],
            $result->getErrorMessagesIndexedByPath()
        );
    }

    public function testDifferentValueAsArrayInSameContext(): void
    {
        $result = (new Validator())->validate(
            ['x' => ['a' => 1, 'b' => 2]],
            [
                new AtLeast(['x']),
                'x' => new AtLeast(['a', 'b']),
            ],
        );
        $this->assertTrue($result->isValid());
    }

    public function testPredefinedResult(): void
    {
        $context = new ValidationContext([
            ValidationContext::PARAMETER_PREDEFINED_RESULT =>
                (new Result())->addError('test error', valuePath: ['a']),
        ]);

        $result = (new Validator())->validate(
            ['a' => null],
            ['a' => new StringValue(skipOnError: true)],
            $context,
        );

        $this->assertSame(
            ['a' => ['test error']],
            $result->getErrorMessagesIndexedByPath()
        );
    }

    public function testPredefinedResultWithContextValidation(): void
    {
        $context = new ValidationContext([
            ValidationContext::PARAMETER_PREDEFINED_RESULT =>
                (new Result())->addError('test error', valuePath: ['a']),
        ]);

        $result = (new Validator())->validate(
            ['a' => null],
            [
                'a' => static function (mixed $value, object $rule, ValidationContext $context): Result {
                    return $context->validate([], ['a' => new Required()]);
                },
            ],
            $context,
        );

        $this->assertSame(
            [
                'a' => ['test error'],
                'a.a' => ['Value not passed.'],
            ],
            $result->getErrorMessagesIndexedByPath()
        );
    }

    public function testInvalidPredefinedResult(): void
    {
        $context = new ValidationContext([
            ValidationContext::PARAMETER_PREDEFINED_RESULT => 42,
        ]);

        $validator = new Validator();

        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Result parameter must be "Yiisoft\Validator\Result", but "int" given.');
        $validator->validate(null, context: $context);
    }
}

yiisoft / validator

Pull Request — master (#599)

ValidatorTest.php$4 ➔ skipOnEmptyDataProvider() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
