Validator::getContainer() - Code Metrics - Inspection of "Add JSON API Validator wrapper. Add fix for JSON A..." - limoncello-php-dist/flute - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 29d040...599906 )

by Neomerx
created 2017-08-27 17:34 UTC
Validator::getContainer() A

↳ Parent: Validator
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1
<?php namespace Limoncello\Flute\Validation;

/**
 * Copyright 2015-2017 [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Container\Traits\HasContainerTrait;
use Limoncello\Contracts\L10n\FormatterFactoryInterface;
use Limoncello\Contracts\L10n\FormatterInterface;
use Limoncello\Flute\Contracts\Validation\ErrorCodes;
use Limoncello\Flute\Contracts\Validation\JsonApiValidatorInterface;
use Limoncello\Flute\Http\JsonApiResponse;
use Limoncello\Flute\Validation\Execution\ContextStorage;
use Limoncello\Flute\Validation\Execution\JsonApiErrorCollection;
use Limoncello\Flute\Validation\Execution\JsonApiRuleSerializer;
use Limoncello\Flute\Validation\Rules\RelationshipsTrait;
use Limoncello\Validation\Contracts\Errors\ErrorInterface;
use Limoncello\Validation\Contracts\Execution\ContextStorageInterface;
use Limoncello\Validation\Execution\BlockInterpreter;
use Limoncello\Validation\Validator\BaseValidator;
use Neomerx\JsonApi\Contracts\Document\DocumentInterface as DI;
use Neomerx\JsonApi\Exceptions\JsonApiException;
use Psr\Container\ContainerInterface;

/**
 * @package Limoncello\Flute
 *
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
 */
class Validator extends BaseValidator implements JsonApiValidatorInterface
{
    use RelationshipsTrait, HasContainerTrait;

    /**
     * Namespace for string resources.
     */
    const RESOURCES_NAMESPACE = 'Limoncello.Flute.Validation';

    /** Rule description index */
    const RULE_INDEX = 0;

    /** Rule description index */
    const RULE_ATTRIBUTES = self::RULE_INDEX + 1;

    /** Rule description index */
    const RULE_TO_ONE = self::RULE_ATTRIBUTES + 1;

    /** Rule description index */
    const RULE_TO_MANY = self::RULE_TO_ONE + 1;

    /** Rule description index */
    const RULE_UNLISTED_ATTRIBUTE = self::RULE_TO_MANY + 1;

    /** Rule description index */
    const RULE_UNLISTED_RELATIONSHIP = self::RULE_UNLISTED_ATTRIBUTE + 1;

    /**
     * @var int
     */
    private $errorStatus;

    /**
     * @var ContextStorageInterface
     */
    private $contextStorage;

    /**
     * @var JsonApiErrorCollection
     */
    private $jsonApiErrors;

    /**
     * @var array
     */
    private $blocks;

    /**
     * @var array
     */
    private $idRule;

    /**
     * @var array
     */
    private $typeRule;

    /**
     * @var int[]
     */
    private $attributeRules;

    /**
     * @var int[]
     */
    private $toOneRules;

    /**
     * @var int[]
     */
    private $toManyRules;

    /**
     * @var bool
     */
    private $isIgnoreUnknowns;

    /**
     * @var FormatterInterface|null
     */
    private $messageFormatter;

    /**
     * @param string             $name
     * @param array              $data
     * @param ContainerInterface $container
     * @param int                $errorStatus
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    public function __construct(
        string $name,
        array $data,
        ContainerInterface $container,
        int $errorStatus = JsonApiResponse::HTTP_UNPROCESSABLE_ENTITY
    ) {
        $this->setContainer($container);

        $ruleSet           = JsonApiRuleSerializer::extractRuleSet($name, $data);
        $this->blocks      = JsonApiRuleSerializer::extractBlocks($data);
        $this->idRule      = JsonApiRuleSerializer::getIdRule($ruleSet);
        $this->typeRule    = JsonApiRuleSerializer::getTypeRule($ruleSet);
        $this->errorStatus = $errorStatus;

        $this
            ->setAttributeRules(JsonApiRuleSerializer::getAttributeRules($ruleSet))
            ->setToOneIndexes(JsonApiRuleSerializer::getToOneRules($ruleSet))
            ->setToManyIndexes(JsonApiRuleSerializer::getToManyRules($ruleSet))
            ->disableIgnoreUnknowns();

        parent::__construct();
    }

    /**
     * @inheritdoc
     */
    public function assert($jsonData): JsonApiValidatorInterface
    {
        if ($this->validate($jsonData) === false) {
            throw new JsonApiException($this->getJsonApiErrorCollection(), $this->getErrorStatus());
        }

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function validate($input): bool
    {
        $this->reInitAggregatorsIfNeeded();

        if (is_array($input) === true) {
            $this
                ->validateType($input)
                ->validateId($input)
                ->validateAttributes($input)
                ->validateRelationships($input);
        } else {
            $title   = $this->formatMessage(ErrorCodes::INVALID_VALUE);
            $details = $this->formatMessage(ErrorCodes::INVALID_VALUE);
            $this->getJsonApiErrorCollection()->addDataError($title, $details, $this->getErrorStatus());
        }

        $hasNoErrors = $this->getJsonApiErrorCollection()->count() <= 0;

        return $hasNoErrors;
    }

    /**
     * @inheritdoc
     */
    public function getJsonApiErrors(): array
    {
        return $this->getJsonApiErrorCollection()->getArrayCopy();
    }

    /**
     * @inheritdoc
     */
    public function getJsonApiCaptures(): array
    {
        return $this->getCaptures()->get();
    }

    /**
     * @return BaseValidator

     */
    protected function resetAggregators(): BaseValidator
    {
        $self = parent::resetAggregators();

        $this->jsonApiErrors  = $this->createJsonApiErrors();
        $this->contextStorage = $this->createContextStorage();

        return $self;
    }

    /**
     * @param array $jsonData
     *
     * @return self
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    private function validateType(array $jsonData): self
    {
        // execute start(s)
        $starts = JsonApiRuleSerializer::getRuleStartIndexes($this->getTypeRule());
        $this->executeStarts($starts);

        if (array_key_exists(DI::KEYWORD_DATA, $jsonData) === true &&
            array_key_exists(DI::KEYWORD_TYPE, $data = $jsonData[DI::KEYWORD_DATA]) === true
        ) {
            // execute main validation block(s)
            $index = JsonApiRuleSerializer::getRuleIndex($this->getTypeRule());
            $this->executeBlock($data[DI::KEYWORD_TYPE], $index);
        } else {
            $title   = $this->formatMessage(ErrorCodes::INVALID_VALUE);
            $details = $this->formatMessage(ErrorCodes::TYPE_MISSING);
            $this->getJsonApiErrorCollection()->addDataTypeError($title, $details, $this->getErrorStatus());
        }

        // execute end(s)
        $ends = JsonApiRuleSerializer::getRuleEndIndexes($this->getTypeRule());
        $this->executeEnds($ends);

        if (count($this->getErrors()) > 0) {

            $title = $this->formatMessage(ErrorCodes::INVALID_VALUE);
            foreach ($this->getErrors()->get() as $error) {
                $this->getJsonApiErrorCollection()
                    ->addDataTypeError($title, $this->getMessage($error), $this->getErrorStatus());
            }
            $this->getErrors()->clear();
        }

        return $this;
    }

    /**
     * @param array $jsonData
     *
     * @return self
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function validateId(array $jsonData): self
    {
        // execute start(s)
        $starts = JsonApiRuleSerializer::getRuleStartIndexes($this->getIdRule());
        $this->executeStarts($starts);

        // execute main validation block(s)
        if (array_key_exists(DI::KEYWORD_DATA, $jsonData) === true &&
            array_key_exists(DI::KEYWORD_ID, $data = $jsonData[DI::KEYWORD_DATA]) === true
        ) {
            $index = JsonApiRuleSerializer::getRuleIndex($this->getIdRule());
            $this->executeBlock($data[DI::KEYWORD_ID], $index);
        }

        // execute end(s)
        $ends = JsonApiRuleSerializer::getRuleEndIndexes($this->getIdRule());
        $this->executeEnds($ends);

        if (count($this->getErrors()) > 0) {

            $title = $this->formatMessage(ErrorCodes::INVALID_VALUE);
            foreach ($this->getErrors()->get() as $error) {
                $this->getJsonApiErrorCollection()
                    ->addDataIdError($title, $this->getMessage($error), $this->getErrorStatus());
            }
            $this->getErrors()->clear();
        }

        return $this;
    }

    /**
     * @param array $jsonData
     *
     * @return self
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    private function validateAttributes(array $jsonData): self
    {
        // execute start(s)
        $starts = JsonApiRuleSerializer::getRulesStartIndexes($this->getAttributeRules());
        $this->executeStarts($starts);

        if (array_key_exists(DI::KEYWORD_DATA, $jsonData) === true &&
            array_key_exists(DI::KEYWORD_ATTRIBUTES, $data = $jsonData[DI::KEYWORD_DATA]) === true
        ) {
            if (is_array($attributes = $data[DI::KEYWORD_ATTRIBUTES]) === false) {
                $title   = $this->formatMessage(ErrorCodes::INVALID_VALUE);
                $details = $this->formatMessage(ErrorCodes::INVALID_ATTRIBUTES);
                $this->getJsonApiErrorCollection()->addAttributesError($title, $details, $this->getErrorStatus());
            } else {
                // execute main validation block(s)
                foreach ($attributes as $name => $value) {
                    if ($this->hasAttributeIndex($name) === true) {
                        $this->executeBlock($value, $this->getAttributeIndex($name));
                    } elseif ($this->isIgnoreUnknowns() === false) {

                        $title   = $this->formatMessage(ErrorCodes::INVALID_VALUE);
                        $details = $this->formatMessage(ErrorCodes::UNKNOWN_ATTRIBUTE);
                        $status  = $this->getErrorStatus();
                        $this->getJsonApiErrorCollection()->addDataAttributeError($name, $title, $details, $status);
                    }
                }
            }
        }

        // execute end(s)
        $ends = JsonApiRuleSerializer::getRulesEndIndexes($this->getAttributeRules());
        $this->executeEnds($ends);

        if (count($this->getErrors()) > 0) {
            foreach ($this->getErrors()->get() as $error) {
                $this->getJsonApiErrorCollection()->addValidationAttributeError($error);
            }
            $this->getErrors()->clear();
        }

        return $this;
    }

    /**
     * @param array $jsonData
     *
     * @return self
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    private function validateRelationships(array $jsonData): self
    {
        // execute start(s)
        $starts = array_merge(
            JsonApiRuleSerializer::getRulesStartIndexes($this->getToOneRules()),
            JsonApiRuleSerializer::getRulesStartIndexes($this->getToManyRules())
        );
        $this->executeStarts($starts);

        if (array_key_exists(DI::KEYWORD_DATA, $jsonData) === true &&
            array_key_exists(DI::KEYWORD_RELATIONSHIPS, $data = $jsonData[DI::KEYWORD_DATA]) === true
        ) {
            if (is_array($relationships = $data[DI::KEYWORD_RELATIONSHIPS]) === false) {
                $title   = $this->formatMessage(ErrorCodes::INVALID_VALUE);
                $details = $this->formatMessage(ErrorCodes::INVALID_RELATIONSHIP_TYPE);
                $this->getJsonApiErrorCollection()->addRelationshipsError($title, $details, $this->getErrorStatus());
            } else {
                // ok we got to something that could be null or a valid relationship
                $toOneIndexes  = JsonApiRuleSerializer::getRulesIndexes($this->getToOneRules());
                $toManyIndexes = JsonApiRuleSerializer::getRulesIndexes($this->getToManyRules());

                foreach ($relationships as $name => $relationship) {
                    if (array_key_exists($name, $toOneIndexes) === true) {
                        // it might be to1 relationship
                        $this->validateAsToOneRelationship($toOneIndexes[$name], $name, $relationship);
                    } elseif (array_key_exists($name, $toManyIndexes) === true) {
                        // it might be toMany relationship
                        $this->validateAsToManyRelationship($toManyIndexes[$name], $name, $relationship);
                    } else {

                        // unknown relationship
                        $title   = $this->formatMessage(ErrorCodes::INVALID_VALUE);
                        $details = $this->formatMessage(ErrorCodes::UNKNOWN_RELATIONSHIP);
                        $status  = $this->getErrorStatus();
                        $this->getJsonApiErrorCollection()->addRelationshipError($name, $title, $details, $status);
                    }
                }
            }
        }

        // execute end(s)
        $ends = array_merge(
            JsonApiRuleSerializer::getRulesEndIndexes($this->getToOneRules()),
            JsonApiRuleSerializer::getRulesEndIndexes($this->getToManyRules())
        );
        $this->executeEnds($ends);

        if (count($this->getErrors()) > 0) {
            foreach ($this->getErrors()->get() as $error) {
                $this->getJsonApiErrorCollection()->addValidationRelationshipError($error);
            }
            $this->getErrors()->clear();
        }

        return $this;
    }

    /**
     * @param int    $index
     * @param string $name
     * @param mixed  $mightBeRelationship
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    private function validateAsToOneRelationship(int $index, string $name, $mightBeRelationship): void
    {
        if (is_array($mightBeRelationship) === true &&
            array_key_exists(DI::KEYWORD_DATA, $mightBeRelationship) === true &&
            ($parsed = $this->parseSingleRelationship($mightBeRelationship[DI::KEYWORD_DATA])) !== false
        ) {
            // All right we got something. Now pass it to a validation rule.
            $this->executeBlock($parsed, $index);
        } else {
            $title   = $this->formatMessage(ErrorCodes::INVALID_VALUE);
            $details = $this->formatMessage(ErrorCodes::INVALID_RELATIONSHIP);
            $this->getJsonApiErrorCollection()->addRelationshipError($name, $title, $details, $this->getErrorStatus());
        }
    }

    /**
     * @param int    $index
     * @param string $name
     * @param mixed  $mightBeRelationship
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    private function validateAsToManyRelationship(int $index, string $name, $mightBeRelationship): void
    {
        $isParsed       = true;
        $collectedPairs = [];
        if (is_array($mightBeRelationship) === true &&
            array_key_exists(DI::KEYWORD_DATA, $mightBeRelationship) === true &&
            is_array($data = $mightBeRelationship[DI::KEYWORD_DATA]) === true
        ) {
            foreach ($data as $mightTypeAndId) {
                // we accept only pairs of type and id (no `null`s are accepted).
                if (is_array($parsed = $this->parseSingleRelationship($mightTypeAndId)) === true) {
                    $collectedPairs[] = $parsed;
                } else {
                    $isParsed = false;
                    break;
                }
            }
        } else {
            $isParsed = false;
        }

        if ($isParsed === true) {

            // All right we got something. Now pass it to a validation rule.
            $this->executeBlock($collectedPairs, $index);
        } else {
            $title   = $this->formatMessage(ErrorCodes::INVALID_VALUE);
            $details = $this->formatMessage(ErrorCodes::INVALID_RELATIONSHIP);
            $this->getJsonApiErrorCollection()->addRelationshipError($name, $title, $details, $this->getErrorStatus());
        }
    }

    /**
     * @param mixed $data
     *
     * @return array|null|false Either `array` ($type => $id), or `null`, or `false` on error.

     *
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    private function parseSingleRelationship($data)
    {
        if ($data === null) {
            $result = null;
        } elseif (is_array($data) === true &&
            array_key_exists(DI::KEYWORD_TYPE, $data) === true &&
            array_key_exists(DI::KEYWORD_ID, $data) === true &&
            is_scalar($type = $data[DI::KEYWORD_TYPE]) === true &&
            is_scalar($index = $data[DI::KEYWORD_ID]) === true
        ) {
            $result = [$type => $index];
        } else {
            $result = false;
        }

        return $result;
    }

    /**
     * Re-initializes internal aggregators for captures, errors, etc.
     */
    private function reInitAggregatorsIfNeeded(): void
    {
        $this->areAggregatorsDirty() === false ?: $this->resetAggregators();
    }

    /**
     * @param mixed $input
     * @param int   $index
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function executeBlock($input, int $index): void
    {
        BlockInterpreter::executeBlock(
            $input,
            $index,
            $this->getBlocks(),
            $this->getContextStorage(),
            $this->getCaptures(),
            $this->getErrors()
        );
    }

    /**
     * @param array $indexes
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function executeStarts(array $indexes): void
    {
        BlockInterpreter::executeStarts($indexes, $this->getBlocks(), $this->getContextStorage(), $this->getErrors());
    }

    /**
     * @param array $indexes
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function executeEnds(array $indexes): void
    {
        BlockInterpreter::executeEnds($indexes, $this->getBlocks(), $this->getContextStorage(), $this->getErrors());
    }

    /**
     * @param ErrorInterface $error
     *
     * @return string
     */
    private function getMessage(ErrorInterface $error): string

    {
        $context = $error->getMessageContext();
        $args    = $context === null ? [] : $context;
        $message = $this->formatMessage($error->getMessageCode(), $args);

        return $message;
    }

    /**
     * @return array
     */
    protected function getIdRule(): array
    {
        return $this->idRule;
    }

    /**
     * @return array
     */
    protected function getTypeRule(): array
    {
        return $this->typeRule;
    }

    /**
     * @return ContextStorageInterface
     */
    protected function getContextStorage(): ContextStorageInterface
    {
        return $this->contextStorage;
    }

    /**
     * @return ContextStorageInterface
     */
    protected function createContextStorage(): ContextStorageInterface
    {
        return new ContextStorage($this->getContainer(), $this->getBlocks());
    }

    /**
     * @return JsonApiErrorCollection
     */
    protected function getJsonApiErrorCollection(): JsonApiErrorCollection
    {
        return $this->jsonApiErrors;
    }

    /**
     * @return JsonApiErrorCollection
     */
    protected function createJsonApiErrors(): JsonApiErrorCollection
    {
        return new JsonApiErrorCollection($this->getContainer(), $this->getErrorStatus());
    }

    /**
     * @return int
     */
    protected function getErrorStatus(): int
    {
        return $this->errorStatus;
    }

    /**
     * @return bool
     */
    protected function isIgnoreUnknowns(): bool
    {
        return $this->isIgnoreUnknowns;
    }

    /**
     * @return self
     */
    protected function enableIgnoreUnknowns(): self
    {
        $this->isIgnoreUnknowns = true;

        return $this;
    }

    /**
     * @return self
     */
    protected function disableIgnoreUnknowns(): self
    {
        $this->isIgnoreUnknowns = false;

        return $this;
    }

    /**
     * @param array $rules
     *
     * @return self
     */
    private function setAttributeRules(array $rules): self
    {
        assert($this->debugCheckIndexesExist($rules));

        $this->attributeRules = $rules;

        return $this;
    }

    /**
     * @param array $rules
     *
     * @return self
     */
    private function setToOneIndexes(array $rules): self
    {
        assert($this->debugCheckIndexesExist($rules));

        $this->toOneRules = $rules;

        return $this;
    }

    /**
     * @param array $rules
     *
     * @return self
     */
    private function setToManyIndexes(array $rules): self
    {
        assert($this->debugCheckIndexesExist($rules));

        $this->toManyRules = $rules;

        return $this;
    }

    /**
     * @return int[]
     */
    protected function getAttributeRules(): array
    {
        return $this->attributeRules;
    }

    /**
     * @return int[]
     */
    protected function getToOneRules(): array
    {
        return $this->toOneRules;
    }

    /**
     * @return int[]
     */
    protected function getToManyRules(): array
    {
        return $this->toManyRules;
    }

    /**
     * @return array
     */
    private function getBlocks(): array
    {
        return $this->blocks;
    }

    /**
     * @return FormatterInterface
     */
    protected function getMessageFormatter(): FormatterInterface
    {
        if ($this->messageFormatter === null) {
            /** @var FormatterFactoryInterface $factory */
            $factory                = $this->getContainer()->get(FormatterFactoryInterface::class);
            $this->messageFormatter = $factory->createFormatter(static::RESOURCES_NAMESPACE);
        }

        return $this->messageFormatter;
    }

    /**
     * @param string $name
     *
     * @return int
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function getAttributeIndex(string $name): int
    {
        $indexes = JsonApiRuleSerializer::getRulesIndexes($this->getAttributeRules());
        $index   = $indexes[$name];

        return $index;
    }

    /**
     * @param string $name
     *
     * @return bool
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function hasAttributeIndex(string $name): bool
    {
        $indexes      = JsonApiRuleSerializer::getRulesIndexes($this->getAttributeRules());
        $hasAttribute = array_key_exists($name, $indexes);

        return $hasAttribute;
    }

    /**
     * @param int   $messageId
     * @param array $args
     *
     * @return string
     */
    private function formatMessage(int $messageId, array $args = []): string
    {
        $message = $this->getMessageFormatter()->formatMessage($messageId, $args);

        return $message;
    }

    /**
     * @param array $rules
     *
     * @return bool
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function debugCheckIndexesExist(array $rules): bool
    {
        $allOk = true;

        $indexes = array_merge(
            JsonApiRuleSerializer::getRulesIndexes($rules),
            JsonApiRuleSerializer::getRulesStartIndexes($rules),
            JsonApiRuleSerializer::getRulesEndIndexes($rules)
        );

        foreach ($indexes as $index) {
            $allOk = $allOk && is_int($index) && JsonApiRuleSerializer::isRuleExist($index, $this->getBlocks());
        }

        return $allOk;
    }
}

limoncello-php-dist / flute

Push — master ( 29d040...599906 )

Validator::getContainer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
