Churn\Commands\ChurnCommand

Complexity

Total Complexity

8

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Importance

Changes	12
Bugs	3	Features	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	execute()	0	20	1
A	configure()	0	9	1
A	getDirectoriesToScan()	0	14	3
A	getOnSuccessObserver()	0	10	2

<?php declare(strict_types = 1);

namespace Churn\Commands;

use Churn\Configuration\Config;
use Churn\Factories\ResultsRendererFactory;
use Churn\Logic\ResultsLogic;
use Churn\Managers\FileManager;
use Churn\Process\Observer\OnSuccess;
use Churn\Process\Observer\OnSuccessNull;
use Churn\Process\Observer\OnSuccessProgress;
use Churn\Process\ProcessFactory;
use Churn\Process\ProcessHandlerFactory;
use function count;
use function file_get_contents;
use InvalidArgumentException;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Yaml\Yaml;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class ChurnCommand extends Command
{
    private const LOGO ="
    ___  _   _  __  __  ____  _  _     ____  _   _  ____
   / __)( )_( )(  )(  )(  _ \( \( )___(  _ \( )_( )(  _ \
  ( (__  ) _ (  )(__)(  )   / )  ((___))___/ ) _ (  )___/
   \___)(_) (_)(______)(_)\_)(_)\_)   (__)  (_) (_)(__)";

    /**
     * The results logic.
     * @var ResultsLogic
     */
    private $resultsLogic;

    /**
     * The process handler factory.
     * @var ProcessHandlerFactory
     */
    private $processHandlerFactory;

    /**
     * The renderer factory.
     * @var ResultsRendererFactory
     */
    private $renderFactory;

    /**
     * ChurnCommand constructor.
     * @param ResultsLogic           $resultsLogic          The results logic.
     * @param ProcessHandlerFactory  $processHandlerFactory The process handler factory.
     * @param ResultsRendererFactory $renderFactory         The Results Renderer Factory.
     */
    public function __construct(
        ResultsLogic $resultsLogic,
        ProcessHandlerFactory $processHandlerFactory,
        ResultsRendererFactory $renderFactory
    ) {
        parent::__construct();
        $this->resultsLogic = $resultsLogic;
        $this->processHandlerFactory = $processHandlerFactory;
        $this->renderFactory = $renderFactory;
    }

    /**
     * Configure the command
     * @return void
     */
    protected function configure(): void
    {
        $this->setName('run')
            ->addArgument('paths', InputArgument::IS_ARRAY, 'Path to source to check.')
            ->addOption('configuration', 'c', InputOption::VALUE_OPTIONAL, 'Path to the configuration file', 'churn.yml')  // @codingStandardsIgnoreLine
            ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format to use', 'text')
            ->addOption('progress', 'p', InputOption::VALUE_NONE, 'Show progress bar')
            ->setDescription('Check files')
            ->setHelp('Checks the churn on the provided path argument(s).');
    }

    /**
     * Execute the command
     * @param InputInterface  $input  Input.
     * @param OutputInterface $output Output.
     * @return integer
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $output->writeln(self::LOGO);
        $content = (string) @file_get_contents($input->getOption('configuration'));

It seems like $input->getOption('configuration') can also be of type string[]; however, parameter $filename of file_get_contents() does only seem to accept string, maybe add an additional type check?

        $config = Config::create(Yaml::parse($content) ?? []);
        $filesCollection = (new FileManager($config->getFileExtensions(), $config->getFilesToIgnore()))
            ->getPhpFiles($this->getDirectoriesToScan($input, $config->getDirectoriesToScan()));
        $completedProcesses = $this->processHandlerFactory->getProcessHandler($config)->process(
            $filesCollection,
            new ProcessFactory($config->getCommitsSince()),
            $this->getOnSuccessObserver($input, $output, $filesCollection->count())
        );
        $resultCollection = $this->resultsLogic->process(
            $completedProcesses,
            $config->getMinScoreToShow(),
            $config->getFilesToShow()
        );
        $renderer = $this->renderFactory->getRenderer($input->getOption('format'));
        $renderer->render($output, $resultCollection);
        return 0;
    }

    /**
     * Get the directories to scan.
     * @param InputInterface $input          Input Interface.
     * @param array          $dirsConfigured The directories configured to scan.
     * @throws InvalidArgumentException If paths argument invalid.
     * @return array When no directories to scan found.
     */
    private function getDirectoriesToScan(InputInterface $input, array $dirsConfigured): array
    {
        $dirsProvidedAsArgs = $input->getArgument('paths');
        if (count($dirsProvidedAsArgs) > 0) {

It seems like $dirsProvidedAsArgs can also be of type string; however, parameter $var of count() does only seem to accept Countable|array, maybe add an additional type check?

            return $dirsProvidedAsArgs;

The expression return $dirsProvidedAsArgs could return the type null|string which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

        }

        if (count($dirsConfigured) > 0) {
            return $dirsConfigured;
        }

        throw new InvalidArgumentException(
            'Provide the directories you want to scan as arguments, ' .
            'or configure them under "directoriesToScan" in your churn.yml file.'
        );
    }

    /**
     * @param InputInterface  $input      Input.
     * @param OutputInterface $output     Output.
     * @param integer         $totalFiles Total number of files to process.
     * @return OnSuccess
     */
    private function getOnSuccessObserver(InputInterface $input, OutputInterface $output, int $totalFiles): OnSuccess
    {
        if ((bool)$input->getOption('progress')) {
            $output->writeln("\n");
            $progressBar = new ProgressBar($output, $totalFiles);
            $progressBar->start();
            return new OnSuccessProgress($progressBar);
        }

        return new OnSuccessNull();
    }
}