terminal\Terminal

Complexity

Total Complexity

34

Size/Duplication

Total Lines	253
Duplicated Lines	0 %

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	info()	0	8	2
A	expectParams()	0	5	1
A	confirm()	0	19	2
A	getArguments()	0	3	1
A	forceOutput()	0	4	1
A	warning()	0	8	2
A	echo()	0	10	3
A	__construct()	0	9	1
A	diff()	0	24	5
A	setArguments()	0	3	1
A	requestSetting()	0	13	2
A	addBuffer()	0	3	1
A	success()	0	8	2
A	getBuffer()	0	3	1
A	error()	0	8	2
A	isAutocomplete()	0	5	2
A	exit()	0	3	1
A	parseArguments()	0	10	3
A	autocomplete()	0	5	1

<?php

namespace terminal;

/**
 * class for terminal/cli/bash output
 */
final class Terminal {
    private $buffer = [];
    private $argv;
    private $argc;
    private $arguments = [];

    public function __construct()
    {
        global $argv;
        global $argc;

        $this->argv = $argv;
        $this->argc = $argc;

        $this->parseArguments();
    }

    public function addBuffer(string $buffer)
    {
        $this->buffer[] = $buffer;
    }

    public function getBuffer(): string
    {
        return implode(PHP_EOL, $this->buffer);
    }

    public function echo(string $string, bool $to_buffer = false, bool $return = false)
    {
        if ($return) {
            return $string;
        }

        if ($to_buffer) {
            $this->addBuffer($string);
        } else {
            echo $string . PHP_EOL;
        }
    }

    public function diff(string $string, bool $to_buffer = false, bool $return = false)

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

    {
        $result_string = '';
        $separator = "\r\n";
        $line = strtok($string, $separator);

        while ($line !== false) {
            if (strpos($line, '-') === 0) {
                $result_string .= $this->error($line, false, true);
            } else if (strpos($line, '+') === 0) {
                $result_string .= $this->success($line, false, true);
            } else {
                $result_string .= $line;
            }

            $result_string .= PHP_EOL;

            $line = strtok($separator);
        }

        if ($to_buffer) {
            $this->setBuffer($result_string);

The method setBuffer() does not exist on terminal\Terminal.

        } else {
            echo $result_string;
        }
    }

    public function info(string $string, bool $to_buffer = false, bool $return = false)
    {
        $output = "\e[46m" . $string . "\e[0m";

        if ($return) {
            return $output;
        } else {
            $this->echo($output, $to_buffer);
        }
    }

    public function success(string $string, bool $to_buffer = false, bool $return = false)
    {
        $output = "\e[32m" . $string . "\e[0m";

        if ($return) {
            return $output;
        } else {
            $this->echo($output, $to_buffer);
        }
    }

    public function warning(string $string, bool $to_buffer = false, bool $return = false)
    {
        $output = "\e[43m" . $string . "\e[0m";

        if ($return) {
            return $output;
        } else {
            $this->echo($output, $to_buffer);
        }
    }

    public function error(string $string, bool $to_buffer = false, bool $return = false)
    {
        $output = "\e[1;31m" . $string . "\e[0m";

        if ($return) {
            return $output;
        } else {
            $this->echo($output, $to_buffer);
        }
    }

    public function forceOutput()
    {
        $this->echo(
            $this->getBuffer()
        );
    }

    /**
     * Requests user for confirm his action
     * 
     * @param callable $success_action
     * @param callable $cancel_action
     * @param string $question
     * @param string $confirmation_word
     */
    public function confirm(
        callable $success_action,
        callable $cancel_action = null,
        string $question = "Are you sure?\n Type 'Y' to continue: ",
        string $confirmation_word = 'Y'
    ): void
    {
        $this->warning($question);
        $handle = fopen('php://stdin', 'r');
        $line   = fgets($handle);

It seems like $handle can also be of type false; however, parameter $handle of fgets() does only seem to accept resource, maybe add an additional type check?

        if(trim($line) != $confirmation_word) {
            $this->warning('ABORTING');
            call_user_func($cancel_action);
            exit;

Using exit here is not recommended.

        }

        fclose($handle);

It seems like $handle can also be of type false; however, parameter $handle of fclose() does only seem to accept resource, maybe add an additional type check?

        call_user_func($success_action);
    }

    /**
     * Requests config item from user 
     */
    public function requestSetting(
        string $name,
        callable $result_action,
        $default = ''
    ): void
    {
        $this->echo("Please, set up $name");
        $handle = fopen('php://stdin', 'r');
        $line   = fgets($handle);

It seems like $handle can also be of type false; however, parameter $handle of fgets() does only seem to accept resource, maybe add an additional type check?

        $result = trim($line);

        call_user_func($result_action, $result ?: $default);
        fclose($handle);

It seems like $handle can also be of type false; however, parameter $handle of fclose() does only seem to accept resource, maybe add an additional type check?

    }

    public function expectParams(
        array $opts,

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

        callable $result_action

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

    )
    {
//         $options = getopt('', ['addon.id:']);
//         print_r($options);
// die();
//         $options = getopt(implode('', array_keys($opts)), $opts);
// print_r($options);
//         array_walk($options, function($option) use ($result_action) {
//             echo 2;
//             call_user_func($result_action, $option);
//         });
    }

    /**
     * Set arguments
     * 
     * @param array  $arguments
     * 
     * @return void
     */
    public function setArguments(array $arguments): void
    {
        $this->arguments = $arguments;
    }

    /**
     * Get arguments
     * 
     * @return array
     */
    public function getArguments(): array
    {
        return $this->arguments;
    }

    /**
     * Parse arguments from terminal to array
     * 
     * @return void
     */
    private function parseArguments(): void
    {
        $arguments = arguments(implode(' ', $this->argv));
        $controller = @$this->argv[1] ?: '';
        list($generator, $command) = array_pad(explode('/', $controller), 2, '');
        $generator = (1 === preg_match('/^[\w]+/ui', $generator)) ? $generator : '';

        $arguments['generator'] = to_camel_case($generator);
        $arguments['command'] = $command;
        $this->setArguments($arguments);
    }

    /**
     * Cheks is terminal at autocomplete mode
     * 
     * @return bool
     */
    public function isAutocomplete()
    {
        return (
            isset($this->arguments['autocomplete'])
            && $this->arguments['autocomplete'] === 'y'
        );
    }

    /**
     * Echo autocompletes to terminal
     * 
     * @param array
     * 
     * @return Terminal
     */
    public function autocomplete(array $variants)
    {
        $this->echo(implode(' ', $variants)) . ' ';

Are you sure the usage of $this->echo(implode(' ', $variants)) targeting terminal\Terminal::echo() seems to always return null.

        return $this;
    }

    /**
     * Closes program execution
     */
    public function exit()
    {
        exit;

Using exit here is not recommended.

    }
}