Question::compulsory() - Code Metrics - Inspection of "Merge pull request #26 from moufmouf/questions_hel..." - theaentmachine/aent-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 02bfd3...3a9941 )

by David

created 2018-06-25 14:17 UTC

Question::compulsory() A

↳ Parent: Question

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
namespace TheAentMachine\Helper;

use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * A helper class to easily create questions.
 */
class Question
{
    /**
     * @var QuestionHelper
     */
    private $helper;
    /**
     * @var InputInterface
     */
    private $input;
    /**
     * @var OutputInterface
     */
    private $output;
    /**
     * @var string
     */
    private $question;
    /**
     * @var string|null
     */
    private $default;
    /**
     * @var bool
     */
    private $compulsory = false;
    /**
     * @var callable
     */
    private $validator;
    /**
     * @var string|null
     */
    private $helpText;
    /**
     * @var bool
     */
    private $yesNoQuestion = false;

    public function __construct(QuestionHelper $helper, InputInterface $input, OutputInterface $output, string $question)
    {
        $this->helper = $helper;
        $this->input = $input;
        $this->output = $output;
        $this->question = $question;
    }

    public function compulsory(): self
    {
        $this->compulsory = true;
        return $this;
    }

    public function setValidator(callable $validator): self
    {
        $this->validator = $validator;
        return $this;
    }

    public function setHelpText(string $helpText): self
    {
        $this->helpText = $helpText;
        return $this;
    }

    public function setDefault(string $default): self
    {
        $this->default = $default;
        return $this;
    }

    public function yesNoQuestion(): self
    {
        $this->yesNoQuestion = true;
        return $this;
    }

    public function ask(): string
    {
        $text = $this->question;
        if ($this->helpText) {
            $text .= ' (? for help)';
        }
        if ($this->default) {
            if (!$this->yesNoQuestion) {
                $text .= ' ['.$this->default.']';
            } elseif ($this->default === 'y') {
                $text .= ' [Y/n]';
            } elseif ($this->default === 'n') {
                $text .= ' [y/N]';
            } else {
                $text .= ' [y/n]';
            }
        }
        $text .= ': ';

        $question = new \Symfony\Component\Console\Question\Question($text, $this->default);

        $validator = $this->validator;

        if ($this->yesNoQuestion) {
            $validator = function (?string $response) use ($validator) {
                $response = trim(\strtolower($response));
                if (!\in_array($response, ['y', 'n', 'yes', 'no'])) {
                    throw new \InvalidArgumentException('Answer must be "y" or "n"');
                }
                $response = \in_array($response, ['y', 'yes']) ? '1' : '';
                return $validator ? $validator($response) : $response;
            };
        }

        if ($this->helpText !== null) {
            $validator = function (?string $response) use ($validator) {
                if (trim($response) === '?') {
                    $this->output->writeln($this->helpText ?: '');
                    return '?';
                }
                return $validator ? $validator($response) : $response;
            };
        }

        if ($this->compulsory) {
            $validator = function (?string $response) use ($validator) {
                if (trim($response) === '') {
                    throw new \InvalidArgumentException('This field is compulsory.');
                }
                return $validator ? $validator($response) : $response;
            };
        }

        $question->setValidator($validator);

        do {
            $answer = $this->helper->ask($this->input, $this->output, $question);
        } while ($this->helpText !== null && $answer === '?');

        return $answer;

    }
}


1			<?php
2			namespace TheAentMachine\Helper;
3
4			use Symfony\Component\Console\Helper\QuestionHelper;
5			use Symfony\Component\Console\Input\InputInterface;
6			use Symfony\Component\Console\Output\OutputInterface;
7
8			/**
9			* A helper class to easily create questions.
10			*/
11			class Question
12			{
13			/**
14			* @var QuestionHelper
15			*/
16			private $helper;
17			/**
18			* @var InputInterface
19			*/
20			private $input;
21			/**
22			* @var OutputInterface
23			*/
24			private $output;
25			/**
26			* @var string
27			*/
28			private $question;
29			/**
30			* @var string\|null
31			*/
32			private $default;
33			/**
34			* @var bool
35			*/
36			private $compulsory = false;
37			/**
38			* @var callable
39			*/
40			private $validator;
41			/**
42			* @var string\|null
43			*/
44			private $helpText;
45			/**
46			* @var bool
47			*/
48			private $yesNoQuestion = false;
49
50			public function __construct(QuestionHelper $helper, InputInterface $input, OutputInterface $output, string $question)
51			{
52			$this->helper = $helper;
53			$this->input = $input;
54			$this->output = $output;
55			$this->question = $question;
56			}
57
58			public function compulsory(): self
59			{
60			$this->compulsory = true;
61			return $this;
62			}
63
64			public function setValidator(callable $validator): self
65			{
66			$this->validator = $validator;
67			return $this;
68			}
69
70			public function setHelpText(string $helpText): self
71			{
72			$this->helpText = $helpText;
73			return $this;
74			}
75
76			public function setDefault(string $default): self
77			{
78			$this->default = $default;
79			return $this;
80			}
81
82			public function yesNoQuestion(): self
83			{
84			$this->yesNoQuestion = true;
85			return $this;
86			}
87
88			public function ask(): string
89			{
90			$text = $this->question;
91			if ($this->helpText) {
92			$text .= ' (? for help)';
93			}
94			if ($this->default) {
95			if (!$this->yesNoQuestion) {
96			$text .= ' ['.$this->default.']';
97			} elseif ($this->default === 'y') {
98			$text .= ' [Y/n]';
99			} elseif ($this->default === 'n') {
100			$text .= ' [y/N]';
101			} else {
102			$text .= ' [y/n]';
103			}
104			}
105			$text .= ': ';
106
107			$question = new \Symfony\Component\Console\Question\Question($text, $this->default);
108
109			$validator = $this->validator;
110
111			if ($this->yesNoQuestion) {
112			$validator = function (?string $response) use ($validator) {
113			$response = trim(\strtolower($response));
114			if (!\in_array($response, ['y', 'n', 'yes', 'no'])) {
115			throw new \InvalidArgumentException('Answer must be "y" or "n"');
116			}
117			$response = \in_array($response, ['y', 'yes']) ? '1' : '';
118			return $validator ? $validator($response) : $response;
119			};
120			}
121
122			if ($this->helpText !== null) {
123			$validator = function (?string $response) use ($validator) {
124			if (trim($response) === '?') {
125			$this->output->writeln($this->helpText ?: '');
126			return '?';
127			}
128			return $validator ? $validator($response) : $response;
129			};
130			}
131
132			if ($this->compulsory) {
133			$validator = function (?string $response) use ($validator) {
134			if (trim($response) === '') {
135			throw new \InvalidArgumentException('This field is compulsory.');
136			}
137			return $validator ? $validator($response) : $response;
138			};
139			}
140
141			$question->setValidator($validator);
142
143			do {
144			$answer = $this->helper->ask($this->input, $this->output, $question);
145			} while ($this->helpText !== null && $answer === '?');
146
147			return $answer;
			0 ignored issues – show Bug Best Practice introduced 2018-06-25 13:30 UTC by Report Bug Copy Issue Report The expression `return $answer` could return the type `null\|boolean` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
148			}
149			}
150

theaentmachine / aent-console

Push — master ( 02bfd3...3a9941 )

Question::compulsory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like