ClientBridge::stream() - Code Metrics - Inspection of "update to new goutte" - bytic/goutte-phantomjs-bridge - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( 03b202...626816 )

by Gabriel

created 2020-06-08 16:49 UTC

ClientBridge::stream() A

↳ Parent: ClientBridge

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	3
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	2

<?php

namespace ByTIC\GouttePhantomJs\Clients\PhantomJs;

use JonnyW\PhantomJs\Client as PhantomJsBaseClient;
use JonnyW\PhantomJs\Http\RequestInterface;
use PhantomInstaller\PhantomBinary;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
use Symfony\Contracts\HttpClient\ResponseStreamInterface;

/**
 * Class PhantomJsClientBridge
 * @package ByTIC\GouttePhantomJs\Clients\PhantomJs
 */
class ClientBridge implements HttpClientInterface
{
    protected $phantomJsClient = null;

    /** @var array Default request options */
    private $config;

    /**
     * ClientBridge constructor.
     *
     * @param array $config
     */
    public function __construct(array $config = [])
    {
        $this->configureDefaults($config);
    }

    /**
     * @inheritdoc
     */
    public function request(string $method, string $url, array $options = []): ResponseInterface
    {
        $client  = $this->getPhantomJsClient();
        $request = $this->createRequest($client, $method, $url, $options);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $request = $this->applyConfig($request);

        /**
         * @see \JonnyW\PhantomJs\Http\Response
         **/
        $response = $client->getMessageFactory()->createResponse();

        // Send the request
        $client->send($request, $response);

        return ResponseFormatter::format($response);
    }

    /**
     * @inheritdoc
     */
    public function requestAsync($method, $uri = '', array $options = [])

    {
    }

    /**
     * @inheritdoc
     */
    public function send(RequestInterface $request, array $options = [])

    {
    }

    /**
     * @inheritdoc
     */
    public function sendAsync(RequestInterface $request, array $options = [])

    {
    }

    /**
     * @inheritdoc
     */
    public function stream($responses, float $timeout = null): ResponseStreamInterface
    {
    }

    /**
     * @inheritdoc
     */
    public function getConfig($option = null)
    {
        return $option === null
            ? $this->config
            : (isset($this->config[$option]) ? $this->config[$option] : null);
    }

    /**
     * Configures the default options for a client.
     *
     * @param array $config
     */
    protected function configureDefaults(array $config)
    {
        $defaults = $this->getConfigDefaults();

        $this->config = $config + $defaults;
    }

    /**
     * @return array
     */
    protected function getConfigDefaults()
    {
        return [
            'request_delay' => false
        ];
    }

    /**
     * @param $option
     * @param $value
     *
     * @return mixed
     */
    public function setConfig($option, $value)
    {
        return $this->config[$option] = $value;
    }

    /**
     * @param PhantomJsBaseClient $client
     * @param $method
     * @param string $uri
     * @param array $parameters
     *
     * @return RequestInterface
     */
    protected function createRequest($client, $method, $uri = '', array $parameters = [])
    {
        /**
         * @see \JonnyW\PhantomJs\Http\Request
         **/
        $request = $client->getMessageFactory()->createRequest($uri, $method);
        $request->addHeader(
            'User-Agent',
            'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:57.0) Gecko/20100101 Firefox/57.0'
        );

        $request->addHeader(
            'Content-Type',
            'application/x-www-form-urlencoded'
        );

        if (isset($parameters['form_params'])) {
            $request->setRequestData($parameters['form_params']);
        }

        return $request;
    }

    /**
     * @param RequestInterface $request
     *
     * @return RequestInterface
     */
    protected function applyConfig($request)
    {
        $requestDelay = $this->getConfig('request_delay');
        if ($requestDelay > 0) {
            $request->setDelay($requestDelay);
        }

        return $request;
    }


    /**
     * @return PhantomJsBaseClient|null
     */
    protected function getPhantomJsClient()
    {
        if ($this->phantomJsClient === null) {
            $this->phantomJsClient = PhantomJsBaseClient::getInstance();
            $this->phantomJsClient->getEngine()->setPath(PhantomBinary::getBin());
        }

        return $this->phantomJsClient;
    }
}


1		<?php
2
3		namespace ByTIC\GouttePhantomJs\Clients\PhantomJs;
4
5		use JonnyW\PhantomJs\Client as PhantomJsBaseClient;
6		use JonnyW\PhantomJs\Http\RequestInterface;
7		use PhantomInstaller\PhantomBinary;
8		use Symfony\Contracts\HttpClient\HttpClientInterface;
9		use Symfony\Contracts\HttpClient\ResponseInterface;
10		use Symfony\Contracts\HttpClient\ResponseStreamInterface;
11
12		/**
13		* Class PhantomJsClientBridge
14		* @package ByTIC\GouttePhantomJs\Clients\PhantomJs
15		*/
16		class ClientBridge implements HttpClientInterface
17		{
18		protected $phantomJsClient = null;
19
20		/** @var array Default request options */
21		private $config;
22
23		/**
24		* ClientBridge constructor.
25		*
26		* @param array $config
27		*/
28	1	public function __construct(array $config = [])
29		{
30	1	$this->configureDefaults($config);
31	1	}
32
33		/**
34		* @inheritdoc
35		*/
36		public function request(string $method, string $url, array $options = []): ResponseInterface
37		{
38		$client = $this->getPhantomJsClient();
39		$request = $this->createRequest($client, $method, $url, $options);
		0 ignored issues – show Bug introduced 2020-06-08 16:59 UTC by Report Bug Copy Issue Report It seems like `$client` defined by `$this->getPhantomJsClient()` on line `38` can be `null`; however, `ByTIC\GouttePhantomJs\Cl...Bridge::createRequest()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
40		$request = $this->applyConfig($request);
41
42		/**
43		* @see \JonnyW\PhantomJs\Http\Response
44		**/
45		$response = $client->getMessageFactory()->createResponse();
46
47		// Send the request
48		$client->send($request, $response);
49
50		return ResponseFormatter::format($response);
51		}
52
53		/**
54		* @inheritdoc
55		*/
56		public function requestAsync($method, $uri = '', array $options = [])
		0 ignored issues – show Unused Code introduced 2020-06-08 16:59 UTC by Report Bug Copy Issue Report The parameter `$method` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2020-06-08 16:59 UTC by Report Bug Copy Issue Report The parameter `$uri` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2020-06-08 16:59 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
57		{
58		}
59
60		/**
61		* @inheritdoc
62		*/
63		public function send(RequestInterface $request, array $options = [])
		0 ignored issues – show Unused Code introduced 2020-06-08 16:59 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2020-06-08 16:59 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
64		{
65		}
66
67		/**
68		* @inheritdoc
69		*/
70		public function sendAsync(RequestInterface $request, array $options = [])
		0 ignored issues – show Unused Code introduced 2020-06-08 16:59 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2020-06-08 16:59 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
71		{
72		}
73
74		/**
75		* @inheritdoc
76		*/
77		public function stream($responses, float $timeout = null): ResponseStreamInterface
78		{
79		}
80
81		/**
82		* @inheritdoc
83		*/
84		public function getConfig($option = null)
85		{
86		return $option === null
87		? $this->config
88		: (isset($this->config[$option]) ? $this->config[$option] : null);
89		}
90
91		/**
92		* Configures the default options for a client.
93		*
94		* @param array $config
95		*/
96	1	protected function configureDefaults(array $config)
97		{
98	1	$defaults = $this->getConfigDefaults();
99
100	1	$this->config = $config + $defaults;
101	1	}
102
103		/**
104		* @return array
105		*/
106	1	protected function getConfigDefaults()
107		{
108		return [
109	1	'request_delay' => false
110		];
111		}
112
113		/**
114		* @param $option
115		* @param $value
116		*
117		* @return mixed
118		*/
119		public function setConfig($option, $value)
120		{
121		return $this->config[$option] = $value;
122		}
123
124		/**
125		* @param PhantomJsBaseClient $client
126		* @param $method
127		* @param string $uri
128		* @param array $parameters
129		*
130		* @return RequestInterface
131		*/
132		protected function createRequest($client, $method, $uri = '', array $parameters = [])
133		{
134		/**
135		* @see \JonnyW\PhantomJs\Http\Request
136		**/
137		$request = $client->getMessageFactory()->createRequest($uri, $method);
138		$request->addHeader(
139		'User-Agent',
140		'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:57.0) Gecko/20100101 Firefox/57.0'
141		);
142
143		$request->addHeader(
144		'Content-Type',
145		'application/x-www-form-urlencoded'
146		);
147
148		if (isset($parameters['form_params'])) {
149		$request->setRequestData($parameters['form_params']);
150		}
151
152		return $request;
153		}
154
155		/**
156		* @param RequestInterface $request
157		*
158		* @return RequestInterface
159		*/
160		protected function applyConfig($request)
161		{
162		$requestDelay = $this->getConfig('request_delay');
163		if ($requestDelay > 0) {
164		$request->setDelay($requestDelay);
165		}
166
167		return $request;
168		}
169
170
171		/**
172		* @return PhantomJsBaseClient\|null
173		*/
174		protected function getPhantomJsClient()
175		{
176		if ($this->phantomJsClient === null) {
177		$this->phantomJsClient = PhantomJsBaseClient::getInstance();
178		$this->phantomJsClient->getEngine()->setPath(PhantomBinary::getBin());
179		}
180
181		return $this->phantomJsClient;
182		}
183		}
184

bytic / goutte-phantomjs-bridge

Push — master ( 03b202...626816 )

ClientBridge::stream() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like