Completed
Push — master ( e4f138...166bf0 )
by Dmitry
02:54
created

Repository::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 3
cts 3
cp 1
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
crap 1
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 62
    public function __construct(Contracts\Type $type)
24
    {
25 62
        $this->type = $type;
26 62
    }
27
28 62
    public function create($params = null)
29
    {
30 62
        if ($params && !is_array($params)) {
31 62
            $params = [$params];
32
        }
33
34 62
        if (!is_array($params)) {
35 2
            $params = [];
36
        }
37
38 62
        $data = [];
39 62
        foreach ($params as $k => $v) {
40 62
            if (is_numeric($k)) {
41 62
                if ($v instanceof Contracts\Entity) {
42 4
                    $type = $this->type->getManager()->findRepository($v)->getType();
43 4
                    $k = $this->type->getReferenceProperty($type);
44
                } else {
45 62
                    $primitive = [];
46 62
                    foreach ($this->type->getProperties() as $property) {
47 62
                        if (!$this->type->isReference($property)) {
48 62
                            $primitive[] = $property;
49
                        }
50
                    }
51 62
                    if (count($primitive) == 2) {
52 62
                        $k = $primitive[1];
53
                    } else {
54 1
                        throw new Exception("Can't calculate key name");
55
                    }
56
                }
57
            }
58 62 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 62
            $data[$k] = $this->type->encodeProperty($k, $v);
63
        }
64 62
        foreach ($this->type->getRequiredProperties() as $property) {
65 62
            if (!array_key_exists($property, $data)) {
66 62
                $convention = $this->type->getManager()->getMeta()->getConvention();
67 62
                $propertyType = $this->type->getPropertyType($property);
68 62
                $data[$property] = $convention->getDefaultValue($propertyType);
69
            }
70
        }
71
72 62
        $this->flushCache();
73
74 62
        return $this->createInstance($data);
75
    }
76
77 62
    private function createInstance($data)
78
    {
79 62
        $class = $this->getType()->getEntityClass();
80
81 62
        return $this->register(new $class($data));
82
    }
83
84 62
    public function __call($method, $arguments)
85
    {
86 62
        foreach ($this->magicMethodRules as $prefix => $oneItem) {
87 62
            if (substr($method, 0, strlen($prefix)) == $prefix) {
88 62
                $tail = substr($method, strlen($prefix));
89 62
                $fields = array_map('strtolower', explode('And', $tail));
90
91 62
                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 62
    public function find($params = [], $oneItem = false)
104
    {
105 62
        $query = [];
106
107 62
        if (is_string($params) && 1 * $params == $params) {
108 1
            $params = 1 * $params;
109
        }
110
111 62
        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 62
        if ($params instanceof Contracts\Entity) {
122 2
            $params = [$params];
123
        }
124
125 62
        $reject = [];
126 62
        if (is_array($params)) {
127
128 62
            foreach($params as $key => $value) {
129 62
                if(is_string($value)) {
130 17
                    if(substr($value, 0, 1) == '!') {
131 62
                        $reject[$key] = substr($value, 1);
132
                    }
133
                }
134
            }
135 62
            foreach(array_keys($reject) as $key) {
136 1
                unset($params[$key]);
137
            }
138
139 62
            foreach ($params as $key => $value) {
140 62
                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 62
                if ($this->type->hasProperty($key)) {
145 62
                    $query[$key] = $this->type->encodeProperty($key, $value);
146
                } else {
147 1
                    $name = $this->getType()->getName();
148 62
                    throw new Exception("Unknown property $name.$key");
149
                }
150
            }
151
        }
152
153 62
        $findKey = md5(json_encode([$query, $reject]).($oneItem ? 'x' : ''));
154 62
        if (array_key_exists($findKey, $this->findCache)) {
155 62
            return $this->findCache[$findKey];
156
        }
157
158 62
        $index = $this->type->findIndex(array_keys($query));
159 62
        if (!is_numeric($index)) {
160 2
            throw new Exception('No index found for '.json_encode(array_keys($query)));
161
        }
162
163 62
        $values = count($query) ? $this->type->getIndexTuple($index, $query) : [];
164
165 62
        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 62
        $data = $this->type->getSpace()->select($values, $index);
185
186 62
        $result = [];
187 62
        if (!empty($data->getData())) {
188 62
            foreach ($data->getData() as $tuple) {
189 62
                $data = $this->type->fromTuple($tuple);
190 62 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 62
                    $entity = $this->entities[$this->keyMap[$data['id']]];
192 62
                    $entity->update($data);
193
                } else {
194 62
                    $entity = $this->createInstance($data);
195
                }
196 62
                if ($oneItem) {
197 62
                    return $this->findCache[$findKey] = $entity;
198
                }
199 14
                $result[] = $entity;
200
            }
201
        }
202 62
        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 62
    }
206
207
    /**
208
     * @return Entity
209
     */
210 62
    public function knows(Contracts\Entity $entity)
211
    {
212 62
        return array_key_exists(spl_object_hash($entity), $this->entities);
213
    }
214
215 6
    public function remove(Contracts\Entity $entity)
216
    {
217 6
        unset($this->entities[$this->keyMap[$entity->id]]);
218 6
        unset($this->keyMap[$entity->id]);
219 6
        $this->flushCache();
220
221 6
        $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 6
    }
223
224 1
    public function removeAll()
225
    {
226 1
        $space = $this->type->getSpace();
227 1
        foreach($space->select([])->getData() as $row) {
228 1
            $space->delete([$row[0]]);
229
        }
230 1
        $this->flushCache();
231 1
    }
232
233 62
    public function flushCache()
234
    {
235 62
        $this->findCache = [];
236 62
    }
237
238 62
    public function save(Contracts\Entity $entity)
239
    {
240 62
        if (!$this->knows($entity)) {
241 1
            throw new LogicException('Entity is not related with this repository');
242
        }
243
244 62
        if (!$entity->getId()) {
245 62
            $this->generateId($entity);
246 62
            $tuple = $this->type->getCompleteTuple($entity->toArray());
247 62
            $this->type->getSpace()->insert($tuple);
248
        } else {
249 19
            $array = $entity->toArray(false);
250 19
            $changes = [];
251 19
            $id = $entity->getId();
252 19
            if (!array_key_exists($id, $this->original)) {
253
                $changes = $array;
254
            } else {
255 19
                foreach ($array as $k => $v) {
256 19
                    if (!array_key_exists($k, $this->original[$id])) {
257 4
                        $changes[$k] = $v;
258 19
                    } elseif ($v !== $this->original[$id][$k]) {
259 19
                        $changes[$k] = $v;
260
                    }
261
                }
262
            }
263
264 19
            foreach ($changes as $k => $v) {
265 19 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...
266 1
                    $name = $this->type->getName();
267 19
                    throw new Exception("Unknown property $name.$k");
268
                }
269
            }
270
271 18
            if (count($changes)) {
272 18
                $operations = [];
273 18
                foreach ($this->type->getTuple($changes) as $key => $value) {
274 18
                    $operations[] = ['=', $key, $value];
275
                }
276
                try {
277 18
                    $result = $this->type->getSpace()->update($id, $operations);
278 17
                    $current = $this->type->fromTuple($result->getData()[0]);
279 17
                    $this->original[$id] = $current;
280 17
                    $entity->update($current);
281 1
                } catch (Exception $e) {
282 1
                    $this->type->getSpace()->delete([$id]);
283 1
                    $tuple = $this->type->getCompleteTuple($entity->toArray());
284 1
                    $this->type->getSpace()->insert($tuple);
285
                }
286 18
                $this->original[$id] = $entity->toArray();
287
            }
288
        }
289
290 62
        $this->flushCache();
291
292 62
        return $entity;
293
    }
294
295 62
    private function register(Contracts\Entity $entity)
296
    {
297 62
        if (!$this->knows($entity)) {
298 62
            $this->entities[spl_object_hash($entity)] = $entity;
299
        }
300 62
        if ($entity->getId() && !array_key_exists($entity->getId(), $this->keyMap)) {
301 62
            $this->keyMap[$entity->getId()] = spl_object_hash($entity);
302
        }
303
304 62
        if ($entity->getId()) {
305 62
            $this->original[$entity->getId()] = $entity->toArray();
306
        }
307
308 62
        return $entity;
309
    }
310
311 62
    private function generateId(Contracts\Entity $entity)
312
    {
313 62
        $manager = $this->type->getManager();
314 62
        $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...
315 62
        $spaceId = $this->type->getSpaceId();
316
317 62
        $sequence = $manager->get('sequence')->oneBySpace($spaceId);
318 62
        if (!$sequence) {
319 62
            $sequence = $manager->get('sequence')->create([
320 62
                'space' => $spaceId,
321 62
                'value' => 0,
322
            ]);
323 62
            $manager->save($sequence);
324
        }
325
326 62
        $nextValue = +$manager->getMeta()
327 62
            ->get('sequence')
328 62
            ->getSpace()
329 62
            ->update($sequence->id, [['+', 2, 1]])
330 62
            ->getData()[0][2];
331
332 62
        $entity->setId($nextValue);
333
334 62
        $this->register($entity);
335
336 62
        return $entity;
337
    }
338
339 62
    public function getType()
340
    {
341 62
        return $this->type;
342
    }
343
344 3
    public function evaluate($query)
345
    {
346 3
        $result = [];
347 3
        $tuples = $this->type->getManager()->getClient()->evaluate($query)->getData()[0];
348 3
        foreach ($tuples as $tuple) {
349 2
            $data = $this->type->fromTuple($tuple);
350 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...
351 2
                $entity = $this->entities[$this->keyMap[$data['id']]];
352 2
                $entity->update($data);
353
            } else {
354
                $entity = $this->createInstance($data);
355
            }
356 2
            $result[] = $entity;
357
        }
358
359 3
        return $result;
360
    }
361
}
362