NotEqualTest::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

NotEqualTest::dataOptions() B

↳ Parent: NotEqualTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	251
Code Lines	180

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	180
nc	1
nop	0
dl	0
loc	251
rs	8
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Tests\Rule;

use RuntimeException;
use Yiisoft\Validator\Rule\NotEqual;
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 NotEqualTest extends RuleTestCase
{
    use RuleWithOptionsTestTrait;
    use SkipOnErrorTestTrait;
    use WhenTestTrait;

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

    public function dataOptions(): array
    {
        return [
            [
                new NotEqual(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 not be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '!=',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new NotEqual(1, type: NotEqual::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 not be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 1,
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 1,
                        ],
                    ],
                    'type' => 'number',
                    'operator' => '!=',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new NotEqual('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 not be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '!=',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new NotEqual('YES', strict: 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 not be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '!==',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new NotEqual('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 not be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => 'YES',
                            'targetAttribute' => null,
                            'targetValueOrAttribute' => 'YES',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '!=',
                    'skipOnEmpty' => true,
                    'skipOnError' => false,
                ],
            ],
            [
                new NotEqual(null, 'attribute'),
                [
                    'targetValue' => null,
                    'targetAttribute' => 'attribute',
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean and null.',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'attribute',
                            'targetValueOrAttribute' => 'attribute',
                        ],
                    ],
                    'incorrectDataSetTypeMessage' => [
                        'template' => 'The attribute value returned from a custom data set must have a scalar type.',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'attribute',
                            'targetValueOrAttribute' => 'attribute',
                        ],
                    ],
                    'message' => [
                        'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
                        'parameters' => [
                            'targetValue' => null,
                            'targetAttribute' => 'attribute',
                            'targetValueOrAttribute' => 'attribute',
                        ],
                    ],
                    'type' => 'string',
                    'operator' => '!=',
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new NotEqual(
                    targetAttribute: '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,
                ],
            ],
        ];
    }

    public function dataValidationPassed(): array
    {
        return [
            [101, [new NotEqual(100)]],
            ['101', [new NotEqual(100, strict: true)]],
        ];
    }

    public function dataValidationFailed(): array
    {
        $message = 'Value must not be equal to "100".';

        return [
            [100, [new NotEqual(100)], ['' => [$message]]],
            [100, [new NotEqual(100, strict: true)], ['' => [$message]]],
            'custom error' => [100, [new NotEqual(100, message: 'Custom error')], ['' => ['Custom error']]],
        ];
    }

    public function testWithoutParameters(): void
    {
        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessage('Either "targetValue" or "targetAttribute" must be specified');
        new NotEqual();
    }

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

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


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Validator\Tests\Rule;
6
7			use RuntimeException;
8			use Yiisoft\Validator\Rule\NotEqual;
9			use Yiisoft\Validator\Tests\Rule\Base\RuleTestCase;
10			use Yiisoft\Validator\Tests\Rule\Base\RuleWithOptionsTestTrait;
11			use Yiisoft\Validator\Tests\Rule\Base\SkipOnErrorTestTrait;
12			use Yiisoft\Validator\Tests\Rule\Base\WhenTestTrait;
13
14			final class NotEqualTest extends RuleTestCase
15			{
16			use RuleWithOptionsTestTrait;
17			use SkipOnErrorTestTrait;
18			use WhenTestTrait;
19
20			public function testGetName(): void
21			{
22			$rule = new NotEqual(1);
23			$this->assertSame('notEqual', $rule->getName());
24			}
25
26			public function dataOptions(): array
27			{
28			return [
29			[
30			new NotEqual(1),
31			[
32			'targetValue' => 1,
33			'targetAttribute' => null,
34			'incorrectInputMessage' => [
35			'template' => 'The allowed types are integer, float, string, boolean and null.',
36			'parameters' => [
37			'targetValue' => 1,
38			'targetAttribute' => null,
39			'targetValueOrAttribute' => 1,
40			],
41			],
42			'incorrectDataSetTypeMessage' => [
43			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
44			'parameters' => [
45			'targetValue' => 1,
46			'targetAttribute' => null,
47			'targetValueOrAttribute' => 1,
48			],
49			],
50			'message' => [
51			'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
52			'parameters' => [
53			'targetValue' => 1,
54			'targetAttribute' => null,
55			'targetValueOrAttribute' => 1,
56			],
57			],
58			'type' => 'string',
59			'operator' => '!=',
60			'skipOnEmpty' => false,
61			'skipOnError' => false,
62			],
63			],
64			[
65			new NotEqual(1, type: NotEqual::TYPE_NUMBER),
66			[
67			'targetValue' => 1,
68			'targetAttribute' => null,
69			'incorrectInputMessage' => [
70			'template' => 'The allowed types are integer, float, string, boolean and null.',
71			'parameters' => [
72			'targetValue' => 1,
73			'targetAttribute' => null,
74			'targetValueOrAttribute' => 1,
75			],
76			],
77			'incorrectDataSetTypeMessage' => [
78			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
79			'parameters' => [
80			'targetValue' => 1,
81			'targetAttribute' => null,
82			'targetValueOrAttribute' => 1,
83			],
84			],
85			'message' => [
86			'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
87			'parameters' => [
88			'targetValue' => 1,
89			'targetAttribute' => null,
90			'targetValueOrAttribute' => 1,
91			],
92			],
93			'type' => 'number',
94			'operator' => '!=',
95			'skipOnEmpty' => false,
96			'skipOnError' => false,
97			],
98			],
99			[
100			new NotEqual('YES'),
101			[
102			'targetValue' => 'YES',
103			'targetAttribute' => null,
104			'incorrectInputMessage' => [
105			'template' => 'The allowed types are integer, float, string, boolean and null.',
106			'parameters' => [
107			'targetValue' => 'YES',
108			'targetAttribute' => null,
109			'targetValueOrAttribute' => 'YES',
110			],
111			],
112			'incorrectDataSetTypeMessage' => [
113			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
114			'parameters' => [
115			'targetValue' => 'YES',
116			'targetAttribute' => null,
117			'targetValueOrAttribute' => 'YES',
118			],
119			],
120			'message' => [
121			'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
122			'parameters' => [
123			'targetValue' => 'YES',
124			'targetAttribute' => null,
125			'targetValueOrAttribute' => 'YES',
126			],
127			],
128			'type' => 'string',
129			'operator' => '!=',
130			'skipOnEmpty' => false,
131			'skipOnError' => false,
132			],
133			],
134			[
135			new NotEqual('YES', strict: true),
136			[
137			'targetValue' => 'YES',
138			'targetAttribute' => null,
139			'incorrectInputMessage' => [
140			'template' => 'The allowed types are integer, float, string, boolean and null.',
141			'parameters' => [
142			'targetValue' => 'YES',
143			'targetAttribute' => null,
144			'targetValueOrAttribute' => 'YES',
145			],
146			],
147			'incorrectDataSetTypeMessage' => [
148			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
149			'parameters' => [
150			'targetValue' => 'YES',
151			'targetAttribute' => null,
152			'targetValueOrAttribute' => 'YES',
153			],
154			],
155			'message' => [
156			'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
157			'parameters' => [
158			'targetValue' => 'YES',
159			'targetAttribute' => null,
160			'targetValueOrAttribute' => 'YES',
161			],
162			],
163			'type' => 'string',
164			'operator' => '!==',
165			'skipOnEmpty' => false,
166			'skipOnError' => false,
167			],
168			],
169			[
170			new NotEqual('YES', skipOnEmpty: true),
171			[
172			'targetValue' => 'YES',
173			'targetAttribute' => null,
174			'incorrectInputMessage' => [
175			'template' => 'The allowed types are integer, float, string, boolean and null.',
176			'parameters' => [
177			'targetValue' => 'YES',
178			'targetAttribute' => null,
179			'targetValueOrAttribute' => 'YES',
180			],
181			],
182			'incorrectDataSetTypeMessage' => [
183			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
184			'parameters' => [
185			'targetValue' => 'YES',
186			'targetAttribute' => null,
187			'targetValueOrAttribute' => 'YES',
188			],
189			],
190			'message' => [
191			'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
192			'parameters' => [
193			'targetValue' => 'YES',
194			'targetAttribute' => null,
195			'targetValueOrAttribute' => 'YES',
196			],
197			],
198			'type' => 'string',
199			'operator' => '!=',
200			'skipOnEmpty' => true,
201			'skipOnError' => false,
202			],
203			],
204			[
205			new NotEqual(null, 'attribute'),
206			[
207			'targetValue' => null,
208			'targetAttribute' => 'attribute',
209			'incorrectInputMessage' => [
210			'template' => 'The allowed types are integer, float, string, boolean and null.',
211			'parameters' => [
212			'targetValue' => null,
213			'targetAttribute' => 'attribute',
214			'targetValueOrAttribute' => 'attribute',
215			],
216			],
217			'incorrectDataSetTypeMessage' => [
218			'template' => 'The attribute value returned from a custom data set must have a scalar type.',
219			'parameters' => [
220			'targetValue' => null,
221			'targetAttribute' => 'attribute',
222			'targetValueOrAttribute' => 'attribute',
223			],
224			],
225			'message' => [
226			'template' => 'Value must not be equal to "{targetValueOrAttribute}".',
227			'parameters' => [
228			'targetValue' => null,
229			'targetAttribute' => 'attribute',
230			'targetValueOrAttribute' => 'attribute',
231			],
232			],
233			'type' => 'string',
234			'operator' => '!=',
235			'skipOnEmpty' => false,
236			'skipOnError' => false,
237			],
238			],
239			[
240			new NotEqual(
241			targetAttribute: 'test',
242			incorrectInputMessage: 'Custom message 1.',
243			incorrectDataSetTypeMessage: 'Custom message 2.',
244			message: 'Custom message 3.',
245			),
246			[
247			'targetValue' => null,
248			'targetAttribute' => 'test',
249			'incorrectInputMessage' => [
250			'template' => 'Custom message 1.',
251			'parameters' => [
252			'targetValue' => null,
253			'targetAttribute' => 'test',
254			'targetValueOrAttribute' => 'test',
255			],
256			],
257			'incorrectDataSetTypeMessage' => [
258			'template' => 'Custom message 2.',
259			'parameters' => [
260			'targetValue' => null,
261			'targetAttribute' => 'test',
262			'targetValueOrAttribute' => 'test',
263			],
264			],
265			'message' => [
266			'template' => 'Custom message 3.',
267			'parameters' => [
268			'targetValue' => null,
269			'targetAttribute' => 'test',
270			'targetValueOrAttribute' => 'test',
271			],
272			],
273			'type' => 'string',
274			'operator' => '!=',
275			'skipOnEmpty' => false,
276			'skipOnError' => false,
277			],
278			],
279			];
280			}
281
282			public function dataValidationPassed(): array
283			{
284			return [
285			[101, [new NotEqual(100)]],
286			['101', [new NotEqual(100, strict: true)]],
287			];
288			}
289
290			public function dataValidationFailed(): array
291			{
292			$message = 'Value must not be equal to "100".';
293
294			return [
295			[100, [new NotEqual(100)], ['' => [$message]]],
296			[100, [new NotEqual(100, strict: true)], ['' => [$message]]],
297			'custom error' => [100, [new NotEqual(100, message: 'Custom error')], ['' => ['Custom error']]],
298			];
299			}
300
301			public function testWithoutParameters(): void
302			{
303			$this->expectException(RuntimeException::class);
304			$this->expectExceptionMessage('Either "targetValue" or "targetAttribute" must be specified');
305			new NotEqual();
306			}
307
308			public function testSkipOnError(): void
309			{
310			$this->testSkipOnErrorInternal(new NotEqual(1), new NotEqual(1, skipOnError: true));
311			}
312
313			public function testWhen(): void
314			{
315			$when = static fn (mixed $value): bool => $value !== null;
316			$this->testWhenInternal(new NotEqual(1), new NotEqual(1, when: $when));
317			}
318			}
319

yiisoft / validator

Pull Request — master (#415)

NotEqualTest::dataOptions() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like