Merge pull request #21 from TheDragonCode/2.x

Add the ability to execute a specific file

Author: Andrey Helldar

src/Console/Migrate.php

@@ -22,7 +22,9 @@ class Migrate extends BaseCommand
     protected $signature = Names::MIGRATE
     . ' {--database= : The database connection to use}'
     . ' {--force : Force the operation to run when in production}'
-    . ' {--step : Force the actions to be run so they can be rolled back individually}';
+    . ' {--step : Force the actions to be run so they can be rolled back individually}'
+    . ' {--path=* : The path(s) to the migrations files to be executed}'
+    . ' {--realpath : Indicate any provided migration file paths are pre-resolved absolute paths}';
 
     /**
      * The console command description.
@@ -47,8 +49,7 @@ public function handle()
 
             $this->migrator->setOutput($this->output)
                 ->run($this->getMigrationPaths(), [
-                    'pretend' => null,
-                    'step'    => $this->optionStep(),
+                    'step' => $this->optionStep(),
                 ]);
         });
 
@@ -58,12 +59,23 @@ public function handle()
     /**
      * Prepare the action database for running.
      */
-    protected function prepareDatabase()
+    protected function prepareDatabase(): void
     {
         if (! $this->migrator->repositoryExists()) {
             $this->call(Names::INSTALL, array_filter([
                 '--database' => $this->optionDatabase(),
             ]));
         }
     }
+
+    protected function getMigrationPaths(): array
+    {
+        if ($paths = $this->optionPath()) {
+            return $paths;
+        }
+
+        return array_merge(
+            $this->migrator->paths(), [$this->getMigrationPath()]
+        );
+    }
 }

src/ServiceProvider.php

@@ -29,7 +29,7 @@ class ServiceProvider extends BaseServiceProvider
         'MigrateStatus'   => Command::STATUS,
     ];
 
-    public function register()
+    public function register(): void
     {
         $this->registerConfig();
         $this->registerRepository();
@@ -38,7 +38,7 @@ public function register()
         $this->registerCommands($this->commands);
     }
 
-    public function provides()
+    public function provides(): array
     {
         return array_merge([
             Action::MIGRATOR,

src/Traits/Optionable.php

@@ -2,6 +2,8 @@
 
 namespace DragonCode\LaravelActions\Traits;
 
+use Illuminate\Support\Str;
+
 /** @mixin \Illuminate\Console\Command */
 trait Optionable
 {
@@ -14,4 +16,25 @@ protected function optionStep(int $default = null): ?int
     {
         return $this->input->getOption('step') ?: $default;
     }
+
+    protected function optionPath(): ?array
+    {
+        if ($path = $this->option('path')) {
+            return collect($path)->map(function ($path) {
+                if ($this->usingRealPath()) {
+                    return $path;
+                }
+
+                $filename = $this->getMigrationPath() . DIRECTORY_SEPARATOR . $path;
+
+                if (is_dir($filename) || file_exists($filename)) {
+                    return $filename;
+                }
+
+                return Str::finish($filename, '.php');
+            })->all();
+        }
+
+        return null;
+    }
 }

tests/Commands/MigrateTest.php

@@ -88,8 +88,7 @@ public function testFailedTransaction()
 
         try {
             $this->artisan('migrate:actions')->run();
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->assertSame(Exception::class, get_class($e));
             $this->assertSame('Random message', $e->getMessage());
         }
@@ -204,6 +203,66 @@ public function testAllow()
         $this->artisan('migrate:actions')->run();
     }
 
+    public function testPathAsFileWithExtension()
+    {
+        $this->copyFiles();
+
+        $table = 'test';
+
+        $path = 'sub_path/2021_12_15_205804_baz.php';
+
+        $this->artisan('migrate:actions:install')->run();
+
+        $this->assertDatabaseCount($table, 0);
+        $this->assertDatabaseCount($this->table, 0);
+        $this->assertDatabaseMigrationDoesntLike($this->table, 'baz');
+        $this->artisan('migrate:actions', ['--path' => $path])->run();
+
+        $this->assertDatabaseCount($table, 1);
+        $this->assertDatabaseCount($this->table, 1);
+        $this->assertDatabaseMigrationHas($this->table, 'baz');
+    }
+
+    public function testPathAsFileWithoutExtension()
+    {
+        $this->copyFiles();
+
+        $table = 'test';
+
+        $path = 'sub_path/2021_12_15_205804_baz';
+
+        $this->artisan('migrate:actions:install')->run();
+
+        $this->assertDatabaseCount($table, 0);
+        $this->assertDatabaseCount($this->table, 0);
+        $this->assertDatabaseMigrationDoesntLike($this->table, 'baz');
+        $this->artisan('migrate:actions', ['--path' => $path])->run();
+
+        $this->assertDatabaseCount($table, 1);
+        $this->assertDatabaseCount($this->table, 1);
+        $this->assertDatabaseMigrationHas($this->table, 'baz');
+    }
+
+    public function testPathAsDirectory()
+    {
+        $this->copyFiles();
+
+        $table = 'test';
+
+        $path = 'sub_path';
+
+        $this->artisan('migrate:actions:install')->run();
+
+        $this->assertDatabaseCount($table, 0);
+        $this->assertDatabaseCount($this->table, 0);
+        $this->assertDatabaseMigrationDoesntLike($this->table, 'baz');
+        $this->artisan('migrate:actions', ['--path' => $path])->run();
+
+        $this->assertDatabaseCount($table, 1);
+        $this->assertDatabaseCount($this->table, 1);
+        $this->assertDatabaseMigrationHas($this->table, 'baz');
+    }
+
     public function testMigrationNotFound()
     {
         $this->assertDatabaseDoesntTable($this->table);

tests/fixtures/actions/sub_path/2021_12_15_205804_baz.php

@@ -0,0 +1,26 @@
+<?php
+
+use DragonCode\LaravelActions\Support\Actionable;
+use Illuminate\Database\Query\Builder;
+use Illuminate\Support\Facades\DB;
+use Ramsey\Uuid\Uuid;
+
+class Baz extends Actionable
+{
+    public function up(): void
+    {
+        $this->table()->insert([
+            'value' => Uuid::uuid4(),
+        ]);
+    }
+
+    public function down(): void
+    {
+        $this->table()->truncate();
+    }
+
+    protected function table(): Builder
+    {
+        return DB::table('test');
+    }
+}