Completed
Push — master ( 2cce3e...4aff6e )
by Dmitry
02:18
created

Annotation   B

Complexity

Total Complexity 42

Size/Duplication

Total Lines 197
Duplicated Lines 8.12 %

Coupling/Cohesion

Components 2
Dependencies 4

Importance

Changes 0
Metric Value
wmc 42
lcom 2
cbo 4
dl 16
loc 197
rs 8.295
c 0
b 0
f 0

8 Methods

Rating   Name   Duplication   Size   Complexity  
D register() 0 33 9
D migrate() 6 75 16
A setEntityPostfix() 0 5 1
A setRepositoryPostfix() 0 5 1
A getRepositorySpaceName() 0 4 1
B getSpaceName() 10 23 6
A toUnderscore() 0 12 4
A getTarantoolType() 0 18 4

How to fix   Duplicated Code    Complexity   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

Complex Class

 Tip:   Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Annotation often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Annotation, and based on these observations, apply Extract Interface, too.

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
    protected $entityClasses = [];
18
    protected $entityPostfix;
19
20
    protected $repositoryClasses = [];
21
    protected $repositoryPostifx;
22
23
    public function register($class)
24
    {
25
        $isEntity = is_subclass_of($class, Entity::class);
0 ignored issues
show
Bug introduced by
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 by
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->entityClasses[] = $class;
37
        }
38
39
        if ($isRepository) {
40
            if ($class == Repository::class) {
41
                throw new Exception("Invalid repository registration");
42
            }
43
            $this->repositoryClasses[] = $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->entityClasses 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 by
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 by
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 by
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 by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. 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->repositoryClasses 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
103
            $class = new ReflectionClass($repository);
104
            $properties = $class->getDefaultProperties();
105
106
            if (array_key_exists('indexes', $properties)) {
107
                foreach ($properties['indexes'] as $index) {
0 ignored issues
show
Bug introduced by
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.

  1. 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) { /** ... */ }
    
  2. 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) { /** .. */ }
    
  3. 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...
108
                    if (!is_array($index)) {
109
                        $index = (array) $index;
110
                    }
111
                    if (!array_key_exists('fields', $index)) {
112
                        $index = ['fields' => $index];
113
                    }
114
115
                    $index['if_not_exists'] = true;
116
                    $space->addIndex($index);
117
                }
118
            }
119
        }
120
121
        foreach ($schema->getSpaces() as $space) {
122
            if (!count($space->getIndexes())) {
123
                if (!$space->hasProperty('id')) {
124
                    throw new Exception("No primary index on ". $space->getName());
125
                }
126
                $space->addIndex(['id']);
127
            }
128
        }
129
130
        return $this;
131
    }
132
133
    public function setEntityPostfix($postfix)
134
    {
135
        $this->entityPostfix = $postfix;
136
        return $this;
137
    }
138
139
    public function setRepositoryPostfix($postfix)
140
    {
141
        $this->repositoryPostifx = $postfix;
142
        return $this;
143
    }
144
145
    private $spaceNames = [];
146
147
    public function getRepositorySpaceName($class)
148
    {
149
        return array_search($class, $this->repositoryMapping);
150
    }
151
152
    public function getSpaceName($class)
153
    {
154
        if (!array_key_exists($class, $this->spaceNames)) {
155
            $reflection = new ReflectionClass($class);
156
            $className = $reflection->getShortName();
157
158 View Code Duplication
            if ($reflection->isSubclassOf(Repository::class)) {
0 ignored issues
show
Duplication introduced by
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...
159
                if ($this->repositoryPostifx) {
160
                    $className = substr($className, 0, strlen($className) - strlen($this->repositoryPostifx));
161
                }
162
            }
163
164 View Code Duplication
            if ($reflection->isSubclassOf(Entity::class)) {
0 ignored issues
show
Duplication introduced by
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...
165
                if ($this->entityPostfix) {
166
                    $className = substr($className, 0, strlen($className) - strlen($this->entityPostfix));
167
                }
168
            }
169
170
            $this->spaceNames[$class] = $this->toUnderscore($className);
171
        }
172
173
        return $this->spaceNames[$class];
174
    }
175
176
    private $underscores = [];
177
178
    private function toUnderscore($input)
179
    {
180
        if (!array_key_exists($input, $this->underscores)) {
181
            preg_match_all('!([A-Z][A-Z0-9]*(?=$|[A-Z][a-z0-9])|[A-Za-z][a-z0-9]+)!', $input, $matches);
182
            $ret = $matches[0];
183
            foreach ($ret as &$match) {
184
                $match = $match == strtoupper($match) ? strtolower($match) : lcfirst($match);
185
            }
186
            $this->underscores[$input] = implode('_', $ret);
187
        }
188
        return $this->underscores[$input];
189
    }
190
191
    private $tarantoolTypes = [];
192
193
    private function getTarantoolType(string $type)
194
    {
195
        if (array_key_exists($type, $this->tarantoolTypes)) {
196
            return $this->tarantoolTypes[$type];
197
        }
198
199
        if ($type[0] == '\\') {
200
            return $this->tarantoolTypes[$type] = 'unsigned';
201
        }
202
203
        switch ($type) {
204
            case 'int':
205
                return $this->tarantoolTypes[$type] = 'unsigned';
206
207
            default:
208
                return $this->tarantoolTypes[$type] = 'str';
209
        }
210
    }
211
}
212