RunMetricsCommand::configure() - Code Metrics - Halleck45/PhpMetrics - Measure and Improve Code Quality continuously with Scrutinizer

RunMetricsCommand::configure() A
last analyzed 2015-12-15 11:18 UTC

↳ Parent: RunMetricsCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	58
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	1

Metric	Value
c	4
b	1
f	1
dl	0
loc	58
rs	9.6391
cc	1
eloc	38
nc	1
nop	0

How to fix Long Method

<?php

/*
 * (c) Jean-François Lépine <https://twitter.com/Halleck45>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Hal\Application\Command;
use Hal\Application\Command\Job\QueueFactory;
use Hal\Application\Config\ConfigFactory;
use Hal\Component\Bounds\Bounds;
use Hal\Component\Evaluation\Evaluator;
use Hal\Component\File\Finder;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Command for run analysis
 *
 * @author Jean-François Lépine <https://twitter.com/Halleck45>
 */
class RunMetricsCommand extends Command
{
    /**
     * @inheritdoc
     */
    protected function configure()
    {
        $this
                ->setName('metrics')
                ->setDescription('Run analysis')
                ->addArgument(
                    'path', InputArgument::OPTIONAL, 'Path to explore'
                )
                ->addOption(
                    'report-html',null, InputOption::VALUE_REQUIRED, 'Path to save report in HTML format. Example: /tmp/report.html'
                )
                ->addOption(
                    'report-xml', null, InputOption::VALUE_REQUIRED, 'Path to save summary report in XML format. Example: /tmp/report.xml'
                )
                ->addOption(
                    'report-cli', null, InputOption::VALUE_NONE, 'Enable report in terminal'
                )
                ->addOption(
                    'violations-xml', null, InputOption::VALUE_REQUIRED, 'Path to save violations in XML format. Example: /tmp/report.xml'
                )
                ->addOption(
                    'report-csv', null, InputOption::VALUE_REQUIRED, 'Path to save summary report in CSV format. Example: /tmp/report.csv'
                )
                ->addOption(
                    'report-json', null, InputOption::VALUE_REQUIRED, 'Path to save detailed report in JSON format. Example: /tmp/report.json'
                )
                ->addOption(
                    'chart-bubbles', null, InputOption::VALUE_REQUIRED, 'Path to save Bubbles chart, in SVG format. Example: /tmp/chart.svg. Graphviz **IS** required'
                )
                ->addOption(
                    'level', null, InputOption::VALUE_REQUIRED, 'Depth of summary report', 0
                )
                ->addOption(
                    'extensions', null, InputOption::VALUE_REQUIRED, 'Regex of extensions to include', null
                )
                ->addOption(
                    'excluded-dirs', null, InputOption::VALUE_REQUIRED, 'Regex of subdirectories to exclude', null
                )
                ->addOption(
                    'symlinks', null, InputOption::VALUE_NONE, 'Enable following symlinks'
                )
                ->addOption(
                    'without-oop', null, InputOption::VALUE_NONE, 'If provided, tool will not extract any information about OOP model (faster)'
                )
                ->addOption(
                    'ignore-errors', null, InputOption::VALUE_NONE, 'If provided, files will be analyzed even with syntax errors'
                )
                ->addOption(
                    'failure-condition', null, InputOption::VALUE_REQUIRED, 'Optional failure condition, in english. For example: average.maintainabilityIndex < 50 or sum.loc > 10000', null
                )
                ->addOption(
                    'config', null, InputOption::VALUE_REQUIRED, 'Config file (YAML)', null
                )
                ->addOption(
                    'template-title', null, InputOption::VALUE_REQUIRED, 'Title for the HTML summary report', null
                )
        ;
    }

    /**
     * @inheritdoc
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {

        $output->writeln('PHPMetrics by Jean-François Lépine <https://twitter.com/Halleck45>');
        $output->writeln('');

        // config
        $configFactory = new ConfigFactory();
        $config = $configFactory->factory($input);

        // files
        if(null === $config->getPath()->getBasePath()) {
            throw new \LogicException('Please provide a path to analyze');
        }

        // files to analyze
        $finder = new Finder(
            $config->getPath()->getExtensions()
            , $config->getPath()->getExcludedDirs()
            , $config->getPath()->isFollowSymlinks() ? Finder::FOLLOW_SYMLINKS : null
        );

        // prepare structures
        $bounds = new Bounds();
        $collection = new \Hal\Component\Result\ResultCollection();
        $aggregatedResults = new \Hal\Component\Result\ResultCollection();

        // execute analyze
        $queueFactory = new QueueFactory($input, $output, $config);
        $queue = $queueFactory->factory($finder, $bounds);
        gc_disable();
        $queue->execute($collection, $aggregatedResults);
        gc_enable();

        $output->writeln('<info>done</info>');

        // evaluation of success
        $rule = $config->getFailureCondition();
        if(null !== $rule) {
            $evaluator = new Evaluator($collection, $aggregatedResults, $bounds);
            $result = $evaluator->evaluate($rule);
            // fail if failure-condition is realized
            return $result->isValid() ? 1 : 0;
        }

        return 0;
    }

}


1			<?php
2
3			/*
4			* (c) Jean-François Lépine <https://twitter.com/Halleck45>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace Hal\Application\Command;
11			use Hal\Application\Command\Job\QueueFactory;
12			use Hal\Application\Config\ConfigFactory;
13			use Hal\Component\Bounds\Bounds;
14			use Hal\Component\Evaluation\Evaluator;
15			use Hal\Component\File\Finder;
16			use Symfony\Component\Console\Command\Command;
17			use Symfony\Component\Console\Input\InputArgument;
18			use Symfony\Component\Console\Input\InputInterface;
19			use Symfony\Component\Console\Input\InputOption;
20			use Symfony\Component\Console\Output\OutputInterface;
21
22			/**
23			* Command for run analysis
24			*
25			* @author Jean-François Lépine <https://twitter.com/Halleck45>
26			*/
27			class RunMetricsCommand extends Command
28			{
29			/**
30			* @inheritdoc
31			*/
32			protected function configure()
33			{
34			$this
35			->setName('metrics')
36			->setDescription('Run analysis')
37			->addArgument(
38			'path', InputArgument::OPTIONAL, 'Path to explore'
39			)
40			->addOption(
41			'report-html',null, InputOption::VALUE_REQUIRED, 'Path to save report in HTML format. Example: /tmp/report.html'
42			)
43			->addOption(
44			'report-xml', null, InputOption::VALUE_REQUIRED, 'Path to save summary report in XML format. Example: /tmp/report.xml'
45			)
46			->addOption(
47			'report-cli', null, InputOption::VALUE_NONE, 'Enable report in terminal'
48			)
49			->addOption(
50			'violations-xml', null, InputOption::VALUE_REQUIRED, 'Path to save violations in XML format. Example: /tmp/report.xml'
51			)
52			->addOption(
53			'report-csv', null, InputOption::VALUE_REQUIRED, 'Path to save summary report in CSV format. Example: /tmp/report.csv'
54			)
55			->addOption(
56			'report-json', null, InputOption::VALUE_REQUIRED, 'Path to save detailed report in JSON format. Example: /tmp/report.json'
57			)
58			->addOption(
59			'chart-bubbles', null, InputOption::VALUE_REQUIRED, 'Path to save Bubbles chart, in SVG format. Example: /tmp/chart.svg. Graphviz IS required'
60			)
61			->addOption(
62			'level', null, InputOption::VALUE_REQUIRED, 'Depth of summary report', 0
63			)
64			->addOption(
65			'extensions', null, InputOption::VALUE_REQUIRED, 'Regex of extensions to include', null
66			)
67			->addOption(
68			'excluded-dirs', null, InputOption::VALUE_REQUIRED, 'Regex of subdirectories to exclude', null
69			)
70			->addOption(
71			'symlinks', null, InputOption::VALUE_NONE, 'Enable following symlinks'
72			)
73			->addOption(
74			'without-oop', null, InputOption::VALUE_NONE, 'If provided, tool will not extract any information about OOP model (faster)'
75			)
76			->addOption(
77			'ignore-errors', null, InputOption::VALUE_NONE, 'If provided, files will be analyzed even with syntax errors'
78			)
79			->addOption(
80			'failure-condition', null, InputOption::VALUE_REQUIRED, 'Optional failure condition, in english. For example: average.maintainabilityIndex < 50 or sum.loc > 10000', null
81			)
82			->addOption(
83			'config', null, InputOption::VALUE_REQUIRED, 'Config file (YAML)', null
84			)
85			->addOption(
86			'template-title', null, InputOption::VALUE_REQUIRED, 'Title for the HTML summary report', null
87			)
88			;
89			}
90
91			/**
92			* @inheritdoc
93			*/
94			protected function execute(InputInterface $input, OutputInterface $output)
95			{
96
97			$output->writeln('PHPMetrics by Jean-François Lépine <https://twitter.com/Halleck45>');
98			$output->writeln('');
99
100			// config
101			$configFactory = new ConfigFactory();
102			$config = $configFactory->factory($input);
103
104			// files
105			if(null === $config->getPath()->getBasePath()) {
106			throw new \LogicException('Please provide a path to analyze');
107			}
108
109			// files to analyze
110			$finder = new Finder(
111			$config->getPath()->getExtensions()
112			, $config->getPath()->getExcludedDirs()
113			, $config->getPath()->isFollowSymlinks() ? Finder::FOLLOW_SYMLINKS : null
114			);
115
116			// prepare structures
117			$bounds = new Bounds();
118			$collection = new \Hal\Component\Result\ResultCollection();
119			$aggregatedResults = new \Hal\Component\Result\ResultCollection();
120
121			// execute analyze
122			$queueFactory = new QueueFactory($input, $output, $config);
123			$queue = $queueFactory->factory($finder, $bounds);
124			gc_disable();
125			$queue->execute($collection, $aggregatedResults);
126			gc_enable();
127
128			$output->writeln('<info>done</info>');
129
130			// evaluation of success
131			$rule = $config->getFailureCondition();
132			if(null !== $rule) {
133			$evaluator = new Evaluator($collection, $aggregatedResults, $bounds);
134			$result = $evaluator->evaluate($rule);
135			// fail if failure-condition is realized
136			return $result->isValid() ? 1 : 0;
137			}
138
139			return 0;
140			}
141
142			}
143

Halleck45 / PhpMetrics

RunMetricsCommand::configure() A last analyzed 2015-12-15 11:18 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

RunMetricsCommand::configure() A
last analyzed 2015-12-15 11:18 UTC