PierInfor\Undercover\Reporter

Complexity

Total Complexity

17

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getThresholds()	0	5	2
A	report()	0	8	2
A	__construct()	0	2	1
A	getResults()	0	5	2
A	getThreshold()	0	7	3
A	getMsgLine()	0	9	2
A	getHeader()	0	3	1
A	getReport()	0	7	1
A	getBody()	0	12	2
A	getFooter()	0	5	1

<?php

declare(strict_types=1);

namespace PierInfor\Undercover;

use PierInfor\Undercover\Interfaces\IReporter;

/**
 * Reporter is a coverage reporter
 *
 * @author Pierre Fromager <info@pier_infor.fr>
 * @version 1.0
 * @package PierInfor\Undercover
 */
class Reporter implements IReporter
{

    protected $results;
    protected $thresholds;
    protected $error;

    /**
     * constructor
     */
    public function __construct()
    {
    }

    /**
     * display report
     *
     * @param array $results
     * @param array $thresholds
     * @return void
     */
    public function report(array $results, array $thresholds): IReporter
    {
        $this->results = $results;
        $this->thresholds = $thresholds;
        if (!empty($this->getResults())) {
            echo $this->getReport();
        }
        return $this;
    }

    /**
     * return results
     *
     * @return array
     */
    protected function getResults(): array
    {
        return is_null($this->results)
            ? []
            : $this->results;
    }

    /**
     * return thresholds
     *
     * @return array
     */
    protected function getThresholds(): array
    {
        return is_null($this->thresholds)
            ? []
            : $this->thresholds;
    }

    /**
     * return threshold as float for a given a key
     *
     * @return float
     */
    protected function getThreshold(string $key): float
    {
        $tresholds = $this->getThresholds();
        if (empty($tresholds) || !isset($tresholds[$key])) {
            return (float) 0;
        }
        return $tresholds[$key];
    }

    /**
     * return report
     *
     * @return string
     */
    protected function getReport(): string
    {
        return sprintf(
            IReporter::REPORT_FORMAT,
            $this->getHeader(),
            $this->getBody(),
            $this->getFooter()
        );
        ;
    }

    /**
     * return header
     *
     * @return string
     */
    protected function getHeader(): string
    {
        return IReporter::HEADER;
    }

    /**
     * return body
     *
     * @return string
     */
    protected function getBody(): string
    {
        $body = '';
        foreach ($this->getResults() as $key => $value) {
            $threshold = $this->getThresholds()[$key];
            $body .= $this->getMsgLine(
                $key,
                $value,
                ($value >= $threshold)
            );
        }
        return $body;
    }

    /**
     * return footer
     *
     * @return string
     */
    protected function getFooter(): string
    {
        return IReporter::T_BEFORE
            . str_repeat('-', \strlen(IReporter::TITLE))
            . IReporter::T_AFTER;
    }

    /**
     * return formated msg line
     *
     * @param string $key
     * @param float $value
     * @return string
     */
    protected function getMsgLine(string $key, float $value, bool $valid): string
    {
        return sprintf(
            IReporter::MSG_FORMAT,
            ucfirst($key),
            $value,
            IReporter::_LIMIT,
            $this->getThreshold($key),
            $valid ? IReporter::_OK : IReporter::_KO
        );
    }
}