Completed
Push — master ( 198c9a...1bdbce )
by Dmitry
03:41
created

Repository   C

Complexity

Total Complexity 55

Size/Duplication

Total Lines 249
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 100%

Importance

Changes 36
Bugs 8 Features 9
Metric Value
wmc 55
c 36
b 8
f 9
lcom 1
cbo 3
dl 0
loc 249
ccs 130
cts 130
cp 1
rs 6.8

11 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
D create() 0 34 10
A __call() 0 13 3
A findOne() 0 4 1
C find() 0 65 19
A knows() 0 4 1
A remove() 0 7 1
C save() 0 49 12
A register() 0 11 4
B generateId() 0 27 2
A getType() 0 4 1

How to fix   Complexity   

Complex Class

Complex classes like Repository 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 Repository, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
namespace Tarantool\Mapper;
4
5
use BadMethodCallException;
6
use LogicException;
7
8
class Repository implements Contracts\Repository
9
{
10
    private $type;
11
    private $entities = [];
12
    private $keyMap = [];
13
    private $findCache = [];
14
15
    private $magicMethodRules = [
16
        'by' => false,
17
        'firstBy' => true,
18
        'oneBy' => true,
19
    ];
20
21 28
    public function __construct(Contracts\Type $type)
22
    {
23 28
        $this->type = $type;
24 28
    }
25
26 28
    public function create($params = null)
27
    {
28 28
        if ($params && !is_array($params)) {
29 28
            $params = [$params];
30
        }
31
32 28
        $data = [];
33 28
        foreach ($params as $k => $v) {
34 28
            if (is_numeric($k)) {
35 28
                if ($v instanceof Contracts\Entity) {
36 4
                    $type = $this->type->getManager()->findRepository($v)->getType();
37 4
                    $k = $this->type->getReferenceProperty($type);
38
                } else {
39 28
                    $primitive = [];
40 28
                    foreach ($this->type->getProperties() as $property) {
41 28
                        if (!$this->type->isReference($property)) {
42 28
                            $primitive[] = $property;
43
                        }
44
                    }
45 28
                    if (count($primitive) == 2) {
46 28
                        $k = $primitive[1];
47
                    } else {
48 1
                        throw new \Exception("Can't calculate key name");
49
                    }
50
                }
51
            }
52 28
            if (!$this->type->hasProperty($k)) {
53 1
                throw new \Exception("Unknown property $k");
54
            }
55 28
            $data[$k] = $this->type->encodeProperty($k, $v);
56
        }
57
58 28
        return $this->register(new Entity($data));
59
    }
60
61 28
    public function __call($method, $arguments)
62
    {
63 28
        foreach ($this->magicMethodRules as $prefix => $oneItem) {
64 28
            if (substr($method, 0, strlen($prefix)) == $prefix) {
65 28
                $tail = substr($method, strlen($prefix));
66 28
                $fields = array_map('strtolower', explode('And', $tail));
67
68 28
                return $this->find(array_combine($fields, $arguments), $oneItem);
69
            }
70
        }
71
72 1
        throw new BadMethodCallException("Method $method not found");
73
    }
74
75 6
    public function findOne($params)
76
    {
77 6
        return $this->find($params, true);
0 ignored issues
show
Bug Compatibility introduced by
The expression $this->find($params, true); of type Tarantool\Mapper\Contrac...pper\Contracts\Entity[] adds the type Tarantool\Mapper\Contracts\Entity[] to the return on line 77 which is incompatible with the return type declared by the interface Tarantool\Mapper\Contracts\Repository::findOne of type Tarantool\Mapper\Contracts\Entity.
Loading history...
78
    }
79
80 28
    public function find($params = [], $oneItem = false)
81
    {
82 28
        $query = [];
83
84 28
        if (is_string($params) && 1 * $params == $params) {
85 1
            $params = 1 * $params;
86
        }
87
88 28
        if (is_int($params)) {
89 6
            if (isset($this->keyMap[$params])) {
90 1
                return $this->entities[$this->keyMap[$params]];
91
            }
92
            $query = [
93 5
                'id' => $params,
94
            ];
95 5
            $oneItem = true;
96
        }
97
98 28
        if ($params instanceof Contracts\Entity) {
99 2
            $params = [$params];
100
        }
101
102 28
        if (is_array($params)) {
103 28
            foreach ($params as $key => $value) {
104 28
                if (is_numeric($key) && $value instanceof Contracts\Entity) {
105 2
                    $type = $this->type->getManager()->findRepository($value)->getType();
106 2
                    $key = $this->type->getReferenceProperty($type);
107
                }
108 28
                if ($this->type->hasProperty($key)) {
109 28
                    $query[$key] = $this->type->encodeProperty($key, $value);
110
                }
111
            }
112
        }
113
114 28
        $findKey = md5(json_encode($query));
115 28
        if (array_key_exists($findKey, $this->findCache)) {
116 28
            return $this->findCache[$findKey];
117
        }
118
119 28
        $index = $this->type->findIndex(array_keys($query));
120 28
        $values = count($query) ? $this->type->getIndexTuple($index, $query) : [];
121
122 28
        $data = $this->type->getSpace()->select($values, $index);
123
124 28
        $result = [];
125 28
        if (!empty($data->getData())) {
126 28
            foreach ($data->getData() as $tuple) {
127 28
                $data = $this->type->fromTuple($tuple);
128 28
                if (isset($data['id']) && array_key_exists($data['id'], $this->keyMap)) {
129 28
                    $entity = $this->entities[$this->keyMap[$data['id']]];
130 28
                    $entity->update($data);
131
                } else {
132 28
                    $entity = new Entity($data);
133 28
                    $this->register($entity);
134
                }
135 28
                if ($oneItem) {
136 28
                    return $this->findCache[$findKey] = $entity;
137
                }
138 6
                $result[] = $entity;
139
            }
140
        }
141 28
        if (!$oneItem) {
142 6
            return $this->findCache[$findKey] = $result;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->findCache[$findKey] = $result; (array) is incompatible with the return type declared by the interface Tarantool\Mapper\Contracts\Repository::find of type Tarantool\Mapper\Contrac...pper\Contracts\Entity[].

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
143
        }
144 28
    }
145
146
    /**
147
     * @return Entity
148
     */
149 28
    public function knows(Contracts\Entity $entity)
150
    {
151 28
        return in_array($entity, $this->entities);
152
    }
153
154 1
    public function remove(Contracts\Entity $entity)
155
    {
156 1
        unset($this->entities[$this->keyMap[$entity->id]]);
157 1
        unset($this->keyMap[$entity->id]);
158
159 1
        $this->type->getSpace()->delete([$entity->id]);
0 ignored issues
show
Bug introduced by
Accessing id on the interface Tarantool\Mapper\Contracts\Entity suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
160 1
    }
161
162 28
    public function save(Contracts\Entity $entity)
163
    {
164 28
        if (!$this->knows($entity)) {
165 1
            throw new LogicException('Entity is not related with this repository');
166
        }
167
168 28
        if (!$entity->getId()) {
169 28
            $this->generateId($entity);
170 28
            $tuple = $this->type->getTuple($entity->toArray());
171
172 28
            $required = $this->type->getRequiredProperties();
173
174 28
            foreach ($this->type->getProperties() as $index => $field) {
175 28
                if (in_array($field, $required) && !array_key_exists($index, $tuple)) {
176 1
                    if ($this->type->isReference($field)) {
177 1
                        $tuple[$index] = 0;
178
                    } else {
179 28
                        $tuple[$index] = '';
180
                    }
181
                }
182
            }
183
184
            // normalize tuple
185 28
            if (array_values($tuple) != $tuple) {
186
                // index was skipped
187 2
                $max = max(array_keys($tuple));
188 2
                foreach (range(0, $max) as $index) {
189 2
                    if (!array_key_exists($index, $tuple)) {
190 2
                        $tuple[$index] = null;
191
                    }
192
                }
193 2
                ksort($tuple);
194
            }
195
196 28
            $this->type->getSpace()->insert($tuple);
197
        } else {
198 6
            $changes = $entity->pullChanges();
199 6
            if (count($changes)) {
200 6
                $operations = [];
201 6
                foreach ($this->type->getTuple($changes) as $key => $value) {
202 6
                    $operations[] = ['=', $key, $value];
203
                }
204
205 6
                $this->type->getSpace()->update($entity->getId(), $operations);
206
            }
207
        }
208
209 28
        return $entity;
210
    }
211
212 28
    private function register(Contracts\Entity $entity)
213
    {
214 28
        if (!$this->knows($entity)) {
215 28
            $this->entities[] = $entity;
216
        }
217 28
        if ($entity->getId() && !array_key_exists($entity->getId(), $this->keyMap)) {
218 28
            $this->keyMap[$entity->getId()] = array_search($entity, $this->entities);
219
        }
220
221 28
        return $entity;
222
    }
223
224 28
    private function generateId(Contracts\Entity $entity)
225
    {
226 28
        $manager = $this->type->getManager();
227 28
        $name = $this->type->getName();
0 ignored issues
show
Unused Code introduced by
$name is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
228 28
        $spaceId = $this->type->getSpaceId();
229
230 28
        $sequence = $manager->get('sequence')->oneBySpace($spaceId);
231 28
        if (!$sequence) {
232 28
            $sequence = $manager->get('sequence')->create([
233 28
                'space' => $spaceId,
234 28
                'value' => 0,
235
            ]);
236 28
            $manager->save($sequence);
237
        }
238
239 28
        $nextValue = +$manager->getMeta()
240 28
            ->get('sequence')
241 28
            ->getSpace()
242 28
            ->update($sequence->id, [['+', 2, 1]])
243 28
            ->getData()[0][2];
244
245 28
        $entity->setId($nextValue);
246
247 28
        $this->register($entity);
248
249 28
        return $entity;
250
    }
251
252 4
    public function getType()
253
    {
254 4
        return $this->type;
255
    }
256
}
257