Merge pull request #142 from kitloong/feature/anonymous

Generate anonymous migration

Author: kitloong

.phpmd.xml

@@ -28,7 +28,7 @@
     </rule>
     <rule ref="rulesets/codesize.xml/ExcessiveClassComplexity">
         <properties>
-            <property name="maximum" value="60"/>
+            <property name="maximum" value="65"/>
         </properties>
     </rule>
     <rule ref="rulesets/codesize.xml/ExcessiveParameterList">

config/migrations-generator.php

@@ -2,13 +2,14 @@
 
 return [
     // Where the templates for the generators are stored.
-    'migration_template_path' => __DIR__ . '/../stubs/migration.generate.stub',
+    'migration_template_path'           => __DIR__ . '/../stubs/migration.generate.stub',
+    'migration_anonymous_template_path' => __DIR__ . '/../stubs/migration.generate.anonymous.stub',
 
     // Where the generated files will be saved.
-    'migration_target_path'   => base_path('database/migrations'),
+    'migration_target_path'             => base_path('database/migrations'),
 
     // Migration filename pattern.
-    'filename_pattern'        => [
+    'filename_pattern'                  => [
         'table'       => '[datetime]_create_[name]_table.php',
         'view'        => '[datetime]_create_[name]_view.php',
         'procedure'   => '[datetime]_create_[name]_proc.php',

src/DBAL/RegisterColumnType.php

@@ -76,7 +76,6 @@ public function handle(): void
      */
     private function registerLaravelColumnType(): void
     {
-        /** @var array<string, string> $typesMap */
         $typesMap = array_flip(Types::ADDITIONAL_TYPES_MAP);
 
         foreach ($typesMap as $type => $doctrineTypeClassName) {
@@ -149,7 +148,7 @@ private function getCustomTypes(): Collection
      * Add or override doctrine type.
      *
      * @param  string  $type
-     * @param  string  $class  The class name which is extends {@see \Doctrine\DBAL\Types\Type}.
+     * @param  class-string<\Doctrine\DBAL\Types\Type>  $class  The class name which is extends {@see \Doctrine\DBAL\Types\Type}.
      * @throws \Doctrine\DBAL\Exception
      */
     private function addOrOverrideType(string $type, string $class): void

src/MigrateGenerateCommand.php

@@ -22,9 +22,12 @@
 use KitLoong\MigrationsGenerator\Schema\Schema;
 use KitLoong\MigrationsGenerator\Schema\SQLiteSchema;
 use KitLoong\MigrationsGenerator\Schema\SQLSrvSchema;
+use KitLoong\MigrationsGenerator\Support\CheckMigrationMethod;
 
 class MigrateGenerateCommand extends Command
 {
+    use CheckMigrationMethod;
+
     /**
      * The name and signature of the console command.
      *
@@ -148,9 +151,7 @@ protected function setup(string $connection): void
             $this->option('path') ?? Config::get('migrations-generator.migration_target_path')
         );
 
-        $setting->setStubPath(
-            $this->option('template-path') ?? Config::get('migrations-generator.migration_template_path')
-        );
+        $this->setStubPath($setting);
 
         $setting->setDate(
             $this->option('date') ? Carbon::parse($this->option('date')) : Carbon::now()
@@ -173,6 +174,25 @@ protected function setup(string $connection): void
         );
     }
 
+    /**
+     * Set migration stub.
+     *
+     * @param  \KitLoong\MigrationsGenerator\Setting  $setting
+     * @return void
+     */
+    protected function setStubPath(Setting $setting): void
+    {
+        $defaultStub = Config::get('migrations-generator.migration_anonymous_template_path');
+
+        if (!$this->hasAnonymousMigration()) {
+            $defaultStub = Config::get('migrations-generator.migration_template_path');
+        }
+
+        $setting->setStubPath(
+            $this->option('template-path') ?? $defaultStub
+        );
+    }
+
     /**
      * Get all tables from schema or return table list provided in option.
      * Then filter and exclude tables in `--ignore` option if any.

src/Migration/Blueprint/Support/MergeTimestamps.php

@@ -67,18 +67,18 @@ public function merge(array $lines, bool $tz): array
     /**
      * Check if column name (created_at or updated_at) is possible a timestamps.
      *
-     * @param  string  $name  Column name, created_at or updated_at.
+     * @param  \KitLoong\MigrationsGenerator\Enum\Migrations\ColumnName  $columnName  Column name, created_at or updated_at.
      * @param  \KitLoong\MigrationsGenerator\Migration\Blueprint\Method  $method
      * @param  bool  $tz  Is timezone.
      * @return bool
      */
-    private function checkTimestamps(string $name, Method $method, bool $tz): bool
+    private function checkTimestamps(ColumnName $columnName, Method $method, bool $tz): bool
     {
         if (!$this->isPossibleTimestampsColumn($method, $tz)) {
             return false;
         }
 
-        if ($method->getValues()[0] !== $name) {
+        if ($method->getValues()[0] !== $columnName->getValue()) {
             return false;
         }
 

src/MigrationsGeneratorServiceProvider.php

@@ -99,7 +99,7 @@ protected function registerConfig()
      * Make column generator singleton by type.
      *
      * @param  \KitLoong\MigrationsGenerator\Enum\Migrations\Method\ColumnType  $type
-     * @param  string  $columnTypeGenerator
+     * @param  class-string<\KitLoong\MigrationsGenerator\Migration\Generator\Columns\ColumnTypeGenerator>  $columnTypeGenerator
      */
     protected function columnTypeSingleton(ColumnType $type, string $columnTypeGenerator): void
     {

src/Support/CheckMigrationMethod.php

@@ -2,6 +2,7 @@
 
 namespace KitLoong\MigrationsGenerator\Support;
 
+use Illuminate\Database\Migrations\Migrator;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Schema\Grammars\Grammar;
 
@@ -38,4 +39,15 @@ public function hasFullText(): bool
     {
         return method_exists(Grammar::class, 'compileFulltext');
     }
+
+    /**
+     * Check if support anonymous migration.
+     * This feature is added in late Laravel v8 and above.
+     *
+     * @return bool
+     */
+    public function hasAnonymousMigration(): bool
+    {
+        return method_exists(Migrator::class, 'getMigrationClass');
+    }
 }

stubs/migration.generate.anonymous.stub

@@ -0,0 +1,26 @@
+<?php
+
+{{ use }}
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        {{ up }}
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        {{ down }}
+    }
+};

tests/Feature/FeatureTestCase.php

@@ -144,8 +144,7 @@ protected function generateMigrations(array $options = []): void
         $this->artisan(
             'migrate:generate',
             array_merge([
-                '--path'          => $this->getStorageMigrationsPath(),
-                '--template-path' => base_path('stubs/migration.generate.stub'),
+                '--path' => $this->getStorageMigrationsPath(),
             ], $options)
         )
             ->expectsQuestion('Do you want to log these migrations in the migrations table?', true)

tests/Feature/MySQL57/DBConnectionTest.php

@@ -63,9 +63,8 @@ public function testDBConnection()
             $this->artisan(
                 'migrate:generate',
                 [
-                    '--connection'    => 'mysql57',
-                    '--path'          => $this->getStorageMigrationsPath(),
-                    '--template-path' => base_path('stubs/migration.generate.stub'),
+                    '--connection' => 'mysql57',
+                    '--path'       => $this->getStorageMigrationsPath(),
                 ]
             )
                 ->expectsQuestion('Do you want to log these migrations in the migrations table?', true)
@@ -101,9 +100,8 @@ public function testLogMigrationToAnotherSource()
         $this->artisan(
             'migrate:generate',
             [
-                '--connection'    => 'mysql57',
-                '--path'          => $this->getStorageMigrationsPath(),
-                '--template-path' => base_path('stubs/migration.generate.stub'),
+                '--connection' => 'mysql57',
+                '--path'       => $this->getStorageMigrationsPath(),
             ]
         )
             ->expectsQuestion('Do you want to log these migrations in the migrations table?', true)