DocBlockTypeGuesser::guessType() - Code Metrics - Inspection of "[WIP] Annotations refactoring & PHP 8 Attributes" - overblog/GraphQLBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#801)

by Timur

created 2021-01-12 22:15 UTC

DocBlockTypeGuesser::guessType() F

↳ Parent: DocBlockTypeGuesser

Complexity

Conditions	21
Paths	144

Size

Total Lines	72
Code Lines	52

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	21
eloc	52
c	1
b	1
f	0
nc	144
nop	3
dl	0
loc	72
rs	3.8

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace Overblog\GraphQLBundle\Config\Parser\MetadataParser\TypeGuesser;

use Exception;
use phpDocumentor\Reflection\DocBlock\Tags\TagWithType;
use phpDocumentor\Reflection\DocBlockFactory;
use phpDocumentor\Reflection\Type;
use phpDocumentor\Reflection\Types\AbstractList;
use phpDocumentor\Reflection\Types\Compound;
use phpDocumentor\Reflection\Types\ContextFactory;
use phpDocumentor\Reflection\Types\Mixed_;
use phpDocumentor\Reflection\Types\Null_;
use phpDocumentor\Reflection\Types\Nullable;
use phpDocumentor\Reflection\Types\Object_;
use ReflectionClass;
use ReflectionMethod;
use ReflectionProperty;
use Reflector;
use function sprintf;

class DocBlockTypeGuesser extends PhpTypeGuesser
{
    protected ?DocBlockFactory $factory;

    public function getName(): string
    {
        return 'Dock block';
    }

    public function supports(Reflector $reflector): bool
    {
        return $reflector instanceof ReflectionProperty || $reflector instanceof ReflectionMethod;
    }

    /**
     * @param ReflectionProperty|ReflectionMethod $reflector
     */
    public function guessType(ReflectionClass $reflectionClass, Reflector $reflector, array $filterGraphQLTypes = []): ?string
    {
        $contextFactory = new ContextFactory();
        $context = $contextFactory->createFromReflector($reflectionClass);
        $docBlockComment = $reflector->getDocComment();
        $docBlockComment = $reflector->getDocComment();
        if (!$docBlockComment) {
            throw new TypeGuessingException(sprintf('Doc Block not found'));
        }

        try {
            $docBlock = $this->getParser()->create($docBlockComment, $context);
        } catch (Exception $e) {
            throw new TypeGuessingException(sprintf('Doc Block parsing failed with error: %s', $e->getMessage()));
        }
        $tagName = $reflector instanceof ReflectionProperty ? 'var' : 'return';
        $tags = $docBlock->getTagsByName($tagName);
        $tag = $tags[0] ?? null;
        if (!$tag || !$tag instanceof TagWithType) {
            throw new TypeGuessingException(sprintf('No @%s tag found in doc block or tag has no type', $tagName));
        }
        $type = $tag->getType();
        $isNullable = false;
        $isList = false;
        $isListNullable = false;
        $exceptionPrefix = sprintf('Tag @%s found', $tagName);

        if ($type instanceof Compound) {
            $type = $this->resolveCompound($type);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            if (!$type) {

                throw new TypeGuessingException(sprintf('%s, but composite types are only allowed with null. Ex: string|null.', $exceptionPrefix));
            }
            $isNullable = true;
        } elseif ($type instanceof Nullable) {
            $isNullable = true;
            $type = $type->getActualType();
        }

        if ($type instanceof AbstractList) {
            $isList = true;
            $isListNullable = $isNullable;
            $isNullable = false;
            $type = $type->getValueType();
            if ($type instanceof Compound) {
                $type = $this->resolveCompound($type);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                if (!$type) {

                    throw new TypeGuessingException(sprintf('%s, but composite types in array or iterable are only allowed with null. Ex: string|null.', $exceptionPrefix));
                }
                $isNullable = true;
            } elseif ($type instanceof Mixed_) {
                throw new TypeGuessingException(sprintf('%s, but the array values cannot be mixed type', $exceptionPrefix));
            }
        }

        if ($type instanceof Object_) {
            $className = $type->getFqsen();
            if (!$className) {
                throw new TypeGuessingException(sprintf('%s, but type "object" is too generic.', $exceptionPrefix));
            }
            // Remove first '\' from returned class name
            $className = substr((string) $className, 1);
            $gqlType = $this->map->resolveType((string) $className, $filterGraphQLTypes);
            if (!$gqlType) {
                throw new TypeGuessingException(sprintf('%s, but target object "%s" is not a GraphQL Type class.', $exceptionPrefix, $className));
            }
        } else {
            $gqlType = $this->resolveTypeFromPhpType((string) $type);
            if (!$gqlType) {
                throw new TypeGuessingException(sprintf('%s, but unable to resolve type "%s" to a GraphQL scalar.', $exceptionPrefix, (string) $type));
            }
        }

        return $isList ? sprintf('[%s%s]%s', $gqlType, $isNullable ? '' : '!', $isListNullable ? '' : '!') : sprintf('%s%s', $gqlType, $isNullable ? '' : '!');
    }

    protected function resolveCompound(Compound $compound): ?Type
    {
        $typeNull = new Null_();
        if (2 !== $compound->getIterator()->count() || !$compound->contains($typeNull)) {
            return null;
        }
        foreach ($compound as $type) {
            if (!$type instanceof Null_) {
                return $type;
            }
        }

        return null;
    }

    private function getParser(): DocBlockFactory
    {
        if (!isset($this->factory)) {
            $this->factory = DocBlockFactory::createInstance();
        }

        return $this->factory;

    }
}


overblog / GraphQLBundle

Scrutinizer GitHub App not installed

Pull Request — master (#801)

DocBlockTypeGuesser::guessType() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like