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

Passed

Pull Request — master (#222)

by Alexander

created 2022-06-02 20:56 UTC

CompareTo::compareValues() B

↳ Parent: Project

Complexity

Conditions	10
Paths	18

Size

Total Lines	28
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	21
CRAP Score	10.1953

Importance

Changes

Metric	Value
cc	10
eloc	25
nc	18
nop	4
dl	0
loc	28
ccs	21
cts	24
cp	0.875
crap	10.1953
rs	7.6666
c	0
b	0
f	0

How to fix Complexity

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use InvalidArgumentException;
use JetBrains\PhpStorm\ArrayShape;
use RuntimeException;
use Yiisoft\Validator\Rule\Trait\RuleNameTrait;

use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
use Yiisoft\Validator\ParametrizedRuleInterface;

/**
 * Compares the specified value with another value.
 *
 * The value being compared with a constant {@see CompareTo::$compareValue}, which is set
 * in the constructor.
 *
 * It supports different comparison operators, specified
 * via the {@see CompareTo::$operator}.
 *
 * The default comparison function is based on string values, which means the values
 * are compared byte by byte. When comparing numbers, make sure to change {@see CompareTo::$type} to
 * {@see CompareTo::TYPE_NUMBER} to enable numeric comparison.
 */
#[Attribute(Attribute::TARGET_PROPERTY)]
final class CompareTo implements ParametrizedRuleInterface
{
    use HandlerClassNameTrait;
    use RuleNameTrait;

    /**
     * Constant for specifying the comparison as string values.
     * No conversion will be done before comparison.
     *
     * @see $type
     */
    public const TYPE_STRING = 'string';
    /**
     * Constant for specifying the comparison as numeric values.
     * String values will be converted into numbers before comparison.
     *
     * @see $type
     */
    public const TYPE_NUMBER = 'number';
    private array $validOperators = [
        '==' => 1,
        '===' => 1,
        '!=' => 1,
        '!==' => 1,
        '>' => 1,
        '>=' => 1,
        '<' => 1,
        '<=' => 1,
    ];

    public function __construct(
        /**
         * @var mixed the constant value to be compared with.
         */
        private $compareValue,
        /**
         * @var string|null user-defined error message
         */
        private ?string $message = null,
        /**
         * @var string the type of the values being compared.
         */
        private string $type = self::TYPE_STRING,
        /**
         * @var string the operator for comparison. The following operators are supported:
         *
         * - `==`: check if two values are equal. The comparison is done is non-strict mode.
         * - `===`: check if two values are equal. The comparison is done is strict mode.
         * - `!=`: check if two values are NOT equal. The comparison is done is non-strict mode.
         * - `!==`: check if two values are NOT equal. The comparison is done is strict mode.
         * - `>`: check if value being validated is greater than the value being compared with.
         * - `>=`: check if value being validated is greater than or equal to the value being compared with.
         * - `<`: check if value being validated is less than the value being compared with.
         * - `<=`: check if value being validated is less than or equal to the value being compared with.
         *
         * When you want to compare numbers, make sure to also chabge @see CompareTo::$type} to
         * {@see CompareTo::TYPE_NUMBER}.
         */
        private string $operator = '==',
        private bool $skipOnEmpty = false,
        private bool $skipOnError = false,
        private ?Closure $when = null,
    ) {
        if (!isset($this->validOperators[$operator])) {
            throw new InvalidArgumentException("Operator \"$operator\" is not supported.");
        }
    }

    /**
     * @return mixed
     */
    public function getCompareValue(): mixed
    {
        return $this->compareValue;
    }

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

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

    /**
     * @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;
    }

    public function getMessage(): string
    {
        return $this->message ?? match ($this->operator) {
            '==', '===' => 'Value must be equal to "{compareValue}".',
            '!=', '!==' => 'Value must not be equal to "{compareValue}".',
            '>' => 'Value must be greater than "{compareValue}".',
            '>=' => 'Value must be greater than or equal to "{compareValue}".',
            '<' => 'Value must be less than "{compareValue}".',
            '<=' => 'Value must be less than or equal to "{compareValue}".',
            default => throw new RuntimeException("Unknown operator: {$this->operator}"),
        };
    }

    #[ArrayShape([
        'compareValue' => '',
        'message' => 'array',
        'type' => 'string',
        'operator' => 'string',
        'skipOnEmpty' => 'bool',
        'skipOnError' => 'bool',
    ])]
    public function getOptions(): array
    {
        return [
            'compareValue' => $this->compareValue,
            'message' => [
                'message' => $this->getMessage(),
                'parameters' => ['compareValue' => $this->compareValue],
            ],
            'type' => $this->type,
            'operator' => $this->operator,
            'skipOnEmpty' => $this->skipOnEmpty,
            'skipOnError' => $this->skipOnError,
        ];
    }
}


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 JetBrains\PhpStorm\ArrayShape;
11		use RuntimeException;
12		use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
		0 ignored issues – show Bug introduced 2022-05-27 13:44 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_TRAIT, expecting T_STRING or '{' on line 12 at column 27 Loading history...
13		use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
14		use Yiisoft\Validator\ParametrizedRuleInterface;
15
16		/**
17		* Compares the specified value with another value.
18		*
19		* The value being compared with a constant {@see CompareTo::$compareValue}, which is set
20		* in the constructor.
21		*
22		* It supports different comparison operators, specified
23		* via the {@see CompareTo::$operator}.
24		*
25		* The default comparison function is based on string values, which means the values
26		* are compared byte by byte. When comparing numbers, make sure to change {@see CompareTo::$type} to
27		* {@see CompareTo::TYPE_NUMBER} to enable numeric comparison.
28		*/
29		#[Attribute(Attribute::TARGET_PROPERTY)]
30		final class CompareTo implements ParametrizedRuleInterface
31		{
32		use HandlerClassNameTrait;
33		use RuleNameTrait;
34
35		/**
36		* Constant for specifying the comparison as string values.
37		* No conversion will be done before comparison.
38		*
39		* @see $type
40		*/
41		public const TYPE_STRING = 'string';
42		/**
43		* Constant for specifying the comparison as numeric values.
44		* String values will be converted into numbers before comparison.
45		*
46		* @see $type
47		*/
48		public const TYPE_NUMBER = 'number';
49		private array $validOperators = [
50		'==' => 1,
51		'===' => 1,
52		'!=' => 1,
53		'!==' => 1,
54		'>' => 1,
55		'>=' => 1,
56		'<' => 1,
57		'<=' => 1,
58		];
59
60	1	public function __construct(
61		/**
62		* @var mixed the constant value to be compared with.
63		*/
64		private $compareValue,
65		/**
66		* @var string\|null user-defined error message
67		*/
68		private ?string $message = null,
69		/**
70		* @var string the type of the values being compared.
71		*/
72		private string $type = self::TYPE_STRING,
73		/**
74		* @var string the operator for comparison. The following operators are supported:
75		*
76		* - `==`: check if two values are equal. The comparison is done is non-strict mode.
77		* - `===`: check if two values are equal. The comparison is done is strict mode.
78		* - `!=`: check if two values are NOT equal. The comparison is done is non-strict mode.
79		* - `!==`: check if two values are NOT equal. The comparison is done is strict mode.
80		* - `>`: check if value being validated is greater than the value being compared with.
81		* - `>=`: check if value being validated is greater than or equal to the value being compared with.
82		* - `<`: check if value being validated is less than the value being compared with.
83		* - `<=`: check if value being validated is less than or equal to the value being compared with.
84		*
85		* When you want to compare numbers, make sure to also chabge @see CompareTo::$type} to
86		* {@see CompareTo::TYPE_NUMBER}.
87		*/
88		private string $operator = '==',
89		private bool $skipOnEmpty = false,
90		private bool $skipOnError = false,
91		private ?Closure $when = null,
92		) {
93	1	if (!isset($this->validOperators[$operator])) {
94		throw new InvalidArgumentException("Operator \"$operator\" is not supported.");
95		}
96		}
97
98		/**
99		* @return mixed
100		*/
101	30	public function getCompareValue(): mixed
102		{
103	30	return $this->compareValue;
104		}
105
106		/**
107		* @return string
108		*/
109	30	public function getType(): string
110		{
111	30	return $this->type;
112		}
113
114		/**
115		* @return string
116		*/
117	30	public function getOperator(): string
118		{
119	30	return $this->operator;
120		}
121
122		/**
123		* @return bool
124		*/
125		public function isSkipOnEmpty(): bool
126		{
127		return $this->skipOnEmpty;
128		}
129
130		/**
131		* @return bool
132		*/
133		public function isSkipOnError(): bool
134		{
135		return $this->skipOnError;
136		}
137
138		/**
139		* @return Closure\|null
140		*/
141		public function getWhen(): ?Closure
142		{
143		return $this->when;
144		}
145
146	22	public function getMessage(): string
147		{
148	22	return $this->message ?? match ($this->operator) {
149	6	'==', '===' => 'Value must be equal to "{compareValue}".',
150	7	'!=', '!==' => 'Value must not be equal to "{compareValue}".',
151	2	'>' => 'Value must be greater than "{compareValue}".',
152	2	'>=' => 'Value must be greater than or equal to "{compareValue}".',
153	2	'<' => 'Value must be less than "{compareValue}".',
154	1	'<=' => 'Value must be less than or equal to "{compareValue}".',
155	22	default => throw new RuntimeException("Unknown operator: {$this->operator}"),
156		};
157		}
158
159	7	#[ArrayShape([
160		'compareValue' => '',
161		'message' => 'array',
162		'type' => 'string',
163		'operator' => 'string',
164		'skipOnEmpty' => 'bool',
165		'skipOnError' => 'bool',
166		])]
167		public function getOptions(): array
168		{
169		return [
170	7	'compareValue' => $this->compareValue,
171		'message' => [
172	7	'message' => $this->getMessage(),
173	7	'parameters' => ['compareValue' => $this->compareValue],
174		],
175	7	'type' => $this->type,
176	7	'operator' => $this->operator,
177	7	'skipOnEmpty' => $this->skipOnEmpty,
178	7	'skipOnError' => $this->skipOnError,
179		];
180		}
181		}
182

yiisoft / validator

Pull Request — master (#222)

CompareTo::compareValues() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like