Repository::removeAll() - Code Metrics - Inspection of "add entity property filter" - tarantool-php/mapper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( da0edd...b0984e )

by Dmitry

created 2016-05-14 15:56 UTC

Repository::removeAll() A

↳ Parent: Repository

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

<?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);
        }

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

tarantool-php / mapper

Push — master ( da0edd...b0984e )

Repository::removeAll() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like