TestCommand::configure() - Code Metrics - Inspection of "Add isolation runner" - hanneskod/readme-tester - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( b1e763...e9b74b )

by Hannes

created 2018-02-18 21:24 UTC

TestCommand::configure() A

↳ Parent: TestCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	51
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	42
nc	1
nop	0
dl	0
loc	51
rs	9.4109
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types = 1);

namespace hanneskod\readmetester\Console;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use hanneskod\readmetester\EngineFactory;
use hanneskod\readmetester\SourceFileIterator;
use hanneskod\readmetester\Example\RegexpFilter;
use hanneskod\readmetester\Example\UnnamedFilter;
use hanneskod\readmetester\Example\NullFilter;
use hanneskod\readmetester\Runner\IsolationRunner;

/**
 * CLI command to run test
 */
class TestCommand extends Command
{
    /**
     * Path to default bootstrap file
     */
    const DEFAULT_BOOTSTRAP = 'vendor/autoload.php';

    protected function configure()
    {
        $this->setName('test')
            ->setDescription('Test examples in readme file')
            ->addArgument(
                'source',
                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
                'One or more files or directories to test',
                ['README.md']
            )
            ->addOption(
                'filter',
                null,
                InputOption::VALUE_REQUIRED,
                'Filter which examples to test using a regular expression'
            )
            ->addOption(
                'format',
                null,
                InputOption::VALUE_REQUIRED,
                "One of 'std' or 'json'"
            )
            ->addOption(
                'named-only',
                null,
                InputOption::VALUE_NONE,
                'Test only named examples'
            )
            ->addOption(
                'ignore-unknown-annotations',
                null,
                InputOption::VALUE_NONE,
                'Ignore example annotations that are not known to readme-tester'
            )
            ->addOption(
                'isolation',
                null,
                InputOption::VALUE_NONE,
                'Run tests in isolation'
            )
            ->addOption(
                'bootstrap',
                null,
                InputOption::VALUE_REQUIRED,
                'A "bootstrap" PHP file that is run before testing'
            )
            ->addOption(
                'no-auto-bootstrap',
                null,
                InputOption::VALUE_NONE,
                "Don't try to load a local composer autoloader when boostrap is not definied"
            )
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $filter = $input->getOption('filter')
            ? new RegexpFilter($input->getOption('filter'))
            : ($input->getOption('named-only') ? new UnnamedFilter : new NullFilter);

        $engineFactory = new EngineFactory;

        if ($input->getOption('isolation')) {
            $engineFactory->setRunner(new IsolationRunner);
        }

        $engine = $engineFactory->createEngine(
            $filter,
            $input->getOption('ignore-unknown-annotations')
        );

        $exitStatus = new ExitStatusListener;
        $engine->registerListener($exitStatus);

        $formatter = $input->getOption('format') == 'json'
            ? new JsonFormatter($output)
            : new DefaultFormatter($output);

        $engine->registerListener($formatter);

        $formatter->onInvokationStart();

        $this->bootstrap($input, $formatter);

        foreach ($input->getArgument('source') as $source) {
            foreach (new SourceFileIterator($source) as $filename => $contents) {
                $formatter->onFile($filename);
                $engine->testFile($contents);
            }
        }

        $formatter->onInvokationEnd();

        return $exitStatus->getStatusCode();
    }

    private function bootstrap(InputInterface $input, $formatter)
    {
        if ($filename = $input->getOption('bootstrap')) {
            if (!file_exists($filename) || !is_readable($filename)) {
                throw new \RuntimeException("Unable to bootstrap $filename");
            }

            require_once $filename;
            $formatter->onBootstrap($filename);
            return;
        }

        if (!$input->getOption('no-auto-bootstrap') && is_readable(self::DEFAULT_BOOTSTRAP)) {
            require_once self::DEFAULT_BOOTSTRAP;
            $formatter->onBootstrap(self::DEFAULT_BOOTSTRAP);
        }
    }
}


1			<?php
2
3			declare(strict_types = 1);
4
5			namespace hanneskod\readmetester\Console;
6
7			use Symfony\Component\Console\Command\Command;
8			use Symfony\Component\Console\Input\InputArgument;
9			use Symfony\Component\Console\Input\InputOption;
10			use Symfony\Component\Console\Input\InputInterface;
11			use Symfony\Component\Console\Output\OutputInterface;
12			use hanneskod\readmetester\EngineFactory;
13			use hanneskod\readmetester\SourceFileIterator;
14			use hanneskod\readmetester\Example\RegexpFilter;
15			use hanneskod\readmetester\Example\UnnamedFilter;
16			use hanneskod\readmetester\Example\NullFilter;
17			use hanneskod\readmetester\Runner\IsolationRunner;
18
19			/**
20			* CLI command to run test
21			*/
22			class TestCommand extends Command
23			{
24			/**
25			* Path to default bootstrap file
26			*/
27			const DEFAULT_BOOTSTRAP = 'vendor/autoload.php';
28
29			protected function configure()
30			{
31			$this->setName('test')
32			->setDescription('Test examples in readme file')
33			->addArgument(
34			'source',
35			InputArgument::OPTIONAL \| InputArgument::IS_ARRAY,
36			'One or more files or directories to test',
37			['README.md']
38			)
39			->addOption(
40			'filter',
41			null,
42			InputOption::VALUE_REQUIRED,
43			'Filter which examples to test using a regular expression'
44			)
45			->addOption(
46			'format',
47			null,
48			InputOption::VALUE_REQUIRED,
49			"One of 'std' or 'json'"
50			)
51			->addOption(
52			'named-only',
53			null,
54			InputOption::VALUE_NONE,
55			'Test only named examples'
56			)
57			->addOption(
58			'ignore-unknown-annotations',
59			null,
60			InputOption::VALUE_NONE,
61			'Ignore example annotations that are not known to readme-tester'
62			)
63			->addOption(
64			'isolation',
65			null,
66			InputOption::VALUE_NONE,
67			'Run tests in isolation'
68			)
69			->addOption(
70			'bootstrap',
71			null,
72			InputOption::VALUE_REQUIRED,
73			'A "bootstrap" PHP file that is run before testing'
74			)
75			->addOption(
76			'no-auto-bootstrap',
77			null,
78			InputOption::VALUE_NONE,
79			"Don't try to load a local composer autoloader when boostrap is not definied"
80			)
81			;
82			}
83
84			protected function execute(InputInterface $input, OutputInterface $output): int
85			{
86			$filter = $input->getOption('filter')
87			? new RegexpFilter($input->getOption('filter'))
88			: ($input->getOption('named-only') ? new UnnamedFilter : new NullFilter);
89
90			$engineFactory = new EngineFactory;
91
92			if ($input->getOption('isolation')) {
93			$engineFactory->setRunner(new IsolationRunner);
94			}
95
96			$engine = $engineFactory->createEngine(
97			$filter,
98			$input->getOption('ignore-unknown-annotations')
99			);
100
101			$exitStatus = new ExitStatusListener;
102			$engine->registerListener($exitStatus);
103
104			$formatter = $input->getOption('format') == 'json'
105			? new JsonFormatter($output)
106			: new DefaultFormatter($output);
107
108			$engine->registerListener($formatter);
109
110			$formatter->onInvokationStart();
111
112			$this->bootstrap($input, $formatter);
113
114			foreach ($input->getArgument('source') as $source) {
115			foreach (new SourceFileIterator($source) as $filename => $contents) {
116			$formatter->onFile($filename);
117			$engine->testFile($contents);
118			}
119			}
120
121			$formatter->onInvokationEnd();
122
123			return $exitStatus->getStatusCode();
124			}
125
126			private function bootstrap(InputInterface $input, $formatter)
127			{
128			if ($filename = $input->getOption('bootstrap')) {
129			if (!file_exists($filename) \|\| !is_readable($filename)) {
130			throw new \RuntimeException("Unable to bootstrap $filename");
131			}
132
133			require_once $filename;
134			$formatter->onBootstrap($filename);
135			return;
136			}
137
138			if (!$input->getOption('no-auto-bootstrap') && is_readable(self::DEFAULT_BOOTSTRAP)) {
139			require_once self::DEFAULT_BOOTSTRAP;
140			$formatter->onBootstrap(self::DEFAULT_BOOTSTRAP);
141			}
142			}
143			}
144

hanneskod / readme-tester

Push — master ( b1e763...e9b74b )

TestCommand::configure() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like