Webcreate\Conveyor\Task\SshTask

Complexity

Total Complexity

13

Size/Duplication

Total Lines	87
Duplicated Lines	18.39 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	1	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setTransporter()	0	8	2
B	execute()	16	36	6
A	simulate()	0	6	1
A	getCommand()	0	12	3

<?php

/*
 * This file is part of the Conveyor package.
 *
 * (c) Jeroen Fiege <jeroen@webcreate.nl>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webcreate\Conveyor\Task;

use Webcreate\Conveyor\DependencyInjection\TransporterAwareInterface;
use Webcreate\Conveyor\IO\IOInterface;
use Webcreate\Conveyor\Repository\Version;
use Webcreate\Conveyor\Transporter\AbstractTransporter;
use Webcreate\Conveyor\Transporter\SshCapableTransporterInterface;
use Webcreate\Conveyor\Util\FilePath;
use Webcreate\Util\Cli;

class SshTask extends Task implements TransporterAwareInterface
{
    /**
     * @var AbstractTransporter|SshCapableTransporterInterface
     */
    protected $transporter;

    public function __construct($config, Cli $cli, IOInterface $io)

Avoid variables with short names like $io. Configured minimum length is 3.

    {
        $this->config = $config;

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

        $this->cli    = $cli;

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

        $this->io     = $io;

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

    }

    public function setTransporter($transporter)
    {
        if (false === $transporter instanceof SshCapableTransporterInterface) {
            throw new \InvalidArgumentException(sprintf("Given transporter of type '%s' does not support SSH.", get_class($transporter)));
        }

        $this->transporter = $transporter;
    }

    /**
     * @todo improve output (also @see ShellTask)
     *
     * @param $target
     * @param  Version           $version
     * @throws \RuntimeException
     */
    public function execute($target, Version $version)
    {
        $command = $this->getCommand($target, $version, $this->options['command']);

        $this->output(sprintf('Executing: <comment>%s</comment>', $command));

        $hasOutput = false;

        $self = $this;
        $outputter = function ($buffer) use ($self, &$hasOutput) {

This code seems to be duplicated across your project.

            if (false === $self->io->isVerbose()) return;

Please always use braces to surround the code block of IF statements.

It is generally a best practice to always use braces with control structures.

            if (!$hasOutput) {
                $this->io->write('');
                $this->io->write('');
                $hasOutput = true;
            }

            $lines = explode("\n", $buffer);
            foreach ($lines as $line) {
                if ($output = trim($line, "\r\n")) {
                    $self->io->write(sprintf('> %s', $output));
                }
            }
        };

        if ($exitCode = $this->transporter->exec($command, $outputter) <> 0) {

The method exec does only exist in Webcreate\Conveyor\Transporter\SshCapableTransporterInterface, but not in Webcreate\Conveyor\Transporter\AbstractTransporter.

            throw new \RuntimeException(
                sprintf(
                    'The command "%s" failed.'."\nExit Code: %s",
                    $command,
                    $exitCode
                )
            );
        }
    }

    public function simulate($target, Version $version)
    {
        $command = $this->getCommand($target, $version, $this->options['command']);

        $this->output(sprintf('Executing: <comment>%s</comment>', $command));
    }

    protected function getCommand($target, $version, $command)

The parameter $target is not used and could be removed.

The parameter $version is not used and could be removed.

    {
        $basepath = $path = $this->transporter->getPath();

The method getPath does only exist in Webcreate\Conveyor\Transporter\AbstractTransporter, but not in Webcreate\Conveyor\Transporter\SshCapableTransporterInterface.

        if (isset($this->options['path']) && $this->options['path']) {
            $path = FilePath::join($basepath, $this->options['path']);
        }

        $command = sprintf('cd %s && %s', $path, $command);

Consider using a different name than the parameter $command. This often makes code more readable.

        return $command;
    }
}