SavinMikhail\CommentsDensity\AnalyzeComments\Commands\AnalyzeCommentCommand

Complexity

Total Complexity

6

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	configure()	0	5	1
A	getFilesFromDirectories()	0	6	3
A	execute()	0	28	2

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\AnalyzeComments\Commands;

use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\AnalyzerFactory;

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

use SavinMikhail\CommentsDensity\AnalyzeComments\Config\ConfigLoader;

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

use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;

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

use SavinMikhail\CommentsDensity\AnalyzeComments\Exception\CommentsDensityException;
use SavinMikhail\CommentsDensity\AnalyzeComments\Reporters\ReporterFactory;

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

use SavinMikhail\CommentsDensity\Baseline\Storage\TreePhpBaselineStorage;
use SplFileInfo;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

final 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.');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $configLoader = new ConfigLoader();
        $path = $configLoader->getProjectRoot() . '/baseline.php';

        $storage = new TreePhpBaselineStorage();
        $storage->init($path);

        $configDto = $configLoader->getConfigDto();
        $files = $this->getFilesFromDirectories($configDto->directories);

        $reporter = (new ReporterFactory())->createReporter($output, $configDto);
        $analyzerFactory = new AnalyzerFactory();

        $analyzer = $analyzerFactory->getAnalyzer($configDto, $output, $storage);

        $outputDTO = $analyzer->analyze($files);

        $reporter->report($outputDTO);

        if ($outputDTO->exceedThreshold) {
            $output->writeln('<error>Comment thresholds were exceeded!</error>');

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

        return Command::SUCCESS;
    }

    /**
     * @param string[] $directories
     * @return SplFileInfo[]
     */
    protected function getFilesFromDirectories(array $directories): iterable
    {
        foreach ($directories as $directory) {
            $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($directory));
            foreach ($iterator as $file) {
                yield $file;

The expression yield $file returns the type Generator which is incompatible with the documented return type SplFileInfo[].

            }
        }
    }
}