Xethron\MigrationsGenerator\MigrateGenerateCommand

Complexity

Total Complexity

46

Size/Duplication

Total Lines	450
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	handle()	0	4	1
B	fire()	0	49	8
A	askYn()	0	7	2
A	askNumeric()	0	18	6
A	generateTablesAndIndices()	0	18	4
A	getStringBetween()	0	9	3
A	migrationExist()	0	16	3
A	generateForeignKeys()	0	21	4
A	generate()	0	11	3
A	getFileGenerationPath()	0	8	1
A	getDatePrefix()	0	4	1
A	getTemplateData()	0	18	3
A	getTemplatePath()	0	4	1
A	getArguments()	0	6	1
A	getOptions()	0	13	1
A	removeExcludedTables()	0	7	1
A	getExcludedTables()	0	10	2

<?php namespace Xethron\MigrationsGenerator;

use Way\Generators\Commands\GeneratorCommand;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;

use Way\Generators\Generator;
use Way\Generators\Filesystem\Filesystem;
use Way\Generators\Compilers\TemplateCompiler;
use Illuminate\Database\Migrations\MigrationRepositoryInterface;

use Xethron\MigrationsGenerator\Generators\SchemaGenerator;
use Xethron\MigrationsGenerator\Syntax\AddToTable;
use Xethron\MigrationsGenerator\Syntax\DroppedTable;
use Xethron\MigrationsGenerator\Syntax\AddForeignKeysToTable;
use Xethron\MigrationsGenerator\Syntax\RemoveForeignKeysFromTable;

use Illuminate\Contracts\Config\Repository as Config;

class MigrateGenerateCommand extends GeneratorCommand {

	/**
	 * The console command name.
	 * @var string
	 */
	protected $name = 'migrate:generate';

	/**
	 * The console command description.
	 * @var string
	 */
	protected $description = 'Generate a migration from an existing table structure.';

	/**
	 * @var \Way\Generators\Filesystem\Filesystem
	 */
	protected $file;

	/**
	 * @var \Way\Generators\Compilers\TemplateCompiler
	 */
	protected $compiler;

	/**
	 * @var \Illuminate\Database\Migrations\MigrationRepositoryInterface  $repository
	 */
	protected $repository;

	/**
	 * @var \Illuminate\Config\Repository  $config
	 */
	protected $config;

	/**
	 * @var \Xethron\MigrationsGenerator\Generators\SchemaGenerator
	 */
	protected $schemaGenerator;

	/**
	 * Array of Fields to create in a new Migration
	 * Namely: Columns, Indexes and Foreign Keys
	 * @var array
	 */
	protected $fields = array();

	/**
	 * List of Migrations that has been done
	 * @var array
	 */
	protected $migrations = array();

	/**
	 * @var bool
	 */
	protected $log = false;

	/**
	 * @var int
	 */
	protected $batch;

	/**
	 * Filename date prefix (Y_m_d_His)
	 * @var string
	 */
	protected $datePrefix;

	/**
	 * @var string
	 */
	protected $migrationName;

	/**
	 * @var string
	 */
	protected $method;

	/**
	 * @var string
	 */
	protected $table;

    /**
     * @var string|null
     */
    protected $connection = null;

    /**
     * @var bool
     */
    protected $ignoreCreatedMigration = false;

    /**
	 * @param \Way\Generators\Generator  $generator
	 * @param \Way\Generators\Filesystem\Filesystem  $file
	 * @param \Way\Generators\Compilers\TemplateCompiler  $compiler
	 * @param \Illuminate\Database\Migrations\MigrationRepositoryInterface  $repository
	 * @param \Illuminate\Config\Repository  $config
	 */
	public function __construct(
		Generator $generator,
		Filesystem $file,
		TemplateCompiler $compiler,
		MigrationRepositoryInterface $repository,
		Config $config
	)
	{
		$this->file = $file;
		$this->compiler = $compiler;
		$this->repository = $repository;
		$this->config = $config;

It seems like $config of type object<Illuminate\Contracts\Config\Repository> is incompatible with the declared type object<Illuminate\Config\Repository> of property $config.

		parent::__construct( $generator );
	}

	/**
	 * Execute the console command. Added for Laravel 5.5
	 *
	 * @return void
	 */
	public function handle()
	{
		$this->fire();
	}

    /**
	 * Execute the console command.
	 *
	 * @return void
	 */
	public function fire()
	{
		$this->info( 'Using connection: '. $this->option( 'connection' ) ."\n" );
        if ($this->option('connection') !== $this->config->get('database.default')) {
            $this->connection = $this->option('connection');

It seems like $this->option('connection') can also be of type array or boolean. However, the property $connection is declared as type string|null. Maybe add an additional type check?

        }
		$this->schemaGenerator = new SchemaGenerator(
			$this->option('connection'),
			$this->option('defaultIndexNames'),
			$this->option('defaultFKNames')
		);

		if ( $this->argument( 'tables' ) ) {
			$tables = explode( ',', $this->argument( 'tables' ) );
		} elseif ( $this->option('tables') ) {
			$tables = explode( ',', $this->option( 'tables' ) );
		} else {
			$tables = $this->schemaGenerator->getTables();
		}

		$tables = $this->removeExcludedTables($tables);
		$this->info( 'Generating migrations for: '. implode( ', ', $tables ) );

		if (!$this->option( 'no-interaction' )) {
			$this->log = $this->askYn('Do you want to log these migrations in the migrations table?');
		}

		if ( $this->log ) {
			$this->repository->setSource( $this->option( 'connection' ) );
			if ( ! $this->repository->repositoryExists() ) {
				$options = array('--database' => $this->option( 'connection' ) );
				$this->call('migrate:install', $options);
			}
			$batch = $this->repository->getNextBatchNumber();
			$this->batch = $this->askNumeric( 'Next Batch Number is: '. $batch .'. We recommend using Batch Number 0 so that it becomes the "first" migration', 0 );

It seems like $this->askNumeric('Next Batch Number is: ' . $batch . '. We recommend using Batch Number 0 so that it becomes the "first" migration', 0) can also be of type double. However, the property $batch is declared as type integer. Maybe add an additional type check?

		}

        if($this->hasOption('ignore-created-migration')) {
            $this->ignoreCreatedMigration = true;
        }

		$this->info( "Setting up Tables and Index Migrations" );
		$this->datePrefix = date( 'Y_m_d_His' );
		$this->generateTablesAndIndices( $tables );
		$this->info( "\nSetting up Foreign Key Migrations\n" );
		$this->datePrefix = date( 'Y_m_d_His', strtotime( '+1 second' ) );
		$this->generateForeignKeys( $tables );
		$this->info( "\nFinished!\n" );
	}

	/**
	 * Ask for user input: Yes/No
	 * @param  string $question Question to ask
	 * @return boolean          Answer from user
	 */
	protected function askYn( $question ) {
		$answer = $this->ask( $question .' [Y/n] ');
		while ( ! in_array( strtolower( $answer ), [ 'y', 'n', 'yes', 'no' ] ) ) {
			$answer = $this->ask('Please choose either yes or no. ');
		}
		return in_array( strtolower( $answer ), [ 'y', 'yes' ] );
	}

	/**
	 * Ask user for a Numeric Value, or blank for default
	 * @param  string    $question Question to ask
	 * @param  int|float $default  Default Value (optional)
	 * @return int|float           Answer
	 */
	protected function askNumeric( $question, $default = null ) {
		$ask = 'Your answer needs to be a numeric value';

		if ( ! is_null( $default ) ) {
			$question .= ' [Default: '. $default .'] ';
			$ask .= ' or blank for default';
		}

		$answer = $this->ask( $question );

		while ( ! is_numeric( $answer ) and ! ( $answer == '' and ! is_null( $default ) ) ) {
			$answer = $this->ask( $ask .'. ');
		}
		if ( $answer == '' ) {
			$answer = $default;
		}
		return $answer;
	}

	/**
	 * Generate tables and index migrations.
	 *
	 * @param  array $tables List of tables to create migrations for
	 * @return void
	 */
	protected function generateTablesAndIndices( array $tables )
	{
		$this->method = 'create';

		foreach ( $tables as $table ) {
			$this->table = $table;
			$this->migrationName = 'create_'. $this->table .'_table';

            if($this->ignoreCreatedMigration && $this->migrationExist($this->table)) {
                $this->info( "Migration $this->migrationName already created: Skipping..." );
                continue;
            }

			$this->fields = $this->schemaGenerator->getFields( $this->table );

It seems like $this->schemaGenerator->getFields($this->table) can also be of type false. However, the property $fields is declared as type array. Maybe add an additional type check?

			$this->generate();
		}
	}

    /**Return a substring between 2 strings
     * @param $string
     * @param $start
     * @param $end
     * @param bool $trim
     * @return false|string
     */
    public function getStringBetween($string, $start, $end, $trim = true) {
        $string = ' ' . $string;
        $ini = strpos($string, $start);
        if ($ini == 0) return '';
        $ini += strlen($start);
        $len = strpos($string, $end, $ini) - $ini;
        $output = substr($string, $ini, $len);
        return ($trim) ? trim(strip_tags($output)) : $output;
    }

    /**Check if migration for table already exists
     * @param $table
     * @param string $prefix
     * @param string $suffix
     * @return bool
     */
    protected function migrationExist($table, $prefix = 'create_', $suffix = '_table')
    {
        $exists = false;
        $path = $this->getPathByOptionOrConfig( 'path', 'migration_target_path' );
        $files = scandir($path);

        foreach ($files as $file)
        {
            if($this->getStringBetween($file, $prefix, $suffix) == $table) {
                $exists = true;
                break;
            }
        }

        return $exists;
    }

	/**
	 * Generate foreign key migrations.
	 *
	 * @param  array $tables List of tables to create migrations for
	 * @return void
	 */
	protected function generateForeignKeys( array $tables )
	{
		$this->method = 'table';
        $prefix = 'add_foreign_keys_to_';
        $suffix = '_table';

		foreach ( $tables as $table ) {
			$this->table = $table;
			$this->migrationName = 'add_foreign_keys_to_'. $this->table .'_table';

            $this->migrationName = $prefix . $this->table . $suffix;
            if($this->ignoreCreatedMigration && $this->migrationExist($this->table, $prefix, $suffix)) {
                $this->info( "Migration $this->migrationName already created: Skipping..." );
                continue;
            }

			$this->fields = $this->schemaGenerator->getForeignKeyConstraints( $this->table );

			$this->generate();
		}
	}

	/**
	 * Generate Migration for the current table.
	 *
	 * @return void
	 */
	protected function generate()
	{
		if ( $this->fields ) {

The expression $this->fields of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

			parent::fire();

It seems like you call parent on a different method (fire() instead of generate()). Are you sure this is correct? If so, you might want to change this to $this->fire().

			if ( $this->log ) {
				$file = $this->datePrefix . '_' . $this->migrationName;
				$this->repository->log($file, $this->batch);
			}
		}
	}

	/**
	 * The path where the file will be created
	 *
	 * @return string
	 */
	protected function getFileGenerationPath()
	{
		$path = $this->getPathByOptionOrConfig( 'path', 'migration_target_path' );
		$migrationName = str_replace('/', '_', $this->migrationName);
		$fileName = $this->getDatePrefix() . '_' . $migrationName . '.php';

		return "{$path}/{$fileName}";
	}

	/**
	 * Get the date prefix for the migration.
	 *
	 * @return string
	 */
	protected function getDatePrefix()
	{
		return $this->datePrefix;
	}

	/**
	 * Fetch the template data
	 *
	 * @return array
	 */
	protected function getTemplateData()
	{
		if ( $this->method == 'create' ) {
			$up = (new AddToTable($this->file, $this->compiler))->run($this->fields, $this->table, $this->connection, 'create');

It seems like $this->connection can also be of type string; however, Xethron\MigrationsGenerator\Syntax\Table::run() does only seem to accept null, maybe add an additional type check?

			$down = (new DroppedTable)->drop($this->table, $this->connection);

It seems like $this->connection can also be of type string; however, Xethron\MigrationsGenerator\Syntax\DroppedTable::drop() does only seem to accept null, maybe add an additional type check?

		}

		if ( $this->method == 'table' ) {
			$up = (new AddForeignKeysToTable($this->file, $this->compiler))->run($this->fields, $this->table, $this->connection);

It seems like $this->connection can also be of type string; however, Xethron\MigrationsGenerator\Syntax\Table::run() does only seem to accept null, maybe add an additional type check?

			$down = (new RemoveForeignKeysFromTable($this->file, $this->compiler))->run($this->fields, $this->table, $this->connection);

It seems like $this->connection can also be of type string; however, Xethron\MigrationsGenerator\Syntax\Table::run() does only seem to accept null, maybe add an additional type check?

		}

		return [
			'CLASS' => ucwords(camel_case($this->migrationName)),

The function camel_case() has been deprecated with message: Str::camel() should be used directly instead. Will be removed in Laravel 6.0.

			'UP'    => $up,

The variable $up does not seem to be defined for all execution paths leading up to this point.

			'DOWN'  => $down

The variable $down does not seem to be defined for all execution paths leading up to this point.

		];
	}

	/**
	 * Get path to template for generator
	 *
	 * @return string
	 */
	protected function getTemplatePath()
	{
		return $this->getPathByOptionOrConfig( 'templatePath', 'migration_template_path' );
	}

	/**
	 * Get the console command arguments.
	 *
	 * @return array
	 */
	protected function getArguments()
	{
		return [
			['tables', InputArgument::OPTIONAL, 'A list of Tables you wish to Generate Migrations for separated by a comma: users,posts,comments'],
		];
	}

	/**
	 * Get the console command options.
	 *
	 * @return array
	 */
	protected function getOptions()
	{
		return [

The return type of return array(array('connection', 'c', \Symfony\Component\Console\Input\InputOption::VALUE_OPTIONAL, 'The database connection to use.', $this->config->get('database.default')), array('tables', 't', \Symfony\Component\Console\Input\InputOption::VALUE_OPTIONAL, 'A list of Tables you wish to Generate Migrations for separated by a comma: users,posts,comments'), array('ignore', 'i', \Symfony\Component\Console\Input\InputOption::VALUE_OPTIONAL, 'A list of Tables you wish to ignore, separated by a comma: users,posts,comments'), array('ignore-created-migration', 'icm', null, 'Flag to ignore migrations already created'), array('path', 'p', \Symfony\Component\Console\Input\InputOption::VALUE_OPTIONAL, 'Where should the file be created?'), array('templatePath', 'tp', \Symfony\Component\Console\Input\InputOption::VALUE_OPTIONAL, 'The location of the template for this generator'), array('defaultIndexNames', null, \Symfony\Component\Console\Input\InputOption::VALUE_NONE, 'Don\'t use db index names for migrations'), array('defaultFKNames', null, \Symfony\Component\Console\Input\InputOption::VALUE_NONE, 'Don\'t use db foreign key names for migrations')); (array[]) is incompatible with the return type of the parent method Way\Generators\Commands\GeneratorCommand::getOptions of type array<string|null>[].

			['connection', 'c', InputOption::VALUE_OPTIONAL, 'The database connection to use.', $this->config->get( 'database.default' )],
			['tables', 't', InputOption::VALUE_OPTIONAL, 'A list of Tables you wish to Generate Migrations for separated by a comma: users,posts,comments'],
			['ignore', 'i', InputOption::VALUE_OPTIONAL, 'A list of Tables you wish to ignore, separated by a comma: users,posts,comments' ],
            ['ignore-created-migration', 'icm', null, 'Flag to ignore migrations already created' ],
            ['path', 'p', InputOption::VALUE_OPTIONAL, 'Where should the file be created?'],
			['templatePath', 'tp', InputOption::VALUE_OPTIONAL, 'The location of the template for this generator'],
			['defaultIndexNames', null, InputOption::VALUE_NONE, 'Don\'t use db index names for migrations'],
			['defaultFKNames', null, InputOption::VALUE_NONE, 'Don\'t use db foreign key names for migrations'],
		];
	}

	/**
	 * Remove all the tables to exclude from the array of tables
	 *
	 * @param array $tables
	 *
	 * @return array
	 */
	protected function removeExcludedTables( array $tables )
	{
		$excludes = $this->getExcludedTables();
		$tables = array_diff($tables, $excludes);

		return $tables;
	}

	/**
	 * Get a list of tables to exclude
	 *
	 * @return array
	 */
	protected function getExcludedTables()
	{
		$excludes = ['migrations'];
		$ignore = $this->option('ignore');
		if ( ! empty($ignore)) {
			return array_merge($excludes, explode(',', $ignore));
		}

		return $excludes;
	}

}