CreateMigrationCommand::getKeywords() - Code Metrics - Inspection of "Fix guessing the keywords from user's input (#4)" - rougin/refinery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 60ed15...bfdf06 )

by Rougin

created 2017-01-06 16:26 UTC

CreateMigrationCommand::getKeywords() B

↳ Parent: CreateMigrationCommand

Complexity

Conditions	5
Paths	8

Size

Total Lines	30
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	30
ccs	17
cts	17
cp	1
rs	8.439
c	0
b	0
f	0
cc	5
eloc	16
nc	8
nop	2
crap	5

<?php

namespace Rougin\Refinery\Commands;

use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Create Migration Command
 *
 * Creates a new migration file based on its file name.
 *
 * @package Refinery
 * @author  Rougin Royce Gutib <[email protected]>
 */
class CreateMigrationCommand extends AbstractCommand
{
    /**
     * Checks whether the command is enabled or not in the current environment.
     *
     * @return boolean
     */
    public function isEnabled()
    {
        return true;
    }

    /**
     * Sets the configurations of the specified command.
     *
     * @return void
     */
    protected function configure()
    {
        $this->setName('create')
            ->setDescription('Creates a new migration file')
            ->addArgument('name', InputArgument::REQUIRED, 'Name of the migration file')
            ->addOption('from-database', null, InputOption::VALUE_NONE, 'Generates a migration based from the database')
            ->addOption('sequential', null, InputOption::VALUE_NONE, 'Generates a migration file with a sequential identifier')
            ->addOption('type', null, InputOption::VALUE_OPTIONAL, 'Data type of the column', 'varchar')
            ->addOption('length', null, InputOption::VALUE_OPTIONAL, 'Length of the column', 50)
            ->addOption('auto_increment', null, InputOption::VALUE_OPTIONAL, 'Generates an "AUTO_INCREMENT" flag on the column', false)
            ->addOption('default', null, InputOption::VALUE_OPTIONAL, 'Generates a default value in the column definition', '')
            ->addOption('null', null, InputOption::VALUE_OPTIONAL, 'Generates a "NULL" value in the column definition', false)
            ->addOption('primary', null, InputOption::VALUE_OPTIONAL, 'Generates a "PRIMARY" value in the column definition', false)
            ->addOption('unsigned', null, InputOption::VALUE_OPTIONAL, 'Generates an "UNSIGNED" value in the column definition', false);
    }

    /**
     * Executes the command.
     *
     * @param  \Symfony\Component\Console\Input\InputInterface   $input
     * @param  \Symfony\Component\Console\Output\OutputInterface $output
     * @return object|\Symfony\Component\Console\Output\OutputInterface
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $fileName = $this->getFileName($input->getArgument('name'), $input->getOption('sequential'));
        $keywords = $this->getKeywords($input->getArgument('name'), $input->getOption('from-database'));

        $data = $this->prepareData($input, $keywords);

        if ($data['command_name'] != 'create') {
            $data = $this->defineColumns($input, $keywords, $data);
        }

        $rendered = $this->renderer->render('Migration.twig', $data);
        $rendered = str_replace("));\n\n\t}", "));\n\t}", $rendered);

        $this->filesystem->write('application/migrations/' . $fileName . '.php', $rendered);

        return $output->writeln('<info>"' . $fileName . '" has been created.</info>');
    }

    /**
     * Defines the columns to be included in the migration.
     *
     * @param  \Symfony\Component\Console\Input\InputInterface $input
     * @param  array                                           $keywords
     * @param  array                                           $data
     * @return array
     */
    protected function defineColumns(InputInterface $input, array $keywords, array $data)
    {
        $data['table_name'] = $keywords[1];

        array_push($data['columns'], $this->setColumn($input, $keywords[2]));

        if ($data['command_name'] == 'modify' || $data['command_name'] == 'update') {
            foreach ($this->describe->getTable($data['table_name']) as $column) {
                $column->getField() != $keywords[2] || array_push($data['defaults'], $column);
            }
        }

        return $data;
    }

    /**
     * Gets the file name of the specified migration.
     *
     * @param  string  $name
     * @param  boolean $isSequential
     * @return string
     */
    protected function getFileName($name, $isSequential = false)
    {
        $migrationType = $this->getMigrationType();

        $fileName = date('YmdHis') . '_' . underscore($name);

        if ($migrationType == 'sequential' || $isSequential) {
            $number = 1;

            $files = new \FilesystemIterator(APPPATH . 'migrations', \FilesystemIterator::SKIP_DOTS);

            $number += iterator_count($files);

            $sequence = sprintf('%03d', $number);
            $fileName = $sequence . '_' . substr($fileName, 15);
        }

        return $fileName;
    }

    /**
     * Gets the defined keywords from the command.
     *
     * @param  string  $name
     * @param  boolean $fromDatabase
     * @return array
     */
    protected function getKeywords($name, $fromDatabase = false)
    {
        $empty = [ '', '', '' ];
        $path  = APPPATH . 'migrations';

        file_exists($path) || mkdir($path);

        preg_match('/(.*?)_(.*?)_table/', underscore($name), $keywords);

        if (strpos($keywords[2], '_in') !== false) {
            preg_match('/(.*?)_(.*?)_in_(.*?)_table/', underscore($name), $keywords);

            $temp = $keywords[3];

            $keywords[3] = $keywords[2];
            $keywords[2] = $temp;
        }

        array_shift($keywords);

        $keywords = array_replace($empty, $keywords);

        if ($fromDatabase && $keywords[0] != 'create') {
            $message = '--from-database is only available to create_*table*_table keyword';

            throw new \InvalidArgumentException($message);
        }

        return $keywords;
    }

    /**
     * Prepares the data to be inserted in the template.
     *
     * @param  \Symfony\Component\Console\Input\InputInterface $input
     * @param  array                                           $keywords
     * @return array
     */
    protected function prepareData(InputInterface $input, array $keywords)
    {
        $data = [];

        $data['command_name'] = $keywords[0];
        $data['data_types']   = [ 'string' => 'VARCHAR', 'integer' => 'INT' ];
        $data['class_name']   = underscore($input->getArgument('name'));
        $data['table_name']   = $keywords[1];

        $data['columns']  = [];
        $data['defaults'] = [];

        if ($input->getOption('from-database') && $data['command_name'] == 'create') {
            $data['columns'] = $this->describe->getTable($data['table_name']);
        }

        return $data;
    }

    /**
     * Sets properties for a specified column
     *
     * @param  \Symfony\Component\Console\Input\InputInterface $input
     * @param  string                                          $fieldName
     * @return \Rougin\Describe\Column
     */
    protected function setColumn(InputInterface $input, $fieldName)
    {
        $column = new \Rougin\Describe\Column;

        $column->setField($fieldName);
        $column->setNull($input->getOption('null'));
        $column->setDataType($input->getOption('type'));
        $column->setLength($input->getOption('length'));
        $column->setPrimary($input->getOption('primary'));
        $column->setUnsigned($input->getOption('unsigned'));
        $column->setDefaultValue($input->getOption('default'));
        $column->setAutoIncrement($input->getOption('auto_increment'));

        return $column;
    }
}


1		<?php
2
3		namespace Rougin\Refinery\Commands;
4
5		use Symfony\Component\Console\Input\InputOption;
6		use Symfony\Component\Console\Input\InputArgument;
7		use Symfony\Component\Console\Input\InputInterface;
8		use Symfony\Component\Console\Output\OutputInterface;
9
10		/**
11		* Create Migration Command
12		*
13		* Creates a new migration file based on its file name.
14		*
15		* @package Refinery
16		* @author Rougin Royce Gutib <[email protected]>
17		*/
18		class CreateMigrationCommand extends AbstractCommand
19		{
20		/**
21		* Checks whether the command is enabled or not in the current environment.
22		*
23		* @return boolean
24		*/
25	3	public function isEnabled()
26		{
27	3	return true;
28		}
29
30		/**
31		* Sets the configurations of the specified command.
32		*
33		* @return void
34		*/
35	33	protected function configure()
36		{
37	33	$this->setName('create')
38	33	->setDescription('Creates a new migration file')
39	33	->addArgument('name', InputArgument::REQUIRED, 'Name of the migration file')
40	33	->addOption('from-database', null, InputOption::VALUE_NONE, 'Generates a migration based from the database')
41	33	->addOption('sequential', null, InputOption::VALUE_NONE, 'Generates a migration file with a sequential identifier')
42	33	->addOption('type', null, InputOption::VALUE_OPTIONAL, 'Data type of the column', 'varchar')
43	33	->addOption('length', null, InputOption::VALUE_OPTIONAL, 'Length of the column', 50)
44	33	->addOption('auto_increment', null, InputOption::VALUE_OPTIONAL, 'Generates an "AUTO_INCREMENT" flag on the column', false)
45	33	->addOption('default', null, InputOption::VALUE_OPTIONAL, 'Generates a default value in the column definition', '')
46	33	->addOption('null', null, InputOption::VALUE_OPTIONAL, 'Generates a "NULL" value in the column definition', false)
47	33	->addOption('primary', null, InputOption::VALUE_OPTIONAL, 'Generates a "PRIMARY" value in the column definition', false)
48	33	->addOption('unsigned', null, InputOption::VALUE_OPTIONAL, 'Generates an "UNSIGNED" value in the column definition', false);
49	33	}
50
51		/**
52		* Executes the command.
53		*
54		* @param \Symfony\Component\Console\Input\InputInterface $input
55		* @param \Symfony\Component\Console\Output\OutputInterface $output
56		* @return object\|\Symfony\Component\Console\Output\OutputInterface
57		*/
58	27	protected function execute(InputInterface $input, OutputInterface $output)
59		{
60	27	$fileName = $this->getFileName($input->getArgument('name'), $input->getOption('sequential'));
61	27	$keywords = $this->getKeywords($input->getArgument('name'), $input->getOption('from-database'));
62
63	24	$data = $this->prepareData($input, $keywords);
64
65	24	if ($data['command_name'] != 'create') {
66	6	$data = $this->defineColumns($input, $keywords, $data);
67	6	}
68
69	24	$rendered = $this->renderer->render('Migration.twig', $data);
70	24	$rendered = str_replace("));\n\n\t}", "));\n\t}", $rendered);
71
72	24	$this->filesystem->write('application/migrations/' . $fileName . '.php', $rendered);
73
74	24	return $output->writeln('<info>"' . $fileName . '" has been created.</info>');
75		}
76
77		/**
78		* Defines the columns to be included in the migration.
79		*
80		* @param \Symfony\Component\Console\Input\InputInterface $input
81		* @param array $keywords
82		* @param array $data
83		* @return array
84		*/
85	6	protected function defineColumns(InputInterface $input, array $keywords, array $data)
86		{
87	6	$data['table_name'] = $keywords[1];
88
89	6	array_push($data['columns'], $this->setColumn($input, $keywords[2]));
90
91	6	if ($data['command_name'] == 'modify' \|\| $data['command_name'] == 'update') {
92	3	foreach ($this->describe->getTable($data['table_name']) as $column) {
93	3	$column->getField() != $keywords[2] \|\| array_push($data['defaults'], $column);
94	3	}
95	3	}
96
97	6	return $data;
98		}
99
100		/**
101		* Gets the file name of the specified migration.
102		*
103		* @param string $name
104		* @param boolean $isSequential
105		* @return string
106		*/
107	27	protected function getFileName($name, $isSequential = false)
108		{
109	27	$migrationType = $this->getMigrationType();
110
111	27	$fileName = date('YmdHis') . '_' . underscore($name);
112
113	27	if ($migrationType == 'sequential' \|\| $isSequential) {
114	3	$number = 1;
115
116	3	$files = new \FilesystemIterator(APPPATH . 'migrations', \FilesystemIterator::SKIP_DOTS);
117
118	3	$number += iterator_count($files);
119
120	3	$sequence = sprintf('%03d', $number);
121	3	$fileName = $sequence . '_' . substr($fileName, 15);
122	3	}
123
124	27	return $fileName;
125		}
126
127		/**
128		* Gets the defined keywords from the command.
129		*
130		* @param string $name
131		* @param boolean $fromDatabase
132		* @return array
133		*/
134	27	protected function getKeywords($name, $fromDatabase = false)
135		{
136	27	$empty = [ '', '', '' ];
137	27	$path = APPPATH . 'migrations';
138
139	27	file_exists($path) \|\| mkdir($path);
140
141	27	preg_match('/(.?)_(.?)_table/', underscore($name), $keywords);
142
143	27	if (strpos($keywords[2], '_in') !== false) {
144	9	preg_match('/(.?)_(.?)_in_(.*?)_table/', underscore($name), $keywords);
145
146	9	$temp = $keywords[3];
147
148	9	$keywords[3] = $keywords[2];
149	9	$keywords[2] = $temp;
150	9	}
151
152	27	array_shift($keywords);
153
154	27	$keywords = array_replace($empty, $keywords);
155
156	27	if ($fromDatabase && $keywords[0] != 'create') {
157	3	$message = '--from-database is only available to create_table_table keyword';
158
159	3	throw new \InvalidArgumentException($message);
160		}
161
162	24	return $keywords;
163		}
164
165		/**
166		* Prepares the data to be inserted in the template.
167		*
168		* @param \Symfony\Component\Console\Input\InputInterface $input
169		* @param array $keywords
170		* @return array
171		*/
172	24	protected function prepareData(InputInterface $input, array $keywords)
173		{
174	24	$data = [];
175
176	24	$data['command_name'] = $keywords[0];
177	24	$data['data_types'] = [ 'string' => 'VARCHAR', 'integer' => 'INT' ];
178	24	$data['class_name'] = underscore($input->getArgument('name'));
179	24	$data['table_name'] = $keywords[1];
180
181	24	$data['columns'] = [];
182	24	$data['defaults'] = [];
183
184	24	if ($input->getOption('from-database') && $data['command_name'] == 'create') {
185	3	$data['columns'] = $this->describe->getTable($data['table_name']);
186	3	}
187
188	24	return $data;
189		}
190
191		/**
192		* Sets properties for a specified column
193		*
194		* @param \Symfony\Component\Console\Input\InputInterface $input
195		* @param string $fieldName
196		* @return \Rougin\Describe\Column
197		*/
198	6	protected function setColumn(InputInterface $input, $fieldName)
199		{
200	6	$column = new \Rougin\Describe\Column;
201
202	6	$column->setField($fieldName);
203	6	$column->setNull($input->getOption('null'));
204	6	$column->setDataType($input->getOption('type'));
205	6	$column->setLength($input->getOption('length'));
206	6	$column->setPrimary($input->getOption('primary'));
207	6	$column->setUnsigned($input->getOption('unsigned'));
208	6	$column->setDefaultValue($input->getOption('default'));
209	6	$column->setAutoIncrement($input->getOption('auto_increment'));
210
211	6	return $column;
212		}
213		}
214

rougin / refinery

Push — master ( 60ed15...bfdf06 )

CreateMigrationCommand::getKeywords() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like