Parser - Code Metrics - Inspection of "Fix PHP 7.4 support" - egulias/EmailValidator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#203)

unknown

created 2019-07-18 15:08 UTC

Parser C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	198
Duplicated Lines	8.08 %

Coupling/Cohesion

Components	1
Dependencies	16

Test Coverage

Coverage

84.26%

Importance

Changes

Metric	Value
wmc	53
lcom	1
cbo	16
dl	16
loc	198
ccs	91
cts	108
cp	0.8426
rs	6.96
c	0
b	0
f	0

14 Methods

Rating	Name	Duplication	Size	Complexity
	parse()	0	1	?
A	__construct()	0	4	1
A	getWarnings()	0	4	1
A	getOpenedParenthesis()	0	4	1
A	validateQuotedPair()	4	12	4
A	parseComments()	0	22	5
A	isUnclosedComment()	0	9	2
B	parseFWS()	6	24	9
A	checkConsecutiveDots()	3	6	3
B	isFWS()	0	17	7
A	escaped()	0	13	4
A	warnEscaping()	0	21	5
A	checkCRLFInFWS()	0	14	4
B	checkDQUOTE()	3	23	7

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

<?php

namespace Egulias\EmailValidator\Parser;

use Egulias\EmailValidator\EmailLexer;
use Egulias\EmailValidator\Exception\AtextAfterCFWS;
use Egulias\EmailValidator\Exception\ConsecutiveDot;
use Egulias\EmailValidator\Exception\CRLFAtTheEnd;
use Egulias\EmailValidator\Exception\CRLFX2;
use Egulias\EmailValidator\Exception\CRNoLF;
use Egulias\EmailValidator\Exception\ExpectingQPair;
use Egulias\EmailValidator\Exception\ExpectingATEXT;
use Egulias\EmailValidator\Exception\ExpectingCTEXT;
use Egulias\EmailValidator\Exception\UnclosedComment;
use Egulias\EmailValidator\Exception\UnclosedQuotedString;
use Egulias\EmailValidator\Warning\CFWSNearAt;
use Egulias\EmailValidator\Warning\CFWSWithFWS;
use Egulias\EmailValidator\Warning\Comment;
use Egulias\EmailValidator\Warning\QuotedPart;
use Egulias\EmailValidator\Warning\QuotedString;

abstract class Parser
{
    protected $warnings = [];
    protected $lexer;
    protected $openedParenthesis = 0;

    public function __construct(EmailLexer $lexer)
    {
        $this->lexer = $lexer;
    }

    public function getWarnings()
    {
        return $this->warnings;
    }

    abstract public function parse($str);

    /** @return int */
    public function getOpenedParenthesis()
    {
        return $this->openedParenthesis;
    }

    /**
     * validateQuotedPair
     */
    protected function validateQuotedPair()
    {
        if (!($this->lexer->token['type'] === EmailLexer::INVALID

            || $this->lexer->token['type'] === EmailLexer::C_DEL)) {
            throw new ExpectingQPair();
        }

        $previous = $this->lexer->getPrevious() ?: ['type' => null];

        $this->warnings[QuotedPart::CODE] =
            new QuotedPart($previous['type'], $this->lexer->token['type']);
    }

    protected function parseComments()
    {
        $this->openedParenthesis = 1;
        $this->isUnclosedComment();
        $this->warnings[Comment::CODE] = new Comment();
        while (!$this->lexer->isNextToken(EmailLexer::S_CLOSEPARENTHESIS)) {
            if ($this->lexer->isNextToken(EmailLexer::S_OPENPARENTHESIS)) {
                $this->openedParenthesis++;
            }
            $this->warnEscaping();
            $this->lexer->moveNext();
        }

        $this->lexer->moveNext();
        if ($this->lexer->isNextTokenAny(array(EmailLexer::GENERIC, EmailLexer::S_EMPTY))) {
            throw new ExpectingATEXT();
        }

        if ($this->lexer->isNextToken(EmailLexer::S_AT)) {
            $this->warnings[CFWSNearAt::CODE] = new CFWSNearAt();
        }
    }

    protected function isUnclosedComment()
    {
        try {
            $this->lexer->find(EmailLexer::S_CLOSEPARENTHESIS);
            return true;
        } catch (\RuntimeException $e) {
            throw new UnclosedComment();
        }
    }

    protected function parseFWS()
    {
        $previous = $this->lexer->getPrevious() ?: ['type' => null];

        $this->checkCRLFInFWS();

        if ($this->lexer->token['type'] === EmailLexer::S_CR) {
            throw new CRNoLF();
        }

        if ($this->lexer->isNextToken(EmailLexer::GENERIC) && $previous['type']  !== EmailLexer::S_AT) {

            throw new AtextAfterCFWS();
        }

        if ($this->lexer->token['type'] === EmailLexer::S_LF || $this->lexer->token['type'] === EmailLexer::C_NUL) {

            throw new ExpectingCTEXT();
        }

        if ($this->lexer->isNextToken(EmailLexer::S_AT) || $previous['type']  === EmailLexer::S_AT) {
            $this->warnings[CFWSNearAt::CODE] = new CFWSNearAt();
        } else {
            $this->warnings[CFWSWithFWS::CODE] = new CFWSWithFWS();
        }
    }

    protected function checkConsecutiveDots()
    {
        if ($this->lexer->token['type'] === EmailLexer::S_DOT && $this->lexer->isNextToken(EmailLexer::S_DOT)) {

            throw new ConsecutiveDot();
        }
    }

    protected function isFWS()
    {
        if ($this->escaped()) {
            return false;
        }

        if ($this->lexer->token['type'] === EmailLexer::S_SP ||
            $this->lexer->token['type'] === EmailLexer::S_HTAB ||
            $this->lexer->token['type'] === EmailLexer::S_CR ||
            $this->lexer->token['type'] === EmailLexer::S_LF ||
            $this->lexer->token['type'] === EmailLexer::CRLF
        ) {
            return true;
        }

        return false;
    }

    protected function escaped()
    {
        $previous = $this->lexer->getPrevious() ?: ['type' => null];

        if ($previous['type'] === EmailLexer::S_BACKSLASH
            &&
            $this->lexer->token['type'] !== EmailLexer::GENERIC
        ) {
            return true;
        }

        return false;
    }

    protected function warnEscaping()
    {
        if ($this->lexer->token['type'] !== EmailLexer::S_BACKSLASH) {
            return false;
        }

        if ($this->lexer->isNextToken(EmailLexer::GENERIC)) {
            throw new ExpectingATEXT();
        }

        if (!$this->lexer->isNextTokenAny(array(EmailLexer::S_SP, EmailLexer::S_HTAB, EmailLexer::C_DEL))) {
            return false;
        }

        $previous = $this->lexer->getPrevious() ?: ['type' => null];

        $this->warnings[QuotedPart::CODE] =
            new QuotedPart($previous['type'], $this->lexer->token['type']);
        return true;

    }

    protected function checkDQUOTE($hasClosingQuote)
    {
        if ($this->lexer->token['type'] !== EmailLexer::S_DQUOTE) {
            return $hasClosingQuote;
        }
        if ($hasClosingQuote) {
            return $hasClosingQuote;
        }
        $previous = $this->lexer->getPrevious() ?: ['type' => null, 'value' => ''];
        if ($this->lexer->isNextToken(EmailLexer::GENERIC) && $previous['type'] === EmailLexer::GENERIC) {

            throw new ExpectingATEXT();
        }

        try {
            $this->lexer->find(EmailLexer::S_DQUOTE);
            $hasClosingQuote = true;
        } catch (\Exception $e) {
            throw new UnclosedQuotedString();
        }
        $this->warnings[QuotedString::CODE] = new QuotedString($previous['value'], $this->lexer->token['value']);

        return $hasClosingQuote;
    }

    protected function checkCRLFInFWS()
    {
        if ($this->lexer->token['type'] !== EmailLexer::CRLF) {
            return;
        }

        if (!$this->lexer->isNextTokenAny(array(EmailLexer::S_SP, EmailLexer::S_HTAB))) {
            throw new CRLFX2();
        }

        if (!$this->lexer->isNextTokenAny(array(EmailLexer::S_SP, EmailLexer::S_HTAB))) {
            throw new CRLFAtTheEnd();
        }
    }
}


1			<?php
2
3			namespace Egulias\EmailValidator\Parser;
4
5			use Egulias\EmailValidator\EmailLexer;
6			use Egulias\EmailValidator\Exception\AtextAfterCFWS;
7			use Egulias\EmailValidator\Exception\ConsecutiveDot;
8			use Egulias\EmailValidator\Exception\CRLFAtTheEnd;
9			use Egulias\EmailValidator\Exception\CRLFX2;
10			use Egulias\EmailValidator\Exception\CRNoLF;
11			use Egulias\EmailValidator\Exception\ExpectingQPair;
12			use Egulias\EmailValidator\Exception\ExpectingATEXT;
13			use Egulias\EmailValidator\Exception\ExpectingCTEXT;
14			use Egulias\EmailValidator\Exception\UnclosedComment;
15			use Egulias\EmailValidator\Exception\UnclosedQuotedString;
16			use Egulias\EmailValidator\Warning\CFWSNearAt;
17			use Egulias\EmailValidator\Warning\CFWSWithFWS;
18			use Egulias\EmailValidator\Warning\Comment;
19			use Egulias\EmailValidator\Warning\QuotedPart;
20			use Egulias\EmailValidator\Warning\QuotedString;
21
22			abstract class Parser
23			{
24			protected $warnings = [];
25			protected $lexer;
26			protected $openedParenthesis = 0;
27
28	130		public function __construct(EmailLexer $lexer)
29			{
30	130		$this->lexer = $lexer;
31	130		}
32
33	52		public function getWarnings()
34			{
35	52		return $this->warnings;
36			}
37
38			abstract public function parse($str);
39
40			/** @return int */
41	6		public function getOpenedParenthesis()
42			{
43	6		return $this->openedParenthesis;
44			}
45
46			/**
47			* validateQuotedPair
48			*/
49			protected function validateQuotedPair()
50			{
51		View Code Duplication	if (!($this->lexer->token['type'] === EmailLexer::INVALID
			0 ignored issues – show Duplication introduced 2016-05-07 13: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...
52			\|\| $this->lexer->token['type'] === EmailLexer::C_DEL)) {
53			throw new ExpectingQPair();
54			}
55
56			$previous = $this->lexer->getPrevious() ?: ['type' => null];
57
58			$this->warnings[QuotedPart::CODE] =
59			new QuotedPart($previous['type'], $this->lexer->token['type']);
60			}
61
62	10		protected function parseComments()
63			{
64	10		$this->openedParenthesis = 1;
65	10		$this->isUnclosedComment();
66	6		$this->warnings[Comment::CODE] = new Comment();
67	6		while (!$this->lexer->isNextToken(EmailLexer::S_CLOSEPARENTHESIS)) {
68	6		if ($this->lexer->isNextToken(EmailLexer::S_OPENPARENTHESIS)) {
69	1		$this->openedParenthesis++;
70	1		}
71	6		$this->warnEscaping();
72	6		$this->lexer->moveNext();
73	6		}
74
75	6		$this->lexer->moveNext();
76	6		if ($this->lexer->isNextTokenAny(array(EmailLexer::GENERIC, EmailLexer::S_EMPTY))) {
77			throw new ExpectingATEXT();
78			}
79
80	6		if ($this->lexer->isNextToken(EmailLexer::S_AT)) {
81	1		$this->warnings[CFWSNearAt::CODE] = new CFWSNearAt();
82	1		}
83	6		}
84
85	13		protected function isUnclosedComment()
86			{
87			try {
88	13		$this->lexer->find(EmailLexer::S_CLOSEPARENTHESIS);
89	7		return true;
90	6		} catch (\RuntimeException $e) {
91	6		throw new UnclosedComment();
92			}
93			}
94
95	16		protected function parseFWS()
96			{
97	16		$previous = $this->lexer->getPrevious() ?: ['type' => null];
98
99	16		$this->checkCRLFInFWS();
100
101	16		if ($this->lexer->token['type'] === EmailLexer::S_CR) {
102	2		throw new CRNoLF();
103			}
104
105	14	View Code Duplication	if ($this->lexer->isNextToken(EmailLexer::GENERIC) && $previous['type'] !== EmailLexer::S_AT) {
			0 ignored issues – show Duplication introduced 2016-05-07 13: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...
106	7		throw new AtextAfterCFWS();
107			}
108
109	10	View Code Duplication	if ($this->lexer->token['type'] === EmailLexer::S_LF \|\| $this->lexer->token['type'] === EmailLexer::C_NUL) {
			0 ignored issues – show Duplication introduced 2016-05-07 13: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...
110			throw new ExpectingCTEXT();
111			}
112
113	10		if ($this->lexer->isNextToken(EmailLexer::S_AT) \|\| $previous['type'] === EmailLexer::S_AT) {
114	3		$this->warnings[CFWSNearAt::CODE] = new CFWSNearAt();
115	3		} else {
116	8		$this->warnings[CFWSWithFWS::CODE] = new CFWSWithFWS();
117			}
118	10		}
119
120	114		protected function checkConsecutiveDots()
121			{
122	114	View Code Duplication	if ($this->lexer->token['type'] === EmailLexer::S_DOT && $this->lexer->isNextToken(EmailLexer::S_DOT)) {
			0 ignored issues – show Duplication introduced 2016-05-07 13: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...
123	3		throw new ConsecutiveDot();
124			}
125	114		}
126
127	108		protected function isFWS()
128			{
129	108		if ($this->escaped()) {
130	1		return false;
131			}
132
133	108		if ($this->lexer->token['type'] === EmailLexer::S_SP \|\|
134	108		$this->lexer->token['type'] === EmailLexer::S_HTAB \|\|
135	108		$this->lexer->token['type'] === EmailLexer::S_CR \|\|
136	108		$this->lexer->token['type'] === EmailLexer::S_LF \|\|
137	108		$this->lexer->token['type'] === EmailLexer::CRLF
138	108		) {
139	16		return true;
140			}
141
142	108		return false;
143			}
144
145	115		protected function escaped()
146			{
147	115		$previous = $this->lexer->getPrevious() ?: ['type' => null];
148
149	115		if ($previous['type'] === EmailLexer::S_BACKSLASH
150	115		&&
151	3		$this->lexer->token['type'] !== EmailLexer::GENERIC
152	115		) {
153	2		return true;
154			}
155
156	115		return false;
157			}
158
159	114		protected function warnEscaping()
160			{
161	114		if ($this->lexer->token['type'] !== EmailLexer::S_BACKSLASH) {
162	109		return false;
163			}
164
165	7		if ($this->lexer->isNextToken(EmailLexer::GENERIC)) {
166	6		throw new ExpectingATEXT();
167			}
168
169	1		if (!$this->lexer->isNextTokenAny(array(EmailLexer::S_SP, EmailLexer::S_HTAB, EmailLexer::C_DEL))) {
170			return false;
171			}
172
173	1		$previous = $this->lexer->getPrevious() ?: ['type' => null];
174
175	1		$this->warnings[QuotedPart::CODE] =
176	1		new QuotedPart($previous['type'], $this->lexer->token['type']);
177	1		return true;
178
179			}
180
181	126		protected function checkDQUOTE($hasClosingQuote)
182			{
183	126		if ($this->lexer->token['type'] !== EmailLexer::S_DQUOTE) {
184	105		return $hasClosingQuote;
185			}
186	22		if ($hasClosingQuote) {
187			return $hasClosingQuote;
188			}
189	22		$previous = $this->lexer->getPrevious() ?: ['type' => null, 'value' => ''];
190	22	View Code Duplication	if ($this->lexer->isNextToken(EmailLexer::GENERIC) && $previous['type'] === EmailLexer::GENERIC) {
			0 ignored issues – show Duplication introduced 2016-04-28 23:00 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...
191	1		throw new ExpectingATEXT();
192			}
193
194			try {
195	21		$this->lexer->find(EmailLexer::S_DQUOTE);
196	20		$hasClosingQuote = true;
197	21		} catch (\Exception $e) {
198	1		throw new UnclosedQuotedString();
199			}
200	20		$this->warnings[QuotedString::CODE] = new QuotedString($previous['value'], $this->lexer->token['value']);
201
202	20		return $hasClosingQuote;
203			}
204
205	16		protected function checkCRLFInFWS()
206			{
207	16		if ($this->lexer->token['type'] !== EmailLexer::CRLF) {
208	16		return;
209			}
210
211			if (!$this->lexer->isNextTokenAny(array(EmailLexer::S_SP, EmailLexer::S_HTAB))) {
212			throw new CRLFX2();
213			}
214
215			if (!$this->lexer->isNextTokenAny(array(EmailLexer::S_SP, EmailLexer::S_HTAB))) {
216			throw new CRLFAtTheEnd();
217			}
218			}
219			}
220

egulias / EmailValidator