TestCacheDecorator::hasBeenRetrieved() - Code Metrics - Inspection of "New method names" - CMProductions/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2f12c3...e53ef5 )

by Hilari

created 2016-07-18 18:43 UTC

TestCacheDecorator::hasBeenRetrieved() A

↳ Parent: TestCacheDecorator

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

namespace Cmp\Cache\Application;

/**
 * Class TestCacheDecorator
 *
 * A backend especially designed for testing
 *
 * @package Cmp\Cache\Infrastureture
 */
class TestCacheDecorator extends CacheDecorator
{
    /**
     * Calls made to the cache
     *
     * @var array
     */
    private $calls = [
        'delete' => [],
        'set'    => [],
        'has'    => [],
        'get'    => [],
        'demand' => [],
        'flush'  => false,
    ];

    /**
     * Checks if an item has been set
     *
     * @param string   $key
     * @param mixed    $value
     * @param int|null $timeToLive
     *
     * @return bool
     */
    public function hasBeenSet($key, $value = null, $timeToLive = null)
    {
        foreach ($this->calls['set'] as $set) {
            if ($this->callMatches($set, $key, $value, $timeToLive)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Checks if an item has been checked with the 'has' method
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasBeenChecked($key)
    {
        return $this->hasBeenDoneByKey($this->calls['has'], $key);
    }

    /**
     * Checks if an item has been requested with 'get'
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasBeenGet($key)
    {
        return $this->hasBeenDoneByKey($this->calls['get'], $key);
    }

    /**
     * Checks if an item has been requested with 'demand'
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasBeenDemanded($key)
    {
        return $this->hasBeenDoneByKey($this->calls['demand'], $key);
    }

    /**
     * Checks if an item has been deleted
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasBeenDeleted($key)
    {
        return $this->hasBeenDoneByKey($this->calls['delete'], $key);
    }

    /**
     * Checks if the cache has been flushed
     *
     * @return bool
     */
    public function hasBeenFlushed()
    {
        return $this->calls['flush'];
    }

    /**
     * @return array
     */
    public function getCalls()
    {
        return $this->calls;
    }

    /**
     * {@inheritdoc}
     */
    public function set($key, $value, $timeToLive = 0)
    {
        $this->calls['set'][] = [
            'key'        => $key,
            'value'      => $value,
            'timeToLive' => $timeToLive,
        ];

        parent::set($key, $value, $timeToLive);
    }

    /**
     * {@inheritdoc}
     */
    public function has($key)
    {
        $this->calls['has'][] = $key;

        return parent::has($key);
    }

    /**
     * {@inheritdoc}
     */
    public function get($key, $default = null)
    {
        $this->calls['get'][] = $key;

        return parent::get($key, $default);
    }

    /**
     * {@inheritdoc}
     */
    public function demand($key)
    {
        $this->calls['demand'][] = $key;

        return parent::demand($key);
    }

    /**
     * {@inheritdoc}
     */
    public function delete($key)
    {
        $this->calls['delete'][] = $key;

        parent::delete($key);
    }

    /**
     * {@inheritdoc}
     */
    public function flush()
    {
        $this->calls['flush'] = true;

        parent::flush();
    }

    /**
     * Tries to match a call by the key
     *
     * @param array  $calls
     * @param string $key
     *
     * @return bool
     */
    private function hasBeenDoneByKey(array $calls, $key)
    {
        foreach ($calls as $keyOnCall) {
            if ($keyOnCall == $key) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param array    $set
     * @param string   $key
     * @param mixed    $value
     * @param null|int $timeToLive
     *
     * @return bool
     */
    private function callMatches(array $set, $key, $value = null, $timeToLive)
    {
        if (
            $set['key'] != $key || 
            !$this->matches($set['value'], $value) || 
            !$this->matches($set['timeToLive'], $timeToLive)

        ) {
            return false;
        }

        return true;
    }

    /**
     * @param mixed $stored
     * @param null  $expected
     *
     * @return bool
     */
    private function matches($stored, $expected = null)
    {
        return $expected === null || $stored == $expected;
    }
}


1			<?php
2
3			namespace Cmp\Cache\Application;
4
5			/**
6			* Class TestCacheDecorator
7			*
8			* A backend especially designed for testing
9			*
10			* @package Cmp\Cache\Infrastureture
11			*/
12			class TestCacheDecorator extends CacheDecorator
13			{
14			/**
15			* Calls made to the cache
16			*
17			* @var array
18			*/
19			private $calls = [
20			'delete' => [],
21			'set' => [],
22			'has' => [],
23			'get' => [],
24			'demand' => [],
25			'flush' => false,
26			];
27
28			/**
29			* Checks if an item has been set
30			*
31			* @param string $key
32			* @param mixed $value
33			* @param int\|null $timeToLive
34			*
35			* @return bool
36			*/
37			public function hasBeenSet($key, $value = null, $timeToLive = null)
38			{
39			foreach ($this->calls['set'] as $set) {
40			if ($this->callMatches($set, $key, $value, $timeToLive)) {
41			return true;
42			}
43			}
44
45			return false;
46			}
47
48			/**
49			* Checks if an item has been checked with the 'has' method
50			*
51			* @param string $key
52			*
53			* @return bool
54			*/
55			public function hasBeenChecked($key)
56			{
57			return $this->hasBeenDoneByKey($this->calls['has'], $key);
58			}
59
60			/**
61			* Checks if an item has been requested with 'get'
62			*
63			* @param string $key
64			*
65			* @return bool
66			*/
67			public function hasBeenGet($key)
68			{
69			return $this->hasBeenDoneByKey($this->calls['get'], $key);
70			}
71
72			/**
73			* Checks if an item has been requested with 'demand'
74			*
75			* @param string $key
76			*
77			* @return bool
78			*/
79			public function hasBeenDemanded($key)
80			{
81			return $this->hasBeenDoneByKey($this->calls['demand'], $key);
82			}
83
84			/**
85			* Checks if an item has been deleted
86			*
87			* @param string $key
88			*
89			* @return bool
90			*/
91			public function hasBeenDeleted($key)
92			{
93			return $this->hasBeenDoneByKey($this->calls['delete'], $key);
94			}
95
96			/**
97			* Checks if the cache has been flushed
98			*
99			* @return bool
100			*/
101			public function hasBeenFlushed()
102			{
103			return $this->calls['flush'];
104			}
105
106			/**
107			* @return array
108			*/
109			public function getCalls()
110			{
111			return $this->calls;
112			}
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function set($key, $value, $timeToLive = 0)
118			{
119			$this->calls['set'][] = [
120			'key' => $key,
121			'value' => $value,
122			'timeToLive' => $timeToLive,
123			];
124
125			parent::set($key, $value, $timeToLive);
126			}
127
128			/**
129			* {@inheritdoc}
130			*/
131			public function has($key)
132			{
133			$this->calls['has'][] = $key;
134
135			return parent::has($key);
136			}
137
138			/**
139			* {@inheritdoc}
140			*/
141			public function get($key, $default = null)
142			{
143			$this->calls['get'][] = $key;
144
145			return parent::get($key, $default);
146			}
147
148			/**
149			* {@inheritdoc}
150			*/
151			public function demand($key)
152			{
153			$this->calls['demand'][] = $key;
154
155			return parent::demand($key);
156			}
157
158			/**
159			* {@inheritdoc}
160			*/
161			public function delete($key)
162			{
163			$this->calls['delete'][] = $key;
164
165			parent::delete($key);
166			}
167
168			/**
169			* {@inheritdoc}
170			*/
171			public function flush()
172			{
173			$this->calls['flush'] = true;
174
175			parent::flush();
176			}
177
178			/**
179			* Tries to match a call by the key
180			*
181			* @param array $calls
182			* @param string $key
183			*
184			* @return bool
185			*/
186			private function hasBeenDoneByKey(array $calls, $key)
187			{
188			foreach ($calls as $keyOnCall) {
189			if ($keyOnCall == $key) {
190			return true;
191			}
192			}
193
194			return false;
195			}
196
197			/**
198			* @param array $set
199			* @param string $key
200			* @param mixed $value
201			* @param null\|int $timeToLive
202			*
203			* @return bool
204			*/
205			private function callMatches(array $set, $key, $value = null, $timeToLive)
206			{
207			if (
208			$set['key'] != $key \|\|
209			!$this->matches($set['value'], $value) \|\|
210			!$this->matches($set['timeToLive'], $timeToLive)
			0 ignored issues – show Bug introduced 2016-07-18 18:45 UTC by Report Bug Copy Issue Report It seems like `$timeToLive` defined by parameter `$timeToLive` on line 205 can also be of type `integer`; however, `Cmp\Cache\Application\Te...cheDecorator::matches()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
211			) {
212			return false;
213			}
214
215			return true;
216			}
217
218			/**
219			* @param mixed $stored
220			* @param null $expected
221			*
222			* @return bool
223			*/
224			private function matches($stored, $expected = null)
225			{
226			return $expected === null \|\| $stored == $expected;
227			}
228			}
229

CMProductions / cache

GitHub Access Token became invalid

Push — master ( 2f12c3...e53ef5 )

TestCacheDecorator::hasBeenRetrieved() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like