migration order

Author: bastinald

config/laravel-automatic-migrations.php

@@ -8,8 +8,8 @@
     |--------------------------------------------------------------------------
     |
     | This value is the path to the stubs the package should use when executing
-    | commands. To use your own stubs, make sure you vendor:publish the package
-    | stubs and update this value to point to the resource path.
+    | commands. To use your own stubs, vendor:publish the package stubs and set
+    | this to: resource_path('stubs/vendor/laravel-automatic-migrations')
     |
     */
 

readme.md

@@ -11,6 +11,7 @@ This package works fine alongside traditional Laravel migration files, for the c
 - [Commands](#commands)
     - [Making Models](#making-models)
     - [Running Migrations](#running-migrations)
+- [Migration Order](#migration-order)
 - [Publishing Stubs](#publishing-stubs)
 - [Traits](#traits)
     - [HasHashes](#hashashes)
@@ -73,6 +74,27 @@ php artisan migrate:auto {--f|--fresh} {--s|--seed} {--force}
 
 Use `-f` to wipe the database, `-s` to seed after migration, and `--force` to run migrations in production.
 
+## Migration Order
+
+You can specify the order to run your model migrations by adding a public `migrationOrder` property to your models. This is useful for pivot tables or situations where you must create a certain table before another.
+
+```php
+class MyModel extends Model
+{
+    public $migrationOrder = 1;
+
+    public function migration(Blueprint $table)
+    {
+        $table->id();
+        $table->string('name');
+        $table->timestamp('created_at')->nullable();
+        $table->timestamp('updated_at')->nullable();
+    }
+}
+```
+
+The `migrate:auto` command will run the automatic migrations in the order specified. If no order is declared for a model, it will default to `0`. Thanks to [@vincentkedison](https://github.com/vincentkedison) for this idea.
+
 ## Publishing Stubs
 
 Use your own model and factory stubs by publishing package files:

resources/stubs/Model.php

@@ -13,8 +13,6 @@ class DummyModelClass extends Model
 
     protected $guarded = [];
 
-    public    $migration_sequence = 1;
-
     public function migration(Blueprint $table)
     {
         $table->id();

resources/stubs/UserModel.php

@@ -18,7 +18,6 @@ class DummyModelClass extends Authenticatable
     protected $hashes = ['password'];
     protected $hidden = ['password', 'remember_token'];
     protected $casts = ['email_verified_at' => 'datetime'];
-    public    $migration_sequence = 0;
 
     public function migration(Blueprint $table)
     {

src/Commands/MigrateAutoCommand.php

@@ -46,8 +46,9 @@ private function runTraditionalMigrations()
 
     private function runAutomaticMigrations()
     {
-        $path = app_path('Models');
+        $path = is_dir(app_path('Models')) ? app_path('Models') : app_path();
         $namespace = app()->getNamespace();
+        $models = collect();
 
         if (!is_dir($path)) {
             return;
@@ -61,35 +62,20 @@ private function runAutomaticMigrations()
                 );
 
             if (method_exists($model, 'migration')) {
-                $this->migrate($model);
+                $models->push([
+                    'object' => $object = app($model),
+                    'order' => $object->migrationOrder ?? 0,
+                ]);
             }
         }
 
-        $models_to_migrate = collect([]);
-
-        foreach ((new Finder)->in($path) as $model) {
-            $model = $namespace . str_replace(
-                    ['/', '.php'],
-                    ['\\', ''],
-                    Str::after($model->getRealPath(), realpath(app_path()) . DIRECTORY_SEPARATOR)
-                );
-
-            if (method_exists($model, 'migration')) {
-                $model_object = app($model);
-                $models_to_migrate[] = ['sequence' => $model_object->migration_sequence ?? 1, 'model' =>  $model];
-            }
-        }
-
-        $sorted_models_to_migrate = $models_to_migrate->sortBy('sequence');
-
-        foreach ($sorted_models_to_migrate as $model) {
-            $this->migrate($model['model']);
+        foreach ($models->sortBy('order') as $model) {
+            $this->migrate($model['object']);
         }
     }
 
-    private function migrate($class)
+    private function migrate($model)
     {
-        $model = app($class);
         $modelTable = $model->getTable();
         $tempTable = 'table_' . $modelTable;
 
@@ -120,14 +106,16 @@ private function migrate($class)
 
     private function seed()
     {
-        if ($this->option('seed')) {
-            $command = 'db:seed';
+        if (!$this->option('seed')) {
+            return;
+        }
 
-            if ($this->option('force')) {
-                $command .= ' --force';
-            }
+        $command = 'db:seed';
 
-            Artisan::call($command, [], $this->getOutput());
+        if ($this->option('force')) {
+            $command .= ' --force';
         }
+
+        Artisan::call($command, [], $this->getOutput());
     }
 }