eddiriarte / console-select

src/Handlers/SelectHandler.php

<?php

This file is missing a doc comment.

The PHP open tag does not have a corresponding PHP close tag

Filename "SelectHandler.php" doesn't match the expected filename "selecthandler.php"

namespace EddIriarte\Console\Handlers;

Missing file doc comment

use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Terminal;
use EddIriarte\Console\Inputs\Interfaces\SelectInput;

/**
 * Class SelectHandler
 * @package Lazzier\Helpers

@package tag is not allowed in class comment

There must be exactly one blank line before the tags in a doc comment

 * @author Eduardo Iriarte <eddiriarte[at]gmail[dot]com>

@author tag is not allowed in class comment

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value indented incorrectly; expected 2 spaces but found 1

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class SelectHandler
{

Opening brace should be on the same line as the declaration for class SelectHandler

    /**

Missing short description in doc comment

     * @var resource
     */
    protected $stream;

Protected member variable "stream" must contain a leading underscore

Expected 1 blank line before member var; 0 found

    /**

Missing short description in doc comment

     * @var OutputInterface
     */
    protected $output;

Protected member variable "output" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var SelectInput
     */
    protected $question;

Protected member variable "question" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var int

Expected "integer" but found "int" for @var tag in member variable comment

     */
    protected $row;

Protected member variable "row" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var int

Expected "integer" but found "int" for @var tag in member variable comment

     */
    protected $column;

Protected member variable "column" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var bool

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    protected $firstRun;

Protected member variable "firstRun" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var int

Expected "integer" but found "int" for @var tag in member variable comment

     */
    protected $terminalWidth;

Protected member variable "terminalWidth" must contain a leading underscore

    /**

Parameter $stream should have a doc-comment as per coding-style.

     * SelectStreamHandler constructor.
     * @param SelectInput $question

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

     * @param OutputInterface $output

Missing parameter comment

     * @param $stream

Missing parameter name

     */
    public function __construct(SelectInput $question, OutputInterface $output, $stream)

Expected 2 blank lines before function; 1 found

Type hint "stream" missing for

    {

Opening brace should be on the same line as the declaration

        $this->row = 0;

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $this->column = 0;

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $this->question = $question;
        $this->output = $output;

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $this->stream = $stream;

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**
     * Navigates through option items.
     *
     * @return array
     */
    public function handle(): array
    {

Opening brace should be on the same line as the declaration

        $this->firstRun = true;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of true please use TRUE.

        $this->output->writeln(
            '<info>' . $this->question->getMessage() . '</info> [<comment>SPACE=select</>, <comment>ENTER=submit</>]'

Concat operator must not be surrounded by spaces

        );
        $this->repaint();

        $sttyMode = shell_exec('stty -g');

        // Disable icanon (so we can fread each keypress) and echo (we'll do echoing here instead)

Inline comments must end in full-stops, exclamation marks, or question marks

        shell_exec('stty -icanon -echo');

        // Read a keypress

Inline comments must end in full-stops, exclamation marks, or question marks

        while (!feof($this->stream)) {

There must be a single space after a NOT operator; 0 found

            $char = fread($this->stream, 1);
            if (" " === $char) {

The string literal does not require double quotes, as per coding-style, please use single quotes.

                $this->tryCellSelection();
            } elseif ("\033" === $char) {

Usage of ELSEIF not allowed; use ELSE IF instead

                $this->tryCellNavigation($char);
            } elseif (10 === ord($char)) {

Usage of ELSEIF not allowed; use ELSE IF instead

                //TODO handle valid state...

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

No space found before comment text; expected "// TODO handle valid state..." but found "//TODO handle valid state..."

                $this->clear();
                $this->output->write('> ' . join(', ', $this->question->getSelections()));

Concat operator must not be surrounded by spaces

                $this->output->write($char);
                break;
            }
            $this->repaint();
        }

        // Reset stty so it behaves normally again

Inline comments must end in full-stops, exclamation marks, or question marks

        shell_exec(sprintf('stty %s', $sttyMode));

        $this->output->writeln(' ');

        return $this->question->getSelections();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end handle()

    /**

Missing short description in doc comment

Parameter $row should have a doc-comment as per coding-style.

Parameter $column should have a doc-comment as per coding-style.

     * @param $row

Missing parameter name

     * @param $column

Missing parameter name

     * @return bool

Expected "boolean" but found "bool" for function return type

     */
    public function exists($row, $column): bool

Type hint "row" missing for

Type hint "column" missing for

    {

Opening brace should be on the same line as the declaration

        return $this->question->hasEntryAt($row, $column);

The method hasEntryAt() does not exist on EddIriarte\Console\Inputs\Interfaces\SelectInput. Since it exists in all sub-types, consider adding an abstract or default implementation to EddIriarte\Console\Inputs\Interfaces\SelectInput.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end exists()

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    protected function up(): void
    {

Opening brace should be on the same line as the declaration

        if ($this->exists($this->row - 1, $this->column)) {

Arithmetic operation must be bracketed

            $this->row -= 1;
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end up()

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    protected function down(): void
    {

Opening brace should be on the same line as the declaration

        if ($this->exists($this->row + 1, $this->column)) {

Arithmetic operation must be bracketed

            $this->row += 1;
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end down()

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    protected function left(): void
    {

Opening brace should be on the same line as the declaration

        if ($this->exists($this->row, $this->column - 1)) {

Arithmetic operation must be bracketed

            $this->column -= 1;
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end left()

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    protected function right(): void
    {

Opening brace should be on the same line as the declaration

        if ($this->exists($this->row, $this->column + 1)) {

Arithmetic operation must be bracketed

            $this->column += 1;
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end right()

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    protected function tryCellSelection(): void
    {

Opening brace should be on the same line as the declaration

        // Try to select cell.
        if ($this->exists($this->row, $this->column)) {
            $option = $this->question->getEntryAt($this->row, $this->column);

The method getEntryAt() does not exist on EddIriarte\Console\Inputs\Interfaces\SelectInput. Since it exists in all sub-types, consider adding an abstract or default implementation to EddIriarte\Console\Inputs\Interfaces\SelectInput.

            $this->question->select($option);
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end tryCellSelection()

    /**

Missing short description in doc comment

Parameter $char should have a doc-comment as per coding-style.

     * @param $char

Missing parameter name

     */

Missing @return tag in function comment

    protected function tryCellNavigation($char): void

Type hint "char" missing for

    {

Opening brace should be on the same line as the declaration

        // Did we read an escape sequence?
        $char .= fread($this->stream, 2);
        if (empty($char[2]) || !in_array($char[2], ['A', 'B', 'C', 'D'])) {

There must be a single space after a NOT operator; 0 found

Short array syntax is not allowed

            // Input stream was not an arrow key.
            return;
        }

        switch ($char[2]) {

All SWITCH statements must contain a DEFAULT case

            case 'A': // go up!

Line indented incorrectly; expected 8 spaces, found 12

Blank lines are not allowed after CASE statements

Comments may not appear after statements

Inline comments must start with a capital letter

                $this->up();
                break;

Case breaking statement must be indented 4 spaces from SWITCH keyword

Case breaking statements must be followed by a single blank line

            case 'B': // go down!

Line indented incorrectly; expected 8 spaces, found 12

Blank lines are not allowed after CASE statements

Comments may not appear after statements

Inline comments must start with a capital letter

                $this->down();
                break;

Case breaking statement must be indented 4 spaces from SWITCH keyword

Case breaking statements must be followed by a single blank line

            case 'C': // go right!

Line indented incorrectly; expected 8 spaces, found 12

Blank lines are not allowed after CASE statements

Comments may not appear after statements

Inline comments must start with a capital letter

                $this->right();
                break;

Case breaking statement must be indented 4 spaces from SWITCH keyword

Case breaking statements must be followed by a single blank line

            case 'D': // go left!

Line indented incorrectly; expected 8 spaces, found 12

Blank lines are not allowed after CASE statements

Comments may not appear after statements

Inline comments must start with a capital letter

                $this->left();
                break;

Case breaking statement must be indented 4 spaces from SWITCH keyword

        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end tryCellNavigation()

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    public function repaint(): void
    {

Opening brace should be on the same line as the declaration

        $message = $this->message();
        if (!$this->firstRun) {

There must be a single space after a NOT operator; 0 found

            $this->clear();
        }

        $this->firstRun = false;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

        $this->output->write($message);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end repaint()

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    public function clear(): void
    {

Opening brace should be on the same line as the declaration

        // Move the cursor to the beginning of the line

Inline comments must end in full-stops, exclamation marks, or question marks

        $this->output->write("\x0D");
        // Erase the line

Inline comments must end in full-stops, exclamation marks, or question marks

        $this->output->write("\x1B[2K");
        // Erase previous lines

Inline comments must end in full-stops, exclamation marks, or question marks

        $lines = $this->question->getChunksCount() - 1;

The method getChunksCount() does not exist on EddIriarte\Console\Inputs\Interfaces\SelectInput. Since it exists in all sub-types, consider adding an abstract or default implementation to EddIriarte\Console\Inputs\Interfaces\SelectInput.

Arithmetic operation must be bracketed

        if ($lines > 0) {
            $this->output->write(str_repeat("\x1B[1A\x1B[2K", $lines));
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end clear()

    /**

Missing short description in doc comment

     * @return string
     */
    protected function message(): string
    {

Opening brace should be on the same line as the declaration

        $chunkSize = $this->chunkSize();

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $chunks = $this->question->getChunks($chunkSize);

The method getChunks() does not exist on EddIriarte\Console\Inputs\Interfaces\SelectInput. Since it exists in all sub-types, consider adding an abstract or default implementation to EddIriarte\Console\Inputs\Interfaces\SelectInput.

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $columnSpace = floor(($this->terminalWidth() - ($chunkSize * 5)) / $chunkSize);
        return join(PHP_EOL, array_map(function ($entries) use ($chunks, $columnSpace) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            $hasCursor = (bool) ($this->row === array_search($entries, $chunks));

The value of a comparison must not be assigned to a variable

A cast statement should not be followed as per the coding-style.

            return $this->makeRow($entries, ($hasCursor ? $this->column : -10), $columnSpace);

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

$columnSpace of type double is incompatible with the type integer expected by parameter $columnSpace of EddIriarte\Console\Handlers\SelectHandler::makeRow().

        }, $chunks));

For multi-line function calls, the closing parenthesis should be on a new line.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end message()

    /**

Missing short description in doc comment

Parameter $columnSpace should have a doc-comment as per coding-style.

     * @param array $entries

Missing parameter comment

     * @param int $activeColumn

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

Expected "integer" but found "int" for parameter type

     * @return mixed
     */
    protected function makeRow(array $entries, int $activeColumn, int $columnSpace)
    {

Opening brace should be on the same line as the declaration

        return array_reduce($entries, function ($carry, $item) use ($entries, $activeColumn, $columnSpace) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            $isActive = ($activeColumn === array_search($item, $entries));

The value of a comparison must not be assigned to a variable

            return $carry . $this->makeCell($item, $isActive, $columnSpace);

Concat operator must not be surrounded by spaces

        }, '');

For multi-line function calls, the closing parenthesis should be on a new line.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end makeRow()

    /**

Missing short description in doc comment

     * @param string $option

Missing parameter comment

     * @param bool $hasCursor

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

Expected "boolean" but found "bool" for parameter type

     * @param int $maxWidth

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

Expected "integer" but found "int" for parameter type

     * @return string
     */
    protected function makeCell(string $option, bool $hasCursor = false, int $maxWidth = 20): string

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

    {

Opening brace should be on the same line as the declaration

        $selected = $this->question->isSelected($option);
        $name = substr($option, 0, ($maxWidth - 1));

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

        return sprintf(
            $hasCursor ? ' <hl> %1$s %2$s </hl>' : ' <%3$s> %1$s %2$s </%3$s>',

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

            ($selected ? '●' : '○'),

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

            $name . str_repeat(' ', $maxWidth - mb_strlen($name)),

Concat operator must not be surrounded by spaces

Arithmetic operation must be bracketed

            ($selected ? 'info' : 'comment')

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

        );
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end makeCell()

    public function terminalWidth()

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        return (new Terminal)->getWidth();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end terminalWidth()

    public function chunkSize()

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $max = $this->terminalWidth();

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

        $largest = array_reduce($this->question->getOptions(), 'max', 0);

        if ($largest > ($max / 2)) {
            return 1;
        } elseif ($largest > ($max / 3)) {

Usage of ELSEIF not allowed; use ELSE IF instead

            return 2;
        } else {
            return 3;
        }
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end chunkSize()

}

Expected //end class

As per coding style, files should not end with a newline character.