Корректировка работы методов

Author: maksimepikhin

README.md

@@ -20,6 +20,59 @@
 Компонент самостоятельно проверяет и создает необходимые (указанные) схемы, таблицы и папки при наличии заранее
 определенных разрешений (прав). Для корректной работы с базой данных необходимо заранее установить соединение с ней.
 
+Для использования компонента достаточно создать экземпляр класса и вызвать нужный метод:
+
+```php
+$sqlMigration = new SqlMigration($database, [
+'schema' => 'migrations',
+'table' => 'migration',
+'path' => 'migrations'
+]);
+
+$sqlMigration->up();
+```
+
+Для работы с консолью достаточно создать файл управления миграциями и вызвать его через `php FILE ACTION PARAMS`:
+
+1. `php migrate up`
+2. `php migrate down 2`
+
+Файл автоматической обработки таких запросов может выглядеть следующим образом:
+
+```php
+#!/usr/bin/env php
+<?php
+declare(strict_types = 1);
+
+use mepihindeveloper\components\{Console, ConsoleSqlMigration, Database};
+
+require_once 'vendor/autoload.php';
+
+$database = new Database([
+'dbms' => 'pgsql',
+'host' => 'localhost',
+'dbname' => 'php',
+'user' => 'www-data',
+'password' => 'pass'
+]);
+$database->connect();
+$sqlMigration = new ConsoleSqlMigration($database, [
+'schema' => 'migrations',
+'table' => 'migration',
+'path' => 'migrations'
+]);
+
+$method = $argv[1];
+$params = $argv[2] ?? null;
+
+if (!method_exists($sqlMigration, $method)) {
+Console::writeLine("Неопознанная команда '{$method}'", Console::FG_RED);
+exit;
+}
+
+return is_null($params) ? $sqlMigration->$method() : $sqlMigration->$method($params);
+```
+
 # Структура
 
 ```
@@ -41,15 +94,15 @@ src/
 
 | Метод | Аргументы | Возвращаемые данные | Исключения | Описание |
 |-------------------------------------------------------------------|------------------------------------------------------------------------------------------------|---------------------|-----------------------------------------|-----------------------------------------------------------------------------|
-| public function up(int $count = 0) | $count Количество миграция (0 - относительно всех) | array | SqlMigrationException | Применяет указанное количество миграций |
-| public function down(int $count = 0) | $count Количество миграция (0 - относительно всех) | array | SqlMigrationException | Отменяет указанное количество миграций |
+| public function up(int $count = 0) | $count Количество миграций (0 - относительно всех) | array | SqlMigrationException | Применяет указанное количество миграций |
+| public function down(int $count = 0) | $count Количество миграций (0 - относительно всех) | array | SqlMigrationException | Отменяет указанное количество миграций |
 | public function history(int $limit = 0) | $limit Ограничение длины списка (null - полный список) | array | | Возвращает список сообщений о примененных миграций |
-| public function create(string $name) | $name Название миграции | bool | RuntimeException\|SqlMigrationException | Создает новую миграцию и возвращает сообщение об успешном создании миграции |
+| public function create(string $name) | $name Название миграции | void | RuntimeException\|SqlMigrationException | Создает новую миграцию и возвращает сообщение об успешном создании миграции |
 | __construct(DatabaseInterface $database, array $settings) | $database Компонент работы с базой данных; array $settings Массив настроек | | SqlMigrationException | Конструктор класса |
 | public function initSchemaAndTable() | | bool | SqlMigrationException | Создает схему и таблицу в случае их отсутствия |
 | public function __destruct() | | | | Деструктор класса |
 | protected function getNotAppliedList() | | array | | Возвращает список не примененных миграций |
-| protected function getHistoryList(int $limit = 0) | $limit Ограничение длины списка (null - полный список) | array | | Возвращает список примененных миграций |
+| protected function getHistoryList(int $limit = 0) | $limit Ограничение длины списка (0 - полный список) | array | | Возвращает список примененных миграций |
 | protected function execute(array $list, int $count, string $type) | $list Массив миграций; $count Количество миграций для применения; $type Тип миграции (up/down) | array | RuntimeException | Выполняет миграции |
 | protected function addHistory(string $name) | $name Наименование миграции | bool | SqlMigrationException | Добавляет запись в таблицу миграций |
 | protected function removeHistory(string $name) | $name Наименование миграции | bool | SqlMigrationException | Удаляет миграцию из таблицы миграций |

src/ConsoleSqlMigration.php

@@ -40,16 +40,17 @@ public function up(int $count = 0): array {
 exit;
 }
 
-foreach ($migrations['success'] as $successMigration) {
-Console::writeLine("Миграция {$successMigration['name']} успешно применена", Console::FG_GREEN);
+if (array_key_exists('success', $migrations)) {
+foreach ($migrations['success'] as $successMigration) {
+Console::writeLine("Миграция {$successMigration['name']} успешно применена", Console::FG_GREEN);
+}
 }
 
 if (array_key_exists('error', $migrations)) {
 foreach ($migrations['error'] as $errorMigration) {
 Console::writeLine("Ошибка применения миграции {$errorMigration['name']}", Console::FG_RED);
+Console::writeLine($errorMigration['errorMessage'], Console::FG_WHITE);
 }
-
-exit;
 }
 
 return $migrations;
@@ -82,23 +83,23 @@ public function down(int $count = 0): array {
 return $migrations;
 }
 
-public function create(string $name): bool {
+public function create(string $name): void {
 try {
 parent::create($name);
 
 Console::writeLine("Миграция {$name} успешно создана");
 } catch (RuntimeException | SqlMigrationException $exception) {
 Console::writeLine($exception->getMessage(), Console::FG_RED);
-
-return false;
 }
-
-return true;
 }
 
 public function history(int $limit = 0): array {
 $historyList = parent::history($limit);
 
+if (empty($historyList)) {
+Console::writeLine('История миграций пуста');
+}
+
 foreach ($historyList as $historyRow) {
 Console::writeLine($historyRow);
 }

src/SqlMigration.php

@@ -29,9 +29,9 @@ class SqlMigration implements SqlMigrationInterface {
  */
 protected array $settings;
 /**
- * @var null|DatabaseInterface Компонент работы с базой данных
+ * @var DatabaseInterface Компонент работы с базой данных
  */
-protected ?DatabaseInterface $database;
+protected DatabaseInterface $database;
 
 /**
  * SqlMigration constructor.
@@ -86,7 +86,6 @@ public function initSchemaAndTable(): bool {
 
 public function __destruct() {
 $this->database->closeConnection();
-$this->database = null;
 }
 
 /**
@@ -99,10 +98,7 @@ public function up(int $count = 0): array {
 return [];
 }
 
-$executeListCount = count($executeList);
-$executeCount = $count === 0 ? $executeListCount : min($count, $executeListCount);
-
-return $this->execute($executeList, $executeCount, self::UP);
+return $this->execute($executeList, $count, self::UP);
 }
 
 /**
@@ -175,9 +171,12 @@ protected function getHistoryList(int $limit = 0): array {
  * @throws RuntimeException
  */
 protected function execute(array $list, int $count, string $type): array {
+$executeListCount = count($list);
+$executeCount = $count === 0 ? $executeListCount : min($count, $executeListCount);
+
 $migrationInfo = [];
 
-for ($index = 0; $index < $count; $index++) {
+for ($index = 0; $index < $executeCount; $index++) {
 $migration = $list[$index];
 $migration['path'] = array_key_exists('path', $migration) ? $migration['path'] :
 "{$this->settings['path']}/{$migration['name']}";
@@ -227,7 +226,7 @@ protected function addHistory(string $name): bool {
 SQL;
 
 if (!$this->database->execute($sql, ['name' => $name, 'apply_time' => time()])) {
-throw new SqlMigrationException("Ошибка применения миграция {$name}");
+throw new SqlMigrationException("Ошибка применения миграции {$name}");
 }
 
 return true;
@@ -278,7 +277,7 @@ public function history(int $limit = 0): array {
 $historyList = $this->getHistoryList($limit);
 
 if (empty($historyList)) {
-return ['История миграций пуста'];
+return [];
 }
 
 $messages = [];
@@ -295,7 +294,7 @@ public function history(int $limit = 0): array {
  *
  * @throws RuntimeException|SqlMigrationException
  */
-public function create(string $name): bool {
+public function create(string $name): void {
 $this->validateName($name);
 
 $migrationMame = $this->generateName($name);
@@ -312,8 +311,6 @@ public function create(string $name): bool {
 if (!file_put_contents($path . '/down.sql', '') === false) {
 throw new RuntimeException("Ошибка создания файла миграции {$path}/down.sql");
 }
-
-return true;
 }
 
 /**

src/interfaces/SqlMigrationInterface.php

@@ -19,9 +19,9 @@ interface SqlMigrationInterface {
 /**
  * Применяет указанное количество миграций
  *
- * @param int $count Количество миграция (0 - относительно всех)
+ * @param int $count Количество миграций (0 - относительно всех)
  *
- * @return array Возвращает список применения и ошибочных миграций. Список может иметь вид:
+ * @return array Возвращает список примененных и ошибочных миграций. Список может иметь вид:
  * 1. Случай, когда отсутствуют миграции для выполнения, то возвращается пустой массив
  * 2. Когда присутствуют миграции для выполнения:
  * [
@@ -37,7 +37,7 @@ public function up(int $count = 0): array;
 /**
  * Отменяет указанное количество миграций
  *
- * @param int $count Количество миграция (0 - относительно всех)
+ * @param int $count Количество миграций (0 - относительно всех)
  *
  * @return array Возвращает список отменных и ошибочных миграций. Список может иметь вид:
  * 1. Случай, когда отсутствуют миграции для выполнения, то возвращается пустой массив
@@ -55,7 +55,7 @@ public function down(int $count = 0): array;
 /**
  * Возвращает список сообщений о примененных миграций
  *
- * @param int $limit Ограничение длины списка (null - полный список)
+ * @param int $limit Ограничение длины списка (0 - полный список)
  *
  * @return array
  */
@@ -66,9 +66,9 @@ public function history(int $limit = 0): array;
  *
  * @param string $name Название миграции
  *
- * @return bool Возвращает true, если миграция была успешно создана. В остальных случаях выкидывает исключение
+ * @return void
  *
  * @throws RuntimeException|SqlMigrationException
  */
-public function create(string $name): bool;
+public function create(string $name): void;
 }