AbstractCommand::askConfirmation() - Code Metrics - Inspection of "Merge pull request #689 from doctrine/rollup" - doctrine/migrations - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5ff3e1...46578f )

by Jonathan

created 2018-05-21 16:42 UTC

AbstractCommand::askConfirmation() A

↳ Parent: AbstractCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	3
dl	0
loc	9
ccs	5
cts	5
cp	1
crap	1
rs	9.6666
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Doctrine\Migrations\Tools\Console\Command;

use Doctrine\DBAL\Connection;
use Doctrine\Migrations\Configuration\Configuration;
use Doctrine\Migrations\DependencyFactory;
use Doctrine\Migrations\MigrationRepository;
use Doctrine\Migrations\Tools\Console\ConnectionLoader;
use Doctrine\Migrations\Tools\Console\Helper\ConfigurationHelper;
use Doctrine\Migrations\Tools\Console\Helper\ConfigurationHelperInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\HelperSet;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use function escapeshellarg;
use function proc_open;
use function str_repeat;
use function strlen;

abstract class AbstractCommand extends Command
{
    /** @var Configuration */
    protected $configuration;

    /** @var Connection */
    protected $connection;

    /** @var DependencyFactory */
    protected $dependencyFactory;

    /** @var MigrationRepository */
    protected $migrationRepository;

    /** @var Configuration|null */
    protected $migrationConfiguration;

    public function setMigrationConfiguration(Configuration $configuration) : void
    {
        $this->configuration = $configuration;

        $this->initializeDependencies();
    }

    public function setConnection(Connection $connection) : void
    {
        $this->connection = $connection;
    }

    public function setDependencyFactory(DependencyFactory $dependencyFactory) : void
    {
        $this->dependencyFactory = $dependencyFactory;
    }

    public function setMigrationRepository(MigrationRepository $migrationRepository) : void
    {
        $this->migrationRepository = $migrationRepository;
    }

    public function initialize(
        InputInterface $input,
        OutputInterface $output
    ) : void {
        $this->configuration = $this->getMigrationConfiguration($input, $output);

        $this->initializeDependencies();

        $this->configuration->validate();
        $this->configuration->createMigrationTable();
    }

    protected function configure() : void
    {
        $this->addOption(
            'configuration',
            null,
            InputOption::VALUE_OPTIONAL,
            'The path to a migrations configuration file.'
        );

        $this->addOption(
            'db-configuration',
            null,
            InputOption::VALUE_OPTIONAL,
            'The path to a database connection configuration file.'
        );
    }

    protected function outputHeader(
        OutputInterface $output
    ) : void {
        $name = $this->configuration->getName();
        $name = $name ?? 'Doctrine Database Migrations';
        $name = str_repeat(' ', 20) . $name . str_repeat(' ', 20);
        $output->writeln('<question>' . str_repeat(' ', strlen($name)) . '</question>');
        $output->writeln('<question>' . $name . '</question>');
        $output->writeln('<question>' . str_repeat(' ', strlen($name)) . '</question>');
        $output->writeln('');
    }

    protected function getMigrationConfiguration(
        InputInterface $input,
        OutputInterface $output
    ) : Configuration {
        if ($this->migrationConfiguration === null) {
            if ($this->hasConfigurationHelper()) {
                /** @var ConfigurationHelper $configHelper */
                $configHelper = $this->getHelperSet()->get('configuration');
            } else {
                $configHelper = new ConfigurationHelper(
                    $this->getConnection($input),
                    $this->configuration
                );
            }

            $this->migrationConfiguration = $configHelper->getMigrationConfig($input);

            $this->migrationConfiguration->getOutputWriter()->setCallback(
                function (string $message) use ($output) : void {
                    $output->writeln($message);
                }
            );
        }

        if ($this->migrationConfiguration === null && $this->configuration instanceof Configuration) {
            $this->migrationConfiguration = $this->configuration;
        }

        return $this->migrationConfiguration;
    }

    protected function askConfirmation(
        string $question,
        InputInterface $input,
        OutputInterface $output
    ) : bool {
        return $this->getHelper('question')->ask(
            $input,
            $output,
            new ConfirmationQuestion($question)
        );
    }

    protected function canExecute(
        string $question,
        InputInterface $input,
        OutputInterface $output
    ) : bool {
        if ($input->isInteractive() && ! $this->askConfirmation($question, $input, $output)) {
            return false;
        }

        return true;
    }

    protected function procOpen(string $editorCommand, string $path) : void
    {
        proc_open($editorCommand . ' ' . escapeshellarg($path), [], $pipes);
    }

    private function initializeDependencies() : void
    {
        $this->connection          = $this->configuration->getConnection();
        $this->dependencyFactory   = $this->configuration->getDependencyFactory();
        $this->migrationRepository = $this->dependencyFactory->getMigrationRepository();
    }

    private function hasConfigurationHelper() : bool
    {
        $helperSet = $this->getHelperSet();

        if (! $helperSet instanceof HelperSet) {

            return false;
        }

        if (! $helperSet->has('configuration')) {
            return false;
        }

        return $helperSet->get('configuration') instanceof ConfigurationHelperInterface;
    }

    private function getConnection(InputInterface $input) : Connection
    {
        if ($this->connection === null) {
            $this->connection = (new ConnectionLoader($this->configuration))
                ->getConnection($input, $this->getHelperSet());
        }

        return $this->connection;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\Migrations\Tools\Console\Command;
6
7		use Doctrine\DBAL\Connection;
8		use Doctrine\Migrations\Configuration\Configuration;
9		use Doctrine\Migrations\DependencyFactory;
10		use Doctrine\Migrations\MigrationRepository;
11		use Doctrine\Migrations\Tools\Console\ConnectionLoader;
12		use Doctrine\Migrations\Tools\Console\Helper\ConfigurationHelper;
13		use Doctrine\Migrations\Tools\Console\Helper\ConfigurationHelperInterface;
14		use Symfony\Component\Console\Command\Command;
15		use Symfony\Component\Console\Helper\HelperSet;
16		use Symfony\Component\Console\Input\InputInterface;
17		use Symfony\Component\Console\Input\InputOption;
18		use Symfony\Component\Console\Output\OutputInterface;
19		use Symfony\Component\Console\Question\ConfirmationQuestion;
20		use function escapeshellarg;
21		use function proc_open;
22		use function str_repeat;
23		use function strlen;
24
25		abstract class AbstractCommand extends Command
26		{
27		/** @var Configuration */
28		protected $configuration;
29
30		/** @var Connection */
31		protected $connection;
32
33		/** @var DependencyFactory */
34		protected $dependencyFactory;
35
36		/** @var MigrationRepository */
37		protected $migrationRepository;
38
39		/** @var Configuration\|null */
40		protected $migrationConfiguration;
41
42	22	public function setMigrationConfiguration(Configuration $configuration) : void
43		{
44	22	$this->configuration = $configuration;
45
46	22	$this->initializeDependencies();
47	22	}
48
49	1	public function setConnection(Connection $connection) : void
50		{
51	1	$this->connection = $connection;
52	1	}
53
54	17	public function setDependencyFactory(DependencyFactory $dependencyFactory) : void
55		{
56	17	$this->dependencyFactory = $dependencyFactory;
57	17	}
58
59	23	public function setMigrationRepository(MigrationRepository $migrationRepository) : void
60		{
61	23	$this->migrationRepository = $migrationRepository;
62	23	}
63
64	24	public function initialize(
65		InputInterface $input,
66		OutputInterface $output
67		) : void {
68	24	$this->configuration = $this->getMigrationConfiguration($input, $output);
69
70	24	$this->initializeDependencies();
71
72	24	$this->configuration->validate();
73	24	$this->configuration->createMigrationTable();
74	24	}
75
76	59	protected function configure() : void
77		{
78	59	$this->addOption(
79	59	'configuration',
80	59	null,
81	59	InputOption::VALUE_OPTIONAL,
82	59	'The path to a migrations configuration file.'
83		);
84
85	59	$this->addOption(
86	59	'db-configuration',
87	59	null,
88	59	InputOption::VALUE_OPTIONAL,
89	59	'The path to a database connection configuration file.'
90		);
91	59	}
92
93	13	protected function outputHeader(
94		OutputInterface $output
95		) : void {
96	13	$name = $this->configuration->getName();
97	13	$name = $name ?? 'Doctrine Database Migrations';
98	13	$name = str_repeat(' ', 20) . $name . str_repeat(' ', 20);
99	13	$output->writeln('<question>' . str_repeat(' ', strlen($name)) . '</question>');
100	13	$output->writeln('<question>' . $name . '</question>');
101	13	$output->writeln('<question>' . str_repeat(' ', strlen($name)) . '</question>');
102	13	$output->writeln('');
103	13	}
104
105	20	protected function getMigrationConfiguration(
106		InputInterface $input,
107		OutputInterface $output
108		) : Configuration {
109	20	if ($this->migrationConfiguration === null) {
110	20	if ($this->hasConfigurationHelper()) {
111		/** @var ConfigurationHelper $configHelper */
112	1	$configHelper = $this->getHelperSet()->get('configuration');
113		} else {
114	19	$configHelper = new ConfigurationHelper(
115	19	$this->getConnection($input),
116	18	$this->configuration
117		);
118		}
119
120	19	$this->migrationConfiguration = $configHelper->getMigrationConfig($input);
121
122	19	$this->migrationConfiguration->getOutputWriter()->setCallback(
123		function (string $message) use ($output) : void {
124	1	$output->writeln($message);
125	19	}
126		);
127		}
128
129	19	if ($this->migrationConfiguration === null && $this->configuration instanceof Configuration) {
130		$this->migrationConfiguration = $this->configuration;
131		}
132
133	19	return $this->migrationConfiguration;
134		}
135
136	1	protected function askConfirmation(
137		string $question,
138		InputInterface $input,
139		OutputInterface $output
140		) : bool {
141	1	return $this->getHelper('question')->ask(
142	1	$input,
143	1	$output,
144	1	new ConfirmationQuestion($question)
145		);
146		}
147
148	1	protected function canExecute(
149		string $question,
150		InputInterface $input,
151		OutputInterface $output
152		) : bool {
153	1	if ($input->isInteractive() && ! $this->askConfirmation($question, $input, $output)) {
154		return false;
155		}
156
157	1	return true;
158		}
159
160	1	protected function procOpen(string $editorCommand, string $path) : void
161		{
162	1	proc_open($editorCommand . ' ' . escapeshellarg($path), [], $pipes);
163	1	}
164
165	46	private function initializeDependencies() : void
166		{
167	46	$this->connection = $this->configuration->getConnection();
168	46	$this->dependencyFactory = $this->configuration->getDependencyFactory();
169	46	$this->migrationRepository = $this->dependencyFactory->getMigrationRepository();
170	46	}
171
172	20	private function hasConfigurationHelper() : bool
173		{
174	20	$helperSet = $this->getHelperSet();
175
176	20	if (! $helperSet instanceof HelperSet) {
		0 ignored issues – show introduced 2018-05-11 16:51 UTC by Report Bug Copy Issue Report `$helperSet` is always a sub-type of `Symfony\Component\Console\Helper\HelperSet`. Loading history...
177	1	return false;
178		}
179
180	19	if (! $helperSet->has('configuration')) {
181	18	return false;
182		}
183
184	1	return $helperSet->get('configuration') instanceof ConfigurationHelperInterface;
185		}
186
187	19	private function getConnection(InputInterface $input) : Connection
188		{
189	19	if ($this->connection === null) {
190	14	$this->connection = (new ConnectionLoader($this->configuration))
191	14	->getConnection($input, $this->getHelperSet());
192		}
193
194	18	return $this->connection;
195		}
196		}
197

doctrine / migrations

Push — master ( 5ff3e1...46578f )

AbstractCommand::askConfirmation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like