DropDatabaseDoctrineCommand::fixShardInformation() - Code Metrics - Inspection of "change name, start splitting method" - chubbyphp/chubbyphp-doctrine-db-service-provider - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 52b8fa...e2a99d )

by Dominik

created 2018-08-05 20:13 UTC

DropDatabaseDoctrineCommand::fixShardInformation() A

↳ Parent: DropDatabaseDoctrineCommand

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes

Metric	Value
dl	0
loc	20
ccs	0
cts	17
cp	0
rs	9.2888
c	0
b	0
f	0
cc	5
nc	5
nop	2
crap	30

<?php

declare(strict_types=1);

namespace Chubbyphp\DoctrineDbServiceProvider\Command;

use Doctrine\Common\Persistence\ConnectionRegistry;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\DriverManager;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * @see https://github.com/doctrine/DoctrineBundle/blob/master/Command/DropDatabaseDoctrineCommand.php
 */
class DropDatabaseDoctrineCommand extends Command
{
    const RETURN_CODE_NOT_DROP = 1;

    const RETURN_CODE_NO_FORCE = 2;

    /**
     * @var ConnectionRegistry
     */
    private $connectionRegistry;

    /**
     * @param ConnectionRegistry $connectionRegistry
     */
    public function __construct(ConnectionRegistry $connectionRegistry)
    {
        parent::__construct();

        $this->connectionRegistry = $connectionRegistry;
    }

    protected function configure()
    {
        $this
            ->setName('dbal:database:drop')
            ->setDescription('Drops the configured database')
            ->addOption('shard', null, InputOption::VALUE_REQUIRED, 'The shard connection to use for this command')
            ->addOption('connection', null, InputOption::VALUE_OPTIONAL, 'The connection to use for this command')
            ->addOption(
                'if-exists',
                null,
                InputOption::VALUE_NONE,
                'Don\'t trigger an error, when the database doesn\'t exist'
            )
            ->addOption('force', null, InputOption::VALUE_NONE, 'Set this parameter to execute this action')
            ->setHelp(<<<EOT
The <info>%command.name%</info> command drops the default connections database:

    <info>php %command.full_name%</info>

The <info>--force</info> parameter has to be used to actually drop the database.

You can also optionally specify the name of a connection to drop the database for:

    <info>php %command.full_name% --connection=default</info>

<error>Be careful: All data in a given database will be lost when executing this command.</error>
EOT
            );
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     *
     * @return int
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $connectionName = $this->getConnectionName($input);

        $connection = $this->connectionRegistry->getConnection($connectionName);

        $ifExists = $input->getOption('if-exists');

        $params = $this->getParams($connection);

        // Cannot inject `shard` option in parent::getDoctrineConnection
        // cause it will try to connect to a non-existing database
        $params = $this->fixShardInformation($input, $params);

        $name = isset($params['path']) ? $params['path'] : (isset($params['dbname']) ? $params['dbname'] : false);
        if (!$name) {
            throw new \InvalidArgumentException(
                'Connection does not contain a \'path\' or \'dbname\' parameter and cannot be dropped.'
            );
        }

        unset($params['dbname'], $params['url']);

        if (!$input->getOption('force')) {
            $output->writeln(
                '<error>ATTENTION:</error> This operation should not be executed in a production environment.'
            );
            $output->writeln('');
            $output->writeln(
                sprintf(
                    '<info>Would drop the database <comment>%s</comment> for connection'
                        .' named <comment>%s</comment>.</info>',
                    $name,
                    $connectionName
                )
            );
            $output->writeln('Please run the operation with --force to execute');
            $output->writeln('<error>All data will be lost!</error>');

            return self::RETURN_CODE_NO_FORCE;
        }

        // Reopen connection without database name set
        // as some vendors do not allow dropping the database connected to.
        $connection->close();
        $connection = DriverManager::getConnection($params);
        $shouldDropDatabase = !$ifExists || in_array($name, $connection->getSchemaManager()->listDatabases());

        // Only quote if we don't have a path
        if (!isset($params['path'])) {
            $name = $connection->getDatabasePlatform()->quoteSingleIdentifier($name);
        }

        try {
            if ($shouldDropDatabase) {
                $connection->getSchemaManager()->dropDatabase($name);
                $output->writeln(
                    sprintf(
                        '<info>Dropped database <comment>%s</comment> for connection'
                            .' named <comment>%s</comment></info>',
                        $name,
                        $connectionName
                    )
                );
            } else {
                $output->writeln(
                    sprintf(
                        '<info>Database <comment>%s</comment> for connection named <comment>%s</comment>'
                            .' doesn\'t exist. Skipped.</info>',
                        $name,
                        $connectionName
                    )
                );
            }
        } catch (\Exception $e) {
            $output->writeln(
                sprintf(
                    '<error>Could not drop database <comment>%s</comment> for connection'
                        .' named <comment>%s</comment></error>',
                    $name,
                    $connectionName
                )
            );
            $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));

            return self::RETURN_CODE_NOT_DROP;
        }

        return 0;
    }

    /**
     * @param InputInterface $input
     *
     * @return string
     */
    private function getConnectionName(InputInterface $input): string

    {
        $connectionName = $input->getOption('connection');

        if ('' !== $connectionName) {
            return $connectionName;
        }

        return $this->connectionRegistry->getDefaultConnectionName();
    }

    /**
     * @param Connection $connection
     *
     * @return array
     */
    private function getParams(Connection $connection): array

    {
        $params = $connection->getParams();
        if (isset($params['master'])) {
            $params = $params['master'];
        }

        return $params;
    }

    /**
     * @param InputInterface $input
     * @param array          $params
     *
     * @return array
     */
    private function fixShardInformation(InputInterface $input, array $params): array
    {
        if (isset($params['shards'])) {
            $shards = $params['shards'];
            // Default select global
            $params = array_merge($params, $params['global']);
            if ($input->getOption('shard')) {
                foreach ($shards as $shard) {
                    if ($shard['id'] === (int) $input->getOption('shard')) {
                        // Select sharded database
                        $params = $shard;
                        unset($params['id']);
                        break;
                    }
                }
            }
        }

        return $params;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Chubbyphp\DoctrineDbServiceProvider\Command;
6
7		use Doctrine\Common\Persistence\ConnectionRegistry;
8		use Doctrine\DBAL\Connection;
9		use Doctrine\DBAL\DriverManager;
10		use Symfony\Component\Console\Command\Command;
11		use Symfony\Component\Console\Input\InputInterface;
12		use Symfony\Component\Console\Input\InputOption;
13		use Symfony\Component\Console\Output\OutputInterface;
14
15		/**
16		* @see https://github.com/doctrine/DoctrineBundle/blob/master/Command/DropDatabaseDoctrineCommand.php
17		*/
18		class DropDatabaseDoctrineCommand extends Command
19		{
20		const RETURN_CODE_NOT_DROP = 1;
21
22		const RETURN_CODE_NO_FORCE = 2;
23
24		/**
25		* @var ConnectionRegistry
26		*/
27		private $connectionRegistry;
28
29		/**
30		* @param ConnectionRegistry $connectionRegistry
31		*/
32		public function __construct(ConnectionRegistry $connectionRegistry)
33		{
34		parent::__construct();
35
36		$this->connectionRegistry = $connectionRegistry;
37		}
38
39		protected function configure()
40		{
41		$this
42		->setName('dbal:database:drop')
43		->setDescription('Drops the configured database')
44		->addOption('shard', null, InputOption::VALUE_REQUIRED, 'The shard connection to use for this command')
45		->addOption('connection', null, InputOption::VALUE_OPTIONAL, 'The connection to use for this command')
46		->addOption(
47		'if-exists',
48		null,
49		InputOption::VALUE_NONE,
50		'Don\'t trigger an error, when the database doesn\'t exist'
51		)
52		->addOption('force', null, InputOption::VALUE_NONE, 'Set this parameter to execute this action')
53		->setHelp(<<<EOT
54		The <info>%command.name%</info> command drops the default connections database:
55
56		<info>php %command.full_name%</info>
57
58		The <info>--force</info> parameter has to be used to actually drop the database.
59
60		You can also optionally specify the name of a connection to drop the database for:
61
62		<info>php %command.full_name% --connection=default</info>
63
64		<error>Be careful: All data in a given database will be lost when executing this command.</error>
65		EOT
66		);
67		}
68
69		/**
70		* @param InputInterface $input
71		* @param OutputInterface $output
72		*
73		* @return int
74		*/
75		protected function execute(InputInterface $input, OutputInterface $output): int
76		{
77		$connectionName = $this->getConnectionName($input);
78
79		$connection = $this->connectionRegistry->getConnection($connectionName);
80
81		$ifExists = $input->getOption('if-exists');
82
83		$params = $this->getParams($connection);
84
85		// Cannot inject `shard` option in parent::getDoctrineConnection
86		// cause it will try to connect to a non-existing database
87		$params = $this->fixShardInformation($input, $params);
88
89		$name = isset($params['path']) ? $params['path'] : (isset($params['dbname']) ? $params['dbname'] : false);
90		if (!$name) {
91		throw new \InvalidArgumentException(
92		'Connection does not contain a \'path\' or \'dbname\' parameter and cannot be dropped.'
93		);
94		}
95
96		unset($params['dbname'], $params['url']);
97
98		if (!$input->getOption('force')) {
99		$output->writeln(
100		'<error>ATTENTION:</error> This operation should not be executed in a production environment.'
101		);
102		$output->writeln('');
103		$output->writeln(
104		sprintf(
105		'<info>Would drop the database <comment>%s</comment> for connection'
106		.' named <comment>%s</comment>.</info>',
107		$name,
108		$connectionName
109		)
110		);
111		$output->writeln('Please run the operation with --force to execute');
112		$output->writeln('<error>All data will be lost!</error>');
113
114		return self::RETURN_CODE_NO_FORCE;
115		}
116
117		// Reopen connection without database name set
118		// as some vendors do not allow dropping the database connected to.
119		$connection->close();
120		$connection = DriverManager::getConnection($params);
121		$shouldDropDatabase = !$ifExists \|\| in_array($name, $connection->getSchemaManager()->listDatabases());
122
123		// Only quote if we don't have a path
124		if (!isset($params['path'])) {
125		$name = $connection->getDatabasePlatform()->quoteSingleIdentifier($name);
126		}
127
128		try {
129		if ($shouldDropDatabase) {
130		$connection->getSchemaManager()->dropDatabase($name);
131		$output->writeln(
132		sprintf(
133		'<info>Dropped database <comment>%s</comment> for connection'
134		.' named <comment>%s</comment></info>',
135		$name,
136		$connectionName
137		)
138		);
139		} else {
140		$output->writeln(
141		sprintf(
142		'<info>Database <comment>%s</comment> for connection named <comment>%s</comment>'
143		.' doesn\'t exist. Skipped.</info>',
144		$name,
145		$connectionName
146		)
147		);
148		}
149		} catch (\Exception $e) {
150		$output->writeln(
151		sprintf(
152		'<error>Could not drop database <comment>%s</comment> for connection'
153		.' named <comment>%s</comment></error>',
154		$name,
155		$connectionName
156		)
157		);
158		$output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
159
160		return self::RETURN_CODE_NOT_DROP;
161		}
162
163		return 0;
164		}
165
166		/**
167		* @param InputInterface $input
168		*
169		* @return string
170		*/
171	View Code Duplication	private function getConnectionName(InputInterface $input): string
		0 ignored issues – show Duplication introduced 2018-08-05 20:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
172		{
173		$connectionName = $input->getOption('connection');
174
175		if ('' !== $connectionName) {
176		return $connectionName;
177		}
178
179		return $this->connectionRegistry->getDefaultConnectionName();
180		}
181
182		/**
183		* @param Connection $connection
184		*
185		* @return array
186		*/
187	View Code Duplication	private function getParams(Connection $connection): array
		0 ignored issues – show Duplication introduced 2018-08-05 20:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
188		{
189		$params = $connection->getParams();
190		if (isset($params['master'])) {
191		$params = $params['master'];
192		}
193
194		return $params;
195		}
196
197		/**
198		* @param InputInterface $input
199		* @param array $params
200		*
201		* @return array
202		*/
203		private function fixShardInformation(InputInterface $input, array $params): array
204		{
205		if (isset($params['shards'])) {
206		$shards = $params['shards'];
207		// Default select global
208		$params = array_merge($params, $params['global']);
209		if ($input->getOption('shard')) {
210		foreach ($shards as $shard) {
211		if ($shard['id'] === (int) $input->getOption('shard')) {
212		// Select sharded database
213		$params = $shard;
214		unset($params['id']);
215		break;
216		}
217		}
218		}
219		}
220
221		return $params;
222		}
223		}
224

chubbyphp / chubbyphp-doctrine-db-service-provider

Push — master ( 52b8fa...e2a99d )

DropDatabaseDoctrineCommand::fixShardInformation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like