Arcanedev\LaravelMetrics\Metrics\Concerns\FormatsTrends

Complexity

Total Complexity

24

Size/Duplication

Total Lines	214
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

96.43%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
B	formatAggregateKey()	0	22	6
B	formatLabelBy()	0	22	6
A	formatAggregateKeyByMonths()	0	4	1
A	formatAggregateKeyByWeeks()	0	7	1
A	formatAggregateKeyByDays()	0	4	1
A	formatAggregateKeyByHours()	0	4	1
A	formatAggregateKeyByMinutes()	0	4	1
A	formatLabelByMonths()	0	4	1
A	formatLabelByWeeks()	0	10	1
A	formatLabelByDays()	0	4	1
A	formatLabelByHours()	0	8	2
A	formatLabelByMinutes()	0	8	2

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelMetrics\Metrics\Concerns;

use Arcanedev\LaravelMetrics\Exceptions\InvalidTrendUnitException;
use Cake\Chronos\Chronos;

/**
 * Trait     FormatsTrends
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
trait FormatsTrends
{
    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Format aggregate key.
     *
     * @param  \Cake\Chronos\Chronos  $date
     * @param  string                 $unit
     *
     * @return string
     */
    protected static function formatAggregateKey(Chronos $date, string $unit): string
    {
        switch ($unit) {
            case static::BY_MONTHS:
                return static::formatAggregateKeyByMonths($date);

            case static::BY_WEEKS:
                return static::formatAggregateKeyByWeeks($date);

            case static::BY_DAYS:
                return static::formatAggregateKeyByDays($date);

            case static::BY_HOURS:
                return static::formatAggregateKeyByHours($date);

            case static::BY_MINUTES:
                return static::formatAggregateKeyByMinutes($date);

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

    /**
     * Format the label.
     *
     * @param  \Cake\Chronos\Chronos  $date
     * @param  string                 $unit
     * @param  bool                   $twelveHourTime
     *
     * @return string
     */
    protected static function formatLabelBy(Chronos $date, string $unit, bool $twelveHourTime = false): string
    {
        switch ($unit) {
            case static::BY_MONTHS:
                return static::formatLabelByMonths($date);

            case static::BY_WEEKS:
                return static::formatLabelByWeeks($date);

            case static::BY_DAYS:
                return static::formatLabelByDays($date);

            case static::BY_HOURS:
                return static::formatLabelByHours($date, $twelveHourTime);

            case static::BY_MINUTES:
                return static::formatLabelByMinutes($date, $twelveHourTime);

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

    /* -----------------------------------------------------------------
     |  Formatters
     | -----------------------------------------------------------------
     */

    /**
     * Format the given date by months.
     *
     * @param  \Cake\Chronos\Chronos  $date
     *
     * @return string
     */
    protected static function formatAggregateKeyByMonths(Chronos $date): string
    {
        return $date->format('Y-m');
    }

    /**
     * Format the given date by weeks.
     *
     * @param  \Cake\Chronos\Chronos  $date
     *
     * @return string
     */
    protected static function formatAggregateKeyByWeeks(Chronos $date): string
    {
        return sprintf('%s %s',
            static::formatAggregateKeyByDays($date),
            static::formatAggregateKeyByDays($date->endOfWeek())

$date->endOfWeek() of type object<Cake\Chronos\ChronosInterface> is not a sub-type of object<Cake\Chronos\Chronos>. It seems like you assume a concrete implementation of the interface Cake\Chronos\ChronosInterface to be always present.

        );
    }

    /**
     * Format the given date by days.
     *
     * @param  \Cake\Chronos\Chronos  $date
     *
     * @return string
     */
    protected static function formatAggregateKeyByDays(Chronos $date): string
    {
        return $date->format('Y-m-d');
    }

    /**
     * Format the given date by hours.
     *
     * @param \Cake\Chronos\Chronos  $date
     *
     * @return string
     */
    protected static function formatAggregateKeyByHours(Chronos $date): string
    {
        return $date->format('Y-m-d H:00');
    }

    /**
     * Format the given date by minutes.
     *
     * @param \Cake\Chronos\Chronos $date
     *
     * @return string
     */
    protected static function formatAggregateKeyByMinutes(Chronos $date): string
    {
        return $date->format('Y-m-d H:i');
    }

    /**
     * Get the label by Months.
     *
     * @param  \Cake\Chronos\Chronos  $date
     *
     * @return string
     */
    protected static function formatLabelByMonths(Chronos $date): string
    {
        return __($date->format('F')).' '.$date->format('Y');
    }

    /**
     * Get the label by Weeks.
     *
     * @param  \Cake\Chronos\Chronos  $date
     *
     * @return string
     */
    protected static function formatLabelByWeeks(Chronos $date): string
    {
        return sprintf('%s %s - %s %s',
            __($date->startOfWeek()->format('F')),
            $date->startOfWeek()->format('j'),

            __($date->endOfWeek()->format('F')),
            $date->endOfWeek()->format('j')
        );
    }

    /**
     * Get the label by Days.
     *
     * @param  \Cake\Chronos\Chronos  $date
     *
     * @return string
     */
    protected static function formatLabelByDays(Chronos $date): string
    {
        return __($date->format('F')).' '.$date->format('j, Y');
    }

    /**
     * Get the label by Hours.
     *
     * @param  \Cake\Chronos\Chronos  $date
     * @param  bool                   $twelveHourTime
     *
     * @return string
     */
    protected static function formatLabelByHours(Chronos $date, bool $twelveHourTime = false): string
    {
        return sprintf('%s %s - %s',
            __($date->format('F')),
            $date->format('j'),
            $date->format($twelveHourTime ? 'g:00 A' : 'G:00')
        );
    }

    /**
     * Get the label by Minutes.
     *
     * @param  \Cake\Chronos\Chronos  $date
     * @param  bool                   $twelveHourTime
     *
     * @return string
     */
    protected static function formatLabelByMinutes(Chronos $date, bool $twelveHourTime): string
    {
        return sprintf('%s %s - %s',
            __($date->format('F')),
            $date->format('j'),
            $date->format($twelveHourTime ? 'g:i A' : 'G:i')
        );
    }
}