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

Completed

Push — master ( f20687...500eb7 )

by ARCANEDEV

created 2019-09-05 09:55 UTC

Metric::cacheFor() 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 Arcanedev\LaravelMetrics\Contracts\Metric as MetricContract;
use Arcanedev\LaravelMetrics\Metrics\Concerns\HasCachedResults;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Str;
use Illuminate\Support\Traits\Macroable;

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

    use Macroable,
        ConvertsToArray,
        HasCachedResults;

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

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

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

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

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

    /**
     * Get the Http request instance.
     *
     * @return \Illuminate\Http\Request
     */
    public function getRequest()
    {
        return $this->request;
    }

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

    {
        $this->request = $request;

        return $this;
    }

    /* -----------------------------------------------------------------
     |  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();
    }

    /**
     * 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(),
        ];
    }

    /**
     * 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();
    }
}


1		<?php namespace Arcanedev\LaravelMetrics\Metrics;
2
3		use Arcanedev\LaravelMetrics\Concerns\ConvertsToArray;
4		use Arcanedev\LaravelMetrics\Contracts\Metric as MetricContract;
5		use Arcanedev\LaravelMetrics\Metrics\Concerns\HasCachedResults;
6		use Illuminate\Database\Eloquent\Builder;
7		use Illuminate\Http\Request;
8		use Illuminate\Support\Str;
9		use Illuminate\Support\Traits\Macroable;
10
11		/**
12		* Class Metric
13		*
14		* @package Arcanedev\LaravelMetrics\Metrics
15		* @author ARCANEDEV <[email protected]>
16		*/
17		abstract class Metric implements MetricContract
18		{
19		/* -----------------------------------------------------------------
20		\| Traits
21		\| -----------------------------------------------------------------
22		*/
23
24		use Macroable,
25		ConvertsToArray,
26		HasCachedResults;
27
28		/* -----------------------------------------------------------------
29		\| Properties
30		\| -----------------------------------------------------------------
31		*/
32
33		/**
34		* The Http request instance.
35		*
36		* @var \Illuminate\Http\Request
37		*/
38		protected $request;
39
40		/* -----------------------------------------------------------------
41		\| Getters & Setters
42		\| -----------------------------------------------------------------
43		*/
44
45		/**
46		* Get the metric's title.
47		*
48		* @return string
49		*/
50	8	public function title(): string
51		{
52	8	$class = class_basename(static::class);
53
54	8	return Str::title(Str::snake($class, ' '));
55		}
56
57		/**
58		* Get the Http request instance.
59		*
60		* @return \Illuminate\Http\Request
61		*/
62	8	public function getRequest()
63		{
64	8	return $this->request;
65		}
66
67		/**
68		* Set the Http request instance.
69		*
70		* @param \Illuminate\Http\Request $request
71		*
72		* @return $this
73		*/
74	100	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...
75		{
76	100	$this->request = $request;
77
78	100	return $this;
79		}
80
81		/* -----------------------------------------------------------------
82		\| Main Methods
83		\| -----------------------------------------------------------------
84		*/
85
86		/**
87		* Resolve & calculate the metric.
88		*
89		* @param \Illuminate\Http\Request $request
90		*
91		* @return \Arcanedev\LaravelMetrics\Results\Result\|mixed
92		*/
93	100	public function resolve(Request $request)
94		{
95	100	$this->setRequest($request);
96
97		$resolver = function () use ($request) {
98	92	return $this->calculate($request);
99	100	};
100
101	100	return ($cacheFor = $this->cacheFor())
102	8	? $this->cacheResult($cacheFor, $resolver)
103	100	: $resolver();
104		}
105
106		/**
107		* Make a new result instance.
108		*
109		* @param mixed\|null $value
110		*
111		* @return \Arcanedev\LaravelMetrics\Results\Result
112		*/
113		abstract protected function result($value = null);
114
115		/* -----------------------------------------------------------------
116		\| Other Methods
117		\| -----------------------------------------------------------------
118		*/
119
120		/**
121		* Get the instance as an array.
122		*
123		* @return array
124		*/
125	8	public function toArray(): array
126		{
127		return [
128	8	'class' => static::class,
129	8	'type' => $this->type(),
130	8	'title' => $this->title(),
131		];
132		}
133
134		/**
135		* Get the query builder.
136		*
137		* @param \Illuminate\Database\Eloquent\Builder\|string $model
138		*
139		* @return \Illuminate\Database\Eloquent\Builder
140		*/
141	92	protected static function getQuery($model): Builder
142		{
143	92	return $model instanceof Builder ? $model : (new $model)->newQuery();
144		}
145		}
146

ARCANEDEV / LaravelMetrics

Push — master ( f20687...500eb7 )

Metric::cacheFor() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like