Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput

Complexity

Total Complexity

18

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	executeProcess()	0	27	7
A	echo()	0	9	3
A	note()	0	3	1
A	box()	0	8	2
A	executeArtisanProcess()	0	18	5

<?php

namespace Backpack\CRUD\app\Console\Commands\Traits;

use Artisan;
use Illuminate\Console\Command;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Symfony\Component\Process\Process;

trait PrettyCommandOutput
{
    /**
     * Run a SSH command.
     *
     * @param  string  $command  The SSH command that needs to be run
     * @param  bool  $beforeNotice  Information for the user before the command is run
     * @param  bool  $afterNotice  Information for the user after the command is run
     * @return mixed Command-line output
     */
    public function executeProcess($command, $beforeNotice = false, $afterNotice = false)
    {
        $this->echo('info', $beforeNotice ? ' '.$beforeNotice : implode(' ', $command));

$command of type string is incompatible with the type array expected by parameter $pieces of implode().

Are you sure $beforeNotice of type true can be used in concatenation?

        // make sure the command is an array as per Symphony 4.3+ requirement
        $command = is_string($command) ? explode(' ', $command) : $command;

The condition is_string($command) is always true.

        $process = new Process($command, null, null, null, $this->option('timeout'));

It seems like option() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $process->run(function ($type, $buffer) {
            if (Process::ERR === $type) {
                $this->echo('comment', $buffer);
            } else {
                $this->echo('line', $buffer);
            }
        });

        // executes after the command finishes
        if (! $process->isSuccessful()) {
            throw new ProcessFailedException($process);
        }

        if ($this->progressBar) {
            $this->progressBar->advance();
        }

        if ($afterNotice) {
            $this->echo('info', $afterNotice);

$afterNotice of type true is incompatible with the type string expected by parameter $content of Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput::echo().

        }
    }

    /**
     * Run an artisan command.
     *
     * @param  string  $command  The artisan command to be run.
     * @param  array  $arguments  Key-value array of arguments to the artisan command.
     * @param  bool  $beforeNotice  Information for the user before the command is run
     * @param  bool  $afterNotice  Information for the user after the command is run
     * @return mixed Command-line output
     */
    public function executeArtisanProcess($command, $arguments = [], $beforeNotice = false, $afterNotice = false)
    {
        $beforeNotice = $beforeNotice ? ' '.$beforeNotice : 'php artisan '.implode(' ', (array) $command).' '.implode(' ', $arguments);

Are you sure $beforeNotice of type true can be used in concatenation?

        $this->echo('info', $beforeNotice);

        try {
            Artisan::call($command, $arguments);
        } catch (Exception $e) {

The type Backpack\CRUD\app\Console\Commands\Traits\Exception was not found. Did you mean Exception? If so, make sure to prefix the type with \.

            throw new ProcessFailedException($e);
        }

        if ($this->progressBar) {
            $this->progressBar->advance();
        }

        if ($afterNotice) {
            $this->echo('info', $afterNotice);

$afterNotice of type true is incompatible with the type string expected by parameter $content of Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput::echo().

        }
    }

    /**
     * Write text to the screen for the user to see.
     *
     * @param  string  $type  line, info, comment, question, error
     * @param  string  $content
     */
    public function echo($type, $content)
    {
        if ($this->option('debug') == false) {
            return;
        }

        // skip empty lines
        if (trim($content)) {
            $this->{$type}($content);
        }
    }

    /**
     * Write a title inside a box.
     *
     * @param  string  $content
     */
    public function box($content)
    {
        for ($i = 0, $line = ''; $i < strlen($content); ++$i, $line .= '─');

        $this->line('');

It seems like line() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->info("┌───{$line}───┐");

It seems like info() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->info("│   $content   │");
        $this->info("└───{$line}───┘");
    }

    /**
     * Write a title inside a box.
     *
     * @param  string  $content
     */
    public function note($content)
    {
        $this->line("│ $content");
    }
}