Xhgui_Searcher_Mongo - Code Metrics - Inspection of "WIP: Backend decoupling" - perftools/xhgui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#244)

by Marcel

created 2018-07-13 21:06 UTC

Xhgui_Searcher_Mongo A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	326
Duplicated Lines	0.92 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

Metric	Value
wmc	37
lcom	2
cbo	2
dl	3
loc	326
rs	9.44
c	0
b	0
f	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	latest()	0	8	1
A	query()	0	7	1
A	get()	0	6	1
A	getForUrl()	0	11	1
B	getPercentileForUrl()	3	72	8
B	getAvgsForUrl()	0	39	5
A	getAll()	0	4	1
A	delete()	0	4	1
A	truncate()	0	4	1
A	getAllWatches()	0	5	1
A	truncateWatches()	0	4	1
B	paginate()	0	44	5
A	_wrap()	0	15	4
A	saveWatch()	0	31	5

How to fix Duplicated Code

<?php

/**
 * A Searcher for a MongoDB backend.
 */
class Xhgui_Searcher_Mongo implements Xhgui_Searcher_Interface
namespace YourVendor;

class YourClass { }
{
    protected $_collection;

    protected $_watches;

    protected $_mapper;

    public function __construct(MongoDb $db)
    {
        $this->_collection = $db->results;

        $this->_watches = $db->watches;

        $this->_mapper = new Xhgui_Db_Mapper();
    }

    /**
     * {@inheritdoc}
     */
    public function latest()
    {
        $cursor = $this->_collection->find()
            ->sort(array('meta.request_date' => -1))
            ->limit(1);
        $result = $cursor->getNext();
        return $this->_wrap($result);

    }

    /**
     * {@inheritdoc}
     */
    public function query($conditions, $limit, $fields = [])
    {
        $result = $this->_collection->find($conditions, $fields)
            ->limit($limit);

        return iterator_to_array($result);
    }

    /**
     * {@inheritdoc}
     */
    public function get($id)
    {
        return $this->_wrap($this->_collection->findOne(array(

            '_id' => new MongoId($id)
        )));
    }

    /**
     * {@inheritdoc}
     */
    public function getForUrl($url, $options, $conditions = [])
    {
        $conditions = array_merge(
            (array)$conditions,
            array('simple_url' => $url)
        );
        $options = array_merge($options, array(
            'conditions' => $conditions,
        ));
        return $this->paginate($options);
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function getPercentileForUrl($percentile, $url, $search = [])
    {
        $result = $this->_mapper->convert(array(
            'conditions' => $search + array('simple_url' => $url)
        ));
        $match = $result['conditions'];

        $col = '$meta.request_date';
        if (!empty($search['limit']) && $search['limit'][0] == "P") {

            $col = '$meta.request_ts';
        }

        $results = $this->_collection->aggregate(array(
            array('$match' => $match),
            array(
                '$project' => array(
                    'date' => $col,
                    'profile.main()' => 1
                )
            ),
            array(
                '$group' => array(
                    '_id' => '$date',
                    'row_count' => array('$sum' => 1),
                    'wall_times' => array('$push' => '$profile.main().wt'),
                    'cpu_times' => array('$push' => '$profile.main().cpu'),
                    'mu_times' => array('$push' => '$profile.main().mu'),
                    'pmu_times' => array('$push' => '$profile.main().pmu'),
                )
            ),
            array(
                '$project' => array(
                    'date' => '$date',
                    'row_count' => '$row_count',
                    'raw_index' => array(
                        '$multiply' => array(
                            '$row_count',
                            $percentile / 100
                        )
                    ),
                    'wall_times' => '$wall_times',
                    'cpu_times' => '$cpu_times',
                    'mu_times' => '$mu_times',
                    'pmu_times' => '$pmu_times',
                )
            ),
            array('$sort' => array('_id' => 1)),
            ),
            array('cursor' => array('batchSize' => 0))
        );

        if (empty($results['result'])) {
            return [];
        }
        $keys = array(
            'wall_times' => 'wt',
            'cpu_times' => 'cpu',
            'mu_times' => 'mu',
            'pmu_times' => 'pmu'
        );
        foreach ($results['result'] as &$result) {
            $result['date'] = ($result['_id'] instanceof MongoDate) ? date('Y-m-d H:i:s', $result['_id']->sec) : $result['_id'];
            unset($result['_id']);
            $index = max(round($result['raw_index']) - 1, 0);
            foreach ($keys as $key => $out) {
                sort($result[$key]);
                $result[$out] = isset($result[$key][$index]) ? $result[$key][$index] : null;
                unset($result[$key]);
            }
        }
        return $results['result'];
    }

    /**
     * {@inheritdoc}
     */
    public function getAvgsForUrl($url, $search = [])
    {
        $match = array('meta.simple_url' => $url);
        if (isset($search['date_start'])) {
            $match['meta.request_date']['$gte'] = (string)$search['date_start'];
        }
        if (isset($search['date_end'])) {
            $match['meta.request_date']['$lte'] = (string)$search['date_end'];
        }
        $results = $this->_collection->aggregate(array(
            array('$match' => $match),
            array(
                '$project' => array(
                    'date' => '$meta.request_date',
                    'profile.main()' => 1,
                )
            ),
            array(
                '$group' => array(
                    '_id' => '$date',
                    'avg_wt' => array('$avg' => '$profile.main().wt'),
                    'avg_cpu' => array('$avg' => '$profile.main().cpu'),
                    'avg_mu' => array('$avg' => '$profile.main().mu'),
                    'avg_pmu' => array('$avg' => '$profile.main().pmu'),
                )
            ),
            array('$sort' => array('_id' => 1))
        ),
            array('cursor' => array('batchSize' => 0))
        );
        if (empty($results['result'])) {
            return [];
        }
        foreach ($results['result'] as $i => $result) {
            $results['result'][$i]['date'] = $result['_id'];
            unset($results['result'][$i]['_id']);
        }
        return $results['result'];
    }

    /**
     * {@inheritdoc}
     */
    public function getAll($options = [])
    {
        return $this->paginate($options);
    }

    /**
     * {@inheritdoc}
     */
    public function delete($id)
    {
        $this->_collection->remove(array('_id' => new MongoId($id)), []);
    }

    /**
     * {@inheritdoc}
     */
    public function truncate()
    {
        return $this->_collection->drop();
    }

    /**
     * {@inheritdoc}
     */
    public function saveWatch(array $data)
    {
        if (empty($data['name'])) {
            return false;
        }

        if (!empty($data['removed']) && isset($data['_id'])) {
            $this->_watches->remove(
                array('_id' => new MongoId($data['_id'])),
                array('w' => 1)
            );
            return true;
        }

        if (empty($data['_id'])) {
            $this->_watches->insert(
                $data,
                array('w' => 1)
            );
            return true;
        }


        $data['_id'] = new MongoId($data['_id']);
        $this->_watches->update(
            array('_id' => $data['_id']),
            $data,
            array('w' => 1)
        );
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function getAllWatches()
    {
        $cursor = $this->_watches->find();
        return array_values(iterator_to_array($cursor));
    }

    /**
     * {@inheritdoc}
     */
    public function truncateWatches()
    {
        $this->_watches->drop();
    }

    private function paginate($options)
    {
        $opts = $this->_mapper->convert($options);

        $totalRows = $this->_collection->find(
            $opts['conditions'],
            array('_id' => 1))->count();

        $totalPages = max(ceil($totalRows / $opts['perPage']), 1);
        $page = 1;
        if (isset($options['page'])) {
            $page = min(max($options['page'], 1), $totalPages);
        }

        $projection = false;
        if (isset($options['projection'])) {
            if ($options['projection'] === true) {
                $projection = array('meta' => 1, 'profile.main()' => 1);
            } else {
                $projection = $options['projection'];
            }
        }

        if ($projection === false) {
            $cursor = $this->_collection->find($opts['conditions'])
                ->sort($opts['sort'])
                ->skip((int)($page - 1) * $opts['perPage'])
                ->limit($opts['perPage']);
        } else {
            $cursor = $this->_collection->find($opts['conditions'], $projection)
                ->sort($opts['sort'])
                ->skip((int)($page - 1) * $opts['perPage'])
                ->limit($opts['perPage']);
        }

        return array(
            'results' => $this->_wrap($cursor),
            'sort' => $opts['sort'],
            'direction' => $opts['direction'],
            'page' => $page,
            'perPage' => $opts['perPage'],
            'totalPages' => $totalPages
        );
    }

    /**
     * Converts arrays + MongoCursors into Xhgui_Profile instances.
     *
     * @param array|MongoCursor $data The data to transform.
     *
     * @return Xhgui_Profile[] The transformed/wrapped results.
     */
    protected function _wrap($data)
    {
        if ($data === null) {
            throw new Exception('No profile data found.');
        }

        if (is_array($data)) {
            return new Xhgui_Profile($data);
        }
        $results = [];
        foreach ($data as $row) {
            $results[] = new Xhgui_Profile($row);
        }
        return $results;
    }
}


1		<?php
2
3		/**
4		* A Searcher for a MongoDB backend.
5		*/
6		class Xhgui_Searcher_Mongo implements Xhgui_Searcher_Interface
		0 ignored issues – show Coding Style Compatibility introduced 2016-02-22 04:48 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
7		{
8		protected $_collection;
9
10		protected $_watches;
11
12		protected $_mapper;
13
14		public function __construct(MongoDb $db)
15		{
16		$this->_collection = $db->results;
		0 ignored issues – show Bug introduced 2016-02-22 04:48 UTC by Report Bug Copy Issue Report The property `results` does not seem to exist in `MongoDB`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
17		$this->_watches = $db->watches;
		0 ignored issues – show Bug introduced 2018-07-13 19:14 UTC by Report Bug Copy Issue Report The property `watches` does not seem to exist in `MongoDB`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
18		$this->_mapper = new Xhgui_Db_Mapper();
19		}
20
21		/**
22		* {@inheritdoc}
23		*/
24		public function latest()
25		{
26		$cursor = $this->_collection->find()
27		->sort(array('meta.request_date' => -1))
28		->limit(1);
29		$result = $cursor->getNext();
30		return $this->_wrap($result);
		0 ignored issues – show Bug Compatibility introduced 2018-07-08 19:27 UTC by Report Bug Copy Issue Report The expression `$this->_wrap($result);` of type `Xhgui_Profile\|array` adds the type `array` to the return on line 30 which is incompatible with the return type declared by the interface `Xhgui_Searcher_Interface::latest` of type `Xhgui_Profile`. Loading history...
31		}
32
33		/**
34		* {@inheritdoc}
35		*/
36		public function query($conditions, $limit, $fields = [])
37		{
38		$result = $this->_collection->find($conditions, $fields)
39		->limit($limit);
40
41		return iterator_to_array($result);
42		}
43
44		/**
45		* {@inheritdoc}
46		*/
47		public function get($id)
48		{
49		return $this->_wrap($this->_collection->findOne(array(
		0 ignored issues – show Bug Compatibility introduced 2018-07-08 19:27 UTC by Report Bug Copy Issue Report The expression `$this->_wrap($this->_col...> new \MongoId($id))));` of type `Xhgui_Profile\|array` adds the type `array` to the return on line 49 which is incompatible with the return type declared by the interface `Xhgui_Searcher_Interface::get` of type `Xhgui_Profile`. Loading history...
50		'_id' => new MongoId($id)
51		)));
52		}
53
54		/**
55		* {@inheritdoc}
56		*/
57		public function getForUrl($url, $options, $conditions = [])
58		{
59		$conditions = array_merge(
60		(array)$conditions,
61		array('simple_url' => $url)
62		);
63		$options = array_merge($options, array(
64		'conditions' => $conditions,
65		));
66		return $this->paginate($options);
		0 ignored issues – show Bug Best Practice introduced 2018-07-08 19:27 UTC by Report Bug Copy Issue Report The return type of `return $this->paginate($options);` (`array`) is incompatible with the return type declared by the interface `Xhgui_Searcher_Interface::getForUrl` of type `MongoCursor`. 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...
67		}
68
69		/**
70		* {@inheritdoc}
71		*/
72		public function getPercentileForUrl($percentile, $url, $search = [])
73		{
74		$result = $this->_mapper->convert(array(
75		'conditions' => $search + array('simple_url' => $url)
76		));
77		$match = $result['conditions'];
78
79		$col = '$meta.request_date';
80	View Code Duplication	if (!empty($search['limit']) && $search['limit'][0] == "P") {
		0 ignored issues – show Duplication introduced 2016-02-22 04:48 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...
81		$col = '$meta.request_ts';
82		}
83
84		$results = $this->_collection->aggregate(array(
85		array('$match' => $match),
86		array(
87		'$project' => array(
88		'date' => $col,
89		'profile.main()' => 1
90		)
91		),
92		array(
93		'$group' => array(
94		'_id' => '$date',
95		'row_count' => array('$sum' => 1),
96		'wall_times' => array('$push' => '$profile.main().wt'),
97		'cpu_times' => array('$push' => '$profile.main().cpu'),
98		'mu_times' => array('$push' => '$profile.main().mu'),
99		'pmu_times' => array('$push' => '$profile.main().pmu'),
100		)
101		),
102		array(
103		'$project' => array(
104		'date' => '$date',
105		'row_count' => '$row_count',
106		'raw_index' => array(
107		'$multiply' => array(
108		'$row_count',
109		$percentile / 100
110		)
111		),
112		'wall_times' => '$wall_times',
113		'cpu_times' => '$cpu_times',
114		'mu_times' => '$mu_times',
115		'pmu_times' => '$pmu_times',
116		)
117		),
118		array('$sort' => array('_id' => 1)),
119		),
120		array('cursor' => array('batchSize' => 0))
121		);
122
123		if (empty($results['result'])) {
124		return [];
125		}
126		$keys = array(
127		'wall_times' => 'wt',
128		'cpu_times' => 'cpu',
129		'mu_times' => 'mu',
130		'pmu_times' => 'pmu'
131		);
132		foreach ($results['result'] as &$result) {
133		$result['date'] = ($result['_id'] instanceof MongoDate) ? date('Y-m-d H:i:s', $result['_id']->sec) : $result['_id'];
134		unset($result['_id']);
135		$index = max(round($result['raw_index']) - 1, 0);
136		foreach ($keys as $key => $out) {
137		sort($result[$key]);
138		$result[$out] = isset($result[$key][$index]) ? $result[$key][$index] : null;
139		unset($result[$key]);
140		}
141		}
142		return $results['result'];
143		}
144
145		/**
146		* {@inheritdoc}
147		*/
148		public function getAvgsForUrl($url, $search = [])
149		{
150		$match = array('meta.simple_url' => $url);
151		if (isset($search['date_start'])) {
152		$match['meta.request_date']['$gte'] = (string)$search['date_start'];
153		}
154		if (isset($search['date_end'])) {
155		$match['meta.request_date']['$lte'] = (string)$search['date_end'];
156		}
157		$results = $this->_collection->aggregate(array(
158		array('$match' => $match),
159		array(
160		'$project' => array(
161		'date' => '$meta.request_date',
162		'profile.main()' => 1,
163		)
164		),
165		array(
166		'$group' => array(
167		'_id' => '$date',
168		'avg_wt' => array('$avg' => '$profile.main().wt'),
169		'avg_cpu' => array('$avg' => '$profile.main().cpu'),
170		'avg_mu' => array('$avg' => '$profile.main().mu'),
171		'avg_pmu' => array('$avg' => '$profile.main().pmu'),
172		)
173		),
174		array('$sort' => array('_id' => 1))
175		),
176		array('cursor' => array('batchSize' => 0))
177		);
178		if (empty($results['result'])) {
179		return [];
180		}
181		foreach ($results['result'] as $i => $result) {
182		$results['result'][$i]['date'] = $result['_id'];
183		unset($results['result'][$i]['_id']);
184		}
185		return $results['result'];
186		}
187
188		/**
189		* {@inheritdoc}
190		*/
191		public function getAll($options = [])
192		{
193		return $this->paginate($options);
194		}
195
196		/**
197		* {@inheritdoc}
198		*/
199		public function delete($id)
200		{
201		$this->_collection->remove(array('_id' => new MongoId($id)), []);
202		}
203
204		/**
205		* {@inheritdoc}
206		*/
207		public function truncate()
208		{
209		return $this->_collection->drop();
210		}
211
212		/**
213		* {@inheritdoc}
214		*/
215		public function saveWatch(array $data)
216		{
217		if (empty($data['name'])) {
218		return false;
219		}
220
221		if (!empty($data['removed']) && isset($data['_id'])) {
222		$this->_watches->remove(
223		array('_id' => new MongoId($data['_id'])),
224		array('w' => 1)
225		);
226		return true;
227		}
228
229		if (empty($data['_id'])) {
230		$this->_watches->insert(
231		$data,
232		array('w' => 1)
233		);
234		return true;
235		}
236
237
238		$data['_id'] = new MongoId($data['_id']);
239		$this->_watches->update(
240		array('_id' => $data['_id']),
241		$data,
242		array('w' => 1)
243		);
244		return true;
245		}
246
247		/**
248		* {@inheritdoc}
249		*/
250		public function getAllWatches()
251		{
252		$cursor = $this->_watches->find();
253		return array_values(iterator_to_array($cursor));
254		}
255
256		/**
257		* {@inheritdoc}
258		*/
259		public function truncateWatches()
260		{
261		$this->_watches->drop();
262		}
263
264		private function paginate($options)
265		{
266		$opts = $this->_mapper->convert($options);
267
268		$totalRows = $this->_collection->find(
269		$opts['conditions'],
270		array('_id' => 1))->count();
271
272		$totalPages = max(ceil($totalRows / $opts['perPage']), 1);
273		$page = 1;
274		if (isset($options['page'])) {
275		$page = min(max($options['page'], 1), $totalPages);
276		}
277
278		$projection = false;
279		if (isset($options['projection'])) {
280		if ($options['projection'] === true) {
281		$projection = array('meta' => 1, 'profile.main()' => 1);
282		} else {
283		$projection = $options['projection'];
284		}
285		}
286
287		if ($projection === false) {
288		$cursor = $this->_collection->find($opts['conditions'])
289		->sort($opts['sort'])
290		->skip((int)($page - 1) * $opts['perPage'])
291		->limit($opts['perPage']);
292		} else {
293		$cursor = $this->_collection->find($opts['conditions'], $projection)
294		->sort($opts['sort'])
295		->skip((int)($page - 1) * $opts['perPage'])
296		->limit($opts['perPage']);
297		}
298
299		return array(
300		'results' => $this->_wrap($cursor),
301		'sort' => $opts['sort'],
302		'direction' => $opts['direction'],
303		'page' => $page,
304		'perPage' => $opts['perPage'],
305		'totalPages' => $totalPages
306		);
307		}
308
309		/**
310		* Converts arrays + MongoCursors into Xhgui_Profile instances.
311		*
312		* @param array\|MongoCursor $data The data to transform.
313		*
314		* @return Xhgui_Profile[] The transformed/wrapped results.
315		*/
316		protected function _wrap($data)
317		{
318		if ($data === null) {
319		throw new Exception('No profile data found.');
320		}
321
322		if (is_array($data)) {
323		return new Xhgui_Profile($data);
324		}
325		$results = [];
326		foreach ($data as $row) {
327		$results[] = new Xhgui_Profile($row);
328		}
329		return $results;
330		}
331		}
332

perftools / xhgui

Pull Request — master (#244)

Xhgui_Searcher_Mongo A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like