feat: Require manual publishing of migrations instead of auto migrating

Also includes test to test migration

Author: athphane

…5_120524_create_mobile_numbers_table.php …grations/create_mobile_numbers_table.phpdatabase/migrations/2024_04_15_120524_create_mobile_numbers_table.php renamed to database/migrations/create_mobile_numbers_table.php database/migrations/2024_04_15_120524_create_mobile_numbers_table.php renamed to database/migrations/create_mobile_numbers_table.php

@@ -4,7 +4,7 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Migrations\Migration;
 
-class CreateMobileNumbersTable extends Migration
+return new class extends Migration
 {
     /**
      * Run the migrations.
@@ -42,4 +42,4 @@ public function down()
     {
         Schema::connection(config('mobile-verification.database_connection'))->dropIfExists(config('mobile-verification.table_name'));
     }
-}
+};

src/MobileVerification.php

@@ -7,25 +7,6 @@
 
 class MobileVerification
 {
-    /**
-     * Indicates if migrations will be run.
-     *
-     * @var bool
-     */
-    public static $runsMigrations = true;
-
-    /**
-     * Configure to not register its migrations.
-     *
-     * @return static
-     */
-    public static function ignoreMigrations()
-    {
-        static::$runsMigrations = false;
-
-        return new static();
-    }
-
     /**
      * Get the configs
      * @param string $key

src/MobileVerificationServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace Javaabu\MobileVerification;
 
+use Carbon\Carbon;
+use Illuminate\Support\Str;
 use Laravel\Passport\Passport;
 use Illuminate\Support\ServiceProvider;
 use League\OAuth2\Server\AuthorizationServer;
@@ -12,18 +14,31 @@
 
 class MobileVerificationServiceProvider extends ServiceProvider
 {
+    /**
+     * The package migrations, in order of creation.
+     *
+     * @var array|string[]
+     */
+    protected array $migrations = [
+        'create_mobile_numbers_table'
+    ];
+
     /**
      * Bootstrap the application services.
      */
     public function boot()
     {
         // declare publishes
         if ($this->app->runningInConsole()) {
-            $this->registerMigrations();
+            // Publish migrations with current timestamp
+            foreach ($this->migrations as $migration) {
+                $vendorMigration = __DIR__ . '/../database/migrations/' . $migration . '.php';
+                $appMigration = $this->generateMigrationName($migration, now()->addSecond());
 
-            $this->publishes([
-                __DIR__.'/../database/migrations' => database_path('migrations'),
-            ], 'mobile-verification-migrations');
+                $this->publishes([
+                    $vendorMigration => $appMigration,
+                ], 'mobile-verification-migrations');
+            }
 
             $this->publishes([
                 __DIR__ . '/../config/mobile-verification.php' => config_path('mobile-verification.php'),
@@ -38,18 +53,6 @@ public function boot()
         $this->loadTranslationsFrom(__DIR__.'/../lang', 'mobile-verification');
     }
 
-    /**
-     * Register migration files.
-     *
-     * @return void
-     */
-    protected function registerMigrations(): void
-    {
-        if (MobileVerification::$runsMigrations) {
-            $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
-        }
-    }
-
     /**
      * Register the application services.
      */
@@ -80,4 +83,28 @@ protected function makeGrant(): MobileGrant
 
         return $grant;
     }
+
+    protected function generateMigrationName(string $migrationFileName, Carbon $now): string
+    {
+        $migrationsPath = 'migrations/' . dirname($migrationFileName) . '/';
+        $migrationFileName = basename($migrationFileName);
+
+        $len = strlen($migrationFileName) + 4;
+
+        if (Str::contains($migrationFileName, '/')) {
+            $migrationsPath .= Str::of($migrationFileName)->beforeLast('/')->finish('/');
+            $migrationFileName = Str::of($migrationFileName)->afterLast('/');
+        }
+
+        foreach (glob(database_path("{$migrationsPath}*.php")) as $filename) {
+            if ((substr($filename, -$len) === $migrationFileName . '.php')) {
+                return $filename;
+            }
+        }
+
+        $timestamp = $now->format('Y_m_d_His');
+        $migrationFileName = Str::of($migrationFileName)->snake()->finish('.php');
+
+        return database_path($migrationsPath . $timestamp . '_' . $migrationFileName);
+    }
 }

tests/TestSupport/Providers/TestServiceProvider.php

@@ -17,6 +17,7 @@ public function boot()
     {
         $this->loadMigrationsFrom([
             __DIR__ . '/../database',
+            __DIR__ . '/../../../database/migrations',
             __DIR__ . '/../../../vendor/laravel/passport/database/migrations'
         ]);
 

tests/Unit/migrations/CreateMobileNumbersTableTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Javaabu\MobileVerification\Tests\Unit\migrations;
+
+use Illuminate\Support\Facades\Schema;
+use PHPUnit\Framework\Attributes\Test;
+use Javaabu\MobileVerification\Tests\TestCase;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+
+class CreateMobileNumbersTableTest extends TestCase
+{
+    use RefreshDatabase;
+
+    #[Test]
+    public function it_can_migrate_up_languages_table()
+    {
+        $this->withoutExceptionHandling();
+
+        $this->assertTrue(Schema::hasTable('mobile_numbers'));
+        $this->assertTrue(Schema::hasColumn('mobile_numbers', 'user_type'));
+        $this->assertTrue(Schema::hasColumn('mobile_numbers', 'user_id'));
+        $this->assertTrue(Schema::hasColumn('mobile_numbers', 'attempts'));
+        $this->assertTrue(Schema::hasColumn('mobile_numbers', 'number'));
+        $this->assertTrue(Schema::hasColumn('mobile_numbers', 'country_code'));
+        $this->assertTrue(Schema::hasColumn('mobile_numbers', 'verification_code'));
+        $this->assertTrue(Schema::hasColumn('mobile_numbers', 'verification_code_created_at'));
+        $this->assertTrue(Schema::hasColumn('mobile_numbers', 'verification_code_id'));
+    }
+}