Completed
Push — master ( 8773a6...36049f )
by Dmitry
04:14
created

Repository::removeAll()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 7
ccs 5
cts 5
cp 1
rs 9.4285
cc 2
eloc 4
nc 2
nop 0
crap 2
1
<?php
2
3
namespace Tarantool\Mapper;
4
5
use BadMethodCallException;
6
use Exception;
7
use LogicException;
8
9
class Repository implements Contracts\Repository
10
{
11
    private $type;
12
    private $entities = [];
13
    private $keyMap = [];
14
    private $findCache = [];
15
    private $original = [];
16
17
    private $magicMethodRules = [
18
        'by' => false,
19
        'firstBy' => true,
20
        'oneBy' => true,
21
    ];
22
23 61
    public function __construct(Contracts\Type $type)
24
    {
25 61
        $this->type = $type;
26 61
    }
27
28 61
    public function create($params = null)
29
    {
30 61
        if ($params && !is_array($params)) {
31 61
            $params = [$params];
32
        }
33
34 61
        if (!is_array($params)) {
35 1
            $params = [];
36
        }
37
38 61
        $data = [];
39 61
        foreach ($params as $k => $v) {
40 61
            if (is_numeric($k)) {
41 61
                if ($v instanceof Contracts\Entity) {
42 4
                    $type = $this->type->getManager()->findRepository($v)->getType();
43 4
                    $k = $this->type->getReferenceProperty($type);
44
                } else {
45 61
                    $primitive = [];
46 61
                    foreach ($this->type->getProperties() as $property) {
47 61
                        if (!$this->type->isReference($property)) {
48 61
                            $primitive[] = $property;
49
                        }
50
                    }
51 61
                    if (count($primitive) == 2) {
52 61
                        $k = $primitive[1];
53
                    } else {
54 1
                        throw new Exception("Can't calculate key name");
55
                    }
56
                }
57
            }
58 61 View Code Duplication
            if (!$this->type->hasProperty($k)) {
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...
59 2
                $name = $this->type->getName();
60 2
                throw new Exception("Unknown property $name.$k");
61
            }
62 61
            $data[$k] = $this->type->encodeProperty($k, $v);
63
        }
64 61
        foreach ($this->type->getRequiredProperties() as $property) {
65 61
            if (!array_key_exists($property, $data)) {
66 61
                $convention = $this->type->getManager()->getMeta()->getConvention();
67 61
                $propertyType = $this->type->getPropertyType($property);
68 61
                $data[$property] = $convention->getDefaultValue($propertyType);
69
            }
70
        }
71
72 61
        $this->flushCache();
73
74 61
        return $this->createInstance($data);
75
    }
76
77 61
    private function createInstance($data)
78
    {
79 61
        $class = $this->getType()->getEntityClass();
80
81 61
        return $this->register(new $class($data));
82
    }
83
84 61
    public function __call($method, $arguments)
85
    {
86 61
        foreach ($this->magicMethodRules as $prefix => $oneItem) {
87 61
            if (substr($method, 0, strlen($prefix)) == $prefix) {
88 61
                $tail = substr($method, strlen($prefix));
89 61
                $fields = array_map('strtolower', explode('And', $tail));
90
91 61
                return $this->find(array_combine($fields, $arguments), $oneItem);
92
            }
93
        }
94
95 1
        throw new BadMethodCallException("Method $method not found");
96
    }
97
98 18
    public function findOne($params)
99
    {
100 18
        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 100 which is incompatible with the return type declared by the interface Tarantool\Mapper\Contracts\Repository::findOne of type Tarantool\Mapper\Contracts\Entity.
Loading history...
101
    }
102
103 61
    public function find($params = [], $oneItem = false)
104
    {
105 61
        $query = [];
106
107 61
        if (is_string($params) && 1 * $params == $params) {
108 1
            $params = 1 * $params;
109
        }
110
111 61
        if (is_int($params)) {
112 10
            if (isset($this->keyMap[$params])) {
113 3
                return $this->entities[$this->keyMap[$params]];
114
            }
115
            $query = [
116 7
                'id' => $params,
117
            ];
118 7
            $oneItem = true;
119
        }
120
121 61
        if ($params instanceof Contracts\Entity) {
122 2
            $params = [$params];
123
        }
124
125 61
        $reject = [];
126 61
        if (is_array($params)) {
127
128 61
            foreach($params as $key => $value) {
129 61
                if(is_string($value)) {
130 17
                    if(substr($value, 0, 1) == '!') {
131 61
                        $reject[$key] = substr($value, 1);
132
                    }
133
                }
134
            }
135 61
            foreach(array_keys($reject) as $key) {
136 1
                unset($params[$key]);
137
            }
138
139 61
            foreach ($params as $key => $value) {
140 61
                if (is_numeric($key) && $value instanceof Contracts\Entity) {
141 2
                    $type = $this->type->getManager()->findRepository($value)->getType();
142 2
                    $key = $this->type->getReferenceProperty($type);
143
                }
144 61
                if ($this->type->hasProperty($key)) {
145 61
                    $query[$key] = $this->type->encodeProperty($key, $value);
146
                } else {
147 1
                    $name = $this->getType()->getName();
148 61
                    throw new Exception("Unknown property $name.$key");
149
                }
150
            }
151
        }
152
153 61
        $findKey = md5(json_encode([$query, $reject]).($oneItem ? 'x' : ''));
154 61
        if (array_key_exists($findKey, $this->findCache)) {
155 61
            return $this->findCache[$findKey];
156
        }
157
158 61
        $index = $this->type->findIndex(array_keys($query));
159 61
        if (!is_numeric($index)) {
160 2
            throw new Exception('No index found for '.json_encode(array_keys($query)));
161
        }
162
163 61
        $values = count($query) ? $this->type->getIndexTuple($index, $query) : [];
164
165 61
        if (count($reject)) {
166 1
            $if = [];
167 1
            $properties = $this->type->getProperties();
168 1
            foreach ($reject as $key => $value) {
169 1
                $num = array_search($key, $properties) + 1;
170 1
                if(!$num) {
171
                    throw new Exception("Unknown property $key");
172
                }
173 1
                $if[] = "tuple[".$num.'] ~= '.(is_numeric($value) ? intval($value):"'$value'");
174
            }
175
176 1
            return $this->evaluate("
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->evaluate('... return 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...
177
                local result = {}
178 1
                for _, tuple in box.space.".$this->type->getName().'.index['.$index.']:pairs{'.implode(',', $values)."} do
179 1
                    if (" . implode(" && ", $if).") then table.insert(result, tuple) end
180
                end
181 1
                return result");
182
        }
183
184 61
        $data = $this->type->getSpace()->select($values, $index);
185
186 61
        $result = [];
187 61
        if (!empty($data->getData())) {
188 61
            foreach ($data->getData() as $tuple) {
189 61
                $data = $this->type->fromTuple($tuple);
190 61 View Code Duplication
                if (isset($data['id']) && array_key_exists($data['id'], $this->keyMap)) {
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...
191 61
                    $entity = $this->entities[$this->keyMap[$data['id']]];
192 61
                    $entity->update($data);
193
                } else {
194 61
                    $entity = $this->createInstance($data);
195
                }
196 61
                if ($oneItem) {
197 61
                    return $this->findCache[$findKey] = $entity;
198
                }
199 14
                $result[] = $entity;
200
            }
201
        }
202 61
        if (!$oneItem) {
203 17
            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...
204
        }
205 61
    }
206
207
    /**
208
     * @return Entity
209
     */
210 61
    public function knows(Contracts\Entity $entity)
211
    {
212 61
        return in_array($entity, $this->entities);
213
    }
214
215 7
    public function remove(Contracts\Entity $entity)
216
    {
217 7
        unset($this->entities[$this->keyMap[$entity->id]]);
218 7
        unset($this->keyMap[$entity->id]);
219 7
        $this->flushCache();
220
221 7
        $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...
222 7
    }
223
224 1
    public function removeAll()
225
    {
226 1
        foreach ($this->find([]) as $entity) {
0 ignored issues
show
Bug introduced by
The expression $this->find(array()) of type object<Tarantool\Mapper\...pper\Contracts\Entity>> 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...
227 1
            $this->remove($entity);
228
        }
229 1
        $this->flushCache();
230 1
    }
231
232 61
    public function flushCache()
233
    {
234 61
        $this->findCache = [];
235 61
    }
236
237 61
    public function save(Contracts\Entity $entity)
238
    {
239 61
        if (!$this->knows($entity)) {
240 1
            throw new LogicException('Entity is not related with this repository');
241
        }
242
243 61
        if (!$entity->getId()) {
244 61
            $this->generateId($entity);
245 61
            $tuple = $this->type->getCompleteTuple($entity->toArray());
246 61
            $this->type->getSpace()->insert($tuple);
247
        } else {
248 18
            $array = $entity->toArray(false);
249 18
            $changes = [];
250 18
            $id = $entity->getId();
251 18
            if (!array_key_exists($id, $this->original)) {
252
                $changes = $array;
253
            } else {
254 18
                foreach ($array as $k => $v) {
255 18
                    if (!array_key_exists($k, $this->original[$id])) {
256 3
                        $changes[$k] = $v;
257 18
                    } elseif ($v !== $this->original[$id][$k]) {
258 18
                        $changes[$k] = $v;
259
                    }
260
                }
261
            }
262
263 18
            foreach ($changes as $k => $v) {
264 18 View Code Duplication
                if (!$this->type->hasProperty($k)) {
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...
265 1
                    $name = $this->type->getName();
266 18
                    throw new Exception("Unknown property $name.$k");
267
                }
268
            }
269
270 17
            if (count($changes)) {
271 17
                $operations = [];
272 17
                foreach ($this->type->getTuple($changes) as $key => $value) {
273 17
                    $operations[] = ['=', $key, $value];
274
                }
275
                try {
276 17
                    $result = $this->type->getSpace()->update($id, $operations);
277 16
                    $current = $this->type->fromTuple($result->getData()[0]);
278 16
                    $this->original[$id] = $current;
279 16
                    $entity->update($current);
280 1
                } catch (Exception $e) {
281 1
                    $this->type->getSpace()->delete([$id]);
282 1
                    $tuple = $this->type->getCompleteTuple($entity->toArray());
283 1
                    $this->type->getSpace()->insert($tuple);
284
                }
285 17
                $this->original[$id] = $entity->toArray();
286
            }
287
        }
288
289 61
        $this->flushCache();
290
291 61
        return $entity;
292
    }
293
294 61
    private function register(Contracts\Entity $entity)
295
    {
296 61
        if (!$this->knows($entity)) {
297 61
            $this->entities[] = $entity;
298
        }
299 61
        if ($entity->getId() && !array_key_exists($entity->getId(), $this->keyMap)) {
300 61
            $this->keyMap[$entity->getId()] = array_search($entity, $this->entities);
301
        }
302
303 61
        if ($entity->getId()) {
304 61
            $this->original[$entity->getId()] = $entity->toArray();
305
        }
306
307 61
        return $entity;
308
    }
309
310 61
    private function generateId(Contracts\Entity $entity)
311
    {
312 61
        $manager = $this->type->getManager();
313 61
        $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...
314 61
        $spaceId = $this->type->getSpaceId();
315
316 61
        $sequence = $manager->get('sequence')->oneBySpace($spaceId);
317 61
        if (!$sequence) {
318 61
            $sequence = $manager->get('sequence')->create([
319 61
                'space' => $spaceId,
320 61
                'value' => 0,
321
            ]);
322 61
            $manager->save($sequence);
323
        }
324
325 61
        $nextValue = +$manager->getMeta()
326 61
            ->get('sequence')
327 61
            ->getSpace()
328 61
            ->update($sequence->id, [['+', 2, 1]])
329 61
            ->getData()[0][2];
330
331 61
        $entity->setId($nextValue);
332
333 61
        $this->register($entity);
334
335 61
        return $entity;
336
    }
337
338 61
    public function getType()
339
    {
340 61
        return $this->type;
341
    }
342
343 3
    public function evaluate($query)
344
    {
345 3
        $result = [];
346 3
        $tuples = $this->type->getManager()->getClient()->evaluate($query)->getData()[0];
347 3
        foreach ($tuples as $tuple) {
348 2
            $data = $this->type->fromTuple($tuple);
349 2 View Code Duplication
            if (isset($data['id']) && array_key_exists($data['id'], $this->keyMap)) {
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...
350 2
                $entity = $this->entities[$this->keyMap[$data['id']]];
351 2
                $entity->update($data);
352
            } else {
353
                $entity = $this->createInstance($data);
354
            }
355 2
            $result[] = $entity;
356
        }
357
358 3
        return $result;
359
    }
360
}
361