Validate::execute() - Code Metrics - Inspection of "Various tweaks" - humbug/box - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#400)

by Théo

created 2019-04-09 20:00 UTC

Validate::execute() C

↳ Parent: Project

Complexity

Conditions	12
Paths	183

Size

Total Lines	78
Code Lines	48

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	48
dl	0
loc	78
rs	6.2749
c	0
b	0
f	0
cc	12
nc	183
nop	2

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of the box project.
 *
 * (c) Kevin Herrera <[email protected]>
 *     Théo Fidry <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace KevinGH\Box\Console\Command;

use Exception;
use KevinGH\Box\Console\ConfigurationLoader;
use KevinGH\Box\Console\IO\IO;
use KevinGH\Box\Console\MessageRenderer;
use KevinGH\Box\Json\JsonValidationException;
use function sprintf;
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;

/**
 * @private
 */
final class Validate extends BaseCommand
{
    private const FILE_ARGUMENT = 'file';
    private const IGNORE_MESSAGES_OPTION = 'ignore-recommendations-and-warnings';

    /**
     * {@inheritdoc}
     */
    protected function configure(): void
    {
        parent::configure();

        $this->setName('validate');
        $this->setDescription('⚙  Validates the configuration file');
        $this->setHelp(
            <<<'HELP'
The <info>%command.name%</info> command will validate the configuration file
and report any errors found, if any.
<comment>
  This command relies on a configuration file for loading
  PHAR packaging settings. If a configuration file is not
  specified through the <info>--configuration|-c</info> option, one of
  the following files will be used (in order): <info>box.json,
  box.json.dist</info>
</comment>
HELP
        );
        $this->addArgument(
            self::FILE_ARGUMENT,
            InputArgument::OPTIONAL,
            'The configuration file. (default: box.json, box.json.dist)'
        );
        $this->addOption(
            self::IGNORE_MESSAGES_OPTION,
            'i',
            InputOption::VALUE_NONE,
            'Will not return a faulty code when a recommendation or warning is found'
        );
    }

    /**
     * {@inheritdoc}
     */
    protected function executeCommand(IO $io): int
    {
        $input = $io->getInput();

        try {
            $config = ConfigurationLoader::getConfig(
                $input->getArgument(self::FILE_ARGUMENT) ?? $this->getConfigurationHelper()->findDefaultPath(),
                $this->getConfigurationHelper(),
                $io,
                false
            );

            $recommendations = $config->getRecommendations();
            $warnings = $config->getWarnings();

            MessageRenderer::render($io, $recommendations, $warnings);

            $hasRecommendationsOrWarnings = [] === $recommendations && [] === $warnings;

            if (false === $hasRecommendationsOrWarnings) {
                if ([] === $recommendations) {
                    $io->caution('The configuration file passed the validation with warnings.');
                } elseif ([] === $warnings) {
                    $io->caution('The configuration file passed the validation with recommendations.');
                } else {
                    $io->caution('The configuration file passed the validation with recommendations and warnings.');
                }
            } else {
                $io->success('The configuration file passed the validation.');
            }

            return $hasRecommendationsOrWarnings || $input->getOption(self::IGNORE_MESSAGES_OPTION) ? 0 : 1;
        } catch (Exception $exception) {
            // Continue
        }

        if ($io->isVerbose()) {
            throw new RuntimeException(
                sprintf(
                    'The configuration file failed validation: %s',
                    $exception->getMessage()
                ),
                $exception->getCode(),
                $exception
            );
        }

        if ($exception instanceof JsonValidationException) {
            $io->writeln(
                sprintf(
                    '<error>The configuration file failed validation: "%s" does not match the expected JSON '
                    .'schema:</error>',
                    $exception->getValidatedFile()
                )
            );

            $io->writeln('');

            foreach ($exception->getErrors() as $error) {
                $io->writeln("<comment>  - $error</comment>");
            }
        } else {
            $errorMessage = isset($exception)
                ? sprintf('The configuration file failed validation: %s', $exception->getMessage())
                : 'The configuration file failed validation.'
            ;

            $io->writeln(
                sprintf(
                    '<error>%s</error>',
                    $errorMessage
                )
            );
        }

        return 1;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the box project.
7			*
8			* (c) Kevin Herrera <[email protected]>
9			* Théo Fidry <[email protected]>
10			*
11			* This source file is subject to the MIT license that is bundled
12			* with this source code in the file LICENSE.
13			*/
14
15			namespace KevinGH\Box\Console\Command;
16
17			use Exception;
18			use KevinGH\Box\Console\ConfigurationLoader;
19			use KevinGH\Box\Console\IO\IO;
20			use KevinGH\Box\Console\MessageRenderer;
21			use KevinGH\Box\Json\JsonValidationException;
22			use function sprintf;
23			use Symfony\Component\Console\Exception\RuntimeException;
24			use Symfony\Component\Console\Input\InputArgument;
25			use Symfony\Component\Console\Input\InputOption;
26
27			/**
28			* @private
29			*/
30			final class Validate extends BaseCommand
31			{
32			private const FILE_ARGUMENT = 'file';
33			private const IGNORE_MESSAGES_OPTION = 'ignore-recommendations-and-warnings';
34
35			/**
36			* {@inheritdoc}
37			*/
38			protected function configure(): void
39			{
40			parent::configure();
41
42			$this->setName('validate');
43			$this->setDescription('⚙ Validates the configuration file');
44			$this->setHelp(
45			<<<'HELP'
46			The <info>%command.name%</info> command will validate the configuration file
47			and report any errors found, if any.
48			<comment>
49			This command relies on a configuration file for loading
50			PHAR packaging settings. If a configuration file is not
51			specified through the <info>--configuration\|-c</info> option, one of
52			the following files will be used (in order): <info>box.json,
53			box.json.dist</info>
54			</comment>
55			HELP
56			);
57			$this->addArgument(
58			self::FILE_ARGUMENT,
59			InputArgument::OPTIONAL,
60			'The configuration file. (default: box.json, box.json.dist)'
61			);
62			$this->addOption(
63			self::IGNORE_MESSAGES_OPTION,
64			'i',
65			InputOption::VALUE_NONE,
66			'Will not return a faulty code when a recommendation or warning is found'
67			);
68			}
69
70			/**
71			* {@inheritdoc}
72			*/
73			protected function executeCommand(IO $io): int
74			{
75			$input = $io->getInput();
76
77			try {
78			$config = ConfigurationLoader::getConfig(
79			$input->getArgument(self::FILE_ARGUMENT) ?? $this->getConfigurationHelper()->findDefaultPath(),
80			$this->getConfigurationHelper(),
81			$io,
82			false
83			);
84
85			$recommendations = $config->getRecommendations();
86			$warnings = $config->getWarnings();
87
88			MessageRenderer::render($io, $recommendations, $warnings);
89
90			$hasRecommendationsOrWarnings = [] === $recommendations && [] === $warnings;
91
92			if (false === $hasRecommendationsOrWarnings) {
93			if ([] === $recommendations) {
94			$io->caution('The configuration file passed the validation with warnings.');
95			} elseif ([] === $warnings) {
96			$io->caution('The configuration file passed the validation with recommendations.');
97			} else {
98			$io->caution('The configuration file passed the validation with recommendations and warnings.');
99			}
100			} else {
101			$io->success('The configuration file passed the validation.');
102			}
103
104			return $hasRecommendationsOrWarnings \|\| $input->getOption(self::IGNORE_MESSAGES_OPTION) ? 0 : 1;
105			} catch (Exception $exception) {
106			// Continue
107			}
108
109			if ($io->isVerbose()) {
110			throw new RuntimeException(
111			sprintf(
112			'The configuration file failed validation: %s',
113			$exception->getMessage()
114			),
115			$exception->getCode(),
116			$exception
117			);
118			}
119
120			if ($exception instanceof JsonValidationException) {
121			$io->writeln(
122			sprintf(
123			'<error>The configuration file failed validation: "%s" does not match the expected JSON '
124			.'schema:</error>',
125			$exception->getValidatedFile()
126			)
127			);
128
129			$io->writeln('');
130
131			foreach ($exception->getErrors() as $error) {
132			$io->writeln("<comment> - $error</comment>");
133			}
134			} else {
135			$errorMessage = isset($exception)
136			? sprintf('The configuration file failed validation: %s', $exception->getMessage())
137			: 'The configuration file failed validation.'
138			;
139
140			$io->writeln(
141			sprintf(
142			'<error>%s</error>',
143			$errorMessage
144			)
145			);
146			}
147
148			return 1;
149			}
150			}
151

humbug / box

Pull Request — master (#400)

Validate::execute() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like