EmailAddress::extractComments() - Code Metrics - Inspection of "Chore: prepare for the 2.1.0 release" - stymiee/email-validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 82f564...b2a72e )

by John

created 2025-06-10 18:47 UTC

EmailAddress::extractComments() C

↳ Parent: EmailAddress

Complexity

Conditions	12
Paths	12

Size

Total Lines	66
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	46
c	0
b	0
f	0
dl	0
loc	66
rs	6.9666
cc	12
nc	12
nop	1

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace EmailValidator;

class EmailAddress
{
    /**
     * @var string
     */
    private string $email;

    /**
     * @var string|null
     */
    private ?string $localPart = null;

    /**
     * @var string|null
     */
    private ?string $domain = null;

    /**
     * @var array<string>
     */
    private array $comments = [];

    public function __construct(string $email)
    {
        $this->email = $email;
        $this->parseEmail();
    }

    /**
     * Parses the email address into local part and domain
     *
     * This method handles:
     * - Multiple @ symbols in quoted strings
     * - Domain literals (IP addresses in square brackets)
     * - Comments in email addresses
     *
     * @return void
     */
    private function parseEmail(): void
    {
        $email = $this->email;

        // Extract comments while preserving their positions
        $email = $this->extractComments($email);

        // Split on the last @ symbol
        $atPos = strrpos($email, '@');
        if ($atPos === false) {
            return;
        }

        $this->localPart = substr($email, 0, $atPos);
        $this->domain = substr($email, $atPos + 1);
    }

    /**
     * Extracts comments from an email address while preserving their positions
     *
     * @param string $email The email address to process
     * @return string The email address with comments removed
     */
    private function extractComments(string $email): string
    {
        $result = '';
        $inComment = false;
        $commentDepth = 0;
        $currentComment = '';
        $escaped = false;

        for ($i = 0, $iMax = strlen($email); $i < $iMax; $i++) {
            $char = $email[$i];

            if ($escaped) {
                if ($inComment) {
                    $currentComment .= $char;
                } else {
                    $result .= $char;
                }
                $escaped = false;
                continue;
            }

            if ($char === '\\') {
                $escaped = true;
                if ($inComment) {
                    $currentComment .= $char;
                } else {
                    $result .= $char;
                }
                continue;
            }

            if ($char === '(') {
                if ($inComment) {
                    $commentDepth++;
                    $currentComment .= $char;
                } else {
                    $inComment = true;
                    $commentDepth = 1;
                }
                continue;
            }

            if ($char === ')') {
                if ($inComment) {
                    $commentDepth--;
                    if ($commentDepth === 0) {
                        $this->comments[] = $currentComment;
                        $currentComment = '';
                        $inComment = false;
                    } else {
                        $currentComment .= $char;
                    }
                } else {
                    $result .= $char;
                }
                continue;
            }

            if ($inComment) {
                $currentComment .= $char;
            } else {
                $result .= $char;
            }
        }

        return $result;
    }

    /**
     * Returns the domain name portion of the email address.
     *
     * @return string|null
     */
    public function getDomain(): ?string
    {
        return $this->domain;
    }

    /**
     * Returns the local part of the email address.
     *
     * @return string|null
     */
    public function getLocalPart(): ?string
    {
        return $this->localPart;
    }

    /**
     * Returns the complete email address.
     *
     * @return string
     */
    public function getEmailAddress(): string
    {
        return $this->email;
    }

    /**
     * Returns any comments found in the email address.
     *
     * @return array<string>
     */
    public function getComments(): array
    {
        return $this->comments;
    }

    /**
     * Returns the username portion of the email address.
     *
     * @since 1.1.0
     * @return string
     */
    private function getUsername(): string
    {
        return $this->localPart ?? '';
    }

    /**
     * Determines if a gmail account is using the "plus trick".
     *
     * @since 1.1.0
     * @return bool
     */
    public function isGmailWithPlusChar(): bool
    {
        $result = false;
        if (in_array($this->getDomain(), ['gmail.com', 'googlemail.com'])) {
            $result = strpos($this->getUsername(), '+') !== false;
        }

        return $result;
    }

    /**
     * Returns a gmail address without the "plus trick" portion of the email address.
     *
     * @since 1.1.0
     * @return string
     */
    public function getGmailAddressWithoutPlus(): string
    {
        return preg_replace('/^(.+?)(\+.+?)(@.+)/', '$1$3', $this->getEmailAddress());
    }

    /**
     * Returns a gmail address without the "plus trick" portion of the email address and all dots removed.
     *
     * @since 1.1.4
     * @return string
     */
    public function getSanitizedGmailAddress(): string
    {
        $email = new EmailAddress($this->getGmailAddressWithoutPlus());
        return sprintf(
            '%s@%s',
            str_replace('.', '', $email->getUsername()),
            $email->getDomain()
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace EmailValidator;
6
7			class EmailAddress
8			{
9			/**
10			* @var string
11			*/
12			private string $email;
13
14			/**
15			* @var string\|null
16			*/
17			private ?string $localPart = null;
18
19			/**
20			* @var string\|null
21			*/
22			private ?string $domain = null;
23
24			/**
25			* @var array<string>
26			*/
27			private array $comments = [];
28
29			public function __construct(string $email)
30			{
31			$this->email = $email;
32			$this->parseEmail();
33			}
34
35			/**
36			* Parses the email address into local part and domain
37			*
38			* This method handles:
39			* - Multiple @ symbols in quoted strings
40			* - Domain literals (IP addresses in square brackets)
41			* - Comments in email addresses
42			*
43			* @return void
44			*/
45			private function parseEmail(): void
46			{
47			$email = $this->email;
48
49			// Extract comments while preserving their positions
50			$email = $this->extractComments($email);
51
52			// Split on the last @ symbol
53			$atPos = strrpos($email, '@');
54			if ($atPos === false) {
55			return;
56			}
57
58			$this->localPart = substr($email, 0, $atPos);
59			$this->domain = substr($email, $atPos + 1);
60			}
61
62			/**
63			* Extracts comments from an email address while preserving their positions
64			*
65			* @param string $email The email address to process
66			* @return string The email address with comments removed
67			*/
68			private function extractComments(string $email): string
69			{
70			$result = '';
71			$inComment = false;
72			$commentDepth = 0;
73			$currentComment = '';
74			$escaped = false;
75
76			for ($i = 0, $iMax = strlen($email); $i < $iMax; $i++) {
77			$char = $email[$i];
78
79			if ($escaped) {
80			if ($inComment) {
81			$currentComment .= $char;
82			} else {
83			$result .= $char;
84			}
85			$escaped = false;
86			continue;
87			}
88
89			if ($char === '\\') {
90			$escaped = true;
91			if ($inComment) {
92			$currentComment .= $char;
93			} else {
94			$result .= $char;
95			}
96			continue;
97			}
98
99			if ($char === '(') {
100			if ($inComment) {
101			$commentDepth++;
102			$currentComment .= $char;
103			} else {
104			$inComment = true;
105			$commentDepth = 1;
106			}
107			continue;
108			}
109
110			if ($char === ')') {
111			if ($inComment) {
112			$commentDepth--;
113			if ($commentDepth === 0) {
114			$this->comments[] = $currentComment;
115			$currentComment = '';
116			$inComment = false;
117			} else {
118			$currentComment .= $char;
119			}
120			} else {
121			$result .= $char;
122			}
123			continue;
124			}
125
126			if ($inComment) {
127			$currentComment .= $char;
128			} else {
129			$result .= $char;
130			}
131			}
132
133			return $result;
134			}
135
136			/**
137			* Returns the domain name portion of the email address.
138			*
139			* @return string\|null
140			*/
141			public function getDomain(): ?string
142			{
143			return $this->domain;
144			}
145
146			/**
147			* Returns the local part of the email address.
148			*
149			* @return string\|null
150			*/
151			public function getLocalPart(): ?string
152			{
153			return $this->localPart;
154			}
155
156			/**
157			* Returns the complete email address.
158			*
159			* @return string
160			*/
161			public function getEmailAddress(): string
162			{
163			return $this->email;
164			}
165
166			/**
167			* Returns any comments found in the email address.
168			*
169			* @return array<string>
170			*/
171			public function getComments(): array
172			{
173			return $this->comments;
174			}
175
176			/**
177			* Returns the username portion of the email address.
178			*
179			* @since 1.1.0
180			* @return string
181			*/
182			private function getUsername(): string
183			{
184			return $this->localPart ?? '';
185			}
186
187			/**
188			* Determines if a gmail account is using the "plus trick".
189			*
190			* @since 1.1.0
191			* @return bool
192			*/
193			public function isGmailWithPlusChar(): bool
194			{
195			$result = false;
196			if (in_array($this->getDomain(), ['gmail.com', 'googlemail.com'])) {
197			$result = strpos($this->getUsername(), '+') !== false;
198			}
199
200			return $result;
201			}
202
203			/**
204			* Returns a gmail address without the "plus trick" portion of the email address.
205			*
206			* @since 1.1.0
207			* @return string
208			*/
209			public function getGmailAddressWithoutPlus(): string
210			{
211			return preg_replace('/^(.+?)(\+.+?)(@.+)/', '$1$3', $this->getEmailAddress());
212			}
213
214			/**
215			* Returns a gmail address without the "plus trick" portion of the email address and all dots removed.
216			*
217			* @since 1.1.4
218			* @return string
219			*/
220			public function getSanitizedGmailAddress(): string
221			{
222			$email = new EmailAddress($this->getGmailAddressWithoutPlus());
223			return sprintf(
224			'%s@%s',
225			str_replace('.', '', $email->getUsername()),
226			$email->getDomain()
227			);
228			}
229			}
230

stymiee / email-validator

Push — master ( 82f564...b2a72e )

EmailAddress::extractComments() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like