AbstractCacheConstraintTrait::failureDescription() - Code Metrics - Inspection of "[RFC] Added MaxHeaderValueLengthFormatter" - FriendsOfSymfony/FOSHttpCache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#424)

by Yanick

created 2018-08-29 09:07 UTC

AbstractCacheConstraintTrait::failureDescription() A

↳ Parent: AbstractCacheConstraintTrait

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

<?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;

/**
 * This trait is used to have the same code and behavior between AbstractCacheConstraint and its legacy version.
 */
trait AbstractCacheConstraintTrait
{
    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();
    }

    /**
     * {@inheritdoc}
     *
     * @param ResponseInterface $other The guzzle response object
     */
    public 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());
            }

            $message .= "\nThe response headers are:\n\n";

            foreach ($other->getHeaders() as $name => $values) {
                foreach ($values as $value) {
                    $message .= $name.': '.$value;
                }
            }

            $body = $other->getBody();
            $body->rewind();
            $message .= sprintf("\nThe response body is:\n\n %s", $body->getContents());

            throw new \RuntimeException($message);
        }

        return false !== strpos((string) $other->getHeaderLine($this->header), $this->getValue());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

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


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		* This trait is used to have the same code and behavior between AbstractCacheConstraint and its legacy version.
18		*/
19		trait AbstractCacheConstraintTrait
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	29	}
36
37		/**
38		* {@inheritdoc}
39		*
40		* @param ResponseInterface $other The guzzle response object
41		*/
42	29	public function matches($other)
43		{
44	29	if (!$other instanceof ResponseInterface) {
45		throw new \RuntimeException(sprintf('Expected a GuzzleHttp\Psr7\Response but got %s', get_class($other)));
46		}
47	29	if (!$other->hasHeader($this->header)) {
48	1	$message = sprintf(
49		'Response has no "%s" header. Configure your caching proxy '
50	1	.'to set the header with cache hit/miss status.',
51	1	$this->header
52		);
53	1	if (200 !== $other->getStatusCode()) {
54		$message .= sprintf("\nStatus code of response is %s.", $other->getStatusCode());
55		}
56
57	1	$message .= "\nThe response headers are:\n\n";
58
59		foreach ($other->getHeaders() as $name => $values) {
60	28	foreach ($values as $value) {
61		$message .= $name.': '.$value;
62		}
63		}
64
65		$body = $other->getBody();
66	2	$body->rewind();
67		$message .= sprintf("\nThe response body is:\n\n %s", $body->getContents());
68	2
69	2	throw new \RuntimeException($message);
70	2	}
71	2
72		return false !== strpos((string) $other->getHeaderLine($this->header), $this->getValue());
		0 ignored issues – show Bug introduced 2017-11-06 08:09 UTC by Report Bug Copy Issue Report It seems like `getValue()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
73		}
74
75		/**
76		* {@inheritdoc}
77		*/
78		public function failureDescription($other)
79		{
80		return sprintf(
81		'response (with status code %s) %s',
82		$other->getStatusCode(),
83		$this->toString()
		0 ignored issues – show Bug introduced 2017-08-09 11:03 UTC by Report Bug Copy Issue Report It seems like `toString()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
84		);
85		}
86		}
87

FriendsOfSymfony / FOSHttpCache

Pull Request — master (#424)

AbstractCacheConstraintTrait::failureDescription() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like