Mcustiel\SimpleRequest\Validator\Properties

Complexity

Total Complexity

33

Size/Duplication

Total Lines	175
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

57.14%

Importance

Changes	5
Bugs	2	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	setSpecification()	0	11	3
A	validate()	0	14	4
A	executePropertiesValidation()	0	18	4
A	validateWithoutAdditionalItemsConcern()	0	10	3
A	validateList()	0	13	3
A	validateListItems()	0	9	3
A	validateTuple()	0	10	4
A	setItems()	0	12	4
A	setAdditionalItems()	0	10	3
A	convertToArray()	0	7	2

<?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;

/**
 * Checks that each element of an object or array validates against its corresponding
 * validator in a collection, using the name of the property or key.
 * <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 Properties extends AbstractIterableValidator
{
    const ITEMS_INDEX = 'properties';
    const ADDITIONAL_ITEMS_INDEX = 'additionalProperties';

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

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

        if (isset($specification[self::ITEMS_INDEX])) {
            $this->setItems($specification[self::ITEMS_INDEX]);
        }
        if (isset($specification[self::ADDITIONAL_ITEMS_INDEX])) {
            $this->setAdditionalItems($specification[self::ADDITIONAL_ITEMS_INDEX]);
        }
    }

    /**
     * (non-PHPdoc)
     * @see \Mcustiel\SimpleRequest\Validator\AbstractAnnotationSpecifiedValidator::validate()
     */
    public function validate($value)
    {
        if (!(is_array($value) || $value instanceof \stdClass)) {
            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->executePropertiesValidation($this->convertToArray($value));
    }

    private function executePropertiesValidation($value)
    {
        if ($this->items instanceof ValidatorInterface) {
            return $this->validateWithoutAdditionalItemsConcern($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 (count($value) <= count($this->items))
            && $this->validateTuple($value);
        }

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

    private function convertToArray($value)
    {
        if (!is_array($value)) {
            return json_decode(json_encode($value), true);
        }
        return $value;
    }


    /**
     * Checks all properties against a validator.
     *
     * @param array $array
     *
     * @return bool
     */
    private function validateWithoutAdditionalItemsConcern(array $array)
    {
        foreach ($array as $value) {
            if (!$this->items->validate($value)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Validates each element against its validator and if additionalItems is a
     * validator, validates the rest of the elements against it.
     *
     * @param array $list
     *
     * @return bool
     */
    private function validateList(array $list)
    {
        if (!$this->validateTuple($list)) {
            return false;
        }
        if ($this->additionalItems === true) {
            return true;
        }

        $keys = array_keys($this->items);
        $count = count($this->items);
        return $this->validateListItems(array_slice($keys, $count, count($list) - $count));
    }

    private function validateListItems($array)
    {
        foreach ($array as $item) {
            if (!$this->additionalItems->validate($item)) {
                return false;
            }
        }
        return true;
    }

    /**
     * Validate each element of the array against its corresponding validator.
     *
     * @param array $tuple
     *
     * @return bool
     */
    private function validateTuple(array $tuple)
    {
        foreach ($this->items as $property => $validator) {

The expression $this->items of type object<Mcustiel\SimpleRequest\Interfaces\ValidatorInterface>|array<integer,object<Mcustiel\SimpleRequest\Interfaces\ValidatorInterface>> is not guaranteed to be traversable. How about adding an additional type check?

            if (!$validator->validate(isset($tuple[$property]) ? $tuple[$property] : null)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Checks and sets items specification.
     *
     * @param array|\Mcustiel\SimpleRequest\Interfaces\ValidatorInterface $specification
     */
    private function setItems($specification)
    {
        if ($specification instanceof ValidatorAnnotation) {
            $this->items = $this->createValidatorInstanceFromAnnotation(
                $specification
            );
        } elseif (is_array($specification)) {
            foreach ($specification as $key => $item) {
                $this->items[$key] = $this->checkIfAnnotationAndReturnObject($item);
            }
        }
    }

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