bdelespierre / gitstats

src/Commands/Run.php

<?php

namespace Bdelespierre\GitStats\Commands;

use Bdelespierre\GitStats\Interfaces\GitServiceInterface;
use Bdelespierre\GitStats\Interfaces\ProcessServiceInterface;
use Bdelespierre\GitStats\Task;
use Symfony\Component\Console\Command\Command;
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 Run extends Command
{
    protected GitServiceInterface $git;
    protected ProcessServiceInterface $process;

    public function __construct(GitServiceInterface $git, ProcessServiceInterface $process)
    {
        $this->git = $git;
        $this->process = $process;

        parent::__construct();
    }

    protected function configure()
    {
        $this->setName('run')
            ->setDescription('Iterate through git commits to gather statistics')
            ->addArgument('branch', InputArgument::OPTIONAL, "The branch to use.", "master")
            ->addArgument('tasks', InputArgument::OPTIONAL, "The task file to use.", ".gitstats.php");
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        try {
            $this->checkEnvironment();

            $branch = $this->getBranch($input);
            $data = $this->runTasks(
                $this->getTasks($input),
                $this->git->getCommits($branch)
            );

            $output->write($this->format($data));
        } catch (\Exception $e) {
            $output->writeln("<error>{$e->getMessage()}</error>");
            return self::FAILURE;
        } finally {
            if (isset($branch)) {
                $this->git->checkout($branch);
            }
        }

        return self::SUCCESS;
    }

    private function checkEnvironment(): void
    {
        if (! $this->git->isGitAvailable()) {
            throw new \RuntimeException("Cannot proceed: unable to find git command.");
        }

        if (! $this->git->isGitRepository()) {
            throw new \RuntimeException(sprintf("Cannot proceed: %s is not a git repository.", getcwd()));
        }

        if (! $this->git->updateIndex()) {
            throw new \RuntimeException("Cannot proceed: unable to update index.");
        }

        if ($this->git->hasUnstagedChanges()) {
            throw new \RuntimeException("Cannot proceed: you have unstaged changes. " .
                "Please commit or stash them.");
        }

        if ($this->git->hasUncommittedChanges()) {
            throw new \RuntimeException("Cannot proceed: your index contains uncommitted changes. " .
                "Please commit or stash them.");
        }
    }

    private function getBranch(InputInterface $input): string
    {
        $branch = $input->getArgument('branch');

        if (! $this->git->isValidBranch($branch)) {

It seems like $branch can also be of type null and string[]; however, parameter $branch of Bdelespierre\GitStats\Interfaces\GitServiceInterface::isValidBranch() does only seem to accept string, maybe add an additional type check?

            throw new \RuntimeException("Branch {$branch} is not valid.");
        }

        return $branch;
    }

    private function getTasks(InputInterface $input): array
    {
        $file = $input->getArgument('tasks');

        if (! is_readable($file)) {

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

            throw new \RuntimeException("File {$file} does not exists.");
        }

        $tasks = [];

        foreach ((require $file)['tasks'] ?? [] as $name => $task) {
            if (! is_array($task) || ! isset($task['command'])) {
                $task = ['command' => $task];
            }

            $tasks[] = new Task($this->process, $name, $task['command'], $task['patterns'] ?? []);
        }

        return $tasks;
    }

    private function runTasks(iterable $tasks, iterable $commits): \Generator
    {
        // headers
        yield array_merge(['commit', 'date'], ...array_map(fn($task) => $task->getHeaders(), $tasks));

$tasks of type iterable is incompatible with the type array expected by parameter $array of array_map().

        foreach ($commits as $commit) {
            $this->git->checkout($commit);

            $timestamp = $this->git->getCommitTimestamp($commit);
            $data = [
                'commit' => $commit,
                'date' => date('Y-m-d H:i:s', $timestamp),
            ];

            foreach ($tasks as $task) {
                $data += $task->run($commit)->toArray();
            }

            yield $data;
        }
    }

    private function format(iterable $data): \Generator
    {
        $buffer = fopen('php://temp', 'r+');

        foreach ($data as $row) {
            $length = fputcsv($buffer, $row, ',', '"', '\\');
            fseek($buffer, ftell($buffer) - $length);
            yield fgets($buffer);
        }

        fclose($buffer);
    }
}