AlecRabbit\Tools\Reports\BenchmarkReport

Complexity

Total Complexity

13

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	computeRelatives()	0	20	3
A	computeAverages()	0	10	3
A	getFunctionObject()	0	3	1
A	__construct()	0	5	1
A	percent()	0	4	1
A	__toString()	0	26	4

<?php
/**
 * User: alec
 * Date: 29.11.18
 * Time: 20:56
 */

namespace AlecRabbit\Tools\Reports;

use AlecRabbit\Tools\Benchmark;
use AlecRabbit\Tools\Internal\BenchmarkedFunction;
use AlecRabbit\Tools\Reports\Base\Report;
use AlecRabbit\Tools\Timer;
use AlecRabbit\Tools\Traits\BenchmarkFields;
use function AlecRabbit\brackets;
use function AlecRabbit\format_time;
use function AlecRabbit\typeOf;
use const AlecRabbit\Constants\Accessories\DEFAULT_NAME;

The constant AlecRabbit\Constants\Accessories\DEFAULT_NAME was not found. Maybe you did not declare it correctly or list all dependencies?

use const AlecRabbit\Constants\BRACKETS_PARENTHESES;

The constant AlecRabbit\Constants\BRACKETS_PARENTHESES was not found. Maybe you did not declare it correctly or list all dependencies?

class BenchmarkReport extends Report
{
    use BenchmarkFields;

    /**
     * BenchmarkReport constructor.
     * @param Benchmark $reportable
     */
    public function __construct(Benchmark $reportable)
    {
        $this->profiler = $reportable->getProfiler();
        $this->functions = $reportable->getFunctions();
        $this->iteration = $reportable->getIteration();
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        $r = (string)$this->getProfiler()->report();
        $r .= 'Benchmark:' . PHP_EOL;
        foreach ($this->computeRelatives() as $indexName => $result) {
            $function = $this->getFunctionObject($indexName);
            $arguments = $function->getArgs();
            $types = [];
            if (!empty($arguments)) {
                foreach ($arguments as $argument) {
                    $types[] = typeOf($argument);
                }
            }
            $r .= sprintf(
                '+%s [%s] %s(%s) %s %s %s',
                $result,
                $function->getIndex(),
                $function->getName(),
                implode(', ', $types),
                $function->getComment(),
                $this->getIteration(),
                PHP_EOL
            );
        }
        return
            $r;
    }

    /**
     * @return array
     */
    private function computeRelatives(): array
    {
        $averages = $this->computeAverages(
            $this->profiler->getTimers()
        );

        $min = min($averages);

        $relatives = [];
        foreach ($averages as $name => $average) {
            $relatives[$name] = $average / $min;
        }
        asort($relatives);

        foreach ($relatives as $name => $relative) {
            $relatives[$name] =
                $this->percent((float)$relative - 1) . ' ' .
                brackets(format_time($averages[$name]), BRACKETS_PARENTHESES);
        }
        return $relatives;
    }

    /**
     * @param array $timers
     * @return array
     */
    private function computeAverages(array $timers): array
    {
        $averages = [];
        /** @var Timer $timer */
        foreach ($timers as $timer) {
            if (DEFAULT_NAME !== $name = $timer->getName()) {
                $averages[$name] = $timer->getAverageValue();
            }
        }
        return $averages;
    }

    /**
     * @param float $relative
     * @return string
     */
    private function percent(float $relative): string
    {
        return
            number_format($relative * 100, 1) . '%';
    }

    /**
     * @param string $name
     * @return BenchmarkedFunction
     */
    private function getFunctionObject(string $name): BenchmarkedFunction
    {
        return $this->functions[$name];
    }
}