AbstractCacheConstraint::matches() - Code Metrics - Inspection of "Improve Travis build" - FriendsOfSymfony/FOSHttpCache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#364)

by Alessandro

created 2017-08-09 07:56 UTC

AbstractCacheConstraint::matches() A

↳ Parent: AbstractCacheConstraint

Complexity

Conditions	4
Paths	4

Size

Total Lines	20
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4.0961

Importance

Changes

Metric	Value
dl	0
loc	20
ccs	9
cts	11
cp	0.8182
rs	9.2
c	0
b	0
f	0
cc	4
eloc	12
nc	4
nop	1
crap	4.0961

<?php

/*
 * This file is part of the FOSHttpCache package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCache\Test\PHPUnit;

use Psr\Http\Message\ResponseInterface;

/**
 * Abstract cache constraint.
 */
abstract class AbstractCacheConstraint extends \PHPUnit_Framework_Constraint
{
    protected $header = 'X-Cache';

    /**
     * Constructor.
     *
     * @param string $header Cache debug header; defaults to X-Cache-Debug
     */
    public function __construct($header = null)
    {
        if ($header) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->header = $header;
        }

        parent::__construct();
    }

    /**
     * Get cache header value.
     *
     * @return string
     */
    abstract public function getValue();

    /**
     * {@inheritdoc}
     *
     * @param Response $other The guzzle response object
     */
    protected function matches($other)
    {
        if (!$other instanceof ResponseInterface) {
            throw new \RuntimeException(sprintf('Expected a GuzzleHttp\Psr7\Response but got %s', get_class($other)));
        }
        if (!$other->hasHeader($this->header)) {
            $message = sprintf(
                'Response has no "%s" header. Configure your caching proxy '
                .'to set the header with cache hit/miss status.',
                $this->header
            );
            if (200 !== $other->getStatusCode()) {
                $message .= sprintf("\nStatus code of response is %s.", $other->getStatusCode());
            }

            throw new \RuntimeException($message);
        }

        return strpos((string) $other->getHeaderLine($this->header), $this->getValue()) !== false;
    }

    /**
     * {@inheritdoc}
     */
    protected function failureDescription($other)
    {
        return sprintf(
            'response (with status code %s) %s',
            $other->getStatusCode(),
            $this->toString()
        );
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSHttpCache package.
5		*
6		* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace FOS\HttpCache\Test\PHPUnit;
13
14		use Psr\Http\Message\ResponseInterface;
15
16		/**
17		* Abstract cache constraint.
18		*/
19		abstract class AbstractCacheConstraint extends \PHPUnit_Framework_Constraint
20		{
21		protected $header = 'X-Cache';
22
23		/**
24		* Constructor.
25		*
26		* @param string $header Cache debug header; defaults to X-Cache-Debug
27		*/
28	29	public function __construct($header = null)
29		{
30	29	if ($header) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-23 22:08 UTC by Report Bug Copy Issue Report The expression `$header` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
31	3	$this->header = $header;
32		}
33
34	29	parent::__construct();
35		}
36
37		/**
38		* Get cache header value.
39		*
40		* @return string
41		*/
42		abstract public function getValue();
43
44		/**
45		* {@inheritdoc}
46		*
47		* @param Response $other The guzzle response object
48		*/
49	29	protected function matches($other)
50		{
51	29	if (!$other instanceof ResponseInterface) {
52		throw new \RuntimeException(sprintf('Expected a GuzzleHttp\Psr7\Response but got %s', get_class($other)));
53		}
54	29	if (!$other->hasHeader($this->header)) {
55	1	$message = sprintf(
56		'Response has no "%s" header. Configure your caching proxy '
57	1	.'to set the header with cache hit/miss status.',
58	1	$this->header
59		);
60	1	if (200 !== $other->getStatusCode()) {
61		$message .= sprintf("\nStatus code of response is %s.", $other->getStatusCode());
62		}
63
64	1	throw new \RuntimeException($message);
65		}
66
67	28	return strpos((string) $other->getHeaderLine($this->header), $this->getValue()) !== false;
68		}
69
70		/**
71		* {@inheritdoc}
72		*/
73	2	protected function failureDescription($other)
74		{
75	2	return sprintf(
76	2	'response (with status code %s) %s',
77	2	$other->getStatusCode(),
78	2	$this->toString()
79		);
80		}
81		}
82

FriendsOfSymfony / FOSHttpCache

Pull Request — master (#364)

AbstractCacheConstraint::matches() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like