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

Completed

Push — master ( 39c620...12e227 )

by Mike

created 2015-12-15 01:14 UTC

AbstractCommand::askConfirmation() A

↳ Parent: AbstractCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
dl	0
loc	8
c	1
b	1
f	0
ccs	4
cts	4
cp	1
rs	9.4286
cc	2
eloc	4
nc	2
nop	3
crap	2

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\DBAL\Migrations\Tools\Console\Command;

use Doctrine\DBAL\DriverManager;
use Doctrine\DBAL\Migrations\Configuration\Configuration;
use Doctrine\DBAL\Migrations\OutputWriter;
use Doctrine\DBAL\Migrations\Tools\Console\Helper\ConfigurationHelper;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Question\ConfirmationQuestion;

/**
 * CLI Command for adding and deleting migration versions from the version table.
 *
 * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link    www.doctrine-project.org
 * @since   2.0
 * @author  Jonathan Wage <[email protected]>
 */
abstract class AbstractCommand extends Command
{
    /**
     * The configuration property only contains the configuration injected by the setter.
     *
     * @var Configuration
     */
    private $configuration;

    /**
     * The migrationConfiguration property contains the configuration
     * created taking into account the command line options.
     *
     * @var Configuration
     */
    private $migrationConfiguration;

    /**
     * @var OutputWriter
     */
    private $outputWriter;

    /**
     * @var \Doctrine\DBAL\Connection
     */
    private $connection;

    protected function configure()
    {
        $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(Configuration $configuration, OutputInterface $output)
    {
        $name = $configuration->getName();
        $name = $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('');
    }

    public function setMigrationConfiguration(Configuration $config)
    {
        $this->configuration = $config;
    }

    /**
     * When any (config) command line option is passed to the migration the migrationConfiguration
     * property is set with the new generated configuration.
     * If no (config) option is passed the migrationConfiguration property is set to the value
     * of the configuration one (if any).
     * Else a new configuration is created and assigned to the migrationConfiguration property.
     *
     * @param InputInterface  $input
     * @param OutputInterface $output
     *
     * @return Configuration
     */
    protected function getMigrationConfiguration(InputInterface $input, OutputInterface $output)
    {
        if (!$this->migrationConfiguration) {
            if ($this->getHelperSet()->has('configuration')
                && $this->getHelperSet()->get('configuration') instanceof ConfigurationHelper) {
                $configHelper = $this->getHelperSet()->get('configuration');
            } else {
                $configHelper = new ConfigurationHelper($this->getConnection($input), $this->configuration);
            }
            $this->migrationConfiguration = $configHelper->getMigrationConfig($input, $this->getOutputWriter($output));
        }

        return $this->migrationConfiguration;
    }

    /**
     * This method ensure that we stay compatible with symfony console 2.3 by using the deprecated dialog helper
     * but use the ConfirmationQuestion when available.
     *
     * @param $question
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return mixed
     */
    protected function askConfirmation($question, InputInterface $input, OutputInterface $output)
    {
        if (!$this->getHelperSet()->has('question')) {
            return $this->getHelper('dialog')->askConfirmation($output, '<question>' . $question . '</question>', false);
        }

        return $this->getHelper('question')->ask($input, $output, new ConfirmationQuestion($question));
    }

    /**
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     *
     * @return \Doctrine\DBAL\Migrations\OutputWriter
     */
    private function getOutputWriter(OutputInterface $output)
    {
        if (!$this->outputWriter) {
            $this->outputWriter = new OutputWriter(function($message) use ($output) {
                return $output->writeln($message);
            });
        }

        return $this->outputWriter;
    }

    /**
     * @param \Symfony\Component\Console\Input\InputInterface $input
     *
     * @return \Doctrine\DBAL\Connection
     * @throws \Doctrine\DBAL\DBALException
     */
    private function getConnection(InputInterface $input)
    {
        if (!$this->connection) {
            if ($input->getOption('db-configuration')) {
                if (!file_exists($input->getOption('db-configuration'))) {
                    throw new \InvalidArgumentException("The specified connection file is not a valid file.");
                }

                $params = include $input->getOption('db-configuration');
                if (!is_array($params)) {
                    throw new \InvalidArgumentException('The connection file has to return an array with database configuration parameters.');
                }
                $this->connection = DriverManager::getConnection($params);
            } elseif (file_exists('migrations-db.php')) {
                $params = include 'migrations-db.php';
                if (!is_array($params)) {
                    throw new \InvalidArgumentException('The connection file has to return an array with database configuration parameters.');
                }
                $this->connection = DriverManager::getConnection($params);
            } elseif ($this->getHelperSet()->has('connection')) {
                $this->connection = $this->getHelper('connection')->getConnection();
            } elseif ($this->configuration) {
                $this->connection = $this->configuration->getConnection();
            } else {
                throw new \InvalidArgumentException('You have to specify a --db-configuration file or pass a Database Connection as a dependency to the Migrations.');
            }
        }

        return $this->connection;
    }

}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the LGPL. For more information, see
17		* <http://www.doctrine-project.org>.
18		*/
19
20		namespace Doctrine\DBAL\Migrations\Tools\Console\Command;
21
22		use Doctrine\DBAL\DriverManager;
23		use Doctrine\DBAL\Migrations\Configuration\Configuration;
24		use Doctrine\DBAL\Migrations\OutputWriter;
25		use Doctrine\DBAL\Migrations\Tools\Console\Helper\ConfigurationHelper;
26		use Symfony\Component\Console\Command\Command;
27		use Symfony\Component\Console\Input\InputInterface;
28		use Symfony\Component\Console\Output\OutputInterface;
29		use Symfony\Component\Console\Input\InputOption;
30		use Symfony\Component\Console\Question\ConfirmationQuestion;
31
32		/**
33		* CLI Command for adding and deleting migration versions from the version table.
34		*
35		* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
36		* @link www.doctrine-project.org
37		* @since 2.0
38		* @author Jonathan Wage <[email protected]>
39		*/
40		abstract class AbstractCommand extends Command
41		{
42		/**
43		* The configuration property only contains the configuration injected by the setter.
44		*
45		* @var Configuration
46		*/
47		private $configuration;
48
49		/**
50		* The migrationConfiguration property contains the configuration
51		* created taking into account the command line options.
52		*
53		* @var Configuration
54		*/
55		private $migrationConfiguration;
56
57		/**
58		* @var OutputWriter
59		*/
60		private $outputWriter;
61
62		/**
63		* @var \Doctrine\DBAL\Connection
64		*/
65		private $connection;
66
67	33	protected function configure()
68		{
69	33	$this->addOption('configuration', null, InputOption::VALUE_OPTIONAL, 'The path to a migrations configuration file.');
70	33	$this->addOption('db-configuration', null, InputOption::VALUE_OPTIONAL, 'The path to a database connection configuration file.');
71	33	}
72
73	1	protected function outputHeader(Configuration $configuration, OutputInterface $output)
74		{
75	1	$name = $configuration->getName();
76	1	$name = $name ? $name : 'Doctrine Database Migrations';
77	1	$name = str_repeat(' ', 20) . $name . str_repeat(' ', 20);
78	1	$output->writeln('<question>' . str_repeat(' ', strlen($name)) . '</question>');
79	1	$output->writeln('<question>' . $name . '</question>');
80	1	$output->writeln('<question>' . str_repeat(' ', strlen($name)) . '</question>');
81	1	$output->writeln('');
82	1	}
83
84	4	public function setMigrationConfiguration(Configuration $config)
85		{
86	4	$this->configuration = $config;
87	4	}
88
89		/**
90		* When any (config) command line option is passed to the migration the migrationConfiguration
91		* property is set with the new generated configuration.
92		* If no (config) option is passed the migrationConfiguration property is set to the value
93		* of the configuration one (if any).
94		* Else a new configuration is created and assigned to the migrationConfiguration property.
95		*
96		* @param InputInterface $input
97		* @param OutputInterface $output
98		*
99		* @return Configuration
100		*/
101	16	protected function getMigrationConfiguration(InputInterface $input, OutputInterface $output)
102		{
103	16	if (!$this->migrationConfiguration) {
104	16	if ($this->getHelperSet()->has('configuration')
105	16	&& $this->getHelperSet()->get('configuration') instanceof ConfigurationHelper) {
106	1	$configHelper = $this->getHelperSet()->get('configuration');
107	1	} else {
108	15	$configHelper = new ConfigurationHelper($this->getConnection($input), $this->configuration);
109		}
110	15	$this->migrationConfiguration = $configHelper->getMigrationConfig($input, $this->getOutputWriter($output));
111	15	}
112
113	15	return $this->migrationConfiguration;
114		}
115
116		/**
117		* This method ensure that we stay compatible with symfony console 2.3 by using the deprecated dialog helper
118		* but use the ConfirmationQuestion when available.
119		*
120		* @param $question
121		* @param InputInterface $input
122		* @param OutputInterface $output
123		* @return mixed
124		*/
125	2	protected function askConfirmation($question, InputInterface $input, OutputInterface $output)
126		{
127	2	if (!$this->getHelperSet()->has('question')) {
128	1	return $this->getHelper('dialog')->askConfirmation($output, '<question>' . $question . '</question>', false);
129		}
130
131	2	return $this->getHelper('question')->ask($input, $output, new ConfirmationQuestion($question));
132		}
133
134		/**
135		* @param \Symfony\Component\Console\Output\OutputInterface $output
136		*
137		* @return \Doctrine\DBAL\Migrations\OutputWriter
138		*/
139	15	private function getOutputWriter(OutputInterface $output)
140		{
141	15	if (!$this->outputWriter) {
142	15	$this->outputWriter = new OutputWriter(function($message) use ($output) {
143	13	return $output->writeln($message);
144	15	});
145	15	}
146
147	15	return $this->outputWriter;
148		}
149
150		/**
151		* @param \Symfony\Component\Console\Input\InputInterface $input
152		*
153		* @return \Doctrine\DBAL\Connection
154		* @throws \Doctrine\DBAL\DBALException
155		*/
156	15	private function getConnection(InputInterface $input)
157		{
158	15	if (!$this->connection) {
159	15	if ($input->getOption('db-configuration')) {
160	1	if (!file_exists($input->getOption('db-configuration'))) {
161		throw new \InvalidArgumentException("The specified connection file is not a valid file.");
162		}
163
164	1	$params = include $input->getOption('db-configuration');
165	1	if (!is_array($params)) {
166		throw new \InvalidArgumentException('The connection file has to return an array with database configuration parameters.');
167		}
168	1	$this->connection = DriverManager::getConnection($params);
169	15	} elseif (file_exists('migrations-db.php')) {
170		$params = include 'migrations-db.php';
171		if (!is_array($params)) {
172		throw new \InvalidArgumentException('The connection file has to return an array with database configuration parameters.');
173		}
174		$this->connection = DriverManager::getConnection($params);
175	14	} elseif ($this->getHelperSet()->has('connection')) {
176	12	$this->connection = $this->getHelper('connection')->getConnection();
177	14	} elseif ($this->configuration) {
178	1	$this->connection = $this->configuration->getConnection();
179	1	} else {
180	1	throw new \InvalidArgumentException('You have to specify a --db-configuration file or pass a Database Connection as a dependency to the Migrations.');
181		}
182	14	}
183
184	14	return $this->connection;
185		}
186
187		}
188

doctrine / migrations

Push — master ( 39c620...12e227 )

AbstractCommand::askConfirmation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like