SelectAbstract - Code Metrics - Inspection of ":octocat:" - chillerlan/php-database - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 57d77d...021fc0 )

by smiley

created 2017-06-19 13:39 UTC

SelectAbstract B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	264
Duplicated Lines	2.27 %

Coupling/Cohesion

Components	3
Dependencies	4

Importance

Changes

Metric	Value
wmc	40
lcom	3
cbo	4
dl	6
loc	264
rs	8.2608
c	0
b	0
f	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	where()	0	3	1
A	openBracket()	0	3	1
A	closeBracket()	0	3	1
A	distinct()	0	5	1
B	addColumn()	6	16	9
B	cols()	0	19	5
A	_addFrom()	0	10	2
B	from()	0	22	4
A	limit()	0	5	1
A	offset()	0	5	1
C	orderBy()	0	32	7
A	groupBy()	0	8	2
B	count()	0	23	5

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 SelectAbstract 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 SelectAbstract, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Class SelectAbstract
 *
 * @filesource   SelectAbstract.php
 * @created      03.06.2017
 * @package      chillerlan\Database\Query\Dialects
 * @author       Smiley <[email protected]>
 * @copyright    2017 Smiley
 * @license      MIT
 */

namespace chillerlan\Database\Query;


use chillerlan\Database\Query\Traits\WhereTrait;

abstract class SelectAbstract extends StatementAbstract implements SelectInterface{
	use WhereTrait;

	/**
	 * @var bool
	 */
	protected $distinct = false;

	/**
	 * @var array
	 */
	protected $cols = [];

	/**
	 * @var array
	 */
	protected $from = [];

	/**
	 * @var array
	 */
	protected $orderby = [];

	/**
	 * @var array
	 */
	protected $groupby = [];


	/**
	 * @param        $val1
	 * @param        $val2
	 * @param string $operator
	 * @param bool   $bind
	 * @param string $join
	 *
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function where($val1, $val2, $operator = '=', $bind = true, $join = 'AND'):SelectInterface{
		return $this->_addWhere($val1, $val2, $operator, $bind, $join);
	}

	/**
	 * @param null $join
	 *
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function openBracket($join = null):SelectInterface{
		return $this->_openBracket($join); // @codeCoverageIgnore
	}

	/**
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function closeBracket():SelectInterface{
		return $this->_closeBracket(); // @codeCoverageIgnore
	}

	/**
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function distinct():SelectInterface{
		$this->distinct = true;

		return $this;
	}

	/**
	 * @param      $expr1
	 * @param null $expr2
	 * @param null $func
	 *
	 * @return void
	 */
	protected function addColumn($expr1, $expr2 = null, $func = null){
		// @todo: quotes
		switch(true){
			case  $expr2 && $func:
switch (true) {
    case!isset($a):  //wrong
        doSomething();
        break;
    case !isset($b):  //right
        doSomething();
        break;
}
				$col = sprintf('%s(%s) AS %s', strtoupper($func), $this->quote($expr1), $this->quote($expr2)); break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
			case  $expr2 && !$func:
switch (true) {
    case!isset($a):  //wrong
        doSomething();
        break;
    case !isset($b):  //right
        doSomething();
        break;
}
				$col = sprintf('%s AS %s', $this->quote($expr1), $this->quote($expr2)); break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
			case !$expr2 && $func:

				$col = sprintf('%s(%s)', strtoupper($func), $this->quote($expr1)); break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
			case !$expr2 && !$func:
			default:
				$col = $this->quote($expr1);
		}

		$this->cols[$expr2 ?? $expr1] = $col;
	}

	/**
	 * @param array $expressions
	 *
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function cols(array $expressions):SelectInterface{

		foreach($expressions as $k => $ref){

			if(is_string($k)){
				is_array($ref)
					? $this->addColumn($ref[0], $k, $ref[1] ?? null)
					: $this->addColumn($ref ,$k);
			}
			else{
				is_array($ref)
					? $this->addColumn($ref[0], null, $ref[1] ?? null)
					: $this->addColumn($ref);
			}

		}

		return $this;
	}

	/**
	 * @param string      $table
	 * @param string|null $ref
	 */
	protected function _addFrom(string $table, string $ref = null){
		// @todo: quotes
		$from = $this->quote($table);

		if($ref){
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$from = sprintf('%s AS %s', $this->quote($ref), $this->quote($table));// @todo: index hint
		}

		$this->from[$ref ?? $table] = $from;
	}

	/**
	 * @param array $expressions
	 *
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function from(array $expressions):SelectInterface{

		foreach($expressions as $k => $ref){

			if(is_string($k)){
				$this->_addFrom($k, $ref);
			}
			else{
				$x = explode(' ', $ref);

				if(count($x) === 2){
					$this->_addFrom($x[0], $x[1]);
				}
				else{
					$this->_addFrom($ref);
				}
			}

		}

		return $this;
	}

	/**
	 * @param int $limit
	 *
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function limit(int $limit):SelectInterface{
		$this->limit = $limit;

		return $this;
	}

	/**
	 * @param int $offset
	 *
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function offset(int $offset):SelectInterface{
		$this->offset = $offset;

		return $this;
	}

	/**
	 * @param array $expressions
	 *
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function orderBy(array $expressions):SelectInterface{

		foreach($expressions as $alias => $expression){

			if(is_string($alias)){

				if(is_array($expression)){
					$dir = strtoupper($expression[0]);

					if(in_array($dir, ['ASC', 'DESC'])){
						$this->orderby[] =  isset($expression[1]) ? strtoupper($expression[1]).'('.$this->quote($alias).') '.$dir : $dir;
					}

				}
				else{
					$dir = strtoupper($expression);

					if(in_array($dir, ['ASC', 'DESC'])){
						$this->orderby[] =  $this->quote($alias).' '.$dir;
					}

				}

			}
			else{
				$this->orderby[] = $this->quote($expression);
			}

		}

		return $this;
	}

	/**
	 * @param array $expressions
	 *
	 * @return \chillerlan\Database\Query\SelectInterface
	 */
	public function groupBy(array $expressions):SelectInterface{

		foreach($expressions as $expression){
			$this->groupby[] = $this->quote($expression);
		}

		return $this;
	}

	/**
	 * @todo
	 *
	 * @return int
	 * @throws \chillerlan\Database\Query\QueryException
	 */
	public function count():int{

		if(empty($this->from)){
			throw new QueryException('no FROM expression specified');
		}

		$glue = ','.PHP_EOL."\t";

		$sql  = 'SELECT ';
		$sql .= $this->distinct ? 'DISTINCT ' : '';
		$sql .= 'COUNT(*) AS  '.$this->quote('count');
		$sql .= 'FROM '.implode($glue , $this->from);
		$sql .= $this->_getWhere();
		$sql .= !empty($this->groupby) ? PHP_EOL.'GROUP BY '.implode($glue, $this->groupby) : '';

		$q = $this->DBDriver->prepared($sql, $this->bindValues);

		if($q->length){
			return (int)$q[0]->count;
		}

		return -1;
	}

}


1		<?php
2		/**
3		* Class SelectAbstract
4		*
5		* @filesource SelectAbstract.php
6		* @created 03.06.2017
7		* @package chillerlan\Database\Query\Dialects
8		* @author Smiley <[email protected]>
9		* @copyright 2017 Smiley
10		* @license MIT
11		*/
12
13		namespace chillerlan\Database\Query;
14
15
16		use chillerlan\Database\Query\Traits\WhereTrait;
17
18		abstract class SelectAbstract extends StatementAbstract implements SelectInterface{
19		use WhereTrait;
20
21		/**
22		* @var bool
23		*/
24		protected $distinct = false;
25
26		/**
27		* @var array
28		*/
29		protected $cols = [];
30
31		/**
32		* @var array
33		*/
34		protected $from = [];
35
36		/**
37		* @var array
38		*/
39		protected $orderby = [];
40
41		/**
42		* @var array
43		*/
44		protected $groupby = [];
45
46
47		/**
48		* @param $val1
49		* @param $val2
50		* @param string $operator
51		* @param bool $bind
52		* @param string $join
53		*
54		* @return \chillerlan\Database\Query\SelectInterface
55		*/
56		public function where($val1, $val2, $operator = '=', $bind = true, $join = 'AND'):SelectInterface{
57		return $this->_addWhere($val1, $val2, $operator, $bind, $join);
58		}
59
60		/**
61		* @param null $join
62		*
63		* @return \chillerlan\Database\Query\SelectInterface
64		*/
65		public function openBracket($join = null):SelectInterface{
66		return $this->_openBracket($join); // @codeCoverageIgnore
67		}
68
69		/**
70		* @return \chillerlan\Database\Query\SelectInterface
71		*/
72		public function closeBracket():SelectInterface{
73		return $this->_closeBracket(); // @codeCoverageIgnore
74		}
75
76		/**
77		* @return \chillerlan\Database\Query\SelectInterface
78		*/
79		public function distinct():SelectInterface{
80		$this->distinct = true;
81
82		return $this;
83		}
84
85		/**
86		* @param $expr1
87		* @param null $expr2
88		* @param null $func
89		*
90		* @return void
91		*/
92		protected function addColumn($expr1, $expr2 = null, $func = null){
93		// @todo: quotes
94		switch(true){
95	View Code Duplication	case $expr2 && $func:
		0 ignored issues – show Duplication introduced 2017-06-16 01:20 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... Coding Style introduced 2017-06-06 00:26 UTC by Report Bug Copy Issue Report As per coding-style, `case` should be followed by a single space. As per the PSR-2 coding standard, there must be a space after the `case` keyword, instead of the test immediately following it. switch (true) { case!isset($a): //wrong doSomething(); break; case !isset($b): //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
96		$col = sprintf('%s(%s) AS %s', strtoupper($func), $this->quote($expr1), $this->quote($expr2)); break;
		0 ignored issues – show Coding Style introduced 2017-06-16 01:20 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
97	View Code Duplication	case $expr2 && !$func:
		0 ignored issues – show Duplication introduced 2017-06-16 01:20 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... Coding Style introduced 2017-06-16 01:20 UTC by Report Bug Copy Issue Report As per coding-style, `case` should be followed by a single space. As per the PSR-2 coding standard, there must be a space after the `case` keyword, instead of the test immediately following it. switch (true) { case!isset($a): //wrong doSomething(); break; case !isset($b): //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
98		$col = sprintf('%s AS %s', $this->quote($expr1), $this->quote($expr2)); break;
		0 ignored issues – show Coding Style introduced 2017-06-16 01:20 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
99	View Code Duplication	case !$expr2 && $func:
		0 ignored issues – show Duplication introduced 2017-06-16 01:20 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...
100		$col = sprintf('%s(%s)', strtoupper($func), $this->quote($expr1)); break;
		0 ignored issues – show Coding Style introduced 2017-06-16 01:20 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
101		case !$expr2 && !$func:
102		default:
103		$col = $this->quote($expr1);
104		}
105
106		$this->cols[$expr2 ?? $expr1] = $col;
107		}
108
109		/**
110		* @param array $expressions
111		*
112		* @return \chillerlan\Database\Query\SelectInterface
113		*/
114		public function cols(array $expressions):SelectInterface{
115
116		foreach($expressions as $k => $ref){
117
118		if(is_string($k)){
119		is_array($ref)
120		? $this->addColumn($ref[0], $k, $ref[1] ?? null)
121		: $this->addColumn($ref ,$k);
122		}
123		else{
124		is_array($ref)
125		? $this->addColumn($ref[0], null, $ref[1] ?? null)
126		: $this->addColumn($ref);
127		}
128
129		}
130
131		return $this;
132		}
133
134		/**
135		* @param string $table
136		* @param string\|null $ref
137		*/
138		protected function _addFrom(string $table, string $ref = null){
139		// @todo: quotes
140		$from = $this->quote($table);
141
142		if($ref){
		0 ignored issues – show Bug Best Practice introduced 2017-06-16 01:20 UTC by Report Bug Copy Issue Report The expression `$ref` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
143		$from = sprintf('%s AS %s', $this->quote($ref), $this->quote($table));// @todo: index hint
144		}
145
146		$this->from[$ref ?? $table] = $from;
147		}
148
149		/**
150		* @param array $expressions
151		*
152		* @return \chillerlan\Database\Query\SelectInterface
153		*/
154		public function from(array $expressions):SelectInterface{
155
156		foreach($expressions as $k => $ref){
157
158		if(is_string($k)){
159		$this->_addFrom($k, $ref);
160		}
161		else{
162		$x = explode(' ', $ref);
163
164		if(count($x) === 2){
165		$this->_addFrom($x[0], $x[1]);
166		}
167		else{
168		$this->_addFrom($ref);
169		}
170		}
171
172		}
173
174		return $this;
175		}
176
177		/**
178		* @param int $limit
179		*
180		* @return \chillerlan\Database\Query\SelectInterface
181		*/
182		public function limit(int $limit):SelectInterface{
183		$this->limit = $limit;
184
185		return $this;
186		}
187
188		/**
189		* @param int $offset
190		*
191		* @return \chillerlan\Database\Query\SelectInterface
192		*/
193		public function offset(int $offset):SelectInterface{
194		$this->offset = $offset;
195
196		return $this;
197		}
198
199		/**
200		* @param array $expressions
201		*
202		* @return \chillerlan\Database\Query\SelectInterface
203		*/
204		public function orderBy(array $expressions):SelectInterface{
205
206		foreach($expressions as $alias => $expression){
207
208		if(is_string($alias)){
209
210		if(is_array($expression)){
211		$dir = strtoupper($expression[0]);
212
213		if(in_array($dir, ['ASC', 'DESC'])){
214		$this->orderby[] = isset($expression[1]) ? strtoupper($expression[1]).'('.$this->quote($alias).') '.$dir : $dir;
215		}
216
217		}
218		else{
219		$dir = strtoupper($expression);
220
221		if(in_array($dir, ['ASC', 'DESC'])){
222		$this->orderby[] = $this->quote($alias).' '.$dir;
223		}
224
225		}
226
227		}
228		else{
229		$this->orderby[] = $this->quote($expression);
230		}
231
232		}
233
234		return $this;
235		}
236
237		/**
238		* @param array $expressions
239		*
240		* @return \chillerlan\Database\Query\SelectInterface
241		*/
242		public function groupBy(array $expressions):SelectInterface{
243
244		foreach($expressions as $expression){
245		$this->groupby[] = $this->quote($expression);
246		}
247
248		return $this;
249		}
250
251		/**
252		* @todo
253		*
254		* @return int
255		* @throws \chillerlan\Database\Query\QueryException
256		*/
257		public function count():int{
258
259		if(empty($this->from)){
260		throw new QueryException('no FROM expression specified');
261		}
262
263		$glue = ','.PHP_EOL."\t";
264
265		$sql = 'SELECT ';
266		$sql .= $this->distinct ? 'DISTINCT ' : '';
267		$sql .= 'COUNT(*) AS '.$this->quote('count');
268		$sql .= 'FROM '.implode($glue , $this->from);
269		$sql .= $this->_getWhere();
270		$sql .= !empty($this->groupby) ? PHP_EOL.'GROUP BY '.implode($glue, $this->groupby) : '';
271
272		$q = $this->DBDriver->prepared($sql, $this->bindValues);
273
274		if($q->length){
275		return (int)$q[0]->count;
276		}
277
278		return -1;
279		}
280
281		}
282

chillerlan / php-database