Cecil\Command\Command

Complexity

Total Complexity

28

Size/Duplication

Total Lines	191
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	initialize()	0	37	8
A	getPath()	0	4	1
A	getBuilder()	0	22	4
A	createProgressBar()	0	14	3
A	getProgressBar()	0	4	1
A	printProgressBar()	0	11	2
B	messageCallback()	0	31	9

<?php
/*
 * Copyright (c) Arnaud Ligny <arnaud@ligny.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Command;

use Cecil\Builder;
use Symfony\Component\Console\Command\Command as BaseCommand;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;

class Command extends BaseCommand
{
    const CONFIG_FILE = 'config.yml';

    /**
     * @var Filesystem
     */
    protected $fs;
    /**
     * @var string
     */
    protected $path;
    /**
     * @var Builder
     */
    protected $builder;
    /**
     * @var ProgressBar
     */
    protected $progressBar = null;

    /**
     * {@inheritdoc}
     */
    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        $this->fs = new Filesystem();

        if (!in_array($this->getName(), ['self-update'])) {
            $this->path = $input->getArgument('path');

It seems like $input->getArgument('path') can also be of type array<integer,string>. However, the property $path is declared as type string. Maybe add an additional type check?

            if (null === $this->getPath()) {
                $this->path = getcwd();
            }
            if (false === realpath($this->getPath())) {
                if (!in_array($this->getName(), ['new:site'])) {
                    $message = sprintf('"%s" is not valid path.', $this->getPath());

                    throw new \InvalidArgumentException($message);
                }
                $helper = $this->getHelper('question');
                $question = new ConfirmationQuestion(sprintf('The provided <path> "%s" doesn\'t exist. Do you want to create it? [y/n]', $this->getpath()), false);
                if (!$helper->ask($input, $output, $question)) {
                    return;
                }

                $this->fs->mkdir($this->getPath());
            }
            $this->path = realpath($this->getPath());
            $this->path = str_replace(DIRECTORY_SEPARATOR, '/', $this->getPath());

            if (!in_array($this->getName(), ['new:site'])) {
                if (!file_exists($this->getPath().'/'.self::CONFIG_FILE)) {
                    $message = sprintf('Cecil could not find "%s" file in "%s"', self::CONFIG_FILE, $this->getPath());

                    throw new \InvalidArgumentException($message);
                }
            }
        }

        parent::initialize($input, $output);
    }

    /**
     * Return the working directory.
     *
     * @return string|null
     */
    public function getPath(): ?string
    {
        return $this->path;
    }

    /**
     * Create or return a Builder instance.
     *
     * @param OutputInterface $output
     * @param array           $config
     * @param array           $options

There is no parameter named $options. Was it maybe removed?

     *
     * @return Builder
     */
    public function getBuilder(
        OutputInterface $output,
        array $config = ['debug' => false]
    ): Builder {
        if (!file_exists($this->getPath().'/'.self::CONFIG_FILE)) {
            throw new \Exception(sprintf('Config file not found in "%s"!', $this->getPath()));
        }

        try {
            $configFile = Yaml::parse(file_get_contents($this->getPath().'/'.self::CONFIG_FILE));
            $config = array_replace_recursive($configFile, $config);
            $this->builder = (new Builder($config, $this->messageCallback($output)))
                ->setSourceDir($this->getPath())
                ->setDestinationDir($this->getPath());
        } catch (ParseException $e) {
            throw new \Exception(sprintf('Config file parse error: %s', $e->getMessage()));
        } catch (\Exception $e) {
            throw new \Exception(sprintf($e->getMessage()));
        }

        return $this->builder;
    }

    /**
     * Create the Progress bar.
     *
     * @param OutputInterface $output
     * @param int             $max
     */
    protected function createProgressBar(OutputInterface $output, $max)
    {
        if ($this->progressBar === null || $max != $this->progressBarMax) {

The property progressBarMax does not seem to exist. Did you mean progressBar?

            $this->progressBarMax = $max;

The property progressBarMax does not seem to exist. Did you mean progressBar?

            $this->progressBar = new ProgressBar($output, $max);
            $this->progressBar->setOverwrite(true);
            $this->progressBar->setFormat(' %percent:3s%% [%bar%] %current%/%max%');
            $this->progressBar->setBarCharacter('#');
            $this->progressBar->setEmptyBarCharacter(' ');
            $this->progressBar->setProgressCharacter('#');
            $this->progressBar->setRedrawFrequency(1);
            $this->progressBar->start();
        }
    }

    /**
     * Return Progress Bar.
     *
     * @return ProgressBar
     */
    protected function getProgressBar()
    {
        return $this->progressBar;
    }

    /**
     * Print the Progress Bar.
     *
     * @param OutputInterface $output
     * @param int             $itemsCount
     * @param int             $itemsMax
     */
    protected function printProgressBar(OutputInterface $output, $itemsCount, $itemsMax)
    {
        $this->createProgressBar($output, $itemsMax);
        $this->getProgressBar()->clear();
        $this->getProgressBar()->setProgress($itemsCount);
        $this->getProgressBar()->display();
        if ($itemsCount == $itemsMax) {
            $this->getProgressBar()->finish();
            $output->writeln('');
        }
    }

    /**
     * Custom message callback function.
     *
     * @param OutputInterface $output
     */
    public function messageCallback(OutputInterface $output)
    {
        return function ($code, $message = '', $itemsCount = 0, $itemsMax = 0) use ($output) {
            if ($this->quiet) {

The property quiet does not exist. Did you maybe forget to declare it?

                return;
            } else {
                if (strpos($code, '_PROGRESS') !== false) {
                    if ($output->isVerbose()) {
                        if ($itemsCount > 0) {
                            $output->writeln(sprintf(' (%u/%u) %s', $itemsCount, $itemsMax, $message));

                            return;
                        }
                        $output->writeln("<info>$message</info>");
                    } else {
                        if (isset($itemsCount) && $itemsMax > 0) {
                            $this->printProgressBar($output, $itemsCount, $itemsMax);
                        } else {
                            $output->writeln("$message");
                        }
                    }
                } elseif (strpos($code, '_ERROR') !== false) {
                    $output->writeln("<error>$message</error>");
                } elseif ($code == 'TIME') {
                    $output->writeln("<comment>$message</comment>");
                } else {
                    $output->writeln("<info>$message</info>");
                }
            }
        };
    }
}