DefaultIO::getArguments() - Code Metrics - Inspection of "Make original arguments available via IO" - captainhook-git/captainhook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 41bfc2...176b02 )

by Sebastian

created 2019-02-16 22:22 UTC

DefaultIO::getArguments() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php
/**
 * This file is part of CaptainHook.
 *
 * (c) Sebastian Feldmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace CaptainHook\App\Console\IO;

use CaptainHook\App\Console\IO;
use CaptainHook\App\Console\IOUtil;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Helper\HelperSet;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Console\Question\Question;

/**
 * Class DefaultIO
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <[email protected]>
 * @link    https://github.com/captainhookphp/captainhook
 * @since   Class available since Release 0.9.0
 */
class DefaultIO extends Base
{
    /**
     * @var \Symfony\Component\Console\Input\InputInterface
     */
    protected $input;

    /**
     * @var \Symfony\Component\Console\Output\OutputInterface
     */
    protected $output;

    /**
     * @var \Symfony\Component\Console\Helper\HelperSet
     */
    protected $helperSet;

    /**
     * @var array
     */
    private $verbosityMap;

    /**
     * Constructor
     *
     * @param \Symfony\Component\Console\Input\InputInterface   $input
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     * @param \Symfony\Component\Console\Helper\HelperSet       $helperSet
     */
    public function __construct(InputInterface $input, OutputInterface $output, HelperSet $helperSet = null)
    {
        $this->input        = $input;
        $this->output       = $output;
        $this->helperSet    = $helperSet;
        $this->verbosityMap = [
            IO::QUIET        => OutputInterface::VERBOSITY_QUIET,
            IO::NORMAL       => OutputInterface::VERBOSITY_NORMAL,
            IO::VERBOSE      => OutputInterface::VERBOSITY_VERBOSE,
            IO::VERY_VERBOSE => OutputInterface::VERBOSITY_VERY_VERBOSE,
            IO::DEBUG        => OutputInterface::VERBOSITY_DEBUG
        ];
    }

    /**
     * Return the original cli arguments
     *
     * @return array
     */
    public function getArguments(): array
    {
        return $this->input->getArguments();
    }

    /**
     * {@inheritDoc}
     */
    public function isInteractive()
    {
        return $this->input->isInteractive();
    }

    /**
     * {@inheritDoc}
     */
    public function isVerbose()
    {
        return $this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE;
    }

    /**
     * {@inheritDoc}
     */
    public function isVeryVerbose()
    {
        return $this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERY_VERBOSE;
    }

    /**
     * {@inheritDoc}
     */
    public function isDebug()
    {
        return $this->output->getVerbosity() >= OutputInterface::VERBOSITY_DEBUG;
    }

    /**
     * {@inheritDoc}
     */
    public function write($messages, $newline = true, $verbosity = self::NORMAL)
    {
        $this->doWrite($messages, $newline, false, $verbosity);
    }

    /**
     * {@inheritDoc}
     */
    public function writeError($messages, $newline = true, $verbosity = self::NORMAL)
    {
        $this->doWrite($messages, $newline, true, $verbosity);
    }

    /**
     * Write to the appropriate user output
     *
     * @param array|string $messages
     * @param bool         $newline
     * @param bool         $stderr
     * @param int          $verbosity
     */
    private function doWrite($messages, $newline, $stderr, $verbosity)
    {
        $sfVerbosity = $this->verbosityMap[$verbosity];
        if ($sfVerbosity > $this->output->getVerbosity()) {
            return;
        }

        $this->getOutputToWriteTo($stderr)->write($messages, $newline, $sfVerbosity);

    }

    /**
     * {@inheritDoc}
     */
    public function ask($question, $default = null)
    {
        /** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */
        $helper   = $this->helperSet->get('question');
        $question = new Question($question, $default);

        return $helper->ask($this->input, $this->getOutputToWriteTo(), $question);
    }

    /**
     * {@inheritDoc}
     */
    public function askConfirmation($question, $default = true)
    {
        /** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */
        $helper   = $this->helperSet->get('question');
        $question = new ConfirmationQuestion($question, $default);

        return IOUtil::answerToBool($helper->ask($this->input, $this->getOutputToWriteTo(), $question));
    }

    /**
     * {@inheritDoc}
     */
    public function askAndValidate($question, $validator, $attempts = null, $default = null)
    {
        /** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */
        $helper   = $this->helperSet->get('question');
        $question = new Question($question, $default);
        $question->setValidator($validator);
        $question->setMaxAttempts($attempts);

        return $helper->ask($this->input, $this->getOutputToWriteTo(), $question);
    }

    /**
     * Return the output to write to
     *
     * @param  bool $stdErr
     * @return \Symfony\Component\Console\Output\OutputInterface
     */
    private function getOutputToWriteTo($stdErr = false)
    {
        if ($stdErr && $this->output instanceof ConsoleOutputInterface) {
            return $this->output->getErrorOutput();
        }

        return $this->output;
    }
}


1		<?php
2		/**
3		* This file is part of CaptainHook.
4		*
5		* (c) Sebastian Feldmann <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10		namespace CaptainHook\App\Console\IO;
11
12		use CaptainHook\App\Console\IO;
13		use CaptainHook\App\Console\IOUtil;
14		use Symfony\Component\Console\Input\InputInterface;
15		use Symfony\Component\Console\Helper\HelperSet;
16		use Symfony\Component\Console\Output\ConsoleOutputInterface;
17		use Symfony\Component\Console\Output\OutputInterface;
18		use Symfony\Component\Console\Question\ConfirmationQuestion;
19		use Symfony\Component\Console\Question\Question;
20
21		/**
22		* Class DefaultIO
23		*
24		* @package CaptainHook
25		* @author Sebastian Feldmann <[email protected]>
26		* @link https://github.com/captainhookphp/captainhook
27		* @since Class available since Release 0.9.0
28		*/
29		class DefaultIO extends Base
30		{
31		/**
32		* @var \Symfony\Component\Console\Input\InputInterface
33		*/
34		protected $input;
35
36		/**
37		* @var \Symfony\Component\Console\Output\OutputInterface
38		*/
39		protected $output;
40
41		/**
42		* @var \Symfony\Component\Console\Helper\HelperSet
43		*/
44		protected $helperSet;
45
46		/**
47		* @var array
48		*/
49		private $verbosityMap;
50
51		/**
52		* Constructor
53		*
54		* @param \Symfony\Component\Console\Input\InputInterface $input
55		* @param \Symfony\Component\Console\Output\OutputInterface $output
56		* @param \Symfony\Component\Console\Helper\HelperSet $helperSet
57		*/
58	14	public function __construct(InputInterface $input, OutputInterface $output, HelperSet $helperSet = null)
59		{
60	14	$this->input = $input;
61	14	$this->output = $output;
62	14	$this->helperSet = $helperSet;
63	14	$this->verbosityMap = [
64		IO::QUIET => OutputInterface::VERBOSITY_QUIET,
65		IO::NORMAL => OutputInterface::VERBOSITY_NORMAL,
66		IO::VERBOSE => OutputInterface::VERBOSITY_VERBOSE,
67		IO::VERY_VERBOSE => OutputInterface::VERBOSITY_VERY_VERBOSE,
68		IO::DEBUG => OutputInterface::VERBOSITY_DEBUG
69		];
70	14	}
71
72		/**
73		* Return the original cli arguments
74		*
75		* @return array
76		*/
77	1	public function getArguments(): array
78		{
79	1	return $this->input->getArguments();
80		}
81
82		/**
83		* {@inheritDoc}
84		*/
85	1	public function isInteractive()
86		{
87	1	return $this->input->isInteractive();
88		}
89
90		/**
91		* {@inheritDoc}
92		*/
93	1	public function isVerbose()
94		{
95	1	return $this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE;
96		}
97
98		/**
99		* {@inheritDoc}
100		*/
101	1	public function isVeryVerbose()
102		{
103	1	return $this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERY_VERBOSE;
104		}
105
106		/**
107		* {@inheritDoc}
108		*/
109	1	public function isDebug()
110		{
111	1	return $this->output->getVerbosity() >= OutputInterface::VERBOSITY_DEBUG;
112		}
113
114		/**
115		* {@inheritDoc}
116		*/
117	2	public function write($messages, $newline = true, $verbosity = self::NORMAL)
118		{
119	2	$this->doWrite($messages, $newline, false, $verbosity);
120	2	}
121
122		/**
123		* {@inheritDoc}
124		*/
125	2	public function writeError($messages, $newline = true, $verbosity = self::NORMAL)
126		{
127	2	$this->doWrite($messages, $newline, true, $verbosity);
128	2	}
129
130		/**
131		* Write to the appropriate user output
132		*
133		* @param array\|string $messages
134		* @param bool $newline
135		* @param bool $stderr
136		* @param int $verbosity
137		*/
138	4	private function doWrite($messages, $newline, $stderr, $verbosity)
139		{
140	4	$sfVerbosity = $this->verbosityMap[$verbosity];
141	4	if ($sfVerbosity > $this->output->getVerbosity()) {
142	1	return;
143		}
144
145	3	$this->getOutputToWriteTo($stderr)->write($messages, $newline, $sfVerbosity);
		0 ignored issues – show Bug introduced 2018-08-24 17:46 UTC by Report Bug Copy Issue Report It seems like `$messages` defined by parameter `$messages` on line 138 can also be of type `array`; however, `Symfony\Component\Consol...utputInterface::write()` does only seem to accept `string\|object<Symfony\Co...onsole\Output\iterable>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
146	3	}
147
148		/**
149		* {@inheritDoc}
150		*/
151	1	public function ask($question, $default = null)
152		{
153		/** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */
154	1	$helper = $this->helperSet->get('question');
155	1	$question = new Question($question, $default);
156
157	1	return $helper->ask($this->input, $this->getOutputToWriteTo(), $question);
158		}
159
160		/**
161		* {@inheritDoc}
162		*/
163	1	public function askConfirmation($question, $default = true)
164		{
165		/** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */
166	1	$helper = $this->helperSet->get('question');
167	1	$question = new ConfirmationQuestion($question, $default);
168
169	1	return IOUtil::answerToBool($helper->ask($this->input, $this->getOutputToWriteTo(), $question));
170		}
171
172		/**
173		* {@inheritDoc}
174		*/
175	1	public function askAndValidate($question, $validator, $attempts = null, $default = null)
176		{
177		/** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */
178	1	$helper = $this->helperSet->get('question');
179	1	$question = new Question($question, $default);
180	1	$question->setValidator($validator);
181	1	$question->setMaxAttempts($attempts);
182
183	1	return $helper->ask($this->input, $this->getOutputToWriteTo(), $question);
184		}
185
186		/**
187		* Return the output to write to
188		*
189		* @param bool $stdErr
190		* @return \Symfony\Component\Console\Output\OutputInterface
191		*/
192	6	private function getOutputToWriteTo($stdErr = false)
193		{
194	6	if ($stdErr && $this->output instanceof ConsoleOutputInterface) {
195	1	return $this->output->getErrorOutput();
196		}
197
198	5	return $this->output;
199		}
200		}
201

captainhook-git / captainhook

Push — master ( 41bfc2...176b02 )

DefaultIO::getArguments() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like