Merge pull request #70 from waynestate/auto-migration-option

Move to loading migrations using loadMigrationsFrom instead of publishing

CHANGELOG.md

@@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Changed
+* Renamed the migration to include a timestamp to ensure only one migration is created.
+* Updated README.md
+
+### Added
+* Added new `enable_migrations` option to the config file to allow for the disabling of the migrations.
+* Added new `auto_migrate` option to the config file to allow for the disabling of the automatic running of the migrations.
+* Added new UPGRADE.md for upgrade instructions.
+
 ## [1.1.4] - 2022-11-02
 ### Fixed
 * Add check for migrations to make sure the table doesn't exist before trying to create it. by @chrispelzer in https://github.com/waynestate/nova-ckeditor4-field/pull/68 https://github.com/waynestate/nova-ckeditor4-field/issues/67

README.md

@@ -110,11 +110,33 @@ The `nova-ckeditor4-field` allows the use of file uploads by extending the attac
 
 ```bash
 php artisan vendor:publish --tag=nova-ckeditor4-field-config # Make sure the config file is published
+php artisan migrate # Run the migrations
+```
+
+The package migrations will automatically run when running `php artisan migrate`.
+
+If you are not going to use the Files and have no need for the migrations, you can disable migrations in `config/nova/ckeditor-field.php`, set the `enable_migrations` to `false`.
+```php
+    'migrations' => [
+        'enable_migrations' => false,
+        // ...
+    ],
+```
+
+If you wish do not wish to use the [Laravel Migration](https://laravel.com/docs/9.x/packages#migrations), but publish the migration yourself to your project.
+Within the published `/config/nova/ckeditor-field.php`, set the `auto_migration` to `false`.
+```php
+    'migrations' => [
+        'enable_migrations' => true,
+        'auto_migrate' => false,
+    ],
+```
+and then publish the migration to your project.
+```php
 php artisan vendor:publish --tag=nova-ckeditor4-field-migrations
-php artisan migrate
 ```
 
-Within the published `/config/nova/ckeditor-field.php`, if you wish to not use the default `Attachment` and/or `PendingAttachment` models. You could replace with your own:
+if you wish to not use the default `Attachment` and/or `PendingAttachment` models. You could replace with your own within the published `/config/nova/ckeditor-field.php`, 
 ```php
     'attachment_model' => \Waynestate\Nova\CKEditor4Field\Models\Attachment::class,
     'pending_attachment_model' => \Waynestate\Nova\CKEditor4Field\Models\PendingAttachment::class,

UPGRADING.md

@@ -0,0 +1,21 @@
+## From v1.1.4 to v1.2.0
+
+Added support for Laravel loadMigrationsFrom to allow for migrations to be handled without needing to publish them.
+
+Previous versions the migration was being published with the timestamp of the time of publishing which caused multiple migrations to be published.
+
+This update renames the migration that is published to include the timestamp from the time it was initially committed to prevent multiple migrations from being published.
+
+You'll also want to make sure that your published `/config/nova/ckeditor-field.php` has the new `enable_migrations` and `auto_migrate` options.
+```php
+    'migrations' => [
+        'enable_migrations' => true,
+        'auto_migrate' => true,
+    ],
+```
+
+It is possible that you could have multiple migrations if you have previously published the migrations. 
+If this is the case, you will need to manually delete the migrations that were published before this update and republish the migrations.
+```php
+php artisan vendor:publish --tag=nova-ckeditor4-field-migrations
+```

config/ckeditor-field.php

@@ -26,6 +26,24 @@
         ],
     ],
 
+    /*
+    |--------------------------------------------------------------------------------
+    | Migrations
+    |--------------------------------------------------------------------------------
+    |
+    | This package comes with migrations to create the tables needed to store the attachments.
+    | If you have no need for migrations, you can disable them by setting `enable_migrations` to false
+    | If you want to disable the auto migration, set this option to false.
+    |
+    | If you disable the auto migration, you can publish the migrations and run them manually as followed:
+    | php artisan vendor:publish --tag=nova-ckeditor4-field-migrations
+    |
+    */
+    'migrations' => [
+        'enable_migrations' => true,
+        'auto_migrate' => true,
+    ],
+
     /*
     |--------------------------------------------------------------------------------
     | CKEditor Attachment Models
@@ -41,6 +59,7 @@
     'attachment_model' => \Waynestate\Nova\CKEditor4Field\Models\Attachment::class,
     'pending_attachment_model' => \Waynestate\Nova\CKEditor4Field\Models\PendingAttachment::class,
 
+
     /*
     |--------------------------------------------------------------------------------
     | CKEditor 4 Javascript URL

src/CKEditor4FieldServiceProvider.php

@@ -32,9 +32,7 @@ public function boot()
             __DIR__ . '/../config/ckeditor-field.php' => config_path('nova/ckeditor-field.php'),
         ], 'nova-ckeditor4-field-config');
 
-        $this->publishes([
-            __DIR__.'/../database/migrations/create_ckeditor_attachment_tables.php' => database_path('migrations/'.Carbon::now()->format('Y_m_d_His').'_create_ckeditor_attachment_tables.php'),
-        ], 'nova-ckeditor4-field-migrations');
+        $this->handleMigrations();
     }
 
     /**
@@ -62,4 +60,25 @@ public function register()
     {
         //
     }
+
+    /**
+     * Handle the migration strategy.
+     *
+     * @return void
+     */
+    protected function handleMigrations()
+    {
+        $migrations = config('nova.ckeditor-field.migrations', []);
+        if (empty($migrations['enable_migrations'])) {
+            return;
+        }
+
+        if (!empty($migrations['auto_migrate'])) {
+            $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
+        } else {
+            $this->publishes([
+                __DIR__ . '/../database/migrations' => database_path('migrations'),
+            ], 'nova-ckeditor4-field-migrations');
+        }
+    }
 }