Digia\GraphQL\Language\AST\Visitor\AcceptVisitorTrait

Complexity

Total Complexity

34

Size/Duplication

Total Lines	352
Duplicated Lines	0 %

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getNodeOrNodes()	0	3	1
A	getParent()	0	3	1
A	addOneToPath()	0	3	1
C	accept()	0	56	11
A	removeAncestor()	0	3	1
A	visitNodeOrNodes()	0	5	2
A	getKey()	0	3	1
A	addAncestor()	0	3	1
A	isEdited()	0	3	1
A	visitNodes()	0	19	3
A	determineIsEdited()	0	4	2
A	getClosestAncestor()	0	3	2
A	compareNode()	0	4	1
A	visitNode()	0	15	3
A	getPath()	0	3	1
A	removeOneFromPath()	0	3	1
A	setIsEdited()	0	4	1

<?php

namespace Digia\GraphQL\Language\AST\Visitor;

use Digia\GraphQL\Language\AST\Node\NodeInterface;
use Digia\GraphQL\Util\SerializationInterface;

trait AcceptVisitorTrait
{

    /**
     * @var VisitorInterface
     */
    protected $visitor;

    /**
     * @var string|int|null
     */
    protected $key;

    /**
     * @var NodeInterface|null
     */
    protected $parent;

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

    /**
     * @var array
     */
    protected $ancestors = [];

    /**
     * @var boolean
     */
    protected $isEdited = false;

    /**
     * @param VisitorInterface      $visitor
     * @param string|int|null       $key
     * @param NodeInterface|null    $parent
     * @param array                 $path
     * @param array|NodeInterface[] $ancestors
     * @return NodeInterface|AcceptVisitorTrait|SerializationInterface|null
     */
    public function accept(
        VisitorInterface $visitor,
        $key = null,
        ?NodeInterface $parent = null,
        array $path = [],
        array $ancestors = []
    ): ?NodeInterface {
        $this->visitor   = $visitor;
        $this->key       = $key;
        $this->parent    = $parent;
        $this->path      = $path;
        $this->ancestors = $ancestors;

        /** @var NodeInterface|AcceptVisitorTrait|null $newNode */
        $newNode = clone $this; // TODO: Benchmark cloning

        if (null !== $parent) {
            $this->addAncestor($parent);
        }

        // If the result was null, it means that we should not traverse this branch.
        if (null === ($newNode = $visitor->enterNode($newNode))) {

It seems like $newNode can also be of type null and Digia\GraphQL\Language\AST\Visitor\AcceptVisitorTrait; however, parameter $node of Digia\GraphQL\Language\AST\Visitor\VisitorInterface::enterNode() does only seem to accept Digia\GraphQL\Language\AST\Node\NodeInterface, maybe add an additional type check?

            return null;
        }

        // If the node was edited, we want to return early
        // to avoid visiting its sub-tree completely.
        if ($newNode->determineIsEdited($this)) {

The method determineIsEdited() does not exist on Digia\GraphQL\Language\AST\Node\NodeInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Digia\GraphQL\Language\AST\Node\DefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeExtensionNodeInterface or Digia\GraphQL\Language\AST\Node\ValueNodeInterface or Digia\GraphQL\Language\AST\Node\SelectionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeNodeInterface or Digia\GraphQL\Language\AST\Node\TypeSystemDefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeDefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\ExecutableDefinitionNodeInterface. Are you sure you never get one of those?

            return $newNode;
        }

        foreach (self::$kindToNodesToVisitMap[$this->kind] as $name) {

The property kind does not exist on Digia\GraphQL\Language\AST\Visitor\AcceptVisitorTrait. Did you maybe forget to declare it?

            $nodeOrNodes = $this->getNodeOrNodes($name);

            if (null === $nodeOrNodes || empty($nodeOrNodes)) {
                continue;
            }

            $newNodeOrNodes = $this->visitNodeOrNodes($nodeOrNodes, $name);

            if (null === $newNodeOrNodes || empty($newNodeOrNodes)) {
                continue;
            }

            $setter = 'set' . ucfirst($name);

            if (method_exists($newNode, $setter)) {
                $newNode->{$setter}($newNodeOrNodes);
            }
        }

        if (null !== $parent) {
            $this->removeAncestor();
        }

        return $visitor->leaveNode($newNode);
    }

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

    /**
     * @param bool $isEdited
     * @return $this
     */
    public function setIsEdited(bool $isEdited)
    {
        $this->isEdited = $isEdited;
        return $this;
    }

    /**
     * @return NodeInterface|null
     */
    public function getClosestAncestor(): ?NodeInterface
    {
        return !empty($this->ancestors) ? $this->ancestors[\count($this->ancestors) - 1] : null;
    }

    /**
     * @return int|null|string
     */
    public function getKey()
    {
        return $this->key;
    }

    /**
     * @return NodeInterface|null
     */
    public function getParent(): ?NodeInterface
    {
        return $this->parent;
    }

    /**
     * @return array
     */
    public function getPath(): array
    {
        return $this->path;
    }

    /**
     * @param string|int $key
     * @return array|NodeInterface|NodeInterface[]|null
     */
    protected function getNodeOrNodes($key)
    {
        return $this->{$key};
    }

    /**
     * @param            $nodeOrNodes
     * @param string|int $key
     * @return array|NodeInterface|NodeInterface[]|null
     */
    protected function visitNodeOrNodes($nodeOrNodes, $key)
    {
        return \is_array($nodeOrNodes)
            ? $this->visitNodes($nodeOrNodes, $key)
            : $this->visitNode($nodeOrNodes, $key, $this);

$this of type Digia\GraphQL\Language\AST\Visitor\AcceptVisitorTrait is incompatible with the type null|Digia\GraphQL\Language\AST\Node\NodeInterface expected by parameter $parent of Digia\GraphQL\Language\AST\Visitor\AcceptVisitorTrait::visitNode().

    }

    /**
     * @param NodeInterface[] $nodes
     * @param string|int      $key
     * @return NodeInterface[]
     */
    protected function visitNodes(array $nodes, $key): array
    {
        $this->addOneToPath($key);

        $index    = 0;
        $newNodes = [];

        foreach ($nodes as $node) {
            $newNode = $this->visitNode($node, $index, null);

            if (null !== $newNode) {
                $newNodes[$index] = $newNode;
                $index++;
            }
        }

        $this->removeOneFromPath();

        return $newNodes;
    }

    /**
     * @param NodeInterface|AcceptVisitorTrait $node
     * @param string|int                       $key
     * @param NodeInterface|null               $parent
     * @return NodeInterface|null
     */
    protected function visitNode(NodeInterface $node, $key, ?NodeInterface $parent): ?NodeInterface
    {
        $this->addOneToPath($key);

        $newNode = $node->accept($this->visitor, $key, $parent, $this->path, $this->ancestors);

The method accept() does not exist on Digia\GraphQL\Language\AST\Node\NodeInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Digia\GraphQL\Language\AST\Node\DefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeExtensionNodeInterface or Digia\GraphQL\Language\AST\Node\ValueNodeInterface or Digia\GraphQL\Language\AST\Node\SelectionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeNodeInterface or Digia\GraphQL\Language\AST\Node\TypeSystemDefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeDefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\ExecutableDefinitionNodeInterface. Are you sure you never get one of those?

        // If the node was edited, we need to revisit it
        // to produce the expected result.
        if (null !== $newNode && $newNode->isEdited()) {
            $newNode = $newNode->accept($this->visitor, $key, $parent, $this->path, $this->ancestors);
        }

        $this->removeOneFromPath();

        return $newNode;
    }

    /**
     * @param NodeInterface|AcceptVisitorTrait $node
     * @return bool
     */
    protected function determineIsEdited(NodeInterface $node): bool
    {
        $this->isEdited = $this->isEdited || !$this->compareNode($node);
        return $this->isEdited;
    }

    /**
     * @param NodeInterface $other
     * @return bool
     */
    protected function compareNode(NodeInterface $other)
    {
        // TODO: Figure out a better way to solve this.
        return $this->toJSON() === $other->toJSON();

It seems like toJSON() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Appends a key to the path.
     * @param string $key
     */
    protected function addOneToPath(string $key)
    {
        $this->path[] = $key;
    }

    /**
     * Removes the last item from the path.
     */
    protected function removeOneFromPath()
    {
        $this->path = \array_slice($this->path, 0, -1);
    }

    /**
     * Adds an ancestor.
     * @param NodeInterface $node
     */
    protected function addAncestor(NodeInterface $node)
    {
        $this->ancestors[] = $node;
    }

    /**
     *  Removes the last ancestor.
     */
    protected function removeAncestor()
    {
        $this->ancestors = \array_slice($this->ancestors, 0, -1);
    }

    /**
     * @var array
     */
    protected static $kindToNodesToVisitMap = [
        'Name' => [],

        'Document'            => ['definitions'],
        'OperationDefinition' => [
            'name',
            'variableDefinitions',
            'directives',
            'selectionSet',
        ],
        'VariableDefinition'  => ['variable', 'type', 'defaultValue'],
        'Variable'            => ['name'],
        'SelectionSet'        => ['selections'],
        'Field'               => ['alias', 'name', 'arguments', 'directives', 'selectionSet'],
        'Argument'            => ['name', 'value'],

        'FragmentSpread'     => ['name', 'directives'],
        'InlineFragment'     => ['typeCondition', 'directives', 'selectionSet'],
        'FragmentDefinition' => [
            'name',
            // Note: fragment variable definitions are experimental and may be changed or removed in the future.
            'variableDefinitions',
            'typeCondition',
            'directives',
            'selectionSet',
        ],

        'IntValue'     => [],
        'FloatValue'   => [],
        'StringValue'  => [],
        'BooleanValue' => [],
        'NullValue'    => [],
        'EnumValue'    => [],
        'ListValue'    => ['values'],
        'ObjectValue'  => ['fields'],
        'ObjectField'  => ['name', 'value'],

        'Directive' => ['name', 'arguments'],

        'NamedType'   => ['name'],
        'ListType'    => ['type'],
        'NonNullType' => ['type'],

        'SchemaDefinition'        => ['directives', 'operationTypes'],
        'OperationTypeDefinition' => ['type'],

        'ScalarTypeDefinition'      => ['description', 'name', 'directives'],
        'ObjectTypeDefinition'      => [
            'description',
            'name',
            'interfaces',
            'directives',
            'fields',
        ],
        'FieldDefinition'           => ['description', 'name', 'arguments', 'type', 'directives'],
        'InputValueDefinition'      => [
            'description',
            'name',
            'type',
            'defaultValue',
            'directives',
        ],
        'InterfaceTypeDefinition'   => ['description', 'name', 'directives', 'fields'],
        'UnionTypeDefinition'       => ['description', 'name', 'directives', 'types'],
        'EnumTypeDefinition'        => ['description', 'name', 'directives', 'values'],
        'EnumValueDefinition'       => ['description', 'name', 'directives'],
        'InputObjectTypeDefinition' => ['description', 'name', 'directives', 'fields'],

        'ScalarTypeExtension'      => ['name', 'directives'],
        'ObjectTypeExtension'      => ['name', 'interfaces', 'directives', 'fields'],
        'InterfaceTypeExtension'   => ['name', 'directives', 'fields'],
        'UnionTypeExtension'       => ['name', 'directives', 'types'],
        'EnumTypeExtension'        => ['name', 'directives', 'values'],
        'InputObjectTypeExtension' => ['name', 'directives', 'fields'],

        'DirectiveDefinition' => ['description', 'name', 'arguments', 'locations'],
    ];
}