Metric::getCachePrefix() - Code Metrics - Inspection of "WIP (Part 8)" - ARCANEDEV/LaravelMetrics - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1842cb...2414f9 )

by ARCANEDEV

created 2019-05-13 23:35 UTC

Metric::getCachePrefix() A

↳ Parent: Metric

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php namespace Arcanedev\LaravelMetrics\Metrics;

use Arcanedev\LaravelMetrics\Concerns\ConvertsToArray;
use Closure;
use DateInterval;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Str;
use JsonSerializable;

/**
 * Class     Metric
 *
 * @package  Arcanedev\LaravelMetrics\Metrics
 * @author   ARCANEDEV <[email protected]>
 */
abstract class Metric implements Arrayable, Jsonable, JsonSerializable, Responsable
{
    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use ConvertsToArray;

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The Http request instance.
     *
     * @var \Illuminate\Http\Request
     */
    protected $request;

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the metric's type.
     *
     * @return string
     */
    abstract public function type(): string;

    /**
     * Get the metric's title.
     *
     * @return string
     */
    public function title(): string
    {
        $class = class_basename(static::class);

        return Str::title(Str::snake($class, ' '));
    }

    /**
     * Set the Http request.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return $this
     */
    public function setRequest(Request $request)

    {
        $this->request = $request;

        return $this;
    }

    /**
     * Determine for how many minutes the metric should be cached.
     *
     * @return \DateTimeInterface|\DateInterval|float|int|void
     */
    public function cacheFor()
    {
        //
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Resolve & calculate the metric.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Arcanedev\LaravelMetrics\Results\Result|mixed
     */
    public function resolve(Request $request)
    {
        $this->setRequest($request);

        $resolver = function () use ($request) {
            return $this->calculate($request);
        };

        return ($cacheFor = $this->cacheFor())
            ? $this->cacheResult($cacheFor, $resolver)
            : $resolver();
    }

    /**
     * Calculate the metric.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Arcanedev\LaravelMetrics\Results\Result|mixed
     */
    abstract public function calculate(Request $request);

    /**
     * Make a new result instance.
     *
     * @param  mixed|null  $value
     *
     * @return \Arcanedev\LaravelMetrics\Results\Result
     */
    abstract protected function result($value = null);

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'class' => static::class,
            'type'  => $this->type(),
            'title' => $this->title(),
        ];
    }

    /**
     * Create an HTTP response that represents the object.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\Http\Response
     */
    public function toResponse($request)
    {
        return response()->json(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $this->resolve($request)->toArray()
        );
    }

    /**
     * Get the query builder.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    protected static function getQuery($model): Builder
    {
        return $model instanceof Builder ? $model : (new $model)->newQuery();
    }

    /**
     * Cache the result.
     *
     * @param  mixed     $cacheFor
     * @param  \Closure  $callback
     *
     * @return mixed
     */
    protected function cacheResult($cacheFor, Closure $callback)
    {
        if (is_numeric($cacheFor))
            $cacheFor = new DateInterval(sprintf('PT%dS', $cacheFor * 60));

        $key = sprintf(
            '%s.%s.%s.%s.%s',
            Str::slug($this->getCachePrefix(), '.'),
            Str::slug(str_replace('\\', '_', static::class)),
            $this->request->input('range', 'no-range'),
            $this->request->input('timezone', 'no-timezone'),
            $this->request->input('twelveHourTime', '24-hour-time')
        );

        return Cache::remember($key, $cacheFor, $callback);
    }

    /**
     * Get the cache's prefix.
     *
     * @return string
     */
    protected function getCachePrefix(): string
    {
        return config('metrics.cache.prefix', 'arcanedev.metrics');
    }
}


1		<?php namespace Arcanedev\LaravelMetrics\Metrics;
2
3		use Arcanedev\LaravelMetrics\Concerns\ConvertsToArray;
4		use Closure;
5		use DateInterval;
6		use Illuminate\Contracts\Support\Arrayable;
7		use Illuminate\Contracts\Support\Jsonable;
8		use Illuminate\Contracts\Support\Responsable;
9		use Illuminate\Database\Eloquent\Builder;
10		use Illuminate\Http\Request;
11		use Illuminate\Support\Facades\Cache;
12		use Illuminate\Support\Str;
13		use JsonSerializable;
14
15		/**
16		* Class Metric
17		*
18		* @package Arcanedev\LaravelMetrics\Metrics
19		* @author ARCANEDEV <[email protected]>
20		*/
21		abstract class Metric implements Arrayable, Jsonable, JsonSerializable, Responsable
22		{
23		/* -----------------------------------------------------------------
24		\| Traits
25		\| -----------------------------------------------------------------
26		*/
27
28		use ConvertsToArray;
29
30		/* -----------------------------------------------------------------
31		\| Properties
32		\| -----------------------------------------------------------------
33		*/
34
35		/**
36		* The Http request instance.
37		*
38		* @var \Illuminate\Http\Request
39		*/
40		protected $request;
41
42		/* -----------------------------------------------------------------
43		\| Getters & Setters
44		\| -----------------------------------------------------------------
45		*/
46
47		/**
48		* Get the metric's type.
49		*
50		* @return string
51		*/
52		abstract public function type(): string;
53
54		/**
55		* Get the metric's title.
56		*
57		* @return string
58		*/
59	8	public function title(): string
60		{
61	8	$class = class_basename(static::class);
62
63	8	return Str::title(Str::snake($class, ' '));
64		}
65
66		/**
67		* Set the Http request.
68		*
69		* @param \Illuminate\Http\Request $request
70		*
71		* @return $this
72		*/
73	92	public function setRequest(Request $request)
		1 ignored issue – show Bug introduced 2019-05-09 20:33 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
74		{
75	92	$this->request = $request;
76
77	92	return $this;
78		}
79
80		/**
81		* Determine for how many minutes the metric should be cached.
82		*
83		* @return \DateTimeInterface\|\DateInterval\|float\|int\|void
84		*/
85	84	public function cacheFor()
86		{
87		//
88	84	}
89
90		/* -----------------------------------------------------------------
91		\| Main Methods
92		\| -----------------------------------------------------------------
93		*/
94
95		/**
96		* Resolve & calculate the metric.
97		*
98		* @param \Illuminate\Http\Request $request
99		*
100		* @return \Arcanedev\LaravelMetrics\Results\Result\|mixed
101		*/
102	92	public function resolve(Request $request)
103		{
104	92	$this->setRequest($request);
105
106		$resolver = function () use ($request) {
107	84	return $this->calculate($request);
108	92	};
109
110	92	return ($cacheFor = $this->cacheFor())
111	8	? $this->cacheResult($cacheFor, $resolver)
112	92	: $resolver();
113		}
114
115		/**
116		* Calculate the metric.
117		*
118		* @param \Illuminate\Http\Request $request
119		*
120		* @return \Arcanedev\LaravelMetrics\Results\Result\|mixed
121		*/
122		abstract public function calculate(Request $request);
123
124		/**
125		* Make a new result instance.
126		*
127		* @param mixed\|null $value
128		*
129		* @return \Arcanedev\LaravelMetrics\Results\Result
130		*/
131		abstract protected function result($value = null);
132
133		/* -----------------------------------------------------------------
134		\| Other Methods
135		\| -----------------------------------------------------------------
136		*/
137
138		/**
139		* Get the instance as an array.
140		*
141		* @return array
142		*/
143	8	public function toArray(): array
144		{
145		return [
146	8	'class' => static::class,
147	8	'type' => $this->type(),
148	8	'title' => $this->title(),
149		];
150		}
151
152		/**
153		* Create an HTTP response that represents the object.
154		*
155		* @param \Illuminate\Http\Request $request
156		*
157		* @return \Illuminate\Http\Response
158		*/
159		public function toResponse($request)
160		{
161		return response()->json(
		0 ignored issues – show Bug introduced 2019-05-13 23:38 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
162		$this->resolve($request)->toArray()
163		);
164		}
165
166		/**
167		* Get the query builder.
168		*
169		* @param \Illuminate\Database\Eloquent\Builder\|string $model
170		*
171		* @return \Illuminate\Database\Eloquent\Builder
172		*/
173	84	protected static function getQuery($model): Builder
174		{
175	84	return $model instanceof Builder ? $model : (new $model)->newQuery();
176		}
177
178		/**
179		* Cache the result.
180		*
181		* @param mixed $cacheFor
182		* @param \Closure $callback
183		*
184		* @return mixed
185		*/
186	8	protected function cacheResult($cacheFor, Closure $callback)
187		{
188	8	if (is_numeric($cacheFor))
189	4	$cacheFor = new DateInterval(sprintf('PT%dS', $cacheFor * 60));
190
191	8	$key = sprintf(
192	8	'%s.%s.%s.%s.%s',
193	8	Str::slug($this->getCachePrefix(), '.'),
194	8	Str::slug(str_replace('\\', '_', static::class)),
195	8	$this->request->input('range', 'no-range'),
196	8	$this->request->input('timezone', 'no-timezone'),
197	8	$this->request->input('twelveHourTime', '24-hour-time')
198		);
199
200	8	return Cache::remember($key, $cacheFor, $callback);
201		}
202
203		/**
204		* Get the cache's prefix.
205		*
206		* @return string
207		*/
208	8	protected function getCachePrefix(): string
209		{
210	8	return config('metrics.cache.prefix', 'arcanedev.metrics');
211		}
212		}
213

ARCANEDEV / LaravelMetrics

Push — master ( 1842cb...2414f9 )

Metric::getCachePrefix() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like