OptimalTransferEncodedTextStream::rewind() - Code Metrics - Inspection of "add post, fix some more CS (declare calls)" - genkgo/mail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#48)

by Frederik

created 2018-03-06 17:27 UTC

OptimalTransferEncodedTextStream::rewind() A

↳ Parent: OptimalTransferEncodedTextStream

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
declare(strict_types=1);

namespace Genkgo\Mail\Stream;

use Genkgo\Mail\StreamInterface;

final class OptimalTransferEncodedTextStream implements StreamInterface
{
    /**
     * @var StreamInterface
     */
    private $decoratedStream;

    /**
     * @var string
     */
    private $encoding = '7bit';

    /**
     * @var int
     */
    private $lineLength = 78;
    
    private const NON_7BIT_CHARS = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F\x7F\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8A\x8B\x8C\x8D\x8E\x8F\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9A\x9B\x9C\x9D\x9E\x9F\xA0\xA1\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xAA\xAB\xAC\xAD\xAE\xAF\xB0\xB1\xB2\xB3\xB4\xB5\xB6\xB7\xB8\xB9\xBA\xBB\xBC\xBD\xBE\xBF\xC0\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1\xD2\xD3\xD4\xD5\xD6\xD7\xD8\xD9\xDA\xDB\xDC\xDD\xDE\xDF\xE0\xE1\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xEA\xEB\xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\xFA\xFB\xFC\xFD\xFE\xFF";

    /**
     * @var string
     */
    private $lineBreak;

    /**
     * @param string $text
     * @param int $lineLength
     * @param string $lineBreak
     */
    public function __construct(string $text, int $lineLength = 78, string $lineBreak = "\r\n")
    {
        $this->lineLength = $lineLength;
        $this->lineBreak = $lineBreak;
        $this->decoratedStream = $this->calculateOptimalStream($text);
    }

    /**
     * @param string $text
     * @return StreamInterface
     */
    private function calculateOptimalStream(string $text): StreamInterface
    {
        if (\strcspn($text, self::NON_7BIT_CHARS) === \strlen($text)) {
            $this->encoding = '7bit';
            return new AsciiEncodedStream($text, $this->lineLength, $this->lineBreak);
        }

        if (\preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $text) > (\strlen($text) / 3)) {
            $this->encoding = 'base64';
            return Base64EncodedStream::fromString($text, $this->lineLength, $this->lineBreak);
        }

        $this->encoding = 'quoted-printable';
        return QuotedPrintableStream::fromString($text, $this->lineLength, $this->lineBreak);
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        return $this->decoratedStream->__toString();
    }
    
    public function close(): void
    {
        $this->decoratedStream->close();
    }

    /**
     * @return mixed
     */
    public function detach()
    {
        return $this->decoratedStream->detach();
    }

    /**
     * @return int|null
     */
    public function getSize(): ?int
    {
        return $this->decoratedStream->getSize();
    }

    /**
     * @return int
     * @throws \RuntimeException
     */
    public function tell(): int
    {
        return $this->decoratedStream->tell();
    }

    /**
     * @return bool
     */
    public function eof(): bool
    {
        return $this->decoratedStream->eof();
    }

    /**
     * @return bool
     */
    public function isSeekable(): bool
    {
        return $this->decoratedStream->isSeekable();
    }

    /**
     * @param int $offset
     * @param int $whence
     * @return int
     */
    public function seek(int $offset, int $whence = SEEK_SET): int
    {
        return $this->decoratedStream->seek($offset, $whence);
    }

    /**
     * @return bool
     */
    public function rewind(): bool
    {
        return $this->decoratedStream->rewind();
    }

    /**
     * @return bool
     */
    public function isWritable(): bool
    {
        return $this->decoratedStream->isWritable();
    }

    /**
     * @param string $string
     * @return int
     */
    public function write($string): int
    {
        return $this->decoratedStream->write($string);
    }

    /**
     * @return bool
     */
    public function isReadable(): bool
    {
        return $this->decoratedStream->isReadable();
    }

    /**
     * @param int $length
     * @return string
     */
    public function read(int $length): string
    {
        return $this->decoratedStream->read($length);
    }

    /**
     * @return string
     */
    public function getContents(): string
    {
        return $this->decoratedStream->getContents();
    }

    /**
     * @param array $keys
     * @return array
     */
    public function getMetadata(array $keys = []): array
    {
        $metaData = $this->decoratedStream->getMetadata($keys);
        $metaData['transfer-encoding'] = $this->encoding;

        $keys = \array_map('strtolower', $keys);

        return \array_filter(
            $metaData,
            function ($key) use ($keys) {
                return \in_array(\strtolower($key), $keys);
            },
            ARRAY_FILTER_USE_KEY
        );
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Genkgo\Mail\Stream;
5
6		use Genkgo\Mail\StreamInterface;
7
8		final class OptimalTransferEncodedTextStream implements StreamInterface
9		{
10		/**
11		* @var StreamInterface
12		*/
13		private $decoratedStream;
14
15		/**
16		* @var string
17		*/
18		private $encoding = '7bit';
19
20		/**
21		* @var int
22		*/
23		private $lineLength = 78;
24
25		private const NON_7BIT_CHARS = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F\x7F\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8A\x8B\x8C\x8D\x8E\x8F\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9A\x9B\x9C\x9D\x9E\x9F\xA0\xA1\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xAA\xAB\xAC\xAD\xAE\xAF\xB0\xB1\xB2\xB3\xB4\xB5\xB6\xB7\xB8\xB9\xBA\xBB\xBC\xBD\xBE\xBF\xC0\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1\xD2\xD3\xD4\xD5\xD6\xD7\xD8\xD9\xDA\xDB\xDC\xDD\xDE\xDF\xE0\xE1\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xEA\xEB\xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\xFA\xFB\xFC\xFD\xFE\xFF";
26
27		/**
28		* @var string
29		*/
30		private $lineBreak;
31
32		/**
33		* @param string $text
34		* @param int $lineLength
35		* @param string $lineBreak
36		*/
37	133	public function __construct(string $text, int $lineLength = 78, string $lineBreak = "\r\n")
38		{
39	133	$this->lineLength = $lineLength;
40	133	$this->lineBreak = $lineBreak;
41	133	$this->decoratedStream = $this->calculateOptimalStream($text);
42	133	}
43
44		/**
45		* @param string $text
46		* @return StreamInterface
47		*/
48	133	private function calculateOptimalStream(string $text): StreamInterface
49		{
50	133	if (\strcspn($text, self::NON_7BIT_CHARS) === \strlen($text)) {
51	124	$this->encoding = '7bit';
52	124	return new AsciiEncodedStream($text, $this->lineLength, $this->lineBreak);
53		}
54
55	10	if (\preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $text) > (\strlen($text) / 3)) {
56	7	$this->encoding = 'base64';
57	7	return Base64EncodedStream::fromString($text, $this->lineLength, $this->lineBreak);
58		}
59
60	3	$this->encoding = 'quoted-printable';
61	3	return QuotedPrintableStream::fromString($text, $this->lineLength, $this->lineBreak);
62		}
63
64		/**
65		* @return string
66		*/
67	106	public function __toString(): string
68		{
69	106	return $this->decoratedStream->__toString();
70		}
71
72		public function close(): void
73		{
74		$this->decoratedStream->close();
75		}
76
77		/**
78		* @return mixed
79		*/
80		public function detach()
81		{
82		return $this->decoratedStream->detach();
83		}
84
85		/**
86		* @return int\|null
87		*/
88	7	public function getSize(): ?int
89		{
90	7	return $this->decoratedStream->getSize();
91		}
92
93		/**
94		* @return int
95		* @throws \RuntimeException
96		*/
97		public function tell(): int
98		{
99		return $this->decoratedStream->tell();
100		}
101
102		/**
103		* @return bool
104		*/
105	1	public function eof(): bool
106		{
107	1	return $this->decoratedStream->eof();
108		}
109
110		/**
111		* @return bool
112		*/
113		public function isSeekable(): bool
114		{
115		return $this->decoratedStream->isSeekable();
116		}
117
118		/**
119		* @param int $offset
120		* @param int $whence
121		* @return int
122		*/
123		public function seek(int $offset, int $whence = SEEK_SET): int
124		{
125		return $this->decoratedStream->seek($offset, $whence);
126		}
127
128		/**
129		* @return bool
130		*/
131	1	public function rewind(): bool
132		{
133	1	return $this->decoratedStream->rewind();
134		}
135
136		/**
137		* @return bool
138		*/
139		public function isWritable(): bool
140		{
141		return $this->decoratedStream->isWritable();
142		}
143
144		/**
145		* @param string $string
146		* @return int
147		*/
148		public function write($string): int
149		{
150		return $this->decoratedStream->write($string);
151		}
152
153		/**
154		* @return bool
155		*/
156		public function isReadable(): bool
157		{
158		return $this->decoratedStream->isReadable();
159		}
160
161		/**
162		* @param int $length
163		* @return string
164		*/
165	1	public function read(int $length): string
166		{
167	1	return $this->decoratedStream->read($length);
168		}
169
170		/**
171		* @return string
172		*/
173		public function getContents(): string
174		{
175		return $this->decoratedStream->getContents();
176		}
177
178		/**
179		* @param array $keys
180		* @return array
181		*/
182	133	public function getMetadata(array $keys = []): array
183		{
184	133	$metaData = $this->decoratedStream->getMetadata($keys);
185	133	$metaData['transfer-encoding'] = $this->encoding;
186
187	133	$keys = \array_map('strtolower', $keys);
188
189	133	return \array_filter(
190	133	$metaData,
191	133	function ($key) use ($keys) {
192	133	return \in_array(\strtolower($key), $keys);
193	133	},
194	133	ARRAY_FILTER_USE_KEY
195		);
196		}
197		}
198

genkgo / mail

Pull Request — master (#48)

OptimalTransferEncodedTextStream::rewind() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like