ResultPrinter.php

<?php

namespace staabm\PHPStanBaselineAnalysis;

use Exception;
use \Iterator;
use Safe\DateTimeImmutable;
use function Safe\sprintf;
use function Safe\json_encode;

final class ResultPrinter {
    const DATE_FORMAT = DateTimeImmutable::RFC2822;

    const FORMAT_JSON = 'json';
    const FORMAT_TEXT = 'text';

    // use plural string-values
    const KEY_REFERENCE_DATE = 'Date';
    const KEY_OVERALL_ERRORS = 'Overall-Errors';
    const KEY_CLASSES_COMPLEXITY = 'Classes-Cognitive-Complexity';
    const KEY_DEPRECATIONS = 'Deprecations';
    const KEY_INVALID_PHPDOCS = 'Invalid-Phpdocs';
    const KEY_UNKNOWN_TYPES = 'Unknown-Types';
    const KEY_ANONYMOUS_VARIABLES = 'Anonymous-Variables';
    const KEY_PROPERTY_TYPE_COVERAGE = 'Native-Property-Type-Coverage';
    const KEY_PARAM_TYPE_COVERAGE = 'Native-Param-Type-Coverage';
    const KEY_RETURN_TYPE_COVERAGE = 'Native-Return-Type-Coverage';
    const KEY_UNUSED_SYMBOLS = 'Unused-Symbols';

    /**
     * @phpstan-assert-if-true self::KEY_* $filterString
     */
    public static function isFilterKey(string $filterString): bool
    {

        return in_array($filterString, self::getFilterKeys(), true);
    }

    /**
     * @return array<self::KEY_*>
     */
    public static function getFilterKeys(): array {
        return [
            self::KEY_CLASSES_COMPLEXITY,
            self::KEY_DEPRECATIONS,
            self::KEY_INVALID_PHPDOCS,
            self::KEY_UNKNOWN_TYPES,
            self::KEY_ANONYMOUS_VARIABLES,
            self::KEY_UNUSED_SYMBOLS,
        ];
    }

    /**
     * @return Iterator<string>
     */
    public function streamText(Baseline $baseline, AnalyzerResult $result): Iterator
    {
        $referenceDate = '';
        if ($result->referenceDate !== null) {
            $referenceDate = $result->referenceDate->format(ResultPrinter::DATE_FORMAT);
        }

        yield sprintf("Analyzing %s\n", $baseline->getFilePath());
        yield sprintf("  %s: %s\n", self::KEY_REFERENCE_DATE, $referenceDate);
        yield sprintf("  %s: %s\n", self::KEY_OVERALL_ERRORS, $result->overallErrors);
        yield sprintf("  %s: %s\n", self::KEY_CLASSES_COMPLEXITY, $result->classesComplexity);
        yield sprintf("  %s: %s\n", self::KEY_DEPRECATIONS, $result->deprecations);
        yield sprintf("  %s: %s\n", self::KEY_INVALID_PHPDOCS, $result->invalidPhpdocs);
        yield sprintf("  %s: %s\n", self::KEY_UNKNOWN_TYPES, $result->unknownTypes);
        yield sprintf("  %s: %s\n", self::KEY_ANONYMOUS_VARIABLES, $result->anonymousVariables);
        yield sprintf("  %s: %s\n", self::KEY_PROPERTY_TYPE_COVERAGE, $result->propertyTypeCoverage);
        yield sprintf("  %s: %s\n", self::KEY_PARAM_TYPE_COVERAGE, $result->paramTypeCoverage);
        yield sprintf("  %s: %s\n", self::KEY_RETURN_TYPE_COVERAGE, $result->returnTypeCoverage);
        yield sprintf("  %s: %s\n", self::KEY_UNUSED_SYMBOLS, $result->unusedSymbols);
    }


    /**
     * @return Iterator<string>
     */
    public function streamJson(Baseline $baseline, AnalyzerResult $result): Iterator
    {
        $referenceDate = null;
        if ($result->referenceDate !== null) {
            $referenceDate = $result->referenceDate->format(ResultPrinter::DATE_FORMAT);
        }

        yield json_encode([
            $baseline->getFilePath() => [
                self::KEY_REFERENCE_DATE => $referenceDate,
                self::KEY_OVERALL_ERRORS => $result->overallErrors,
                self::KEY_CLASSES_COMPLEXITY => $result->classesComplexity,
                self::KEY_DEPRECATIONS => $result->deprecations,
                self::KEY_INVALID_PHPDOCS => $result->invalidPhpdocs,
                self::KEY_UNKNOWN_TYPES => $result->unknownTypes,
                self::KEY_ANONYMOUS_VARIABLES => $result->anonymousVariables,
                self::KEY_PROPERTY_TYPE_COVERAGE => $result->propertyTypeCoverage,
                self::KEY_PARAM_TYPE_COVERAGE => $result->paramTypeCoverage,
                self::KEY_RETURN_TYPE_COVERAGE => $result->returnTypeCoverage,
                self::KEY_UNUSED_SYMBOLS => $result->unusedSymbols,
            ]
        ]);
    }
}