Validator::validate() - Code Metrics - Inspection of "Merge pull request #401 from bytestream/fix-tests" - proengsoft/laravel-jsvalidation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 328c23...368b19 )

unknown

created 2020-03-13 14:08 UTC

Validator::validate() A

↳ Parent: Validator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1.0046

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	5
cts	6
cp	0.8333
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	1.0046

<?php

namespace Proengsoft\JsValidation\Remote;

use Illuminate\Support\Arr;
use Illuminate\Http\JsonResponse;
use Illuminate\Validation\ValidationException;
use Illuminate\Validation\ValidationRuleParser;
use Proengsoft\JsValidation\Support\RuleListTrait;
use Illuminate\Http\Exceptions\HttpResponseException;
use Illuminate\Validation\Validator as BaseValidator;
use Proengsoft\JsValidation\Support\AccessProtectedTrait;

class Validator
{
    use AccessProtectedTrait;
    use RuleListTrait;

    /**
     * Validator extension name.
     */
    const EXTENSION_NAME = 'jsvalidation';

    /**
     * @var \Illuminate\Validation\Validator
     */
    protected $validator;

    /**
     * RemoteValidator constructor.
     *
     * @param \Illuminate\Validation\Validator $validator
     */
    public function __construct(BaseValidator $validator)
    {
        $this->validator = $validator;
    }

    /**
     * Validate request.
     *
     * @param $field
     * @param $parameters
     * @return void
     *
     * @throws \Illuminate\Validation\ValidationException
     */
    public function validate($field, $parameters = [])
    {
        $attribute = $this->parseAttributeName($field);
        $validationParams = $this->parseParameters($parameters);
        $validationResult = $this->validateJsRemoteRequest($attribute, $validationParams);

        $this->throwValidationException($validationResult, $this->validator);
    }

    /**
     * Throw the failed validation exception.
     *
     * @param mixed $result
     * @param \Illuminate\Validation\Validator  $validator
     * @return void
     *
     * @throws \Illuminate\Validation\ValidationException|\Illuminate\Http\Exceptions\HttpResponseException
     */
    protected function throwValidationException($result, $validator)
    {
        $response = new JsonResponse($result, 200);

        if ($result !== true && class_exists(ValidationException::class)) {
            throw new ValidationException($validator, $response);
        }

        throw new HttpResponseException($response);
    }

    /**
     *  Parse Validation input request data.
     *
     * @param $data
     * @return array
     */
    protected function parseAttributeName($data)
    {
        parse_str($data, $attrParts);
        $attrParts = is_null($attrParts) ? [] : $attrParts;
        $newAttr = array_keys(Arr::dot($attrParts));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return array_pop($newAttr);
    }

    /**
     *  Parse Validation parameters.
     *
     * @param $parameters
     * @return array
     */
    protected function parseParameters($parameters)
    {
        $newParams = ['validate_all' => false];
        if (isset($parameters[0])) {
            $newParams['validate_all'] = ($parameters[0] === 'true') ? true : false;
        }

        return $newParams;
    }

    /**
     * Validate remote Javascript Validations.
     *
     * @param $attribute
     * @param array $parameters
     * @return array|bool
     */
    protected function validateJsRemoteRequest($attribute, $parameters)
    {
        $this->setRemoteValidation($attribute, $parameters['validate_all']);

        $validator = $this->validator;
        if ($validator->passes()) {
            return true;
        }

        return $validator->messages()->get($attribute);
    }

    /**
     * Sets data for validate remote rules.
     *
     * @param $attribute
     * @param bool $validateAll
     * @return void
     */
    protected function setRemoteValidation($attribute, $validateAll = false)
    {
        $validator = $this->validator;
        $rules = $validator->getRules();
        $rules = isset($rules[$attribute]) ? $rules[$attribute] : [];
        if (in_array('no_js_validation', $rules)) {
            $validator->setRules([$attribute => []]);

            return;
        }
        if (! $validateAll) {
            $rules = $this->purgeNonRemoteRules($rules, $validator);
        }
        $validator->setRules([$attribute => $rules]);
    }

    /**
     * Remove rules that should not be validated remotely.
     *
     * @param $rules
     * @param BaseValidator $validator
     * @return mixed
     */
    protected function purgeNonRemoteRules($rules, $validator)
    {
        $protectedValidator = $this->createProtectedCaller($validator);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        foreach ($rules as $i => $rule) {
            $parsedRule = ValidationRuleParser::parse([$rule]);
            if (! $this->isRemoteRule($parsedRule[0])) {
                unset($rules[$i]);
            }
        }

        return $rules;
    }
}


1		<?php
2
3		namespace Proengsoft\JsValidation\Remote;
4
5		use Illuminate\Support\Arr;
6		use Illuminate\Http\JsonResponse;
7		use Illuminate\Validation\ValidationException;
8		use Illuminate\Validation\ValidationRuleParser;
9		use Proengsoft\JsValidation\Support\RuleListTrait;
10		use Illuminate\Http\Exceptions\HttpResponseException;
11		use Illuminate\Validation\Validator as BaseValidator;
12		use Proengsoft\JsValidation\Support\AccessProtectedTrait;
13
14		class Validator
15		{
16		use AccessProtectedTrait;
17		use RuleListTrait;
18
19		/**
20		* Validator extension name.
21		*/
22		const EXTENSION_NAME = 'jsvalidation';
23
24		/**
25		* @var \Illuminate\Validation\Validator
26		*/
27		protected $validator;
28
29		/**
30		* RemoteValidator constructor.
31		*
32		* @param \Illuminate\Validation\Validator $validator
33		*/
34	60	public function __construct(BaseValidator $validator)
35		{
36	60	$this->validator = $validator;
37	60	}
38
39		/**
40		* Validate request.
41		*
42		* @param $field
43		* @param $parameters
44		* @return void
45		*
46		* @throws \Illuminate\Validation\ValidationException
47		*/
48	60	public function validate($field, $parameters = [])
49		{
50	60	$attribute = $this->parseAttributeName($field);
51	60	$validationParams = $this->parseParameters($parameters);
52	60	$validationResult = $this->validateJsRemoteRequest($attribute, $validationParams);
53
54	60	$this->throwValidationException($validationResult, $this->validator);
55		}
56
57		/**
58		* Throw the failed validation exception.
59		*
60		* @param mixed $result
61		* @param \Illuminate\Validation\Validator $validator
62		* @return void
63		*
64		* @throws \Illuminate\Validation\ValidationException\|\Illuminate\Http\Exceptions\HttpResponseException
65		*/
66	60	protected function throwValidationException($result, $validator)
67		{
68	60	$response = new JsonResponse($result, 200);
69
70	60	if ($result !== true && class_exists(ValidationException::class)) {
71	24	throw new ValidationException($validator, $response);
72		}
73
74	36	throw new HttpResponseException($response);
75		}
76
77		/**
78		* Parse Validation input request data.
79		*
80		* @param $data
81		* @return array
82		*/
83	60	protected function parseAttributeName($data)
84		{
85	60	parse_str($data, $attrParts);
86	60	$attrParts = is_null($attrParts) ? [] : $attrParts;
87	60	$newAttr = array_keys(Arr::dot($attrParts));
		0 ignored issues – show Documentation introduced 2020-03-04 01:10 UTC by Report Bug Copy Issue Report `$attrParts` is of type `array`, but the function expects a `object<Illuminate\Support\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
88
89	60	return array_pop($newAttr);
90		}
91
92		/**
93		* Parse Validation parameters.
94		*
95		* @param $parameters
96		* @return array
97		*/
98	60	protected function parseParameters($parameters)
99		{
100	60	$newParams = ['validate_all' => false];
101	60	if (isset($parameters[0])) {
102	48	$newParams['validate_all'] = ($parameters[0] === 'true') ? true : false;
103	4	}
104
105	60	return $newParams;
106		}
107
108		/**
109		* Validate remote Javascript Validations.
110		*
111		* @param $attribute
112		* @param array $parameters
113		* @return array\|bool
114		*/
115	60	protected function validateJsRemoteRequest($attribute, $parameters)
116		{
117	60	$this->setRemoteValidation($attribute, $parameters['validate_all']);
118
119	60	$validator = $this->validator;
120	60	if ($validator->passes()) {
121	36	return true;
122		}
123
124	24	return $validator->messages()->get($attribute);
125		}
126
127		/**
128		* Sets data for validate remote rules.
129		*
130		* @param $attribute
131		* @param bool $validateAll
132		* @return void
133		*/
134	60	protected function setRemoteValidation($attribute, $validateAll = false)
135		{
136	60	$validator = $this->validator;
137	60	$rules = $validator->getRules();
138	60	$rules = isset($rules[$attribute]) ? $rules[$attribute] : [];
139	60	if (in_array('no_js_validation', $rules)) {
140	12	$validator->setRules([$attribute => []]);
141
142	12	return;
143		}
144	48	if (! $validateAll) {
145	36	$rules = $this->purgeNonRemoteRules($rules, $validator);
146	3	}
147	48	$validator->setRules([$attribute => $rules]);
148	48	}
149
150		/**
151		* Remove rules that should not be validated remotely.
152		*
153		* @param $rules
154		* @param BaseValidator $validator
155		* @return mixed
156		*/
157	36	protected function purgeNonRemoteRules($rules, $validator)
158		{
159	36	$protectedValidator = $this->createProtectedCaller($validator);
		0 ignored issues – show Unused Code introduced 2017-01-30 21:56 UTC by Report Bug Copy Issue Report `$protectedValidator` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
160
161	36	foreach ($rules as $i => $rule) {
162	36	$parsedRule = ValidationRuleParser::parse([$rule]);
163	36	if (! $this->isRemoteRule($parsedRule[0])) {
164	36	unset($rules[$i]);
165	3	}
166	3	}
167
168	36	return $rules;
169		}
170		}
171

proengsoft / laravel-jsvalidation

Push — master ( 328c23...368b19 )

Validator::validate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like