AbstractService::getCacheKey() - Code Metrics - Inspection of "Merge pull request #4 from ARCANEDEV/patch-2" - ARCANEDEV/Currencies - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 06d9f7...a7a165 )

by ARCANEDEV

created 2016-06-25 03:59 UTC

AbstractService::getCacheKey() A

↳ Parent: AbstractService

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php namespace Arcanedev\Currencies\Services;

use Arcanedev\Currencies\Contracts\Http\Client as ClientContract;
use Arcanedev\Currencies\Contracts\Services\CurrencyService;
use Arcanedev\Currencies\Entities\RateCollection;
use Closure;
use Illuminate\Contracts\Cache\Repository as CacheContract;
use Illuminate\Support\Arr;

/**
 * Class     AbstractService
 *
 * @package  Arcanedev\Currencies\Services
 * @author   ARCANEDEV <[email protected]>
 */
abstract class AbstractService implements CurrencyService
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * The base URL.
     *
     * @var string
     */
    protected $baseUrl = '';

    /**
     * @var \Arcanedev\Currencies\Contracts\Http\Client
     */
    protected $client;

    /**
     * The cache repository.
     *
     * @var \Illuminate\Contracts\Cache\Repository
     */
    protected $cache;

    /**
     * The enabled cache status.
     *
     * @var bool
     */
    protected $cacheEnabled;

    /**
     * The cache key name.
     *
     * @var string
     */
    protected $cacheKey;

    /**
     * The cache duration.
     *
     * @var int
     */
    protected $cacheDuration;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * AbstractService constructor.
     *
     * @param  \Arcanedev\Currencies\Contracts\Http\Client  $client
     * @param  \Illuminate\Contracts\Cache\Repository       $cache
     * @param  array                                        $configs
     */
    public function __construct(ClientContract $client, CacheContract $cache, array $configs = [])
    {
        $this->client = $client;
        $this->cache  = $cache;
        $this->setCacheConfigs($configs);
        $this->setProviderConfigs($configs);

        $this->client->setBaseUrl($this->baseUrl);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the default currency.
     *
     * @return string
     */
    public function getDefaultCurrency()
    {
        return config('currencies.default', 'USD');
    }

    /**
     * Get the supported currencies.
     *
     * @return array
     */
    public function getSupportedCurrencies()
    {
        return config('currencies.supported', []);
    }

    /**
     * Get the `from` currency.
     *
     * @param  string  $from
     *
     * @return string
     */
    protected function getFromCurrency($from)
    {
        if (is_null($from)) {
            $from = $this->getDefaultCurrency();
        }

        return $from;
    }

    /**
     * Get the `to` currencies.
     *
     * @param  array|string|null  $to
     *
     * @return array
     */
    protected function getToCurrencies($to)
    {
        if (is_null($to)) {
            return array_diff(
                $this->getSupportedCurrencies(),
                [$this->getDefaultCurrency()]
            );
        }

        return $to;
    }

    /**
     * Set the cache configs.
     *
     * @param  array  $configs
     */
    protected function setCacheConfigs(array $configs)
    {
        $this->cacheEnabled  = Arr::get($configs, 'cache.enabled', false);
        $this->cacheKey      = Arr::get($configs, 'cache.key', 'currencies.rates');
        $this->cacheDuration = Arr::get($configs, 'cache.duration', 0);
    }

    /**
     * Set the configs.
     *
     * @param  array  $configs
     */
    abstract protected function setProviderConfigs(array $configs);

    /**
     * Get cache key.
     *
     * @return string
     */
    protected function getCacheKey()
    {
        return $this->cacheKey;
    }

    /**
     * Check if cache is enabled.
     *
     * @return bool
     */
    public function isCacheEnabled()
    {
        return (bool) $this->cacheEnabled;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get currencies rates.
     *
     * @param  string|null        $from
     * @param  array|string|null  $to
     *
     * @return \Arcanedev\Currencies\Entities\RateCollection
     */
    public function rates($from = null, $to = null)
    {
        $from = $this->getFromCurrency($from);
        $to   = $this->getToCurrencies($to);

        $self     = $this;
        $callback = function () use ($self, $from, $to) {
            return $self->request($from, $to);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        };

        $rates = $this->isCacheEnabled()
            ? $this->cacheResults($callback)
            : call_user_func($callback);

        return $this->prepareRates($from, $rates);
    }

    /**
     * Make an API request.
     *
     * @param  string  $from
     * @param  array   $to
     *
     * @return \Arcanedev\Currencies\Entities\RateCollection
     */
    abstract protected function request($from, array $to);

    /**
     * Cache results.
     *
     * @param  Closure  $callback
     *
     * @return array
     */
    private function cacheResults(Closure $callback)
    {
        return $this->cache->remember(
            $this->getCacheKey(),
            $this->cacheDuration,
            $callback
        );
    }

    /**
     * Prepare rates collection.
     *
     * @param  string  $from
     * @param  array   $rates
     *
     * @return \Arcanedev\Currencies\Entities\RateCollection
     */
    protected function prepareRates($from, array $rates)
    {
        return RateCollection::make()->load($from, $rates);
    }
}


1		<?php namespace Arcanedev\Currencies\Services;
2
3		use Arcanedev\Currencies\Contracts\Http\Client as ClientContract;
4		use Arcanedev\Currencies\Contracts\Services\CurrencyService;
5		use Arcanedev\Currencies\Entities\RateCollection;
6		use Closure;
7		use Illuminate\Contracts\Cache\Repository as CacheContract;
8		use Illuminate\Support\Arr;
9
10		/**
11		* Class AbstractService
12		*
13		* @package Arcanedev\Currencies\Services
14		* @author ARCANEDEV <[email protected]>
15		*/
16		abstract class AbstractService implements CurrencyService
17		{
18		/* ------------------------------------------------------------------------------------------------
19		\| Properties
20		\| ------------------------------------------------------------------------------------------------
21		*/
22		/**
23		* The base URL.
24		*
25		* @var string
26		*/
27		protected $baseUrl = '';
28
29		/**
30		* @var \Arcanedev\Currencies\Contracts\Http\Client
31		*/
32		protected $client;
33
34		/**
35		* The cache repository.
36		*
37		* @var \Illuminate\Contracts\Cache\Repository
38		*/
39		protected $cache;
40
41		/**
42		* The enabled cache status.
43		*
44		* @var bool
45		*/
46		protected $cacheEnabled;
47
48		/**
49		* The cache key name.
50		*
51		* @var string
52		*/
53		protected $cacheKey;
54
55		/**
56		* The cache duration.
57		*
58		* @var int
59		*/
60		protected $cacheDuration;
61
62		/* ------------------------------------------------------------------------------------------------
63		\| Constructor
64		\| ------------------------------------------------------------------------------------------------
65		*/
66		/**
67		* AbstractService constructor.
68		*
69		* @param \Arcanedev\Currencies\Contracts\Http\Client $client
70		* @param \Illuminate\Contracts\Cache\Repository $cache
71		* @param array $configs
72		*/
73	24	public function __construct(ClientContract $client, CacheContract $cache, array $configs = [])
74		{
75	24	$this->client = $client;
76	24	$this->cache = $cache;
77	24	$this->setCacheConfigs($configs);
78	24	$this->setProviderConfigs($configs);
79
80	24	$this->client->setBaseUrl($this->baseUrl);
81	24	}
82
83		/* ------------------------------------------------------------------------------------------------
84		\| Getters & Setters
85		\| ------------------------------------------------------------------------------------------------
86		*/
87		/**
88		* Get the default currency.
89		*
90		* @return string
91		*/
92	12	public function getDefaultCurrency()
93		{
94	12	return config('currencies.default', 'USD');
95		}
96
97		/**
98		* Get the supported currencies.
99		*
100		* @return array
101		*/
102	12	public function getSupportedCurrencies()
103		{
104	12	return config('currencies.supported', []);
105		}
106
107		/**
108		* Get the `from` currency.
109		*
110		* @param string $from
111		*
112		* @return string
113		*/
114	12	protected function getFromCurrency($from)
115		{
116	12	if (is_null($from)) {
117	12	$from = $this->getDefaultCurrency();
118	9	}
119
120	12	return $from;
121		}
122
123		/**
124		* Get the `to` currencies.
125		*
126		* @param array\|string\|null $to
127		*
128		* @return array
129		*/
130	12	protected function getToCurrencies($to)
131		{
132	12	if (is_null($to)) {
133	12	return array_diff(
134	12	$this->getSupportedCurrencies(),
135	12	[$this->getDefaultCurrency()]
136	9	);
137		}
138
139		return $to;
140		}
141
142		/**
143		* Set the cache configs.
144		*
145		* @param array $configs
146		*/
147	24	protected function setCacheConfigs(array $configs)
148		{
149	24	$this->cacheEnabled = Arr::get($configs, 'cache.enabled', false);
150	24	$this->cacheKey = Arr::get($configs, 'cache.key', 'currencies.rates');
151	24	$this->cacheDuration = Arr::get($configs, 'cache.duration', 0);
152	24	}
153
154		/**
155		* Set the configs.
156		*
157		* @param array $configs
158		*/
159		abstract protected function setProviderConfigs(array $configs);
160
161		/**
162		* Get cache key.
163		*
164		* @return string
165		*/
166		protected function getCacheKey()
167		{
168		return $this->cacheKey;
169		}
170
171		/**
172		* Check if cache is enabled.
173		*
174		* @return bool
175		*/
176	12	public function isCacheEnabled()
177		{
178	12	return (bool) $this->cacheEnabled;
179		}
180
181		/* ------------------------------------------------------------------------------------------------
182		\| Main Functions
183		\| ------------------------------------------------------------------------------------------------
184		*/
185		/**
186		* Get currencies rates.
187		*
188		* @param string\|null $from
189		* @param array\|string\|null $to
190		*
191		* @return \Arcanedev\Currencies\Entities\RateCollection
192		*/
193	12	public function rates($from = null, $to = null)
194		{
195	12	$from = $this->getFromCurrency($from);
196	12	$to = $this->getToCurrencies($to);
197
198	12	$self = $this;
199	12	$callback = function () use ($self, $from, $to) {
200	12	return $self->request($from, $to);
		0 ignored issues – show Bug introduced 2016-06-25 03:44 UTC by Report Bug Copy Issue Report It seems like `$to` defined by `$this->getToCurrencies($to)` on line `196` can also be of type `string`; however, `Arcanedev\Currencies\Ser...tractService::request()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
201	12	};
202
203	12	$rates = $this->isCacheEnabled()
204	9	? $this->cacheResults($callback)
205	12	: call_user_func($callback);
206
207	12	return $this->prepareRates($from, $rates);
208		}
209
210		/**
211		* Make an API request.
212		*
213		* @param string $from
214		* @param array $to
215		*
216		* @return \Arcanedev\Currencies\Entities\RateCollection
217		*/
218		abstract protected function request($from, array $to);
219
220		/**
221		* Cache results.
222		*
223		* @param Closure $callback
224		*
225		* @return array
226		*/
227		private function cacheResults(Closure $callback)
228		{
229		return $this->cache->remember(
230		$this->getCacheKey(),
231		$this->cacheDuration,
232		$callback
233		);
234		}
235
236		/**
237		* Prepare rates collection.
238		*
239		* @param string $from
240		* @param array $rates
241		*
242		* @return \Arcanedev\Currencies\Entities\RateCollection
243		*/
244	12	protected function prepareRates($from, array $rates)
245		{
246	12	return RateCollection::make()->load($from, $rates);
247		}
248		}
249

ARCANEDEV / Currencies

Push — master ( 06d9f7...a7a165 )

AbstractService::getCacheKey() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like