AttributesRulesProviderTest.php$3 ➔ convertRulesToClassNames() - Code Metrics - Inspection of "Allow use class name in `ObjectParser` + use `Obje..." - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#449)

by Sergei

created 2022-12-10 07:14 UTC

php$3 ➔ convertRulesToClassNames() A

↳ Parent: AttributesRulesProviderTest

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	11
cc	3
rs	9.9

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Tests\RulesProvider;

use JetBrains\PhpStorm\Deprecated;
use PHPUnit\Framework\TestCase;
use ReflectionProperty;
use Traversable;
use Yiisoft\Validator\Rule\HasLength;
use Yiisoft\Validator\Rule\IsTrue;
use Yiisoft\Validator\Rule\Number;
use Yiisoft\Validator\Rule\Required;
use Yiisoft\Validator\RuleInterface;
use Yiisoft\Validator\RulesProvider\AttributesRulesProvider;
use Yiisoft\Validator\Tests\Support\Data\ObjectWithDifferentPropertyVisibility;

final class AttributesRulesProviderTest extends TestCase
{
    public function dataBase(): array
    {
        return [
            'class-name' => [
                [
                    'name' => [Required::class],
                    'age' => [Number::class],
                    'number' => [Number::class],
                ],
                ObjectWithDifferentPropertyVisibility::class,
            ],
            'object' => [
                [
                    'name' => [Required::class],
                    'age' => [Number::class],
                    'number' => [Number::class],
                ],
                new ObjectWithDifferentPropertyVisibility(),
            ],
            'object with no properties' => [
                [],
                new class () {
                },
            ],
            'object with properties without rule attributes' => [
                [
                    'title' => [HasLength::class],
                ],
                new class () {
                    #[Deprecated(reason: 'test reason', replacement: 'test replacement')]
                    private int $viewsCount = 1;


                    private bool $active = true;


                    #[HasLength(max: 255)]
                    private string $title = 'Test title';

                },
            ],
        ];
    }

    /**
     * @dataProvider dataBase
     */
    public function testBase(array $expectedRuleClassNames, string|object $source): void
    {
        $rulesProvider = new AttributesRulesProvider($source);
        $ruleClassNames = $this->convertRulesToClassNames($rulesProvider->getRules());

        $this->assertSame($expectedRuleClassNames, $ruleClassNames);
    }

    public function dataPropertyVisibility(): array
    {
        return [
            'class-name-and-private-protected-public' => [
                [
                    'name' => [Required::class],
                    'age' => [Number::class],
                    'number' => [Number::class],
                ],
                ObjectWithDifferentPropertyVisibility::class,
                ReflectionProperty::IS_PRIVATE | ReflectionProperty::IS_PROTECTED | ReflectionProperty::IS_PUBLIC,
            ],
            'class-name-and-private' => [
                [
                    'number' => [Number::class],
                ],
                ObjectWithDifferentPropertyVisibility::class,
                ReflectionProperty::IS_PRIVATE,
            ],
            'class-name-and-protected' => [
                [
                    'age' => [Number::class],
                ],
                ObjectWithDifferentPropertyVisibility::class,
                ReflectionProperty::IS_PROTECTED,
            ],
            'class-name-and-public' => [
                [
                    'name' => [Required::class],
                ],
                ObjectWithDifferentPropertyVisibility::class,
                ReflectionProperty::IS_PUBLIC,
            ],
            'object-and-private-protected-public' => [
                [
                    'name' => [Required::class],
                    'age' => [Number::class],
                    'number' => [Number::class],
                ],
                new ObjectWithDifferentPropertyVisibility(),
                ReflectionProperty::IS_PRIVATE | ReflectionProperty::IS_PROTECTED | ReflectionProperty::IS_PUBLIC,
            ],
            'object-and-private' => [
                [
                    'number' => [Number::class],
                ],
                new ObjectWithDifferentPropertyVisibility(),
                ReflectionProperty::IS_PRIVATE,
            ],
            'object-and-protected' => [
                [
                    'age' => [Number::class],
                ],
                new ObjectWithDifferentPropertyVisibility(),
                ReflectionProperty::IS_PROTECTED,
            ],
            'object-and-public' => [
                [
                    'name' => [Required::class],
                ],
                new ObjectWithDifferentPropertyVisibility(),
                ReflectionProperty::IS_PUBLIC,
            ],
        ];
    }

    /**
     * @dataProvider dataPropertyVisibility
     */
    public function testPropertyVisibility(
        array $expectedRuleClassNames,
        string|object $source,
        int $propertyVisibility,
    ): void {
        $rulesProvider = new AttributesRulesProvider($source, $propertyVisibility);

        $ruleClassNames = $this->convertRulesToClassNames($rulesProvider->getRules());

        $this->assertSame($expectedRuleClassNames, $ruleClassNames);
    }

    public function dataStaticProperties(): array
    {
        return [
            [
                ['a' => [Required::class]],
                new class() {

                    #[Required]
                    public int $a = 1;
                    #[IsTrue]
                    public static bool $b = false;
                },
                true
            ],
            [
                ['a' => [Required::class], 'b' => [IsTrue::class]],
                new class() {

                    #[Required]
                    public int $a = 1;
                    #[IsTrue]
                    public static bool $b = false;
                },
                false
            ],
        ];
    }

    /**
     * @dataProvider dataStaticProperties
     */
    public function testStaticProperties(
        array $expectedRuleClassNames,
        object $source,
        bool $skipStaticProperties,
    ): void {
        $rulesProvider = new AttributesRulesProvider($source, skipStaticProperties: $skipStaticProperties);

        $ruleClassNames = $this->convertRulesToClassNames($rulesProvider->getRules());

        $this->assertSame($expectedRuleClassNames, $ruleClassNames);
    }

    private function convertRulesToClassNames(iterable $rules): array
    {
        $classNames = [];
        foreach ($rules as $attribute => $attributeRules) {
            $classNames[$attribute] = array_map(
                static fn (RuleInterface $rule): string => $rule::class,
                $attributeRules instanceof Traversable ? iterator_to_array($attributeRules) : $attributeRules
            );
        }

        return $classNames;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Validator\Tests\RulesProvider;
6
7			use JetBrains\PhpStorm\Deprecated;
8			use PHPUnit\Framework\TestCase;
9			use ReflectionProperty;
10			use Traversable;
11			use Yiisoft\Validator\Rule\HasLength;
12			use Yiisoft\Validator\Rule\IsTrue;
13			use Yiisoft\Validator\Rule\Number;
14			use Yiisoft\Validator\Rule\Required;
15			use Yiisoft\Validator\RuleInterface;
16			use Yiisoft\Validator\RulesProvider\AttributesRulesProvider;
17			use Yiisoft\Validator\Tests\Support\Data\ObjectWithDifferentPropertyVisibility;
18
19			final class AttributesRulesProviderTest extends TestCase
20			{
21			public function dataBase(): array
22			{
23			return [
24			'class-name' => [
25			[
26			'name' => [Required::class],
27			'age' => [Number::class],
28			'number' => [Number::class],
29			],
30			ObjectWithDifferentPropertyVisibility::class,
31			],
32			'object' => [
33			[
34			'name' => [Required::class],
35			'age' => [Number::class],
36			'number' => [Number::class],
37			],
38			new ObjectWithDifferentPropertyVisibility(),
39			],
40			'object with no properties' => [
41			[],
42			new class () {
43			},
44			],
45			'object with properties without rule attributes' => [
46			[
47			'title' => [HasLength::class],
48			],
49			new class () {
50			#[Deprecated(reason: 'test reason', replacement: 'test replacement')]
51			private int $viewsCount = 1;
			0 ignored issues – show introduced 2022-12-01 11:29 UTC by Report Bug Copy Issue Report The private property `$viewsCount` is not used, and could be removed. Loading history...
52
53			private bool $active = true;
			0 ignored issues – show introduced 2022-12-01 11:29 UTC by Report Bug Copy Issue Report The private property `$active` is not used, and could be removed. Loading history...
54
55			#[HasLength(max: 255)]
56			private string $title = 'Test title';
			0 ignored issues – show introduced 2022-12-01 11:29 UTC by Report Bug Copy Issue Report The private property `$title` is not used, and could be removed. Loading history...
57			},
58			],
59			];
60			}
61
62			/**
63			* @dataProvider dataBase
64			*/
65			public function testBase(array $expectedRuleClassNames, string\|object $source): void
66			{
67			$rulesProvider = new AttributesRulesProvider($source);
68			$ruleClassNames = $this->convertRulesToClassNames($rulesProvider->getRules());
69
70			$this->assertSame($expectedRuleClassNames, $ruleClassNames);
71			}
72
73			public function dataPropertyVisibility(): array
74			{
75			return [
76			'class-name-and-private-protected-public' => [
77			[
78			'name' => [Required::class],
79			'age' => [Number::class],
80			'number' => [Number::class],
81			],
82			ObjectWithDifferentPropertyVisibility::class,
83			ReflectionProperty::IS_PRIVATE \| ReflectionProperty::IS_PROTECTED \| ReflectionProperty::IS_PUBLIC,
84			],
85			'class-name-and-private' => [
86			[
87			'number' => [Number::class],
88			],
89			ObjectWithDifferentPropertyVisibility::class,
90			ReflectionProperty::IS_PRIVATE,
91			],
92			'class-name-and-protected' => [
93			[
94			'age' => [Number::class],
95			],
96			ObjectWithDifferentPropertyVisibility::class,
97			ReflectionProperty::IS_PROTECTED,
98			],
99			'class-name-and-public' => [
100			[
101			'name' => [Required::class],
102			],
103			ObjectWithDifferentPropertyVisibility::class,
104			ReflectionProperty::IS_PUBLIC,
105			],
106			'object-and-private-protected-public' => [
107			[
108			'name' => [Required::class],
109			'age' => [Number::class],
110			'number' => [Number::class],
111			],
112			new ObjectWithDifferentPropertyVisibility(),
113			ReflectionProperty::IS_PRIVATE \| ReflectionProperty::IS_PROTECTED \| ReflectionProperty::IS_PUBLIC,
114			],
115			'object-and-private' => [
116			[
117			'number' => [Number::class],
118			],
119			new ObjectWithDifferentPropertyVisibility(),
120			ReflectionProperty::IS_PRIVATE,
121			],
122			'object-and-protected' => [
123			[
124			'age' => [Number::class],
125			],
126			new ObjectWithDifferentPropertyVisibility(),
127			ReflectionProperty::IS_PROTECTED,
128			],
129			'object-and-public' => [
130			[
131			'name' => [Required::class],
132			],
133			new ObjectWithDifferentPropertyVisibility(),
134			ReflectionProperty::IS_PUBLIC,
135			],
136			];
137			}
138
139			/**
140			* @dataProvider dataPropertyVisibility
141			*/
142			public function testPropertyVisibility(
143			array $expectedRuleClassNames,
144			string\|object $source,
145			int $propertyVisibility,
146			): void {
147			$rulesProvider = new AttributesRulesProvider($source, $propertyVisibility);
148
149			$ruleClassNames = $this->convertRulesToClassNames($rulesProvider->getRules());
150
151			$this->assertSame($expectedRuleClassNames, $ruleClassNames);
152			}
153
154			public function dataStaticProperties(): array
155			{
156			return [
157			[
158			['a' => [Required::class]],
159			new class() {
			0 ignored issues – show Coding Style introduced 2022-12-10 07:16 UTC by Report Bug Copy Issue Report Expected 1 space after class keyword; 0 found Loading history...
160			#[Required]
161			public int $a = 1;
162			#[IsTrue]
163			public static bool $b = false;
164			},
165			true
166			],
167			[
168			['a' => [Required::class], 'b' => [IsTrue::class]],
169			new class() {
			0 ignored issues – show Coding Style introduced 2022-12-10 07:16 UTC by Report Bug Copy Issue Report Expected 1 space after class keyword; 0 found Loading history...
170			#[Required]
171			public int $a = 1;
172			#[IsTrue]
173			public static bool $b = false;
174			},
175			false
176			],
177			];
178			}
179
180			/**
181			* @dataProvider dataStaticProperties
182			*/
183			public function testStaticProperties(
184			array $expectedRuleClassNames,
185			object $source,
186			bool $skipStaticProperties,
187			): void {
188			$rulesProvider = new AttributesRulesProvider($source, skipStaticProperties: $skipStaticProperties);
189
190			$ruleClassNames = $this->convertRulesToClassNames($rulesProvider->getRules());
191
192			$this->assertSame($expectedRuleClassNames, $ruleClassNames);
193			}
194
195			private function convertRulesToClassNames(iterable $rules): array
196			{
197			$classNames = [];
198			foreach ($rules as $attribute => $attributeRules) {
199			$classNames[$attribute] = array_map(
200			static fn (RuleInterface $rule): string => $rule::class,
201			$attributeRules instanceof Traversable ? iterator_to_array($attributeRules) : $attributeRules
202			);
203			}
204
205			return $classNames;
206			}
207			}
208

yiisoft / validator

Pull Request — master (#449)

php$3 ➔ convertRulesToClassNames() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like