AggregateResponse::__toString() - Code Metrics - Inspection of "improve reading of fetch command (#87)" - genkgo/mail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1e8cf3...95d72b )

by Frederik

created 2020-10-12 07:54 UTC

AggregateResponse::__toString() A

↳ Parent: AggregateResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	0
cts	7
cp	0
rs	9.8666
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php
declare(strict_types=1);

namespace Genkgo\Mail\Protocol\Imap\Response;

use Genkgo\Mail\Exception\AssertionFailedException;
use Genkgo\Mail\Protocol\ConnectionInterface;
use Genkgo\Mail\Protocol\Imap\CommandResponseCanBeParsedInterface;
use Genkgo\Mail\Protocol\Imap\RequestInterface;
use Genkgo\Mail\Protocol\Imap\ResponseInterface;

/**
 * @implements \IteratorAggregate<int, ResponseInterface[]>
 */
final class AggregateResponse implements \IteratorAggregate
{
    /**
     * @var array|ResponseInterface[]
     */
    private $lines = [];

    /**
     * @return \Iterator|ResponseInterface[]
     */
    public function getIterator(): \Iterator
    {
        return new \ArrayIterator($this->lines);
    }

    /**
     * @return ResponseInterface
     */
    public function first(): ResponseInterface
    {
        if (empty($this->lines)) {
            throw new \OutOfBoundsException('Cannot return item of empty response');
        }

        return \reset($this->lines);
    }

    /**
     * @return ResponseInterface
     */
    public function last(): ResponseInterface
    {
        if (empty($this->lines)) {
            throw new \OutOfBoundsException('Cannot return item of empty response');
        }

        return \end($this->lines);
    }

    /**
     * @param int $index
     * @return ResponseInterface
     */
    public function at(int $index): ResponseInterface
    {
        if (!isset($this->lines[$index])) {
            throw new \OutOfBoundsException('GenericItem not in response');
        }

        return $this->lines[$index];
    }

    /**
     * @return bool
     */
    public function hasCompleted(): bool
    {
        if (empty($this->lines)) {
            return false;
        }

        $lastCommand = \end($this->lines);
        try {
            $lastCommand->assertTagged();
            return true;
        } catch (AssertionFailedException $e) {

        }

        try {
            $lastCommand->assertContinuation();
            return true;
        } catch (AssertionFailedException $e) {

        }

        return false;
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        return \implode(
            '',
            \array_map(
                function (ResponseInterface $response) {
                    return (string)$response;
                },
                $this->lines
            )
        );
    }

    /**
     * @param RequestInterface $request
     * @param ConnectionInterface $connection
     * @return AggregateResponse
     */
    public static function fromServerResponse(ConnectionInterface $connection, RequestInterface $request): self
    {
        return self::fromResponseLines(
            (function () use ($connection) {
                while ($line = $connection->receive()) {
                    yield $line;
                }
            })(),
            $request
        );
    }

    /**
     * @param \Iterator<int, string> $lines
     * @param RequestInterface $request
     * @return static
     */
    public static function fromResponseLines(\Iterator $lines, RequestInterface $request): self
    {
        $response = new self();
        $currentLine = [];

        foreach ($lines as $line) {
            switch (\substr($line, 0, 2)) {
                case '+ ':
                    if ($currentLine !== []) {
                        $response->lines[] = new UntaggedResponse(\implode('', $currentLine));
                        $currentLine = [];
                    }

                    $response->lines[] = new CommandContinuationRequestResponse(
                        \substr($line, 2)
                    );
                    break;
                case '* ':
                    if ($currentLine !== []) {
                        $response->lines[] = new UntaggedResponse(\implode('', $currentLine));
                        $currentLine = [];
                    }

                    if ($request instanceof CommandResponseCanBeParsedInterface) {
                        $response->lines[] = $request->createParsedResponse(
                            (function () use ($line, $lines) {
                                yield $line;

                                while ($lines->valid()) {
                                    $lines->next();
                                    yield $lines->current();
                                }
                            })()
                        );
                    } else {
                        $currentLine = [\substr($line, 2)];
                    }
                    break;
                default:
                    try {
                        $taggedResponse = new TaggedResponse(
                            $request->getTag(),
                            $request->getTag()->extractBodyFromLine($line)
                        );

                        if ($currentLine !== []) {
                            $response->lines[] = new UntaggedResponse(\implode('', $currentLine));
                            $currentLine = [];
                        }

                        $response->lines[] = $taggedResponse;
                    } catch (\InvalidArgumentException $e) {
                        if ($response->lines === []) {
                            throw new \UnexpectedValueException(
                                'Expected line to begin with +, * or tag. Got: ' . $line
                            );
                        }

                        $currentLine[] = $line;
                    }
                    break;
            }

            if ($response->hasCompleted()) {
                return $response;
            }
        }

        throw new \UnexpectedValueException('Unexpected end of response');
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Genkgo\Mail\Protocol\Imap\Response;
5
6		use Genkgo\Mail\Exception\AssertionFailedException;
7		use Genkgo\Mail\Protocol\ConnectionInterface;
8		use Genkgo\Mail\Protocol\Imap\CommandResponseCanBeParsedInterface;
9		use Genkgo\Mail\Protocol\Imap\RequestInterface;
10		use Genkgo\Mail\Protocol\Imap\ResponseInterface;
11
12		/**
13		* @implements \IteratorAggregate<int, ResponseInterface[]>
14		*/
15		final class AggregateResponse implements \IteratorAggregate
16		{
17		/**
18		* @var array\|ResponseInterface[]
19		*/
20		private $lines = [];
21
22		/**
23		* @return \Iterator\|ResponseInterface[]
24		*/
25	1	public function getIterator(): \Iterator
26		{
27	1	return new \ArrayIterator($this->lines);
28		}
29
30		/**
31		* @return ResponseInterface
32		*/
33	17	public function first(): ResponseInterface
34		{
35	17	if (empty($this->lines)) {
36		throw new \OutOfBoundsException('Cannot return item of empty response');
37		}
38
39	17	return \reset($this->lines);
40		}
41
42		/**
43		* @return ResponseInterface
44		*/
45	16	public function last(): ResponseInterface
46		{
47	16	if (empty($this->lines)) {
48	1	throw new \OutOfBoundsException('Cannot return item of empty response');
49		}
50
51	15	return \end($this->lines);
52		}
53
54		/**
55		* @param int $index
56		* @return ResponseInterface
57		*/
58	3	public function at(int $index): ResponseInterface
59		{
60	3	if (!isset($this->lines[$index])) {
61	1	throw new \OutOfBoundsException('GenericItem not in response');
62		}
63
64	2	return $this->lines[$index];
65		}
66
67		/**
68		* @return bool
69		*/
70	24	public function hasCompleted(): bool
71		{
72	24	if (empty($this->lines)) {
73	14	return false;
74		}
75
76	24	$lastCommand = \end($this->lines);
77		try {
78	24	$lastCommand->assertTagged();
79	23	return true;
80	8	} catch (AssertionFailedException $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-01-28 16:40 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
81		}
82
83		try {
84	8	$lastCommand->assertContinuation();
85	6	return true;
86	2	} catch (AssertionFailedException $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-01-28 16:40 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
87		}
88
89	2	return false;
90		}
91
92		/**
93		* @return string
94		*/
95		public function __toString(): string
96		{
97		return \implode(
98		'',
99		\array_map(
100		function (ResponseInterface $response) {
101		return (string)$response;
102		},
103		$this->lines
104		)
105		);
106		}
107
108		/**
109		* @param RequestInterface $request
110		* @param ConnectionInterface $connection
111		* @return AggregateResponse
112		*/
113	13	public static function fromServerResponse(ConnectionInterface $connection, RequestInterface $request): self
114		{
115	13	return self::fromResponseLines(
116		(function () use ($connection) {
117	13	while ($line = $connection->receive()) {
118	13	yield $line;
119		}
120	13	})(),
121		$request
122		);
123		}
124
125		/**
126		* @param \Iterator<int, string> $lines
127		* @param RequestInterface $request
128		* @return static
129		*/
130	24	public static function fromResponseLines(\Iterator $lines, RequestInterface $request): self
131		{
132	24	$response = new self();
133	24	$currentLine = [];
134
135	24	foreach ($lines as $line) {
136	24	switch (\substr($line, 0, 2)) {
137	24	case '+ ':
138	6	if ($currentLine !== []) {
139		$response->lines[] = new UntaggedResponse(\implode('', $currentLine));
140		$currentLine = [];
141		}
142
143	6	$response->lines[] = new CommandContinuationRequestResponse(
144	6	\substr($line, 2)
145		);
146	6	break;
147	23	case '* ':
148	16	if ($currentLine !== []) {
149		$response->lines[] = new UntaggedResponse(\implode('', $currentLine));
150		$currentLine = [];
151		}
152
153	16	if ($request instanceof CommandResponseCanBeParsedInterface) {
154	2	$response->lines[] = $request->createParsedResponse(
155		(function () use ($line, $lines) {
156	2	yield $line;
157
158	2	while ($lines->valid()) {
159	2	$lines->next();
160	2	yield $lines->current();
161		}
162	2	})()
163		);
164		} else {
165	14	$currentLine = [\substr($line, 2)];
166		}
167	16	break;
168		default:
169		try {
170	23	$taggedResponse = new TaggedResponse(
171	23	$request->getTag(),
172	23	$request->getTag()->extractBodyFromLine($line)
173		);
174
175	23	if ($currentLine !== []) {
176	14	$response->lines[] = new UntaggedResponse(\implode('', $currentLine));
177	14	$currentLine = [];
178		}
179
180	23	$response->lines[] = $taggedResponse;
181		} catch (\InvalidArgumentException $e) {
182		if ($response->lines === []) {
183		throw new \UnexpectedValueException(
184		'Expected line to begin with +, * or tag. Got: ' . $line
185		);
186		}
187
188		$currentLine[] = $line;
189		}
190	23	break;
191		}
192
193	24	if ($response->hasCompleted()) {
194	24	return $response;
195		}
196		}
197
198		throw new \UnexpectedValueException('Unexpected end of response');
199		}
200		}
201

genkgo / mail

Push — master ( 1e8cf3...95d72b )

AggregateResponse::__toString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like