StreamReader::processResponseHeaders() - Code Metrics - Inspection of "Merge pull request #4 from DaveRandom/feature/stre..." - PeeHaa/AsyncTwitter - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d137b6...850d7f )

by Pieter

created 2017-02-22 13:48 UTC

StreamReader::processResponseHeaders() B

↳ Parent: StreamReader

Complexity

Conditions	6
Paths	18

Size

Total Lines	40
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
dl	0
loc	40
ccs	0
cts	30
cp	0
rs	8.439
c	0
b	0
f	0
cc	6
eloc	21
nc	18
nop	1
crap	42

<?php declare(strict_types = 1);

namespace PeeHaa\AsyncTwitter\Api\Client;

use Amp\Artax\Notify;
use Amp\Deferred;
use Amp\Promise;
use ExceptionalJSON\DecodeErrorException;
use PeeHaa\AsyncTwitter\Api\Client\Exception\StreamFailureException;
use PeeHaa\AsyncTwitter\Api\Client\Exception\StreamOpenFailureException;
use PeeHaa\AsyncTwitter\Api\StatusStream;

class StreamReader
{
    /**
     * @uses processResponseHeaders
     * @uses processBodyData
     * @uses processResponseComplete
     * @uses processError
     */
    private static $progressHandlers = [
        Notify::RESPONSE_HEADERS   => 'processResponseHeaders',
        Notify::RESPONSE_BODY_DATA => 'processBodyData',
        Notify::RESPONSE           => 'processResponseComplete',
        Notify::ERROR              => 'processError',
    ];

    /**
     * @var StatusStream
     */
    private $stream;

    private $openDeferred;
    private $inflateCtx;
    private $rawDataBuffer = '';

    public function __construct()
    {
        $this->openDeferred = new Deferred;
    }

    private function processBodyData(string $data)
    {
        if ($this->stream === null) {
            return;
        }

        /** @noinspection PhpUndefinedFunctionInspection */
        $this->rawDataBuffer .= $this->inflateCtx !== null
            ? \inflate_add($this->inflateCtx, $data)
            : $data;

        while (false !== $pos = \strpos($this->rawDataBuffer, "\r\n")) {
            if ($pos > 0) {
                try {
                    $this->stream->update(\json_try_decode(\substr($this->rawDataBuffer, 0, $pos), true));
                } catch (DecodeErrorException $e) {
                    $this->stream->fail(new StreamFailureException('Error decoding stream data', 0, $e));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $this->inflateCtx = $this->stream = null;
                    return;
                }
            }

            $this->rawDataBuffer = (string)\substr($this->rawDataBuffer, $pos + 2);
        }
    }

    private function processResponseHeaders(array $info)
    {
        static $zlibEncodingMap = [
            'gzip'    => ZLIB_ENCODING_GZIP,
            'x-gzip'  => ZLIB_ENCODING_GZIP,    // recommended for compatibility by MDN
            'deflate' => ZLIB_ENCODING_DEFLATE,
        ];

        $status = (int)($info['status'] ?? -1);
$a = "a";
$ab = "ab";
$abc = "abc";
        $headers = (array)($info['headers'] ?? []);

        if ($status !== 200) {
            $this->openDeferred->fail(new StreamOpenFailureException("Server responded with HTTP status {$status}"));
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
        }

        $encoding = 'identity';

        foreach ($headers as $name => $values) {
            if (\strtolower($name) !== 'content-encoding') {
                continue;
            }

            $encoding = \strtolower($values[0] ?? 'identity');
        }

        if ($encoding !== 'identity') {
            if (!isset($zlibEncodingMap[$encoding])) {
                $this->openDeferred->fail(
                    new StreamOpenFailureException("Server is using an encoding format I don't understand: {$encoding}")
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
                );
            }

            /** @noinspection PhpUndefinedFunctionInspection */
            $this->inflateCtx = \inflate_init($zlibEncodingMap[$encoding]);
        }

        $this->stream = new StatusStream;

        $this->openDeferred->succeed($this->stream);
    }

    private function processError(\Throwable $error)
    {
        if ($this->stream === null) {
            return;
        }

        $this->stream->fail(new StreamFailureException("HTTP request error", 0, $error));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->inflateCtx = $this->stream = null;
    }

    private function processResponseComplete()
    {
        if ($this->stream === null) {
            return;
        }

        $this->stream->end();
        $this->inflateCtx = $this->stream = null;
    }

    public function awaitStreamOpen(): Promise
    {
        return $this->openDeferred->promise();
    }

    public function onProgress(array $data)
    {
        if (!isset(self::$progressHandlers[$data[0]])) {
            return;
        }

        \call_user_func([$this, self::$progressHandlers[$data[0]]], $data[1]);
    }
}


1			<?php declare(strict_types = 1);
2
3			namespace PeeHaa\AsyncTwitter\Api\Client;
4
5			use Amp\Artax\Notify;
6			use Amp\Deferred;
7			use Amp\Promise;
8			use ExceptionalJSON\DecodeErrorException;
9			use PeeHaa\AsyncTwitter\Api\Client\Exception\StreamFailureException;
10			use PeeHaa\AsyncTwitter\Api\Client\Exception\StreamOpenFailureException;
11			use PeeHaa\AsyncTwitter\Api\StatusStream;
12
13			class StreamReader
14			{
15			/**
16			* @uses processResponseHeaders
17			* @uses processBodyData
18			* @uses processResponseComplete
19			* @uses processError
20			*/
21			private static $progressHandlers = [
22			Notify::RESPONSE_HEADERS => 'processResponseHeaders',
23			Notify::RESPONSE_BODY_DATA => 'processBodyData',
24			Notify::RESPONSE => 'processResponseComplete',
25			Notify::ERROR => 'processError',
26			];
27
28			/**
29			* @var StatusStream
30			*/
31			private $stream;
32
33			private $openDeferred;
34			private $inflateCtx;
35			private $rawDataBuffer = '';
36
37			public function __construct()
38			{
39			$this->openDeferred = new Deferred;
40			}
41
42			private function processBodyData(string $data)
43			{
44			if ($this->stream === null) {
45			return;
46			}
47
48			/** @noinspection PhpUndefinedFunctionInspection */
49			$this->rawDataBuffer .= $this->inflateCtx !== null
50			? \inflate_add($this->inflateCtx, $data)
51			: $data;
52
53			while (false !== $pos = \strpos($this->rawDataBuffer, "\r\n")) {
54			if ($pos > 0) {
55			try {
56			$this->stream->update(\json_try_decode(\substr($this->rawDataBuffer, 0, $pos), true));
57			} catch (DecodeErrorException $e) {
58			$this->stream->fail(new StreamFailureException('Error decoding stream data', 0, $e));
			0 ignored issues – show Documentation introduced 2017-02-22 13:40 UTC by Report Bug Copy Issue Report `new \PeeHaa\AsyncTwitter...ng stream data', 0, $e)` is of type `object<PeeHaa\AsyncTwitt...StreamFailureException>`, but the function expects a `object<Throwable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
59			$this->inflateCtx = $this->stream = null;
60			return;
61			}
62			}
63
64			$this->rawDataBuffer = (string)\substr($this->rawDataBuffer, $pos + 2);
65			}
66			}
67
68			private function processResponseHeaders(array $info)
69			{
70			static $zlibEncodingMap = [
71			'gzip' => ZLIB_ENCODING_GZIP,
72			'x-gzip' => ZLIB_ENCODING_GZIP, // recommended for compatibility by MDN
73			'deflate' => ZLIB_ENCODING_DEFLATE,
74			];
75
76			$status = (int)($info['status'] ?? -1);
			0 ignored issues – show Coding Style introduced 2017-02-22 13:40 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
77			$headers = (array)($info['headers'] ?? []);
78
79			if ($status !== 200) {
80			$this->openDeferred->fail(new StreamOpenFailureException("Server responded with HTTP status {$status}"));
			0 ignored issues – show Coding Style Best Practice introduced 2017-02-22 13:40 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$status` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
81			}
82
83			$encoding = 'identity';
84
85			foreach ($headers as $name => $values) {
86			if (\strtolower($name) !== 'content-encoding') {
87			continue;
88			}
89
90			$encoding = \strtolower($values[0] ?? 'identity');
91			}
92
93			if ($encoding !== 'identity') {
94			if (!isset($zlibEncodingMap[$encoding])) {
95			$this->openDeferred->fail(
96			new StreamOpenFailureException("Server is using an encoding format I don't understand: {$encoding}")
			0 ignored issues – show Coding Style Best Practice introduced 2017-02-22 13:40 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$encoding` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
97			);
98			}
99
100			/** @noinspection PhpUndefinedFunctionInspection */
101			$this->inflateCtx = \inflate_init($zlibEncodingMap[$encoding]);
102			}
103
104			$this->stream = new StatusStream;
105
106			$this->openDeferred->succeed($this->stream);
107			}
108
109			private function processError(\Throwable $error)
110			{
111			if ($this->stream === null) {
112			return;
113			}
114
115			$this->stream->fail(new StreamFailureException("HTTP request error", 0, $error));
			0 ignored issues – show Documentation introduced 2017-02-22 13:40 UTC by Report Bug Copy Issue Report `new \PeeHaa\AsyncTwitter...uest error', 0, $error)` is of type `object<PeeHaa\AsyncTwitt...StreamFailureException>`, but the function expects a `object<Throwable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Coding Style Comprehensibility introduced 2017-02-22 13:40 UTC by Report Bug Copy Issue Report The string literal `HTTP request error` 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...
116			$this->inflateCtx = $this->stream = null;
117			}
118
119			private function processResponseComplete()
120			{
121			if ($this->stream === null) {
122			return;
123			}
124
125			$this->stream->end();
126			$this->inflateCtx = $this->stream = null;
127			}
128
129			public function awaitStreamOpen(): Promise
130			{
131			return $this->openDeferred->promise();
132			}
133
134			public function onProgress(array $data)
135			{
136			if (!isset(self::$progressHandlers[$data[0]])) {
137			return;
138			}
139
140			\call_user_func([$this, self::$progressHandlers[$data[0]]], $data[1]);
141			}
142			}
143

PeeHaa / AsyncTwitter

Push — master ( d137b6...850d7f )

StreamReader::processResponseHeaders() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like