JsFunctionsScanner - Code Metrics - Inspection of "Fix stripping backslash from new line characters i..." - oscarotero/Gettext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#201)

unknown

created 2019-03-24 23:32 UTC

JsFunctionsScanner D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	258
Duplicated Lines	12.4 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	32
loc	258
rs	4.08
c	0
b	0
f	0
wmc	59
lcom	1
cbo	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
F	getFunctions()	32	173	48
A	status()	0	10	3
A	downStatus()	0	4	1
A	upStatus()	0	4	1
A	prepareArgument()	0	19	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 JsFunctionsScanner 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 JsFunctionsScanner, and based on these observations, apply Extract Interface, too.

<?php

namespace Gettext\Utils;

class JsFunctionsScanner extends FunctionsScanner
{
    protected $code;
    protected $status = [];

    /**
     * Constructor.
     *
     * @param string $code The php code to scan
     */
    public function __construct($code)
    {
        // Normalize newline characters
        $this->code = str_replace(["\r\n", "\n\r", "\r"], "\n", $code);
    }

    /**
     * {@inheritdoc}
     */
    public function getFunctions(array $constants = [])
    {
        $length = strlen($this->code);
        $line = 1;
        $buffer = '';
        $functions = [];
        $bufferFunctions = [];
        $char = null;

        for ($pos = 0; $pos < $length; ++$pos) {
            $prev = $char;
            $char = $this->code[$pos];
            $next = isset($this->code[$pos + 1]) ? $this->code[$pos + 1] : null;

            switch ($char) {
                case '\\':
                    switch ($this->status()) {
                        case 'simple-quote':
                            break 2;
                        case 'double-quote':
                            break 2;

                        default:

                            $prev = $char;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                            $char = $next;
                            $pos++;
                            $next = isset($this->code[$pos]) ? $this->code[$pos] : null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

                            break;
                    }

                case "\n":
                    ++$line;

                    if ($this->status('line-comment')) {
                        $this->upStatus();
                    }
                    break;

                case '/':
                    switch ($this->status()) {
                        case 'simple-quote':
                        case 'double-quote':
                        case 'line-comment':
                            break;

                        case 'block-comment':
                            if ($prev === '*') {
                                $this->upStatus();
                            }
                            break;

                        default:
                            if ($next === '/') {
                                $this->downStatus('line-comment');
                            } elseif ($next === '*') {
                                $this->downStatus('block-comment');
                            }
                            break;
                    }
                    break;

                case "'":

                    switch ($this->status()) {
                        case 'simple-quote':
                            $this->upStatus();
                            break;

                        case 'line-comment':
                        case 'block-comment':
                        case 'double-quote':
                            break;

                        default:
                            $this->downStatus('simple-quote');
                            break;
                    }
                    break;

                case '"':

                    switch ($this->status()) {
                        case 'double-quote':
                            $this->upStatus();
                            break;

                        case 'line-comment':
                        case 'block-comment':
                        case 'simple-quote':
                            break;

                        default:
                            $this->downStatus('double-quote');
                            break;
                    }
                    break;

                case '(':
                    switch ($this->status()) {
                        case 'simple-quote':
                        case 'double-quote':
                        case 'line-comment':
                        case 'block-comment':
                        case 'line-comment':
                            break;

                        default:
                            if ($buffer && preg_match('/(\w+)$/', $buffer, $matches)) {
                                $this->downStatus('function');
                                array_unshift($bufferFunctions, [$matches[1], $line, []]);
                                $buffer = '';
                                continue 3;
                            }
                            break;
                    }
                    break;

                case ')':
                    switch ($this->status()) {
                        case 'function':
                            if (($argument = self::prepareArgument($buffer))) {
                                $bufferFunctions[0][2][] = $argument;
                            }

                            if (!empty($bufferFunctions)) {
                                $functions[] = array_shift($bufferFunctions);
                            }

                            $this->upStatus();
                            $buffer = '';
                            continue 3;
                    }
                    break;

                case ',':
                    switch ($this->status()) {
                        case 'function':
                            if (($argument = self::prepareArgument($buffer))) {
                                $bufferFunctions[0][2][] = $argument;
                            }

                            $buffer = '';
                            continue 3;
                    }
                    break;

                case ' ':
                case '\t':
                    switch ($this->status()) {
                        case 'double-quote':
                        case 'simple-quote':
                            break;

                        default:
                            $buffer = '';
                            continue 3;
                    }
                    break;
            }

            switch ($this->status()) {
                case 'line-comment':
                case 'block-comment':
                    break;

                default:
                    $buffer .= $char;
                    break;
            }
        }

        return $functions;
    }

    /**
     * Get the current context of the scan.
     *
     * @param null|string $match To check whether the current status is this value
     *
     * @return string|bool
     */
    protected function status($match = null)
    {
        $status = isset($this->status[0]) ? $this->status[0] : null;

        if ($match !== null) {
            return $status === $match;
        }

        return $status;
    }

    /**
     * Add a new status to the stack.
     *
     * @param string $status
     */
    protected function downStatus($status)
    {
        array_unshift($this->status, $status);
    }

    /**
     * Removes and return the current status.
     *
     * @return string|null
     */
    protected function upStatus()
    {
        return array_shift($this->status);
    }

    /**
     * Prepares the arguments found in functions.
     *
     * @param string $argument
     *
     * @return string
     */
    protected static function prepareArgument($argument)
    {
        $argument = isset($argument) ? $argument : '';

        if (!$argument) {
            return null;
        }

        if ($argument[0] === '"' || $argument[0] === "'") {
            $argument = substr($argument, 1, -1);
        }

        $replace = [
            '\n' => "\n",
            '\t' => "\t",
        ];

        return str_replace(array_keys($replace), array_values($replace), $argument);
    }
}


1		<?php
2
3		namespace Gettext\Utils;
4
5		class JsFunctionsScanner extends FunctionsScanner
6		{
7		protected $code;
8		protected $status = [];
9
10		/**
11		* Constructor.
12		*
13		* @param string $code The php code to scan
14		*/
15		public function __construct($code)
16		{
17		// Normalize newline characters
18		$this->code = str_replace(["\r\n", "\n\r", "\r"], "\n", $code);
19		}
20
21		/**
22		* {@inheritdoc}
23		*/
24		public function getFunctions(array $constants = [])
25		{
26		$length = strlen($this->code);
27		$line = 1;
28		$buffer = '';
29		$functions = [];
30		$bufferFunctions = [];
31		$char = null;
32
33		for ($pos = 0; $pos < $length; ++$pos) {
34		$prev = $char;
35		$char = $this->code[$pos];
36		$next = isset($this->code[$pos + 1]) ? $this->code[$pos + 1] : null;
37
38		switch ($char) {
39		case '\\':
40		switch ($this->status()) {
41		case 'simple-quote':
42		break 2;
43		case 'double-quote':
44		break 2;
45
46		default:
47
48		$prev = $char;
		0 ignored issues – show Unused Code introduced 2017-07-27 12:48 UTC by Report Bug Copy Issue Report `$prev` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
49		$char = $next;
50		$pos++;
51		$next = isset($this->code[$pos]) ? $this->code[$pos] : null;
		0 ignored issues – show Unused Code introduced 2019-03-21 15:25 UTC by Report Bug Copy Issue Report `$next` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
52
53		break;
54		}
55
56		case "\n":
57		++$line;
58
59		if ($this->status('line-comment')) {
60		$this->upStatus();
61		}
62		break;
63
64		case '/':
65		switch ($this->status()) {
66		case 'simple-quote':
67		case 'double-quote':
68		case 'line-comment':
69		break;
70
71		case 'block-comment':
72		if ($prev === '*') {
73		$this->upStatus();
74		}
75		break;
76
77		default:
78		if ($next === '/') {
79		$this->downStatus('line-comment');
80		} elseif ($next === '*') {
81		$this->downStatus('block-comment');
82		}
83		break;
84		}
85		break;
86
87	View Code Duplication	case "'":
		0 ignored issues – show Duplication introduced 2015-11-24 13: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...
88		switch ($this->status()) {
89		case 'simple-quote':
90		$this->upStatus();
91		break;
92
93		case 'line-comment':
94		case 'block-comment':
95		case 'double-quote':
96		break;
97
98		default:
99		$this->downStatus('simple-quote');
100		break;
101		}
102		break;
103
104	View Code Duplication	case '"':
		0 ignored issues – show Duplication introduced 2015-11-24 13: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...
105		switch ($this->status()) {
106		case 'double-quote':
107		$this->upStatus();
108		break;
109
110		case 'line-comment':
111		case 'block-comment':
112		case 'simple-quote':
113		break;
114
115		default:
116		$this->downStatus('double-quote');
117		break;
118		}
119		break;
120
121		case '(':
122		switch ($this->status()) {
123		case 'simple-quote':
124		case 'double-quote':
125		case 'line-comment':
126		case 'block-comment':
127		case 'line-comment':
128		break;
129
130		default:
131		if ($buffer && preg_match('/(\w+)$/', $buffer, $matches)) {
132		$this->downStatus('function');
133		array_unshift($bufferFunctions, [$matches[1], $line, []]);
134		$buffer = '';
135		continue 3;
136		}
137		break;
138		}
139		break;
140
141		case ')':
142		switch ($this->status()) {
143		case 'function':
144		if (($argument = self::prepareArgument($buffer))) {
145		$bufferFunctions[0][2][] = $argument;
146		}
147
148		if (!empty($bufferFunctions)) {
149		$functions[] = array_shift($bufferFunctions);
150		}
151
152		$this->upStatus();
153		$buffer = '';
154		continue 3;
155		}
156		break;
157
158		case ',':
159		switch ($this->status()) {
160		case 'function':
161		if (($argument = self::prepareArgument($buffer))) {
162		$bufferFunctions[0][2][] = $argument;
163		}
164
165		$buffer = '';
166		continue 3;
167		}
168		break;
169
170		case ' ':
171		case '\t':
172		switch ($this->status()) {
173		case 'double-quote':
174		case 'simple-quote':
175		break;
176
177		default:
178		$buffer = '';
179		continue 3;
180		}
181		break;
182		}
183
184		switch ($this->status()) {
185		case 'line-comment':
186		case 'block-comment':
187		break;
188
189		default:
190		$buffer .= $char;
191		break;
192		}
193		}
194
195		return $functions;
196		}
197
198		/**
199		* Get the current context of the scan.
200		*
201		* @param null\|string $match To check whether the current status is this value
202		*
203		* @return string\|bool
204		*/
205		protected function status($match = null)
206		{
207		$status = isset($this->status[0]) ? $this->status[0] : null;
208
209		if ($match !== null) {
210		return $status === $match;
211		}
212
213		return $status;
214		}
215
216		/**
217		* Add a new status to the stack.
218		*
219		* @param string $status
220		*/
221		protected function downStatus($status)
222		{
223		array_unshift($this->status, $status);
224		}
225
226		/**
227		* Removes and return the current status.
228		*
229		* @return string\|null
230		*/
231		protected function upStatus()
232		{
233		return array_shift($this->status);
234		}
235
236		/**
237		* Prepares the arguments found in functions.
238		*
239		* @param string $argument
240		*
241		* @return string
242		*/
243		protected static function prepareArgument($argument)
244		{
245		$argument = isset($argument) ? $argument : '';
246
247		if (!$argument) {
248		return null;
249		}
250
251		if ($argument[0] === '"' \|\| $argument[0] === "'") {
252		$argument = substr($argument, 1, -1);
253		}
254
255		$replace = [
256		'\n' => "\n",
257		'\t' => "\t",
258		];
259
260		return str_replace(array_keys($replace), array_values($replace), $argument);
261		}
262		}
263

oscarotero / Gettext