hanneskod\readmetester\Console\Presenter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	begin()	0	4	1
A	bootstrap()	0	4	1
B	end()	0	16	6
A	beginFile()	0	5	1
A	beginAssertion()	0	12	2
A	hasFailures()	0	4	1
A	success()	0	3	1
A	failure()	0	4	1

<?php

declare(strict_types = 1);

namespace hanneskod\readmetester\Console;

use Symfony\Component\Console\Output\OutputInterface;
use hanneskod\readmetester\Expectation\ReturnObj\ReturnObj;

/**
 * Presenter for normal (non-verbose) output
 */
class Presenter
{
    /**
     * @var OutputInterface
     */
    protected $output;

    /**
     * @var integer The number of processed files
     */
    private $fileCount = 0;

    /**
     * @var integer The number of assertions
     */
    private $assertionCount = 0;

    /**
     * @var integer The number of failed assertions
     */
    private $failureCount = 0;

    public function __construct(OutputInterface $output)
    {
        $this->output = $output;
    }

    /**
     * Called when a new test run starts
     */
    public function begin()
    {
        $this->output->writeln("Readme-Tester by Hannes Forsgård.");
    }

    /**
     * Called when a bootstrap has ben pulled
     */
    public function bootstrap(string $bootstrap)
    {
        $this->output->writeln("Loading bootstrap <comment>$bootstrap</comment>");
    }

    /**
     * Called when a test run ends
     */
    public function end()
    {
        $this->output->writeln(
            sprintf(
                "<%s>%s file%s tested, %s assertion%s, %s failure%s.</%s>",
                $this->hasFailures() ? 'error' : 'info',
                $this->fileCount,
                $this->fileCount == 1 ? '' : 's',
                $this->assertionCount,
                $this->assertionCount == 1 ? '' : 's',
                $this->failureCount,
                $this->failureCount == 1 ? '' : 's',
                $this->hasFailures() ? 'error' : 'info'
            )
        );
    }

    /**
     * Called when a new file is tested
     */
    public function beginFile(string $fileName)
    {
        $this->fileCount++;
        $this->output->writeln("Testing examples in <comment>$fileName</comment>");
    }

    /**
     * Called when an assertion is tested
     */
    public function beginAssertion(string $exampleName, ReturnObj $returnObj)
    {
        $this->assertionCount++;

        if ($returnObj->isSuccess()) {
            $this->success($exampleName, $returnObj->getMessage());
            return;
        }

        $this->failureCount++;
        $this->failure($exampleName, $returnObj->getMessage());
    }

    /**
     * Check if any failures have been recorded
     */
    public function hasFailures(): bool
    {
        return !!$this->failureCount;
    }

    /**
     * Called when an assertion is successfull
     */
    protected function success(string $exampleName, string $message)
    {
    }

    /**
     * Called when an assertion failes
     */
    protected function failure(string $exampleName, string $message)
    {
        $this->output->writeln("\n<error>Example $exampleName: $message</error>\n");
    }
}