Arcanedev\LaravelMetrics\Metrics\Metric

Complexity

Total Complexity

12

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

94.44%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
	type()	0	1	?
A	title()	0	6	1
A	setRequest()	0	6	1
A	cacheFor()	0	4	1
A	resolve()	0	12	2
	calculate()	0	1	?
	result()	0	1	?
A	toArray()	0	8	1
A	toResponse()	0	4	1
A	getQuery()	0	4	2
A	cacheResult()	0	16	2
A	getCachePrefix()	0	4	1

<?php namespace Arcanedev\LaravelMetrics\Metrics;

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

/**
 * Class     Metric
 *
 * @package  Arcanedev\LaravelMetrics\Metrics
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
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)

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().

    {
        $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\JsonResponse
     */
    public function toResponse($request)
    {
        return new JsonResponse($this->toArray());

The return type of return new \Illuminate\Http\JsonResponse($this->toArray()); (Illuminate\Http\JsonResponse) is incompatible with the return type declared by the interface Illuminate\Contracts\Support\Responsable::toResponse of type Illuminate\Http\Response.

    }

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