savinmikhail / Comments-Density

src/AnalyzeComments/Metrics/ComToLoc.php

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\AnalyzeComments\Metrics;

use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentStatisticsDTO;

The type SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentStatisticsDTO was not found. Maybe you did not declare it correctly or list all dependencies?

use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\ComToLocDTO;

The type SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\ComToLocDTO was not found. Maybe you did not declare it correctly or list all dependencies?

use function round;

/**
 * lines of comments to lines of code relation.
 */
final class ComToLoc
{
    private bool $exceedThreshold = false;

    /**
     * @param array<string, float> $thresholds
     */
    public function __construct(private readonly array $thresholds) {}

    /**
     * @param CommentStatisticsDTO[] $commentStatistics
     */
    public function prepareComToLoc(array $commentStatistics, int $linesOfCode): ComToLocDTO
    {
        $ratio = $this->getRatio($commentStatistics, $linesOfCode);

        return new ComToLocDTO(
            $ratio,
            $this->getColorForRatio($ratio),
        );
    }

    public function hasExceededThreshold(): bool
    {
        return $this->exceedThreshold;
    }

    /**
     * @param CommentStatisticsDTO[] $commentStatistics
     */
    private function getRatio(array $commentStatistics, int $linesOfCode): float
    {
        if ($linesOfCode === 0) {
            return 0;
        }

        $totalComments = 0;

        foreach ($commentStatistics as $stat) {
            $totalComments += $stat->lines;
        }

        return round($totalComments / $linesOfCode, 2);
    }

    private function getColorForRatio(float $ratio): string
    {
        if (! isset($this->thresholds['Com/LoC'])) {
            return 'white';
        }
        if ($ratio >= $this->thresholds['Com/LoC']) {
            return 'green';
        }
        $this->exceedThreshold = true;

        return 'red';
    }
}