DocBlock::migrate() - Code Metrics - Inspection of "index create if not exists flag" - tarantool-php/mapper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( efdf1e...4c7914 )

by Dmitry

created 2017-05-10 14:06 UTC

DocBlock::migrate() D

↳ Parent: DocBlock

Complexity

Conditions	16
Paths	207

Size

Total Lines	76
Code Lines	41

Duplication

Lines	6
Ratio	7.89 %

Importance

Changes

Metric	Value
dl	6
loc	76
rs	4.7492
c	0
b	0
f	0
cc	16
eloc	41
nc	207
nop	0

How to fix Long Method Complexity

<?php

namespace Tarantool\Mapper\Plugins;

use Exception;

use phpDocumentor\Reflection\DocBlockFactory;
use ReflectionClass;
use ReflectionProperty;

use Tarantool\Mapper\Entity;
use Tarantool\Mapper\Plugin;
use Tarantool\Mapper\Repository;

class DocBlock extends UserClasses
{
    private $entities = [];

    private $repositories = [];


    public function register($class)
    {
        $isEntity = is_subclass_of($class, Entity::class);

        $isRepository = is_subclass_of($class, Repository::class);


        if(!$isEntity && !$isRepository) {
            throw new Exception("Invalid registration");
        }

        if($isEntity) {
            if($class == Entity::class) {
                throw new Exception("Invalid entity registration");
            }
            $this->entities[] = $class;
        }

        if($isRepository) {
            if($class == Repository::class) {
                throw new Exception("Invalid repository registration");
            }
            $this->repositories[] = $class;
        }

        $reflection = new ReflectionClass($class);
        $space = $this->toUnderscore($reflection->getShortName());
        if($this->mapper->getSchema()->hasSpace($space)) {
            if($isEntity) {
                $this->mapEntity($space, $class);
            } else {
                $this->mapRepository($space, $class);
            }
        }
        return $this;
    }

    public function migrate()
    {
        $factory = DocBlockFactory::createInstance();

        $schema = $this->mapper->getSchema();

        foreach($this->entities as $entity) {

            $class = new ReflectionClass($entity);
            $spaceName = $this->toUnderscore($class->getShortName());

            $space = $schema->hasSpace($spaceName) ? $schema->getSpace($spaceName) : $schema->createSpace($spaceName);
            $this->mapEntity($spaceName, $entity);

            foreach($class->getProperties(ReflectionProperty::IS_PUBLIC) as $property) {

                $description = $factory->create($property->getDocComment());
                $tags = $description->getTags('var');


                if(!count($tags)) {

                    throw new Exception("No var tag for ".$entity.'::'.$property->getName());
                }

                if(count($tags) > 1) {

                    throw new Exception("Invalid var tag for ".$entity.'::'.$property->getName());
                }

                $property = $this->toUnderscore($property->getName());
                $type = $this->getTarantoolType($tags[0]->getType());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

                if(!$space->hasProperty($property)) {
                    $space->addProperty($property, $type);
                }
            }
        }

        foreach($this->repositories as $repository) {

            $class = new ReflectionClass($repository);
            $spaceName = $this->toUnderscore($class->getShortName());

            if(!$schema->hasSpace($spaceName)) {
                throw new Exception("Repository with no entity definition");
            }

            $this->mapRepository($spaceName, $repository);

            $space = $schema->getSpace($spaceName);
            $properties = $class->getDefaultProperties();
            if(array_key_exists('indexes', $properties)) {
                foreach($properties['indexes'] as $index) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                    if(!is_array($index)) {
                        $index = (array) $index;
                    }
                    if(!array_key_exists('fields', $index)) {
                        $index = ['fields' => $index];
                    }

                    $index['if_not_exists'] = true;
                    $space->addIndex($index);
                }
            }
        }

        foreach($schema->getSpaces() as $space) {

            if(!count($space->getIndexes())) {
                if(!$space->hasProperty('id')) {
                    throw new Exception("No primary index on ". $space->getName());
                }
                $space->addIndex(['id']);
            }
        }

        return $this;
    }

    private $underscores = [];

    private function toUnderscore($input)
    {
        if(!array_key_exists($input, $this->underscores)) {
            preg_match_all('!([A-Z][A-Z0-9]*(?=$|[A-Z][a-z0-9])|[A-Za-z][a-z0-9]+)!', $input, $matches);
            $ret = $matches[0];
            foreach ($ret as &$match) {
                $match = $match == strtoupper($match) ? strtolower($match) : lcfirst($match);
            }
            $this->underscores[$input] = implode('_', $ret);
        }
        return $this->underscores[$input];
    }

    private $tarantoolTypes = [];

    private function getTarantoolType(string $type)
    {
        if(array_key_exists($type, $this->tarantoolTypes)) {
            return $this->tarantoolTypes[$type];
        }

        if($type[0] == '\\') {
            return $this->tarantoolTypes[$type] = 'unsigned';
        }

        switch($type) {
            case 'int':
                return $this->tarantoolTypes[$type] = 'unsigned';

            default:
                return $this->tarantoolTypes[$type] = 'str';
        }
    }
}


1		<?php
2
3		namespace Tarantool\Mapper\Plugins;
4
5		use Exception;
6
7		use phpDocumentor\Reflection\DocBlockFactory;
8		use ReflectionClass;
9		use ReflectionProperty;
10
11		use Tarantool\Mapper\Entity;
12		use Tarantool\Mapper\Plugin;
13		use Tarantool\Mapper\Repository;
14
15		class DocBlock extends UserClasses
16		{
17		private $entities = [];
		0 ignored issues – show Comprehensibility introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
18		private $repositories = [];
		0 ignored issues – show Comprehensibility introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
19
20		public function register($class)
21		{
22		$isEntity = is_subclass_of($class, Entity::class);
		0 ignored issues – show Bug introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report Due to PHP Bug #53727, `is_subclass_of` might return inconsistent results on some PHP versions if `\Tarantool\Mapper\Entity::class` can be an interface. If so, you could instead use `ReflectionClass::implementsInterface`. Loading history...
23		$isRepository = is_subclass_of($class, Repository::class);
		0 ignored issues – show Bug introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report Due to PHP Bug #53727, `is_subclass_of` might return inconsistent results on some PHP versions if `\Tarantool\Mapper\Repository::class` can be an interface. If so, you could instead use `ReflectionClass::implementsInterface`. Loading history...
24
25		if(!$isEntity && !$isRepository) {
26		throw new Exception("Invalid registration");
27		}
28
29		if($isEntity) {
30		if($class == Entity::class) {
31		throw new Exception("Invalid entity registration");
32		}
33		$this->entities[] = $class;
34		}
35
36		if($isRepository) {
37		if($class == Repository::class) {
38		throw new Exception("Invalid repository registration");
39		}
40		$this->repositories[] = $class;
41		}
42
43		$reflection = new ReflectionClass($class);
44		$space = $this->toUnderscore($reflection->getShortName());
45		if($this->mapper->getSchema()->hasSpace($space)) {
46		if($isEntity) {
47		$this->mapEntity($space, $class);
48		} else {
49		$this->mapRepository($space, $class);
50		}
51		}
52		return $this;
53		}
54
55		public function migrate()
56		{
57		$factory = DocBlockFactory::createInstance();
58
59		$schema = $this->mapper->getSchema();
60
61		foreach($this->entities as $entity) {
62
63		$class = new ReflectionClass($entity);
64		$spaceName = $this->toUnderscore($class->getShortName());
65
66		$space = $schema->hasSpace($spaceName) ? $schema->getSpace($spaceName) : $schema->createSpace($spaceName);
67		$this->mapEntity($spaceName, $entity);
68
69		foreach($class->getProperties(ReflectionProperty::IS_PUBLIC) as $property) {
70
71		$description = $factory->create($property->getDocComment());
72		$tags = $description->getTags('var');
		0 ignored issues – show Unused Code introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report The call to `DocBlock::getTags()` has too many arguments starting with `'var'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
73
74	View Code Duplication	if(!count($tags)) {
		0 ignored issues – show Duplication introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
75		throw new Exception("No var tag for ".$entity.'::'.$property->getName());
76		}
77
78	View Code Duplication	if(count($tags) > 1) {
		0 ignored issues – show Duplication introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
79		throw new Exception("Invalid var tag for ".$entity.'::'.$property->getName());
80		}
81
82		$property = $this->toUnderscore($property->getName());
83		$type = $this->getTarantoolType($tags[0]->getType());
		0 ignored issues – show Bug introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `phpDocumentor\Reflection\DocBlock\Tag` as the method `getType()` does only exist in the following implementations of said interface: `phpDocumentor\Reflection\DocBlock\Tags\Param`, `phpDocumentor\Reflection\DocBlock\Tags\Property`, `phpDocumentor\Reflection...Block\Tags\PropertyRead`, `phpDocumentor\Reflection...lock\Tags\PropertyWrite`, `phpDocumentor\Reflection\DocBlock\Tags\Return_`, `phpDocumentor\Reflection\DocBlock\Tags\Throws`, `phpDocumentor\Reflection\DocBlock\Tags\Var_`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
84
85		if(!$space->hasProperty($property)) {
86		$space->addProperty($property, $type);
87		}
88		}
89		}
90
91		foreach($this->repositories as $repository) {
92
93		$class = new ReflectionClass($repository);
94		$spaceName = $this->toUnderscore($class->getShortName());
95
96		if(!$schema->hasSpace($spaceName)) {
97		throw new Exception("Repository with no entity definition");
98		}
99
100		$this->mapRepository($spaceName, $repository);
101
102		$space = $schema->getSpace($spaceName);
103		$properties = $class->getDefaultProperties();
104		if(array_key_exists('indexes', $properties)) {
105		foreach($properties['indexes'] as $index) {
		0 ignored issues – show Bug introduced 2017-05-05 14:12 UTC by Report Bug Copy Issue Report The expression `$properties['indexes']` of type `null\|integer\|double\|string\|boolean\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
106		if(!is_array($index)) {
107		$index = (array) $index;
108		}
109		if(!array_key_exists('fields', $index)) {
110		$index = ['fields' => $index];
111		}
112
113		$index['if_not_exists'] = true;
114		$space->addIndex($index);
115		}
116		}
117		}
118
119		foreach($schema->getSpaces() as $space) {
120
121		if(!count($space->getIndexes())) {
122		if(!$space->hasProperty('id')) {
123		throw new Exception("No primary index on ". $space->getName());
124		}
125		$space->addIndex(['id']);
126		}
127		}
128
129		return $this;
130		}
131
132		private $underscores = [];
133
134		private function toUnderscore($input)
135		{
136		if(!array_key_exists($input, $this->underscores)) {
137		preg_match_all('!([A-Z][A-Z0-9]*(?=$\|[A-Z][a-z0-9])\|[A-Za-z][a-z0-9]+)!', $input, $matches);
138		$ret = $matches[0];
139		foreach ($ret as &$match) {
140		$match = $match == strtoupper($match) ? strtolower($match) : lcfirst($match);
141		}
142		$this->underscores[$input] = implode('_', $ret);
143		}
144		return $this->underscores[$input];
145		}
146
147		private $tarantoolTypes = [];
148
149		private function getTarantoolType(string $type)
150		{
151		if(array_key_exists($type, $this->tarantoolTypes)) {
152		return $this->tarantoolTypes[$type];
153		}
154
155		if($type[0] == '\\') {
156		return $this->tarantoolTypes[$type] = 'unsigned';
157		}
158
159		switch($type) {
160		case 'int':
161		return $this->tarantoolTypes[$type] = 'unsigned';
162
163		default:
164		return $this->tarantoolTypes[$type] = 'str';
165		}
166		}
167		}
168

tarantool-php / mapper

Push — master ( efdf1e...4c7914 )

DocBlock::migrate() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like