Valkyrja\Cli\Interaction\Message\Question

Complexity

Total Complexity

12

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	fopen()	0	3	1
A	fgets()	0	3	1
A	ask()	0	25	4
A	getAnswer()	0	4	1
A	__construct()	0	11	2
A	withAnswer()	0	8	1
A	getCallable()	0	4	1
A	withCallable()	0	8	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Valkyrja Framework package.
 *
 * (c) Melech Mizrachi <melechmizrachi@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valkyrja\Cli\Interaction\Message;

use Override;

The type Override was not found. Maybe you did not declare it correctly or list all dependencies?

use Valkyrja\Cli\Interaction\Exception\InvalidArgumentException;
use Valkyrja\Cli\Interaction\Formatter\Contract\Formatter;
use Valkyrja\Cli\Interaction\Formatter\QuestionFormatter;
use Valkyrja\Cli\Interaction\Message\Contract\Answer;

This use statement conflicts with another class in this namespace, Valkyrja\Cli\Interaction\Message\Answer. Consider defining an alias.

use Valkyrja\Cli\Interaction\Message\Contract\Question as Contract;
use Valkyrja\Cli\Interaction\Output\Contract\Output;

use function fgets;
use function fopen;
use function is_callable;

/**
 * Class Question.
 *
 * @author Melech Mizrachi
 */
class Question extends Message implements Contract
{
    /**
     * @param non-empty-string                $text     The text

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param callable(Output, Answer):Output $callable The callable
     */
    public function __construct(
        string $text,
        protected $callable,
        protected Answer $answer,
        Formatter|null $formatter = new QuestionFormatter()
    ) {
        if (! is_callable($this->callable)) {
            throw new InvalidArgumentException('$callable must be a valid callable');
        }

        parent::__construct($text, $formatter);
    }

    /**
     * @inheritDoc
     */
    #[Override]
    public function getCallable(): callable
    {
        return $this->callable;
    }

    /**
     * @inheritDoc
     */
    #[Override]
    public function withCallable(callable $callable): static
    {
        $new = clone $this;

        $new->callable = $callable;

        return $new;
    }

    /**
     * @inheritDoc
     */
    #[Override]
    public function getAnswer(): Answer
    {
        return $this->answer;
    }

    /**
     * @inheritDoc
     */
    #[Override]
    public function withAnswer(Answer $answer): static
    {
        $new = clone $this;

        $new->answer = $answer;

        return $new;
    }

    /**
     * @inheritDoc
     */
    #[Override]
    public function ask(): Answer
    {
        $answer = $this->answer;
        $handle = $this->fopen(filename: 'php://stdin', mode: 'rb');

        if ($handle === false) {
            // TODO: Determine if we want to throw RuntimeException (UnhandledStreamQuestionException) here
            return $answer;
        }

        $line = $this->fgets($handle);

        if ($line === false) {
            // TODO: Determine if we want to throw RuntimeException (UnhandledLineQuestionException) here
            return $answer;
        }

        $response = trim($line);

        if ($response === '') {
            return $answer;
        }

        return $answer->withUserResponse($response);
    }

    /**
     * @param non-empty-string $filename The filename to open

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param non-empty-string $mode     The mode
     *
     * @return resource|false
     */
    protected function fopen(string $filename, string $mode)
    {
        return fopen(filename: $filename, mode: $mode);
    }

    /**
     * @param resource $stream The stream
     */
    protected function fgets($stream): string|false
    {
        return fgets($stream);
    }
}