Processor - Code Metrics - Inspection of "Add a Gitter chat badge to README.md" - Youshido/GraphQL - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

unknown

created 2016-05-18 02:10 UTC

Processor F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	468
Duplicated Lines	2.14 %

Coupling/Cohesion

Components	1
Dependencies	25

Test Coverage

Coverage

73.39%

Importance

Changes	59
Bugs	19	Features	10

Metric	Value
wmc	86
c	59
b	19
f	10
lcom	1
cbo	25
dl	10
loc	468
ccs	171
cts	233
cp	0.7339
rs	1.3043

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setSchema()	0	18	2
A	parseAndCreateRequest()	0	9	1
A	processFieldTypeQuery()	5	14	3
B	getPropertyValue()	0	12	5
A	getSchema()	0	4	1
D	processRequest()	0	32	9
B	executeQuery()	0	23	5
C	executeMutation()	5	38	8
C	processAstFieldQuery()	0	59	11
B	collectListOrSingleValue()	0	25	5
D	getPreResolvedValue()	0	28	9
A	classify()	0	11	2
A	resolveValue()	0	11	2
A	parseArgumentsValues()	0	15	4
C	processQueryFields()	0	32	11
A	collectValue()	0	10	4
A	getResponseData()	0	18	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Processor often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Processor, and based on these observations, apply Extract Interface, too.

<?php
/*
* This file is a part of graphql-youshido project.
*
* @author Portey Vasil <[email protected]>
* @author Alexandr Viniychuk <[email protected]>
* created: 11/28/15 1:05 AM
*/

namespace Youshido\GraphQL;

use Youshido\GraphQL\Introspection\QueryType;
use Youshido\GraphQL\Introspection\SchemaType;
use Youshido\GraphQL\Introspection\TypeDefinitionType;
use Youshido\GraphQL\Parser\Ast\FragmentReference;
use Youshido\GraphQL\Parser\Ast\Mutation;
use Youshido\GraphQL\Parser\Ast\Query;
use Youshido\GraphQL\Parser\Ast\TypedFragmentReference;
use Youshido\GraphQL\Parser\Parser;
use Youshido\GraphQL\Type\AbstractType;
use Youshido\GraphQL\Type\Field\Field;
use Youshido\GraphQL\Type\Object\AbstractEnumType;
use Youshido\GraphQL\Type\Object\AbstractInterfaceType;
use Youshido\GraphQL\Type\Object\ObjectType;
use Youshido\GraphQL\Type\Scalar\AbstractScalarType;
use Youshido\GraphQL\Type\TypeInterface;
use Youshido\GraphQL\Type\TypeMap;
use Youshido\GraphQL\Parser\Ast\Field as AstField;
use Youshido\GraphQL\Validator\ErrorContainer\ErrorContainerTrait;
use Youshido\GraphQL\Validator\Exception\ConfigurationException;
use Youshido\GraphQL\Validator\Exception\ResolveException;
use Youshido\GraphQL\Validator\ResolveValidator\ResolveValidator;
use Youshido\GraphQL\Validator\ResolveValidator\ResolveValidatorInterface;
use Youshido\GraphQL\Validator\SchemaValidator\SchemaValidator;

class Processor
{
    use ErrorContainerTrait;

    const TYPE_NAME_QUERY = '__typename';

    /** @var  array */
    protected $data;

    /** @var ResolveValidatorInterface */
    protected $resolveValidator;

    /** @var SchemaValidator */
    protected $schemaValidator;

    /** @var AbstractSchema */
    protected $schema;

    /** @var Request */
    protected $request;

    public function __construct()
    {
        $this->resolveValidator = new ResolveValidator();
        $this->schemaValidator  = new SchemaValidator();
    }

    public function setSchema(AbstractSchema $schema)
    {
        if (!$this->schemaValidator->validate($schema)) {
            $this->mergeErrors($this->schemaValidator);

            return;
        }

        $this->schema = $schema;

        $__schema = new SchemaType();
        $__schema->setSchema($schema);

        $__type = new TypeDefinitionType();

        $this->schema->addQuery('__schema', $__schema);
        $this->schema->addQuery('__type', $__type);
    }

    public function processRequest($payload, $variables = [])
    {
        if (!$this->getSchema()) {
            $this->addError(new ConfigurationException('You have to set GraphQL Schema to process'));
        }
        if (empty($payload) || $this->hasErrors()) return $this;

        $this->data = [];

        try {
            $this->parseAndCreateRequest($payload, $variables);

            foreach ($this->request->getQueries() as $query) {
                if ($queryResult = $this->executeQuery($query, $this->getSchema()->getQueryType())) {
                    $this->data = array_merge($this->data, $queryResult);
                };
            }

            foreach ($this->request->getMutations() as $mutation) {
                if ($mutationResult = $this->executeMutation($mutation, $this->getSchema()->getMutationType())) {
                    $this->data = array_merge($this->data, $mutationResult);
                }
            }

        } catch (\Exception $e) {
            $this->resolveValidator->clearErrors();

            $this->resolveValidator->addError($e);
        }

        return $this;
    }

    protected function parseAndCreateRequest($query, $variables = [])
    {
        $parser = new Parser();

        $data = $parser->parse($query);

        $this->request = new Request($data);
        $this->request->setVariables($variables);
    }

    /**
     * @param Query|Field          $query
     * @param ObjectType|QueryType $currentLevelSchema
     * @param null                 $contextValue
     * @return array|bool|mixed
     */
    protected function executeQuery($query, $currentLevelSchema, $contextValue = null)
    {
        if (!$this->resolveValidator->checkFieldExist($currentLevelSchema, $query)) {
            return null;
        }

        /** @var Field $field */
        $field = $currentLevelSchema->getField($query->getName());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $alias = $query->getAlias() ?: $query->getName();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        if ($query instanceof AstField) {
            $value = $this->processAstFieldQuery($query, $contextValue, $field);
        } else {
            if (!$this->resolveValidator->validateArguments($field, $query, $this->request)) {
                return null;
            }

            $value = $this->processFieldTypeQuery($query, $contextValue, $field);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

        }

        return [$alias => $value];
    }

    /**
     * @param Mutation   $mutation
     * @param ObjectType $currentLevelSchema
     * @return array|null
     * @throws ConfigurationException
     */
    protected function executeMutation(Mutation $mutation, $currentLevelSchema)
    {
        if (!$currentLevelSchema) throw new ConfigurationException('There is no mutation ' . $mutation->getName());

        if (!$this->resolveValidator->checkFieldExist($currentLevelSchema, $mutation)) {
            return null;
        }

        /** @var Field $field */
        $field = $currentLevelSchema->getConfig()->getField($mutation->getName());
        $alias = $mutation->getAlias() ?: $mutation->getName();

        if (!$this->resolveValidator->validateArguments($field, $mutation, $this->request)) {
            return null;
        }

        $resolvedValue = $this->resolveValue($field, null, $mutation);

        if (!$this->resolveValidator->validateResolvedValue($resolvedValue, $field->getType())) {

            $this->resolveValidator->addError(new ResolveException(sprintf('Not valid resolved value for mutation "%s"', $field->getType()->getName())));

            return [$alias => null];
        }

        $value = $resolvedValue;
        if ($mutation->hasFields()) {
            if ($field->getType()->isAbstractType()) {
                $outputType = $field->getType()->getConfig()->resolveType($resolvedValue);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            } else {
                /** @var AbstractType $outputType */
                $outputType = $field->getType();
            }

            $value = $this->collectListOrSingleValue($outputType, $resolvedValue, $mutation);
        }

        return [$alias => $value];
    }

    /**
     * @param AstField $astField
     * @param mixed    $contextValue
     * @param Field    $field
     * @return array|mixed|null
     * @throws \Exception
     */
    protected function processAstFieldQuery(AstField $astField, $contextValue, Field $field)
    {
        $value            = null;
        $preResolvedValue = $this->getPreResolvedValue($contextValue, $astField, $field);

        if ($field->getConfig()->getType()->getKind() == TypeMap::KIND_LIST) {
            if (!is_array($preResolvedValue)) {
                $this->resolveValidator->addError(new ResolveException('Not valid resolve value for list type'));

                return null;
            }

            $listValue = [];
            foreach ($preResolvedValue as $resolvedValueItem) {
                /** @var TypeInterface $type */
                $type = $field->getType()->getConfig()->getItem();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

                if ($type->getKind() == TypeMap::KIND_ENUM) {
                    /** @var $type AbstractEnumType */
                    if (!$type->isValidValue($resolvedValueItem)) {
                        $this->resolveValidator->addError(new ResolveException('Not valid value for enum type'));

                        $listValue = null;
                        break;
                    }

                    $listValue[] = $type->resolve($resolvedValueItem);
                } else {
                    /** @var AbstractScalarType $type */
                    $listValue[] = $type->serialize($preResolvedValue);
                }
            }

            $value = $listValue;
        } else {
            if ($field->getType()->getKind() == TypeMap::KIND_ENUM) {
                if (!$field->getType()->isValidValue($preResolvedValue)) {
                    $this->resolveValidator->addError(new ResolveException(sprintf('Not valid value for %s type', ($field->getType()->getKind()))));
                    $value = null;
                } else {
                    $value = $preResolvedValue;
                    /** $field->getType()->resolve($preResolvedValue); */
                }
            } elseif ($field->getType()->getKind() == TypeMap::KIND_NON_NULL) {
                if (!$field->getType()->isValidValue($preResolvedValue)) {
                    $this->resolveValidator->addError(new ResolveException(sprintf('Cannot return null for non-nullable field %s', $astField->getName() . '.' . $field->getName())));

                } elseif (!$field->getType()->getNullableType()->isValidValue($preResolvedValue)) {
                    $this->resolveValidator->addError(new ResolveException(sprintf('Not valid value for %s field %s', $field->getType()->getNullableType()->getKind(), $field->getName())));

                    $value = null;
                } else {
                    $value = $preResolvedValue;
                }
            } else {
                $value = $field->getType()->serialize($preResolvedValue);
            }
        }

        return $value;
    }

    /**
     * @param       $query
     * @param mixed $contextValue
     * @param Field $field
     * @return null
     * @throws \Exception
     */
    protected function processFieldTypeQuery($query, $contextValue, $field)
    {
        if (!($resolvedValue = $this->resolveValue($field, $contextValue, $query))) {
            return $resolvedValue;
        }

        if (!$this->resolveValidator->validateResolvedValue($resolvedValue, $field->getType())) {

            $this->resolveValidator->addError(new ResolveException(sprintf('Not valid resolved value for query "%s"', $field->getType()->getName())));

            return null;
        }

        return $this->collectListOrSingleValue($field->getType(), $resolvedValue, $query);
    }

    /**
     * @param AbstractType   $fieldType
     * @param mixed          $resolvedValue
     * @param Query|Mutation $query
     * @return array|mixed
     * @throws \Exception
     */
    protected function collectListOrSingleValue(AbstractType $fieldType, $resolvedValue, $query)
    {
        $value = [];
        if ($fieldType->getKind() == TypeMap::KIND_LIST) {
            foreach ($resolvedValue as $resolvedValueItem) {
                $value[]   = [];
                $index     = count($value) - 1;
                $namedType = $fieldType->getNamedType();

                if ($namedType->isAbstractType()) {
                    $resolvedType = $namedType->getConfig()->resolveType($resolvedValueItem);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                    if ($namedType instanceof AbstractInterfaceType) {
                        $this->resolveValidator->assertTypeImplementsInterface($resolvedType, $namedType);
                    }
                    $namedType = $resolvedType;
                }

                $value[$index] = $this->processQueryFields($query, $namedType, $resolvedValueItem, $value[$index]);
            }
        } else {
            $value = $this->processQueryFields($query, $fieldType, $resolvedValue, $value);
        }

        return $value;
    }

    /**
     * @param          $value
     * @param AstField $astField
     * @param Field    $field
     *
     * @throws \Exception
     *
     * @return mixed
     */
    protected function getPreResolvedValue($value, AstField $astField, Field $field)
    {
        $resolved      = false;
        $resolverValue = null;

        if (is_array($value) && array_key_exists($astField->getName(), $value)) {
            $resolverValue = $value[$astField->getName()];
            $resolved      = true;
        } elseif (is_object($value)) {
            try {
                $resolverValue = $this->getPropertyValue($value, $astField->getName());
                $resolved      = true;
            } catch (\Exception $e) {

            }
        } elseif ($field->getNamedType()->getKind() == TypeMap::KIND_SCALAR) {
            $resolved = true;
        }

        if ($resolved) {
            if ($field->getConfig() && ($field->getConfig()->issetResolve())) {
                $resolverValue = $field->resolve($resolverValue, $astField->getKeyValueArguments(), $field->getType());
            }

            return $resolverValue;
        }

        throw new \Exception(sprintf('Property "%s" not found in resolve result', $astField->getName()));
    }

    protected function getPropertyValue($data, $path)
    {
        if (is_object($data)) {
            $getter = 'get' . $this->classify($path);

            return is_callable([$data, $getter]) ? $data->$getter() : null;
        } elseif (is_array($data)) {
            return array_key_exists($path, $data) ? $data[$path] : null;
        }

        return null;
    }

    protected function classify($text)
    {
        $text       = explode(' ', str_replace(['_', '/', '-', '.'], ' ', $text));
        $textLength = count($text);
        for ($i = 0; $i < $textLength; $i++) {
            $text[$i] = ucfirst($text[$i]);
        }
        $text = ucfirst(implode('', $text));

        return $text;
    }

    /**
     * @param Field $field
     * @param mixed $contextValue
     * @param Query $query
     *
     * @return mixed
     */
    protected function resolveValue($field, $contextValue, $query)
    {
        $resolvedValue = $field->resolve($contextValue, $this->parseArgumentsValues($field, $query), $field->getType());

        if ($field->getType()->isAbstractType()) {
            $resolvedType = $field->getType()->resolveType($resolvedValue);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            $field->setType($resolvedType);
        }

        return $resolvedValue;
    }

    /**
     * @param $field     Field
     * @param $query     Query
     *
     * @return array
     */
    public function parseArgumentsValues($field, $query)
    {
        if ($query instanceof \Youshido\GraphQL\Parser\Ast\Field) {
            return [];
        }

        $args = [];
        foreach ($query->getArguments() as $argument) {
            if ($configArgument = $field->getConfig()->getArgument($argument->getName())) {
                $args[$argument->getName()] = $configArgument->getType()->parseValue($argument->getValue()->getValue());
            }
        }

        return $args;
    }

    /**
     * @param $query         Query
     * @param $queryType     ObjectType|TypeInterface|Field
     * @param $resolvedValue mixed
     * @param $value         array
     *
     * @throws \Exception
     *
     * @return array
     */
    protected function processQueryFields($query, $queryType, $resolvedValue, $value)
    {
        foreach ($query->getFields() as $field) {
            if ($field instanceof FragmentReference) {
                if (!$fragment = $this->request->getFragment($field->getName())) {
                    throw new \Exception(sprintf('Fragment reference "%s" not found', $field->getName()));
                }

                if ($fragment->getModel() !== $queryType->getName()) {
                    throw new \Exception(sprintf('Fragment reference "%s" not found on model "%s"', $field->getName(), $queryType->getName()));
                }

                foreach ($fragment->getFields() as $fragmentField) {
                    $value = $this->collectValue($value, $this->executeQuery($fragmentField, $queryType, $resolvedValue));
                }
            } elseif ($field instanceof TypedFragmentReference) {
                if ($field->getTypeName() !== $queryType->getName()) {
                    continue;
                }

                foreach ($field->getFields() as $fragmentField) {
                    $value = $this->collectValue($value, $this->executeQuery($fragmentField, $queryType, $resolvedValue));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                }
            } elseif ($field->getName() == self::TYPE_NAME_QUERY) {
                $value = $this->collectValue($value, [$field->getAlias() ?: $field->getName() => $queryType->getName()]);
            } else {
                $value = $this->collectValue($value, $this->executeQuery($field, $queryType, $resolvedValue));
            }
        }

        return $value;
    }

    protected function collectValue($value, $queryValue)
    {
        if ($queryValue && is_array($queryValue)) {
            $value = array_merge(is_array($value) ? $value : [], $queryValue);
        } else {
            $value = $queryValue;
        }

        return $value;
    }

    public function getSchema()
    {
        return $this->schema;
    }

    public function getResponseData()
    {
        $result = [];

        if (!empty($this->data)) {
            $result['data'] = $this->data;
        }

        $this->mergeErrors($this->resolveValidator);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($this->hasErrors()) {
            $result['errors'] = $this->getErrorsArray();
        }
        $this->clearErrors();
        $this->resolveValidator->clearErrors();
        $this->schemaValidator->clearErrors();

        return $result;
    }
}


Pull Request — master (#3)

Processor F

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

18 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Youshido / GraphQL

Pull Request — master (#3)

Processor F

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

18 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like