JsFunctionsScanner - Code Metrics - oscarotero/Gettext - Measure and Improve Code Quality continuously with Scrutinizer

JsFunctionsScanner F
last analyzed 2019-10-22 16:47 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	316
Duplicated Lines	16.14 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	51
loc	316
rs	2
c	0
b	0
f	0
wmc	81
lcom	1
cbo	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
F	getFunctions()	51	205	62
A	status()	0	10	3
A	downStatus()	0	4	1
A	upStatus()	0	4	1
A	prepareArgument()	0	6	3
B	convertString()	0	31	10

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':
                            if ($next !== "'") {
                                break 2;
                            }
                            break;

                        case 'double-quote':
                            if ($next !== '"') {
                                break 2;
                            }
                            break;

                        case 'back-tick':
                            if ($next !== '`') {
                                break 2;
                            }
                            break;
                    }

                    $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 'back-tick':
                        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':
                        case 'back-tick':
                            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':
                        case 'back-tick':
                            break;

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

                case '`':

                    switch ($this->status()) {
                        case 'back-tick':
                            $this->upStatus();
                            break;

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

                        default:
                            $this->downStatus('back-tick');
                            break;
                    }
                    break;

                case '(':
                    switch ($this->status()) {
                        case 'simple-quote':
                        case 'double-quote':
                        case 'back-tick':
                        case 'line-comment':
                        case 'block-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 = static::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 = static::prepareArgument($buffer))) {
                                $bufferFunctions[0][2][] = $argument;
                            }

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

                case ' ':
                case '\t':
                    switch ($this->status()) {
                        case 'double-quote':
                        case 'simple-quote':
                        case 'back-tick':
                            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)
    {
        if ($argument && in_array($argument[0], ['"', "'", '`'], true)) {
            return static::convertString(substr($argument, 1, -1));
        }
    }

    /**
     * Decodes a string with an argument.
     *
     * @param string $value
     *
     * @return string
     */
    protected static function convertString($value)
    {
        if (strpos($value, '\\') === false) {
            return $value;
        }

        return preg_replace_callback(
            '/\\\(n|r|t|v|e|f|"|\\\)/',
            function ($match) {
                switch ($match[1][0]) {
                    case 'n':
                        return "\n";
                    case 'r':
                        return "\r";
                    case 't':
                        return "\t";
                    case 'v':
                        return "\v";
                    case 'e':
                        return "\e";
                    case 'f':
                        return "\f";
                    case '"':
                        return '"';
                    case '\\':
                        return '\\';
                }
            },
            $value
        );
    }
}


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		if ($next !== "'") {
43		break 2;
44		}
45		break;
46
47		case 'double-quote':
48		if ($next !== '"') {
49		break 2;
50		}
51		break;
52
53		case 'back-tick':
54		if ($next !== '`') {
55		break 2;
56		}
57		break;
58		}
59
60		$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...
61		$char = $next;
62		$pos++;
63		$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...
64		break;
65
66		case "\n":
67		++$line;
68
69		if ($this->status('line-comment')) {
70		$this->upStatus();
71		}
72		break;
73
74		case '/':
75		switch ($this->status()) {
76		case 'simple-quote':
77		case 'double-quote':
78		case 'back-tick':
79		case 'line-comment':
80		break;
81
82		case 'block-comment':
83		if ($prev === '*') {
84		$this->upStatus();
85		}
86		break;
87
88		default:
89		if ($next === '/') {
90		$this->downStatus('line-comment');
91		} elseif ($next === '*') {
92		$this->downStatus('block-comment');
93		}
94		break;
95		}
96		break;
97
98	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...
99		switch ($this->status()) {
100		case 'simple-quote':
101		$this->upStatus();
102		break;
103
104		case 'line-comment':
105		case 'block-comment':
106		case 'double-quote':
107		case 'back-tick':
108		break;
109
110		default:
111		$this->downStatus('simple-quote');
112		break;
113		}
114		break;
115
116	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...
117		switch ($this->status()) {
118		case 'double-quote':
119		$this->upStatus();
120		break;
121
122		case 'line-comment':
123		case 'block-comment':
124		case 'simple-quote':
125		case 'back-tick':
126		break;
127
128		default:
129		$this->downStatus('double-quote');
130		break;
131		}
132		break;
133
134	View Code Duplication	case '`':
		0 ignored issues – show Duplication introduced 2019-07-08 07:54 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...
135		switch ($this->status()) {
136		case 'back-tick':
137		$this->upStatus();
138		break;
139
140		case 'line-comment':
141		case 'block-comment':
142		case 'simple-quote':
143		case 'double-quote':
144		break;
145
146		default:
147		$this->downStatus('back-tick');
148		break;
149		}
150		break;
151
152		case '(':
153		switch ($this->status()) {
154		case 'simple-quote':
155		case 'double-quote':
156		case 'back-tick':
157		case 'line-comment':
158		case 'block-comment':
159		break;
160
161		default:
162		if ($buffer && preg_match('/(\w+)$/', $buffer, $matches)) {
163		$this->downStatus('function');
164		array_unshift($bufferFunctions, [$matches[1], $line, []]);
165		$buffer = '';
166		continue 3;
167		}
168		break;
169		}
170		break;
171
172		case ')':
173		switch ($this->status()) {
174		case 'function':
175		if (($argument = static::prepareArgument($buffer))) {
176		$bufferFunctions[0][2][] = $argument;
177		}
178
179		if (!empty($bufferFunctions)) {
180		$functions[] = array_shift($bufferFunctions);
181		}
182
183		$this->upStatus();
184		$buffer = '';
185		continue 3;
186		}
187		break;
188
189		case ',':
190		switch ($this->status()) {
191		case 'function':
192		if (($argument = static::prepareArgument($buffer))) {
193		$bufferFunctions[0][2][] = $argument;
194		}
195
196		$buffer = '';
197		continue 3;
198		}
199		break;
200
201		case ' ':
202		case '\t':
203		switch ($this->status()) {
204		case 'double-quote':
205		case 'simple-quote':
206		case 'back-tick':
207		break;
208
209		default:
210		$buffer = '';
211		continue 3;
212		}
213		break;
214		}
215
216		switch ($this->status()) {
217		case 'line-comment':
218		case 'block-comment':
219		break;
220
221		default:
222		$buffer .= $char;
223		break;
224		}
225		}
226
227		return $functions;
228		}
229
230		/**
231		* Get the current context of the scan.
232		*
233		* @param null\|string $match To check whether the current status is this value
234		*
235		* @return string\|bool
236		*/
237		protected function status($match = null)
238		{
239		$status = isset($this->status[0]) ? $this->status[0] : null;
240
241		if ($match !== null) {
242		return $status === $match;
243		}
244
245		return $status;
246		}
247
248		/**
249		* Add a new status to the stack.
250		*
251		* @param string $status
252		*/
253		protected function downStatus($status)
254		{
255		array_unshift($this->status, $status);
256		}
257
258		/**
259		* Removes and return the current status.
260		*
261		* @return string\|null
262		*/
263		protected function upStatus()
264		{
265		return array_shift($this->status);
266		}
267
268		/**
269		* Prepares the arguments found in functions.
270		*
271		* @param string $argument
272		*
273		* @return string
274		*/
275		protected static function prepareArgument($argument)
276		{
277		if ($argument && in_array($argument[0], ['"', "'", '`'], true)) {
278		return static::convertString(substr($argument, 1, -1));
279		}
280		}
281
282		/**
283		* Decodes a string with an argument.
284		*
285		* @param string $value
286		*
287		* @return string
288		*/
289		protected static function convertString($value)
290		{
291		if (strpos($value, '\\') === false) {
292		return $value;
293		}
294
295		return preg_replace_callback(
296		'/\\\(n\|r\|t\|v\|e\|f\|"\|\\\)/',
297		function ($match) {
298		switch ($match[1][0]) {
299		case 'n':
300		return "\n";
301		case 'r':
302		return "\r";
303		case 't':
304		return "\t";
305		case 'v':
306		return "\v";
307		case 'e':
308		return "\e";
309		case 'f':
310		return "\f";
311		case '"':
312		return '"';
313		case '\\':
314		return '\\';
315		}
316		},
317		$value
318		);
319		}
320		}
321

oscarotero / Gettext

JsFunctionsScanner F last analyzed 2019-10-22 16:47 UTC