RedisCache::__construct() - Code Metrics - Inspection of "Test coverage increased" - soupmix/cache-redis - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 842a53...3f8831 )

by Mehmet

created 2017-10-31 12:41 UTC

RedisCache::__construct() A

↳ Parent: RedisCache

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3.072

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
ccs	4
cts	5
cp	0.8
rs	9.4285
cc	3
eloc	4
nc	2
nop	1
crap	3.072

<?php

namespace Soupmix\Cache;

use Soupmix\Cache\Exceptions\InvalidArgumentException;
use Psr\SimpleCache\CacheInterface;
use Redis;
use DateInterval;
use DateTime;

class RedisCache implements CacheInterface
{
    const PSR16_RESERVED_CHARACTERS = ['{','}','(',')','/','@',':'];

    private $handler;


    /**
     * Connect to Redis service
     *
     * @param Redis $handler Configuration values that has dbIndex name and host's IP address
     *
     */
    public function __construct(Redis $handler)
    {
        if (defined('Redis::SERIALIZER_IGBINARY') && extension_loaded('igbinary')) {
            $handler->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_IGBINARY);
        }
        $this->handler = $handler;
    }

    public function getConnection()
    {
        return $this->handler;
    }

    /**
     * {@inheritDoc}
     */
    public function get($key, $default = null)
    {
        $value = $this->handler->get($key);
        return $value ? $value : $default;
    }

    /**
     * {@inheritDoc}
     */
    public function set($key, $value, $ttl = null)
    {
        $this->checkKeysValidity($key);
        if ($ttl instanceof DateInterval) {
            $ttl = (new DateTime('now'))->add($ttl)->getTimeStamp() - time();
        }
        $setTtl = (int) $ttl;
        if ($setTtl === 0) {
            return $this->handler->set($key, $value);
        }
        return $this->handler->setex($key, $ttl, $value);
    }

    /**
     * {@inheritDoc}
     */
    public function delete($key)
    {
        return (bool) $this->handler->delete($key);
    }
    /**
     * {@inheritDoc}
     */
    public function clear()
    {
        return $this->handler->flushDB();
    }
    /**
     * {@inheritDoc}
     */
    public function getMultiple($keys, $default = null)
    {
        $defaults = array_fill(0, count($keys), $default);
        foreach ($keys as $key) {
            $this->checkKeysValidity($key);
        }
        return array_merge(array_combine($keys, $this->handler->mget($keys)), $defaults);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
    /**
     * {@inheritDoc}
     */
    public function setMultiple($values, $ttl = null)
    {
        foreach ($values as $key => $value) {
            $this->checkKeysValidity($key);
        }
        if ($ttl instanceof DateInterval) {
            $ttl = (new DateTime('now'))->add($ttl)->getTimeStamp() - time();
        }
        $setTtl = (int) $ttl;
        if ($setTtl === 0) {
            return $this->handler->mset($values);
        }
        $return = true;
        foreach ($values as $key => $value) {
            $return = $return && $this->set($key, $value, $setTtl);

        }
        return $return;
    }
    /**
     * {@inheritDoc}
     */
    public function deleteMultiple($keys)
    {
        foreach ($keys as $key) {
            $this->checkKeysValidity($key);
        }
        $return =[];
        foreach ($keys as $key) {
            $return[$key] = (bool) $this->delete($key);
        }
        return $return;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
    /**
     * Increment a value atomically in the cache by its step value, which defaults to 1
     *
     * @param string  $key  The cache item key
     * @param integer $step The value to increment by, defaulting to 1
     *
     * @return int|bool The new value on success and false on failure
     */
    public function increment($key, $step = 1)
    {
        return $this->handler->incr($key, $step);
    }
    /**
     * Decrement a value atomically in the cache by its step value, which defaults to 1
     *
     * @param string  $key  The cache item key
     * @param integer $step The value to decrement by, defaulting to 1
     *
     * @return int|bool The new value on success and false on failure
     */
    public function decrement($key, $step = 1)
    {
        return $this->handler->decr($key, $step);
    }




    /**
     * {@inheritDoc}
     */
    public function has($key)
    {
        $this->checkKeysValidity($key);
        return $this->handler->exists($key);
    }

    private function checkKeysValidity($key)
    {
        if (!is_string($key)) {
            $message = sprintf('Key %s is not a string.', $key);
            throw new InvalidArgumentException($message);
        }
        foreach (self::PSR16_RESERVED_CHARACTERS as $needle) {
            if (strpos($key, $needle) !== false) {
                $message = sprintf('Key %s has not a legal value.', $key);
                throw new InvalidArgumentException($message);
            }
        }
    }
}


1		<?php
2
3		namespace Soupmix\Cache;
4
5		use Soupmix\Cache\Exceptions\InvalidArgumentException;
6		use Psr\SimpleCache\CacheInterface;
7		use Redis;
8		use DateInterval;
9		use DateTime;
10
11		class RedisCache implements CacheInterface
12		{
13		const PSR16_RESERVED_CHARACTERS = ['{','}','(',')','/','@',':'];
14
15		private $handler;
16
17
18		/**
19		* Connect to Redis service
20		*
21		* @param Redis $handler Configuration values that has dbIndex name and host's IP address
22		*
23		*/
24	8	public function __construct(Redis $handler)
25		{
26	8	if (defined('Redis::SERIALIZER_IGBINARY') && extension_loaded('igbinary')) {
27		$handler->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_IGBINARY);
28		}
29	8	$this->handler = $handler;
30	8	}
31
32	1	public function getConnection()
33		{
34	1	return $this->handler;
35		}
36
37		/**
38		* {@inheritDoc}
39		*/
40	1	public function get($key, $default = null)
41		{
42	1	$value = $this->handler->get($key);
43	1	return $value ? $value : $default;
44		}
45
46		/**
47		* {@inheritDoc}
48		*/
49	5	public function set($key, $value, $ttl = null)
50		{
51	5	$this->checkKeysValidity($key);
52	3	if ($ttl instanceof DateInterval) {
53	1	$ttl = (new DateTime('now'))->add($ttl)->getTimeStamp() - time();
54		}
55	3	$setTtl = (int) $ttl;
56	3	if ($setTtl === 0) {
57	1	return $this->handler->set($key, $value);
58		}
59	2	return $this->handler->setex($key, $ttl, $value);
60		}
61
62		/**
63		* {@inheritDoc}
64		*/
65	2	public function delete($key)
66		{
67	2	return (bool) $this->handler->delete($key);
68		}
69		/**
70		* {@inheritDoc}
71		*/
72	8	public function clear()
73		{
74	8	return $this->handler->flushDB();
75		}
76		/**
77		* {@inheritDoc}
78		*/
79	1	public function getMultiple($keys, $default = null)
80		{
81	1	$defaults = array_fill(0, count($keys), $default);
82	1	foreach ($keys as $key) {
83	1	$this->checkKeysValidity($key);
84		}
85	1	return array_merge(array_combine($keys, $this->handler->mget($keys)), $defaults);
		0 ignored issues – show Bug Best Practice introduced 2017-01-06 19:55 UTC by Report Bug Copy Issue Report The return type of `return array_merge(array...et($keys)), $defaults);` (`array`) is incompatible with the return type declared by the interface `Psr\SimpleCache\CacheInterface::getMultiple` of type `Psr\SimpleCache\iterable`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
86		}
87		/**
88		* {@inheritDoc}
89		*/
90	1	public function setMultiple($values, $ttl = null)
91		{
92	1	foreach ($values as $key => $value) {
93	1	$this->checkKeysValidity($key);
94		}
95	1	if ($ttl instanceof DateInterval) {
96	1	$ttl = (new DateTime('now'))->add($ttl)->getTimeStamp() - time();
97		}
98	1	$setTtl = (int) $ttl;
99	1	if ($setTtl === 0) {
100	1	return $this->handler->mset($values);
101		}
102	1	$return = true;
103	1	foreach ($values as $key => $value) {
104	1	$return = $return && $this->set($key, $value, $setTtl);
105
106		}
107	1	return $return;
108		}
109		/**
110		* {@inheritDoc}
111		*/
112	1	public function deleteMultiple($keys)
113		{
114	1	foreach ($keys as $key) {
115	1	$this->checkKeysValidity($key);
116		}
117	1	$return =[];
118	1	foreach ($keys as $key) {
119	1	$return[$key] = (bool) $this->delete($key);
120		}
121	1	return $return;
		0 ignored issues – show Bug Best Practice introduced 2017-01-03 20:09 UTC by Report Bug Copy Issue Report The return type of `return $return;` (`array`) is incompatible with the return type declared by the interface `Psr\SimpleCache\CacheInterface::deleteMultiple` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
122		}
123		/**
124		* Increment a value atomically in the cache by its step value, which defaults to 1
125		*
126		* @param string $key The cache item key
127		* @param integer $step The value to increment by, defaulting to 1
128		*
129		* @return int\|bool The new value on success and false on failure
130		*/
131	1	public function increment($key, $step = 1)
132		{
133	1	return $this->handler->incr($key, $step);
134		}
135		/**
136		* Decrement a value atomically in the cache by its step value, which defaults to 1
137		*
138		* @param string $key The cache item key
139		* @param integer $step The value to decrement by, defaulting to 1
140		*
141		* @return int\|bool The new value on success and false on failure
142		*/
143	1	public function decrement($key, $step = 1)
144		{
145	1	return $this->handler->decr($key, $step);
146		}
147
148
149
150
151		/**
152		* {@inheritDoc}
153		*/
154	1	public function has($key)
155		{
156	1	$this->checkKeysValidity($key);
157	1	return $this->handler->exists($key);
158		}
159
160	5	private function checkKeysValidity($key)
161		{
162	5	if (!is_string($key)) {
163	1	$message = sprintf('Key %s is not a string.', $key);
164	1	throw new InvalidArgumentException($message);
165		}
166	4	foreach (self::PSR16_RESERVED_CHARACTERS as $needle) {
167	4	if (strpos($key, $needle) !== false) {
168	1	$message = sprintf('Key %s has not a legal value.', $key);
169	1	throw new InvalidArgumentException($message);
170		}
171		}
172	3	}
173		}
174

soupmix / cache-redis

Push — master ( 842a53...3f8831 )

RedisCache::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like