Repository::__construct() - Code Metrics - Inspection of "meta rollback feature implemented" - tarantool-php/mapper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d4316...84d771 )

by Dmitry

created 2016-04-17 16:57 UTC

Repository::__construct() 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	0

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

<?php

namespace Tarantool\Mapper;

use BadMethodCallException;
use LogicException;

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

    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];
        }

        $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)) {
                throw new \Exception("Unknown property $k");
            }
            $data[$k] = $this->type->encodeProperty($k, $v);
        }

        return $this->register(new Entity($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));
        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 = new Entity($data);
                    $this->register($entity);
                }
                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->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 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 {
            $changes = $entity->pullChanges();
            if (count($changes)) {
                $operations = [];
                foreach ($this->type->getTuple($changes) as $key => $value) {
                    $operations[] = ['=', $key, $value];
                }
                try {
                    $this->type->getSpace()->update($entity->getId(), $operations);
                } catch (\Exception $e) {
                    $this->type->getSpace()->delete([$entity->getId()]);
                    $tuple = $this->type->getCompleteTuple($entity->toArray());
                    $this->type->getSpace()->insert($tuple);
                }
            }
        }

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

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

tarantool-php / mapper

Push — master ( 6d4316...84d771 )

Repository::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like