SavinMikhail\CommentsDensity\Commands\AnalyzeCommentCommand

Complexity

Total Complexity

8

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Test Coverage

Coverage

78.95%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getExcludes()	0	5	1
A	parseConfigFile()	0	4	1
A	getDirectories()	0	5	1
A	analyze()	0	11	2
A	execute()	0	37	1
A	getProjectRoot()	0	3	1
A	configure()	0	5	1

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\Commands;

use SavinMikhail\CommentsDensity\CDS;
use SavinMikhail\CommentsDensity\CommentDensity;
use SavinMikhail\CommentsDensity\Comments\CommentFactory;
use SavinMikhail\CommentsDensity\ComToLoc;
use SavinMikhail\CommentsDensity\DTO\Input\ConfigDTO;

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

use SavinMikhail\CommentsDensity\FileAnalyzer;

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

use SavinMikhail\CommentsDensity\MissingDocBlockAnalyzer;
use SavinMikhail\CommentsDensity\Reporters\ReporterFactory;

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

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Yaml\Parser;

class AnalyzeCommentCommand extends Command
{
    protected function configure(): void
    {
        $this->setName('analyze:comments')
            ->setDescription('Analyzes the comment density in files within a directory.')
            ->setHelp('This command allows you to analyze the comments in PHP files within a specified directory.');
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $configFile = $this->getProjectRoot() . '/comments_density.yaml';
        $config = $this->parseConfigFile($configFile);

        $directories = $this->getDirectories($config);
        $exclude = $this->getExcludes($config);
        $thresholds = $config['thresholds'] ?? [];
        $outputConfig = $config['output'] ?? [];

        $configDto = new ConfigDTO(
            $thresholds,
            $exclude,
            $outputConfig
        );

        $reporterFactory = new ReporterFactory();
        $commentFactory = new CommentFactory();
        $missingDocBlock = new MissingDocBlockAnalyzer();
        $fileAnalyzer = new FileAnalyzer(
            $output,
            $missingDocBlock,
            new CDS($configDto->thresholds, $commentFactory),
            $commentFactory
        );

        $analyzer = new CommentDensity(
            $configDto,
            $commentFactory,
            $fileAnalyzer,
            $reporterFactory->createReporter($output, $configDto),
            new CDS($configDto->thresholds, $commentFactory),
            new ComToLoc($configDto->thresholds),
            $missingDocBlock
        );

        return $this->analyze($analyzer, $directories, $output);
    }

    protected function parseConfigFile(string $configFile): array
    {
        $yamlParser = new Parser();
        return $yamlParser->parseFile($configFile);
    }

    protected function getDirectories(array $config): array
    {
        return array_map(
            fn($dir) => $this->getProjectRoot() . '/' . $dir,
            $config['directories']
        );
    }

    protected function getExcludes(array $config): array
    {
        return array_map(
            fn($dir) => $this->getProjectRoot() . '/' . $dir,
            $config['exclude']
        );
    }

    protected function analyze(CommentDensity $analyzer, array $directories, OutputInterface $output): int
    {
        $limitExceeded = $analyzer->analyzeDirectories($directories);

        if ($limitExceeded) {
            $output->writeln('<error>Comment thresholds were exceeded!</error>');
            return Command::FAILURE;
        }

        $output->writeln('<info>Comment thresholds are passed!</info>');
        return Command::SUCCESS;
    }

    protected function getProjectRoot(): string
    {
        return dirname(__DIR__, 2);
    }
}