Validator::buildRule() - Code Metrics - Inspection of "excluded PHP < 7 from Travis CI builds" - franzose/kontrolio - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a97ce7...6f972b )

by Jan

created 2020-05-05 10:10 UTC

Validator::buildRule() A

↳ Parent: Validator

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	5
rs	10

<?php

namespace Kontrolio;

use Kontrolio\Data\Attribute;
use Kontrolio\Data\Data;
use Kontrolio\Error\Errors;
use Kontrolio\Rules\Core\Sometimes;
use Kontrolio\Rules\Core\UntilFirstFailure;
use Kontrolio\Rules\ArrayNormalizer;
use Kontrolio\Rules\Instantiator;
use Kontrolio\Rules\StopsFurtherValidationInterface;
use Kontrolio\Rules\Parser;
use Kontrolio\Rules\Repository;
use Kontrolio\Rules\CallableRuleWrapper;
use Kontrolio\Rules\RuleInterface;
use UnexpectedValueException;

/**
 * Main class of the validation service.
 *
 * @package Kontrolio
 */
class Validator implements ValidatorInterface
{
    /**
     * Data to validate.
     *
     * @var Data
     */
    protected $data;
    
    /**
     * Raw validation rules.
     *
     * @var array
     */
    protected $rules = [];

    /**
     * Formatted validation rules.
     *
     * @var array
     */
    protected $normalizedRules = [];

    /**
     * Validation messages.
     *
     * @var array
     */
    protected $messages = [];

    private $repository;
    private $normalizer;

    /**
     * Validation errors.
     *
     * @var Errors
     */
    protected $errors;

    /**
     * Flag indicating that the validation should stop.
     *
     * @var bool
     */
    protected $shouldStopOnFirstFailure = false;

    /**
     * Flag indication that the validation of the current attribute should stop.
     *
     * @var bool
     */
    protected $shouldStopWithinAttribute = false;

    /**
     * Flag indicating that the validation can be bypassed.
     *
     * @var bool
     */
    private $bypass = false;

    /**
     * Validator constructor.
     *
     * @param array $data
     * @param array $rules
     * @param array $messages
     */
    public function __construct(array $data, array $rules, array $messages = [])
    {
        $this->data = new Data($data);
        $this->rules = $rules;
        $this->messages = $messages;
        $instantiator = new Instantiator();
        $this->repository = new Repository($instantiator);
        $this->normalizer = new ArrayNormalizer(new Parser($this->repository));
        $this->errors = new Errors($messages);
    }

    /**
     * Extends available rules with new ones.
     *
     * @param array $rules
     *
     * @return $this
     */
    public function extend(array $rules)
    {
        $this->repository->add($rules);

        return $this;
    }

    /**
     * Returns all available validation rules.
     *
     * @return array
     */
    public function getAvailable()
    {
        return $this->repository->all();
    }

    /**
     * Returns data that's being validated.
     *
     * @return array
     */
    public function getData()
    {
        return $this->data->raw();
    }

    /**
     * Sets data that need to be validated.
     *
     * @param array $data
     *
     * @return $this
     */
    public function setData(array $data)
    {
        $this->data = new Data($data);

        return $this;
    }

    /**
     * Returns validation rules.
     *
     * @return array
     */
    public function getRules()
    {
        return $this->rules;
    }

    /**
     * Checks proper format of the validation rules and sets them for the validator.
     *
     * @param array $rules
     *
     * @return $this
     * @throws UnexpectedValueException
     */
    public function setRules(array $rules)
    {
        $this->rules = $rules;
        $this->normalizedRules = $this->normalizer->normalize($rules);

        return $this;
    }

    /**
     * Returns validation messages.
     *
     * @return array
     */
    public function getMessages()
    {
        return $this->messages;
    }

    /**
     * Sets validation messages.
     *
     * @param array $messages
     *
     * @return $this
     */
    public function setMessages(array $messages)
    {
        $this->messages = $messages;

        return $this;
    }

    /**
     * Validates given data.
     *
     * @return bool
     * @throws UnexpectedValueException
     */
    public function validate()
    {
        if (empty($this->normalizedRules)) {
            $this->normalizedRules = $this->normalizer->normalize($this->rules);
        }

        foreach ($this->normalizedRules as $attrName => $rules) {
            $this->bypass = false;
            $this->shouldStopWithinAttribute = false;

            foreach ($rules as $rule) {
                if ($rule instanceof UntilFirstFailure) {
                    $this->shouldStopWithinAttribute = true;
                }

                $attribute = $this->data->get($attrName);
                $rule = $this->resolveRule($rule, $attribute);

                $this->handle($rule, $attribute);

                if ($this->shouldProceedToTheNextAttribute($attrName)) {
                    continue 2;
                }
                
                if ($this->shouldStopOnFailure($rule, $attrName)) {
                    return false;
                }
            }
        }
        
        return $this->errors->isEmpty();
    }

    /**
     * Processes a data attribute and creates new validation error message if the validation failed.
     *
     * @param RuleInterface $rule
     * @param Attribute $attribute
     * @throws UnexpectedValueException
     */
    protected function handle($rule, Attribute $attribute)
    {
        if ($rule instanceof Sometimes && $attribute->isEmpty()) {
            $this->bypass = true;

            return;
        }

        $raw = $attribute->getValue();

        if ($rule->isValid($raw) ||
            $rule->canSkipValidation($raw) ||
            ($rule->emptyValueAllowed() && $attribute->isEmpty())) {
            return;
        }

        $this->errors->add($attribute, $rule);
    }

    /**
     * Resolves validation rule according to actual rule type.
     *
     * @param callable|RuleInterface $rule
     * @param mixed $value
     *
     * @return RuleInterface
     * @throws UnexpectedValueException
     */
    protected function resolveRule($rule, Attribute $value)
    {
        if ($rule instanceof RuleInterface) {
            return $rule;
        }
        
        if (is_callable($rule)) {
            return new CallableRuleWrapper($rule($value->getValue()));
        }

        throw new UnexpectedValueException(sprintf('Rule must implement `%s` or be callable.', RuleInterface::class));
    }

    /**
     * Determines whether validation should stop on the first failure.
     *
     * @param string $attribute
     * @param RuleInterface $rule
     *
     * @return bool
     */
    protected function shouldStopOnFailure(RuleInterface $rule, $attribute)
    {
        return (
            $rule instanceof StopsFurtherValidationInterface ||
            $this->shouldStopOnFirstFailure ||
            $this->shouldStopWithinAttribute
        ) && $this->errors->has($attribute);
    }

    /**
     * Determines whether validator should proceed to the next attribute
     *
     * @param string $attribute
     *
     * @return bool
     */
    protected function shouldProceedToTheNextAttribute($attribute)
    {
        return $this->bypass || ($this->shouldStopWithinAttribute && $this->errors->has($attribute));
    }

    /**
     * Checks whether there are validation errors.
     *
     * @return bool
     */
    public function hasErrors()
    {
        return !$this->errors->isEmpty();
    }

    /**
     * Returns all validation errors.
     *
     * @return array
     */
    public function getErrors()
    {
        return $this->errors->raw();
    }

    /**
     * Returns a plain validation errors array without their attribute names.
     *
     * @return array
     */
    public function getErrorsList()
    {
        return $this->errors->flatten();
    }

    /**
     * Determines whether validation should stop on the first failure.
     *
     * @param bool $stop
     *
     * @return $this
     */
    public function shouldStopOnFirstFailure($stop = true)
    {
        $this->shouldStopOnFirstFailure = $stop;

        return $this;
    }
}


1			<?php
2
3			namespace Kontrolio;
4
5			use Kontrolio\Data\Attribute;
6			use Kontrolio\Data\Data;
7			use Kontrolio\Error\Errors;
8			use Kontrolio\Rules\Core\Sometimes;
9			use Kontrolio\Rules\Core\UntilFirstFailure;
10			use Kontrolio\Rules\ArrayNormalizer;
11			use Kontrolio\Rules\Instantiator;
12			use Kontrolio\Rules\StopsFurtherValidationInterface;
13			use Kontrolio\Rules\Parser;
14			use Kontrolio\Rules\Repository;
15			use Kontrolio\Rules\CallableRuleWrapper;
16			use Kontrolio\Rules\RuleInterface;
17			use UnexpectedValueException;
18
19			/**
20			* Main class of the validation service.
21			*
22			* @package Kontrolio
23			*/
24			class Validator implements ValidatorInterface
25			{
26			/**
27			* Data to validate.
28			*
29			* @var Data
30			*/
31			protected $data;
32
33			/**
34			* Raw validation rules.
35			*
36			* @var array
37			*/
38			protected $rules = [];
39
40			/**
41			* Formatted validation rules.
42			*
43			* @var array
44			*/
45			protected $normalizedRules = [];
46
47			/**
48			* Validation messages.
49			*
50			* @var array
51			*/
52			protected $messages = [];
53
54			private $repository;
55			private $normalizer;
56
57			/**
58			* Validation errors.
59			*
60			* @var Errors
61			*/
62			protected $errors;
63
64			/**
65			* Flag indicating that the validation should stop.
66			*
67			* @var bool
68			*/
69			protected $shouldStopOnFirstFailure = false;
70
71			/**
72			* Flag indication that the validation of the current attribute should stop.
73			*
74			* @var bool
75			*/
76			protected $shouldStopWithinAttribute = false;
77
78			/**
79			* Flag indicating that the validation can be bypassed.
80			*
81			* @var bool
82			*/
83			private $bypass = false;
84
85			/**
86			* Validator constructor.
87			*
88			* @param array $data
89			* @param array $rules
90			* @param array $messages
91			*/
92			public function __construct(array $data, array $rules, array $messages = [])
93			{
94			$this->data = new Data($data);
95			$this->rules = $rules;
96			$this->messages = $messages;
97			$instantiator = new Instantiator();
98			$this->repository = new Repository($instantiator);
99			$this->normalizer = new ArrayNormalizer(new Parser($this->repository));
100			$this->errors = new Errors($messages);
101			}
102
103			/**
104			* Extends available rules with new ones.
105			*
106			* @param array $rules
107			*
108			* @return $this
109			*/
110			public function extend(array $rules)
111			{
112			$this->repository->add($rules);
113
114			return $this;
115			}
116
117			/**
118			* Returns all available validation rules.
119			*
120			* @return array
121			*/
122			public function getAvailable()
123			{
124			return $this->repository->all();
125			}
126
127			/**
128			* Returns data that's being validated.
129			*
130			* @return array
131			*/
132			public function getData()
133			{
134			return $this->data->raw();
135			}
136
137			/**
138			* Sets data that need to be validated.
139			*
140			* @param array $data
141			*
142			* @return $this
143			*/
144			public function setData(array $data)
145			{
146			$this->data = new Data($data);
147
148			return $this;
149			}
150
151			/**
152			* Returns validation rules.
153			*
154			* @return array
155			*/
156			public function getRules()
157			{
158			return $this->rules;
159			}
160
161			/**
162			* Checks proper format of the validation rules and sets them for the validator.
163			*
164			* @param array $rules
165			*
166			* @return $this
167			* @throws UnexpectedValueException
168			*/
169			public function setRules(array $rules)
170			{
171			$this->rules = $rules;
172			$this->normalizedRules = $this->normalizer->normalize($rules);
173
174			return $this;
175			}
176
177			/**
178			* Returns validation messages.
179			*
180			* @return array
181			*/
182			public function getMessages()
183			{
184			return $this->messages;
185			}
186
187			/**
188			* Sets validation messages.
189			*
190			* @param array $messages
191			*
192			* @return $this
193			*/
194			public function setMessages(array $messages)
195			{
196			$this->messages = $messages;
197
198			return $this;
199			}
200
201			/**
202			* Validates given data.
203			*
204			* @return bool
205			* @throws UnexpectedValueException
206			*/
207			public function validate()
208			{
209			if (empty($this->normalizedRules)) {
210			$this->normalizedRules = $this->normalizer->normalize($this->rules);
211			}
212
213			foreach ($this->normalizedRules as $attrName => $rules) {
214			$this->bypass = false;
215			$this->shouldStopWithinAttribute = false;
216
217			foreach ($rules as $rule) {
218			if ($rule instanceof UntilFirstFailure) {
219			$this->shouldStopWithinAttribute = true;
220			}
221
222			$attribute = $this->data->get($attrName);
223			$rule = $this->resolveRule($rule, $attribute);
224
225			$this->handle($rule, $attribute);
226
227			if ($this->shouldProceedToTheNextAttribute($attrName)) {
228			continue 2;
229			}
230
231			if ($this->shouldStopOnFailure($rule, $attrName)) {
232			return false;
233			}
234			}
235			}
236
237			return $this->errors->isEmpty();
238			}
239
240			/**
241			* Processes a data attribute and creates new validation error message if the validation failed.
242			*
243			* @param RuleInterface $rule
244			* @param Attribute $attribute
245			* @throws UnexpectedValueException
246			*/
247			protected function handle($rule, Attribute $attribute)
248			{
249			if ($rule instanceof Sometimes && $attribute->isEmpty()) {
250			$this->bypass = true;
251
252			return;
253			}
254
255			$raw = $attribute->getValue();
256
257			if ($rule->isValid($raw) \|\|
258			$rule->canSkipValidation($raw) \|\|
259			($rule->emptyValueAllowed() && $attribute->isEmpty())) {
260			return;
261			}
262
263			$this->errors->add($attribute, $rule);
264			}
265
266			/**
267			* Resolves validation rule according to actual rule type.
268			*
269			* @param callable\|RuleInterface $rule
270			* @param mixed $value
271			*
272			* @return RuleInterface
273			* @throws UnexpectedValueException
274			*/
275			protected function resolveRule($rule, Attribute $value)
276			{
277			if ($rule instanceof RuleInterface) {
278			return $rule;
279			}
280
281			if (is_callable($rule)) {
282			return new CallableRuleWrapper($rule($value->getValue()));
283			}
284
285			throw new UnexpectedValueException(sprintf('Rule must implement `%s` or be callable.', RuleInterface::class));
286			}
287
288			/**
289			* Determines whether validation should stop on the first failure.
290			*
291			* @param string $attribute
292			* @param RuleInterface $rule
293			*
294			* @return bool
295			*/
296			protected function shouldStopOnFailure(RuleInterface $rule, $attribute)
297			{
298			return (
299			$rule instanceof StopsFurtherValidationInterface \|\|
300			$this->shouldStopOnFirstFailure \|\|
301			$this->shouldStopWithinAttribute
302			) && $this->errors->has($attribute);
303			}
304
305			/**
306			* Determines whether validator should proceed to the next attribute
307			*
308			* @param string $attribute
309			*
310			* @return bool
311			*/
312			protected function shouldProceedToTheNextAttribute($attribute)
313			{
314			return $this->bypass \|\| ($this->shouldStopWithinAttribute && $this->errors->has($attribute));
315			}
316
317			/**
318			* Checks whether there are validation errors.
319			*
320			* @return bool
321			*/
322			public function hasErrors()
323			{
324			return !$this->errors->isEmpty();
325			}
326
327			/**
328			* Returns all validation errors.
329			*
330			* @return array
331			*/
332			public function getErrors()
333			{
334			return $this->errors->raw();
335			}
336
337			/**
338			* Returns a plain validation errors array without their attribute names.
339			*
340			* @return array
341			*/
342			public function getErrorsList()
343			{
344			return $this->errors->flatten();
345			}
346
347			/**
348			* Determines whether validation should stop on the first failure.
349			*
350			* @param bool $stop
351			*
352			* @return $this
353			*/
354			public function shouldStopOnFirstFailure($stop = true)
355			{
356			$this->shouldStopOnFirstFailure = $stop;
357
358			return $this;
359			}
360			}
361

franzose / kontrolio

Push — master ( a97ce7...6f972b )

Validator::buildRule() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like