Question::ask() - Code Metrics - Inspection of "adding choice question" - theaentmachine/aent-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#37)

by Julien

created 2018-07-18 12:10 UTC

Question::ask() F

↳ Parent: Question

Complexity

Conditions	20
Paths	162

Size

Total Lines	66
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	20
eloc	43
nc	162
nop	0
dl	0
loc	66
rs	3.65
c	0
b	0
f	0

How to fix Long Method Complexity

<?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|null */
    private $validator;

    /** @var string|null */
    private $helpText;

    /** @var bool  */
    private $yesNoQuestion = false;

    /** @var bool */
    private $choiceQuestion = false;

    /** @var mixed[] */
    private $choices;

    /** @var bool */
    private $multiselectQuestion = 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;
    }

    /**
     * @param mixed[] $choices
     * @param bool $multiselect
     * @return Question
     */
    public function choiceQuestion(array $choices, bool $multiselect = false): self
    {
        $this->choiceQuestion = true;
        $this->choices = $choices;
        $this->multiselectQuestion = $multiselect;
        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 {
                throw new \InvalidArgumentException('Default value must be "y" or "n".');
            }
        } elseif ($this->yesNoQuestion) {
            $text .= ' [y/n]';
        }
        $text .= ': ';


        $question = $this->choiceQuestion ? new \Symfony\Component\Console\Question\ChoiceQuestion($text, $this->choices, $this->default) : new \Symfony\Component\Console\Question\Question($text, $this->default);

        $validator = $this->validator;

        if ($this->yesNoQuestion) {
            $validator = function (?string $response) use ($validator) {
                $response = $response ?? '';
                $response = \strtolower(trim($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) {
                $response = $response ?? '';
                if (trim($response) === '?') {
                    $this->output->writeln($this->helpText ?: '');
                    return '?';
                }
                return $validator ? $validator($response) : $response;
            };
        }

        if ($this->compulsory) {
            $validator = function (?string $response) use ($validator) {
                $response = $response ?? '';
                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
3			namespace TheAentMachine\Helper;
4
5			use Symfony\Component\Console\Helper\QuestionHelper;
6			use Symfony\Component\Console\Input\InputInterface;
7			use Symfony\Component\Console\Output\OutputInterface;
8
9			/**
10			* A helper class to easily create questions.
11			*/
12			class Question
13			{
14			/** @var QuestionHelper */
15			private $helper;
16
17			/** @var InputInterface */
18			private $input;
19
20			/** @var OutputInterface */
21			private $output;
22
23			/** @var string */
24			private $question;
25
26			/** @var string\|null */
27			private $default;
28
29			/** @var bool */
30			private $compulsory = false;
31
32			/** @var callable\|null */
33			private $validator;
34
35			/** @var string\|null */
36			private $helpText;
37
38			/** @var bool */
39			private $yesNoQuestion = false;
40
41			/** @var bool */
42			private $choiceQuestion = false;
43
44			/** @var mixed[] */
45			private $choices;
46
47			/** @var bool */
48			private $multiselectQuestion = 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			/**
89			* @param mixed[] $choices
90			* @param bool $multiselect
91			* @return Question
92			*/
93			public function choiceQuestion(array $choices, bool $multiselect = false): self
94			{
95			$this->choiceQuestion = true;
96			$this->choices = $choices;
97			$this->multiselectQuestion = $multiselect;
98			return $this;
99			}
100
101			public function ask(): string
102			{
103			$text = $this->question;
104			if ($this->helpText) {
105			$text .= ' (? for help)';
106			}
107			if ($this->default) {
108			if (!$this->yesNoQuestion) {
109			$text .= ' [' . $this->default . ']';
110			} elseif ($this->default === 'y') {
111			$text .= ' [Y/n]';
112			} elseif ($this->default === 'n') {
113			$text .= ' [y/N]';
114			} else {
115			throw new \InvalidArgumentException('Default value must be "y" or "n".');
116			}
117			} elseif ($this->yesNoQuestion) {
118			$text .= ' [y/n]';
119			}
120			$text .= ': ';
121
122
123			$question = $this->choiceQuestion ? new \Symfony\Component\Console\Question\ChoiceQuestion($text, $this->choices, $this->default) : new \Symfony\Component\Console\Question\Question($text, $this->default);
124
125			$validator = $this->validator;
126
127			if ($this->yesNoQuestion) {
128			$validator = function (?string $response) use ($validator) {
129			$response = $response ?? '';
130			$response = \strtolower(trim($response));
131			if (!\in_array($response, ['y', 'n', 'yes', 'no'])) {
132			throw new \InvalidArgumentException('Answer must be "y" or "n"');
133			}
134			$response = \in_array($response, ['y', 'yes']) ? '1' : '';
135			return $validator ? $validator($response) : $response;
136			};
137			}
138
139			if ($this->helpText !== null) {
140			$validator = function (?string $response) use ($validator) {
141			$response = $response ?? '';
142			if (trim($response) === '?') {
143			$this->output->writeln($this->helpText ?: '');
144			return '?';
145			}
146			return $validator ? $validator($response) : $response;
147			};
148			}
149
150			if ($this->compulsory) {
151			$validator = function (?string $response) use ($validator) {
152			$response = $response ?? '';
153			if (trim($response) === '') {
154			throw new \InvalidArgumentException('This field is compulsory.');
155			}
156			return $validator ? $validator($response) : $response;
157			};
158			}
159
160			$question->setValidator($validator);
161
162			do {
163			$answer = $this->helper->ask($this->input, $this->output, $question);
164			} while ($this->helpText !== null && $answer === '?');
165
166			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...
167			}
168			}
169

theaentmachine / aent-console

Pull Request — master (#37)

Question::ask() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like