PrettyDataCollector - Code Metrics - as3io/As3ModlrBundle - Measure and Improve Code Quality continuously with Scrutinizer

PrettyDataCollector C
last analyzed 2016-10-19 15:57 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	221
Duplicated Lines	18.55 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	77
lcom	1
cbo	1
dl	41
loc	221
rs	5.4715
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setBatchInsertThreshold()	0	4	1
F	collect()	41	148	53
C	bsonEncode()	0	59	23

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like PrettyDataCollector often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use PrettyDataCollector, and based on these observations, apply Extract Interface, too.

<?php

/*
 * This file is part of the Doctrine MongoDBBundle
 *
 * The code was originally distributed inside the Symfony framework.
 *
 * (c) Fabien Potencier <[email protected]>
 * (c) Doctrine Project
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace As3\Bundle\ModlrBundle\DataCollector\MongoDb;

use Doctrine\MongoDB\GridFSFile;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * A data collector that formats pretty queries.
 *
 * @author Kris Wallsmith <[email protected]>
 */
class PrettyDataCollector extends StandardDataCollector
{
    private $batchInsertThreshold;

    public function setBatchInsertThreshold($batchInsertThreshold)
    {
        $this->batchInsertThreshold = $batchInsertThreshold;
    }

    public function collect(Request $request, Response $response, \Exception $exception = null)
    {
        $this->data['queries'] = array();
        $this->data['nb_queries'] = 0;

        $grouped = array();
        $ordered = array();
        foreach ($this->queries as $query) {
            if (!isset($query['query']) || !isset($query['fields'])) {
                // no grouping necessary
                $ordered[] = array($query);
                continue;
            }

            $cursor = serialize($query['query']).serialize($query['fields']);

            // append if issued from cursor (currently just "sort")
            if (isset($query['sort'])) {
                unset($query['query'], $query['fields']);
                $grouped[$cursor][count($grouped[$cursor]) - 1][] = $query;
            } else {
                $grouped[$cursor][] = array($query);
                $ordered[] =& $grouped[$cursor][count($grouped[$cursor]) - 1];
            }
        }

        $i = 0;
        $db = '';
        $query = '';
        foreach ($ordered as $logs) {
            foreach ($logs as $log) {
                if (isset($log['db']) && $db != $log['db']) {
                    // for readability
                    $this->data['queries'][$i++] = 'use '.$log['db'].';';
                    $db = $log['db'];
                }

                if (isset($log['collection'])) {
                    // flush the previous and start a new query
                    if (!empty($query)) {

                        if ('.' == $query[0]) {
                            $query  = 'db'.$query;
                        }

                        $this->data['queries'][$i++] = $query.';';
                        ++$this->data['nb_queries'];
                    }

                    $query = 'db.'.$log['collection'];
                }

                // format the method call
                if (isset($log['authenticate'])) {
                    $query .= '.authenticate()';
                } elseif (isset($log['batchInsert'])) {
                    if (1 === $log['num']) {
                        $query .= '.insert('.$this->bsonEncode($log['data']).')';
                    } elseif (null !== $this->batchInsertThreshold && $this->batchInsertThreshold <= $log['num']) {
                        $query .= '.batchInsert(**'.$log['num'].' items**)';
                    } else {
                        $query .= '.batchInsert('.$this->bsonEncode($log['data']).')';
                    }
                } elseif (isset($log['command'])) {
                    $query .= '.runCommand('.$this->bsonEncode($log['data']).')';
                } elseif (isset($log['count'])) {
                    $query .= '.count(';
                    if ($log['query'] || $log['limit'] || $log['skip']) {
                        $query .= $this->bsonEncode($log['query']);
                        if ($log['limit'] || $log['skip']) {

                            $query .= ', '.$this->bsonEncode($log['limit']);
                            if ($log['skip']) {
                                $query .= ', '.$this->bsonEncode($log['skip']);
                            }
                        }
                    }
                    $query .= ')';
                } elseif (isset($log['skip'])) {
                    $query .= '.skip('.$log['skipNum'].')';
                } elseif (isset($log['limit'])) {
                    $query .= '.limit('.$log['limitNum'].')';
                } elseif (isset($log['createCollection'])) {
                    $query .= '.createCollection()';
                } elseif (isset($log['createDBRef'])) {
                    $query .= '.createDBRef()';
                } elseif (isset($log['deleteIndex'])) {
                    $query .= '.dropIndex('.$this->bsonEncode($log['keys']).')';
                } elseif (isset($log['deleteIndexes'])) {
                    $query .= '.dropIndexes()';
                } elseif (isset($log['drop'])) {
                    $query .= '.drop()';
                } elseif (isset($log['dropDatabase'])) {
                    $query .= '.dropDatabase()';
                } elseif (isset($log['ensureIndex'])) {

                    $query .= '.ensureIndex('.$this->bsonEncode($log['keys']).', '.$this->bsonEncode($log['options']).')';
                } elseif (isset($log['execute'])) {
                    $query .= '.execute()';
                } elseif (isset($log['find'])) {
                    $query .= '.find(';
                    if ($log['query'] || $log['fields']) {

                        $query .= $this->bsonEncode($log['query']);
                        if ($log['fields']) {
                            $query .= ', '.$this->bsonEncode($log['fields']);
                        }
                    }
                    $query .= ')';
                } elseif (isset($log['findOne'])) {
                    $query .= '.findOne(';
                    if ($log['query'] || $log['fields']) {

                        $query .= $this->bsonEncode($log['query']);
                        if ($log['fields']) {
                            $query .= ', '.$this->bsonEncode($log['fields']);
                        }
                    }
                    $query .= ')';
                } elseif (isset($log['getDBRef'])) {
                    $query .= '.getDBRef()';
                } elseif (isset($log['group'])) {
                    $query .= '.group('.$this->bsonEncode(array(
                        'key'    => $log['keys'],
                        'initial' => $log['initial'],
                        'reduce'  => $log['reduce'],
                    )).')';
                } elseif (isset($log['insert'])) {
                    $query .= '.insert('.$this->bsonEncode($log['document']).')';
                } elseif (isset($log['remove'])) {
                    $query .= '.remove('.$this->bsonEncode($log['query']).')';
                } elseif (isset($log['save'])) {
                    $query .= '.save('.$this->bsonEncode($log['document']).')';
                } elseif (isset($log['sort'])) {
                    $query .= '.sort('.$this->bsonEncode($log['sortFields']).')';
                } elseif (isset($log['update'])) {

                    // todo: include $log['options']

                    $query .= '.update('.$this->bsonEncode($log['query']).', '.$this->bsonEncode($log['newObj']).')';
                } elseif (isset($log['validate'])) {
                    $query .= '.validate()';
                }
            }
        }

        if (!empty($query)) {

            if ('.' == $query[0]) {
                $query  = 'db'.$query;
            }

            $this->data['queries'][$i++] = $query.';';
            ++$this->data['nb_queries'];
        }
    }

    /**
     * @todo Move this to a collaborator
     */
    private function bsonEncode($query, $array = true)
    {
        $parts = array();

        foreach ($query as $key => $value) {
            if (!is_numeric($key)) {
                $array = false;
            }

            if (null === $value) {
                $formatted = 'null';
            } elseif (is_bool($value)) {
                $formatted = $value ? 'true' : 'false';
            } elseif (is_int($value) || is_float($value)) {
                $formatted = $value;
            } elseif (is_scalar($value)) {
                $formatted = '"'.$value.'"';
            } elseif (is_array($value)) {
                $formatted = $this->bsonEncode($value);
            } elseif ($value instanceof \MongoId) {
                $formatted = 'ObjectId("'.$value.'")';
            } elseif ($value instanceof \MongoDate) {
                $formatted = 'new ISODate("'.date('c', $value->sec).'")';
            } elseif ($value instanceof \DateTime) {
                $formatted = 'new ISODate("'.date('c', $value->getTimestamp()).'")';
            } elseif ($value instanceof \MongoRegex) {
                $formatted = 'new RegExp("'.$value->regex.'", "'.$value->flags.'")';
            } elseif ($value instanceof \MongoMinKey) {
                $formatted = 'new MinKey()';
            } elseif ($value instanceof \MongoMaxKey) {
                $formatted = 'new MaxKey()';
            } elseif ($value instanceof \MongoBinData) {
                $formatted = 'new BinData('.$value->type.', "'.base64_encode($value->bin).'")';
            } elseif ($value instanceof \MongoGridFSFile || $value instanceof GridFSFile) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                $formatted = 'new MongoGridFSFile("'.$value->getFilename().'")';
            } elseif ($value instanceof \stdClass) {
                $formatted = $this->bsonEncode((array) $value);
            } else {
                $formatted = (string) $value;
            }

            $parts['"'.$key.'"'] = $formatted;
        }

        if (0 == count($parts)) {
            return $array ? '[ ]' : '{ }';
        }

        if ($array) {
            return '[ '.implode(', ', $parts).' ]';
        } else {
            $mapper = function($key, $value)
            {
                return $key.': '.$value;
            };

            return '{ '.implode(', ', array_map($mapper, array_keys($parts), array_values($parts))).' }';
        }
    }
}


PrettyDataCollector C
last analyzed 2016-10-19 15:57 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

1		<?php
2
3		/*
4		* This file is part of the Doctrine MongoDBBundle
5		*
6		* The code was originally distributed inside the Symfony framework.
7		*
8		* (c) Fabien Potencier <[email protected]>
9		* (c) Doctrine Project
10		*
11		* For the full copyright and license information, please view the LICENSE
12		* file that was distributed with this source code.
13		*/
14
15		namespace As3\Bundle\ModlrBundle\DataCollector\MongoDb;
16
17		use Doctrine\MongoDB\GridFSFile;
18		use Symfony\Component\HttpFoundation\Request;
19		use Symfony\Component\HttpFoundation\Response;
20
21		/**
22		* A data collector that formats pretty queries.
23		*
24		* @author Kris Wallsmith <[email protected]>
25		*/
26		class PrettyDataCollector extends StandardDataCollector
27		{
28		private $batchInsertThreshold;
29
30		public function setBatchInsertThreshold($batchInsertThreshold)
31		{
32		$this->batchInsertThreshold = $batchInsertThreshold;
33		}
34
35		public function collect(Request $request, Response $response, \Exception $exception = null)
36		{
37		$this->data['queries'] = array();
38		$this->data['nb_queries'] = 0;
39
40		$grouped = array();
41		$ordered = array();
42		foreach ($this->queries as $query) {
43		if (!isset($query['query']) \|\| !isset($query['fields'])) {
44		// no grouping necessary
45		$ordered[] = array($query);
46		continue;
47		}
48
49		$cursor = serialize($query['query']).serialize($query['fields']);
50
51		// append if issued from cursor (currently just "sort")
52		if (isset($query['sort'])) {
53		unset($query['query'], $query['fields']);
54		$grouped[$cursor][count($grouped[$cursor]) - 1][] = $query;
55		} else {
56		$grouped[$cursor][] = array($query);
57		$ordered[] =& $grouped[$cursor][count($grouped[$cursor]) - 1];
58		}
59		}
60
61		$i = 0;
62		$db = '';
63		$query = '';
64		foreach ($ordered as $logs) {
65		foreach ($logs as $log) {
66		if (isset($log['db']) && $db != $log['db']) {
67		// for readability
68		$this->data['queries'][$i++] = 'use '.$log['db'].';';
69		$db = $log['db'];
70		}
71
72		if (isset($log['collection'])) {
73		// flush the previous and start a new query
74	View Code Duplication	if (!empty($query)) {
		0 ignored issues – show Duplication introduced 2016-05-04 16:28 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...
75		if ('.' == $query[0]) {
76		$query = 'db'.$query;
77		}
78
79		$this->data['queries'][$i++] = $query.';';
80		++$this->data['nb_queries'];
81		}
82
83		$query = 'db.'.$log['collection'];
84		}
85
86		// format the method call
87		if (isset($log['authenticate'])) {
88		$query .= '.authenticate()';
89		} elseif (isset($log['batchInsert'])) {
90		if (1 === $log['num']) {
91		$query .= '.insert('.$this->bsonEncode($log['data']).')';
92		} elseif (null !== $this->batchInsertThreshold && $this->batchInsertThreshold <= $log['num']) {
93		$query .= '.batchInsert('.$log['num'].' items)';
94		} else {
95		$query .= '.batchInsert('.$this->bsonEncode($log['data']).')';
96		}
97		} elseif (isset($log['command'])) {
98		$query .= '.runCommand('.$this->bsonEncode($log['data']).')';
99		} elseif (isset($log['count'])) {
100		$query .= '.count(';
101		if ($log['query'] \|\| $log['limit'] \|\| $log['skip']) {
102		$query .= $this->bsonEncode($log['query']);
103	View Code Duplication	if ($log['limit'] \|\| $log['skip']) {
		0 ignored issues – show Duplication introduced 2016-05-04 16:28 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...
104		$query .= ', '.$this->bsonEncode($log['limit']);
105		if ($log['skip']) {
106		$query .= ', '.$this->bsonEncode($log['skip']);
107		}
108		}
109		}
110		$query .= ')';
111		} elseif (isset($log['skip'])) {
112		$query .= '.skip('.$log['skipNum'].')';
113		} elseif (isset($log['limit'])) {
114		$query .= '.limit('.$log['limitNum'].')';
115		} elseif (isset($log['createCollection'])) {
116		$query .= '.createCollection()';
117		} elseif (isset($log['createDBRef'])) {
118		$query .= '.createDBRef()';
119		} elseif (isset($log['deleteIndex'])) {
120		$query .= '.dropIndex('.$this->bsonEncode($log['keys']).')';
121		} elseif (isset($log['deleteIndexes'])) {
122		$query .= '.dropIndexes()';
123		} elseif (isset($log['drop'])) {
124		$query .= '.drop()';
125		} elseif (isset($log['dropDatabase'])) {
126		$query .= '.dropDatabase()';
127	View Code Duplication	} elseif (isset($log['ensureIndex'])) {
		0 ignored issues – show Duplication introduced 2016-05-04 16:28 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...
128		$query .= '.ensureIndex('.$this->bsonEncode($log['keys']).', '.$this->bsonEncode($log['options']).')';
129		} elseif (isset($log['execute'])) {
130		$query .= '.execute()';
131		} elseif (isset($log['find'])) {
132		$query .= '.find(';
133	View Code Duplication	if ($log['query'] \|\| $log['fields']) {
		0 ignored issues – show Duplication introduced 2016-05-04 16:28 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...
134		$query .= $this->bsonEncode($log['query']);
135		if ($log['fields']) {
136		$query .= ', '.$this->bsonEncode($log['fields']);
137		}
138		}
139		$query .= ')';
140		} elseif (isset($log['findOne'])) {
141		$query .= '.findOne(';
142	View Code Duplication	if ($log['query'] \|\| $log['fields']) {
		0 ignored issues – show Duplication introduced 2016-05-04 16:28 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...
143		$query .= $this->bsonEncode($log['query']);
144		if ($log['fields']) {
145		$query .= ', '.$this->bsonEncode($log['fields']);
146		}
147		}
148		$query .= ')';
149		} elseif (isset($log['getDBRef'])) {
150		$query .= '.getDBRef()';
151		} elseif (isset($log['group'])) {
152		$query .= '.group('.$this->bsonEncode(array(
153		'key' => $log['keys'],
154		'initial' => $log['initial'],
155		'reduce' => $log['reduce'],
156		)).')';
157		} elseif (isset($log['insert'])) {
158		$query .= '.insert('.$this->bsonEncode($log['document']).')';
159		} elseif (isset($log['remove'])) {
160		$query .= '.remove('.$this->bsonEncode($log['query']).')';
161		} elseif (isset($log['save'])) {
162		$query .= '.save('.$this->bsonEncode($log['document']).')';
163		} elseif (isset($log['sort'])) {
164		$query .= '.sort('.$this->bsonEncode($log['sortFields']).')';
165	View Code Duplication	} elseif (isset($log['update'])) {
		0 ignored issues – show Duplication introduced 2016-05-04 16:28 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...
166		// todo: include $log['options']
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-04 16:28 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
167		$query .= '.update('.$this->bsonEncode($log['query']).', '.$this->bsonEncode($log['newObj']).')';
168		} elseif (isset($log['validate'])) {
169		$query .= '.validate()';
170		}
171		}
172		}
173
174	View Code Duplication	if (!empty($query)) {
		0 ignored issues – show Duplication introduced 2016-05-04 16:28 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...
175		if ('.' == $query[0]) {
176		$query = 'db'.$query;
177		}
178
179		$this->data['queries'][$i++] = $query.';';
180		++$this->data['nb_queries'];
181		}
182		}
183
184		/**
185		* @todo Move this to a collaborator
186		*/
187		private function bsonEncode($query, $array = true)
188		{
189		$parts = array();
190
191		foreach ($query as $key => $value) {
192		if (!is_numeric($key)) {
193		$array = false;
194		}
195
196		if (null === $value) {
197		$formatted = 'null';
198		} elseif (is_bool($value)) {
199		$formatted = $value ? 'true' : 'false';
200		} elseif (is_int($value) \|\| is_float($value)) {
201		$formatted = $value;
202		} elseif (is_scalar($value)) {
203		$formatted = '"'.$value.'"';
204		} elseif (is_array($value)) {
205		$formatted = $this->bsonEncode($value);
206		} elseif ($value instanceof \MongoId) {
207		$formatted = 'ObjectId("'.$value.'")';
208		} elseif ($value instanceof \MongoDate) {
209		$formatted = 'new ISODate("'.date('c', $value->sec).'")';
210		} elseif ($value instanceof \DateTime) {
211		$formatted = 'new ISODate("'.date('c', $value->getTimestamp()).'")';
212		} elseif ($value instanceof \MongoRegex) {
213		$formatted = 'new RegExp("'.$value->regex.'", "'.$value->flags.'")';
214		} elseif ($value instanceof \MongoMinKey) {
215		$formatted = 'new MinKey()';
216		} elseif ($value instanceof \MongoMaxKey) {
217		$formatted = 'new MaxKey()';
218		} elseif ($value instanceof \MongoBinData) {
219		$formatted = 'new BinData('.$value->type.', "'.base64_encode($value->bin).'")';
220		} elseif ($value instanceof \MongoGridFSFile \|\| $value instanceof GridFSFile) {
		0 ignored issues – show Bug introduced 2016-05-04 16:28 UTC by Report Bug Copy Issue Report The class `Doctrine\MongoDB\GridFSFile` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
221		$formatted = 'new MongoGridFSFile("'.$value->getFilename().'")';
222		} elseif ($value instanceof \stdClass) {
223		$formatted = $this->bsonEncode((array) $value);
224		} else {
225		$formatted = (string) $value;
226		}
227
228		$parts['"'.$key.'"'] = $formatted;
229		}
230
231		if (0 == count($parts)) {
232		return $array ? '[ ]' : '{ }';
233		}
234
235		if ($array) {
236		return '[ '.implode(', ', $parts).' ]';
237		} else {
238		$mapper = function($key, $value)
239		{
240		return $key.': '.$value;
241		};
242
243		return '{ '.implode(', ', array_map($mapper, array_keys($parts), array_values($parts))).' }';
244		}
245		}
246		}
247

as3io / As3ModlrBundle

PrettyDataCollector C last analyzed 2016-10-19 15:57 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

PrettyDataCollector C
last analyzed 2016-10-19 15:57 UTC