AlecRabbit\Tools\Reports\Formatters\TimerReportFormatter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Test Coverage

Coverage

93.33%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	formatElapsed()	0	8	2
A	simple()	0	7	2
A	full()	0	21	2
A	refineElapsed()	0	3	1
A	process()	0	9	4
A	refineSeconds()	0	4	2
A	refineName()	0	6	2

<?php declare(strict_types=1);

namespace AlecRabbit\Tools\Reports\Formatters;

use AlecRabbit\Accessories\Pretty;
use AlecRabbit\Tools\Reports\Contracts\ReportInterface;
use AlecRabbit\Tools\Reports\TimerReport;
use Carbon\CarbonInterval;
use function AlecRabbit\typeOf;
use const AlecRabbit\Traits\Constants\DEFAULT_NAME;

class TimerReportFormatter extends ReportFormatter
{
    protected const MILLISECONDS_THRESHOLD = 10000;

    /** {@inheritdoc} */
    public function process(ReportInterface $report): string
    {
        if ($report instanceof TimerReport) {
            if (0 === $report->getCount() && DEFAULT_NAME === $report->getName()) {
                return $this->simple($report);
            }
            return $this->full($report);
        }
        $this->wrongReportType(TimerReport::class, $report);

In this branch, the function will implicitly return null which is incompatible with the type-hinted return string. Consider adding a return statement or allowing null as return value.

    }

    /**
     * @param TimerReport $report
     * @param bool $eol
     * @return string
     */
    protected function simple(TimerReport $report, bool $eol = true): string
    {
        return
            sprintf(
                self::ELAPSED . ': %s %s',
                $this->refineElapsed($report->getElapsed()),
                $eol ? PHP_EOL : ''
            );
    }

    /**
     * @param \DateInterval $elapsed
     * @return string
     */
    protected function refineElapsed(\DateInterval $elapsed): string
    {
        return static::formatElapsed($elapsed);
    }

    public static function formatElapsed(\DateInterval $elapsed): string
    {
        $c = CarbonInterval::instance($elapsed);
        if ($c->totalMilliseconds < self::MILLISECONDS_THRESHOLD) {
            return
                Pretty::milliseconds($c->totalMilliseconds);
        }
        return (string)$c;
    }

    /**
     * @param TimerReport $report
     * @param bool $eol
     * @return string
     */
    protected function full(TimerReport $report, bool $eol = true): string
    {
        $r = $report;
        return sprintf(
            self::TIMER . '%s: ' .
            self::AVERAGE . ': %s, ' .
            self::LAST . ': %s, ' .
            self::MIN . '(%s): %s, ' .
            self::MAX . '(%s): %s, ' .
            self::COUNT . ': %s, ' .
            self::ELAPSED . ': %s%s',
            $this->refineName($r->getName()),
            $this->refineSeconds($r->getAverageValue()),
            $this->refineSeconds($r->getLastValue()),
            $r->getMinValueIteration(),
            $this->refineSeconds($r->getMinValue()),
            $r->getMaxValueIteration(),
            $this->refineSeconds($r->getMaxValue()),
            $r->getCount(),
            $this->refineElapsed($r->getElapsed()),
            $eol ? PHP_EOL : ''
        );
    }

    protected function refineName(string $name): string
    {
        if (DEFAULT_NAME === $name) {
            return '';
        }
        return '[' . $name . ']';
    }

    protected function refineSeconds(?float $seconds): string
    {
        return
            $seconds ? Pretty::seconds($seconds) : 'NULL';
    }
}