JobQueue\Application\Console\ListTasks

Complexity

Total Complexity

28

Size/Duplication

Total Lines	214
Duplicated Lines	0 %

Test Coverage

Coverage

72.92%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	execute()	0	24	5
A	configure()	0	11	1
C	display()	0	39	7
C	getRows()	0	56	11
B	addTableFooter()	0	28	4

<?php

namespace JobQueue\Application\Console;

use JobQueue\Application\Utils\CommandTrait;
use JobQueue\Domain\Task\Profile;
use JobQueue\Domain\Task\Status;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Helper\TableCell;
use Symfony\Component\Console\Helper\TableSeparator;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

final class ListTasks extends ManagerCommand
{
    use CommandTrait;

    /**
     *
     * @var Profile
     */
    private $profile;

    /**
     *
     * @var Status
     */
    private $status;

    /**
     *
     * @var array
     */
    private $tags = [];

    public function configure()
    {
        $this
            ->setName('list')
            ->setDescription('Lists tasks')
            ->addOption('profile', 'p', InputOption::VALUE_OPTIONAL, 'Limits the listing to a profile')
            ->addOption('status',  's', InputOption::VALUE_OPTIONAL, 'Limits the listing to a status')
            ->addOption('tags',    't', InputOption::VALUE_IS_ARRAY|InputOption::VALUE_OPTIONAL, 'Limits the listing to one or many (array) tags')
            ->addOption('order',   'o', InputOption::VALUE_REQUIRED, 'Orders tasks by "date", "profile" or "status"', 'status')
            ->addOption('follow',  'f', InputOption::VALUE_NONE, 'Enables to keep tasks evolution on the console')
            ->addOption('legend',  'l', InputOption::VALUE_NONE, 'Displays a legend for status labels at the list footer')
        ;
    }

    /**
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return int
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->setStyles($output);

        $this->profile = $input->getOption('profile')
            ? new Profile($input->getOption('profile'))
            : null;

        $this->status = $input->getOption('status')
            ? new Status($input->getOption('status'))
            : null;

        $this->tags = is_array($input->getOption('tags'))
            ? $input->getOption('tags')
            : [];

        // Clear screen for `follow` mode
        if ($follow = $input->getOption('follow')) {
            system('clear');
        }

        $this->display($follow, $input, $output);

        return 0;
    }

    /**
     *
     * @param bool            $follow
     * @param InputInterface  $input
     * @param OutputInterface $output
     */
    private function display(bool $follow, InputInterface $input, OutputInterface $output)
    {
        list($rows, $taskCount) = $this->getRows($input->getOption('order'), $output);

        if (empty($rows)) {
            $this->formatInfoBlock(
                sprintf('There is currently no task corresponding to %s profile and %s status in queue.',
                    $this->profile ?: 'any',
                    $this->status ?: 'any'),
                $output
            );

        } else {
            if ($input->getOption('legend')) {
                $rows = $this->addTableFooter($rows, $output);
            }

            $columns = ['Job', 'Profile', 'Date'];
            foreach ($this->tags as $key => $tag) {
                $columns[] = sprintf('T%d', $key + 1);
            }
            $columns[] = 'Identifier';

            (new Table($output))
                ->setHeaders($columns)
                ->setRows($rows)
                ->render()
            ;

            $output->writeln(sprintf('There is %d tasks in queue', $taskCount));
            $output->writeln('');
        }

        // follow mode
        if ($follow) {
            sleep(1);
            system('clear');

            $this->display($follow, $input, $output);
        }
    }

    /**
     *
     * @param string          $order
     * @param OutputInterface $output
     * @return array
     */
    public function getRows(string $order, OutputInterface $output): array
    {
        $taskCount = 0;
        $rows = [];
        $previousSeparator = null;

        foreach ($this->queue->search($this->profile, $this->status, $this->tags, $order) as $task) {
            $status = (string) $task->getStatus();

            // When no specific status is required in the command line,
            // then do not display `finished` tasks (this is arbitrary)
            if (is_null($this->status)) {
                if (Status::FINISHED === $status) continue;
            }

            $taskCount++;

            $profile = (string) $task->getProfile();

            switch ($order) {
                case 'date':
                    $separator = $task->getCreatedAt('Ymd');
                    break;

                case 'profile':
                    $separator = $profile;
                    break;

                case 'status':
                default:
                    $separator = $status;
            }

            if ($previousSeparator and $separator !== $previousSeparator) {
                $rows[] = new TableSeparator;
            }

            $taskData = [
                sprintf('%s %s', $this->formatContent('■', $status, $output), $task->getJobName(true)),
                $profile,
                $task->getCreatedAt('Y-m-d H:i:s'),
            ];

            // Add `tags` columns
            foreach ($this->tags as $tag) {
                $taskData[] = $task->hasTag($tag) ? ' ✔ ' : ' ✘ ';
            }

            $taskData[] = $task->getIdentifier();

            $rows[] = $taskData;

            $previousSeparator = $separator;
        }

        return [$rows, $taskCount];
    }

    /**
     *
     * @param array $rows
     * @param OutputInterface $output
     * @return array
     */
    private function addTableFooter(array $rows, OutputInterface $output): array
    {
        $legend = [];
        foreach (Status::listStatus() as $status) {
            $legend[] = sprintf('%s %s', $this->formatContent('■', $status, $output), $status);
        }

        $colspan = count(Status::listStatus()) + count($this->tags);

        $rows[] = new TableSeparator;
        $rows[] = [new TableCell(
            sprintf('Legend:   %s', implode('   ', $legend)),
            ['colspan' => $colspan]
        )];

        if (!empty($this->tags)) {
            $tags = [];
            foreach ($this->tags as $key => $tag) {
                $tags[] = sprintf('- T%s: tag "%s"', $key + 1, $tag);
            }

            $rows[] = [new TableCell(
                sprintf("Tag(s): \n%s", implode("\n", $tags)),
                ['colspan' => $colspan]
            )];
        }

        return $rows;
    }
}