Graviton\Deployment\Command\AbstractCommand

Complexity

Total Complexity

8

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

80.77%

Importance

Changes	7
Bugs	3	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	execute()	0	10	1
A	getStartMessage()	0	8	2
A	getStep()	0	8	2
A	addStep()	0	6	1
A	setStartMessage()	0	6	1

<?php
/**
 * base command
 */
namespace Graviton\Deployment\Command;

use Graviton\Deployment\Configuration;
use Graviton\Deployment\Deployment;
use Graviton\Deployment\Steps\StepInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Process\ProcessBuilder;

/**
 * @author   List of contributors <https://github.com/libgraviton/deploy-scripts/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
abstract class AbstractCommand extends Command
{
    /**
     * @var array configuration settings for the application.
     */
    protected $configuration;

    /** @var StepInterface[] */
    protected $steps;

    /** @var string */
    protected $message;

    /**
     * Constructor.
     *
     * @param Configuration $configuration current application configuration loader.
     * @param string|null   $name          The name of the command;
     *                                     passing null means it must be set in configure()
     *
     */
    public function __construct(Configuration $configuration, $name = null)
    {
        parent::__construct($name);

        $this->configuration = $configuration->load();
    }

    /**
     * Executes the current command.
     *
     * @param InputInterface  $input  An InputInterface instance
     * @param OutputInterface $output Output of the command
     *
     * @return void
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $output->writeln($this->getStartMessage());

        $deployment = new Deployment(new ProcessBuilder());
        $deployment->registerSteps($this->steps);

        $output->write($deployment->deploy());
        $output->writeln('... done');
    }

    /**
     * Provides the previous defined message.
     *
     * @return string
     *
     * @throws \LogicException in case no message was set.
     */
    public function getStartMessage()
    {
        if (empty($this->message)) {
            throw new \LogicException('The console message must not be empty!');
        }

        return $this->message;
    }

    /**
     * Set the content of the start message.
     *
     * @param string $message Start message.
     *
     * @return $this
     */
    public function setStartMessage($message)
    {
        $this->message = $message;

        return $this;
    }

    /**
     * Provides the defined
     *
     * @return StepInterface[]
     *
     * @throws \LogicException in case no step was set.
     */
    public function getStep()
    {
        if (empty($this->steps)) {
            throw new \LogicException('The command step must not be empty!');
        }

        return $this->steps;
    }

    /**
     * Adds a step to the set of steps to be executed.
     *
     * @param StepInterface $step Step to be executed
     *
     * @return $this
     */
    public function addStep(StepInterface $step)
    {
        $this->steps[] = $step;

        return $this;
    }
}