Migrator::runMigrations() - Code Metrics - Inspection of "Don't update properties that already has the corre..." - starweb/starlit-db - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

by Felix

created 2016-06-29 09:09 UTC

Migrator::runMigrations() A

↳ Parent: Migrator

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * Starlit Db.
 *
 * @copyright Copyright (c) 2016 Starweb / Ehandelslogik i Lund AB
 * @license   BSD 3-Clause
 */

namespace Starlit\Db\Migration;

use Starlit\Db\Db;

/**
 * Class for handling migration between different database versions.
 *
 * @author Andreas Nilsson <http://github.com/jandreasn>
 */
class Migrator
{
    /**
     * @const string
     */
    const DIRECTION_UP = 'up';

    /**
     * @const string
     */
    const DIRECTION_DOWN = 'down';

    /**
     * @var string
     */
    protected $migrationsTableName = 'migrations';

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

    /**
     * @var Db
     */
    protected $db;

    /**
     * @var callable
     */
    protected $infoCallback;

    /**
     * @var AbstractMigration[]
     */
    protected $migrations;

    /**
     * @var int[]
     */
    protected $migratedNumbers;

    /**
     * @var bool
     */
    private $hasMigrationsTable;

    /**
     * @param string          $migrationsDirectory
     * @param Db              $db
     * @param callable        $infoCallback
     */
    public function __construct(
        $migrationsDirectory,
        Db $db,
        callable $infoCallback = null
    ) {
        $this->migrationsDirectory = $migrationsDirectory;
        $this->db = $db;
        $this->infoCallback = $infoCallback;
    }

    /**
     * @return \SplFileInfo[]
     */
    protected function findMigrationFiles()
    {
        $migrationFiles = [];
        $directoryIterator = new \FilesystemIterator($this->migrationsDirectory);
        foreach ($directoryIterator as $fileInfo) {
            if ($fileInfo->isFile() && $fileInfo->getExtension() === 'php') {
                $migrationFiles[] = $fileInfo;
            }
        }

        return $migrationFiles;
    }

    /**
     * @return AbstractMigration[]
     */
    protected function loadMigrations()
    {
        $migrations = [];
        foreach ($this->findMigrationFiles() as $file) {
            require_once $file->getPathname();

            $className = '\\' . $file->getBasename('.' . $file->getExtension());
            $migration = new $className($this->db);

            $migrations[$migration->getNumber()] = $migration;
        }

        ksort($migrations);

        return $migrations;
    }

    /**
     * @return AbstractMigration[]
     */
    public function getMigrations()
    {
        if (!isset($this->migrations)) {
            $this->migrations = $this->loadMigrations();
        }

        return $this->migrations;
    }

    /**
     * @return int
     */
    public function getLatestNumber()
    {
        $numbers = array_keys($this->getMigrations());
        $latest = end($numbers);

        return ($latest !== false) ? $latest : 0;

    }

    /**
     * @return bool
     */
    private function hasMigrationsTable()
    {
        if (!isset($this->hasMigrationsTable)) {
            $this->hasMigrationsTable =
                (bool) $this->db->fetchOne('SHOW TABLES LIKE ?', [$this->migrationsTableName]);
        }

        return $this->hasMigrationsTable;
    }

    /**
     */
    protected function createMigrationsTable()
    {
        if (!$this->hasMigrationsTable()) {
            $this->db->exec('
                CREATE TABLE `' . $this->migrationsTableName . '` (
                    `migration_number` BIGINT NOT NULL,
                    `completed_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
                    PRIMARY KEY (`migration_number`)
                )
            ');
            $this->hasMigrationsTable = true;
        }
    }

    /**
     * @return array
     */
    protected function getMigratedNumbers()
    {
        if (!isset($this->migratedNumbers)) {
            $this->createMigrationsTable();

            $this->migratedNumbers = [];

            $sql = 'SELECT * FROM `' . $this->migrationsTableName . '` ORDER BY migration_number';
            foreach ($this->db->fetchAll($sql) as $row) {
                $this->migratedNumbers[] = $row['migration_number'];
            }
        }

        return $this->migratedNumbers;
    }

    /**
     * @return int
     */
    public function getCurrentNumber()
    {
        $migratedNumbers = $this->getMigratedNumbers();
        $current = end($migratedNumbers);

        return ($current !== false) ? $current : 0;
    }

    /**
     * @param int $toNumber
     * @return string
     */
    protected function getDirection($toNumber)
    {
        return ($this->getCurrentNumber() > $toNumber) ? self::DIRECTION_DOWN : self::DIRECTION_UP;
    }

    /**
     * @param int $to
     * @return AbstractMigration[]
     */
    public function getMigrationsTo($to = null)
    {
        $toNumber = $this->getToNumber($to);
        $allMigrations = $this->getMigrations();
        $direction = $this->getDirection($toNumber);
        if ($direction === self::DIRECTION_DOWN) {
            $allMigrations = array_reverse($allMigrations, true);
        }

        $migrations = [];
        foreach ($allMigrations as $migrationNumber => $migration) {
            if ($this->shouldMigrationBeMigrated($migration, $toNumber, $direction)) {
                $migrations[$migrationNumber] = $migration;
            }
        }

        return $migrations;
    }

    /**
     * @param AbstractMigration $migration
     * @param int               $toNumber
     * @param string            $direction
     * @return bool
     */
    private function shouldMigrationBeMigrated(AbstractMigration $migration, $toNumber, $direction)
    {
        if (($direction === self::DIRECTION_UP
                && $migration->getNumber() <= $toNumber
                && !in_array($migration->getNumber(), $this->getMigratedNumbers()))
            || ($direction == self::DIRECTION_DOWN
                && $migration->getNumber() > $toNumber
                && in_array($migration->getNumber(), $this->getMigratedNumbers()))
        ) {
            return true;
        }

        return false;
    }

    /**
     * @param AbstractMigration $migration
     */
    protected function addMigratedMigration(AbstractMigration $migration)
    {
        $this->createMigrationsTable();

        $this->db->exec(
            'INSERT INTO `' . $this->migrationsTableName . '` SET migration_number = ?',
            [$migration->getNumber()]
        );

        $this->migratedNumbers[] = $migration->getNumber();
    }

    /**
     * @param AbstractMigration $migration
     */
    protected function deleteMigratedMigration(AbstractMigration $migration)
    {
        $this->createMigrationsTable();

        $this->db->exec(
            'DELETE FROM `' . $this->migrationsTableName . '` WHERE migration_number = ?',
            [$migration->getNumber()]
        );

        if (($key = array_search($migration->getNumber(), $this->migratedNumbers)) !== false) {
            unset($this->migratedNumbers[$key]);
        }
    }

    /**
     * Empty database.
     */
    public function emptyDb()
    {
        if (($rows = $this->db->fetchAll('SHOW TABLES', [], true))) {
            $this->db->exec('SET foreign_key_checks = 0');
            foreach ($rows as $row) {
                $this->db->exec('DROP TABLE `' . $row[0] . '`');
            }
            $this->db->exec('SET foreign_key_checks = 1');
        }
    }

    /**
     * @param int|null $to
     * @return int
     * @throws \InvalidArgumentException
     */
    protected function getToNumber($to = null)
    {
        if ($to === null) {
            return $this->getLatestNumber();
        } elseif (!preg_match('/^\d+$/', $to)) {
            throw new \InvalidArgumentException('Migration number must be a number');
        }

        $toNumber = (int) $to;

        if (!in_array($toNumber, array_keys($this->getMigrations()))) {
             throw new \InvalidArgumentException('Invalid migration number');
        }

        return $toNumber;
    }

    /**
     * @param int|null $to A migration number to migrate to (if not provided, latest migration number will be used)
     * @return bool Returns true if any action was performed
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     */
    public function migrate($to = null)
    {
        if ($this->getCurrentNumber() > $this->getLatestNumber()) {
            throw new \RuntimeException(sprintf(
                'The current migration number (%d) is higher than latest available (%d). Something is wrong!',
                $this->getCurrentNumber(),
                $this->getLatestNumber()
            ));
        }

        $toNumber = $this->getToNumber($to);
        $migrations = $this->getMigrationsTo($toNumber);

        // If there's no migration to be done, we are up to date.
        if (!$migrations) {

            $this->addInfo(sprintf(
                'No migrations available, things are up to date (migration %d)!',
                $this->getCurrentNumber()
            ));

            return false;
        }

        $this->addInfo(sprintf(
            'Running %d migrations from migration %d to %d...',
            count($migrations),
            $this->getCurrentNumber(),
            $toNumber
        ));

        $this->runMigrations($migrations, $this->getDirection($toNumber));

        $this->addInfo(sprintf('Done! %s migrations migrated!', count($migrations)));

        return true;
    }

    /**
     * @param AbstractMigration[] $migrations
     * @param string $direction
     */
    protected function runMigrations(array $migrations, $direction)
    {
        foreach ($migrations as $migration) {
            if ($direction === self::DIRECTION_UP) {
                $this->addInfo(sprintf(' - Migrating up %d...', $migration->getNumber()));
                $migration->up();
                $this->addMigratedMigration($migration);

            } else {
                $this->addInfo(sprintf(' - Migrating down %d...', $migration->getNumber()));
                $migration->down();
                $this->deleteMigratedMigration($migration);

            }
        }
    }

    /**
     * @param string $info
     */
    protected function addInfo($info)
    {
        if ($this->infoCallback) {
            $callback = $this->infoCallback;
            $callback($info);
        }
    }
}


1		<?php
2		/**
3		* Starlit Db.
4		*
5		* @copyright Copyright (c) 2016 Starweb / Ehandelslogik i Lund AB
6		* @license BSD 3-Clause
7		*/
8
9		namespace Starlit\Db\Migration;
10
11		use Starlit\Db\Db;
12
13		/**
14		* Class for handling migration between different database versions.
15		*
16		* @author Andreas Nilsson <http://github.com/jandreasn>
17		*/
18		class Migrator
19		{
20		/**
21		* @const string
22		*/
23		const DIRECTION_UP = 'up';
24
25		/**
26		* @const string
27		*/
28		const DIRECTION_DOWN = 'down';
29
30		/**
31		* @var string
32		*/
33		protected $migrationsTableName = 'migrations';
34
35		/**
36		* @var string
37		*/
38		protected $migrationsDirectory;
39
40		/**
41		* @var Db
42		*/
43		protected $db;
44
45		/**
46		* @var callable
47		*/
48		protected $infoCallback;
49
50		/**
51		* @var AbstractMigration[]
52		*/
53		protected $migrations;
54
55		/**
56		* @var int[]
57		*/
58		protected $migratedNumbers;
59
60		/**
61		* @var bool
62		*/
63		private $hasMigrationsTable;
64
65		/**
66		* @param string $migrationsDirectory
67		* @param Db $db
68		* @param callable $infoCallback
69		*/
70	10	public function __construct(
71		$migrationsDirectory,
72		Db $db,
73		callable $infoCallback = null
74		) {
75	10	$this->migrationsDirectory = $migrationsDirectory;
76	10	$this->db = $db;
77	10	$this->infoCallback = $infoCallback;
78	10	}
79
80		/**
81		* @return \SplFileInfo[]
82		*/
83	8	protected function findMigrationFiles()
84		{
85	8	$migrationFiles = [];
86	8	$directoryIterator = new \FilesystemIterator($this->migrationsDirectory);
87	8	foreach ($directoryIterator as $fileInfo) {
88	8	if ($fileInfo->isFile() && $fileInfo->getExtension() === 'php') {
89	8	$migrationFiles[] = $fileInfo;
90		}
91		}
92
93	8	return $migrationFiles;
94		}
95
96		/**
97		* @return AbstractMigration[]
98		*/
99	8	protected function loadMigrations()
100		{
101	8	$migrations = [];
102	8	foreach ($this->findMigrationFiles() as $file) {
103	8	require_once $file->getPathname();
104
105	8	$className = '\\' . $file->getBasename('.' . $file->getExtension());
106	8	$migration = new $className($this->db);
107
108	8	$migrations[$migration->getNumber()] = $migration;
109		}
110
111	8	ksort($migrations);
112
113	8	return $migrations;
114		}
115
116		/**
117		* @return AbstractMigration[]
118		*/
119	8	public function getMigrations()
120		{
121	8	if (!isset($this->migrations)) {
122	8	$this->migrations = $this->loadMigrations();
123		}
124
125	8	return $this->migrations;
126		}
127
128		/**
129		* @return int
130		*/
131	8	public function getLatestNumber()
132		{
133	8	$numbers = array_keys($this->getMigrations());
134	8	$latest = end($numbers);
135
136	8	return ($latest !== false) ? $latest : 0;
137
138		}
139
140		/**
141		* @return bool
142		*/
143	8	private function hasMigrationsTable()
144		{
145	8	if (!isset($this->hasMigrationsTable)) {
146	8	$this->hasMigrationsTable =
147	8	(bool) $this->db->fetchOne('SHOW TABLES LIKE ?', [$this->migrationsTableName]);
148		}
149
150	8	return $this->hasMigrationsTable;
151		}
152
153		/**
154		*/
155	8	protected function createMigrationsTable()
156		{
157	8	if (!$this->hasMigrationsTable()) {
158	8	$this->db->exec('
159	8	CREATE TABLE `' . $this->migrationsTableName . '` (
160		`migration_number` BIGINT NOT NULL,
161		`completed_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
162		PRIMARY KEY (`migration_number`)
163		)
164	8	');
165	8	$this->hasMigrationsTable = true;
166		}
167	8	}
168
169		/**
170		* @return array
171		*/
172	8	protected function getMigratedNumbers()
173		{
174	8	if (!isset($this->migratedNumbers)) {
175	8	$this->createMigrationsTable();
176
177	8	$this->migratedNumbers = [];
178
179	8	$sql = 'SELECT * FROM `' . $this->migrationsTableName . '` ORDER BY migration_number';
180	8	foreach ($this->db->fetchAll($sql) as $row) {
181	8	$this->migratedNumbers[] = $row['migration_number'];
182		}
183		}
184
185	8	return $this->migratedNumbers;
186		}
187
188		/**
189		* @return int
190		*/
191	8	public function getCurrentNumber()
192		{
193	8	$migratedNumbers = $this->getMigratedNumbers();
194	8	$current = end($migratedNumbers);
195
196	8	return ($current !== false) ? $current : 0;
197		}
198
199		/**
200		* @param int $toNumber
201		* @return string
202		*/
203	4	protected function getDirection($toNumber)
204		{
205	4	return ($this->getCurrentNumber() > $toNumber) ? self::DIRECTION_DOWN : self::DIRECTION_UP;
206		}
207
208		/**
209		* @param int $to
210		* @return AbstractMigration[]
211		*/
212	4	public function getMigrationsTo($to = null)
213		{
214	4	$toNumber = $this->getToNumber($to);
215	4	$allMigrations = $this->getMigrations();
216	4	$direction = $this->getDirection($toNumber);
217	4	if ($direction === self::DIRECTION_DOWN) {
218	1	$allMigrations = array_reverse($allMigrations, true);
219		}
220
221	4	$migrations = [];
222	4	foreach ($allMigrations as $migrationNumber => $migration) {
223	4	if ($this->shouldMigrationBeMigrated($migration, $toNumber, $direction)) {
224	4	$migrations[$migrationNumber] = $migration;
225		}
226		}
227
228	4	return $migrations;
229		}
230
231		/**
232		* @param AbstractMigration $migration
233		* @param int $toNumber
234		* @param string $direction
235		* @return bool
236		*/
237	4	private function shouldMigrationBeMigrated(AbstractMigration $migration, $toNumber, $direction)
238		{
239	4	if (($direction === self::DIRECTION_UP
240	4	&& $migration->getNumber() <= $toNumber
241	3	&& !in_array($migration->getNumber(), $this->getMigratedNumbers()))
242	4	\|\| ($direction == self::DIRECTION_DOWN
243	4	&& $migration->getNumber() > $toNumber
244	4	&& in_array($migration->getNumber(), $this->getMigratedNumbers()))
245		) {
246	3	return true;
247		}
248
249	4	return false;
250		}
251
252		/**
253		* @param AbstractMigration $migration
254		*/
255	2	protected function addMigratedMigration(AbstractMigration $migration)
256		{
257	2	$this->createMigrationsTable();
258
259	2	$this->db->exec(
260	2	'INSERT INTO `' . $this->migrationsTableName . '` SET migration_number = ?',
261	2	[$migration->getNumber()]
262		);
263
264	2	$this->migratedNumbers[] = $migration->getNumber();
265	2	}
266
267		/**
268		* @param AbstractMigration $migration
269		*/
270	1	protected function deleteMigratedMigration(AbstractMigration $migration)
271		{
272	1	$this->createMigrationsTable();
273
274	1	$this->db->exec(
275	1	'DELETE FROM `' . $this->migrationsTableName . '` WHERE migration_number = ?',
276	1	[$migration->getNumber()]
277		);
278
279	1	if (($key = array_search($migration->getNumber(), $this->migratedNumbers)) !== false) {
280	1	unset($this->migratedNumbers[$key]);
281		}
282	1	}
283
284		/**
285		* Empty database.
286		*/
287	1	public function emptyDb()
288		{
289	1	if (($rows = $this->db->fetchAll('SHOW TABLES', [], true))) {
290	1	$this->db->exec('SET foreign_key_checks = 0');
291	1	foreach ($rows as $row) {
292	1	$this->db->exec('DROP TABLE `' . $row[0] . '`');
293		}
294	1	$this->db->exec('SET foreign_key_checks = 1');
295		}
296	1	}
297
298		/**
299		* @param int\|null $to
300		* @return int
301		* @throws \InvalidArgumentException
302		*/
303	6	protected function getToNumber($to = null)
304		{
305	6	if ($to === null) {
306	3	return $this->getLatestNumber();
307	6	} elseif (!preg_match('/^\d+$/', $to)) {
308	1	throw new \InvalidArgumentException('Migration number must be a number');
309		}
310
311	5	$toNumber = (int) $to;
312
313	5	if (!in_array($toNumber, array_keys($this->getMigrations()))) {
314	1	throw new \InvalidArgumentException('Invalid migration number');
315		}
316
317	4	return $toNumber;
318		}
319
320		/**
321		* @param int\|null $to A migration number to migrate to (if not provided, latest migration number will be used)
322		* @return bool Returns true if any action was performed
323		* @throws \InvalidArgumentException
324		* @throws \RuntimeException
325		*/
326	7	public function migrate($to = null)
327		{
328	7	if ($this->getCurrentNumber() > $this->getLatestNumber()) {
329	1	throw new \RuntimeException(sprintf(
330	1	'The current migration number (%d) is higher than latest available (%d). Something is wrong!',
331	1	$this->getCurrentNumber(),
332	1	$this->getLatestNumber()
333		));
334		}
335
336	6	$toNumber = $this->getToNumber($to);
337	4	$migrations = $this->getMigrationsTo($toNumber);
338
339		// If there's no migration to be done, we are up to date.
340	4	if (!$migrations) {
		0 ignored issues – show Bug Best Practice introduced 2016-04-04 09:15 UTC by Report Bug Copy Issue Report The expression `$migrations` of type `Starlit\Db\Migration\AbstractMigration[]` 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. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
341	1	$this->addInfo(sprintf(
342	1	'No migrations available, things are up to date (migration %d)!',
343	1	$this->getCurrentNumber()
344		));
345
346	1	return false;
347		}
348
349	3	$this->addInfo(sprintf(
350	3	'Running %d migrations from migration %d to %d...',
351		count($migrations),
352	3	$this->getCurrentNumber(),
353		$toNumber
354		));
355
356	3	$this->runMigrations($migrations, $this->getDirection($toNumber));
357
358	3	$this->addInfo(sprintf('Done! %s migrations migrated!', count($migrations)));
359
360	3	return true;
361		}
362
363		/**
364		* @param AbstractMigration[] $migrations
365		* @param string $direction
366		*/
367	3	protected function runMigrations(array $migrations, $direction)
368		{
369	3	foreach ($migrations as $migration) {
370	3	if ($direction === self::DIRECTION_UP) {
371	2	$this->addInfo(sprintf(' - Migrating up %d...', $migration->getNumber()));
372	2	$migration->up();
373	2	$this->addMigratedMigration($migration);
374
375		} else {
376	1	$this->addInfo(sprintf(' - Migrating down %d...', $migration->getNumber()));
377	1	$migration->down();
378	3	$this->deleteMigratedMigration($migration);
379
380		}
381		}
382	3	}
383
384		/**
385		* @param string $info
386		*/
387	4	protected function addInfo($info)
388		{
389	4	if ($this->infoCallback) {
390	4	$callback = $this->infoCallback;
391	4	$callback($info);
392		}
393	4	}
394		}
395

starweb / starlit-db

GitHub Access Token became invalid

Pull Request — master (#3)

Migrator::runMigrations() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like