savinmikhail / Comments-Density

src/AnalyzeComments/Metrics/CDS.php

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\AnalyzeComments\Metrics;

use InvalidArgumentException;
use Mikhail\PrimitiveWrappers\Int\Integer;
use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CdsDTO;

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

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\Comments\CommentTypeFactory;

The type SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentTypeFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use function in_array;
use function round;

/**
 * comments density score (from 0 to 1).
 */
final class CDS
{
    private const MISSING_DOCBLOCK_WEIGHT = -1;

    private bool $exceedThreshold = false;

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

    /**
     * @param CommentStatisticsDTO[] $commentStatistics
     */
    public function calculateCDS(array $commentStatistics): float
    {
        $rawScore = $this->calculateRawScore($commentStatistics);
        $minPossibleScore = $this->getMinPossibleScore($commentStatistics);
        $maxPossibleScore = $this->getMaxPossibleScore($commentStatistics);

        try {
            return (new Integer(0))
                ->scaleToRange($rawScore, $minPossibleScore, $maxPossibleScore);
        } catch (InvalidArgumentException) {
            return 0;
        }
    }

    public function prepareCDS(float $cds): CdsDTO
    {
        $cds = round($cds, 2);

        return new CdsDTO(
            $cds,
            $this->getColorForCDS($cds),
        );
    }

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

    /**
     * @param CommentStatisticsDTO[] $commentStatistics
     */
    private function calculateRawScore(array $commentStatistics): float
    {
        $rawScore = 0;

        foreach ($commentStatistics as $stat) {
            $comment = $this->commentFactory->getCommentType($stat->type);
            if ($comment) {
                $rawScore += $stat->count * $comment->getWeight();

                continue;
            }
            $rawScore += $stat->count * self::MISSING_DOCBLOCK_WEIGHT;
        }

        return $rawScore;
    }

    /**
     * @param CommentStatisticsDTO[] $commentStatistics
     */
    private function getMinPossibleScore(array $commentStatistics): float
    {
        $minScore = 0;
        foreach ($commentStatistics as $stat) {
            $comment = $this->commentFactory->getCommentType($stat->type);
            if (!$comment) {
                $minScore += self::MISSING_DOCBLOCK_WEIGHT * $stat->count;

                continue;
            }
            if ($comment->getWeight() < 0) {
                $minScore += $comment->getWeight() * $stat->count;

                continue;
            }
            $minScore -= $comment->getWeight() * $stat->count;
        }

        return $minScore;
    }

    /**
     * @param CommentStatisticsDTO[] $commentStatistics
     */
    private function getMaxPossibleScore(array $commentStatistics): float
    {
        $maxAmountOfDocBlock = 0;
        foreach ($commentStatistics as $statisticsDTO) {
            if (in_array($statisticsDTO->type, ['missingDocblock', 'docblock'], true)) {
                $maxAmountOfDocBlock += $statisticsDTO->count;
            }
        }

        return $maxAmountOfDocBlock * $this->commentFactory->getCommentType('docBlock')->getWeight();
    }

    private function getColorForCDS(float $cds): string
    {
        if (! isset($this->thresholds['CDS'])) {
            return 'white';
        }
        if ($cds >= $this->thresholds['CDS']) {
            return 'green';
        }
        $this->exceedThreshold = true;

        return 'red';
    }
}