Scanner - Code Metrics - Inspection of "Added integration with Markdown" - XaBerr/JATE - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9ad54b...895d73 )

by Federico

created 2016-08-26 18:08 UTC

Scanner B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	283
Duplicated Lines	4.24 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	12
loc	283
rs	8.439
wmc	47
lcom	1
cbo	2

18 Methods

Rating	Name	Duplication	Size	Complexity
A	scan()	0	8	4
B	scanComment()	0	15	5
A	scanInterpolation()	0	4	1
B	scanTag()	0	21	5
A	scanFilter()	0	4	1
A	scanDoctype()	0	4	1
A	scanId()	0	4	1
A	scanClassName()	0	20	1
A	scanText()	0	4	1
A	scanAssignment()	0	8	3
A	scanConditional()	0	18	2
A	scanEach()	12	12	2
B	scanCustomKeyword()	0	16	5
A	scanCode()	0	14	4
B	scanAttributes()	0	29	5
A	scanPipelessText()	0	16	4
A	scanColon()	0	4	1
A	scanAndAttributes()	0	4	1

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

<?php

namespace Jade\Lexer;

/**
 * Class Jade\Lexer\Scanner.
 */
abstract class Scanner extends MixinScanner
{
    /**
     *  Helper to create tokens.
     */
    protected function scan($regex, $type, $captureIndex = 1)
    {
        if (preg_match($regex, $this->input, $matches)) {
            $this->consume($matches[0]);

            return $this->token($type, isset($matches[$captureIndex]) && strlen($matches[$captureIndex]) > 0 ? $matches[$captureIndex] : '');
        }
    }

    /**
     * Scan comment from input & return it if found.
     *
     * @return object|null
     */
    protected function scanComment()
    {
        $indent = count($this->indentStack) ? $this->indentStack[0] : 0;
        if (preg_match('/^ *\/\/(-)?([^\n]*(\n+[ \t]{' . ($indent + 1) . ',}[^\n]*)*)/', $this->input, $matches)) {
            $this->consume($matches[0]);
            $value = isset($matches[2]) ? $matches[2] : '';
            if (isset($matches[3])) {
                $value .= "\n";
            }
            $token = $this->token('comment', $value);
            $token->buffer = '-' !== $matches[1];

            return $token;
        }
    }

    /**
     * @return object
     */
    protected function scanInterpolation()
    {
        return $this->scan('/^#{(.*?)}/', 'interpolation');
    }

    /**
     * @return object
     */
    protected function scanTag()
    {
        if (preg_match('/^(\w[-:\w]*)(\/?)/', $this->input, $matches)) {
            $this->consume($matches[0]);
            $name = $matches[1];

            if (':' === substr($name, -1) && ':' !== substr($name, -2, 1)) {
                $name = substr($name, 0, -1);
                $this->defer($this->token(':'));

                while (' ' === substr($this->input, 0, 1)) {
                    $this->consume(' ');
                }
            }

            $token = $this->token('tag', $name);
            $token->selfClosing = ($matches[2] === '/');

            return $token;
        }
    }

    /**
     * @return object
     */
    protected function scanFilter()
    {
        return $this->scan('/^(?<!:):(?!:)(\w+(?:-\w+)*)/', 'filter');
    }

    /**
     * @return object
     */
    protected function scanDoctype()
    {
        return $this->scan('/^(?:!!!|doctype) *([^\n]+)?/', 'doctype');
    }

    /**
     * @return object
     */
    protected function scanId()
    {
        return $this->scan('/^#([\w-]+)/', 'id');
    }

    /**
     * @return object
     */
    protected function scanClassName()
    {
        // http://www.w3.org/TR/CSS21/grammar.html#scanner
        //
        // ident:
        //      -?{nmstart}{nmchar}*

        // nmstart:
        //      [_a-z]|{nonascii}|{escape}

        // nonascii:
        //      [\240-\377]
        // escape:
        //      {unicode}|\\[^\r\n\f0-9a-f]

        // unicode:
        //      \\{h}{1,6}(\r\n|[ \t\r\n\f])?

        // nmchar:
        //      [_a-z0-9-]|{nonascii}|{escape}

        //
        // /^(-?(?!=[0-9-])(?:[_a-z0-9-]|[\240-\377]|\\{h}{1,6}(?:\r\n|[ \t\r\n\f])?|\\[^\r\n\f0-9a-f])+)/

        return $this->scan('/^\.([\w-]+)/', 'class');
    }

    /**
     * @return object
     */
    protected function scanText()
    {
        return $this->scan('/^(?:\| ?| ?)?([^\n]+)/', 'text');
    }

    /**
     * @return object
     */
    protected function scanAssignment()
    {
        if (preg_match('/^(\$?\w+) += *([^;\n]+|\'[^\']+\'|"[^"]+")( *;? *)/', $this->input, $matches)) {
            $this->consume($matches[0]);

            return $this->token('code', (substr($matches[1], 0, 1) === '$' ? '' : '$') . $matches[1] . '=' . $matches[2]);
        }
    }

    /**
     * @return object
     */
    protected function scanConditional()
    {
        if (preg_match('/^(if|unless|else if|elseif|else|while)\b([^\n]*)/', $this->input, $matches)) {
            $this->consume($matches[0]);

            /*switch ($matches[1]) {

                case 'if': $code = 'if (' . $matches[2] . '):'; break;
                case 'unless': $code = 'if (!(' . $matches[2] . ')):'; break;
                case 'else if': $code = 'elseif (' . $matches[2] . '):'; break;
                case 'else': $code = 'else (' . $matches[2] . '):'; break;
            }*/
            $code = $this->normalizeCode($matches[0]);
            $token = $this->token('code', $code);
            $token->buffer = false;

            return $token;
        }
    }

    /**
     * @return object
     */
    protected function scanEach()

    {
        if (preg_match('/^(?:- *)?(?:each|for) +(\w+)(?: *, *(\w+))? +in *([^\n]+)/', $this->input, $matches)) {
            $this->consume($matches[0]);

            $token = $this->token('each', $matches[1]);
            $token->key = $matches[2];
            $token->code = $this->normalizeCode($matches[3]);

            return $token;
        }
    }

    /**
     * @return object
     */
    protected function scanCustomKeyword()
    {
        if (
            count($this->customKeywords) &&
class MyClass { }

$x = new MyClass();
$x->foo = true;
            preg_match('/^([\w-]+)([^\n]*)/', $this->input, $matches) &&
            isset($this->customKeywords[$matches[1]]) &&
            is_callable($this->customKeywords[$matches[1]])
        ) {
            $this->consume($matches[0]);

            $token = $this->token('customKeyword', $matches[1]);
            $token->args = trim($matches[2]);

            return $token;
        }
    }

    /**
     * @return object
     */
    protected function scanCode()
    {
        if (preg_match('/^(!?=|-)([^\n]+)/', $this->input, $matches)) {
            $this->consume($matches[0]);
            $flags = $matches[1];
            $code = $this->normalizeCode($matches[2]);

            $token = $this->token('code', $code);
            $token->escape = $flags[0] === '=';
            $token->buffer = '=' === $flags[0] || (isset($flags[1]) && '=' === $flags[1]);

            return $token;
        }
    }

    /**
     * @throws \ErrorException
     *
     * @return object
     */
    protected function scanAttributes()
    {
        if (substr($this->input, 0, 1) === '(') {
            // cant use ^ anchor in the regex because the pattern is recursive
            // but this restriction is asserted by the if above
            //$this->input = preg_replace('/([a-zA-Z0-9\'"\\]\\}\\)])([\t ]+[a-zA-Z])/', '$1,$2', $this->input);
            if (!preg_match('/\((?:"(?:\\\\.|[^"\\\\])*"|\'(?:\\\\.|[^\'\\\\])*\'|[^()\'"]++|(?R))*+\)/', $this->input, $matches)) {
                throw new \ErrorException('Unable to find attributes closing parenthesis.', 21);
            }
            $this->consume($matches[0]);

            //$str = preg_replace('/()([a-zA-Z0-9_\\x7f-\\xff\\)\\]\\}"\'])(\s+[a-zA-Z_])/', '$1,$2', $str);

            $token = $this->token('attributes');
            $token->attributes = array();
            $token->escaped = array();
            $token->selfClosing = false;

            $parser = new Attributes($token);
            $parser->parseWith(substr($matches[0], 1, strlen($matches[0]) - 2));

            if ($this->length() && '/' === $this->input[0]) {
                $this->consume(1);
                $token->selfClosing = true;
            }

            return $token;
        }
    }

    /**
     * @return object
     */
    protected function scanPipelessText()
    {
        if ($this->pipeless && "\n" !== substr($this->input, 0, 1)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $pos = strpos($this->input, "\n");

            if ($pos === false) {
                $pos = $this->length();
            }

            $str = substr($this->input, 0, $pos); // do not include the \n char

            $this->consume($str);

            return $this->token('text', ltrim($str));
        }
    }

    /**
     * @return object
     */
    protected function scanColon()
    {
        return $this->scan('/^:(?!:) */', ':');
    }

    /**
     * @return object
     */
    protected function scanAndAttributes()
    {
        return $this->scan('/^&attributes(\(((?>[^()]+|(?1))*)\))/', '&attributes', 2);
    }
}


1		<?php
2
3		namespace Jade\Lexer;
4
5		/**
6		* Class Jade\Lexer\Scanner.
7		*/
8		abstract class Scanner extends MixinScanner
9		{
10		/**
11		* Helper to create tokens.
12		*/
13		protected function scan($regex, $type, $captureIndex = 1)
14		{
15		if (preg_match($regex, $this->input, $matches)) {
16		$this->consume($matches[0]);
17
18		return $this->token($type, isset($matches[$captureIndex]) && strlen($matches[$captureIndex]) > 0 ? $matches[$captureIndex] : '');
19		}
20		}
21
22		/**
23		* Scan comment from input & return it if found.
24		*
25		* @return object\|null
26		*/
27		protected function scanComment()
28		{
29		$indent = count($this->indentStack) ? $this->indentStack[0] : 0;
30		if (preg_match('/^ \/\/(-)?([^\n](\n+[ \t]{' . ($indent + 1) . ',}[^\n]))/', $this->input, $matches)) {
31		$this->consume($matches[0]);
32		$value = isset($matches[2]) ? $matches[2] : '';
33		if (isset($matches[3])) {
34		$value .= "\n";
35		}
36		$token = $this->token('comment', $value);
37		$token->buffer = '-' !== $matches[1];
38
39		return $token;
40		}
41		}
42
43		/**
44		* @return object
45		*/
46		protected function scanInterpolation()
47		{
48		return $this->scan('/^#{(.*?)}/', 'interpolation');
49		}
50
51		/**
52		* @return object
53		*/
54		protected function scanTag()
55		{
56		if (preg_match('/^(\w[-:\w]*)(\/?)/', $this->input, $matches)) {
57		$this->consume($matches[0]);
58		$name = $matches[1];
59
60		if (':' === substr($name, -1) && ':' !== substr($name, -2, 1)) {
61		$name = substr($name, 0, -1);
62		$this->defer($this->token(':'));
63
64		while (' ' === substr($this->input, 0, 1)) {
65		$this->consume(' ');
66		}
67		}
68
69		$token = $this->token('tag', $name);
70		$token->selfClosing = ($matches[2] === '/');
71
72		return $token;
73		}
74		}
75
76		/**
77		* @return object
78		*/
79		protected function scanFilter()
80		{
81		return $this->scan('/^(?<!:):(?!:)(\w+(?:-\w+)*)/', 'filter');
82		}
83
84		/**
85		* @return object
86		*/
87		protected function scanDoctype()
88		{
89		return $this->scan('/^(?:!!!\|doctype) *([^\n]+)?/', 'doctype');
90		}
91
92		/**
93		* @return object
94		*/
95		protected function scanId()
96		{
97		return $this->scan('/^#([\w-]+)/', 'id');
98		}
99
100		/**
101		* @return object
102		*/
103		protected function scanClassName()
104		{
105		// http://www.w3.org/TR/CSS21/grammar.html#scanner
106		//
107		// ident:
108		// -?{nmstart}{nmchar}*
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
109		// nmstart:
110		// [_a-z]\|{nonascii}\|{escape}
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
111		// nonascii:
112		// [\240-\377]
113		// escape:
114		// {unicode}\|\\[^\r\n\f0-9a-f]
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report `47%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
115		// unicode:
116		// \\{h}{1,6}(\r\n\|[ \t\r\n\f])?
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report `69%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
117		// nmchar:
118		// [_a-z0-9-]\|{nonascii}\|{escape}
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report `53%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
119		//
120		// /^(-?(?!=[0-9-])(?:[_a-z0-9-]\|[\240-\377]\|\\{h}{1,6}(?:\r\n\|[ \t\r\n\f])?\|\\[^\r\n\f0-9a-f])+)/
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report `62%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
121		return $this->scan('/^\.([\w-]+)/', 'class');
122		}
123
124		/**
125		* @return object
126		*/
127		protected function scanText()
128		{
129		return $this->scan('/^(?:\\| ?\| ?)?([^\n]+)/', 'text');
130		}
131
132		/**
133		* @return object
134		*/
135		protected function scanAssignment()
136		{
137		if (preg_match('/^(\$?\w+) += ([^;\n]+\|\'[^\']+\'\|"[^"]+")( ;? *)/', $this->input, $matches)) {
138		$this->consume($matches[0]);
139
140		return $this->token('code', (substr($matches[1], 0, 1) === '$' ? '' : '$') . $matches[1] . '=' . $matches[2]);
141		}
142		}
143
144		/**
145		* @return object
146		*/
147		protected function scanConditional()
148		{
149		if (preg_match('/^(if\|unless\|else if\|elseif\|else\|while)\b([^\n]*)/', $this->input, $matches)) {
150		$this->consume($matches[0]);
151
152		/*switch ($matches[1]) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report `53%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
153		case 'if': $code = 'if (' . $matches[2] . '):'; break;
154		case 'unless': $code = 'if (!(' . $matches[2] . ')):'; break;
155		case 'else if': $code = 'elseif (' . $matches[2] . '):'; break;
156		case 'else': $code = 'else (' . $matches[2] . '):'; break;
157		}*/
158		$code = $this->normalizeCode($matches[0]);
159		$token = $this->token('code', $code);
160		$token->buffer = false;
161
162		return $token;
163		}
164		}
165
166		/**
167		* @return object
168		*/
169	View Code Duplication	protected function scanEach()
		0 ignored issues – show Duplication introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
170		{
171		if (preg_match('/^(?:- )?(?:each\|for) +(\w+)(?: , (\w+))? +in ([^\n]+)/', $this->input, $matches)) {
172		$this->consume($matches[0]);
173
174		$token = $this->token('each', $matches[1]);
175		$token->key = $matches[2];
176		$token->code = $this->normalizeCode($matches[3]);
177
178		return $token;
179		}
180		}
181
182		/**
183		* @return object
184		*/
185		protected function scanCustomKeyword()
186		{
187		if (
188		count($this->customKeywords) &&
		0 ignored issues – show Bug introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report The property `customKeywords` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
189		preg_match('/^([\w-]+)([^\n]*)/', $this->input, $matches) &&
190		isset($this->customKeywords[$matches[1]]) &&
191		is_callable($this->customKeywords[$matches[1]])
192		) {
193		$this->consume($matches[0]);
194
195		$token = $this->token('customKeyword', $matches[1]);
196		$token->args = trim($matches[2]);
197
198		return $token;
199		}
200		}
201
202		/**
203		* @return object
204		*/
205		protected function scanCode()
206		{
207		if (preg_match('/^(!?=\|-)([^\n]+)/', $this->input, $matches)) {
208		$this->consume($matches[0]);
209		$flags = $matches[1];
210		$code = $this->normalizeCode($matches[2]);
211
212		$token = $this->token('code', $code);
213		$token->escape = $flags[0] === '=';
214		$token->buffer = '=' === $flags[0] \|\| (isset($flags[1]) && '=' === $flags[1]);
215
216		return $token;
217		}
218		}
219
220		/**
221		* @throws \ErrorException
222		*
223		* @return object
224		*/
225		protected function scanAttributes()
226		{
227		if (substr($this->input, 0, 1) === '(') {
228		// cant use ^ anchor in the regex because the pattern is recursive
229		// but this restriction is asserted by the if above
230		//$this->input = preg_replace('/([a-zA-Z0-9\'"\\]\\}\\)])([\t ]+[a-zA-Z])/', '$1,$2', $this->input);
231		if (!preg_match('/\((?:"(?:\\\\.\|[^"\\\\])"\|\'(?:\\\\.\|[^\'\\\\])\'\|[^()\'"]++\|(?R))*+\)/', $this->input, $matches)) {
232		throw new \ErrorException('Unable to find attributes closing parenthesis.', 21);
233		}
234		$this->consume($matches[0]);
235
236		//$str = preg_replace('/()([a-zA-Z0-9_\\x7f-\\xff\\)\\]\\}"\'])(\s+[a-zA-Z_])/', '$1,$2', $str);
237
238		$token = $this->token('attributes');
239		$token->attributes = array();
240		$token->escaped = array();
241		$token->selfClosing = false;
242
243		$parser = new Attributes($token);
244		$parser->parseWith(substr($matches[0], 1, strlen($matches[0]) - 2));
245
246		if ($this->length() && '/' === $this->input[0]) {
247		$this->consume(1);
248		$token->selfClosing = true;
249		}
250
251		return $token;
252		}
253		}
254
255		/**
256		* @return object
257		*/
258		protected function scanPipelessText()
259		{
260		if ($this->pipeless && "\n" !== substr($this->input, 0, 1)) {
		0 ignored issues – show Bug introduced 2016-08-26 18:11 UTC by Report Bug Copy Issue Report The property `pipeless` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
261		$pos = strpos($this->input, "\n");
262
263		if ($pos === false) {
264		$pos = $this->length();
265		}
266
267		$str = substr($this->input, 0, $pos); // do not include the \n char
268
269		$this->consume($str);
270
271		return $this->token('text', ltrim($str));
272		}
273		}
274
275		/**
276		* @return object
277		*/
278		protected function scanColon()
279		{
280		return $this->scan('/^:(?!:) */', ':');
281		}
282
283		/**
284		* @return object
285		*/
286		protected function scanAndAttributes()
287		{
288		return $this->scan('/^&attributes(\(((?>[^()]+\|(?1))*)\))/', '&attributes', 2);
289		}
290		}
291

XaBerr / JATE