PHPStanTypeParser::parse() - Code Metrics - Inspection of "wip" - Majkl578/doctrine-annotations - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — type ( 257e93...5997a7 )

by Michael

created 2019-03-06 16:20 UTC

PHPStanTypeParser::parse() A

↳ Parent: PHPStanTypeParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
ccs	0
cts	3
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

declare(strict_types=1);

namespace Doctrine\Annotations\TypeParser;

use Doctrine\Annotations\Metadata\Type\BooleanType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\FloatType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\IntegerType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\IntersectionType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\ListType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\MapType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\MixedType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\NullType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\ObjectType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\StringType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\Type;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Metadata\Type\UnionType;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Parser\Ast\Reference;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Parser\Reference\ReferenceResolver;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\Annotations\Parser\Scope;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Lexer\Lexer;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Parser\PhpDocParser;
filter:
    dependency_paths: ["lib/*"]
use PHPStan\PhpDocParser\Parser\TokenIterator;
filter:
    dependency_paths: ["lib/*"]
use function array_map;
use function assert;
use function count;
use function ltrim;
use function strcasecmp;
use function strtolower;

final class PHPStanTypeParser implements TypeParser
{
    /** @var Lexer */
    private $lexer;

    /** @var PhpDocParser */
    private $phpDocParser;

    /** @var ReferenceResolver */
    private $referenceResolver;

    public function __construct(Lexer $lexer, PhpDocParser $phpDocParser, ReferenceResolver $referenceResolver)
    {
        $this->lexer             = $lexer;
        $this->phpDocParser      = $phpDocParser;
        $this->referenceResolver = $referenceResolver;
    }

    public function parsePropertyType(string $docBlock, Scope $scope) : Type
    {
        $tags = $this->parse($docBlock)->getVarTagValues();

        assert(count($tags) <= 1, 'multiple @var tags not allowed');

        if (count($tags) === 0) {
            return new MixedType();
        }

        return $this->resolveType($tags[0]->type, $scope);
    }

    private function parse(string $docBlock) : PhpDocNode
    {
        return $this->phpDocParser->parse(new TokenIterator($this->lexer->tokenize($docBlock)));
    }

    private function resolveType(TypeNode $typeNode, Scope $scope) : Type
    {
        if ($typeNode instanceof IdentifierTypeNode && strcasecmp($typeNode->name, 'null') === 0) {
            return new NullType();
        }

        if ($typeNode instanceof NullableTypeNode) {
            return new UnionType($this->resolveType($typeNode->type, $scope), new NullType());
        }

        if ($typeNode instanceof UnionTypeNode) {
            return new UnionType(
                ...array_map(
                    function (TypeNode $type) use ($scope) : Type {
                        return $this->resolveType($type, $scope);
                    },
                    $typeNode->types
                )
            );
        }

        if ($typeNode instanceof IntersectionTypeNode) {
            return new IntersectionType(
                ...array_map(
                    function (TypeNode $type) use ($scope) : Type {
                        return $this->resolveType($type, $scope);
                    },
                    $typeNode->types
                )
            );
        }

        if ($typeNode instanceof ArrayTypeNode) {
            return $this->resolveArrayTypeNode($typeNode, $scope);
        }

        if ($typeNode instanceof GenericTypeNode) {
            return $this->resolveGenericNode($typeNode, $scope);
        }

        assert($typeNode instanceof IdentifierTypeNode, 'Unsupported node type');

        return $this->resolveIdentifierNode($typeNode, $scope);
    }

    private function resolveGenericNode(GenericTypeNode $typeNode, Scope $scope) : Type
    {
        assert(
            strcasecmp($typeNode->type->name, 'array') === 0
            || strcasecmp($typeNode->type->name, 'iterable') === 0
        );

        if (count($typeNode->genericTypes) === 1) {
            return new ListType($this->resolveType($typeNode->genericTypes[0], $scope));
        }

        if (count($typeNode->genericTypes) === 2) {
            assert($typeNode->genericTypes[0] instanceof IdentifierTypeNode);

            return new MapType(
                $this->resolveIdentifierNode($typeNode->genericTypes[0], $scope),
                $this->resolveType($typeNode->genericTypes[1], $scope)
            );
        }

        assert(false, '>2 generic type args');
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }

    private function resolveArrayTypeNode(ArrayTypeNode $typeNode, Scope $scope) : Type
    {
        return new ListType($this->resolveType($typeNode->type, $scope));
    }

    private function resolveIdentifierNode(TypeNode $typeNode, Scope $scope) : Type
    {
        assert($typeNode instanceof IdentifierTypeNode);

        $canonicalName = strtolower($typeNode->name);

        switch ($canonicalName) {
            case 'bool':
            case 'boolean':
                return new BooleanType();
            case 'int':
            case 'integer':
                return new IntegerType();
            case 'float':
            case 'double':
            case 'real':
                return new FloatType();
            case 'string':
                return new StringType();
            case 'array':
                return new MapType(new UnionType(new IntegerType(), new StringType()), new MixedType());
            case 'mixed':
                return new MixedType(); // TODO not really a scalar
        }

        $fullyQualified = $typeNode->name[0] === '\\';
        return new ObjectType(
            $this->referenceResolver->resolve(
                new Reference(
                    $fullyQualified ? ltrim($typeNode->name, '\\') : $typeNode->name,
                    $fullyQualified
                ),
                $scope
            )
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Doctrine\Annotations\TypeParser;
6
7			use Doctrine\Annotations\Metadata\Type\BooleanType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\BooleanType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use Doctrine\Annotations\Metadata\Type\FloatType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\FloatType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
9			use Doctrine\Annotations\Metadata\Type\IntegerType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\IntegerType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use Doctrine\Annotations\Metadata\Type\IntersectionType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Met...a\Type\IntersectionType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11			use Doctrine\Annotations\Metadata\Type\ListType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\ListType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
12			use Doctrine\Annotations\Metadata\Type\MapType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\MapType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
13			use Doctrine\Annotations\Metadata\Type\MixedType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\MixedType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
14			use Doctrine\Annotations\Metadata\Type\NullType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\NullType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15			use Doctrine\Annotations\Metadata\Type\ObjectType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\ObjectType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use Doctrine\Annotations\Metadata\Type\StringType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\StringType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17			use Doctrine\Annotations\Metadata\Type\Type;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\Type` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
18			use Doctrine\Annotations\Metadata\Type\UnionType;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Metadata\Type\UnionType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
19			use Doctrine\Annotations\Parser\Ast\Reference;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Parser\Ast\Reference` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
20			use Doctrine\Annotations\Parser\Reference\ReferenceResolver;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Par...rence\ReferenceResolver` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21			use Doctrine\Annotations\Parser\Scope;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `Doctrine\Annotations\Parser\Scope` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
22			use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
23			use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
			0 ignored issues – show Bug introduced 2019-03-06 16:23 UTC by Report Bug Copy Issue Report The type `PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...

Majkl578 / doctrine-annotations

Push — type ( 257e93...5997a7 )

PHPStanTypeParser::parse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like