Command::configure() - Code Metrics - Inspection of "Return non zero exit code when there are magic num..." - povils/phpmnd - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#51)

by Povilas

created 2017-05-12 22:10 UTC

Command::configure() B

↳ Parent: Command

Complexity

Conditions	1
Paths	1

Size

Total Lines	91
Code Lines	70

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	91
rs	8.518
cc	1
eloc	70
nc	1
nop	0

How to fix Long Method

<?php

namespace Povils\PHPMND\Console;

use Povils\PHPMND\Detector;
use Povils\PHPMND\ExtensionResolver;
use Povils\PHPMND\FileReportList;
use Povils\PHPMND\HintList;
use Povils\PHPMND\PHPFinder;
use Povils\PHPMND\Printer;
use Symfony\Component\Console\Command\Command as BaseCommand;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class Command
 *
 * @package Povils\PHPMND\Console
 */
class Command extends BaseCommand
{
    /**
     * @inheritdoc
     */
    protected function configure()
    {
        $this
            ->setName('phpmnd')
            ->setDefinition(
                [
                    new InputArgument(
                        'directory',
                        InputArgument::REQUIRED,
                        'Directory to analyze'
                    )
                ]
            )
            ->addOption(
                'extensions',
                null,
                InputOption::VALUE_REQUIRED,
                'A comma-separated list of extensions',
                []
            )
            ->addOption(
                'ignore-numbers',
                null,
                InputOption::VALUE_REQUIRED,
                'A comma-separated list of numbers to ignore',
                [0, 1]
            )
            ->addOption(
                'ignore-funcs',
                null,
                InputOption::VALUE_REQUIRED,
                'A comma-separated list of functions to ignore when using "argument" extension',
                []
            )
            ->addOption(
                'exclude',
                null,
                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
                'Exclude a directory from code analysis (must be relative to source)'
            )
            ->addOption(
                'exclude-path',
                null,
                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
                'Exclude a path from code analysis (must be relative to source)'
            )
            ->addOption(
                'exclude-file',
                null,
                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
                'Exclude a file from code analysis (must be relative to source)'
            )
            ->addOption(
                'suffixes',
                null,
                InputOption::VALUE_REQUIRED,
                'Comma-separated string of valid source code filename extensions',
                'php'
            )
            ->addOption(
                'progress',
                null,
                InputOption::VALUE_NONE,
                'Show progress bar'
            )
            ->addOption(
                'hint',
                null,
                InputOption::VALUE_NONE,
                'Suggest replacements for magic numbers'
            )
            ->addOption(
                'non-zero-exit-on-violation',
                null,
                InputOption::VALUE_NONE,
                'Return a non zero exit code when there are magic numbers'
            )
            ->addOption(
                'strings',
                null,
                InputOption::VALUE_NONE,
                'Include strings literal search in code analysis'
            )
            ->addOption(
                'ignore-strings',
                null,
                InputOption::VALUE_REQUIRED,
                'A comma-separated list of strings to ignore when using "strings" option',
                []
            );
    }

    /**
     * @inheritdoc
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $finder = $this->createFinder($input);

        if (0 === $finder->count()) {
            $output->writeln('No files found to scan');
            exit(0);
        }

        $progressBar = null;
        if ($input->getOption('progress')) {
            $progressBar = new ProgressBar($output, $finder->count());
            $progressBar->start();
        }

        $hintList = new HintList;
        $detector = new Detector($this->createOption($input), $hintList);

        $fileReportList = new FileReportList();
        $printer = new Printer();
        foreach ($finder as $file) {
            try {
                $fileReport = $detector->detect($file);
                if ($fileReport->hasMagicNumbers()) {
                    $fileReportList->addFileReport($fileReport);
                }
            } catch (\Exception $e) {
                $output->writeln($e->getMessage());
            }

            if ($input->getOption('progress')) {
                $progressBar->advance();
            }
        }

        if ($input->getOption('progress')) {
            $progressBar->finish();
        }

        if ($output->getVerbosity() !== OutputInterface::VERBOSITY_QUIET) {
            $output->writeln('');
            $printer->printData($output, $fileReportList, $hintList);
            $output->writeln('<info>' . \PHP_Timer::resourceUsage() . '</info>');
        }

        if ($input->getOption('non-zero-exit-on-violation') && $fileReportList->hasMagicNumbers()) {
            exit(1);
        }
    }

    /**
     * @param InputInterface $input
     * @return Option
     * @throws \Exception
     */
    private function createOption(InputInterface $input)
    {
        $option = new Option;
        $option->setIgnoreNumbers(array_map([$this, 'castToNumber'], $this->getCSVOption($input, 'ignore-numbers')));
        $option->setIgnoreFuncs($this->getCSVOption($input, 'ignore-funcs'));
        $option->setIncludeStrings($input->getOption('strings'));
        $option->setIgnoreStrings($input->getOption('ignore-strings'));
        $option->setGiveHint($input->getOption('hint'));
        $option->setExtensions(
            (new ExtensionResolver())->resolve($this->getCSVOption($input, 'extensions'))
        );

        return $option;
    }

    /**
     * @param InputInterface $input
     * @param string $option
     *
     * @return array
     */
    private function getCSVOption(InputInterface $input, $option)
    {
        $result = $input->getOption($option);
        if (false === is_array($result)) {
            return explode(',', $result);
        }

        return $result;
    }

    /**
     * @param InputInterface $input
     *
     * @return PHPFinder
     */
    protected function createFinder(InputInterface $input)
    {
        return new PHPFinder(
            $input->getArgument('directory'),
            $input->getOption('exclude'),
            $input->getOption('exclude-path'),
            $input->getOption('exclude-file'),
            $this->getCSVOption($input, 'suffixes')
        );
    }

    /**
     * @param string $value
     *
     * @return int|float|string
     */
    private function castToNumber($value)
    {
        if (is_numeric($value)) {
            $value += 0; // '2' -> (int) 2, '2.' -> (float) 2.0
        }

        return $value;
    }
}


1			<?php
2
3			namespace Povils\PHPMND\Console;
4
5			use Povils\PHPMND\Detector;
6			use Povils\PHPMND\ExtensionResolver;
7			use Povils\PHPMND\FileReportList;
8			use Povils\PHPMND\HintList;
9			use Povils\PHPMND\PHPFinder;
10			use Povils\PHPMND\Printer;
11			use Symfony\Component\Console\Command\Command as BaseCommand;
12			use Symfony\Component\Console\Helper\ProgressBar;
13			use Symfony\Component\Console\Input\InputArgument;
14			use Symfony\Component\Console\Input\InputInterface;
15			use Symfony\Component\Console\Input\InputOption;
16			use Symfony\Component\Console\Output\OutputInterface;
17
18			/**
19			* Class Command
20			*
21			* @package Povils\PHPMND\Console
22			*/
23			class Command extends BaseCommand
24			{
25			/**
26			* @inheritdoc
27			*/
28			protected function configure()
29			{
30			$this
31			->setName('phpmnd')
32			->setDefinition(
33			[
34			new InputArgument(
35			'directory',
36			InputArgument::REQUIRED,
37			'Directory to analyze'
38			)
39			]
40			)
41			->addOption(
42			'extensions',
43			null,
44			InputOption::VALUE_REQUIRED,
45			'A comma-separated list of extensions',
46			[]
47			)
48			->addOption(
49			'ignore-numbers',
50			null,
51			InputOption::VALUE_REQUIRED,
52			'A comma-separated list of numbers to ignore',
53			[0, 1]
54			)
55			->addOption(
56			'ignore-funcs',
57			null,
58			InputOption::VALUE_REQUIRED,
59			'A comma-separated list of functions to ignore when using "argument" extension',
60			[]
61			)
62			->addOption(
63			'exclude',
64			null,
65			InputOption::VALUE_REQUIRED \| InputOption::VALUE_IS_ARRAY,
66			'Exclude a directory from code analysis (must be relative to source)'
67			)
68			->addOption(
69			'exclude-path',
70			null,
71			InputOption::VALUE_REQUIRED \| InputOption::VALUE_IS_ARRAY,
72			'Exclude a path from code analysis (must be relative to source)'
73			)
74			->addOption(
75			'exclude-file',
76			null,
77			InputOption::VALUE_REQUIRED \| InputOption::VALUE_IS_ARRAY,
78			'Exclude a file from code analysis (must be relative to source)'
79			)
80			->addOption(
81			'suffixes',
82			null,
83			InputOption::VALUE_REQUIRED,
84			'Comma-separated string of valid source code filename extensions',
85			'php'
86			)
87			->addOption(
88			'progress',
89			null,
90			InputOption::VALUE_NONE,
91			'Show progress bar'
92			)
93			->addOption(
94			'hint',
95			null,
96			InputOption::VALUE_NONE,
97			'Suggest replacements for magic numbers'
98			)
99			->addOption(
100			'non-zero-exit-on-violation',
101			null,
102			InputOption::VALUE_NONE,
103			'Return a non zero exit code when there are magic numbers'
104			)
105			->addOption(
106			'strings',
107			null,
108			InputOption::VALUE_NONE,
109			'Include strings literal search in code analysis'
110			)
111			->addOption(
112			'ignore-strings',
113			null,
114			InputOption::VALUE_REQUIRED,
115			'A comma-separated list of strings to ignore when using "strings" option',
116			[]
117			);
118			}
119
120			/**
121			* @inheritdoc
122			*/
123			protected function execute(InputInterface $input, OutputInterface $output)
124			{
125			$finder = $this->createFinder($input);
126
127			if (0 === $finder->count()) {
128			$output->writeln('No files found to scan');
129			exit(0);
130			}
131
132			$progressBar = null;
133			if ($input->getOption('progress')) {
134			$progressBar = new ProgressBar($output, $finder->count());
135			$progressBar->start();
136			}
137
138			$hintList = new HintList;
139			$detector = new Detector($this->createOption($input), $hintList);
140
141			$fileReportList = new FileReportList();
142			$printer = new Printer();
143			foreach ($finder as $file) {
144			try {
145			$fileReport = $detector->detect($file);
146			if ($fileReport->hasMagicNumbers()) {
147			$fileReportList->addFileReport($fileReport);
148			}
149			} catch (\Exception $e) {
150			$output->writeln($e->getMessage());
151			}
152
153			if ($input->getOption('progress')) {
154			$progressBar->advance();
155			}
156			}
157
158			if ($input->getOption('progress')) {
159			$progressBar->finish();
160			}
161
162			if ($output->getVerbosity() !== OutputInterface::VERBOSITY_QUIET) {
163			$output->writeln('');
164			$printer->printData($output, $fileReportList, $hintList);
165			$output->writeln('<info>' . \PHP_Timer::resourceUsage() . '</info>');
166			}
167
168			if ($input->getOption('non-zero-exit-on-violation') && $fileReportList->hasMagicNumbers()) {
169			exit(1);
170			}
171			}
172
173			/**
174			* @param InputInterface $input
175			* @return Option
176			* @throws \Exception
177			*/
178			private function createOption(InputInterface $input)
179			{
180			$option = new Option;
181			$option->setIgnoreNumbers(array_map([$this, 'castToNumber'], $this->getCSVOption($input, 'ignore-numbers')));
182			$option->setIgnoreFuncs($this->getCSVOption($input, 'ignore-funcs'));
183			$option->setIncludeStrings($input->getOption('strings'));
184			$option->setIgnoreStrings($input->getOption('ignore-strings'));
185			$option->setGiveHint($input->getOption('hint'));
186			$option->setExtensions(
187			(new ExtensionResolver())->resolve($this->getCSVOption($input, 'extensions'))
188			);
189
190			return $option;
191			}
192
193			/**
194			* @param InputInterface $input
195			* @param string $option
196			*
197			* @return array
198			*/
199			private function getCSVOption(InputInterface $input, $option)
200			{
201			$result = $input->getOption($option);
202			if (false === is_array($result)) {
203			return explode(',', $result);
204			}
205
206			return $result;
207			}
208
209			/**
210			* @param InputInterface $input
211			*
212			* @return PHPFinder
213			*/
214			protected function createFinder(InputInterface $input)
215			{
216			return new PHPFinder(
217			$input->getArgument('directory'),
218			$input->getOption('exclude'),
219			$input->getOption('exclude-path'),
220			$input->getOption('exclude-file'),
221			$this->getCSVOption($input, 'suffixes')
222			);
223			}
224
225			/**
226			* @param string $value
227			*
228			* @return int\|float\|string
229			*/
230			private function castToNumber($value)
231			{
232			if (is_numeric($value)) {
233			$value += 0; // '2' -> (int) 2, '2.' -> (float) 2.0
234			}
235
236			return $value;
237			}
238			}
239

povils / phpmnd

Pull Request — master (#51)

Command::configure() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like