CreateMigrationCommand::getFileName() - Code Metrics - Inspection of "Improve code quality (#3)" - rougin/refinery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b82482...e519f6 )

by Rougin

created 2016-12-31 09:09 UTC

CreateMigrationCommand::getFileName() A

↳ Parent: CreateMigrationCommand

Complexity

Conditions	3
Paths	2

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	11
cts	11
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	10
nc	2
nop	2
crap	3

<?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'));

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

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

        $rendered = $this->renderer->render('Migration.twig', $data);

        $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[3];

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

        if ($data['command_name'] == 'modify') {
            foreach ($this->describe->getTable($data['table_name']) as $column) {
                $column->getField() != $keywords[1] || 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
     * @return array
     */
    protected function getKeywords($name)
    {
        $path = APPPATH . 'migrations';

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

        $keywords = [ '', '', '', '' ];

        return array_replace($keywords, explode('_', underscore($name)));
    }

    /**
     * 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')) {
            if ($data['command_name'] != 'create') {
                $message = '--from-database is only available to create_*table*_table keyword';

                throw new \InvalidArgumentException($message);
            }

            $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'));
62
63	27	$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
71	24	$this->filesystem->write('application/migrations/' . $fileName . '.php', $rendered);
72
73	24	return $output->writeln('<info>"' . $fileName . '" has been created.</info>');
74		}
75
76		/**
77		* Defines the columns to be included in the migration.
78		*
79		* @param \Symfony\Component\Console\Input\InputInterface $input
80		* @param array $keywords
81		* @param array $data
82		* @return array
83		*/
84	6	protected function defineColumns(InputInterface $input, array $keywords, array $data)
85		{
86	6	$data['table_name'] = $keywords[3];
87
88	6	array_push($data['columns'], $this->setColumn($input, $keywords[1]));
89
90	6	if ($data['command_name'] == 'modify') {
91	3	foreach ($this->describe->getTable($data['table_name']) as $column) {
92	3	$column->getField() != $keywords[1] \|\| array_push($data['defaults'], $column);
93	3	}
94	3	}
95
96	6	return $data;
97		}
98
99		/**
100		* Gets the file name of the specified migration.
101		*
102		* @param string $name
103		* @param boolean $isSequential
104		* @return string
105		*/
106	27	protected function getFileName($name, $isSequential = false)
107		{
108	27	$migrationType = $this->getMigrationType();
109
110	27	$fileName = date('YmdHis') . '_' . underscore($name);
111
112	27	if ($migrationType == 'sequential' \|\| $isSequential) {
113	27	$number = 1;
114
115	27	$files = new \FilesystemIterator(APPPATH . 'migrations', \FilesystemIterator::SKIP_DOTS);
116
117	27	$number += iterator_count($files);
118
119	27	$sequence = sprintf('%03d', $number);
120	27	$fileName = $sequence . '_' . substr($fileName, 15);
121	27	}
122
123	27	return $fileName;
124		}
125
126		/**
127		* Gets the defined keywords from the command.
128		*
129		* @param string $name
130		* @return array
131		*/
132	27	protected function getKeywords($name)
133		{
134	27	$path = APPPATH . 'migrations';
135
136	27	file_exists($path) \|\| mkdir($path);
137
138	27	$keywords = [ '', '', '', '' ];
139
140	27	return array_replace($keywords, explode('_', underscore($name)));
141		}
142
143		/**
144		* Prepares the data to be inserted in the template.
145		*
146		* @param \Symfony\Component\Console\Input\InputInterface $input
147		* @param array $keywords
148		* @return array
149		*/
150	27	protected function prepareData(InputInterface $input, array $keywords)
151		{
152	27	$data = [];
153
154	27	$data['command_name'] = $keywords[0];
155	27	$data['data_types'] = [ 'string' => 'VARCHAR', 'integer' => 'INT' ];
156	27	$data['class_name'] = underscore($input->getArgument('name'));
157	27	$data['table_name'] = $keywords[1];
158
159	27	$data['columns'] = [];
160	27	$data['defaults'] = [];
161
162	27	if ($input->getOption('from-database')) {
163	6	if ($data['command_name'] != 'create') {
164	3	$message = '--from-database is only available to create_table_table keyword';
165
166	3	throw new \InvalidArgumentException($message);
167		}
168
169	3	$data['columns'] = $this->describe->getTable($data['table_name']);
170	3	}
171
172	24	return $data;
173		}
174
175		/**
176		* Sets properties for a specified column
177		*
178		* @param \Symfony\Component\Console\Input\InputInterface $input
179		* @param string $fieldName
180		* @return \Rougin\Describe\Column
181		*/
182	6	protected function setColumn(InputInterface $input, $fieldName)
183		{
184	6	$column = new \Rougin\Describe\Column;
185
186	6	$column->setField($fieldName);
187	6	$column->setNull($input->getOption('null'));
188	6	$column->setDataType($input->getOption('type'));
189	6	$column->setLength($input->getOption('length'));
190	6	$column->setPrimary($input->getOption('primary'));
191	6	$column->setUnsigned($input->getOption('unsigned'));
192	6	$column->setDefaultValue($input->getOption('default'));
193	6	$column->setAutoIncrement($input->getOption('auto_increment'));
194
195	6	return $column;
196		}
197		}
198

rougin / refinery

Push — master ( b82482...e519f6 )

CreateMigrationCommand::getFileName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like