CreateDefinition - Code Metrics - Inspection of "Add support for CHECK Constraints" - phpmyadmin/sql-parser - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#200)

unknown

created 2018-08-03 17:40 UTC

CreateDefinition B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	335
Duplicated Lines	5.37 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

93.69%

Importance

Changes

Metric	Value
wmc	50
lcom	1
cbo	9
dl	18
loc	335
ccs	104
cts	111
cp	0.9369
rs	8.4
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	3
F	parse()	18	155	38
B	build()	0	39	9

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

<?php

/**
 * Parses the create definition of a column or a key.
 *
 * Used for parsing `CREATE TABLE` statement.
 */

namespace PhpMyAdmin\SqlParser\Components;

use PhpMyAdmin\SqlParser\Component;
use PhpMyAdmin\SqlParser\Context;
use PhpMyAdmin\SqlParser\Parser;
use PhpMyAdmin\SqlParser\Token;
use PhpMyAdmin\SqlParser\TokensList;

/**
 * Parses the create definition of a column or a key.
 *
 * Used for parsing `CREATE TABLE` statement.
 *
 * @category   Components
 *
 * @license    https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
 */
class CreateDefinition extends Component
{
    /**
     * All field options.
     *
     * @var array
     */
    public static $FIELD_OPTIONS = array(
        // Tells the `OptionsArray` to not sort the options.
        // See the note below.
        '_UNSORTED' => true,

        'NOT NULL' => 1,
        'NULL' => 1,
        'DEFAULT' => array(2, 'expr', array('breakOnAlias' => true)),
        /* Following are not according to grammar, but MySQL happily accepts
         * these at any location */
        'CHARSET' => array(2, 'var'),
        'COLLATE' => array(3, 'var'),
        'AUTO_INCREMENT' => 3,
        'PRIMARY' => 4,
        'PRIMARY KEY' => 4,
        'UNIQUE' => 4,
        'UNIQUE KEY' => 4,
        'COMMENT' => array(5, 'var'),
        'COLUMN_FORMAT' => array(6, 'var'),
        'ON UPDATE' => array(7, 'expr'),

        // Generated columns options.
        'GENERATED ALWAYS' => 8,
        'AS' => array(9, 'expr', array('parenthesesDelimited' => true)),
        'VIRTUAL' => 10,
        'PERSISTENT' => 11,
        'STORED' => 11,
        // Common entries.
        //
        // NOTE: Some of the common options are not in the same order which
        // causes troubles when checking if the options are in the right order.
        // I should find a way to define multiple sets of options and make the
        // parser select the right set.
        //
        // 'UNIQUE'                        => 4,
        // 'UNIQUE KEY'                    => 4,
        // 'COMMENT'                       => array(5, 'var'),
        // 'NOT NULL'                      => 1,
        // 'NULL'                          => 1,
        // 'PRIMARY'                       => 4,
        // 'PRIMARY KEY'                   => 4,
    );

    /**
     * The name of the new column.
     *
     * @var string
     */
    public $name;

    /**
     * Whether this field is a constraint or not.
     *
     * @var bool
     */
    public $isConstraint;

    /**
     * The data type of thew new column.
     *
     * @var DataType
     */
    public $type;

    /**
     * The key.
     *
     * @var Key
     */
    public $key;

    /**
     * Check constraint
     *
     * @var check
     */
    public $check;

    /**
     * The table that is referenced.
     *
     * @var Reference
     */
    public $references;

    /**
     * The options of this field.
     *
     * @var OptionsArray
     */
    public $options;

    /**
     * Constructor.
     *
     * @param string       $name         the name of the field

     * @param OptionsArray $options      the options of this field

     * @param DataType|Key $type         the data type of this field or the key

     * @param bool         $isConstraint whether this field is a constraint or not
     * @param Reference    $references   references

     */
    public function __construct(
        $name = null,
        $options = null,
        $type = null,
        $isConstraint = false,
        $references = null
    ) {
        $this->name = $name;
        $this->options = $options;
        if ($type instanceof DataType) {
            $this->type = $type;
        } elseif ($type instanceof Key) {
            $this->key = $type;
            $this->isConstraint = $isConstraint;
            $this->references = $references;
        }
    }

    /**
     * @param Parser     $parser  the parser that serves as context
     * @param TokensList $list    the list of tokens that are being parsed
     * @param array      $options parameters for parsing
     *
     * @return CreateDefinition[]
     */
    public static function parse(Parser $parser, TokensList $list, array $options = array())
    {
        $ret = array();

        $expr = new self();

        /**
         * The state of the parser.
         *
         * Below are the states of the parser.
         *
         *      0 -----------------------[ ( ]------------------------> 1
         *
         *      1 --------------------[ CONSTRAINT ]------------------> 1
         *      1 -----------------------[ key ]----------------------> 2
         *      1 -------------[ constraint / column name ]-----------> 2
         *
         *      2 --------------------[ data type ]-------------------> 3
         *
         *      3 ---------------------[ options ]--------------------> 4
         *
         *      4 --------------------[ REFERENCES ]------------------> 4
         *
         *      5 ------------------------[ , ]-----------------------> 1
         *      5 ------------------------[ ) ]-----------------------> 6 (-1)
         *
         * @var int
         */
        $state = 0;

        for (; $list->idx < $list->count; ++$list->idx) {
            /**
             * Token parsed at this moment.
             *
             * @var Token
             */
            $token = $list->tokens[$list->idx];

            // End of statement.
            if ($token->type === Token::TYPE_DELIMITER) {
                break;
            }

            // Skipping whitespaces and comments.
            if (($token->type === Token::TYPE_WHITESPACE) || ($token->type === Token::TYPE_COMMENT)) {
                continue;
            }

            if ($state === 0) {
                if (($token->type === Token::TYPE_OPERATOR) && ($token->value === '(')) {
                    $state = 1;
                } else {
                    $parser->error(
                        'An opening bracket was expected.',
                        $token
                    );

                    break;
                }
            } elseif ($state === 1) {
                if ($token->type === Token::TYPE_KEYWORD && $token->keyword === 'CONSTRAINT') {
                    $expr->isConstraint = true;
                } elseif (($token->type === Token::TYPE_KEYWORD) && ($token->flags & Token::FLAG_KEYWORD_KEY)) {
                    $expr->key = Key::parse($parser, $list);
                    $state = 4;
                } elseif (($token->type === Token::TYPE_KEYWORD) && $token->keyword === 'CHECK') {
                    $expr->check = Check::parse($parser, $list);
                    $state = 4;
                } elseif ($token->type === Token::TYPE_SYMBOL || $token->type === Token::TYPE_NONE) {
                    $expr->name = $token->value;
                    if (!$expr->isConstraint) {
                        $state = 2;
                    }
                } elseif ($token->type === Token::TYPE_KEYWORD) {
                    if ($token->flags & Token::FLAG_KEYWORD_RESERVED) {
                        // Reserved keywords can't be used
                        // as field names without backquotes
                        $parser->error(
                            'A symbol name was expected! '
                            . 'A reserved keyword can not be used '
                            . 'as a column name without backquotes.',
                            $token
                        );

                        return $ret;
                    }

                    // Non-reserved keywords are allowed without backquotes
                    $expr->name = $token->value;
                    $state = 2;
                } else {
                    $parser->error(
                        'A symbol name was expected!',
                        $token
                    );

                    return $ret;
                }
            } elseif ($state === 2) {
                $expr->type = DataType::parse($parser, $list);
                $state = 3;
            } elseif ($state === 3) {
                if (($token->type === Token::TYPE_KEYWORD) && $token->keyword === 'CHECK') {
                    $expr->check = Check::parse($parser, $list);
                    $state = 4;
                } else {
                    $expr->options = OptionsArray::parse($parser, $list, static::$FIELD_OPTIONS);
                    $state = 4;
                }
            } elseif ($state === 4) {
                if ($token->type === Token::TYPE_KEYWORD && $token->keyword === 'REFERENCES') {
                    ++$list->idx; // Skipping keyword 'REFERENCES'.
                    $expr->references = Reference::parse($parser, $list);
                } else {
                    --$list->idx;
                }
                $state = 5;
            } elseif ($state === 5) {
                if ((!empty($expr->type)) || (!empty($expr->key)) || (!empty($expr->check))) {
                    $ret[] = $expr;
                }
                $expr = new self();
                if ($token->value === ',') {
                    $state = 1;
                } elseif ($token->value === ')') {
                    $state = 6;
                    ++$list->idx;
                    break;
                } else {
                    $parser->error(
                        'A comma or a closing bracket was expected.',
                        $token
                    );
                    $state = 0;
                    break;
                }
            }
        }

        // Last iteration was not saved.
        if ((!empty($expr->type)) || (!empty($expr->key)) || (!empty($expr->check))) {
            $ret[] = $expr;
        }

        if (($state !== 0) && ($state !== 6)) {
            $parser->error(
                'A closing bracket was expected.',
                $list->tokens[$list->idx - 1]
            );
        }

        --$list->idx;

        return $ret;
    }

    /**
     * @param CreateDefinition|CreateDefinition[] $component the component to be built
     * @param array                               $options   parameters for building
     *
     * @return string
     */
    public static function build($component, array $options = array())
    {
        if (is_array($component)) {
            return "(\n  " . implode(",\n  ", $component) . "\n)";
        }

        $tmp = '';

        if ($component->isConstraint) {
            $tmp .= 'CONSTRAINT ';
        }

        if ((isset($component->name)) && ($component->name !== '')) {
            $tmp .= Context::escape($component->name) . ' ';
        }

        if ($component->isConstraint) {
            $tmp .= Check::build($component->check);
        }

        if (!empty($component->type)) {
            $tmp .= DataType::build(
                $component->type,
                array('lowercase' => true)
            ) . ' ';
        }

        if (!empty($component->key)) {
            $tmp .= $component->key . ' ';
        }

        if (!empty($component->references)) {
            $tmp .= 'REFERENCES ' . $component->references . ' ';
        }

        $tmp .= $component->options;

        return trim($tmp);
    }
}


1			<?php
2
3			/**
4			* Parses the create definition of a column or a key.
5			*
6			* Used for parsing `CREATE TABLE` statement.
7			*/
8
9			namespace PhpMyAdmin\SqlParser\Components;
10
11			use PhpMyAdmin\SqlParser\Component;
12			use PhpMyAdmin\SqlParser\Context;
13			use PhpMyAdmin\SqlParser\Parser;
14			use PhpMyAdmin\SqlParser\Token;
15			use PhpMyAdmin\SqlParser\TokensList;
16
17			/**
18			* Parses the create definition of a column or a key.
19			*
20			* Used for parsing `CREATE TABLE` statement.
21			*
22			* @category Components
23			*
24			* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
25			*/
26			class CreateDefinition extends Component
27			{
28			/**
29			* All field options.
30			*
31			* @var array
32			*/
33			public static $FIELD_OPTIONS = array(
34			// Tells the `OptionsArray` to not sort the options.
35			// See the note below.
36			'_UNSORTED' => true,
37
38			'NOT NULL' => 1,
39			'NULL' => 1,
40			'DEFAULT' => array(2, 'expr', array('breakOnAlias' => true)),
41			/* Following are not according to grammar, but MySQL happily accepts
42			* these at any location */
43			'CHARSET' => array(2, 'var'),
44			'COLLATE' => array(3, 'var'),
45			'AUTO_INCREMENT' => 3,
46			'PRIMARY' => 4,
47			'PRIMARY KEY' => 4,
48			'UNIQUE' => 4,
49			'UNIQUE KEY' => 4,
50			'COMMENT' => array(5, 'var'),
51			'COLUMN_FORMAT' => array(6, 'var'),
52			'ON UPDATE' => array(7, 'expr'),
53
54			// Generated columns options.
55			'GENERATED ALWAYS' => 8,
56			'AS' => array(9, 'expr', array('parenthesesDelimited' => true)),
57			'VIRTUAL' => 10,
58			'PERSISTENT' => 11,
59			'STORED' => 11,
60			// Common entries.
61			//
62			// NOTE: Some of the common options are not in the same order which
63			// causes troubles when checking if the options are in the right order.
64			// I should find a way to define multiple sets of options and make the
65			// parser select the right set.
66			//
67			// 'UNIQUE' => 4,
68			// 'UNIQUE KEY' => 4,
69			// 'COMMENT' => array(5, 'var'),
70			// 'NOT NULL' => 1,
71			// 'NULL' => 1,
72			// 'PRIMARY' => 4,
73			// 'PRIMARY KEY' => 4,
74			);
75
76			/**
77			* The name of the new column.
78			*
79			* @var string
80			*/
81			public $name;
82
83			/**
84			* Whether this field is a constraint or not.
85			*
86			* @var bool
87			*/
88			public $isConstraint;
89
90			/**
91			* The data type of thew new column.
92			*
93			* @var DataType
94			*/
95			public $type;
96
97			/**
98			* The key.
99			*
100			* @var Key
101			*/
102			public $key;
103
104			/**
105			* Check constraint
106			*
107			* @var check
108			*/
109			public $check;
110
111			/**
112			* The table that is referenced.
113			*
114			* @var Reference
115			*/
116			public $references;
117
118			/**
119			* The options of this field.
120			*
121			* @var OptionsArray
122			*/
123			public $options;
124
125			/**
126			* Constructor.
127			*
128			* @param string $name the name of the field
			0 ignored issues – show Documentation introduced 2016-02-12 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$name` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
129			* @param OptionsArray $options the options of this field
			0 ignored issues – show Documentation introduced 2016-02-12 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$options` not be `OptionsArray\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
130			* @param DataType\|Key $type the data type of this field or the key
			0 ignored issues – show Documentation introduced 2016-02-12 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$type` not be `DataType\|Key\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
131			* @param bool $isConstraint whether this field is a constraint or not
132			* @param Reference $references references
			0 ignored issues – show Documentation introduced 2016-02-12 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$references` not be `Reference\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
133			*/
134	32		public function __construct(
135			$name = null,
136			$options = null,
137			$type = null,
138			$isConstraint = false,
139			$references = null
140			) {
141	32		$this->name = $name;
142	32		$this->options = $options;
143	32		if ($type instanceof DataType) {
144	1		$this->type = $type;
145	32		} elseif ($type instanceof Key) {
146	1		$this->key = $type;
147	1		$this->isConstraint = $isConstraint;
148	1		$this->references = $references;
149			}
150	32		}
151
152			/**
153			* @param Parser $parser the parser that serves as context
154			* @param TokensList $list the list of tokens that are being parsed
155			* @param array $options parameters for parsing
156			*
157			* @return CreateDefinition[]
158			*/
159	32		public static function parse(Parser $parser, TokensList $list, array $options = array())
160			{
161	32		$ret = array();
162
163	32		$expr = new self();
164
165			/**
166			* The state of the parser.
167			*
168			* Below are the states of the parser.
169			*
170			* 0 -----------------------[ ( ]------------------------> 1
171			*
172			* 1 --------------------[ CONSTRAINT ]------------------> 1
173			* 1 -----------------------[ key ]----------------------> 2
174			* 1 -------------[ constraint / column name ]-----------> 2
175			*
176			* 2 --------------------[ data type ]-------------------> 3
177			*
178			* 3 ---------------------[ options ]--------------------> 4
179			*
180			* 4 --------------------[ REFERENCES ]------------------> 4
181			*
182			* 5 ------------------------[ , ]-----------------------> 1
183			* 5 ------------------------[ ) ]-----------------------> 6 (-1)
184			*
185			* @var int
186			*/
187	32		$state = 0;
188
189	32		for (; $list->idx < $list->count; ++$list->idx) {
190			/**
191			* Token parsed at this moment.
192			*
193			* @var Token
194			*/
195	32		$token = $list->tokens[$list->idx];
196
197			// End of statement.
198	32		if ($token->type === Token::TYPE_DELIMITER) {
199	2		break;
200			}
201
202			// Skipping whitespaces and comments.
203	31		if (($token->type === Token::TYPE_WHITESPACE) \|\| ($token->type === Token::TYPE_COMMENT)) {
204	28		continue;
205			}
206
207	31		if ($state === 0) {
208	31		if (($token->type === Token::TYPE_OPERATOR) && ($token->value === '(')) {
209	30		$state = 1;
210			} else {
211	1		$parser->error(
212	1		'An opening bracket was expected.',
213	1		$token
214			);
215
216	1		break;
217			}
218	30		} elseif ($state === 1) {
219	30		if ($token->type === Token::TYPE_KEYWORD && $token->keyword === 'CONSTRAINT') {
220	5		$expr->isConstraint = true;
221	30		} elseif (($token->type === Token::TYPE_KEYWORD) && ($token->flags & Token::FLAG_KEYWORD_KEY)) {
222	11		$expr->key = Key::parse($parser, $list);
223	11		$state = 4;
224	30		} elseif (($token->type === Token::TYPE_KEYWORD) && $token->keyword === 'CHECK') {
225			$expr->check = Check::parse($parser, $list);
226			$state = 4;
227	30	View Code Duplication	} elseif ($token->type === Token::TYPE_SYMBOL \|\| $token->type === Token::TYPE_NONE) {
228	27		$expr->name = $token->value;
229	27		if (!$expr->isConstraint) {
230	27		$state = 2;
231			}
232	3		} elseif ($token->type === Token::TYPE_KEYWORD) {
233	2		if ($token->flags & Token::FLAG_KEYWORD_RESERVED) {
234			// Reserved keywords can't be used
235			// as field names without backquotes
236	1		$parser->error(
237			'A symbol name was expected! '
238			. 'A reserved keyword can not be used '
239	1		. 'as a column name without backquotes.',
240	1		$token
241			);
242
243	1		return $ret;
244			}
245
246			// Non-reserved keywords are allowed without backquotes
247	1		$expr->name = $token->value;
248	1		$state = 2;
249			} else {
250	1		$parser->error(
251	1		'A symbol name was expected!',
252	1		$token
253			);
254
255	1		return $ret;
256			}
257	28		} elseif ($state === 2) {
258	28		$expr->type = DataType::parse($parser, $list);
259	28		$state = 3;
260	28		} elseif ($state === 3) {
261	28		if (($token->type === Token::TYPE_KEYWORD) && $token->keyword === 'CHECK') {
262			$expr->check = Check::parse($parser, $list);
263			$state = 4;
264			} else {
265	28		$expr->options = OptionsArray::parse($parser, $list, static::$FIELD_OPTIONS);
266	28		$state = 4;
267			}
268	28		} elseif ($state === 4) {
269	28		if ($token->type === Token::TYPE_KEYWORD && $token->keyword === 'REFERENCES') {
270	4		++$list->idx; // Skipping keyword 'REFERENCES'.
271	4		$expr->references = Reference::parse($parser, $list);
272			} else {
273	28		--$list->idx;
274			}
275	28		$state = 5;
276	28		} elseif ($state === 5) {
277	28	View Code Duplication	if ((!empty($expr->type)) \|\| (!empty($expr->key)) \|\| (!empty($expr->check))) {
278	28		$ret[] = $expr;
279			}
280	28		$expr = new self();
281	28		if ($token->value === ',') {
282	19		$state = 1;
283	27		} elseif ($token->value === ')') {
284	26		$state = 6;
285	26		++$list->idx;
286	26		break;
287			} else {
288	1		$parser->error(
289	1		'A comma or a closing bracket was expected.',
290	1		$token
291			);
292	1		$state = 0;
293	1		break;
294			}
295			}
296			}
297
298			// Last iteration was not saved.
299	30	View Code Duplication	if ((!empty($expr->type)) \|\| (!empty($expr->key)) \|\| (!empty($expr->check))) {
300	1		$ret[] = $expr;
301			}
302
303	30	View Code Duplication	if (($state !== 0) && ($state !== 6)) {
304	1		$parser->error(
305	1		'A closing bracket was expected.',
306	1		$list->tokens[$list->idx - 1]
307			);
308			}
309
310	30		--$list->idx;
311
312	30		return $ret;
313			}
314
315			/**
316			* @param CreateDefinition\|CreateDefinition[] $component the component to be built
317			* @param array $options parameters for building
318			*
319			* @return string
320			*/
321	8		public static function build($component, array $options = array())
322			{
323	8		if (is_array($component)) {
324	7		return "(\n " . implode(",\n ", $component) . "\n)";
325			}
326
327	8		$tmp = '';
328
329	8		if ($component->isConstraint) {
330			$tmp .= 'CONSTRAINT ';
331			}
332
333	8		if ((isset($component->name)) && ($component->name !== '')) {
334	7		$tmp .= Context::escape($component->name) . ' ';
335			}
336
337	8		if ($component->isConstraint) {
338			$tmp .= Check::build($component->check);
339			}
340
341	8		if (!empty($component->type)) {
342	7		$tmp .= DataType::build(
343	7		$component->type,
344	7		array('lowercase' => true)
345	7		) . ' ';
346			}
347
348	8		if (!empty($component->key)) {
349	2		$tmp .= $component->key . ' ';
350			}
351
352	8		if (!empty($component->references)) {
353			$tmp .= 'REFERENCES ' . $component->references . ' ';
354			}
355
356	8		$tmp .= $component->options;
357
358	8		return trim($tmp);
359			}
360			}
361

phpmyadmin / sql-parser