AddressConsumer::isStartToken() - Code Metrics - Inspection of "Return valid email for quoted local-part #203" - zbateson/mail-mime-parser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 295c7f...61bbf4 )

by Zaahid

created 2022-12-23 07:20 UTC

AddressConsumer::isStartToken() A

↳ Parent: AddressConsumer

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	1
crap	1

<?php
/**
 * This file is part of the ZBateson\MailMimeParser project.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 */
namespace ZBateson\MailMimeParser\Header\Consumer;

use ZBateson\MailMimeParser\Header\Part\AddressGroupPart;
use ZBateson\MailMimeParser\Header\Part\AddressPart;
use ZBateson\MailMimeParser\Header\Part\CommentPart;
use ZBateson\MailMimeParser\Header\Part\LiteralPart;

/**
 * Parses a single part of an address header.
 * 
 * Represents a single part of a list of addresses.  A part could be one email
 * address, or one 'group' containing multiple addresses.  The consumer ends on
 * finding either a comma token, representing a separation between addresses, or
 * a semi-colon token representing the end of a group.
 * 
 * A single email address may consist of just an email, or a name and an email
 * address.  Both of these are valid examples of a From header:
 *  - From: [email protected]
 *  - From: Jon Snow <[email protected]>
 * 
 * Groups must be named, for example:
 *  - To: Winterfell: [email protected], Arya Stark <[email protected]>;
 *
 * Addresses may contain quoted parts and comments, and names may be mime-header
 * encoded.
 * 
 * @author Zaahid Bateson
 */
class AddressConsumer extends AbstractConsumer
{
    /**
     * Returns the following as sub-consumers:
     *  - {@see AddressGroupConsumer}
     *  - {@see CommentConsumer}
     *  - {@see QuotedStringConsumer}
     * 
     * @return AbstractConsumer[] the sub-consumers
     */
    protected function getSubConsumers()
    {
        return [
            $this->consumerService->getAddressGroupConsumer(),
            $this->consumerService->getAddressEmailConsumer(),
            $this->consumerService->getCommentConsumer(),
            $this->consumerService->getQuotedStringConsumer(),
        ];
    }
    
    /**
     * Overridden to return patterns matching end tokens ("," and ";"), and
     * whitespace.
     * 
     * @return string[] the patterns
     */
    public function getTokenSeparators()
    {
        return [ ',', ';', '\s+' ];
    }
    
    /**
     * Returns true for commas and semi-colons.
     * 
     * Although the semi-colon is not strictly the end token of an
     * AddressConsumer, it could end a parent AddressGroupConsumer.
     * 
     * @param string $token
     * @return boolean false
     */
    protected function isEndToken($token)
    {
        return ($token === ',' || $token === ';');
    }
    
    /**
     * AddressConsumer is "greedy", so this always returns true.
     * 
     * @param string $token
     * @return boolean false
     */
    protected function isStartToken($token)
    {
        return true;
    }

    /**
     * Performs final processing on parsed parts.
     * 
     * AddressConsumer's implementation looks for tokens representing the
     * beginning of an address part, to create a Part\AddressPart out of a
     * name/address pair, or assign the name part to a parsed
     * Part\AddressGroupPart returned from its AddressGroupConsumer
     * sub-consumer.
     * 
     * The returned array consists of a single element - either a
     * Part\AddressPart or a Part\AddressGroupPart.
     * 
     * @param \ZBateson\MailMimeParser\Header\IHeaderPart[] $parts
     * @return \ZBateson\MailMimeParser\Header\IHeaderPart[]|array
     */
    protected function processParts(array $parts)
    {
        $strName = '';
        $strEmail = '';
        foreach ($parts as $part) {
            if ($part instanceof AddressGroupPart) {
                return [
                    $this->partFactory->newAddressGroupPart(
                        $part->getAddresses(),
                        $strName
                    )
                ];
            } elseif ($part instanceof AddressPart) {
                return [ $this->partFactory->newAddressPart($strName, $part->getEmail()) ];
            } elseif ((($part instanceof LiteralPart) && !($part instanceof CommentPart)) && $part->getValue() !== '') {
                $strEmail .= '"' . preg_replace('/(["\\\])/', "\\\\$1", $part->getValue()) . '"';
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            } else {
                $strEmail .= preg_replace('/\s+/', '', $part->getValue());
            }
            $strName .= $part->getValue();
        }
        return [ $this->partFactory->newAddressPart('', $strEmail) ];
    }
}


1		<?php
2		/**
3		* This file is part of the ZBateson\MailMimeParser project.
4		*
5		* @license http://opensource.org/licenses/bsd-license.php BSD
6		*/
7		namespace ZBateson\MailMimeParser\Header\Consumer;
8
9		use ZBateson\MailMimeParser\Header\Part\AddressGroupPart;
10		use ZBateson\MailMimeParser\Header\Part\AddressPart;
11		use ZBateson\MailMimeParser\Header\Part\CommentPart;
12		use ZBateson\MailMimeParser\Header\Part\LiteralPart;
13
14		/**
15		* Parses a single part of an address header.
16		*
17		* Represents a single part of a list of addresses. A part could be one email
18		* address, or one 'group' containing multiple addresses. The consumer ends on
19		* finding either a comma token, representing a separation between addresses, or
20		* a semi-colon token representing the end of a group.
21		*
22		* A single email address may consist of just an email, or a name and an email
23		* address. Both of these are valid examples of a From header:
24		* - From: [email protected]
25		* - From: Jon Snow <[email protected]>
26		*
27		* Groups must be named, for example:
28		* - To: Winterfell: [email protected], Arya Stark <[email protected]>;
29		*
30		* Addresses may contain quoted parts and comments, and names may be mime-header
31		* encoded.
32		*
33		* @author Zaahid Bateson
34		*/
35		class AddressConsumer extends AbstractConsumer
36		{
37		/**
38		* Returns the following as sub-consumers:
39		* - {@see AddressGroupConsumer}
40		* - {@see CommentConsumer}
41		* - {@see QuotedStringConsumer}
42		*
43		* @return AbstractConsumer[] the sub-consumers
44		*/
45	103	protected function getSubConsumers()
46		{
47	103	return [
48	103	$this->consumerService->getAddressGroupConsumer(),
49	103	$this->consumerService->getAddressEmailConsumer(),
50	103	$this->consumerService->getCommentConsumer(),
51	103	$this->consumerService->getQuotedStringConsumer(),
52	103	];
53		}
54
55		/**
56		* Overridden to return patterns matching end tokens ("," and ";"), and
57		* whitespace.
58		*
59		* @return string[] the patterns
60		*/
61	103	public function getTokenSeparators()
62		{
63	103	return [ ',', ';', '\s+' ];
64		}
65
66		/**
67		* Returns true for commas and semi-colons.
68		*
69		* Although the semi-colon is not strictly the end token of an
70		* AddressConsumer, it could end a parent AddressGroupConsumer.
71		*
72		* @param string $token
73		* @return boolean false
74		*/
75	103	protected function isEndToken($token)
76		{
77	103	return ($token === ',' \|\| $token === ';');
78		}
79
80		/**
81		* AddressConsumer is "greedy", so this always returns true.
82		*
83		* @param string $token
84		* @return boolean false
85		*/
86	95	protected function isStartToken($token)
87		{
88	95	return true;
89		}
90
91		/**
92		* Performs final processing on parsed parts.
93		*
94		* AddressConsumer's implementation looks for tokens representing the
95		* beginning of an address part, to create a Part\AddressPart out of a
96		* name/address pair, or assign the name part to a parsed
97		* Part\AddressGroupPart returned from its AddressGroupConsumer
98		* sub-consumer.
99		*
100		* The returned array consists of a single element - either a
101		* Part\AddressPart or a Part\AddressGroupPart.
102		*
103		* @param \ZBateson\MailMimeParser\Header\IHeaderPart[] $parts
104		* @return \ZBateson\MailMimeParser\Header\IHeaderPart[]\|array
105		*/
106	103	protected function processParts(array $parts)
107		{
108	103	$strName = '';
109	103	$strEmail = '';
110	103	foreach ($parts as $part) {
111	103	if ($part instanceof AddressGroupPart) {
112	1	return [
113	1	$this->partFactory->newAddressGroupPart(
114	1	$part->getAddresses(),
115	1	$strName
116	1	)
117	1	];
118	103	} elseif ($part instanceof AddressPart) {
119	96	return [ $this->partFactory->newAddressPart($strName, $part->getEmail()) ];
120	103	} elseif ((($part instanceof LiteralPart) && !($part instanceof CommentPart)) && $part->getValue() !== '') {
121	55	$strEmail .= '"' . preg_replace('/(["\\\])/', "\\\\$1", $part->getValue()) . '"';
		0 ignored issues – show Coding Style Comprehensibility introduced 2022-12-23 07:29 UTC by Report Bug Copy Issue Report The string literal `\\\\$1` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
122		} else {
123	103	$strEmail .= preg_replace('/\s+/', '', $part->getValue());
124		}
125	103	$strName .= $part->getValue();
126		}
127	8	return [ $this->partFactory->newAddressPart('', $strEmail) ];
128		}
129		}
130

zbateson / mail-mime-parser

Push — master ( 295c7f...61bbf4 )

AddressConsumer::isStartToken() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like