RenameOperation::__toString() - Code Metrics - Inspection of "Fix new property names on 6.0 for the custom seria..." - phpmyadmin/sql-parser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6c3f09...c54108 )

by William

created 2023-03-28 13:50 UTC

RenameOperation::__toString() A

↳ Parent: RenameOperation

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace PhpMyAdmin\SqlParser\Components;

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

use function implode;
use function is_array;

/**
 * `RENAME TABLE` keyword parser.
 */
final class RenameOperation implements Component
{
    /**
     * The old table name.
     *
     * @var Expression
     */
    public $old;

    /**
     * The new table name.
     *
     * @var Expression
     */
    public $new;

    /**
     * @param Expression $old old expression
     * @param Expression $new new expression containing new name
     */
    public function __construct($old = null, $new = null)
    {
        $this->old = $old;
        $this->new = $new;
    }

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

        $expr = new static();

        /**
         * The state of the parser.
         *
         * Below are the states of the parser.
         *
         *      0 ---------------------[ old name ]--------------------> 1
         *
         *      1 ------------------------[ TO ]-----------------------> 2
         *
         *      2 ---------------------[ new name ]--------------------> 3
         *
         *      3 ------------------------[ , ]------------------------> 0
         *      3 -----------------------[ else ]----------------------> (END)
         *
         * @var int
         */
        $state = 0;

        for (; $list->idx < $list->count; ++$list->idx) {
            /**
             * Token parsed at this moment.
             */
            $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) {
                $expr->old = Expression::parse(
                    $parser,
                    $list,
                    [
                        'breakOnAlias' => true,
                        'parseField' => 'table',
                    ]
                );
                if (empty($expr->old)) {
                    $parser->error('The old name of the table was expected.', $token);
                }

                $state = 1;
            } elseif ($state === 1) {
                if ($token->type !== Token::TYPE_KEYWORD || $token->keyword !== 'TO') {
                    $parser->error('Keyword "TO" was expected.', $token);
                    break;
                }

                $state = 2;
            } elseif ($state === 2) {
                $expr->new = Expression::parse(
                    $parser,
                    $list,
                    [
                        'breakOnAlias' => true,
                        'parseField' => 'table',
                    ]
                );
                if (empty($expr->new)) {
                    $parser->error('The new name of the table was expected.', $token);
                }

                $state = 3;
            } elseif ($state === 3) {
                if (($token->type !== Token::TYPE_OPERATOR) || ($token->value !== ',')) {
                    break;
                }

                $ret[] = $expr;
                $expr = new static();
                $state = 0;
            }
        }

        if ($state !== 3) {

            $parser->error('A rename operation was expected.', $list->tokens[$list->idx - 1]);
        }

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

        --$list->idx;

        return $ret;
    }

    /**
     * @param RenameOperation      $component the component to be built
     * @param array<string, mixed> $options   parameters for building
     */
    public static function build($component, array $options = []): string
    {
        if (is_array($component)) {

            return implode(', ', $component);
        }

        return $component->old . ' TO ' . $component->new;
    }

    public function __toString(): string
    {
        return static::build($this);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace PhpMyAdmin\SqlParser\Components;
6
7		use PhpMyAdmin\SqlParser\Component;
8		use PhpMyAdmin\SqlParser\Parser;
9		use PhpMyAdmin\SqlParser\Token;
10		use PhpMyAdmin\SqlParser\TokensList;
11
12		use function implode;
13		use function is_array;
14
15		/**
16		* `RENAME TABLE` keyword parser.
17		*/
18		final class RenameOperation implements Component
19		{
20		/**
21		* The old table name.
22		*
23		* @var Expression
24		*/
25		public $old;
26
27		/**
28		* The new table name.
29		*
30		* @var Expression
31		*/
32		public $new;
33
34		/**
35		* @param Expression $old old expression
36		* @param Expression $new new expression containing new name
37		*/
38	18	public function __construct($old = null, $new = null)
39		{
40	18	$this->old = $old;
41	18	$this->new = $new;
42		}
43
44		/**
45		* @param Parser $parser the parser that serves as context
46		* @param TokensList $list the list of tokens that are being parsed
47		* @param array<string, mixed> $options parameters for parsing
48		*
49		* @return RenameOperation[]
50		*/
51	18	public static function parse(Parser $parser, TokensList $list, array $options = [])
52		{
53	18	$ret = [];
54
55	18	$expr = new static();
56
57		/**
58		* The state of the parser.
59		*
60		* Below are the states of the parser.
61		*
62		* 0 ---------------------[ old name ]--------------------> 1
63		*
64		* 1 ------------------------[ TO ]-----------------------> 2
65		*
66		* 2 ---------------------[ new name ]--------------------> 3
67		*
68		* 3 ------------------------[ , ]------------------------> 0
69		* 3 -----------------------[ else ]----------------------> (END)
70		*
71		* @var int
72		*/
73	18	$state = 0;
74
75	18	for (; $list->idx < $list->count; ++$list->idx) {
76		/**
77		* Token parsed at this moment.
78		*/
79	18	$token = $list->tokens[$list->idx];
80
81		// End of statement.
82	18	if ($token->type === Token::TYPE_DELIMITER) {
83	14	break;
84		}
85
86		// Skipping whitespaces and comments.
87	18	if (($token->type === Token::TYPE_WHITESPACE) \|\| ($token->type === Token::TYPE_COMMENT)) {
88	14	continue;
89		}
90
91	18	if ($state === 0) {
92	18	$expr->old = Expression::parse(
93	18	$parser,
94	18	$list,
95	18	[
96	18	'breakOnAlias' => true,
97	18	'parseField' => 'table',
98	18	]
99	18	);
100	18	if (empty($expr->old)) {
101	2	$parser->error('The old name of the table was expected.', $token);
102		}
103
104	18	$state = 1;
105	16	} elseif ($state === 1) {
106	16	if ($token->type !== Token::TYPE_KEYWORD \|\| $token->keyword !== 'TO') {
107	2	$parser->error('Keyword "TO" was expected.', $token);
108	2	break;
109		}
110
111	14	$state = 2;
112	14	} elseif ($state === 2) {
113	14	$expr->new = Expression::parse(
114	14	$parser,
115	14	$list,
116	14	[
117	14	'breakOnAlias' => true,
118	14	'parseField' => 'table',
119	14	]
120	14	);
121	14	if (empty($expr->new)) {
122	2	$parser->error('The new name of the table was expected.', $token);
123		}
124
125	14	$state = 3;
126	10	} elseif ($state === 3) {
127	10	if (($token->type !== Token::TYPE_OPERATOR) \|\| ($token->value !== ',')) {
128	2	break;
129		}
130
131	8	$ret[] = $expr;
132	8	$expr = new static();
133	8	$state = 0;
134		}
135		}
136
137	18	if ($state !== 3) {
		0 ignored issues – show introduced 2020-08-16 13:42 UTC by Report Bug Copy Issue Report The condition `$state !== 3` is always `true`. Loading history...
138	4	$parser->error('A rename operation was expected.', $list->tokens[$list->idx - 1]);
139		}
140
141		// Last iteration was not saved.
142	18	if (! empty($expr->old)) {
143	16	$ret[] = $expr;
144		}
145
146	18	--$list->idx;
147
148	18	return $ret;
149		}
150
151		/**
152		* @param RenameOperation $component the component to be built
153		* @param array<string, mixed> $options parameters for building
154		*/
155	4	public static function build($component, array $options = []): string
156		{
157	4	if (is_array($component)) {
		0 ignored issues – show introduced 2020-08-16 13:42 UTC by Report Bug Copy Issue Report The condition `is_array($component)` is always `false`. Loading history...
158	4	return implode(', ', $component);
159		}
160
161	4	return $component->old . ' TO ' . $component->new;
162		}
163
164	4	public function __toString(): string
165		{
166	4	return static::build($this);
167		}
168		}
169

phpmyadmin / sql-parser

Push — master ( 6c3f09...c54108 )

RenameOperation::__toString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like