Arcanedev\LaravelMetrics\Metrics\Trend

Complexity

Total Complexity

57

Size/Duplication

Total Lines	672
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Test Coverage

Coverage

43.71%

Importance

Changes

0

37 Methods

Rating	Name	Duplication	Size	Complexity
A	type()	0	4	1
A	countByMonths()	0	4	1
A	countByWeeks()	0	4	1
A	countByDays()	0	4	1
A	countByHours()	0	4	1
A	countByMinutes()	0	4	1
A	count()	0	4	1
A	averageByMonths()	0	4	1
A	averageByWeeks()	0	4	1
A	averageByDays()	0	4	1
A	averageByHours()	0	4	1
A	averageByMinutes()	0	4	1
A	average()	0	4	1
A	sumByMonths()	0	4	1
A	sumByWeeks()	0	4	1
A	sumByDays()	0	4	1
A	sumByHours()	0	4	1
A	sumByMinutes()	0	4	1
A	sum()	0	4	1
A	maxByMonths()	0	4	1
A	maxByWeeks()	0	4	1
A	maxByDays()	0	4	1
A	maxByHours()	0	4	1
A	maxByMinutes()	0	4	1
A	max()	0	4	1
A	minByMonths()	0	4	1
A	minByWeeks()	0	4	1
A	minByDays()	0	4	1
A	minByHours()	0	4	1
A	minByMinutes()	0	4	1
A	min()	0	4	1
A	result()	0	4	1
A	aggregate()	0	48	3
B	parseDateResult()	0	23	6
B	getAggregateStartingDate()	0	28	6
B	getAllPossibleDateResults()	0	37	9
A	toArray()	0	7	1

<?php namespace Arcanedev\LaravelMetrics\Metrics;

use Arcanedev\LaravelMetrics\Exceptions\InvalidTrendUnitException;
use Arcanedev\LaravelMetrics\Metrics\Concerns\HasExpressions;
use Arcanedev\LaravelMetrics\Results\TrendResult;
use Cake\Chronos\Chronos;
use DateTime;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Facades\DB;

/**
 * Class     Trend
 *
 * @package  Arcanedev\LaravelMetrics\Metrics
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class Trend extends Metric
{
    /* -----------------------------------------------------------------
     |  Constants
     | -----------------------------------------------------------------
     */

    /**
     * Trend metric unit constants.
     */
    const BY_MONTHS  = 'month';
    const BY_WEEKS   = 'week';
    const BY_DAYS    = 'day';
    const BY_HOURS   = 'hour';
    const BY_MINUTES = 'minute';

    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use HasExpressions,
        Concerns\HasRanges,
        Concerns\FormatsTrends;

    /* -----------------------------------------------------------------
     |  Getters
     | -----------------------------------------------------------------
     */

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

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

    /**
     * Return a value result showing a count aggregate over months.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|null                                   $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function countByMonths($model, $column = null)
    {
        return $this->count(self::BY_MONTHS, $model, $column);
    }

    /**
     * Return a value result showing a count aggregate over weeks.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|null                                   $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function countByWeeks($model, $column = null)
    {
        return $this->count(self::BY_WEEKS, $model, $column);
    }

    /**
     * Return a value result showing a count aggregate over days.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|null                                   $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function countByDays($model, $column = null)
    {
        return $this->count(self::BY_DAYS, $model, $column);
    }

    /**
     * Return a value result showing a count aggregate over hours.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|null                                   $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function countByHours($model, $column = null)
    {
        return $this->count(self::BY_HOURS, $model, $column);
    }

    /**
     * Return a value result showing a count aggregate over minutes.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|null                                   $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function countByMinutes($model, $column = null)
    {
        return $this->count(self::BY_MINUTES, $model, $column);
    }

    /**
     * Return a value result showing a count aggregate over time.
     *
     * @param  string                                        $unit
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|null                                   $dateColumn
     * @param  string|null                                   $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function count($unit, $model, $dateColumn = null, $column = null)
    {
        return $this->aggregate('count', $unit, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a average aggregate over months.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function averageByMonths($model, $column, $dateColumn = null)
    {
        return $this->average(self::BY_MONTHS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a average aggregate over weeks.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function averageByWeeks($model, $column, $dateColumn = null)
    {
        return $this->average(self::BY_WEEKS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a average aggregate over days.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function averageByDays($model, $column, $dateColumn = null)
    {
        return $this->average(self::BY_DAYS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a average aggregate over hours.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function averageByHours($model, $column, $dateColumn = null)
    {
        return $this->average(self::BY_HOURS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a average aggregate over minutes.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function averageByMinutes($model, $column, $dateColumn = null)
    {
        return $this->average(self::BY_MINUTES, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a average aggregate over time.
     *
     * @param  string                                        $unit
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function average(string $unit, $model, $column, $dateColumn = null)
    {
        return $this->aggregate('avg', $unit, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a sum aggregate over months.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function sumByMonths($model, $column, $dateColumn = null)
    {
        return $this->sum(self::BY_MONTHS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a sum aggregate over weeks.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string                                        $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function sumByWeeks($model, $column, $dateColumn = null)
    {
        return $this->sum(self::BY_WEEKS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a sum aggregate over days.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function sumByDays($model, $column, $dateColumn = null)
    {
        return $this->sum(self::BY_DAYS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a sum aggregate over hours.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string                                        $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function sumByHours($model, $column, $dateColumn = null)
    {
        return $this->sum(self::BY_HOURS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a sum aggregate over minutes.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function sumByMinutes($model, $column, $dateColumn = null)
    {
        return $this->sum(self::BY_MINUTES, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a sum aggregate over time.
     *
     * @param  string                                        $unit
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function sum(string $unit, $model, $column, $dateColumn = null)
    {
        return $this->aggregate('sum', $unit, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a max aggregate over months.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function maxByMonths($model, $column, $dateColumn = null)
    {
        return $this->max(self::BY_MONTHS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a max aggregate over weeks.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function maxByWeeks($model, $column, $dateColumn = null)
    {
        return $this->max(self::BY_WEEKS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a max aggregate over days.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function maxByDays($model, $column, $dateColumn = null)
    {
        return $this->max(self::BY_DAYS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a max aggregate over hours.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function maxByHours($model, $column, $dateColumn = null)
    {
        return $this->max(self::BY_HOURS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a max aggregate over minutes.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function maxByMinutes($model, $column, $dateColumn = null)
    {
        return $this->max(self::BY_MINUTES, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a max aggregate over time.
     *
     * @param  string                                        $unit
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function max(string $unit, $model, $column, $dateColumn = null)
    {
        return $this->aggregate('max', $unit, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a min aggregate over months.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function minByMonths($model, $column, $dateColumn = null)
    {
        return $this->min(self::BY_MONTHS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a min aggregate over weeks.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function minByWeeks($model, $column, $dateColumn = null)
    {
        return $this->min(self::BY_WEEKS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a min aggregate over days.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function minByDays($model, $column, $dateColumn = null)
    {
        return $this->min(self::BY_DAYS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a min aggregate over hours.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function minByHours($model, $column, $dateColumn = null)
    {
        return $this->min(self::BY_HOURS, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a min aggregate over minutes.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function minByMinutes($model, $column, $dateColumn = null)
    {
        return $this->min(self::BY_MINUTES, $model, $column, $dateColumn);
    }

    /**
     * Return a value result showing a min aggregate over time.
     *
     * @param  string                                        $unit
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    public function min(string $unit, $model, $column, $dateColumn = null)
    {
        return $this->aggregate('min', $unit, $model, $column, $dateColumn);
    }

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

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

    /**
     * Handle the aggregate calculation of the metric.
     *
     * @param  string                                        $method
     * @param  string                                        $unit
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|null                                   $column
     * @param  string|null                                   $dateColumn
     *
     * @return \Arcanedev\LaravelMetrics\Results\TrendResult|mixed
     */
    protected function aggregate(string $method, string $unit, $model, ?string $column = null, ?string $dateColumn = null)
    {
        $range          = (int) $this->request->input('range');
        $timezone       = $this->request->input('timezone');
        $twelveHourTime = $this->request->input('twelveHourTime') === 'true';

        $query      = static::getQuery($model);
        $column     = $column ?? $query->getModel()->getCreatedAtColumn();

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

        $dateColumn = $dateColumn ?? $query->getModel()->getCreatedAtColumn();
        $expression = $this->getExpression($query, 'trend_date_format', $dateColumn, [$unit, $query, $timezone]);

        $possibleDateResults = $this->getAllPossibleDateResults(
            $startingDate = $this->getAggregateStartingDate($unit),
            $endingDate = Chronos::now(),
            $unit,
            $timezone,
            $twelveHourTime
        );

        $wrappedColumn = $query->getQuery()->getGrammar()->wrap($column);

        $results = $query->select([

The method select() does not exist on Illuminate\Database\Eloquent\Builder. Did you maybe mean createSelectWithConstraint()?

                DB::raw("{$expression} as date_result"),
                DB::raw("{$method}({$wrappedColumn}) as aggregate")
            ])
            ->whereBetween($dateColumn, [$startingDate, $endingDate])
            ->groupBy(DB::raw($expression))
            ->orderBy('date_result')
            ->get();

        $results = array_merge($possibleDateResults, $results->mapWithKeys(function ($result) use ($method, $unit, $twelveHourTime) {
            return with(static::parseDateResult($result->getAttribute('date_result'), $unit), function ($date) use ($method, $unit, $twelveHourTime, $result) {
                $value = $result->getAttribute('aggregate');

                return [
                    $this->formatAggregateKey($date, $unit) => [
                        'label' => $this->formatLabelBy($date, $unit, $twelveHourTime),
                        'value' => $method === 'count' ? intval($value) : round($value, 0),
                    ],
                ];
            });
        })->all());

        if (count($results) > $range)
            array_shift($results);

        return $this->result()->trend($results);
    }

    /**
     * Parse the date result.
     *
     * @param  string  $dateResult
     * @param  string  $unit
     *
     * @return \Cake\Chronos\Chronos
     */
    protected function parseDateResult(string $dateResult, string $unit): Chronos
    {
        switch ($unit) {
            case self::BY_MONTHS:
                return Chronos::createFromFormat('Y-m', $dateResult);

            case self::BY_WEEKS:
                [$year, $week] = explode('-', $dateResult);

The variable $year does not exist. Did you forget to declare it?

The variable $week does not exist. Did you forget to declare it?

                return Chronos::instance((new DateTime)->setISODate($year, $week)->setTime(0, 0));

            case self::BY_DAYS:
                return Chronos::createFromFormat('Y-m-d', $dateResult);

            case self::BY_HOURS:
                return Chronos::createFromFormat('Y-m-d H:00', $dateResult);

            case self::BY_MINUTES:
                return Chronos::createFromFormat('Y-m-d H:i:00', $dateResult);

            default:
                throw InvalidTrendUnitException::make($unit);
        }
    }

    /**
     * Determine the proper aggregate starting date.
     *
     * @param  string  $unit
     *
     * @return \Cake\Chronos\Chronos
     */
    protected function getAggregateStartingDate(string $unit): Chronos
    {
        $range = $this->request->input('range', 2);

        switch ($unit) {
            case self::BY_MONTHS:
                return Chronos::now()->subMonths($range - 1)->firstOfMonth()->setTime(0, 0);

            case self::BY_WEEKS:
                return Chronos::now()->subWeeks($range - 1)->startOfWeek()->setTime(0, 0);

            case self::BY_DAYS:
                return Chronos::now()->subDays($range - 1)->setTime(0, 0);

            case self::BY_HOURS:
                return with(Chronos::now()->subHours($range - 1), function (Chronos $now) {
                    return $now->setTimeFromTimeString("{$now->hour}:00");
                });

            case self::BY_MINUTES:
                return with(Chronos::now()->subMinutes($range - 1), function (Chronos $now) {
                    return $now->setTimeFromTimeString("{$now->hour}:{$now->minute}:00");
                });

            default:
                throw InvalidTrendUnitException::make($unit);
        }
    }

    /**
     * Get all of the possible date results for the given units.
     *
     * @param  \Cake\Chronos\Chronos  $startDate
     * @param  \Cake\Chronos\Chronos  $endDate
     * @param  string                 $unit
     * @param  mixed                  $timezone
     * @param  bool                   $twelveHourTime
     *
     * @return array
     */
    protected function getAllPossibleDateResults(
        Chronos $startDate, Chronos $endDate, string $unit, $timezone, bool $twelveHourTime
    ): array
    {
        $nextDate = $startDate;

        if ( ! empty($timezone)) {
            $nextDate = $startDate->setTimezone($timezone);
            $endDate  = $endDate->setTimezone($timezone);
        }

        $possibleDateResults[static::formatAggregateKey($nextDate, $unit)] = [

$possibleDateResults was never initialized. Although not strictly required by PHP, it is generally a good practice to add $possibleDateResults = array(); before regardless.

            'label' => static::formatLabelBy($nextDate, $unit, $twelveHourTime),
            'value' => 0,
        ];

        while ($nextDate->lt($endDate)) {
            if ($unit === self::BY_MONTHS)
                $nextDate = $nextDate->addMonths(1);
            elseif ($unit === self::BY_WEEKS)
                $nextDate = $nextDate->addWeeks(1);
            elseif ($unit === self::BY_DAYS)
                $nextDate = $nextDate->addDays(1);
            elseif ($unit === self::BY_HOURS)
                $nextDate = $nextDate->addHours(1);
            elseif ($unit === self::BY_MINUTES)
                $nextDate = $nextDate->addMinutes(1);

            if ($nextDate->lte($endDate))
                $possibleDateResults[static::formatAggregateKey($nextDate, $unit)] = [
                    'label' => static::formatLabelBy($nextDate, $unit, $twelveHourTime),
                    'value' => 0,
                ];
        }

        return $possibleDateResults;
    }

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