MontealegreLuis / phuml

src/Console/Commands/GenerateStatisticsCommand.php

<?php declare(strict_types=1);
/**
 * This source file is subject to the license that is bundled with this package in the file LICENSE.
 */

namespace PhUml\Console\Commands;

use PhUml\Console\ConsoleProgressDisplay;
use PhUml\Generators\StatisticsGenerator;
use PhUml\Generators\StatisticsGeneratorConfiguration;
use Symfony\Component\Console\Command\Command;

The type Symfony\Component\Console\Command\Command was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Exception\InvalidArgumentException;

The type Symfony\Component\Console\Exception\InvalidArgumentException was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Input\InputArgument;

The type Symfony\Component\Console\Input\InputArgument was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Input\InputInterface;

The type Symfony\Component\Console\Input\InputInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Input\InputOption;

The type Symfony\Component\Console\Input\InputOption was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Output\OutputInterface;

The type Symfony\Component\Console\Output\OutputInterface was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * This command will generate a text file with the statistics of an OO codebase
 *
 * This command has 2 required arguments
 *
 * 1. `directory`. The path where your codebase lives
 * 2. `output`. The path to where the generated `png` image will be saved
 *
 * There is 1 option
 *
 * 1. `recursive`. If present it will look recursively within the `directory` provided
 */
final class GenerateStatisticsCommand extends Command
{
    /**
     * @throws InvalidArgumentException
     */
    protected function configure(): void
    {
        $this
            ->setName('phuml:statistics')
            ->setDescription('Generate statistics about the code of a given directory')
            ->setHelp(
                <<<HELP
Example:
    php bin/phuml phuml:statistics -r  ./src statistics.txt

    This example will scan the `./src` directory recursively for php files.
    It will generate the statistics and save them to the file `statistics.txt`.
HELP
            )
            ->addOption(
                'recursive',
                'r',
                InputOption::VALUE_NONE,
                'Look for classes in the given directory recursively'
            )
            ->addArgument(
                'directory',
                InputArgument::REQUIRED,
                'The directory to be scanned to generate the statistics'
            )
            ->addArgument(
                'output',
                InputArgument::REQUIRED,
                'The file name for your statistics file'
            )
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        /** @var array{ recursive: bool } $options */
        $options = $input->getOptions();
        $configuration = new StatisticsGeneratorConfiguration($options, new ConsoleProgressDisplay($output));
        $generator = StatisticsGenerator::fromConfiguration($configuration);

        /**
         * @var array{
         *      directory: string,
         *      output: string
         * } $arguments
         */
        $arguments = $input->getArguments();
        $generator->generate(GeneratorInput::textFile($arguments));

        return self::SUCCESS;
    }
}