Items::validateArray() - Code Metrics - Inspection of "Merge pull request #4 from mcustiel/develop" - mcustiel/php-simple-request - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7e4b7e...89d185 )

by Mariano

created 2016-07-19 15:43 UTC

Items::validateArray() A

↳ Parent: Items

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.0416

Importance

Changes	3
Bugs	2	Features	2

Metric	Value
c	3
b	2
f	2
dl	0
loc	10
ccs	5
cts	6
cp	0.8333
rs	9.4285
cc	3
eloc	5
nc	3
nop	2
crap	3.0416

<?php
/**
 * This file is part of php-simple-request.
 *
 * php-simple-request is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * php-simple-request is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with php-simple-request.  If not, see <http://www.gnu.org/licenses/>.
 */
namespace Mcustiel\SimpleRequest\Validator;

use Mcustiel\SimpleRequest\Interfaces\ValidatorInterface;
use Mcustiel\SimpleRequest\Annotation\ValidatorAnnotation;
use Mcustiel\SimpleRequest\Exception\UnspecifiedValidatorException;

/**
 * Checks that each element of an array validates against its corresponding
 * validator in a collection.
 * <a href="http://spacetelescope.github.io/understanding-json-schema/UnderstandingJSONSchema.pdf">Here</a>
 * you can see examples of use for this validator.
 *
 * @author mcustiel
 */
class Items extends AbstractIterableValidator
{
    const ITEMS_INDEX = 'items';
    const ADDITIONAL_ITEMS_INDEX = 'additionalItems';

    /**
     * @var bool|\Mcustiel\SimpleRequest\Interfaces\ValidatorInterface
     */
    private $additionalItems = true;

    /**
     * {@inheritdoc}
     *
     * @see \Mcustiel\SimpleRequest\Validator\AbstractIterableValidator::setSpecification()
     */
    public function setSpecification($specification = null)
    {
        $this->checkSpecificationIsArray($specification);

        $this->initItems($specification);
        $this->initAdditionalItems($specification);
    }

    private function initAdditionalItems($specification)
    {
        if (isset($specification[self::ADDITIONAL_ITEMS_INDEX])) {
            $this->setAdditionalItems($specification[self::ADDITIONAL_ITEMS_INDEX]);
        }
    }

    private function initItems($specification)
    {
        if (isset($specification[self::ITEMS_INDEX])) {
            $this->setItems($specification[self::ITEMS_INDEX]);
        }
    }

    /**
     * {@inheritdoc}
     *
     * @see \Mcustiel\SimpleRequest\Validator\AbstractAnnotationSpecifiedValidator::validate()
     */
    public function validate($value)
    {
        if (!is_array($value)) {
            return false;
        }

        // From json-schema definition: if "items" is not present, or its value is an object,
        // validation of the instance always succeeds, regardless of the value of "additionalItems";
        if (empty($this->items)) {
            return true;
        }

        return $this->executeItemsValidation($value);
    }

    private function executeItemsValidation($value)
    {
        if ($this->items instanceof ValidatorInterface) {
            return $this->validateArray($value, $this->items);
        }
        $valid = $this->validateTuple($value);
        // From json-schema definition: if the value of "additionalItems" is boolean value false and
        // the value of "items" is an array, the instance is valid if its size is less than, or
        // equal to, the size of "items".
        if ($this->additionalItems === false) {
            return $valid && (count($value) <= count($this->items));
        }

        // From json-schema definition: if the value of "additionalItems" is
        // boolean value true or an object, validation of the instance always succeeds;
        return $this->validateRest($value);
    }

    /**
     * Validates each element against its corresponding validator. Then,
     * if additionalItems is a validator, checks the rest again those
     * validators.
     *
     * @param array $list
     *
     * @return bool
     */
    private function validateRest(array $list)
    {
        $count = count($this->items);
        return $this->additionalItems === true ||
            $this->validateArray(
                array_slice($list, $count, count($list) - $count),
                $this->additionalItems
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            );
    }

    /**
     * Validates each one of the elements of the array against
     * its corresponding specified validator.
     *
     * @param array $tuple
     *
     * @return bool
     */
    private function validateTuple(array $tuple)
    {
        $keys = array_keys($this->items);
        $count = count($this->items);
        for ($index = 0; $index < $count; $index++) {
            // In the specification is not clear what to do when instance size
            // is less than items size. I chose to pass null and if null passes
            // the validation, it returns true.
            if (isset($tuple[$keys[$index]]) &&
                !$this->items[$index]->validate($tuple[$keys[$index]])) {
                return false;
            }
        }

        return true;
    }

    /**
     * Checks and sets the specified items values.
     *
     * @param array|\Mcustiel\SimpleRequest\Interfaces\ValidatorInterface $specification
     */
    private function setItems($specification)
    {
        if ($specification instanceof ValidatorAnnotation) {
            $this->items = $this->createValidatorInstanceFromAnnotation(

                $specification
            );
        } else {
            $this->checkSpecificationIsArray($specification);
            $this->items = $this->convertAnnotationsToValidators($specification);

        }
    }

    private function convertAnnotationsToValidators(array $specification)
    {
        $items = [];
        foreach ($specification as $index => $validator) {
            $items[$index] = $this->checkIfAnnotationAndReturnObject($validator);
        }
        return $items;
    }

    /**
     * Checks and sets the specified additionalItems.
     *
     * @param bool|\Mcustiel\SimpleRequest\Interfaces\ValidatorInterface $specification
     */
    private function setAdditionalItems($specification)
    {
        if (is_bool($specification)) {
            $this->additionalItems = $specification;
        } elseif ($specification instanceof ValidatorAnnotation) {
            $this->additionalItems = $this->createValidatorInstanceFromAnnotation(
                $specification
            );
        } else {
            throw new UnspecifiedValidatorException(
                'The validator is being initialized without a valid validator Annotation'
            );
        }
    }

    /**
     * Validates an array against a specific validator.
     *
     * @param array                                                 $array
     * @param \Mcustiel\SimpleRequest\Interfaces\ValidatorInterface $validator
     */
    private function validateArray(array $array, ValidatorInterface $validator)
    {
        foreach ($array as $item) {
            if (!$validator->validate($item)) {
                return false;
            }
        }

        return true;
    }
}


1		<?php
2		/**
3		* This file is part of php-simple-request.
4		*
5		* php-simple-request is free software: you can redistribute it and/or modify
6		* it under the terms of the GNU Lesser General Public License as published by
7		* the Free Software Foundation, either version 3 of the License, or
8		* (at your option) any later version.
9		*
10		* php-simple-request is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License
16		* along with php-simple-request. If not, see <http://www.gnu.org/licenses/>.
17		*/
18		namespace Mcustiel\SimpleRequest\Validator;
19
20		use Mcustiel\SimpleRequest\Interfaces\ValidatorInterface;
21		use Mcustiel\SimpleRequest\Annotation\ValidatorAnnotation;
22		use Mcustiel\SimpleRequest\Exception\UnspecifiedValidatorException;
23
24		/**
25		* Checks that each element of an array validates against its corresponding
26		* validator in a collection.
27		* <a href="http://spacetelescope.github.io/understanding-json-schema/UnderstandingJSONSchema.pdf">Here</a>
28		* you can see examples of use for this validator.
29		*
30		* @author mcustiel
31		*/
32		class Items extends AbstractIterableValidator
33		{
34		const ITEMS_INDEX = 'items';
35		const ADDITIONAL_ITEMS_INDEX = 'additionalItems';
36
37		/**
38		* @var bool\|\Mcustiel\SimpleRequest\Interfaces\ValidatorInterface
39		*/
40		private $additionalItems = true;
41
42		/**
43		* {@inheritdoc}
44		*
45		* @see \Mcustiel\SimpleRequest\Validator\AbstractIterableValidator::setSpecification()
46		*/
47	87	public function setSpecification($specification = null)
48		{
49	87	$this->checkSpecificationIsArray($specification);
50
51	86	$this->initItems($specification);
52	84	$this->initAdditionalItems($specification);
53	83	}
54
55	84	private function initAdditionalItems($specification)
56		{
57	84	if (isset($specification[self::ADDITIONAL_ITEMS_INDEX])) {
58	83	$this->setAdditionalItems($specification[self::ADDITIONAL_ITEMS_INDEX]);
59	82	}
60	83	}
61
62	86	private function initItems($specification)
63		{
64	86	if (isset($specification[self::ITEMS_INDEX])) {
65	85	$this->setItems($specification[self::ITEMS_INDEX]);
66	83	}
67	84	}
68
69		/**
70		* {@inheritdoc}
71		*
72		* @see \Mcustiel\SimpleRequest\Validator\AbstractAnnotationSpecifiedValidator::validate()
73		*/
74	85	public function validate($value)
75		{
76	85	if (!is_array($value)) {
77	1	return false;
78		}
79
80		// From json-schema definition: if "items" is not present, or its value is an object,
81		// validation of the instance always succeeds, regardless of the value of "additionalItems";
82	84	if (empty($this->items)) {
83		return true;
84		}
85
86	84	return $this->executeItemsValidation($value);
87		}
88
89	84	private function executeItemsValidation($value)
90		{
91	84	if ($this->items instanceof ValidatorInterface) {
92	2	return $this->validateArray($value, $this->items);
93		}
94	82	$valid = $this->validateTuple($value);
95		// From json-schema definition: if the value of "additionalItems" is boolean value false and
96		// the value of "items" is an array, the instance is valid if its size is less than, or
97		// equal to, the size of "items".
98	82	if ($this->additionalItems === false) {
99	82	return $valid && (count($value) <= count($this->items));
100		}
101
102		// From json-schema definition: if the value of "additionalItems" is
103		// boolean value true or an object, validation of the instance always succeeds;
104		return $this->validateRest($value);
105		}
106
107		/**
108		* Validates each element against its corresponding validator. Then,
109		* if additionalItems is a validator, checks the rest again those
110		* validators.
111		*
112		* @param array $list
113		*
114		* @return bool
115		*/
116		private function validateRest(array $list)
117		{
118		$count = count($this->items);
119		return $this->additionalItems === true \|\|
120		$this->validateArray(
121		array_slice($list, $count, count($list) - $count),
122		$this->additionalItems
		0 ignored issues – show Bug introduced 2016-01-30 17:24 UTC by Report Bug Copy Issue Report It seems like `$this->additionalItems` can also be of type `boolean`; however, `Mcustiel\SimpleRequest\V...\Items::validateArray()` does only seem to accept `object<Mcustiel\SimpleRe...ces\ValidatorInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
123		);
124		}
125
126		/**
127		* Validates each one of the elements of the array against
128		* its corresponding specified validator.
129		*
130		* @param array $tuple
131		*
132		* @return bool
133		*/
134	82	private function validateTuple(array $tuple)
135		{
136	82	$keys = array_keys($this->items);
137	82	$count = count($this->items);
138	82	for ($index = 0; $index < $count; $index++) {
139		// In the specification is not clear what to do when instance size
140		// is less than items size. I chose to pass null and if null passes
141		// the validation, it returns true.
142	82	if (isset($tuple[$keys[$index]]) &&
143	82	!$this->items[$index]->validate($tuple[$keys[$index]])) {
144	2	return false;
145		}
146	82	}
147
148	80	return true;
149		}
150
151		/**
152		* Checks and sets the specified items values.
153		*
154		* @param array\|\Mcustiel\SimpleRequest\Interfaces\ValidatorInterface $specification
155		*/
156	85	private function setItems($specification)
157		{
158	85	if ($specification instanceof ValidatorAnnotation) {
159	2	$this->items = $this->createValidatorInstanceFromAnnotation(
		0 ignored issues – show Documentation Bug introduced 2016-07-15 12:42 UTC by Report Bug Copy Issue Report It seems like `$this->createValidatorIn...otation($specification)` of type `object<Mcustiel\SimpleRe...ces\ValidatorInterface>` is incompatible with the declared type `array<integer,object<Mcu...es\ValidatorInterface>>` of property `$items`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
160		$specification
161	2	);
162	2	} else {
163	83	$this->checkSpecificationIsArray($specification);
164	82	$this->items = $this->convertAnnotationsToValidators($specification);
		0 ignored issues – show Bug introduced 2016-07-19 15:46 UTC by Report Bug Copy Issue Report It seems like `$specification` defined by parameter `$specification` on line 156 can also be of type `object<Mcustiel\SimpleRe...ces\ValidatorInterface>`; however, `Mcustiel\SimpleRequest\V...notationsToValidators()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
165		}
166	83	}
167
168	82	private function convertAnnotationsToValidators(array $specification)
169		{
170	82	$items = [];
171	82	foreach ($specification as $index => $validator) {
172	82	$items[$index] = $this->checkIfAnnotationAndReturnObject($validator);
173	81	}
174	81	return $items;
175		}
176
177		/**
178		* Checks and sets the specified additionalItems.
179		*
180		* @param bool\|\Mcustiel\SimpleRequest\Interfaces\ValidatorInterface $specification
181		*/
182	83	private function setAdditionalItems($specification)
183		{
184	83	if (is_bool($specification)) {
185	82	$this->additionalItems = $specification;
186	83	} elseif ($specification instanceof ValidatorAnnotation) {
187		$this->additionalItems = $this->createValidatorInstanceFromAnnotation(
188		$specification
189		);
190		} else {
191	1	throw new UnspecifiedValidatorException(
192		'The validator is being initialized without a valid validator Annotation'
193	1	);
194		}
195	82	}
196
197		/**
198		* Validates an array against a specific validator.
199		*
200		* @param array $array
201		* @param \Mcustiel\SimpleRequest\Interfaces\ValidatorInterface $validator
202		*/
203	2	private function validateArray(array $array, ValidatorInterface $validator)
204		{
205	2	foreach ($array as $item) {
206	2	if (!$validator->validate($item)) {
207		return false;
208		}
209	2	}
210
211	2	return true;
212		}
213		}
214

mcustiel / php-simple-request

Push — master ( 7e4b7e...89d185 )

Items::validateArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like