CompareToTest::dataOptions() - Code Metrics - Inspection of "Docs, part 3" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#415)

unknown

created 2022-12-01 12:08 UTC

CompareToTest::dataOptions() B

↳ Parent: CompareToTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	357
Code Lines	256

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	256
nc	1
nop	0
dl	0
loc	357
rs	8
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Tests\Rule;

use InvalidArgumentException;
use stdClass;
use Yiisoft\Validator\DataSetInterface;
use Yiisoft\Validator\Rule\Compare;
use Yiisoft\Validator\Rule\CompareTo;
use Yiisoft\Validator\Tests\Rule\Base\RuleTestCase;
use Yiisoft\Validator\Tests\Rule\Base\RuleWithOptionsTestTrait;
use Yiisoft\Validator\Tests\Rule\Base\SkipOnErrorTestTrait;
use Yiisoft\Validator\Tests\Rule\Base\WhenTestTrait;

final class CompareToTest extends RuleTestCase
{
    use RuleWithOptionsTestTrait;
    use SkipOnErrorTestTrait;
    use WhenTestTrait;

    public function testInitWithWrongOperator(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $message = 'Operator "=" is not supported. The valid operators are: "==", "===", "!=", "!==", ">", ">=", ' .
            '"<", "<=".';
        $this->expectExceptionMessage($message);
        new CompareTo(operator: '=');
    }

    public function testGetName(): void
    {
        $rule = new CompareTo();
        $this->assertSame('compareTo', $rule->getName());
    }

    public function dataOptions(): array
    {
        return [
            [
                new CompareTo(1),
                [
                    'targetValue' => 1,
                    'targetAttribute' => null,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo(1, type: CompareTo::TYPE_NUMBER),
                [
                    'targetValue' => 1,
                    'targetAttribute' => null,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'type' => 'number',
                    'operator' => '==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo(1, type: CompareTo::TYPE_NUMBER, operator: '>='),
                [
                    'targetValue' => 1,
                    'targetAttribute' => null,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must be greater than or equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'type' => 'number',
                    'operator' => '>=',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo('YES'),
                [
                    'targetValue' => 'YES',
                    'targetAttribute' => null,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo('YES', skipOnEmpty: true),
                [
                    'targetValue' => 'YES',
                    'targetAttribute' => null,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '==',
                    'skipOnEmpty' => true,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo('YES', operator: '!=='),
                [
                    'targetValue' => 'YES',
                    'targetAttribute' => null,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '!==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo('YES', message: 'Custom message for {targetValueOrAttribute}.'),
                [
                    'targetValue' => 'YES',
                    'targetAttribute' => null,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'message' => [
                        'template' => 'Custom message for {targetValueOrAttribute}.',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo(null, 'test'),
                [
                    'targetValue' => null,
                    'targetAttribute' => 'test',
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 'test',
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 'test',
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 'test',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo(
                    null,
                    'test',
                    incorrectInputMessage: 'Custom message 1.',
                    incorrectDataSetTypeMessage: 'Custom message 2.',
                    message: 'Custom message 3.',
                ),
                [
                    'targetValue' => null,
                    'targetAttribute' => 'test',
                    'incorrectInputMessage' => [
                        'template' => 'Custom message 1.',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 'test',
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'Custom message 2.',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 'test',
                        ],
                    ],
                    'message' => [
                        'template' => 'Custom message 3.',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 'test',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new CompareTo(1, 'test'),
                [
                    'targetValue' => 1,
                    'targetAttribute' => 'test',
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => 'test',
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
        ];
    }

    public function dataValidationPassed(): array
    {
        return [
            [null, [new CompareTo('')]],
            [null, [new CompareTo('', operator: '===')]],

            [100, [new CompareTo(100)]],
            [['attribute' => 100, 'number' => 100], ['number' => new CompareTo(null, 'attribute')]],
            ['100', [new CompareTo(100)]],

            [100, [new CompareTo(100, operator: '===')]],
            ['100', [new CompareTo(100, operator: '===')]],
            [100.0, [new CompareTo(100, operator: '===')]],

            [100.00001, [new CompareTo(100, operator: '!=')]],
            [false, [new CompareTo(100, operator: '!=')]],

            [false, [new CompareTo(100, operator: '!==')]],

            [101, [new CompareTo(100, operator: '>')]],

            [100, [new CompareTo(100, operator: '>=')]],
            [101, [new CompareTo(100, operator: '>=')]],
            [99, [new CompareTo(100, operator: '<')]],

            [100, [new CompareTo(100, operator: '<=')]],
            [99, [new CompareTo(100, operator: '<=')]],
            [['attribute' => 100, 'number' => 99], ['number' => new CompareTo(null, 'attribute', operator: '<=')]],

            ['100.50', [new CompareTo('100.5', type: Compare::TYPE_NUMBER)]],
            ['100.50', [new CompareTo('100.5', type: Compare::TYPE_NUMBER, operator: '===')]],
        ];
    }

    public function dataValidationFailed(): array
    {
        $incorrectDataSet = new class () implements DataSetInterface {
            public function getAttributeValue(string $attribute): mixed
            {
                return new stdClass();
            }

            public function getData(): mixed
            {
                return false;
            }

            public function hasAttribute(string $attribute): bool
            {
                return false;
            }
        };
        $messageEqual = 'Value must be equal to "100".';
        $messageNotEqual = 'Value must not be equal to "100".';
        $messageGreaterThan = 'Value must be greater than "100".';
        $messageGreaterOrEqualThan = 'Value must be greater than or equal to "100".';
        $messageLessThan = 'Value must be less than "100".';
        $messageLessOrEqualThan = 'Value must be less than or equal to "100".';

        return [
            'incorrect input' => [
                [],
                [new CompareTo(false)],
                ['' => ['The allowed types are integer, float, string, boolean and null.']],
            ],
            'custom incorrect input message' => [
                [],
                [new CompareTo(false, incorrectInputMessage: 'Custom incorrect input message.')],
                ['' => ['Custom incorrect input message.']],
            ],
            'custom incorrect input message with parameters' => [
                [],
                [new CompareTo(false, incorrectInputMessage: 'Attribute - {attribute}, type - {type}.')],
                ['' => ['Attribute - , type - array.']],
            ],
            'custom incorrect input message with parameters, attribute set' => [
                ['data' => []],
                ['data' => new CompareTo(false, incorrectInputMessage: 'Attribute - {attribute}, type - {type}.')],
                ['data' => ['Attribute - data, type - array.']],
            ],

            'incorrect data set type' => [
                $incorrectDataSet,
                [new CompareTo(targetAttribute: 'test')],
                ['' => ['The attribute value returned from a custom data set must have a scalar type.']],
            ],
            'custom incorrect data set type message' => [
                $incorrectDataSet,
                [
                    new CompareTo(
                        targetAttribute: 'test',
                        incorrectDataSetTypeMessage: 'Custom incorrect data set type message.',
                    ),
                ],
                ['' => ['Custom incorrect data set type message.']],
            ],
            'custom incorrect data set type message with parameters' => [
                $incorrectDataSet,
                [
                    new CompareTo(
                        targetAttribute: 'test',
                        incorrectDataSetTypeMessage: 'Type - {type}.',
                    ),
                ],
                ['' => ['Type - stdClass.']],
            ],

            [null, [new CompareTo(0)], ['' => ['Value must be equal to "0".']]],

            [101, [new CompareTo(100)], ['' => [$messageEqual]]],

            [101, [new CompareTo(100, operator: '===')], ['' => [$messageEqual]]],
            [
                ['attribute' => 100, 'number' => 101],
                ['number' => new CompareTo(null, 'attribute', operator: '===')],
                ['number' => [$messageEqual]],
            ],

            [100, [new CompareTo(100, operator: '!=')], ['' => [$messageNotEqual]]],
            ['100', [new CompareTo(100, operator: '!=')], ['' => [$messageNotEqual]]],
            [100.0, [new CompareTo(100, operator: '!=')], ['' => [$messageNotEqual]]],

            [100, [new CompareTo(100, operator: '!==')], ['' => [$messageNotEqual]]],
            ['100', [new CompareTo(100, operator: '!==')], ['' => [$messageNotEqual]]],
            [100.0, [new CompareTo(100, operator: '!==')], ['' => [$messageNotEqual]]],

            [100, [new CompareTo(100, operator: '>')], ['' => [$messageGreaterThan]]],
            [99, [new CompareTo(100, operator: '>')], ['' => [$messageGreaterThan]]],

            [99, [new CompareTo(100, operator: '>=')], ['' => [$messageGreaterOrEqualThan]]],

            [100, [new CompareTo(100, operator: '<')], ['' => [$messageLessThan]]],
            [101, [new CompareTo(100, operator: '<')], ['' => [$messageLessThan]]],

            [101, [new CompareTo(100, operator: '<=')], ['' => [$messageLessOrEqualThan]]],
            [
                ['attribute' => 100, 'number' => 101],
                ['number' => new CompareTo(null, 'attribute', operator: '<=')],
                ['number' => [$messageLessOrEqualThan]],
            ],

            'custom message' => [101, [new CompareTo(100, message: 'Custom message.')], ['' => ['Custom message.']]],
            'custom message with parameters, target value set' => [
                101,
                [
                    new CompareTo(
                        100,
                        message: 'Attribute - {attribute}, target value - {targetValue}, target attribute - ' .
                        '{targetAttribute}, target value or attribute - {targetValueOrAttribute}, value - {value}.',
                    ),
                ],
                [
                    '' => [
                        'Attribute - , target value - 100, target attribute - , target value or attribute - 100, ' .
                        'value - 101.',
                    ],
                ],
            ],
            'custom message with parameters, attribute and target attribute set' => [
                ['attribute' => 100, 'number' => 101],
                [
                    'number' => new CompareTo(
                        null,
                        'attribute',
                        message: 'Attribute - {attribute}, target value - {targetValue}, target attribute - ' .
                        '{targetAttribute}, target value or attribute - {targetValueOrAttribute}, value - {value}.',
                        operator: '===',
                    ),
                ],
                [
                    'number' => [
                        'Attribute - number, target value - , target attribute - attribute, target value or ' .
                        'attribute - 100, value - 101.',
                    ],
                ],
            ],

            ['100.50', [new CompareTo('100.5', operator: '===')], ['' => ['Value must be equal to "100.5".']]],
        ];
    }

    public function testSkipOnError(): void
    {
        $this->testSkipOnErrorInternal(new CompareTo(), new CompareTo(skipOnError: true));
    }

    public function testWhen(): void
    {
        $when = static fn (mixed $value): bool => $value !== null;
        $this->testWhenInternal(new CompareTo(), new CompareTo(when: $when));
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Validator\Tests\Rule;
6
7			use InvalidArgumentException;
8			use stdClass;
9			use Yiisoft\Validator\DataSetInterface;
10			use Yiisoft\Validator\Rule\Compare;
11			use Yiisoft\Validator\Rule\CompareTo;
12			use Yiisoft\Validator\Tests\Rule\Base\RuleTestCase;
13			use Yiisoft\Validator\Tests\Rule\Base\RuleWithOptionsTestTrait;
14			use Yiisoft\Validator\Tests\Rule\Base\SkipOnErrorTestTrait;
15			use Yiisoft\Validator\Tests\Rule\Base\WhenTestTrait;
16
17			final class CompareToTest extends RuleTestCase
18			{
19			use RuleWithOptionsTestTrait;
20			use SkipOnErrorTestTrait;
21			use WhenTestTrait;
22
23			public function testInitWithWrongOperator(): void
24			{
25			$this->expectException(InvalidArgumentException::class);
26			$message = 'Operator "=" is not supported. The valid operators are: "==", "===", "!=", "!==", ">", ">=", ' .
27			'"<", "<=".';
28			$this->expectExceptionMessage($message);
29			new CompareTo(operator: '=');
30			}
31
32			public function testGetName(): void
33			{
34			$rule = new CompareTo();
35			$this->assertSame('compareTo', $rule->getName());
36			}
37
38			public function dataOptions(): array
39			{
40			return [
41			[
42			new CompareTo(1),
43			[
44			'targetValue' => 1,
45			'targetAttribute' => null,
46			'incorrectInputMessage' => [
47			'template' => 'The allowed types are integer, float, string, boolean and null.',
48			'parameters' => [
49			'targetValue' => 1,
50			'targetAttribute' => null,
51			'targetValueOrAttribute' => 1,
52			],
53			],
54			'incorrectDataSetTypeMessage' => [
55			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
56			'parameters' => [
57			'targetValue' => 1,
58			'targetAttribute' => null,
59			'targetValueOrAttribute' => 1,
60			],
61			],
62			'message' => [
63			'template' => 'Value must be equal to "{targetValueOrAttribute}".',
64			'parameters' => [
65			'targetValue' => 1,
66			'targetAttribute' => null,
67			'targetValueOrAttribute' => 1,
68			],
69			],
70			'type' => 'string',
71			'operator' => '==',
72			'skipOnEmpty' => false,
73			'skipOnError' => false,
74			],
75			],
76			[
77			new CompareTo(1, type: CompareTo::TYPE_NUMBER),
78			[
79			'targetValue' => 1,
80			'targetAttribute' => null,
81			'incorrectInputMessage' => [
82			'template' => 'The allowed types are integer, float, string, boolean and null.',
83			'parameters' => [
84			'targetValue' => 1,
85			'targetAttribute' => null,
86			'targetValueOrAttribute' => 1,
87			],
88			],
89			'incorrectDataSetTypeMessage' => [
90			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
91			'parameters' => [
92			'targetValue' => 1,
93			'targetAttribute' => null,
94			'targetValueOrAttribute' => 1,
95			],
96			],
97			'message' => [
98			'template' => 'Value must be equal to "{targetValueOrAttribute}".',
99			'parameters' => [
100			'targetValue' => 1,
101			'targetAttribute' => null,
102			'targetValueOrAttribute' => 1,
103			],
104			],
105			'type' => 'number',
106			'operator' => '==',
107			'skipOnEmpty' => false,
108			'skipOnError' => false,
109			],
110			],
111			[
112			new CompareTo(1, type: CompareTo::TYPE_NUMBER, operator: '>='),
113			[
114			'targetValue' => 1,
115			'targetAttribute' => null,
116			'incorrectInputMessage' => [
117			'template' => 'The allowed types are integer, float, string, boolean and null.',
118			'parameters' => [
119			'targetValue' => 1,
120			'targetAttribute' => null,
121			'targetValueOrAttribute' => 1,
122			],
123			],
124			'incorrectDataSetTypeMessage' => [
125			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
126			'parameters' => [
127			'targetValue' => 1,
128			'targetAttribute' => null,
129			'targetValueOrAttribute' => 1,
130			],
131			],
132			'message' => [
133			'template' => 'Value must be greater than or equal to "{targetValueOrAttribute}".',
134			'parameters' => [
135			'targetValue' => 1,
136			'targetAttribute' => null,
137			'targetValueOrAttribute' => 1,
138			],
139			],
140			'type' => 'number',
141			'operator' => '>=',
142			'skipOnEmpty' => false,
143			'skipOnError' => false,
144			],
145			],
146			[
147			new CompareTo('YES'),
148			[
149			'targetValue' => 'YES',
150			'targetAttribute' => null,
151			'incorrectInputMessage' => [
152			'template' => 'The allowed types are integer, float, string, boolean and null.',
153			'parameters' => [
154			'targetValue' => 'YES',
155			'targetAttribute' => null,
156			'targetValueOrAttribute' => 'YES',
157			],
158			],
159			'incorrectDataSetTypeMessage' => [
160			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
161			'parameters' => [
162			'targetValue' => 'YES',
163			'targetAttribute' => null,
164			'targetValueOrAttribute' => 'YES',
165			],
166			],
167			'message' => [
168			'template' => 'Value must be equal to "{targetValueOrAttribute}".',
169			'parameters' => [
170			'targetValue' => 'YES',
171			'targetAttribute' => null,
172			'targetValueOrAttribute' => 'YES',
173			],
174			],
175			'type' => 'string',
176			'operator' => '==',
177			'skipOnEmpty' => false,
178			'skipOnError' => false,
179			],
180			],
181			[
182			new CompareTo('YES', skipOnEmpty: true),
183			[
184			'targetValue' => 'YES',
185			'targetAttribute' => null,
186			'incorrectInputMessage' => [
187			'template' => 'The allowed types are integer, float, string, boolean and null.',
188			'parameters' => [
189			'targetValue' => 'YES',
190			'targetAttribute' => null,
191			'targetValueOrAttribute' => 'YES',
192			],
193			],
194			'incorrectDataSetTypeMessage' => [
195			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
196			'parameters' => [
197			'targetValue' => 'YES',
198			'targetAttribute' => null,
199			'targetValueOrAttribute' => 'YES',
200			],
201			],
202			'message' => [
203			'template' => 'Value must be equal to "{targetValueOrAttribute}".',
204			'parameters' => [
205			'targetValue' => 'YES',
206			'targetAttribute' => null,
207			'targetValueOrAttribute' => 'YES',
208			],
209			],
210			'type' => 'string',
211			'operator' => '==',
212			'skipOnEmpty' => true,
213			'skipOnError' => false,
214			],
215			],
216			[
217			new CompareTo('YES', operator: '!=='),
218			[
219			'targetValue' => 'YES',
220			'targetAttribute' => null,
221			'incorrectInputMessage' => [
222			'template' => 'The allowed types are integer, float, string, boolean and null.',
223			'parameters' => [
224			'targetValue' => 'YES',
225			'targetAttribute' => null,
226			'targetValueOrAttribute' => 'YES',
227			],
228			],
229			'incorrectDataSetTypeMessage' => [
230			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
231			'parameters' => [
232			'targetValue' => 'YES',
233			'targetAttribute' => null,
234			'targetValueOrAttribute' => 'YES',
235			],
236			],
237			'message' => [
238			'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
239			'parameters' => [
240			'targetValue' => 'YES',
241			'targetAttribute' => null,
242			'targetValueOrAttribute' => 'YES',
243			],
244			],
245			'type' => 'string',
246			'operator' => '!==',
247			'skipOnEmpty' => false,
248			'skipOnError' => false,
249			],
250			],
251			[
252			new CompareTo('YES', message: 'Custom message for {targetValueOrAttribute}.'),
253			[
254			'targetValue' => 'YES',
255			'targetAttribute' => null,
256			'incorrectInputMessage' => [
257			'template' => 'The allowed types are integer, float, string, boolean and null.',
258			'parameters' => [
259			'targetValue' => 'YES',
260			'targetAttribute' => null,
261			'targetValueOrAttribute' => 'YES',
262			],
263			],
264			'incorrectDataSetTypeMessage' => [
265			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
266			'parameters' => [
267			'targetValue' => 'YES',
268			'targetAttribute' => null,
269			'targetValueOrAttribute' => 'YES',
270			],
271			],
272			'message' => [
273			'template' => 'Custom message for {targetValueOrAttribute}.',
274			'parameters' => [
275			'targetValue' => 'YES',
276			'targetAttribute' => null,
277			'targetValueOrAttribute' => 'YES',
278			],
279			],
280			'type' => 'string',
281			'operator' => '==',
282			'skipOnEmpty' => false,
283			'skipOnError' => false,
284			],
285			],
286			[
287			new CompareTo(null, 'test'),
288			[
289			'targetValue' => null,
290			'targetAttribute' => 'test',
291			'incorrectInputMessage' => [
292			'template' => 'The allowed types are integer, float, string, boolean and null.',
293			'parameters' => [
294			'targetValue' => null,
295			'targetAttribute' => 'test',
296			'targetValueOrAttribute' => 'test',
297			],
298			],
299			'incorrectDataSetTypeMessage' => [
300			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
301			'parameters' => [
302			'targetValue' => null,
303			'targetAttribute' => 'test',
304			'targetValueOrAttribute' => 'test',
305			],
306			],
307			'message' => [
308			'template' => 'Value must be equal to "{targetValueOrAttribute}".',
309			'parameters' => [
310			'targetValue' => null,
311			'targetAttribute' => 'test',
312			'targetValueOrAttribute' => 'test',
313			],
314			],
315			'type' => 'string',
316			'operator' => '==',
317			'skipOnEmpty' => false,
318			'skipOnError' => false,
319			],
320			],
321			[
322			new CompareTo(
323			null,
324			'test',
325			incorrectInputMessage: 'Custom message 1.',
326			incorrectDataSetTypeMessage: 'Custom message 2.',
327			message: 'Custom message 3.',
328			),
329			[
330			'targetValue' => null,
331			'targetAttribute' => 'test',
332			'incorrectInputMessage' => [
333			'template' => 'Custom message 1.',
334			'parameters' => [
335			'targetValue' => null,
336			'targetAttribute' => 'test',
337			'targetValueOrAttribute' => 'test',
338			],
339			],
340			'incorrectDataSetTypeMessage' => [
341			'template' => 'Custom message 2.',
342			'parameters' => [
343			'targetValue' => null,
344			'targetAttribute' => 'test',
345			'targetValueOrAttribute' => 'test',
346			],
347			],
348			'message' => [
349			'template' => 'Custom message 3.',
350			'parameters' => [
351			'targetValue' => null,
352			'targetAttribute' => 'test',
353			'targetValueOrAttribute' => 'test',
354			],
355			],
356			'type' => 'string',
357			'operator' => '==',
358			'skipOnEmpty' => false,
359			'skipOnError' => false,
360			],
361			],
362			[
363			new CompareTo(1, 'test'),
364			[
365			'targetValue' => 1,
366			'targetAttribute' => 'test',
367			'incorrectInputMessage' => [
368			'template' => 'The allowed types are integer, float, string, boolean and null.',
369			'parameters' => [
370			'targetValue' => 1,
371			'targetAttribute' => 'test',
372			'targetValueOrAttribute' => 1,
373			],
374			],
375			'incorrectDataSetTypeMessage' => [
376			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
377			'parameters' => [
378			'targetValue' => 1,
379			'targetAttribute' => 'test',
380			'targetValueOrAttribute' => 1,
381			],
382			],
383			'message' => [
384			'template' => 'Value must be equal to "{targetValueOrAttribute}".',
385			'parameters' => [
386			'targetValue' => 1,
387			'targetAttribute' => 'test',
388			'targetValueOrAttribute' => 1,
389			],
390			],
391			'type' => 'string',
392			'operator' => '==',
393			'skipOnEmpty' => false,
394			'skipOnError' => false,
395			],
396			],
397			];
398			}
399
400			public function dataValidationPassed(): array
401			{
402			return [
403			[null, [new CompareTo('')]],
404			[null, [new CompareTo('', operator: '===')]],
405
406			[100, [new CompareTo(100)]],
407			[['attribute' => 100, 'number' => 100], ['number' => new CompareTo(null, 'attribute')]],
408			['100', [new CompareTo(100)]],
409
410			[100, [new CompareTo(100, operator: '===')]],
411			['100', [new CompareTo(100, operator: '===')]],
412			[100.0, [new CompareTo(100, operator: '===')]],
413
414			[100.00001, [new CompareTo(100, operator: '!=')]],
415			[false, [new CompareTo(100, operator: '!=')]],
416
417			[false, [new CompareTo(100, operator: '!==')]],
418
419			[101, [new CompareTo(100, operator: '>')]],
420
421			[100, [new CompareTo(100, operator: '>=')]],
422			[101, [new CompareTo(100, operator: '>=')]],
423			[99, [new CompareTo(100, operator: '<')]],
424
425			[100, [new CompareTo(100, operator: '<=')]],
426			[99, [new CompareTo(100, operator: '<=')]],
427			[['attribute' => 100, 'number' => 99], ['number' => new CompareTo(null, 'attribute', operator: '<=')]],
428
429			['100.50', [new CompareTo('100.5', type: Compare::TYPE_NUMBER)]],
430			['100.50', [new CompareTo('100.5', type: Compare::TYPE_NUMBER, operator: '===')]],
431			];
432			}
433
434			public function dataValidationFailed(): array
435			{
436			$incorrectDataSet = new class () implements DataSetInterface {
437			public function getAttributeValue(string $attribute): mixed
438			{
439			return new stdClass();
440			}
441
442			public function getData(): mixed
443			{
444			return false;
445			}
446
447			public function hasAttribute(string $attribute): bool
448			{
449			return false;
450			}
451			};
452			$messageEqual = 'Value must be equal to "100".';
453			$messageNotEqual = 'Value must not be equal to "100".';
454			$messageGreaterThan = 'Value must be greater than "100".';
455			$messageGreaterOrEqualThan = 'Value must be greater than or equal to "100".';
456			$messageLessThan = 'Value must be less than "100".';
457			$messageLessOrEqualThan = 'Value must be less than or equal to "100".';
458
459			return [
460			'incorrect input' => [
461			[],
462			[new CompareTo(false)],
463			['' => ['The allowed types are integer, float, string, boolean and null.']],
464			],
465			'custom incorrect input message' => [
466			[],
467			[new CompareTo(false, incorrectInputMessage: 'Custom incorrect input message.')],
468			['' => ['Custom incorrect input message.']],
469			],
470			'custom incorrect input message with parameters' => [
471			[],
472			[new CompareTo(false, incorrectInputMessage: 'Attribute - {attribute}, type - {type}.')],
473			['' => ['Attribute - , type - array.']],
474			],
475			'custom incorrect input message with parameters, attribute set' => [
476			['data' => []],
477			['data' => new CompareTo(false, incorrectInputMessage: 'Attribute - {attribute}, type - {type}.')],
478			['data' => ['Attribute - data, type - array.']],
479			],
480
481			'incorrect data set type' => [
482			$incorrectDataSet,
483			[new CompareTo(targetAttribute: 'test')],
484			['' => ['The attribute value returned from a custom data set must have a scalar type.']],
485			],
486			'custom incorrect data set type message' => [
487			$incorrectDataSet,
488			[
489			new CompareTo(
490			targetAttribute: 'test',
491			incorrectDataSetTypeMessage: 'Custom incorrect data set type message.',
492			),
493			],
494			['' => ['Custom incorrect data set type message.']],
495			],
496			'custom incorrect data set type message with parameters' => [
497			$incorrectDataSet,
498			[
499			new CompareTo(
500			targetAttribute: 'test',
501			incorrectDataSetTypeMessage: 'Type - {type}.',
502			),
503			],
504			['' => ['Type - stdClass.']],
505			],
506
507			[null, [new CompareTo(0)], ['' => ['Value must be equal to "0".']]],
508
509			[101, [new CompareTo(100)], ['' => [$messageEqual]]],
510
511			[101, [new CompareTo(100, operator: '===')], ['' => [$messageEqual]]],
512			[
513			['attribute' => 100, 'number' => 101],
514			['number' => new CompareTo(null, 'attribute', operator: '===')],
515			['number' => [$messageEqual]],
516			],
517
518			[100, [new CompareTo(100, operator: '!=')], ['' => [$messageNotEqual]]],
519			['100', [new CompareTo(100, operator: '!=')], ['' => [$messageNotEqual]]],
520			[100.0, [new CompareTo(100, operator: '!=')], ['' => [$messageNotEqual]]],
521
522			[100, [new CompareTo(100, operator: '!==')], ['' => [$messageNotEqual]]],
523			['100', [new CompareTo(100, operator: '!==')], ['' => [$messageNotEqual]]],
524			[100.0, [new CompareTo(100, operator: '!==')], ['' => [$messageNotEqual]]],
525
526			[100, [new CompareTo(100, operator: '>')], ['' => [$messageGreaterThan]]],
527			[99, [new CompareTo(100, operator: '>')], ['' => [$messageGreaterThan]]],
528
529			[99, [new CompareTo(100, operator: '>=')], ['' => [$messageGreaterOrEqualThan]]],
530
531			[100, [new CompareTo(100, operator: '<')], ['' => [$messageLessThan]]],
532			[101, [new CompareTo(100, operator: '<')], ['' => [$messageLessThan]]],
533
534			[101, [new CompareTo(100, operator: '<=')], ['' => [$messageLessOrEqualThan]]],
535			[
536			['attribute' => 100, 'number' => 101],
537			['number' => new CompareTo(null, 'attribute', operator: '<=')],
538			['number' => [$messageLessOrEqualThan]],
539			],
540
541			'custom message' => [101, [new CompareTo(100, message: 'Custom message.')], ['' => ['Custom message.']]],
542			'custom message with parameters, target value set' => [
543			101,
544			[
545			new CompareTo(
546			100,
547			message: 'Attribute - {attribute}, target value - {targetValue}, target attribute - ' .
548			'{targetAttribute}, target value or attribute - {targetValueOrAttribute}, value - {value}.',
549			),
550			],
551			[
552			'' => [
553			'Attribute - , target value - 100, target attribute - , target value or attribute - 100, ' .
554			'value - 101.',
555			],
556			],
557			],
558			'custom message with parameters, attribute and target attribute set' => [
559			['attribute' => 100, 'number' => 101],
560			[
561			'number' => new CompareTo(
562			null,
563			'attribute',
564			message: 'Attribute - {attribute}, target value - {targetValue}, target attribute - ' .
565			'{targetAttribute}, target value or attribute - {targetValueOrAttribute}, value - {value}.',
566			operator: '===',
567			),
568			],
569			[
570			'number' => [
571			'Attribute - number, target value - , target attribute - attribute, target value or ' .
572			'attribute - 100, value - 101.',
573			],
574			],
575			],
576
577			['100.50', [new CompareTo('100.5', operator: '===')], ['' => ['Value must be equal to "100.5".']]],
578			];
579			}
580
581			public function testSkipOnError(): void
582			{
583			$this->testSkipOnErrorInternal(new CompareTo(), new CompareTo(skipOnError: true));
584			}
585
586			public function testWhen(): void
587			{
588			$when = static fn (mixed $value): bool => $value !== null;
589			$this->testWhenInternal(new CompareTo(), new CompareTo(when: $when));
590			}
591			}
592

yiisoft / validator

Pull Request — master (#415)

CompareToTest::dataOptions() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like