silverstripe / moduleratings-plugin

src/Command/RateModuleCommand.php

<?php

namespace SilverStripe\ModuleRatingsPlugin\Command;

use Composer\Command\BaseCommand;
use InvalidArgumentException;
use SilverStripe\ModuleRatings\Check;
use SilverStripe\ModuleRatings\CheckSuite;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Helper\TableSeparator;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class RateModuleCommand extends BaseCommand
{
    protected function configure()
    {
        $this
            ->setName('rate-module')
            ->setDescription('Assesses a module\'s quality and provides a rating')
            ->setDefinition([
                new InputArgument(
                    'module-path',
                    InputArgument::REQUIRED,
                    'The path to the module folder, relative to the current working directory'
                ),
                new InputOption(
                    'slug',
                    null,
                    InputOption::VALUE_OPTIONAL,
                    "The module's GitHub repository slug, e.g. silverstripe/silverstripe-blog - used for API checks"
                ),
            ])->setHelp(<<<TEXT
This command will assess the provided module based on a selection of pre-defined quality checks, and provide a rating
out of 100.

You must provide the <info>module-path</info> to map the path from the current working directory to the source code
of the module, and you may optionally provide the <info>slug</info> argument which will enable API based status checks.

Note that without providing <info>slug</info> the module will never be able to achieve a 100% score.
TEXT
        );
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        // Ensure autoloader is included
        $vendorDir = $this->getComposer()->getConfig()->get('vendor-dir');
        require_once $vendorDir . '/autoload.php';

        $modulePath = $input->getArgument('module-path');
        if (empty($modulePath) || !file_exists($modulePath)) {

It seems like $modulePath can also be of type string[]; however, parameter $filename of file_exists() does only seem to accept string, maybe add an additional type check?

            throw new InvalidArgumentException('Provided module path "' . $modulePath . '" does not exist!');

Are you sure $modulePath of type null|string|string[] can be used in concatenation?

        }

        // Make path absolute
        $modulePath = realpath($modulePath);

It seems like $modulePath can also be of type string[]; however, parameter $path of realpath() does only seem to accept string, maybe add an additional type check?

        $checkSuite = new CheckSuite();

        $checkSuite->setModuleRoot($modulePath);
        if ($slug = $input->getOption('slug')) {
            $checkSuite->setRepositorySlug($slug);
        }

        // Get a callback we can use to monitor the check suite progress
        $progressBar = new ProgressBar($output, count($checkSuite->getChecks()));
        $progressBar->setFormatDefinition('checksuite', '  %current%/%max% [%bar%] %message%');
        $progressBar->setFormat('checksuite');
        $progressBar->setMessage('Loading check suite...');
        $progressBar->start();
        $callback = $this->getCheckCallback($progressBar);

        $checkSuite->run($callback);

        $progressBar->finish();
        $progressBar->clear();

        $tableRows = $checkSuite->getCheckDetails();
        $tableRows[] = new TableSeparator();
        $tableRows[] = ['TOTAL SCORE (normalised)', $checkSuite->getScore(), '100'];

        $table = new Table($output);
        $table
            ->setHeaders(['Check description', 'Points', 'Maximum'])
            ->setRows($tableRows);
        $table->render();
    }

    protected function getCheckCallback(ProgressBar $progressBar)
    {
        return function (Check $check, callable $delegate) use ($progressBar) {
            $progressBar->setMessage('Running check: ' . $check->getKey());
            $delegate();
            $progressBar->advance();
        };
    }
}