Client::ensureCallable() - Code Metrics - Inspection of "Enhancement: Extract method which ensures result i..." - php-http/mock-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#43)

by Andreas

created 2019-06-05 15:45 UTC

Client::ensureCallable() A

↳ Parent: Client

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4.016

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	9
cts	10
cp	0.9
rs	9.6333
c	0
b	0
f	0
cc	4
nc	4
nop	1
crap	4.016

<?php

namespace Http\Mock;

use Http\Client\Common\HttpAsyncClientEmulator;
use Http\Client\Common\VersionBridgeClient;
use Http\Client\Exception;
use Http\Client\HttpAsyncClient;
use Http\Client\HttpClient;
use Http\Discovery\MessageFactoryDiscovery;
use Http\Message\RequestMatcher;
use Http\Message\ResponseFactory;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * An implementation of the HTTP client that is useful for automated tests.
 *
 * This mock does not send requests but stores them for later retrieval.
 * You can configure the mock with responses to return and/or exceptions to throw.
 *
 * @author David de Boer <[email protected]>
 */
class Client implements HttpClient, HttpAsyncClient
{
    use HttpAsyncClientEmulator;
    use VersionBridgeClient;

    /**
     * @var ResponseFactory
     */
    private $responseFactory;

    /**
     * @var array
     */
    private $conditionalResults = [];

    /**
     * @var RequestInterface[]
     */
    private $requests = [];

    /**
     * @var ResponseInterface[]
     */
    private $responses = [];

    /**
     * @var ResponseInterface|null
     */
    private $defaultResponse;

    /**
     * @var Exception[]
     */
    private $exceptions = [];

    /**
     * @var Exception|null
     */
    private $defaultException;

    public function __construct(ResponseFactory $responseFactory = null)
    {
        $this->responseFactory = $responseFactory ?: MessageFactoryDiscovery::find();
    }

    /**
     * {@inheritdoc}
     */
    public function doSendRequest(RequestInterface $request)
    {
        $this->requests[] = $request;

        foreach ($this->conditionalResults as $result) {
            /**
             * @var RequestMatcher
             */
            $matcher = $result['matcher'];

            /**
             * @var callable
             */
            $callable = $result['callable'];

            if ($matcher->matches($request)) {
                return $callable($request);
            }
        }

        if (count($this->exceptions) > 0) {
            throw array_shift($this->exceptions);
        }

        if (count($this->responses) > 0) {
            return array_shift($this->responses);
        }

        if ($this->defaultException) {
            throw $this->defaultException;
        }

        if ($this->defaultResponse) {
            return $this->defaultResponse;
        }

        // Return success response by default
        return $this->responseFactory->createResponse();
    }

    /**
     * Adds an exception to be thrown or response to be returned if the request
     * matcher matches.
     *
     * For more complex logic, pass a callable as $result. The method is given
     * the request and MUST either return a ResponseInterface or throw an
     * exception that implements the PSR-18 / HTTPlug exception interface.
     *
     * @param ResponseInterface|Exception|ClientExceptionInterface|callable $result
     */
    public function on(RequestMatcher $requestMatcher, $result)
    {
        $callable = self::ensureCallable($result);

        $this->conditionalResults[] = [
            'matcher' => $requestMatcher,
            'callable' => $callable,
        ];
    }

    /**
     * @param ResponseInterface|Exception|ClientExceptionInterface|callable $result
     *
     * @throws \InvalidArgumentException
     *
     * @return callable
     */
    private static function ensureCallable($result)
    {
        switch (true) {
            case is_callable($result):
                return $result;
            case $result instanceof ResponseInterface:
                return function () use ($result) {
                    return $result;
                };

                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case $result instanceof \Exception:
                return function () use ($result) {
                    throw $result;
                };
            default:
                throw new \InvalidArgumentException('Result must be either a response, an exception, or a callable');
        }
    }

    /**
     * Adds an exception that will be thrown.
     */
    public function addException(\Exception $exception)

    {
        if (!$exception instanceof Exception) {
            @trigger_error('Clients may only throw exceptions of type '.Exception::class.'. Setting an exception of class '.get_class($exception).' will not be possible anymore in the future', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
        $this->exceptions[] = $exception;
    }

    /**
     * Sets the default exception to throw when the list of added exceptions and responses is exhausted.
     *
     * If both a default exception and a default response are set, the exception will be thrown.
     */
    public function setDefaultException(\Exception $defaultException = null)

    {
        if (!$defaultException instanceof Exception) {
            @trigger_error('Clients may only throw exceptions of type '.Exception::class.'. Setting an exception of class '.get_class($defaultException).' will not be possible anymore in the future', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
        $this->defaultException = $defaultException;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Adds a response that will be returned in first in first out order.
     */
    public function addResponse(ResponseInterface $response)
    {
        $this->responses[] = $response;
    }

    /**
     * Sets the default response to be returned when the list of added exceptions and responses is exhausted.
     */
    public function setDefaultResponse(ResponseInterface $defaultResponse = null)
    {
        $this->defaultResponse = $defaultResponse;
    }

    /**
     * Returns requests that were sent.
     *
     * @return RequestInterface[]
     */
    public function getRequests()
    {
        return $this->requests;
    }

    public function getLastRequest()
    {
        return end($this->requests);
    }

    public function reset()
    {
        $this->responses = [];
        $this->exceptions = [];
        $this->requests = [];
        $this->setDefaultException();
        $this->setDefaultResponse();
    }
}


1			<?php
2
3			namespace Http\Mock;
4
5			use Http\Client\Common\HttpAsyncClientEmulator;
6			use Http\Client\Common\VersionBridgeClient;
7			use Http\Client\Exception;
8			use Http\Client\HttpAsyncClient;
9			use Http\Client\HttpClient;
10			use Http\Discovery\MessageFactoryDiscovery;
11			use Http\Message\RequestMatcher;
12			use Http\Message\ResponseFactory;
13			use Psr\Http\Client\ClientExceptionInterface;
14			use Psr\Http\Message\RequestInterface;
15			use Psr\Http\Message\ResponseInterface;
16
17			/**
18			* An implementation of the HTTP client that is useful for automated tests.
19			*
20			* This mock does not send requests but stores them for later retrieval.
21			* You can configure the mock with responses to return and/or exceptions to throw.
22			*
23			* @author David de Boer <[email protected]>
24			*/
25			class Client implements HttpClient, HttpAsyncClient
26			{
27			use HttpAsyncClientEmulator;
28			use VersionBridgeClient;
29
30			/**
31			* @var ResponseFactory
32			*/
33			private $responseFactory;
34
35			/**
36			* @var array
37			*/
38			private $conditionalResults = [];
39
40			/**
41			* @var RequestInterface[]
42			*/
43			private $requests = [];
44
45			/**
46			* @var ResponseInterface[]
47			*/
48			private $responses = [];
49
50			/**
51			* @var ResponseInterface\|null
52			*/
53			private $defaultResponse;
54
55			/**
56			* @var Exception[]
57			*/
58			private $exceptions = [];
59
60			/**
61			* @var Exception\|null
62			*/
63			private $defaultException;
64
65	15		public function __construct(ResponseFactory $responseFactory = null)
66			{
67	15		$this->responseFactory = $responseFactory ?: MessageFactoryDiscovery::find();
68	15		}
69
70			/**
71			* {@inheritdoc}
72			*/
73	11		public function doSendRequest(RequestInterface $request)
74			{
75	11		$this->requests[] = $request;
76
77	11		foreach ($this->conditionalResults as $result) {
78			/**
79			* @var RequestMatcher
80			*/
81	4		$matcher = $result['matcher'];
82
83			/**
84			* @var callable
85			*/
86	4		$callable = $result['callable'];
87
88	4		if ($matcher->matches($request)) {
89	4		return $callable($request);
90			}
91			}
92
93	8		if (count($this->exceptions) > 0) {
94	1		throw array_shift($this->exceptions);
95			}
96
97	7		if (count($this->responses) > 0) {
98	3		return array_shift($this->responses);
99			}
100
101	4		if ($this->defaultException) {
102	1		throw $this->defaultException;
103			}
104
105	3		if ($this->defaultResponse) {
106	1		return $this->defaultResponse;
107			}
108
109			// Return success response by default
110	2		return $this->responseFactory->createResponse();
111			}
112
113			/**
114			* Adds an exception to be thrown or response to be returned if the request
115			* matcher matches.
116			*
117			* For more complex logic, pass a callable as $result. The method is given
118			* the request and MUST either return a ResponseInterface or throw an
119			* exception that implements the PSR-18 / HTTPlug exception interface.
120			*
121			* @param ResponseInterface\|Exception\|ClientExceptionInterface\|callable $result
122			*/
123	4		public function on(RequestMatcher $requestMatcher, $result)
124			{
125	4		$callable = self::ensureCallable($result);
126
127			$this->conditionalResults[] = [
128	4		'matcher' => $requestMatcher,
129	1		'callable' => $callable,
130			];
131	1		}
132	3
133			/**
134	1		* @param ResponseInterface\|Exception\|ClientExceptionInterface\|callable $result
135	2		*
136			* @throws \InvalidArgumentException
137	2		*
138	1		* @return callable
139	1		*/
140	1		private static function ensureCallable($result)
141	1		{
142			switch (true) {
143	1		case is_callable($result):
144			return $result;
145			case $result instanceof ResponseInterface:
146			return function () use ($result) {
147	4		return $result;
148	4		};
149	4
150			break;
			0 ignored issues – show Unused Code introduced 2019-06-05 15:54 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
151	4		case $result instanceof \Exception:
152			return function () use ($result) {
153			throw $result;
154			};
155			default:
156	2		throw new \InvalidArgumentException('Result must be either a response, an exception, or a callable');
157			}
158	2		}
159
160			/**
161			* Adds an exception that will be thrown.
162			*/
163		View Code Duplication	public function addException(\Exception $exception)
			0 ignored issues – show Duplication introduced 2019-01-02 09:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
164			{
165			if (!$exception instanceof Exception) {
166			@trigger_error('Clients may only throw exceptions of type '.Exception::class.'. Setting an exception of class '.get_class($exception).' will not be possible anymore in the future', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2019-01-02 09:09 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
167			}
168			$this->exceptions[] = $exception;
169			}
170
171			/**
172			* Sets the default exception to throw when the list of added exceptions and responses is exhausted.
173			*
174			* If both a default exception and a default response are set, the exception will be thrown.
175			*/
176		View Code Duplication	public function setDefaultException(\Exception $defaultException = null)
			0 ignored issues – show Duplication introduced 2019-01-02 09:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
177			{
178			if (!$defaultException instanceof Exception) {
179			@trigger_error('Clients may only throw exceptions of type '.Exception::class.'. Setting an exception of class '.get_class($defaultException).' will not be possible anymore in the future', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2019-01-02 09:09 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
180			}
181			$this->defaultException = $defaultException;
			0 ignored issues – show Documentation Bug introduced 2017-11-07 23:58 UTC by Report Bug Copy Issue Report It seems like `$defaultException` can also be of type `object<Exception>`. However, the property `$defaultException` is declared as type `object<Http\Client\Exception>\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
182			}
183
184			/**
185			* Adds a response that will be returned in first in first out order.
186			*/
187			public function addResponse(ResponseInterface $response)
188			{
189			$this->responses[] = $response;
190			}
191
192			/**
193			* Sets the default response to be returned when the list of added exceptions and responses is exhausted.
194			*/
195			public function setDefaultResponse(ResponseInterface $defaultResponse = null)
196			{
197			$this->defaultResponse = $defaultResponse;
198			}
199
200			/**
201			* Returns requests that were sent.
202			*
203			* @return RequestInterface[]
204			*/
205			public function getRequests()
206			{
207			return $this->requests;
208			}
209
210			public function getLastRequest()
211			{
212			return end($this->requests);
213			}
214
215			public function reset()
216			{
217			$this->responses = [];
218			$this->exceptions = [];
219			$this->requests = [];
220			$this->setDefaultException();
221			$this->setDefaultResponse();
222			}
223			}
224

php-http / mock-client

Pull Request — master (#43)

Client::ensureCallable() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like