ApiTestClient::getScript() - Code Metrics - Inspection of "Using Decorator instead of DI param for test clien..." - kleijnweb/swagger-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3df05c...731503 )

by John

created 2016-07-10 13:51 UTC

ApiTestClient::getScript() A

↳ Parent: ApiTestClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/*
 * This file is part of the KleijnWeb\SwaggerBundle package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace KleijnWeb\SwaggerBundle\Test;

use Symfony\Bundle\FrameworkBundle\Client;
use Symfony\Component\BrowserKit\Request;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DomCrawler\Crawler;
use Symfony\Component\DomCrawler\Form;
use Symfony\Component\DomCrawler\Link;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\HttpKernel\Profiler\Profile as HttpProfile;
use Symfony\Component\HttpFoundation\Response;

/**
 * @author John Kleijn <[email protected]>
 * @codeCoverageIgnore
 */
class ApiTestClient extends Client
{
    /**
     * @var Client
     */
    private $subject;

    /**
     * ApiTestClient constructor.
     *
     * @param Client $subject
     */
    public function __construct(Client $subject)
    {
        $this->subject = $subject;
    }

    /**
     * Makes a request from a Request object directly.
     *
     * @param Request $request       A Request instance
     * @param bool    $changeHistory Whether to update the history or not (only used internally for back(), forward(),
     *                               and reload())
     *
     * @return Crawler
     */
    public function requestFromRequest(Request $request, $changeHistory = true)
    {
        return $this->subject->requestFromRequest($request, $changeHistory);
    }

    /**
     * Returns the container.
     *
     * @return ContainerInterface
     */
    public function getContainer()
    {
        return $this->subject->getContainer();
    }

    /**
     * Returns the kernel.
     *
     * @return KernelInterface
     */
    public function getKernel()
    {
        return $this->subject->getKernel();
    }

    /**
     * Gets the profile associated with the current Response.
     *
     * @return HttpProfile A Profile instance
     */
    public function getProfile()
    {
        return $this->subject->getProfile();
    }

    /**
     * Enables the profiler for the very next request.
     *
     * If the profiler is not enabled, the call to this method does nothing.
     */
    public function enableProfiler()
    {
        $this->subject->enableProfiler();
    }

    /**
     * {@inheritdoc}
     *
     * @param Request $request A Request instance
     *
     * @return Response A Response instance
     */
    protected function doRequest($request)
    {
        return $this->subject->doRequest($request);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * {@inheritdoc}
     *
     * @param Request $request A Request instance
     *
     * @return Response A Response instance
     */
    protected function doRequestInProcess($request)
    {
        return $this->subject->doRequestInProcess($request);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Returns the script to execute when the request must be insulated.
     *
     * It assumes that the autoloader is named 'autoload.php' and that it is
     * stored in the same directory as the kernel (this is the case for the
     * Symfony Standard Edition). If this is not your case, create your own
     * client and override this method.
     *
     * @param Request $request A Request instance
     *
     * @return string The script content
     */
    protected function getScript($request)
    {
        return $this->subject->getScript($request);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }


    /**
     * Sets whether to automatically follow redirects or not.
     *
     * @param bool $followRedirect Whether to follow redirects
     *
     * @api
     */
    public function followRedirects($followRedirect = true)
    {
        $this->subject->followRedirects($followRedirect);
    }

    /**
     * Sets the maximum number of requests that crawler can follow.
     *
     * @param int $maxRedirects
     */
    public function setMaxRedirects($maxRedirects)
    {
        $this->subject->setMaxRedirects($maxRedirects);
    }

    /**
     * Sets the insulated flag.
     *
     * @param bool $insulated Whether to insulate the requests or not
     *
     * @throws \RuntimeException When Symfony Process Component is not installed
     *
     * @api
     */
    public function insulate($insulated = true)
    {
        $this->subject->insulate($insulated);
    }

    /**
     * Sets server parameters.
     *
     * @param array $server An array of server parameters
     *
     * @api
     */
    public function setServerParameters(array $server)
    {
        $this->subject->setServerParameters($server);
    }

    /**
     * Sets single server parameter.
     *
     * @param string $key   A key of the parameter
     * @param string $value A value of the parameter
     */
    public function setServerParameter($key, $value)
    {
        $this->subject->setServerParameter($key, $value);
    }

    /**
     * Gets single server parameter for specified key.
     *
     * @param string $key     A key of the parameter to get
     * @param string $default A default value when key is undefined
     *
     * @return string A value of the parameter
     */
    public function getServerParameter($key, $default = '')
    {
        return $this->subject->getServerParameter($key, $default);
    }

    /**
     * Returns the History instance.
     *
     * @return History A History instance
     *
     * @api
     */
    public function getHistory()
    {
        return $this->subject->getHistory();
    }

    /**
     * Returns the CookieJar instance.
     *
     * @return CookieJar A CookieJar instance
     *
     * @api
     */
    public function getCookieJar()
    {
        return $this->subject->getCookieJar();
    }

    /**
     * Returns the current Crawler instance.
     *
     * @return Crawler|null A Crawler instance
     *
     * @api
     */
    public function getCrawler()
    {
        return $this->subject->getCrawler();
    }

    /**
     * Returns the current BrowserKit Response instance.
     *
     * @return Response|null A BrowserKit Response instance
     *
     * @api
     */
    public function getInternalResponse()
    {
        return $this->subject->getInternalResponse();
    }

    /**
     * Returns the current origin response instance.
     *
     * The origin response is the response instance that is returned
     * by the code that handles requests.
     *
     * @return object|null A response instance
     *
     * @see doRequest()
     *
     * @api
     */
    public function getResponse()
    {
        return $this->subject->getResponse();
    }

    /**
     * Returns the current BrowserKit Request instance.
     *
     * @return Request|null A BrowserKit Request instance
     *
     * @api
     */
    public function getInternalRequest()
    {
        return $this->subject->getInternalRequest();
    }

    /**
     * Returns the current origin Request instance.
     *
     * The origin request is the request instance that is sent
     * to the code that handles requests.
     *
     * @return object|null A Request instance
     *
     * @see doRequest()
     *
     * @api
     */
    public function getRequest()
    {
        return $this->subject->getRequest();
    }

    /**
     * Clicks on a given link.
     *
     * @param Link $link A Link instance
     *
     * @return Crawler
     *
     * @api
     */
    public function click(Link $link)
    {
        return $this->subject->click($link);
    }

    /**
     * Submits a form.
     *
     * @param Form  $form   A Form instance
     * @param array $values An array of form field values
     *
     * @return Crawler
     *
     * @api
     */
    public function submit(Form $form, array $values = [])
    {
        return $this->subject->submit($form, $values);
    }

    /**
     * Calls a URI.
     *
     * @param string $method        The request method
     * @param string $uri           The URI to fetch
     * @param array  $parameters    The Request parameters
     * @param array  $files         The files
     * @param array  $server        The server parameters (HTTP headers are referenced with a HTTP_ prefix as PHP does)
     * @param string $content       The raw body data
     * @param bool   $changeHistory Whether to update the history or not (only used internally for back(), forward(),
     *                              and reload())
     *
     * @return Crawler
     *
     * @api
     */
    public function request(
        $method,
        $uri,
        array $parameters = [],
        array $files = [],
        array $server = [],
        $content = null,
        $changeHistory = true
    ) {
        return $this->subject->request(
            $method,
            $uri,
            $parameters,
            $files,
            $server,
            $content,
            $changeHistory
        );
    }

    /**
     * Filters the BrowserKit request to the origin one.
     *
     * @param Request $request The BrowserKit Request to filter
     *
     * @return object An origin request instance
     */
    protected function filterRequest(Request $request)
    {
        return $this->subject->filterRequest($request);
    }

    /**
     * Filters the origin response to the BrowserKit one.
     *
     * @param object $response The origin response to filter
     *
     * @return Response An BrowserKit Response instance
     */
    protected function filterResponse($response)
    {
        return $this->subject->filterResponse($response);
    }

    /**
     * Creates a crawler.
     *
     * This method returns null if the DomCrawler component is not available.
     *
     * @param string $uri     A URI
     * @param string $content Content for the crawler to use
     * @param string $type    Content type
     *
     * @return Crawler|null
     */
    protected function createCrawlerFromContent($uri, $content, $type)
    {
        return $this->subject->createCrawlerFromContent($uri, $content, $type);
    }

    /**
     * Goes back in the browser history.
     *
     * @return Crawler
     *
     * @api
     */
    public function back()
    {
        return $this->subject->back();
    }

    /**
     * Goes forward in the browser history.
     *
     * @return Crawler
     *
     * @api
     */
    public function forward()
    {
        return $this->subject->forward();
    }

    /**
     * Reloads the current browser.
     *
     * @return Crawler
     *
     * @api
     */
    public function reload()
    {
        return $this->subject->reload();
    }

    /**
     * Follow redirects?
     *
     * @return Crawler
     *
     * @throws \LogicException If request was not a redirect
     *
     * @api
     */
    public function followRedirect()
    {
        return $this->subject->followRedirect();
    }

    /**
     * Restarts the client.
     *
     * It flushes history and all cookies.
     *
     * @api
     */
    public function restart()
    {
        $this->subject->restart();
    }

    /**
     * Takes a URI and converts it to absolute if it is not already absolute.
     *
     * @param string $uri A URI
     *
     * @return string An absolute URI
     */
    protected function getAbsoluteUri($uri)
    {
        return $this->subject->getAbsoluteUri($uri);
    }
}


1			<?php
2			/*
3			* This file is part of the KleijnWeb\SwaggerBundle package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8
9			namespace KleijnWeb\SwaggerBundle\Test;
10
11			use Symfony\Bundle\FrameworkBundle\Client;
12			use Symfony\Component\BrowserKit\Request;
13			use Symfony\Component\DependencyInjection\ContainerInterface;
14			use Symfony\Component\DomCrawler\Crawler;
15			use Symfony\Component\DomCrawler\Form;
16			use Symfony\Component\DomCrawler\Link;
17			use Symfony\Component\HttpKernel\KernelInterface;
18			use Symfony\Component\HttpKernel\Profiler\Profile as HttpProfile;
19			use Symfony\Component\HttpFoundation\Response;
20
21			/**
22			* @author John Kleijn <[email protected]>
23			* @codeCoverageIgnore
24			*/
25			class ApiTestClient extends Client
26			{
27			/**
28			* @var Client
29			*/
30			private $subject;
31
32			/**
33			* ApiTestClient constructor.
34			*
35			* @param Client $subject
36			*/
37			public function __construct(Client $subject)
38			{
39			$this->subject = $subject;
40			}
41
42			/**
43			* Makes a request from a Request object directly.
44			*
45			* @param Request $request A Request instance
46			* @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(),
47			* and reload())
48			*
49			* @return Crawler
50			*/
51			public function requestFromRequest(Request $request, $changeHistory = true)
52			{
53			return $this->subject->requestFromRequest($request, $changeHistory);
54			}
55
56			/**
57			* Returns the container.
58			*
59			* @return ContainerInterface
60			*/
61			public function getContainer()
62			{
63			return $this->subject->getContainer();
64			}
65
66			/**
67			* Returns the kernel.
68			*
69			* @return KernelInterface
70			*/
71			public function getKernel()
72			{
73			return $this->subject->getKernel();
74			}
75
76			/**
77			* Gets the profile associated with the current Response.
78			*
79			* @return HttpProfile A Profile instance
80			*/
81			public function getProfile()
82			{
83			return $this->subject->getProfile();
84			}
85
86			/**
87			* Enables the profiler for the very next request.
88			*
89			* If the profiler is not enabled, the call to this method does nothing.
90			*/
91			public function enableProfiler()
92			{
93			$this->subject->enableProfiler();
94			}
95
96			/**
97			* {@inheritdoc}
98			*
99			* @param Request $request A Request instance
100			*
101			* @return Response A Response instance
102			*/
103			protected function doRequest($request)
104			{
105			return $this->subject->doRequest($request);
			0 ignored issues – show Documentation introduced 2016-07-10 14:03 UTC by Report Bug Copy Issue Report `$request` is of type `object<Symfony\Component\BrowserKit\Request>`, but the function expects a `object<Symfony\Component\HttpFoundation\Request>`. 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...
106			}
107
108			/**
109			* {@inheritdoc}
110			*
111			* @param Request $request A Request instance
112			*
113			* @return Response A Response instance
114			*/
115			protected function doRequestInProcess($request)
116			{
117			return $this->subject->doRequestInProcess($request);
			0 ignored issues – show Documentation introduced 2016-07-10 14:03 UTC by Report Bug Copy Issue Report `$request` is of type `object<Symfony\Component\BrowserKit\Request>`, but the function expects a `object<Symfony\Component\HttpFoundation\Request>`. 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...
118			}
119
120			/**
121			* Returns the script to execute when the request must be insulated.
122			*
123			* It assumes that the autoloader is named 'autoload.php' and that it is
124			* stored in the same directory as the kernel (this is the case for the
125			* Symfony Standard Edition). If this is not your case, create your own
126			* client and override this method.
127			*
128			* @param Request $request A Request instance
129			*
130			* @return string The script content
131			*/
132			protected function getScript($request)
133			{
134			return $this->subject->getScript($request);
			0 ignored issues – show Documentation introduced 2016-07-10 14:03 UTC by Report Bug Copy Issue Report `$request` is of type `object<Symfony\Component\BrowserKit\Request>`, but the function expects a `object<Symfony\Component\HttpFoundation\Request>`. 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...
135			}
136
137
138			/**
139			* Sets whether to automatically follow redirects or not.
140			*
141			* @param bool $followRedirect Whether to follow redirects
142			*
143			* @api
144			*/
145			public function followRedirects($followRedirect = true)
146			{
147			$this->subject->followRedirects($followRedirect);
148			}
149
150			/**
151			* Sets the maximum number of requests that crawler can follow.
152			*
153			* @param int $maxRedirects
154			*/
155			public function setMaxRedirects($maxRedirects)
156			{
157			$this->subject->setMaxRedirects($maxRedirects);
158			}
159
160			/**
161			* Sets the insulated flag.
162			*
163			* @param bool $insulated Whether to insulate the requests or not
164			*
165			* @throws \RuntimeException When Symfony Process Component is not installed
166			*
167			* @api
168			*/
169			public function insulate($insulated = true)
170			{
171			$this->subject->insulate($insulated);
172			}
173
174			/**
175			* Sets server parameters.
176			*
177			* @param array $server An array of server parameters
178			*
179			* @api
180			*/
181			public function setServerParameters(array $server)
182			{
183			$this->subject->setServerParameters($server);
184			}
185
186			/**
187			* Sets single server parameter.
188			*
189			* @param string $key A key of the parameter
190			* @param string $value A value of the parameter
191			*/
192			public function setServerParameter($key, $value)
193			{
194			$this->subject->setServerParameter($key, $value);
195			}
196
197			/**
198			* Gets single server parameter for specified key.
199			*
200			* @param string $key A key of the parameter to get
201			* @param string $default A default value when key is undefined
202			*
203			* @return string A value of the parameter
204			*/
205			public function getServerParameter($key, $default = '')
206			{
207			return $this->subject->getServerParameter($key, $default);
208			}
209
210			/**
211			* Returns the History instance.
212			*
213			* @return History A History instance
214			*
215			* @api
216			*/
217			public function getHistory()
218			{
219			return $this->subject->getHistory();
220			}
221
222			/**
223			* Returns the CookieJar instance.
224			*
225			* @return CookieJar A CookieJar instance
226			*
227			* @api
228			*/
229			public function getCookieJar()
230			{
231			return $this->subject->getCookieJar();
232			}
233
234			/**
235			* Returns the current Crawler instance.
236			*
237			* @return Crawler\|null A Crawler instance
238			*
239			* @api
240			*/
241			public function getCrawler()
242			{
243			return $this->subject->getCrawler();
244			}
245
246			/**
247			* Returns the current BrowserKit Response instance.
248			*
249			* @return Response\|null A BrowserKit Response instance
250			*
251			* @api
252			*/
253			public function getInternalResponse()
254			{
255			return $this->subject->getInternalResponse();
256			}
257
258			/**
259			* Returns the current origin response instance.
260			*
261			* The origin response is the response instance that is returned
262			* by the code that handles requests.
263			*
264			* @return object\|null A response instance
265			*
266			* @see doRequest()
267			*
268			* @api
269			*/
270			public function getResponse()
271			{
272			return $this->subject->getResponse();
273			}
274
275			/**
276			* Returns the current BrowserKit Request instance.
277			*
278			* @return Request\|null A BrowserKit Request instance
279			*
280			* @api
281			*/
282			public function getInternalRequest()
283			{
284			return $this->subject->getInternalRequest();
285			}
286
287			/**
288			* Returns the current origin Request instance.
289			*
290			* The origin request is the request instance that is sent
291			* to the code that handles requests.
292			*
293			* @return object\|null A Request instance
294			*
295			* @see doRequest()
296			*
297			* @api
298			*/
299			public function getRequest()
300			{
301			return $this->subject->getRequest();
302			}
303
304			/**
305			* Clicks on a given link.
306			*
307			* @param Link $link A Link instance
308			*
309			* @return Crawler
310			*
311			* @api
312			*/
313			public function click(Link $link)
314			{
315			return $this->subject->click($link);
316			}
317
318			/**
319			* Submits a form.
320			*
321			* @param Form $form A Form instance
322			* @param array $values An array of form field values
323			*
324			* @return Crawler
325			*
326			* @api
327			*/
328			public function submit(Form $form, array $values = [])
329			{
330			return $this->subject->submit($form, $values);
331			}
332
333			/**
334			* Calls a URI.
335			*
336			* @param string $method The request method
337			* @param string $uri The URI to fetch
338			* @param array $parameters The Request parameters
339			* @param array $files The files
340			* @param array $server The server parameters (HTTP headers are referenced with a HTTP_ prefix as PHP does)
341			* @param string $content The raw body data
342			* @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(),
343			* and reload())
344			*
345			* @return Crawler
346			*
347			* @api
348			*/
349			public function request(
350			$method,
351			$uri,
352			array $parameters = [],
353			array $files = [],
354			array $server = [],
355			$content = null,
356			$changeHistory = true
357			) {
358			return $this->subject->request(
359			$method,
360			$uri,
361			$parameters,
362			$files,
363			$server,
364			$content,
365			$changeHistory
366			);
367			}
368
369			/**
370			* Filters the BrowserKit request to the origin one.
371			*
372			* @param Request $request The BrowserKit Request to filter
373			*
374			* @return object An origin request instance
375			*/
376			protected function filterRequest(Request $request)
377			{
378			return $this->subject->filterRequest($request);
379			}
380
381			/**
382			* Filters the origin response to the BrowserKit one.
383			*
384			* @param object $response The origin response to filter
385			*
386			* @return Response An BrowserKit Response instance
387			*/
388			protected function filterResponse($response)
389			{
390			return $this->subject->filterResponse($response);
391			}
392
393			/**
394			* Creates a crawler.
395			*
396			* This method returns null if the DomCrawler component is not available.
397			*
398			* @param string $uri A URI
399			* @param string $content Content for the crawler to use
400			* @param string $type Content type
401			*
402			* @return Crawler\|null
403			*/
404			protected function createCrawlerFromContent($uri, $content, $type)
405			{
406			return $this->subject->createCrawlerFromContent($uri, $content, $type);
407			}
408
409			/**
410			* Goes back in the browser history.
411			*
412			* @return Crawler
413			*
414			* @api
415			*/
416			public function back()
417			{
418			return $this->subject->back();
419			}
420
421			/**
422			* Goes forward in the browser history.
423			*
424			* @return Crawler
425			*
426			* @api
427			*/
428			public function forward()
429			{
430			return $this->subject->forward();
431			}
432
433			/**
434			* Reloads the current browser.
435			*
436			* @return Crawler
437			*
438			* @api
439			*/
440			public function reload()
441			{
442			return $this->subject->reload();
443			}
444
445			/**
446			* Follow redirects?
447			*
448			* @return Crawler
449			*
450			* @throws \LogicException If request was not a redirect
451			*
452			* @api
453			*/
454			public function followRedirect()
455			{
456			return $this->subject->followRedirect();
457			}
458
459			/**
460			* Restarts the client.
461			*
462			* It flushes history and all cookies.
463			*
464			* @api
465			*/
466			public function restart()
467			{
468			$this->subject->restart();
469			}
470
471			/**
472			* Takes a URI and converts it to absolute if it is not already absolute.
473			*
474			* @param string $uri A URI
475			*
476			* @return string An absolute URI
477			*/
478			protected function getAbsoluteUri($uri)
479			{
480			return $this->subject->getAbsoluteUri($uri);
481			}
482			}
483

kleijnweb / swagger-bundle

Push — master ( 3df05c...731503 )

ApiTestClient::getScript() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like