QueryRepository::getVaryUri() - Code Metrics - Inspection of "Refactor, Add HttpCache::transfer() method" - bearsunday/BEAR.QueryRepository - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.x (#55)

by Akihito

created 2018-10-13 01:00 UTC

QueryRepository::getVaryUri() A

↳ Parent: Project

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	10
cts	10
cp	1
rs	9.7333
c	0
b	0
f	0
cc	4
nc	4
nop	1
crap	4

<?php
/**
 * This file is part of the BEAR.QueryRepository package.
 *
 * @license http://opensource.org/licenses/MIT MIT
 */
namespace BEAR\QueryRepository;

use BEAR\QueryRepository\Exception\ExpireAtKeyNotExists;
use BEAR\RepositoryModule\Annotation\Cacheable;
use BEAR\RepositoryModule\Annotation\HttpCache;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use BEAR\RepositoryModule\Annotation\Storage;
use BEAR\Resource\AbstractUri;
use BEAR\Resource\RequestInterface;
use BEAR\Resource\ResourceObject;
use Doctrine\Common\Annotations\Reader;

class QueryRepository implements QueryRepositoryInterface
{
    const ETAG_BY_URI = 'etag-by-uri';

    /**
     * @var ResourceStorageInterface
     */
    private $storage;

    /**
     * @var Reader
     */
    private $reader;

    /**
     * @var Expiry
     */
    private $expiry;

    /**
     * @var EtagSetterInterface
     */
    private $setEtag;

    /**
     * @Storage("kvs")
     */
    public function __construct(
        EtagSetterInterface $setEtag,
        ResourceStorageInterface $storage,
        Reader $reader,
        Expiry $expiry
    ) {
        $this->setEtag = $setEtag;
        $this->reader = $reader;
        $this->storage = $storage;
        $this->expiry = $expiry;
    }

    /**
     * {@inheritdoc}
     *
     * @throws \ReflectionException
     */
    public function put(ResourceObject $ro)
    {
        $ro->toString();
        $httpCache = $this->getHttpCacheAnnotation($ro);
        $cacheable = $this->getCacheableAnnotation($ro);
        /* @var Cacheable $cacheable|null */
        ($this->setEtag)($ro, null, $httpCache);
        if (isset($ro->headers['ETag'])) {
            $this->storage->updateEtag($ro);
        }
        $body = $this->evaluateBody($ro->body);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $lifeTime = $this->getExpiryTime($ro, $cacheable);
        $this->setMaxAge($ro, $lifeTime);
        if ($cacheable instanceof Cacheable && $cacheable->type === 'view') {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            if (! $ro->view) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                // render
                $ro->view = $ro->toString();
            }

            return $this->storage->saveView($ro, $lifeTime);
        }
        // "value" cache type
        return $this->storage->saveValue($ro, $lifeTime);
    }

    /**
     * {@inheritdoc}
     */
    public function get(AbstractUri $uri)
    {
        $data = $this->storage->get($uri);
        if ($data === false) {
            return false;
        }
        $age = \time() - \strtotime($data[2]['Last-Modified']);
        $data[2]['Age'] = $age;

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function purge(AbstractUri $uri)
    {
        $this->storage->deleteEtag($uri);

        return $this->storage->delete($uri);
    }

    /**
     * @throws \ReflectionException
     */
    private function getHttpCacheAnnotation(ResourceObject $ro)
    {
        $annotation = $this->reader->getClassAnnotation(new \ReflectionClass($ro), HttpCache::class);
        if ($annotation instanceof HttpCache || $annotation === null) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $annotation;
        }
        throw new \LogicException();
    }

    /**
     * @throws \ReflectionException
     */
    private function getCacheableAnnotation(ResourceObject $ro)
    {
        $annotation = $this->reader->getClassAnnotation(new \ReflectionClass($ro), Cacheable::class);
        if ($annotation instanceof Cacheable || $annotation === null) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $annotation;
        }
        throw new \LogicException();
    }

    /**
     * @param mixed $body
     *
     * @return mixed
     */
    private function evaluateBody($body)
    {
        if (! \is_array($body)) {
            return $body;
        }
        foreach ($body as &$item) {
            if ($item instanceof RequestInterface) {
                $item = ($item)();
            }
        }

        return $body;
    }

    private function getExpiryTime(ResourceObject $ro, Cacheable $cacheable = null) : int
    {
        if ($cacheable === null) {
            return 0;
        }

        if ($cacheable->expiryAt) {
            return $this->getExpiryAtSec($ro, $cacheable);
        }

        return $cacheable->expirySecond ? $cacheable->expirySecond : $this->expiry[$cacheable->expiry];
    }

    private function getExpiryAtSec(ResourceObject $ro, Cacheable $cacheable) : int
    {
        if (! isset($ro->body[$cacheable->expiryAt])) {
            $msg = \sprintf('%s::%s', \get_class($ro), $cacheable->expiryAt);
            throw new ExpireAtKeyNotExists($msg);
        }
        $expiryAt = $ro->body[$cacheable->expiryAt];

        return \strtotime($expiryAt) - \time();
    }

    private function setMaxAge(ResourceObject $ro, int $age)
    {
        $setMaxAge = \sprintf('max-age=%d', $age);
        if (isset($ro->headers['Cache-Control'])) {
            $ro->headers['Cache-Control'] .= ', ' . $setMaxAge;

            return;
        }
        $ro->headers['Cache-Control'] = $setMaxAge;
    }
}


1		<?php
2		/**
3		* This file is part of the BEAR.QueryRepository package.
4		*
5		* @license http://opensource.org/licenses/MIT MIT
6		*/
7		namespace BEAR\QueryRepository;
8
9		use BEAR\QueryRepository\Exception\ExpireAtKeyNotExists;
10		use BEAR\RepositoryModule\Annotation\Cacheable;
11		use BEAR\RepositoryModule\Annotation\HttpCache;
		0 ignored issues – show Bug introduced 2018-10-11 07:36 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `BEAR\QueryRepository\HttpCache`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
12		use BEAR\RepositoryModule\Annotation\Storage;
13		use BEAR\Resource\AbstractUri;
14		use BEAR\Resource\RequestInterface;
15		use BEAR\Resource\ResourceObject;
16		use Doctrine\Common\Annotations\Reader;
17
18		class QueryRepository implements QueryRepositoryInterface
19		{
20		const ETAG_BY_URI = 'etag-by-uri';
21
22		/**
23		* @var ResourceStorageInterface
24		*/
25		private $storage;
26
27		/**
28		* @var Reader
29		*/
30		private $reader;
31
32		/**
33		* @var Expiry
34		*/
35		private $expiry;
36
37		/**
38		* @var EtagSetterInterface
39		*/
40		private $setEtag;
41
42		/**
43		* @Storage("kvs")
44		*/
45	26	public function __construct(
46		EtagSetterInterface $setEtag,
47		ResourceStorageInterface $storage,
48		Reader $reader,
49		Expiry $expiry
50		) {
51	26	$this->setEtag = $setEtag;
52	26	$this->reader = $reader;
53	26	$this->storage = $storage;
54	26	$this->expiry = $expiry;
55	26	}
56
57		/**
58		* {@inheritdoc}
59		*
60		* @throws \ReflectionException
61		*/
62	24	public function put(ResourceObject $ro)
63		{
64	24	$ro->toString();
65	24	$httpCache = $this->getHttpCacheAnnotation($ro);
66	24	$cacheable = $this->getCacheableAnnotation($ro);
67		/* @var Cacheable $cacheable\|null */
68	24	($this->setEtag)($ro, null, $httpCache);
69	24	if (isset($ro->headers['ETag'])) {
70	24	$this->storage->updateEtag($ro);
71		}
72	24	$body = $this->evaluateBody($ro->body);
		0 ignored issues – show Unused Code introduced 2018-10-12 17:47 UTC by Report Bug Copy Issue Report `$body` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
73	24	$lifeTime = $this->getExpiryTime($ro, $cacheable);
74	23	$this->setMaxAge($ro, $lifeTime);
75	23	if ($cacheable instanceof Cacheable && $cacheable->type === 'view') {
		0 ignored issues – show Bug introduced 2016-08-03 12:44 UTC by Report Bug Copy Issue Report The class `BEAR\RepositoryModule\Annotation\Cacheable` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
76	2	if (! $ro->view) {
		0 ignored issues – show Bug Best Practice introduced 2018-09-30 17:01 UTC by Report Bug Copy Issue Report The expression `$ro->view` of type `string\|null` is loosely compared to `false`; 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...
77		// render
78		$ro->view = $ro->toString();
79		}
80
81	2	return $this->storage->saveView($ro, $lifeTime);
82		}
83		// "value" cache type
84	21	return $this->storage->saveValue($ro, $lifeTime);
85		}
86
87		/**
88		* {@inheritdoc}
89		*/
90	22	public function get(AbstractUri $uri)
91		{
92	22	$data = $this->storage->get($uri);
93	22	if ($data === false) {
94	20	return false;
95		}
96	14	$age = \time() - \strtotime($data[2]['Last-Modified']);
97	14	$data[2]['Age'] = $age;
98
99	14	return $data;
100		}
101
102		/**
103		* {@inheritdoc}
104		*/
105	12	public function purge(AbstractUri $uri)
106		{
107	12	$this->storage->deleteEtag($uri);
108
109	12	return $this->storage->delete($uri);
110		}
111
112		/**
113		* @throws \ReflectionException
114		*/
115	24	private function getHttpCacheAnnotation(ResourceObject $ro)
116		{
117	24	$annotation = $this->reader->getClassAnnotation(new \ReflectionClass($ro), HttpCache::class);
118	24	if ($annotation instanceof HttpCache \|\| $annotation === null) {
		0 ignored issues – show Bug introduced 2018-10-11 07:36 UTC by Report Bug Copy Issue Report The class `BEAR\RepositoryModule\Annotation\HttpCache` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
119	24	return $annotation;
120		}
121		throw new \LogicException();
122		}
123
124		/**
125		* @throws \ReflectionException
126		*/
127	24	private function getCacheableAnnotation(ResourceObject $ro)
128		{
129	24	$annotation = $this->reader->getClassAnnotation(new \ReflectionClass($ro), Cacheable::class);
130	24	if ($annotation instanceof Cacheable \|\| $annotation === null) {
		0 ignored issues – show Bug introduced 2018-10-11 07:36 UTC by Report Bug Copy Issue Report The class `BEAR\RepositoryModule\Annotation\Cacheable` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
131	24	return $annotation;
132		}
133		throw new \LogicException();
134		}
135
136		/**
137		* @param mixed $body
138		*
139		* @return mixed
140		*/
141	24	private function evaluateBody($body)
142		{
143	24	if (! \is_array($body)) {
144	7	return $body;
145		}
146	17	foreach ($body as &$item) {
147	17	if ($item instanceof RequestInterface) {
148	17	$item = ($item)();
149		}
150		}
151
152	17	return $body;
153		}
154
155	25	private function getExpiryTime(ResourceObject $ro, Cacheable $cacheable = null) : int
156		{
157	25	if ($cacheable === null) {
158	4	return 0;
159		}
160
161	21	if ($cacheable->expiryAt) {
162	2	return $this->getExpiryAtSec($ro, $cacheable);
163		}
164
165	19	return $cacheable->expirySecond ? $cacheable->expirySecond : $this->expiry[$cacheable->expiry];
166		}
167
168	2	private function getExpiryAtSec(ResourceObject $ro, Cacheable $cacheable) : int
169		{
170	2	if (! isset($ro->body[$cacheable->expiryAt])) {
171	1	$msg = \sprintf('%s::%s', \get_class($ro), $cacheable->expiryAt);
172	1	throw new ExpireAtKeyNotExists($msg);
173		}
174	1	$expiryAt = $ro->body[$cacheable->expiryAt];
175
176	1	return \strtotime($expiryAt) - \time();
177		}
178
179	23	private function setMaxAge(ResourceObject $ro, int $age)
180		{
181	23	$setMaxAge = \sprintf('max-age=%d', $age);
182	23	if (isset($ro->headers['Cache-Control'])) {
183	6	$ro->headers['Cache-Control'] .= ', ' . $setMaxAge;
184
185	6	return;
186		}
187	20	$ro->headers['Cache-Control'] = $setMaxAge;
188	20	}
189		}
190

bearsunday / BEAR.QueryRepository

Pull Request — 1.x (#55)

QueryRepository::getVaryUri() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like