Nested::validateValue() - Code Metrics - Inspection of "Refactoring rules concept" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#222)

by Rustam

created 2022-05-27 13:42 UTC

Nested::validateValue() B

↳ Parent: Project

Complexity

Conditions	11
Paths	7

Size

Total Lines	39
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	24
CRAP Score	11

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	11
eloc	23
nc	7
nop	2
dl	0
loc	39
ccs	24
cts	24
cp	1
crap	11
rs	7.3166
c	1
b	0
f	0

How to fix Complexity

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use InvalidArgumentException;
use Traversable;
use Yiisoft\Validator\Rule\Trait\RuleNameTrait;

use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
use Yiisoft\Validator\ParametrizedRuleInterface;
use Yiisoft\Validator\RuleInterface;
use Yiisoft\Validator\RulesDumper;
use function is_array;

/**
 * Can be used for validation of nested structures.
 *
 * For example, we have an inbound request with the following structure:
 *
 * ```php
 * $request = [
 *     'author' => [
 *         'name' => 'Dmitry',
 *         'age' => 18,
 *     ],
 * ];
 * ```
 *
 * So to make validation we can configure it like this:
 *
 * ```php
 * $rule = new Nested([
 *     'author' => new Nested([
 *         'name' => [new HasLength(min: 3)],
 *         'age' => [new Number(min: 18)],
 *     )];
 * ]);
 * ```
 */
#[Attribute(Attribute::TARGET_PROPERTY)]
final class Nested implements ParametrizedRuleInterface
{
    use HandlerClassNameTrait;
    use RuleNameTrait;

    public function __construct(
        /**
         * @var RuleInterface[][]
         */
        private iterable $rules = [],
        private bool $errorWhenPropertyPathIsNotFound = false,
        private string $propertyPathIsNotFoundMessage = 'Property path "{path}" is not found.',
        private bool $skipOnEmpty = false,
        private bool $skipOnError = false,
        private ?Closure $when = null,
    ) {
        $rules = $rules instanceof Traversable ? iterator_to_array($rules) : $rules;
        if (empty($rules)) {
            throw new InvalidArgumentException('Rules must not be empty.');
        }

        if ($this->checkRules($rules)) {
            $message = sprintf('Each rule should be an instance of %s.', RuleInterface::class);
            throw new InvalidArgumentException($message);
        }

        $this->rules = $rules;
    }

    /**
     * @return iterable
     */
    public function getRules(): iterable
    {
        return $this->rules;
    }

    /**
     * @return bool
     */
    public function isErrorWhenPropertyPathIsNotFound(): bool
    {
        return $this->errorWhenPropertyPathIsNotFound;
    }

    /**
     * @return string
     */
    public function getPropertyPathIsNotFoundMessage(): string
    {
        return $this->propertyPathIsNotFoundMessage;
    }

    /**
     * @return bool
     */
    public function isSkipOnEmpty(): bool
    {
        return $this->skipOnEmpty;
    }

    /**
     * @return bool
     */
    public function isSkipOnError(): bool
    {
        return $this->skipOnError;
    }

    /**
     * @return Closure|null
     */
    public function getWhen(): ?Closure
    {
        return $this->when;
    }

    private function checkRules(array $rules): bool
    {
        return array_reduce(
            $rules,
            function (bool $carry, $rule) {
                return $carry || (is_array($rule) ? $this->checkRules($rule) : !$rule instanceof RuleInterface);
            },
            false
        );
    }

    public function getOptions(): array
    {
        return (new RulesDumper())->asArray($this->rules);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Validator\Rule;
6
7		use Attribute;
8		use Closure;
9		use InvalidArgumentException;
10		use Traversable;
11		use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
		0 ignored issues – show Bug introduced 2022-04-21 16:11 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_TRAIT, expecting T_STRING or '{' on line 11 at column 27 Loading history...
12		use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
13		use Yiisoft\Validator\ParametrizedRuleInterface;
14		use Yiisoft\Validator\RuleInterface;
15		use Yiisoft\Validator\RulesDumper;
16		use function is_array;
17
18		/**
19		* Can be used for validation of nested structures.
20		*
21		* For example, we have an inbound request with the following structure:
22		*
23		* ```php
24		* $request = [
25		* 'author' => [
26		* 'name' => 'Dmitry',
27		* 'age' => 18,
28		* ],
29		* ];
30		* ```
31		*
32		* So to make validation we can configure it like this:
33		*
34		* ```php
35		* $rule = new Nested([
36		* 'author' => new Nested([
37		* 'name' => [new HasLength(min: 3)],
38		* 'age' => [new Number(min: 18)],
39		* )];
40		* ]);
41		* ```
42		*/
43		#[Attribute(Attribute::TARGET_PROPERTY)]
44		final class Nested implements ParametrizedRuleInterface
45		{
46		use HandlerClassNameTrait;
47		use RuleNameTrait;
48
49	3	public function __construct(
50		/**
51		* @var RuleInterface[][]
52		*/
53		private iterable $rules = [],
54		private bool $errorWhenPropertyPathIsNotFound = false,
55		private string $propertyPathIsNotFoundMessage = 'Property path "{path}" is not found.',
56		private bool $skipOnEmpty = false,
57		private bool $skipOnError = false,
58		private ?Closure $when = null,
59		) {
60	3	$rules = $rules instanceof Traversable ? iterator_to_array($rules) : $rules;
61	3	if (empty($rules)) {
62	1	throw new InvalidArgumentException('Rules must not be empty.');
63		}
64
65	2	if ($this->checkRules($rules)) {
66	1	$message = sprintf('Each rule should be an instance of %s.', RuleInterface::class);
67	1	throw new InvalidArgumentException($message);
68		}
69
70	1	$this->rules = $rules;
71		}
72
73		/**
74		* @return iterable
75		*/
76	10	public function getRules(): iterable
77		{
78	10	return $this->rules;
79		}
80
81		/**
82		* @return bool
83		*/
84	10	public function isErrorWhenPropertyPathIsNotFound(): bool
85		{
86	10	return $this->errorWhenPropertyPathIsNotFound;
87		}
88
89		/**
90		* @return string
91		*/
92	2	public function getPropertyPathIsNotFoundMessage(): string
93		{
94	2	return $this->propertyPathIsNotFoundMessage;
95		}
96
97		/**
98		* @return bool
99		*/
100		public function isSkipOnEmpty(): bool
101		{
102		return $this->skipOnEmpty;
103		}
104
105		/**
106		* @return bool
107		*/
108		public function isSkipOnError(): bool
109		{
110		return $this->skipOnError;
111		}
112
113		/**
114		* @return Closure\|null
115		*/
116		public function getWhen(): ?Closure
117		{
118		return $this->when;
119		}
120
121	2	private function checkRules(array $rules): bool
122		{
123	2	return array_reduce(
124		$rules,
125	2	function (bool $carry, $rule) {
126	2	return $carry \|\| (is_array($rule) ? $this->checkRules($rule) : !$rule instanceof RuleInterface);
127		},
128		false
129		);
130		}
131
132	4	public function getOptions(): array
133		{
134	4	return (new RulesDumper())->asArray($this->rules);
135		}
136		}
137

yiisoft / validator

Pull Request — master (#222)

Nested::validateValue() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like