table options

bizley · Oct 29, 2018 · 238cc74 · 238cc74
1 parent 27b311f
commit 238cc74
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -102,6 +102,8 @@ Starting with yii2-migration v2.0 it is possible to generate updating migration
 | `generalSchema`      | `g`   | Whether to use general column schema instead of database specific (1). _default:_ `1`
 | `fixHistory`         | `h`   | Whether to add migration history entry when migration is generated. _default:_ `0`
 | `skipMigrations`     |       | List of migrations from the history table that should be skipped during the update process (2). _default:_ `[]`
+| `tableOptionsInit`   | `O`   | String rendered in the create migration template to initialize table options. _default:_ `$tableOptions = null; if ($this->db->driverName === 'mysql') { $tableOptions = 'CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE=InnoDB'; }`
+| `tableOptions`       | `o`   | String rendered in the create migration template for table options. _default:_ `$tableOptions`
 
 (1) Remember that with different database types general column schemas may be generated with different length.
 

diff --git a/src/Generator.php b/src/Generator.php
@@ -75,6 +75,18 @@ class Generator extends Component
      */
     public $generalSchema = true;
 
+    /**
+     * @var string|null
+     * @since 2.3.4
+     */
+    public $tableOptionsInit;
+
+    /**
+     * @var string|null
+     * @since 2.3.4
+     */
+    public $tableOptions;
+
     /**
      * Checks if DB connection is passed.
      * @throws InvalidConfigException
@@ -259,7 +271,9 @@ public function getTable()
                 'primaryKey' => $this->getTablePrimaryKey(),
                 'columns' => $this->getTableColumns($indexes),
                 'foreignKeys' => $this->getTableForeignKeys(),
-                'indexes' => $indexes
+                'indexes' => $indexes,
+                'tableOptionsInit' => $this->tableOptionsInit,
+                'tableOptions' => $this->tableOptions,
             ]);
         }
         return $this->_table;

diff --git a/src/controllers/MigrationController.php b/src/controllers/MigrationController.php
@@ -20,13 +20,13 @@
  * Generates migration file based on the existing database table and previous migrations.
  *
  * @author Paweł Bizley Brzozowski
- * @version 2.3.3
+ * @version 2.3.4
  * @license Apache 2.0
  * https://github.com/bizley/yii2-migration
  */
 class MigrationController extends Controller
 {
-    protected $version = '2.3.3';
+    protected $version = '2.3.4';
 
     /**
      * @var string Default command action.
@@ -115,6 +115,27 @@ class MigrationController extends Controller
      */
     public $skipMigrations = [];
 
+    /**
+     * @var string|null String rendered in the create migration template to initialize table options.
+     * By default it adds variable "$tableOptions" with optional collate configuration for MySQL DBMS to be used with
+     * default $tableOptions.
+     * Alias -O
+     * @since 2.3.4
+     */
+    public $tableOptionsInit = '$tableOptions = null;
+        if ($this->db->driverName === \'mysql\') {
+            $tableOptions = \'CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE=InnoDB\';
+        }';
+
+    /**
+     * @var string|null String rendered in the create migration template for table options.
+     * By default it renders "$tableOptions" to indicate that options should be taken from variable
+     * set in $tableOptionsInit property.
+     * Alias -o
+     * @since 2.3.4
+     */
+    public $tableOptions = '$tableOptions';
+
     /**
      * @inheritdoc
      */
@@ -126,7 +147,7 @@ public function options($actionID)
         switch ($actionID) {
             case 'create':
             case 'create-all':
-                return array_merge($options, $createOptions);
+                return array_merge($options, $createOptions, ['tableOptionsInit', 'tableOptions']);
             case 'update':
             case 'update-all':
                 return array_merge($options, $createOptions, $updateOptions);
@@ -150,6 +171,8 @@ public function optionAliases()
             'P' => 'useTablePrefix',
             'h' => 'fixHistory',
             's' => 'showOnly',
+            'O' => 'tableOptionsInit',
+            'o' => 'tableOptions',
         ]);
     }
 
@@ -331,6 +354,8 @@ public function actionCreate($table)
                 'className' => $className,
                 'namespace' => $this->migrationNamespace,
                 'generalSchema' => $this->generalSchema,
+                'tableOptionsInit' => $this->tableOptionsInit,
+                'tableOptions' => $this->tableOptions,
             ]);
 
             if ($generator->tableSchema === null) {

diff --git a/src/table/TableStructure.php b/src/table/TableStructure.php
@@ -54,14 +54,15 @@ class TableStructure extends Object
      */
     public $dbPrefix;
     /**
-     * @var string
+     * @var string|null
+     * @since 2.3.4
      */
-    public $tableOptionsInit = <<<'PHP'
-$tableOptions = null;
-        if ($this->db->driverName === 'mysql') {
-            $tableOptions = 'CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE=InnoDB';
-        }
-PHP;
+    public $tableOptionsInit;
+    /**
+     * @var string|null
+     * @since 2.3.4
+     */
+    public $tableOptions;
 
     /**
      * Returns schema type.
@@ -137,23 +138,14 @@ public function renderTable()
     {
         $output = '';
 
-        $tableOptionsSet = false;
-        if ($this->generalSchema || $this->schema === self::SCHEMA_MYSQL) {
-            $output .= <<<'PHP'
-        $tableOptions = null;
-        if ($this->db->driverName === 'mysql') {
-            $tableOptions = 'CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE=InnoDB';
-        }
-
-
-PHP;
-            $tableOptionsSet = true;
+        if ($this->tableOptionsInit !== null) {
+            $output .= "        {$this->tableOptionsInit}\n\n";
         }
         $output .= "        \$this->createTable('" . $this->renderName() . "', [";
         foreach ($this->columns as $column) {
             $output .= "\n" . $column->render($this);
         }
-        $output .= "\n        ]" . ($tableOptionsSet ? ', $tableOptions' : '') . ");\n";
+        $output .= "\n        ]" . ($this->tableOptions !== null ? ", {$this->tableOptions}" : '') . ");\n";
 
         return $output;
     }

diff --git a/tests/table/TableStructureTest.php b/tests/table/TableStructureTest.php
@@ -0,0 +1,55 @@
+<?php
+
+namespace bizley\tests\table;
+
+use bizley\migration\table\TableStructure;
+
+class TableStructureTest extends \PHPUnit\Framework\TestCase
+{
+    public function testRenderNameNoPrefix()
+    {
+        $table = new TableStructure([
+            'name' => 'test',
+            'usePrefix' => false,
+        ]);
+        $this->assertEquals('test', $table->renderName());
+    }
+
+    public function testRenderNameWithPrefix()
+    {
+        $table = new TableStructure([
+            'name' => 'test',
+        ]);
+        $this->assertEquals('{{%test}}', $table->renderName());
+    }
+
+    public function testRenderNameWithPrefixAlreadyInName()
+    {
+        $table = new TableStructure([
+            'name' => 'prefix_test',
+            'dbPrefix' => 'prefix_',
+        ]);
+        $this->assertEquals('{{%test}}', $table->renderName());
+    }
+
+    public function testRenderTableCreate()
+    {
+        $table = new TableStructure([
+            'name' => 'test',
+        ]);
+        $this->assertEquals("        \$this->createTable('{{%test}}', [\n        ]);\n", $table->renderTable());
+    }
+
+    public function testRenderTableCreateDefaultTableOptions()
+    {
+        $table = new TableStructure([
+            'name' => 'test',
+            'tableOptionsInit' => '$tableOptions = null;
+        if ($this->db->driverName === \'mysql\') {
+            $tableOptions = \'CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE=InnoDB\';
+        }',
+            'tableOptions' => '$tableOptions',
+        ]);
+        $this->assertEquals("        \$tableOptions = null;\n        if (\$this->db->driverName === 'mysql') {\n            \$tableOptions = 'CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE=InnoDB';\n        }\n\n        \$this->createTable('{{%test}}', [\n        ], \$tableOptions);\n", $table->renderTable());
+    }
+}