AbstractEnhancedProvider::checkQueueNamespace() - Code Metrics - Inspection of "merge 2.0 into master" - comodojo/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b9da65...b16e40 )

by Marco

created 2017-01-30 00:20 UTC

AbstractEnhancedProvider::checkQueueNamespace() A

↳ Parent: AbstractEnhancedProvider

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	9

Duplication

Lines	14
Ratio	100 %

Code Coverage

Tests	7
CRAP Score	3.0175

Importance

Changes

Metric	Value
dl	14
loc	14
ccs	7
cts	8
cp	0.875
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	3
nop	1
crap	3.0175

<?php namespace Comodojo\Cache\Providers;

use \Comodojo\Cache\Traits\StatefulTrait;
use \Comodojo\Cache\Traits\NamespaceTrait;
use \Comodojo\Cache\Interfaces\EnhancedCacheItemPoolInterface;
use \Comodojo\Cache\Components\UniqueId;
use \Psr\Log\LoggerInterface;
use \Comodojo\Cache\Item;
use \Comodojo\Cache\Components\KeyValidator;
use \Psr\Cache\CacheItemInterface;
use \DateTime;
use \Comodojo\Exception\CacheException;
use \Comodojo\Exception\InvalidCacheArgumentException;
use \Exception;

/**
 * Abstract stateful provider implementation
 *
 * @package     Comodojo Spare Parts
 * @author      Marco Giovinazzi <[email protected]>
 * @license     MIT
 *
 * LICENSE:
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

abstract class AbstractEnhancedProvider
    extends AbstractProvider

    implements EnhancedCacheItemPoolInterface {


    use StatefulTrait;
    use NamespaceTrait;

    protected $driver;

    private $queue = [];

    public function __construct(LoggerInterface $logger = null) {

        parent::__construct($logger);

        $this->setId(UniqueId::get())->test();

    }

    abstract public function getStats();

    public function getItem($key) {

        if ( KeyValidator::validateKey($key) === false ) {
            throw new InvalidCacheArgumentException('Invalid key provided');
        }

        try {

            $data = $this->driver->get($key, $this->getNamespace());

        } catch (Exception $e) {

            $this->setState(self::CACHE_ERROR, $e->getMessage());
            $data = null;

        }

        if ( $data === null ) return new Item($key);

        $item = new Item($key, true);

        return $item->set(unserialize($data));

    }

    public function hasItem($key) {


        if ( KeyValidator::validateKey($key) === false ) {
            throw new InvalidCacheArgumentException('Invalid key provided');
        }

        try {

            $data = $this->driver->has($key, $this->getNamespace());

        } catch (Exception $e) {

            $this->setState(self::CACHE_ERROR, $e->getMessage());
            $data = false;

        }

        return $data;

    }

    public function clear() {

        try {

            $data = $this->driver->clear();

        } catch (Exception $e) {

            $this->setState(self::CACHE_ERROR, $e->getMessage());
            $data = false;

        }

        return $data;

    }

    public function clearNamespace() {


        try {

            $data = $this->driver->clear($this->getNamespace());

        } catch (Exception $e) {

            $this->setState(self::CACHE_ERROR, $e->getMessage());
            $data = false;

        }

        return $data;

    }

    public function deleteItem($key) {


        if ( KeyValidator::validateKey($key) === false ) {
            throw new InvalidCacheArgumentException('Invalid key provided');
        }

        try {

            $data = $this->driver->delete($key, $this->getNamespace());

        } catch (Exception $e) {

            $this->setState(self::CACHE_ERROR, $e->getMessage());
            $data = false;

        }

        return $data;

    }

    public function save(CacheItemInterface $item) {

        $ttl = $item->getTtl();

        if ( $ttl < 0 ) return false;

        try {

            $data = $this->driver->set($item->getKey(), $this->getNamespace(), serialize($item->getRaw()), $ttl);

        } catch (Exception $e) {

            $this->setState(self::CACHE_ERROR, $e->getMessage());
            $data = false;

        }

        return $data;

    }

    public function test() {


        if ( $this->driver->test() ) {

            $this->setState(self::CACHE_SUCCESS);

            return true;

        }

        $error = $this->driver->getName()." driver unavailable, disabling provider ".$this->getId()." administratively";

        $this->logger->error($error);

        $this->setState(self::CACHE_ERROR, $error);

        return false;

    }

    public function getItems(array $keys = []) {

        if ( empty($keys) ) return [];

        $result = [];

        try {

            $data = $this->driver->getMultiple($keys, $this->getNamespace());

        } catch (Exception $e) {

            $this->setState(self::CACHE_ERROR, $e->getMessage());
            $data = array_combine($keys, array_fill(0, count($keys), null));

        }

        foreach ( $data as $key => $value ) {

            if ( $value == null ) {
                $result[$key] = new Item($key);
            } else {
                $result[$key] = new Item($key, true);
                $result[$key]->set(unserialize($value));
            }

        }

        return $result;

    }

    public function deleteItems(array $keys) {


        try {

            $data = $this->driver->deleteMultiple($keys, $this->getNamespace());

        } catch (Exception $e) {

            $this->setState(self::CACHE_ERROR, $e->getMessage());
            $data = false;

        }

        return $data;

    }

    public function saveDeferred(CacheItemInterface $item) {


        $this->checkQueueNamespace(true);

        $namespace = $this->getNamespace();

        $this->queue[$namespace][$item->getKey()] = $item;

        return true;

    }

    public function commit() {


        $result = [];

        $active_namespace = $this->getNamespace();

        foreach ( $this->queue as $namespace => $queue ) {

            $this->setNamespace($namespace);

            foreach ( $queue as $key => $item ) {

                $result[] = $this->save($item);

            }

        }

        $this->queue = [];

        $this->setNamespace($active_namespace);

        return in_array(false, $result) ? false : true;

    }

    private function checkQueueNamespace($create = false) {


        $namespace = $this->getNamespace();

        if ( array_key_exists($namespace, $this->queue) ) {
            return true;
        } else if ( $create ) {
            $this->queue[$namespace] = [];
            return true;
        } else {
            return false;
        }

    }

}


1			<?php namespace Comodojo\Cache\Providers;
2
3			use \Comodojo\Cache\Traits\StatefulTrait;
4			use \Comodojo\Cache\Traits\NamespaceTrait;
5			use \Comodojo\Cache\Interfaces\EnhancedCacheItemPoolInterface;
6			use \Comodojo\Cache\Components\UniqueId;
7			use \Psr\Log\LoggerInterface;
8			use \Comodojo\Cache\Item;
9			use \Comodojo\Cache\Components\KeyValidator;
10			use \Psr\Cache\CacheItemInterface;
11			use \DateTime;
12			use \Comodojo\Exception\CacheException;
13			use \Comodojo\Exception\InvalidCacheArgumentException;
14			use \Exception;
15
16			/**
17			* Abstract stateful provider implementation
18			*
19			* @package Comodojo Spare Parts
20			* @author Marco Giovinazzi <[email protected]>
21			* @license MIT
22			*
23			* LICENSE:
24			*
25			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
31			* THE SOFTWARE.
32			*/
33
34			abstract class AbstractEnhancedProvider
35			extends AbstractProvider
			0 ignored issues – show Coding Style introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report The extends keyword must be on the same line as the class name Loading history... Coding Style introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report Expected 0 spaces between "AbstractProvider" and comma; 1 found Loading history...
36			implements EnhancedCacheItemPoolInterface {
			0 ignored issues – show Coding Style introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report The implements keyword must be on the same line as the class name Loading history...
37
38			use StatefulTrait;
39			use NamespaceTrait;
40
41			protected $driver;
42
43			private $queue = [];
44
45	206		public function __construct(LoggerInterface $logger = null) {
46
47	206		parent::__construct($logger);
48
49	206		$this->setId(UniqueId::get())->test();
50
51	206		}
52
53			abstract public function getStats();
54
55	172		public function getItem($key) {
56
57	172		if ( KeyValidator::validateKey($key) === false ) {
58			throw new InvalidCacheArgumentException('Invalid key provided');
59			}
60
61			try {
62
63	172		$data = $this->driver->get($key, $this->getNamespace());
64
65	172		} catch (Exception $e) {
66
67			$this->setState(self::CACHE_ERROR, $e->getMessage());
68			$data = null;
69
70			}
71
72	172		if ( $data === null ) return new Item($key);
73
74	93		$item = new Item($key, true);
75
76	93		return $item->set(unserialize($data));
77
78			}
79
80	39	View Code Duplication	public function hasItem($key) {
			0 ignored issues – show Duplication introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
81
82	39		if ( KeyValidator::validateKey($key) === false ) {
83			throw new InvalidCacheArgumentException('Invalid key provided');
84			}
85
86			try {
87
88	39		$data = $this->driver->has($key, $this->getNamespace());
89
90	39		} catch (Exception $e) {
91
92			$this->setState(self::CACHE_ERROR, $e->getMessage());
93			$data = false;
94
95			}
96
97	39		return $data;
98
99			}
100
101	56		public function clear() {
102
103			try {
104
105	56		$data = $this->driver->clear();
106
107	56		} catch (Exception $e) {
108
109			$this->setState(self::CACHE_ERROR, $e->getMessage());
110			$data = false;
111
112			}
113
114	56		return $data;
115
116			}
117
118	7	View Code Duplication	public function clearNamespace() {
			0 ignored issues – show Duplication introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
119
120			try {
121
122	7		$data = $this->driver->clear($this->getNamespace());
123
124	7		} catch (Exception $e) {
125
126			$this->setState(self::CACHE_ERROR, $e->getMessage());
127			$data = false;
128
129			}
130
131	7		return $data;
132
133			}
134
135	10	View Code Duplication	public function deleteItem($key) {
			0 ignored issues – show Duplication introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
136
137	10		if ( KeyValidator::validateKey($key) === false ) {
138			throw new InvalidCacheArgumentException('Invalid key provided');
139			}
140
141			try {
142
143	10		$data = $this->driver->delete($key, $this->getNamespace());
144
145	10		} catch (Exception $e) {
146
147			$this->setState(self::CACHE_ERROR, $e->getMessage());
148			$data = false;
149
150			}
151
152	10		return $data;
153
154			}
155
156	166		public function save(CacheItemInterface $item) {
157
158	166		$ttl = $item->getTtl();
159
160	166		if ( $ttl < 0 ) return false;
161
162			try {
163
164	117		$data = $this->driver->set($item->getKey(), $this->getNamespace(), serialize($item->getRaw()), $ttl);
165
166	117		} catch (Exception $e) {
167
168			$this->setState(self::CACHE_ERROR, $e->getMessage());
169			$data = false;
170
171			}
172
173	117		return $data;
174
175			}
176
177	206	View Code Duplication	public function test() {
			0 ignored issues – show Duplication introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
178
179	206		if ( $this->driver->test() ) {
180
181	206		$this->setState(self::CACHE_SUCCESS);
182
183	206		return true;
184
185			}
186
187			$error = $this->driver->getName()." driver unavailable, disabling provider ".$this->getId()." administratively";
188
189			$this->logger->error($error);
190
191			$this->setState(self::CACHE_ERROR, $error);
192
193			return false;
194
195			}
196
197	12		public function getItems(array $keys = []) {
198
199	12		if ( empty($keys) ) return [];
200
201	6		$result = [];
202
203			try {
204
205	6		$data = $this->driver->getMultiple($keys, $this->getNamespace());
206
207	6		} catch (Exception $e) {
208
209			$this->setState(self::CACHE_ERROR, $e->getMessage());
210			$data = array_combine($keys, array_fill(0, count($keys), null));
211
212			}
213
214	6		foreach ( $data as $key => $value ) {
215
216	6		if ( $value == null ) {
217			$result[$key] = new Item($key);
218			} else {
219	6		$result[$key] = new Item($key, true);
220	6		$result[$key]->set(unserialize($value));
221			}
222
223	6		}
224
225	6		return $result;
226
227			}
228
229	12	View Code Duplication	public function deleteItems(array $keys) {
			0 ignored issues – show Duplication introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
230
231			try {
232
233	12		$data = $this->driver->deleteMultiple($keys, $this->getNamespace());
234
235	12		} catch (Exception $e) {
236
237			$this->setState(self::CACHE_ERROR, $e->getMessage());
238			$data = false;
239
240			}
241
242	12		return $data;
243
244			}
245
246	12	View Code Duplication	public function saveDeferred(CacheItemInterface $item) {
			0 ignored issues – show Duplication introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
247
248	12		$this->checkQueueNamespace(true);
249
250	12		$namespace = $this->getNamespace();
251
252	12		$this->queue[$namespace][$item->getKey()] = $item;
253
254	12		return true;
255
256			}
257
258	12	View Code Duplication	public function commit() {
			0 ignored issues – show Duplication introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
259
260	12		$result = [];
261
262	12		$active_namespace = $this->getNamespace();
263
264	12		foreach ( $this->queue as $namespace => $queue ) {
265
266	12		$this->setNamespace($namespace);
267
268	12		foreach ( $queue as $key => $item ) {
269
270	12		$result[] = $this->save($item);
271
272	12		}
273
274	12		}
275
276	12		$this->queue = [];
277
278	12		$this->setNamespace($active_namespace);
279
280	12		return in_array(false, $result) ? false : true;
281
282			}
283
284	12	View Code Duplication	private function checkQueueNamespace($create = false) {
			0 ignored issues – show Duplication introduced 2017-01-24 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
285
286	12		$namespace = $this->getNamespace();
287
288	12		if ( array_key_exists($namespace, $this->queue) ) {
289	6		return true;
290	12		} else if ( $create ) {
291	12		$this->queue[$namespace] = [];
292	12		return true;
293			} else {
294			return false;
295			}
296
297			}
298
299			}
300

comodojo / cache

Push — master ( b9da65...b16e40 )

AbstractEnhancedProvider::checkQueueNamespace() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like