SavinMikhail\CommentsDensity\Commands\AnalyzeFileCommand

Complexity

Total Complexity

6

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Test Coverage

Coverage

84.62%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	analyzeFile()	0	11	2
A	configure()	0	6	1
A	parseConfigFile()	0	4	1
A	getProjectRoot()	0	3	1
A	execute()	0	37	1

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\Commands;

use SavinMikhail\CommentsDensity\CommentDensity;
use SavinMikhail\CommentsDensity\Comments\CommentFactory;
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\Metrics\CDS;
use SavinMikhail\CommentsDensity\Metrics\ComToLoc;
use SavinMikhail\CommentsDensity\Metrics\Metrics;

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

use SavinMikhail\CommentsDensity\Metrics\PerformanceMonitor;
use SavinMikhail\CommentsDensity\MissingDocBlockAnalyzer;
use SavinMikhail\CommentsDensity\Reporters\ConsoleReporter;

The type SavinMikhail\CommentsDensity\Reporters\ConsoleReporter 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\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Yaml\Parser;

use function dirname;

class AnalyzeFileCommand extends Command
{
    protected function configure(): void
    {
        $this->setName('analyze:file')
            ->setDescription('Analyzes the comment density in a single PHP file.')
            ->addArgument('file', InputArgument::REQUIRED, 'The PHP file to analyze')
            ->setHelp('This command allows you to analyze the comments in a single PHP file.');
    }

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

        $thresholds = $config['thresholds'];
        $outputConfig = $config['output'] ?? [];
        $file = $input->getArgument('file');
        $missingDocBlock = new MissingDocBlockAnalyzer();
        $configDto = new ConfigDTO(
            $thresholds,
            [],
            $outputConfig
        );
        $commentFactory = new CommentFactory();
        $cds = new CDS($configDto->thresholds, $commentFactory);
        $fileAnalyzer = new FileAnalyzer(
            $output,
            $missingDocBlock,
            $cds,
            $commentFactory
        );
        $metrics = new Metrics(
            $cds,
            new ComToLoc($configDto->thresholds),
            new PerformanceMonitor(),
        );
        $analyzer = new CommentDensity(
            $configDto,
            $commentFactory,
            $fileAnalyzer,
            new ConsoleReporter($output),
            $missingDocBlock,
            $metrics
        );

        return $this->analyzeFile($analyzer, $file, $output);
    }

    protected function analyzeFile(CommentDensity $analyzer, string $file, OutputInterface $output): int
    {
        $limitExceeded = $analyzer->analyzeFile($file);

        if ($limitExceeded) {
            $output->writeln('<error>Comment thresholds were exceeded!</error>');
            $output->writeln('<info>To skip commit checks, add -n or --no-verify flag to commit command</info>');
            return Command::FAILURE;
        }
        $output->writeln('<info>Comment thresholds are passed!</info>');
        return Command::SUCCESS;
    }

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

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