Annotation::toUnderscore() - Code Metrics - Inspection of "rename plugins" - tarantool-php/mapper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4f4774...00e15e )

by Dmitry

created 2017-05-24 09:14 UTC

Annotation::toUnderscore() A

↳ Parent: Annotation

Complexity

Conditions	4
Paths	2

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.2
c	0
b	0
f	0
cc	4
eloc	8
nc	2
nop	1

<?php

namespace Tarantool\Mapper\Plugin;

use Exception;

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

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

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

    private $entityPostfix;

    private $repositories = [];

    private $repositoryPostifx;

    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;
        }

        $space = $this->getSpaceName($class);
        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) {
            $spaceName = $this->getSpaceName($entity);
            $space = $schema->hasSpace($spaceName) ? $schema->getSpace($spaceName) : $schema->createSpace($spaceName);

            $this->mapEntity($spaceName, $entity);

            $class = new ReflectionClass($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) {
            $spaceName = $this->getSpaceName($repository);

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

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

            $space = $schema->getSpace($spaceName);
            $properties = $class->getDefaultProperties();
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            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;
    }

    public function setEntityPostfix($postfix)
    {
        $this->entityPostfix = $postfix;
        return $this;
    }

    public function setRepositoryPostfix($postfix)
    {
        $this->repositoryPostifx = $postfix;
        return $this;
    }

    public function getRepositoryMapping()
    {
        $mapping = [];
        foreach ($this->repositories as $class) {
            $mapping[$this->getSpaceName($class)] = $class;
        }
        return $mapping;
    }

    public function getEntityMapping()
    {
        $mapping = [];
        foreach ($this->entities as $class) {
            $mapping[$this->getSpaceName($class)] = $class;
        }
        return $mapping;
    }

    private $spaceNames = [];

    public function getSpaceName($class)
    {
        if (!array_key_exists($class, $this->spaceNames)) {
            $reflection = new ReflectionClass($class);
            $className = $reflection->getShortName();

            if ($reflection->isSubclassOf(Repository::class)) {

                if ($this->repositoryPostifx) {
                    $className = substr($className, 0, strlen($className) - strlen($this->repositoryPostifx));
                }
            }

            if ($reflection->isSubclassOf(Entity::class)) {

                if ($this->entityPostfix) {
                    $className = substr($className, 0, strlen($className) - strlen($this->entityPostfix));
                }
            }

            $this->spaceNames[$class] = $this->toUnderscore($className);
        }

        return $this->spaceNames[$class];
    }

    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';
        }
    }
}


Push — master ( 4f4774...00e15e )

Annotation::toUnderscore() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1		<?php
2
3		namespace Tarantool\Mapper\Plugin;
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 Annotation 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 $entityPostfix;
19
20		private $repositories = [];
		0 ignored issues – show Comprehensibility introduced 2017-05-18 06:47 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...
21		private $repositoryPostifx;
22
23		public function register($class)
24		{
25		$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...
26		$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...
27
28		if (!$isEntity && !$isRepository) {
29		throw new Exception("Invalid registration");
30		}
31
32		if ($isEntity) {
33		if ($class == Entity::class) {
34		throw new Exception("Invalid entity registration");
35		}
36		$this->entities[] = $class;
37		}
38
39		if ($isRepository) {
40		if ($class == Repository::class) {
41		throw new Exception("Invalid repository registration");
42		}
43		$this->repositories[] = $class;
44		}
45
46		$space = $this->getSpaceName($class);
47		if ($this->mapper->getSchema()->hasSpace($space)) {
48		if ($isEntity) {
49		$this->mapEntity($space, $class);
50		} else {
51		$this->mapRepository($space, $class);
52		}
53		}
54		return $this;
55		}
56
57		public function migrate()
58		{
59		$factory = DocBlockFactory::createInstance();
60
61		$schema = $this->mapper->getSchema();
62
63		foreach ($this->entities as $entity) {
64		$spaceName = $this->getSpaceName($entity);
65		$space = $schema->hasSpace($spaceName) ? $schema->getSpace($spaceName) : $schema->createSpace($spaceName);
66
67		$this->mapEntity($spaceName, $entity);
68
69		$class = new ReflectionClass($entity);
70
71		foreach ($class->getProperties(ReflectionProperty::IS_PUBLIC) as $property) {
72		$description = $factory->create($property->getDocComment());
73		$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...
74
75	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...
76		throw new Exception("No var tag for ".$entity.'::'.$property->getName());
77		}
78
79	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...
80		throw new Exception("Invalid var tag for ".$entity.'::'.$property->getName());
81		}
82
83		$property = $this->toUnderscore($property->getName());
84		$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...
85
86		if (!$space->hasProperty($property)) {
87		$space->addProperty($property, $type);
88		}
89		}
90		}
91
92		foreach ($this->repositories as $repository) {
93		$spaceName = $this->getSpaceName($repository);
94
95		if (!$schema->hasSpace($spaceName)) {
96		throw new Exception("Repository with no entity definition");
97		}
98
99		$this->mapRepository($spaceName, $repository);
100
101		$space = $schema->getSpace($spaceName);
102		$properties = $class->getDefaultProperties();
		0 ignored issues – show Bug introduced 2017-05-18 06:47 UTC by Report Bug Copy Issue Report The variable `$class` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
103		if (array_key_exists('indexes', $properties)) {
104		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...
105		if (!is_array($index)) {
106		$index = (array) $index;
107		}
108		if (!array_key_exists('fields', $index)) {
109		$index = ['fields' => $index];
110		}
111
112		$index['if_not_exists'] = true;
113		$space->addIndex($index);
114		}
115		}
116		}
117
118		foreach ($schema->getSpaces() as $space) {
119		if (!count($space->getIndexes())) {
120		if (!$space->hasProperty('id')) {
121		throw new Exception("No primary index on ". $space->getName());
122		}
123		$space->addIndex(['id']);
124		}
125		}
126
127		return $this;
128		}
129
130		public function setEntityPostfix($postfix)
131		{
132		$this->entityPostfix = $postfix;
133		return $this;
134		}
135
136		public function setRepositoryPostfix($postfix)
137		{
138		$this->repositoryPostifx = $postfix;
139		return $this;
140		}
141
142		public function getRepositoryMapping()
143		{
144		$mapping = [];
145		foreach ($this->repositories as $class) {
146		$mapping[$this->getSpaceName($class)] = $class;
147		}
148		return $mapping;
149		}
150
151		public function getEntityMapping()
152		{
153		$mapping = [];
154		foreach ($this->entities as $class) {
155		$mapping[$this->getSpaceName($class)] = $class;
156		}
157		return $mapping;
158		}
159
160		private $spaceNames = [];
161
162		public function getSpaceName($class)
163		{
164		if (!array_key_exists($class, $this->spaceNames)) {
165		$reflection = new ReflectionClass($class);
166		$className = $reflection->getShortName();
167
168	View Code Duplication	if ($reflection->isSubclassOf(Repository::class)) {
		0 ignored issues – show Duplication introduced 2017-05-18 06:47 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...
169		if ($this->repositoryPostifx) {
170		$className = substr($className, 0, strlen($className) - strlen($this->repositoryPostifx));
171		}
172		}
173
174	View Code Duplication	if ($reflection->isSubclassOf(Entity::class)) {
		0 ignored issues – show Duplication introduced 2017-05-18 06:47 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...
175		if ($this->entityPostfix) {
176		$className = substr($className, 0, strlen($className) - strlen($this->entityPostfix));
177		}
178		}
179
180		$this->spaceNames[$class] = $this->toUnderscore($className);
181		}
182
183		return $this->spaceNames[$class];
184		}
185
186		private $underscores = [];
187
188		private function toUnderscore($input)
189		{
190		if (!array_key_exists($input, $this->underscores)) {
191		preg_match_all('!([A-Z][A-Z0-9]*(?=$\|[A-Z][a-z0-9])\|[A-Za-z][a-z0-9]+)!', $input, $matches);
192		$ret = $matches[0];
193		foreach ($ret as &$match) {
194		$match = $match == strtoupper($match) ? strtolower($match) : lcfirst($match);
195		}
196		$this->underscores[$input] = implode('_', $ret);
197		}
198		return $this->underscores[$input];
199		}
200
201		private $tarantoolTypes = [];
202
203		private function getTarantoolType(string $type)
204		{
205		if (array_key_exists($type, $this->tarantoolTypes)) {
206		return $this->tarantoolTypes[$type];
207		}
208
209		if ($type[0] == '\\') {
210		return $this->tarantoolTypes[$type] = 'unsigned';
211		}
212
213		switch ($type) {
214		case 'int':
215		return $this->tarantoolTypes[$type] = 'unsigned';
216
217		default:
218		return $this->tarantoolTypes[$type] = 'str';
219		}
220		}
221		}
222

tarantool-php / mapper

Push — master ( 4f4774...00e15e )

Annotation::toUnderscore() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like