JsFunctionsScanner - Code Metrics - Inspection of "Merge pull request #154 from AleksSem/master" - oscarotero/Gettext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 010d44...6c2765 )

by Oscar

created 2017-07-27 14:35 UTC

JsFunctionsScanner C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	233
Duplicated Lines	13.73 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	32
loc	233
rs	6.5957
c	0
b	0
f	0
wmc	56
lcom	1
cbo	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
F	getFunctions()	32	162	46
A	status()	0	10	3
A	downStatus()	0	4	1
A	upStatus()	0	4	1
A	prepareArgument()	0	6	4

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)
    {
        $this->code = $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 '\\':
                    $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:
                            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 && ($argument[0] === '"' || $argument[0] === "'")) {
            return substr($argument, 1, -1);
        }
    }
}


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		$this->code = $code;
18		}
19
20		/**
21		* {@inheritdoc}
22		*/
23		public function getFunctions(array $constants = [])
24		{
25		$length = strlen($this->code);
26		$line = 1;
27		$buffer = '';
28		$functions = [];
29		$bufferFunctions = [];
30		$char = null;
31
32		for ($pos = 0; $pos < $length; ++$pos) {
33		$prev = $char;
34		$char = $this->code[$pos];
35		$next = isset($this->code[$pos + 1]) ? $this->code[$pos + 1] : null;
36
37		switch ($char) {
38		case '\\':
39		$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...
40		$char = $next;
41		$pos++;
42		$next = isset($this->code[$pos]) ? $this->code[$pos] : null;
		0 ignored issues – show Unused Code introduced 2017-07-27 12:48 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...
43		break;
44
45		case "\n":
46		++$line;
47
48		if ($this->status('line-comment')) {
49		$this->upStatus();
50		}
51		break;
52
53		case '/':
54		switch ($this->status()) {
55		case 'simple-quote':
56		case 'double-quote':
57		case 'line-comment':
58		break;
59
60		case 'block-comment':
61		if ($prev === '*') {
62		$this->upStatus();
63		}
64		break;
65
66		default:
67		if ($next === '/') {
68		$this->downStatus('line-comment');
69		} elseif ($next === '*') {
70		$this->downStatus('block-comment');
71		}
72		break;
73		}
74		break;
75
76	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...
77		switch ($this->status()) {
78		case 'simple-quote':
79		$this->upStatus();
80		break;
81
82		case 'line-comment':
83		case 'block-comment':
84		case 'double-quote':
85		break;
86
87		default:
88		$this->downStatus('simple-quote');
89		break;
90		}
91		break;
92
93	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...
94		switch ($this->status()) {
95		case 'double-quote':
96		$this->upStatus();
97		break;
98
99		case 'line-comment':
100		case 'block-comment':
101		case 'simple-quote':
102		break;
103
104		default:
105		$this->downStatus('double-quote');
106		break;
107		}
108		break;
109
110		case '(':
111		switch ($this->status()) {
112		case 'simple-quote':
113		case 'double-quote':
114		case 'line-comment':
115		case 'block-comment':
116		case 'line-comment':
117		break;
118
119		default:
120		if ($buffer && preg_match('/(\w+)$/', $buffer, $matches)) {
121		$this->downStatus('function');
122		array_unshift($bufferFunctions, [$matches[1], $line, []]);
123		$buffer = '';
124		continue 3;
125		}
126		break;
127		}
128		break;
129
130		case ')':
131		switch ($this->status()) {
132		case 'function':
133		if (($argument = self::prepareArgument($buffer))) {
134		$bufferFunctions[0][2][] = $argument;
135		}
136
137		if (!empty($bufferFunctions)) {
138		$functions[] = array_shift($bufferFunctions);
139		}
140
141		$this->upStatus();
142		$buffer = '';
143		continue 3;
144		}
145		break;
146
147		case ',':
148		switch ($this->status()) {
149		case 'function':
150		if (($argument = self::prepareArgument($buffer))) {
151		$bufferFunctions[0][2][] = $argument;
152		}
153
154		$buffer = '';
155		continue 3;
156		}
157		break;
158
159		case ' ':
160		case '\t':
161		switch ($this->status()) {
162		case 'double-quote':
163		case 'simple-quote':
164		break;
165
166		default:
167		continue 3;
168		}
169		break;
170		}
171
172		switch ($this->status()) {
173		case 'line-comment':
174		case 'block-comment':
175		break;
176
177		default:
178		$buffer .= $char;
179		break;
180		}
181		}
182
183		return $functions;
184		}
185
186		/**
187		* Get the current context of the scan.
188		*
189		* @param null\|string $match To check whether the current status is this value
190		*
191		* @return string\|bool
192		*/
193		protected function status($match = null)
194		{
195		$status = isset($this->status[0]) ? $this->status[0] : null;
196
197		if ($match !== null) {
198		return $status === $match;
199		}
200
201		return $status;
202		}
203
204		/**
205		* Add a new status to the stack.
206		*
207		* @param string $status
208		*/
209		protected function downStatus($status)
210		{
211		array_unshift($this->status, $status);
212		}
213
214		/**
215		* Removes and return the current status.
216		*
217		* @return string\|null
218		*/
219		protected function upStatus()
220		{
221		return array_shift($this->status);
222		}
223
224		/**
225		* Prepares the arguments found in functions.
226		*
227		* @param string $argument
228		*
229		* @return string
230		*/
231		protected static function prepareArgument($argument)
232		{
233		if ($argument && ($argument[0] === '"' \|\| $argument[0] === "'")) {
234		return substr($argument, 1, -1);
235		}
236		}
237		}
238

oscarotero / Gettext