Merge pull request #86 from creasico/feat/publish-migration

feat(db): add basic database migration for `addresses` table, fix #85

.github/workflows/test.yml

@@ -154,6 +154,11 @@ jobs:
           composer require "laravel/framework=${{ matrix.laravel }}" --no-update
           composer update --prefer-dist --no-interaction --no-progress
 
+      - name: Run migrations
+        run: |
+          composer testbench vendor:publish -- --tag creasi-migrations
+          composer testbench migrate
+
       - name: Run tests
         run: composer test -- --coverage
 

README.md

@@ -801,6 +801,14 @@ class User extends Model implements HasAddresses
 }
 ```
 
+To be able to use `Address` model, all you need is to publish the migration, like so
+
+```sh
+php artisan vendor:publish --tag creasi-migrations
+```
+
+Then simply run `artisan migrate` to apply the additional migrations.
+
 ### Databases
 
 The database structure documentation please consult to [`database/README.md`](https://github.com/creasico/laravel-nusa/blob/main/database/README.md).

database/.gitattributes

@@ -1,2 +1,2 @@
-migrations   export-ignore
-seeders      export-ignore
+migrations/*.php   export-ignore
+seeders            export-ignore

src/ServiceProvider.php

@@ -4,6 +4,8 @@
 
 namespace Creasi\Nusa;
 
+use Illuminate\Filesystem\Filesystem;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider as IlluminateServiceProvider;
 
@@ -58,6 +60,10 @@ protected function registerPublishables()
         $this->publishes([
             self::LIB_PATH.'/resources/lang' => \resource_path('lang/vendor/creasico'),
         ], ['creasi-lang']);
+
+        $this->publishes([
+            self::LIB_PATH.'/database/migrations/create_addresses_tables.php.stub' => $this->getMigrationFileName('create_addresses_tables.php'),
+        ], 'creasi-migrations');
     }
 
     protected function registerBindings()
@@ -85,6 +91,22 @@ protected function registerBindings()
         });
     }
 
+    /**
+     * Returns existing migration file if found, else uses the current timestamp.
+     *
+     * @link https://github.com/spatie/laravel-permission/blob/main/src/PermissionServiceProvider.php
+     */
+    protected function getMigrationFileName(string $migrationFileName): string
+    {
+        $timestamp = date('Y_m_d_His');
+        $filesystem = $this->app->make(Filesystem::class);
+
+        return Collection::make([$this->app->databasePath().DIRECTORY_SEPARATOR.'migrations'.DIRECTORY_SEPARATOR])
+            ->flatMap(fn ($path) => $filesystem->glob($path.'*_'.$migrationFileName))
+            ->push($this->app->databasePath()."/migrations/{$timestamp}_{$migrationFileName}")
+            ->first();
+    }
+
     public function provides()
     {
         return [

workbench/app/Providers/WorkbenchServiceProvider.php

@@ -6,8 +6,6 @@
 use Illuminate\Support\ServiceProvider;
 use Workbench\App\Console\StatCommand;
 
-use function Orchestra\Testbench\workbench_path;
-
 class WorkbenchServiceProvider extends ServiceProvider
 {
     /**
@@ -23,10 +21,6 @@ public function register(): void
      */
     public function boot(): void
     {
-        $this->loadMigrationsFrom(
-            workbench_path('database/migrations')
-        );
-
         if (app()->runningInConsole()) {
             $this->commands([
                 StatCommand::class,