TrueValueTest::dataOptions() - Code Metrics - Inspection of "More phpdoc" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#490)

unknown

created 2022-12-27 06:45 UTC

TrueValueTest::dataOptions() A

↳ Parent: TrueValueTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	71
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	46
nc	1
nop	0
dl	0
loc	71
rs	9.1781
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Tests\Rule;

use Yiisoft\Validator\Rule\TrueValue;
use Yiisoft\Validator\Rule\TrueValueHandler;
use Yiisoft\Validator\Tests\Rule\Base\DifferentRuleInHandlerTestTrait;
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 TrueValueTest extends RuleTestCase
{
    use DifferentRuleInHandlerTestTrait;
    use RuleWithOptionsTestTrait;
    use SkipOnErrorTestTrait;
    use WhenTestTrait;

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

    public function dataOptions(): array
    {
        return [
            [
                new TrueValue(),
                [
                    'trueValue' => '1',
                    'strict' => false,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean. {type} given.',
                        'parameters' => [
                            'true' => '1',
                        ],
                    ],
                    'message' => [
                        'template' => 'The value must be "{true}".',
                        'parameters' => [
                            'true' => '1',
                        ],
                    ],
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new TrueValue(trueValue: true, strict: true),
                [
                    'trueValue' => true,
                    'strict' => true,
                    'incorrectInputMessage' => [
                        'template' => 'The allowed types are integer, float, string, boolean. {type} given.',
                        'parameters' => [
                            'true' => 'true',
                        ],
                    ],
                    'message' => [
                        'template' => 'The value must be "{true}".',
                        'parameters' => [
                            'true' => 'true',
                        ],
                    ],
                    'skipOnEmpty' => false,
                    'skipOnError' => false,
                ],
            ],
            [
                new TrueValue(
                    trueValue: 'YES',
                    strict: true,
                    incorrectInputMessage: 'Custom incorrect input message.',
                    message: 'Custom message.',
                    skipOnEmpty: true,
                    skipOnError: true
                ),
                [
                    'trueValue' => 'YES',
                    'strict' => true,
                    'incorrectInputMessage' => [
                        'template' => 'Custom incorrect input message.',
                        'parameters' => [
                            'true' => 'YES',
                        ],
                    ],
                    'message' => [
                        'template' => 'Custom message.',
                        'parameters' => [
                            'true' => 'YES',
                        ],
                    ],
                    'skipOnEmpty' => true,
                    'skipOnError' => true,
                ],
            ],
        ];
    }

    public function dataValidationPassed(): array
    {
        return [
            [true, [new TrueValue()]],
            ['1', [new TrueValue()]],
            ['1', [new TrueValue(strict: true)]],
            [true, [new TrueValue(trueValue: true, strict: true)]],
        ];
    }

    public function dataValidationFailed(): array
    {
        return [
            ['5', [new TrueValue()], ['' => ['The value must be "1".']]],
            [null, [new TrueValue()], ['' => ['The allowed types are integer, float, string, boolean. null given.']]],
            [[], [new TrueValue()], ['' => ['The allowed types are integer, float, string, boolean. array given.']]],
            [true, [new TrueValue(strict: true)], ['' => ['The value must be "1".']]],
            ['1', [new TrueValue(trueValue: true, strict: true)], ['' => ['The value must be "true".']]],
            [
                [],
                [new TrueValue(trueValue: true, strict: true)],
                ['' => ['The allowed types are integer, float, string, boolean. array given.']],
            ],

            [false, [new TrueValue()], ['' => ['The value must be "1".']]],
            ['0', [new TrueValue()], ['' => ['The value must be "1".']]],
            ['0', [new TrueValue(strict: true)], ['' => ['The value must be "1".']]],
            [false, [new TrueValue(trueValue: true, strict: true)], ['' => ['The value must be "true".']]],

            'custom message' => [
                5,
                [new TrueValue(message: 'Custom error.')],
                ['' => ['Custom error.']],
            ],
            'custom message with parameters' => [
                5,
                [new TrueValue(message: 'Attribute - {attribute}, true - {true}, value - {value}.')],
                ['' => ['Attribute - , true - 1, value - 5.']],
            ],
            'custom message with parameters, custom true value, strict' => [
                5,
                [
                    new TrueValue(
                        trueValue: true,
                        strict: true,
                        message: 'Attribute - {attribute}, true - {true}, value - {value}.',
                    ),
                ],
                ['' => ['Attribute - , true - true, value - 5.']],
            ],
            'custom message with parameters, attribute set' => [
                ['data' => 5],
                [
                    'data' => new TrueValue(message: 'Attribute - {attribute}, true - {true}, value - {value}.'),
                ],
                ['data' => ['Attribute - data, true - 1, value - 5.']],
            ],
            'custom incorrect input message' => [
                [],
                [new TrueValue(incorrectInputMessage: 'Custom error.')],
                ['' => ['Custom error.']],
            ],
            'custom incorrect input message with parameters' => [
                [],
                [
                    new TrueValue(incorrectInputMessage: 'Attribute - {attribute}, true - {true}, type - {type}.'),
                ],
                ['' => ['Attribute - , true - 1, type - array.']],
            ],
            'custom incorrect input message with parameters, custom true and false values, strict' => [
                [],
                [
                    new TrueValue(
                        trueValue: true,
                        strict: true,
                        incorrectInputMessage: 'Attribute - {attribute}, true - {true}, type - {type}.',
                    ),
                ],
                ['' => ['Attribute - , true - true, type - array.']],
            ],
            'custom incorrect input message with parameters, attribute set' => [
                ['data' => []],
                [
                    'data' => new TrueValue(incorrectInputMessage: 'Attribute - {attribute}, true - {true}, type - {type}.'),
                ],
                ['data' => ['Attribute - data, true - 1, type - array.']],
            ],
            'custom incorrect input message, null' => [
                null,
                [new TrueValue(incorrectInputMessage: 'Attribute - {attribute}, true - {true}, type - {type}.'),],
                ['' => ['Attribute - , true - 1, type - null.']],
            ],
        ];
    }

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

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

    protected function getDifferentRuleInHandlerItems(): array
    {
        return [TrueValue::class, TrueValueHandler::class];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Validator\Tests\Rule;
6
7			use Yiisoft\Validator\Rule\TrueValue;
8			use Yiisoft\Validator\Rule\TrueValueHandler;
9			use Yiisoft\Validator\Tests\Rule\Base\DifferentRuleInHandlerTestTrait;
10			use Yiisoft\Validator\Tests\Rule\Base\RuleTestCase;
11			use Yiisoft\Validator\Tests\Rule\Base\RuleWithOptionsTestTrait;
12			use Yiisoft\Validator\Tests\Rule\Base\SkipOnErrorTestTrait;
13			use Yiisoft\Validator\Tests\Rule\Base\WhenTestTrait;
14
15			final class TrueValueTest extends RuleTestCase
16			{
17			use DifferentRuleInHandlerTestTrait;
18			use RuleWithOptionsTestTrait;
19			use SkipOnErrorTestTrait;
20			use WhenTestTrait;
21
22			public function testGetName(): void
23			{
24			$rule = new TrueValue();
25			$this->assertSame('isTrue', $rule->getName());
26			}
27
28			public function dataOptions(): array
29			{
30			return [
31			[
32			new TrueValue(),
33			[
34			'trueValue' => '1',
35			'strict' => false,
36			'incorrectInputMessage' => [
37			'template' => 'The allowed types are integer, float, string, boolean. {type} given.',
38			'parameters' => [
39			'true' => '1',
40			],
41			],
42			'message' => [
43			'template' => 'The value must be "{true}".',
44			'parameters' => [
45			'true' => '1',
46			],
47			],
48			'skipOnEmpty' => false,
49			'skipOnError' => false,
50			],
51			],
52			[
53			new TrueValue(trueValue: true, strict: true),
54			[
55			'trueValue' => true,
56			'strict' => true,
57			'incorrectInputMessage' => [
58			'template' => 'The allowed types are integer, float, string, boolean. {type} given.',
59			'parameters' => [
60			'true' => 'true',
61			],
62			],
63			'message' => [
64			'template' => 'The value must be "{true}".',
65			'parameters' => [
66			'true' => 'true',
67			],
68			],
69			'skipOnEmpty' => false,
70			'skipOnError' => false,
71			],
72			],
73			[
74			new TrueValue(
75			trueValue: 'YES',
76			strict: true,
77			incorrectInputMessage: 'Custom incorrect input message.',
78			message: 'Custom message.',
79			skipOnEmpty: true,
80			skipOnError: true
81			),
82			[
83			'trueValue' => 'YES',
84			'strict' => true,
85			'incorrectInputMessage' => [
86			'template' => 'Custom incorrect input message.',
87			'parameters' => [
88			'true' => 'YES',
89			],
90			],
91			'message' => [
92			'template' => 'Custom message.',
93			'parameters' => [
94			'true' => 'YES',
95			],
96			],
97			'skipOnEmpty' => true,
98			'skipOnError' => true,
99			],
100			],
101			];
102			}
103
104			public function dataValidationPassed(): array
105			{
106			return [
107			[true, [new TrueValue()]],
108			['1', [new TrueValue()]],
109			['1', [new TrueValue(strict: true)]],
110			[true, [new TrueValue(trueValue: true, strict: true)]],
111			];
112			}
113
114			public function dataValidationFailed(): array
115			{
116			return [
117			['5', [new TrueValue()], ['' => ['The value must be "1".']]],
118			[null, [new TrueValue()], ['' => ['The allowed types are integer, float, string, boolean. null given.']]],
119			[[], [new TrueValue()], ['' => ['The allowed types are integer, float, string, boolean. array given.']]],
120			[true, [new TrueValue(strict: true)], ['' => ['The value must be "1".']]],
121			['1', [new TrueValue(trueValue: true, strict: true)], ['' => ['The value must be "true".']]],
122			[
123			[],
124			[new TrueValue(trueValue: true, strict: true)],
125			['' => ['The allowed types are integer, float, string, boolean. array given.']],
126			],
127
128			[false, [new TrueValue()], ['' => ['The value must be "1".']]],
129			['0', [new TrueValue()], ['' => ['The value must be "1".']]],
130			['0', [new TrueValue(strict: true)], ['' => ['The value must be "1".']]],
131			[false, [new TrueValue(trueValue: true, strict: true)], ['' => ['The value must be "true".']]],
132
133			'custom message' => [
134			5,
135			[new TrueValue(message: 'Custom error.')],
136			['' => ['Custom error.']],
137			],
138			'custom message with parameters' => [
139			5,
140			[new TrueValue(message: 'Attribute - {attribute}, true - {true}, value - {value}.')],
141			['' => ['Attribute - , true - 1, value - 5.']],
142			],
143			'custom message with parameters, custom true value, strict' => [
144			5,
145			[
146			new TrueValue(
147			trueValue: true,
148			strict: true,
149			message: 'Attribute - {attribute}, true - {true}, value - {value}.',
150			),
151			],
152			['' => ['Attribute - , true - true, value - 5.']],
153			],
154			'custom message with parameters, attribute set' => [
155			['data' => 5],
156			[
157			'data' => new TrueValue(message: 'Attribute - {attribute}, true - {true}, value - {value}.'),
158			],
159			['data' => ['Attribute - data, true - 1, value - 5.']],
160			],
161			'custom incorrect input message' => [
162			[],
163			[new TrueValue(incorrectInputMessage: 'Custom error.')],
164			['' => ['Custom error.']],
165			],
166			'custom incorrect input message with parameters' => [
167			[],
168			[
169			new TrueValue(incorrectInputMessage: 'Attribute - {attribute}, true - {true}, type - {type}.'),
170			],
171			['' => ['Attribute - , true - 1, type - array.']],
172			],
173			'custom incorrect input message with parameters, custom true and false values, strict' => [
174			[],
175			[
176			new TrueValue(
177			trueValue: true,
178			strict: true,
179			incorrectInputMessage: 'Attribute - {attribute}, true - {true}, type - {type}.',
180			),
181			],
182			['' => ['Attribute - , true - true, type - array.']],
183			],
184			'custom incorrect input message with parameters, attribute set' => [
185			['data' => []],
186			[
187			'data' => new TrueValue(incorrectInputMessage: 'Attribute - {attribute}, true - {true}, type - {type}.'),
188			],
189			['data' => ['Attribute - data, true - 1, type - array.']],
190			],
191			'custom incorrect input message, null' => [
192			null,
193			[new TrueValue(incorrectInputMessage: 'Attribute - {attribute}, true - {true}, type - {type}.'),],
194			['' => ['Attribute - , true - 1, type - null.']],
195			],
196			];
197			}
198
199			public function testSkipOnError(): void
200			{
201			$this->testSkipOnErrorInternal(new TrueValue(), new TrueValue(skipOnError: true));
202			}
203
204			public function testWhen(): void
205			{
206			$when = static fn (mixed $value): bool => $value !== null;
207			$this->testWhenInternal(new TrueValue(), new TrueValue(when: $when));
208			}
209
210			protected function getDifferentRuleInHandlerItems(): array
211			{
212			return [TrueValue::class, TrueValueHandler::class];
213			}
214			}
215

yiisoft / validator

Pull Request — master (#490)

TrueValueTest::dataOptions() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like