Yarak\Migrations\Migrator

Complexity

Total Complexity

26

Size/Duplication

Total Lines	334
Duplicated Lines	8.38 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	run()	0	8	1
A	getPendingMigrations()	0	7	1
A	getMigrationFiles()	0	14	1
A	runPending()	0	20	3
A	runUp()	14	14	2
A	resolveMigrationClass()	0	8	1
A	rollback()	0	8	1
A	runRollback()	0	18	3
A	runDown()	14	14	2
A	reset()	0	8	1
A	refresh()	0	12	1
A	setUp()	0	10	2
A	setConnection()	0	10	1
A	getConnection()	0	4	1
A	createMigrationsRepository()	0	8	2
A	log()	0	4	1
A	getLog()	0	4	1

<?php

namespace Yarak\Migrations;

use Yarak\Helpers\Str;
use Yarak\Config\Config;
use Yarak\Helpers\Paths;
use Yarak\DB\ConnectionResolver;

class Migrator
{
    use Paths;

    /**
     * Yarak config.
     *
     * @var Config
     */
    protected $config;

    /**
     * Database connection resolver.
     *
     * @var ConnectionResolver
     */
    protected $resolver;

    /**
     * Repository for logging migration activity.
     *
     * @var MigrationRepository
     */
    protected $repository;

    /**
     * The active database connection.
     *
     * @var Phalcon\Db\Adapter\Pdo
     */
    protected $connection = null;

    /**
     * Log of info/error messages.
     *
     * @var array
     */
    protected $log = [];

    /**
     * Construct.
     *
     * @param Config                       $config
     * @param ConnectionResolver           $resolver
     * @param MigrationRepositoryInterface $repository
     */
    public function __construct(
        Config $config,
        ConnectionResolver $resolver,
        MigrationRepository $repository
    ) {
        $this->config = $config;
        $this->resolver = $resolver;
        $this->repository = $repository;
    }

    /**
     * Run migrations.
     *
     * @return array
     */
    public function run()
    {
        $this->setUp();

        $pendingMigrations = $this->getPendingMigrations();

        return $this->runPending($pendingMigrations);
    }

    /**
     * Get all migration filenames that have not been run.
     *
     * @return array
     */
    protected function getPendingMigrations()
    {
        return array_diff(
            $this->getMigrationFiles(),
            $this->repository->getRanMigrations()
        );
    }

    /**
     * Get array of migration file names from directory listed in config.
     *
     * @return array
     */
    protected function getMigrationFiles()
    {
        $files = scandir($this->config->getMigrationDirectory());

        $files = array_filter($files, function ($file) {
            return strpos($file, '.php') !== false;
        });

        $files = array_map(function ($file) {
            return str_replace('.php', '', $file);
        }, $files);

        return array_values($files);
    }

    /**
     * Run pending migrations.
     *
     * @param array $migrations
     *
     * @return array
     */
    protected function runPending(array $migrations)
    {
        if (count($migrations) === 0) {
            $this->log('<info>No pending migrations to run.</info>');

            return [];
        }

        $batch = $this->repository->getNextBatchNumber();

        $this->connection->begin();

        foreach ($migrations as $migration) {
            $this->runUp($migration, $batch);
        }

        $this->connection->commit();

        return $migrations;
    }

    /**
     * Run the migration.
     *
     * @param string $migration
     * @param int    $batch
     */
    protected function runUp($migration, $batch)
    {
        $migrationClass = $this->resolveMigrationClass($migration);

        try {
            $migrationClass->up($this->connection);
        } catch (\Exception $e) {
            return $this->log("<error>{$e->getMessage()}</error>");
        }

        $this->log("<info>Migrated {$migration}.</info>");

        $this->repository->insertRecord($migration, $batch);
    }

    /**
     * Resolve the migration class from the file name.
     *
     * @param string $migration
     *
     * @return Yarak\Migrations\Migration
     */
    public function resolveMigrationClass($migration)
    {
        require_once $this->config->getMigrationDirectory().$migration.'.php';

        $class = Str::studly(implode('_', array_slice(explode('_', $migration), 4)));

        return new $class();
    }

    /**
     * Rollback migrations.
     *
     * @param int $steps
     *
     * @return array
     */
    public function rollback($steps = 1)
    {
        $this->setUp();

        $toRollback = $this->repository->getRanMigrations(null, $steps);

        return $this->runRollback($toRollback);
    }

    /**
     * Rollback given migrations.
     *
     * @param array $migrations
     *
     * @return array
     */
    protected function runRollback(array $migrations)
    {
        if (count($migrations) === 0) {
            $this->log('<info>Nothing to rollback.</info>');

            return [];
        }

        $this->connection->begin();

        foreach (array_reverse($migrations) as $migration) {
            $this->runDown($migration);
        }

        $this->connection->commit();

        return $migrations;
    }

    /**
     * Rollback the migration.
     *
     * @param string $migration
     */
    protected function runDown($migration)
    {
        $migrationClass = $this->resolveMigrationClass($migration);

        try {
            $migrationClass->down($this->connection);
        } catch (\Exception $e) {
            return $this->log("<error>{$e->getMessage()}</error>");
        }

        $this->log("<info>Rolled back {$migration}.</info>");

        $this->repository->deleteRecord($migration);
    }

    /**
     * Reset the database by rolling back all migrations.
     *
     * @return array
     */
    public function reset()
    {
        $this->setUp();

        $toRollback = $this->repository->getRanMigrations();

        return $this->runRollback($toRollback);
    }

    /**
     * Reset the database and run all migrations.
     *
     * @return array
     */
    public function refresh()
    {
        $this->setUp();

        $toRollback = $this->repository->getRanMigrations();

        $this->runRollback($toRollback);

        $pendingMigrations = $this->getPendingMigrations();

        return $this->runPending($pendingMigrations);
    }

    /**
     * Perform setup procedures for migrations.
     */
    protected function setUp()
    {
        if (!$this->connection) {
            $this->setConnection();
        }

        $this->createMigrationsRepository();

        $this->makeDirectoryStructure($this->config->getAllDatabaseDirectories());
    }

    /**
     * Set connection to database on object.
     *
     * @return Pdo
     */
    public function setConnection()
    {
        $dbConfig = $this->config->get('database');

        $this->connection = $this->resolver->getConnection($dbConfig);

It seems like $this->resolver->getConnection($dbConfig) of type object<Yarak\DB\Phalcon\Db\Adapter\Pdo> is incompatible with the declared type object<Yarak\Migrations\Phalcon\Db\Adapter\Pdo> of property $connection.

        $this->repository->setConnection($this->connection);

        return $this;
    }

    /**
     * Return the connection.
     *
     * @return Phalcon\Db\Adapter\Pdo
     */
    public function getConnection()
    {
        return $this->connection;
    }

    /**
     * Create the migrations table if it doesn't exist.
     */
    public function createMigrationsRepository()
    {
        if (!$this->repository->exists()) {
            $this->repository->create();
        }

        return $this;
    }

    /**
     * Log a message.
     *
     * @param string $message
     */
    protected function log($message)
    {
        $this->log[] = $message;
    }

    /**
     * Return the object log.
     *
     * @return array
     */
    public function getLog()
    {
        return $this->log;
    }
}