Arcanedev\LaravelMetrics\Metrics\RangedValue

Complexity

Total Complexity

11

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	type()	0	4	1
A	count()	0	4	1
A	average()	0	4	1
A	sum()	0	4	1
A	max()	0	4	1
A	min()	0	4	1
A	aggregate()	0	14	3
A	toArray()	0	7	1
A	result()	0	4	1

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelMetrics\Metrics;

use Arcanedev\LaravelMetrics\Metrics\Concerns\{HasRanges, HasRoundedValue};
use Arcanedev\LaravelMetrics\Results\RangedValueResult;

/**
 * Class     RangedValue
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class RangedValue extends Metric
{
    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use HasRanges,
        HasRoundedValue;

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

    /**
     * Get the metric type.
     *
     * @return string
     */
    public function type(): string
    {
        return 'ranged-value';
    }

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

    /**
     * Calculate the `count` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Model|string  $model
     * @param  string|null                                 $column
     * @param  string|null                                 $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\RangedValueResult|mixed
     */
    protected function count($model, $column = null, $dateColumn = null)
    {
        return $this->aggregate('count', $model, $column, $dateColumn);
    }

    /**
     * Calculate the `average` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\RangedValueResult|mixed
     */
    public function average($model, $column, $dateColumn = null)
    {
        return $this->aggregate('avg', $model, $column, $dateColumn);
    }

    /**
     * Calculate the `sum` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\RangedValueResult|mixed
     */
    public function sum($model, $column, $dateColumn = null)
    {
        return $this->aggregate('sum', $model, $column, $dateColumn);
    }

    /**
     * Calculate the `max` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\RangedValueResult|mixed
     */
    public function max($model, $column, $dateColumn = null)
    {
        return $this->aggregate('max', $model, $column, $dateColumn);
    }

    /**
     * Calculate the `min` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\RangedValueResult|mixed
     */
    public function min($model, $column, $dateColumn = null)
    {
        return $this->aggregate('min', $model, $column, $dateColumn);
    }

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

    /**
     * Handle the aggregate calculation of the metric.
     *
     * @param  string                                      $method
     * @param  \Illuminate\Database\Eloquent\Model|string  $model
     * @param  string|null                                 $column
     * @param  string|null                                 $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\RangedValueResult|mixed
     */
    private function aggregate(string $method, $model, $column = null, $dateColumn = null)
    {
        $query      = static::getQuery($model);
        $column     = $column ?? $query->getModel()->getQualifiedKeyName();

The method getQualifiedKeyName does only exist in Illuminate\Database\Eloquent\Model, but not in Illuminate\Database\Eloquent\Builder.

        $dateColumn = $dateColumn ?? $query->getModel()->getCreatedAtColumn();

The method getCreatedAtColumn does only exist in Illuminate\Database\Eloquent\Model, but not in Illuminate\Database\Eloquent\Builder.

        $range      = (int) $this->request->input('range', 1);
        $timezone   = $this->getCurrentTimezone($this->request);

        $current  = with(clone $query)->whereBetween($dateColumn, $this->currentRange($range, $timezone))->{$method}($column);
        $previous = with(clone $query)->whereBetween($dateColumn, $this->previousRange($range, $timezone))->{$method}($column);

        return $this->result($method === 'count' ? $current : $this->roundValue($current))
                    ->previous($method === 'count' ? $previous : $this->roundValue($previous));
    }

    /**
     * Prepare the metric for JSON serialization.
     *
     * @return array
     */
    public function toArray(): array
    {
        return array_merge(
            parent::toArray(),
            ['ranges' => $this->rangesToArray()]
        );
    }

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