DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\OutputFormatters\TableOutputFormatter

Complexity

Total Complexity

10

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getIdentifier()	0	3	1
A	renderTable()	0	4	2
A	outputResults()	0	14	3
A	addIssuesInTable()	0	44	4

<?php

declare(strict_types=1);

namespace DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\OutputFormatters;

use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\AbsoluteFileName;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\OutputFormatter\OutputFormatter;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResults;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Output\BufferedOutput;
use Webmozart\Assert\Assert;

final class TableOutputFormatter implements OutputFormatter
{
    public const CODE = 'table';

    public function outputResults(AnalysisResults $analysisResults): string
    {
        if ($analysisResults->hasNoIssues()) {
            return 'No issues';
        }

        $bufferedOutput = new BufferedOutput();
        $hasWarnings = $this->addIssuesInTable($bufferedOutput, $analysisResults);

        if ($hasWarnings) {
            $bufferedOutput->writeln("\nThese results include warnings. To exclude warnings from output use the --ignore-warnings flag.");
        }

        return $bufferedOutput->fetch();
    }

    public function getIdentifier(): string
    {
        return self::CODE;
    }

    private function addIssuesInTable(BufferedOutput $output, AnalysisResults $analysisResults): bool
    {
        $hasWarnings = false;

        /** @var string[] $headings */
        $headings = [
            'Line',
            'Description',
        ];

        /** @var AbsoluteFileName $currentFileName */
        $currentFileName = null;
        /** @var Table|null $currentTable */
        $currentTable = null;
        foreach ($analysisResults->getAnalysisResults() as $analysisResult) {
            $fileName = $analysisResult->getLocation()->getAbsoluteFileName();

            if (!$fileName->isEqual($currentFileName)) {
                $this->renderTable($currentTable);

                $output->writeln("\nFILE: {$fileName->getFileName()}");
                $currentFileName = $fileName;
                $currentTable = new Table($output);
                $currentTable->setHeaders($headings);
            }

            $warning = $analysisResult->getSeverity()->isWarning();
            if ($warning) {
                $hasWarnings = true;
                $prefix = 'WARNING: ';
            } else {
                $prefix = '';
            }

            Assert::notNull($currentTable, 'No Table object');
            $currentTable->addRow([
                $analysisResult->getLocation()->getLineNumber()->getLineNumber(),
                $prefix.$analysisResult->getMessage(),
            ]);
        }

        $this->renderTable($currentTable);

        return $hasWarnings;
    }

    private function renderTable(?Table $table): void
    {
        if (null !== $table) {
            $table->render();
        }
    }
}