SavinMikhail\CommentsDensity\MissingDocblock\MissingDocBlockAnalyzer::analyzeTokens()

Complexity

Conditions	6
Paths	6

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	6

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	MissingDocBlockAnalyzer::getColor()	0	3	1
A	MissingDocBlockAnalyzer::getMissingDocblocks()	0	3	1

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\MissingDocblock;

use PhpParser\NodeTraverser;
use PhpParser\ParserFactory;
use PhpParser\NodeVisitor\NameResolver;
use SavinMikhail\CommentsDensity\DTO\Input\MissingDocblockConfigDTO;

The type SavinMikhail\CommentsDensity\DTO\Input\MissingDocblockConfigDTO was not found. Maybe you did not declare it correctly or list all dependencies?

final class MissingDocBlockAnalyzer
{
    private bool $exceedThreshold = false;

    public function __construct(
        private readonly MissingDocblockConfigDTO $docblockConfigDTO,
    ) {
    }

    /**
     * Analyzes the AST of a file for missing docblocks.
     *
     * @param string $code The code to analyze.
     * @param string $filename The filename of the code.
     * @return array The analysis results.
     */
    public function analyze(string $code, string $filename): array
    {
        $parser = (new ParserFactory())->createForHostVersion();
        $ast = $parser->parse($code);

        $traverser = new NodeTraverser();
        $visitor = new MissingDocBlockVisitor($filename, $this->docblockConfigDTO);

        $traverser->addVisitor(new NameResolver());
        $traverser->addVisitor($visitor);
        $traverser->traverse($ast);

It seems like $ast can also be of type null; however, parameter $nodes of PhpParser\NodeTraverser::traverse() does only seem to accept array, maybe add an additional type check?

        return $visitor->missingDocBlocks;
    }

    public function getMissingDocblocks(string $code, string $filename): array
    {
        return $this->analyze($code, $filename);
    }

    public function getColor(): string
    {
        return 'red';
    }

    public function getStatColor(float $count, array $thresholds): string
    {
        if (!isset($thresholds['missingDocBlock'])) {
            return 'white';
        }
        if ($count <= $thresholds['missingDocBlock']) {
            return 'green';
        }
        $this->exceedThreshold = true;
        return 'red';
    }

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

    public function getName(): string
    {
        return 'missingDocblock';
    }
}