Repository::flushCache() - Code Metrics - Inspection of "type casting for entities" - tarantool-php/mapper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b0984e...c79602 )

by Dmitry

created 2016-05-14 18:15 UTC

Repository::flushCache() A

↳ Parent: Repository

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	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

namespace Tarantool\Mapper;

use BadMethodCallException;
use Exception;
use LogicException;

class Repository implements Contracts\Repository
{
    private $type;
    private $entities = [];
    private $keyMap = [];
    private $findCache = [];
    private $original = [];

    private $magicMethodRules = [
        'by' => false,
        'firstBy' => true,
        'oneBy' => true,
    ];

    public function __construct(Contracts\Type $type)
    {
        $this->type = $type;
    }

    public function create($params = null)
    {
        if ($params && !is_array($params)) {
            $params = [$params];
        }

        if (!is_array($params)) {
            $params = [];
        }

        $data = [];
        foreach ($params as $k => $v) {
            if (is_numeric($k)) {
                if ($v instanceof Contracts\Entity) {
                    $type = $this->type->getManager()->findRepository($v)->getType();
                    $k = $this->type->getReferenceProperty($type);
                } else {
                    $primitive = [];
                    foreach ($this->type->getProperties() as $property) {
                        if (!$this->type->isReference($property)) {
                            $primitive[] = $property;
                        }
                    }
                    if (count($primitive) == 2) {
                        $k = $primitive[1];
                    } else {
                        throw new Exception("Can't calculate key name");
                    }
                }
            }
            if (!$this->type->hasProperty($k)) {

                $name = $this->type->getName();
                throw new Exception("Unknown property $name.$k");
            }
            $data[$k] = $this->type->encodeProperty($k, $v);
        }
        foreach ($this->type->getRequiredProperties() as $property) {
            if (!array_key_exists($property, $data)) {
                $convention = $this->type->getManager()->getMeta()->getConvention();
                $propertyType = $this->type->getPropertyType($property);
                $data[$property] = $convention->getDefaultValue($propertyType);
            }
        }

        $this->flushCache();

        return $this->createInstance($data);
    }

    private function createInstance($data)
    {
        $class = $this->getType()->getEntityClass();

        return $this->register(new $class($data));
    }

    public function __call($method, $arguments)
    {
        foreach ($this->magicMethodRules as $prefix => $oneItem) {
            if (substr($method, 0, strlen($prefix)) == $prefix) {
                $tail = substr($method, strlen($prefix));
                $fields = array_map('strtolower', explode('And', $tail));

                return $this->find(array_combine($fields, $arguments), $oneItem);
            }
        }

        throw new BadMethodCallException("Method $method not found");
    }

    public function findOne($params)
    {
        return $this->find($params, true);

    }

    public function find($params = [], $oneItem = false)
    {
        $query = [];

        if (is_string($params) && 1 * $params == $params) {
            $params = 1 * $params;
        }

        if (is_int($params)) {
            if (isset($this->keyMap[$params])) {
                return $this->entities[$this->keyMap[$params]];
            }
            $query = [
                'id' => $params,
            ];
            $oneItem = true;
        }

        if ($params instanceof Contracts\Entity) {
            $params = [$params];
        }

        if (is_array($params)) {
            foreach ($params as $key => $value) {
                if (is_numeric($key) && $value instanceof Contracts\Entity) {
                    $type = $this->type->getManager()->findRepository($value)->getType();
                    $key = $this->type->getReferenceProperty($type);
                }
                if ($this->type->hasProperty($key)) {
                    $query[$key] = $this->type->encodeProperty($key, $value);
                }
            }
        }

        $findKey = md5(json_encode($query).($oneItem ? 'x' : ''));
        if (array_key_exists($findKey, $this->findCache)) {
            return $this->findCache[$findKey];
        }

        $index = $this->type->findIndex(array_keys($query));
        if (!is_numeric($index)) {
            throw new Exception('No index found for '.json_encode(array_keys($query)));
        }

        $values = count($query) ? $this->type->getIndexTuple($index, $query) : [];
        $data = $this->type->getSpace()->select($values, $index);

        $result = [];
        if (!empty($data->getData())) {
            foreach ($data->getData() as $tuple) {
                $data = $this->type->fromTuple($tuple);
                if (isset($data['id']) && array_key_exists($data['id'], $this->keyMap)) {
                    $entity = $this->entities[$this->keyMap[$data['id']]];
                    $entity->update($data);
                } else {
                    $entity = $this->createInstance($data);
                }
                if ($oneItem) {
                    return $this->findCache[$findKey] = $entity;
                }
                $result[] = $entity;
            }
        }
        if (!$oneItem) {
            return $this->findCache[$findKey] = $result;
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());
}
        }
    }

    /**
     * @return Entity
     */
    public function knows(Contracts\Entity $entity)
    {
        return in_array($entity, $this->entities);
    }

    public function remove(Contracts\Entity $entity)
    {
        unset($this->entities[$this->keyMap[$entity->id]]);
        unset($this->keyMap[$entity->id]);
        $this->flushCache();

        $this->type->getSpace()->delete([$entity->id]);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }

    public function removeAll()
    {
        foreach ($this->find([]) as $entity) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $this->remove($entity);
        }
        $this->flushCache();
    }

    public function flushCache()
    {
        $this->findCache = [];
    }

    public function save(Contracts\Entity $entity)
    {
        if (!$this->knows($entity)) {
            throw new LogicException('Entity is not related with this repository');
        }

        if (!$entity->getId()) {
            $this->generateId($entity);
            $tuple = $this->type->getCompleteTuple($entity->toArray());
            $this->type->getSpace()->insert($tuple);
        } else {
            $array = $entity->toArray(false);
            $changes = [];
            $id = $entity->getId();
            if (!array_key_exists($id, $this->original)) {
                $changes = $array;
            } else {
                foreach ($array as $k => $v) {
                    if (!array_key_exists($k, $this->original[$id])) {
                        $changes[$k] = $v;
                    } elseif ($v !== $this->original[$id][$k]) {
                        $changes[$k] = $v;
                    }
                }
            }

            foreach ($changes as $k => $v) {
                if (!$this->type->hasProperty($k)) {

                    $name = $this->type->getName();
                    throw new Exception("Unknown property $name.$k");
                }
            }

            if (count($changes)) {
                $operations = [];
                foreach ($this->type->getTuple($changes) as $key => $value) {
                    $operations[] = ['=', $key, $value];
                }
                try {
                    $result = $this->type->getSpace()->update($id, $operations);
                    $current = $this->type->fromTuple($result->getData()[0]);
                    $this->original[$id] = $current;
                    $entity->update($current);
                } catch (Exception $e) {
                    $this->type->getSpace()->delete([$id]);
                    $tuple = $this->type->getCompleteTuple($entity->toArray());
                    $this->type->getSpace()->insert($tuple);
                }
                $this->original[$id] = $entity->toArray();
            }
        }

        return $entity;
    }

    private function register(Contracts\Entity $entity)
    {
        if (!$this->knows($entity)) {
            $this->entities[] = $entity;
        }
        if ($entity->getId() && !array_key_exists($entity->getId(), $this->keyMap)) {
            $this->keyMap[$entity->getId()] = array_search($entity, $this->entities);
        }

        if ($entity->getId()) {
            $this->original[$entity->getId()] = $entity->toArray();
        }

        return $entity;
    }

    private function generateId(Contracts\Entity $entity)
    {
        $manager = $this->type->getManager();
        $name = $this->type->getName();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $spaceId = $this->type->getSpaceId();

        $sequence = $manager->get('sequence')->oneBySpace($spaceId);
        if (!$sequence) {
            $sequence = $manager->get('sequence')->create([
                'space' => $spaceId,
                'value' => 0,
            ]);
            $manager->save($sequence);
        }

        $nextValue = +$manager->getMeta()
            ->get('sequence')
            ->getSpace()
            ->update($sequence->id, [['+', 2, 1]])
            ->getData()[0][2];

        $entity->setId($nextValue);

        $this->register($entity);

        return $entity;
    }

    public function getType()
    {
        return $this->type;
    }
}


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	55		public function __construct(Contracts\Type $type)
24			{
25	55		$this->type = $type;
26	55		}
27
28	55		public function create($params = null)
29			{
30	55		if ($params && !is_array($params)) {
31	55		$params = [$params];
32			}
33
34	55		if (!is_array($params)) {
35	1		$params = [];
36			}
37
38	55		$data = [];
39	55		foreach ($params as $k => $v) {
40	55		if (is_numeric($k)) {
41	55		if ($v instanceof Contracts\Entity) {
42	4		$type = $this->type->getManager()->findRepository($v)->getType();
43	4		$k = $this->type->getReferenceProperty($type);
44			} else {
45	55		$primitive = [];
46	55		foreach ($this->type->getProperties() as $property) {
47	55		if (!$this->type->isReference($property)) {
48	55		$primitive[] = $property;
49			}
50			}
51	55		if (count($primitive) == 2) {
52	55		$k = $primitive[1];
53			} else {
54	1		throw new Exception("Can't calculate key name");
55			}
56			}
57			}
58	55	View Code Duplication	if (!$this->type->hasProperty($k)) {
			0 ignored issues – show Duplication introduced 2016-05-14 15:59 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...
59	2		$name = $this->type->getName();
60	2		throw new Exception("Unknown property $name.$k");
61			}
62	55		$data[$k] = $this->type->encodeProperty($k, $v);
63			}
64	55		foreach ($this->type->getRequiredProperties() as $property) {
65	55		if (!array_key_exists($property, $data)) {
66	55		$convention = $this->type->getManager()->getMeta()->getConvention();
67	55		$propertyType = $this->type->getPropertyType($property);
68	55		$data[$property] = $convention->getDefaultValue($propertyType);
69			}
70			}
71
72	55		$this->flushCache();
73
74	55		return $this->createInstance($data);
75			}
76
77	55		private function createInstance($data)
78			{
79	55		$class = $this->getType()->getEntityClass();
80
81	55		return $this->register(new $class($data));
82			}
83
84	55		public function __call($method, $arguments)
85			{
86	55		foreach ($this->magicMethodRules as $prefix => $oneItem) {
87	55		if (substr($method, 0, strlen($prefix)) == $prefix) {
88	55		$tail = substr($method, strlen($prefix));
89	55		$fields = array_map('strtolower', explode('And', $tail));
90
91	55		return $this->find(array_combine($fields, $arguments), $oneItem);
92			}
93			}
94
95	1		throw new BadMethodCallException("Method $method not found");
96			}
97
98	16		public function findOne($params)
99			{
100	16		return $this->find($params, true);
			0 ignored issues – show Bug Compatibility introduced 2016-04-04 18:16 UTC by Report Bug Copy Issue Report 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	55		public function find($params = [], $oneItem = false)
104			{
105	55		$query = [];
106
107	55		if (is_string($params) && 1 * $params == $params) {
108	1		$params = 1 * $params;
109			}
110
111	55		if (is_int($params)) {
112	9		if (isset($this->keyMap[$params])) {
113	3		return $this->entities[$this->keyMap[$params]];
114			}
115			$query = [
116	6		'id' => $params,
117			];
118	6		$oneItem = true;
119			}
120
121	55		if ($params instanceof Contracts\Entity) {
122	2		$params = [$params];
123			}
124
125	55		if (is_array($params)) {
126	55		foreach ($params as $key => $value) {
127	55		if (is_numeric($key) && $value instanceof Contracts\Entity) {
128	2		$type = $this->type->getManager()->findRepository($value)->getType();
129	2		$key = $this->type->getReferenceProperty($type);
130			}
131	55		if ($this->type->hasProperty($key)) {
132	55		$query[$key] = $this->type->encodeProperty($key, $value);
133			}
134			}
135			}
136
137	55		$findKey = md5(json_encode($query).($oneItem ? 'x' : ''));
138	55		if (array_key_exists($findKey, $this->findCache)) {
139	55		return $this->findCache[$findKey];
140			}
141
142	55		$index = $this->type->findIndex(array_keys($query));
143	55		if (!is_numeric($index)) {
144	2		throw new Exception('No index found for '.json_encode(array_keys($query)));
145			}
146
147	55		$values = count($query) ? $this->type->getIndexTuple($index, $query) : [];
148	55		$data = $this->type->getSpace()->select($values, $index);
149
150	55		$result = [];
151	55		if (!empty($data->getData())) {
152	55		foreach ($data->getData() as $tuple) {
153	55		$data = $this->type->fromTuple($tuple);
154	55		if (isset($data['id']) && array_key_exists($data['id'], $this->keyMap)) {
155	55		$entity = $this->entities[$this->keyMap[$data['id']]];
156	55		$entity->update($data);
157			} else {
158	55		$entity = $this->createInstance($data);
159			}
160	55		if ($oneItem) {
161	55		return $this->findCache[$findKey] = $entity;
162			}
163	13		$result[] = $entity;
164			}
165			}
166	55		if (!$oneItem) {
167	16		return $this->findCache[$findKey] = $result;
			0 ignored issues – show Bug Best Practice introduced 2016-04-07 17:41 UTC by Report Bug Copy Issue Report 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...
168			}
169	55		}
170
171			/**
172			* @return Entity
173			*/
174	55		public function knows(Contracts\Entity $entity)
175			{
176	55		return in_array($entity, $this->entities);
177			}
178
179	7		public function remove(Contracts\Entity $entity)
180			{
181	7		unset($this->entities[$this->keyMap[$entity->id]]);
182	7		unset($this->keyMap[$entity->id]);
183	7		$this->flushCache();
184
185	7		$this->type->getSpace()->delete([$entity->id]);
			0 ignored issues – show Bug introduced 2016-04-04 18:16 UTC by Report Bug Copy Issue Report 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 Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
186	7		}
187
188	1		public function removeAll()
189			{
190	1		foreach ($this->find([]) as $entity) {
			0 ignored issues – show Bug introduced 2016-04-18 08:35 UTC by Report Bug Copy Issue Report 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. 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...
191	1		$this->remove($entity);
192			}
193	1		$this->flushCache();
194	1		}
195
196	55		public function flushCache()
197			{
198	55		$this->findCache = [];
199	55		}
200
201	55		public function save(Contracts\Entity $entity)
202			{
203	55		if (!$this->knows($entity)) {
204	1		throw new LogicException('Entity is not related with this repository');
205			}
206
207	55		if (!$entity->getId()) {
208	55		$this->generateId($entity);
209	55		$tuple = $this->type->getCompleteTuple($entity->toArray());
210	55		$this->type->getSpace()->insert($tuple);
211			} else {
212	15		$array = $entity->toArray(false);
213	15		$changes = [];
214	15		$id = $entity->getId();
215	15		if (!array_key_exists($id, $this->original)) {
216			$changes = $array;
217			} else {
218	15		foreach ($array as $k => $v) {
219	15		if (!array_key_exists($k, $this->original[$id])) {
220	3		$changes[$k] = $v;
221	15		} elseif ($v !== $this->original[$id][$k]) {
222	15		$changes[$k] = $v;
223			}
224			}
225			}
226
227	15		foreach ($changes as $k => $v) {
228	15	View Code Duplication	if (!$this->type->hasProperty($k)) {
			0 ignored issues – show Duplication introduced 2016-05-14 15:59 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...
229	1		$name = $this->type->getName();
230	15		throw new Exception("Unknown property $name.$k");
231			}
232			}
233
234	14		if (count($changes)) {
235	14		$operations = [];
236	14		foreach ($this->type->getTuple($changes) as $key => $value) {
237	14		$operations[] = ['=', $key, $value];
238			}
239			try {
240	14		$result = $this->type->getSpace()->update($id, $operations);
241	13		$current = $this->type->fromTuple($result->getData()[0]);
242	13		$this->original[$id] = $current;
243	13		$entity->update($current);
244	1		} catch (Exception $e) {
245	1		$this->type->getSpace()->delete([$id]);
246	1		$tuple = $this->type->getCompleteTuple($entity->toArray());
247	1		$this->type->getSpace()->insert($tuple);
248			}
249	14		$this->original[$id] = $entity->toArray();
250			}
251			}
252
253	55		return $entity;
254			}
255
256	55		private function register(Contracts\Entity $entity)
257			{
258	55		if (!$this->knows($entity)) {
259	55		$this->entities[] = $entity;
260			}
261	55		if ($entity->getId() && !array_key_exists($entity->getId(), $this->keyMap)) {
262	55		$this->keyMap[$entity->getId()] = array_search($entity, $this->entities);
263			}
264
265	55		if ($entity->getId()) {
266	55		$this->original[$entity->getId()] = $entity->toArray();
267			}
268
269	55		return $entity;
270			}
271
272	55		private function generateId(Contracts\Entity $entity)
273			{
274	55		$manager = $this->type->getManager();
275	55		$name = $this->type->getName();
			0 ignored issues – show Unused Code introduced 2016-04-04 18:16 UTC by Report Bug Copy Issue Report `$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...
276	55		$spaceId = $this->type->getSpaceId();
277
278	55		$sequence = $manager->get('sequence')->oneBySpace($spaceId);
279	55		if (!$sequence) {
280	55		$sequence = $manager->get('sequence')->create([
281	55		'space' => $spaceId,
282	55		'value' => 0,
283			]);
284	55		$manager->save($sequence);
285			}
286
287	55		$nextValue = +$manager->getMeta()
288	55		->get('sequence')
289	55		->getSpace()
290	55		->update($sequence->id, [['+', 2, 1]])
291	55		->getData()[0][2];
292
293	55		$entity->setId($nextValue);
294
295	55		$this->register($entity);
296
297	55		return $entity;
298			}
299
300	55		public function getType()
301			{
302	55		return $this->type;
303			}
304			}
305

tarantool-php / mapper

Push — master ( b0984e...c79602 )

Repository::flushCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like