active_record_migration_ui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 498bb67c6e2397910c46799ef954c689e9f6eb77a1c9e41416c2c043dddc51ea
+  data.tar.gz: 7c4e53766990419586895d6f534f1439ea6f66dae57135bb4b3c892f2547ec1f
+SHA512:
+  metadata.gz: 5cc8fbfb8636e13fd8817e29171ff6d5d5e8eb27dca5e34d2561ef15adf24191fedc1cc4b55d2e7b2a5bc82a66993d6bef64e32602700e95135f184674529ac8
+  data.tar.gz: d474a2ab12b5d4cf23daf691443932fd6fe5ff55a79026fb2ba27c11925e884698290d57dbaefc174e9b2b84c93e353f44c7b28dec74ac5b914184e90e63bb6d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# ActiveRecordMigrationUi
+
+This gem replaces the Rails default pending migration page with a small React
+app which allows you to run your migration scripts from your web browser.
+
+So before this gem you had this :
+
+![Rails default pending migration page](screenshots/rails-default-pending-migration-page.png)
+
+After having installed this gem you will have this :
+
+![ActiveRecord Migration UI page](screenshots/ar-migration-ui-page.png)
+
+![ActiveRecord Migration UI script logs](screenshots/ar-migration-ui-logs.png)
+
+## Usage
+
+The ActiveRecord Migration UI page will show up as soon as you installed the gem,
+restarted your server and have at least one pending migration script.
+
+Click the "Migrate now!" button to run the pending migration scripts.
+
+## Installation
+
+Add this gem where you want to it to be available.
+
+It is recommended to use it only on your environment machine, but you could also
+deploy it to your staging environment for instance.
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'active_record_migration_ui'
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_record_migration_ui
+```
+
+## Development
+
+1. Install [docker-sync](http://docker-sync.io): `gem install docker-sync`
+2. Build the Docker image: `docker-compose build webpack`
+3. Boot webpack: `docker-sync-stack start`
+  This step will fail with the error:
+  ```
+  error Command "webpack-dev-server" not found.
+  ```
+  _TODO : find a way to not have this error_
+4. Install NPM packages
+  ```
+  $ docker-compose run --rm -v armui-sync:/gem:nocopy webpack yarn
+  ```
+5. Restart again docker-sync: `docker-sync-stack start`
+
+Now you should see webpack running on port 3036.
+
+## Architecture
+
+We made an `ARCHITECURE.md` file in order to guide you through this gem's code.
+
+## Contributing
+
+1. Fork this gem
+2. Implement your new features
+3. [Clean your branch history](https://thoughtbot.com/blog/git-interactive-rebase-squash-amend-rewriting-history)
+4. Open a Merge Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Releasing a new version
+
+1. Run the `docker-sync-stack start` command (See [Development](#development)).
+2. Run `docker-compose run --rm -v armui-sync:/gem:nocopy webpack bash -c 'RAILS_ENV=production RAILS_MASTER_KEY=4d046dc285e33d0750e78d7effe25f3b rails build'`
+
+This will produce the gem in the `pkg/` folder.

data/Rakefile

@@ -0,0 +1,48 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordMigrationUi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+#
+# require 'rake/testtask'
+#
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << 'test'
+#   t.pattern = 'test/**/*_test.rb'
+#   t.verbose = false
+# end
+#
+# task default: :test
+
+#
+# Adds Webpacker tasks before rails build
+#
+def yarn_install_available?
+  puts "Rails::VERSION::MAJOR: #{Rails::VERSION::MAJOR.inspect}"
+  puts "Rails::VERSION::MINOR: #{Rails::VERSION::MINOR.inspect}"
+  rails_major = Rails::VERSION::MAJOR
+  rails_minor = Rails::VERSION::MINOR
+
+  rails_major > 5 || (rails_major == 5 && rails_minor >= 1)
+end
+
+Rake::Task['build'].enhance([
+  'app:active_record_migration_ui:webpacker:compile'
+])

data/app/channels/active_record_migration_ui/active_record_migration_ui_channel.rb

@@ -0,0 +1,11 @@
+module ActiveRecordMigrationUi
+  class ActiveRecordMigrationUiChannel < ApplicationCable::Channel
+    def subscribed
+      stream_from ActiveRecordMigrationUi.ac_channel_name
+    end
+
+    def migrate(data)
+      OrganiseMigratingScript.call(version: data['version'])
+    end
+  end
+end

data/app/channels/active_record_migration_ui/application_cable/channel.rb

@@ -0,0 +1,6 @@
+module ActiveRecordMigrationUi
+  module ApplicationCable
+    class Channel < ActionCable::Channel::Base
+    end
+  end
+end

data/app/channels/active_record_migration_ui/application_cable/connection.rb

@@ -0,0 +1,6 @@
+module ActiveRecordMigrationUi
+  module ApplicationCable
+    class Connection < ActionCable::Connection::Base
+    end
+  end
+end

data/app/controllers/active_record_migration_ui/application_controller.rb

@@ -0,0 +1,5 @@
+module ActiveRecordMigrationUi
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/active_record_migration_ui/migrations_controller.rb

@@ -0,0 +1,24 @@
+require_dependency 'active_record_migration_ui/application_controller'
+
+module ActiveRecordMigrationUi
+  class MigrationsController < ApplicationController
+    # Rack Middleware uses this method in order to run the index action.
+    def self.call(env)
+      action(:index).call(env)
+    end
+
+    def index
+      respond_to do |format|
+        format.html
+        format.json do
+          interactor = FindAllPendingMigrationScripts.call
+          if interactor.failure?
+            render json: interactor.errors, status: :unprocessable_entity
+          else
+            render json: interactor.scripts, status: :ok
+          end
+        end
+      end
+    end
+  end
+end

data/app/interactors/active_record_migration_ui/ensure_migration_version_is_included_in_pending_scripts.rb

@@ -0,0 +1,49 @@
+module ActiveRecordMigrationUi
+  class EnsureMigrationVersionIsIncludedInPendingScripts
+    include Interactor
+
+    def call
+      sanity_checks!
+
+      return if version_is_included_in_pending_scripts?
+
+      context.fail!(errors: {
+        version: 'was not found in pending migration script list'
+      })
+    end
+
+    private
+
+    def sanity_checks!
+      unless context.version
+        context.fail!(errors: { version: 'is missing' })
+      end
+
+      unless context.version =~ /\d+/
+        context.fail!(errors: {
+          version: 'is invalid (Expected numbers like 20180323142544).'
+        })
+      end
+
+      unless context.scripts
+        context.fail!(errors: { scripts: 'is missing' })
+      end
+
+      unless context.scripts.is_a?(Array)
+        context.fail!(errors: {
+          scripts: "must be an Array but it #{context.scripts.class.name}"
+        })
+      end
+
+      return unless context.scripts.size.zero?
+
+      context.fail!(errors: {
+        scripts: 'must contain migration scripts, but is empty'
+      })
+    end
+
+    def version_is_included_in_pending_scripts?
+      context.scripts.detect { |script| script[:version] == context.version }
+    end
+  end
+end

data/app/interactors/active_record_migration_ui/find_all_pending_migration_scripts.rb

@@ -0,0 +1,29 @@
+module ActiveRecordMigrationUi
+  class FindAllPendingMigrationScripts
+    include Interactor
+
+    def call
+      context.scripts = build_pending_scripts_list
+    end
+
+    private
+
+    def migrations_status
+      # This will ensure the `schema_migrations` table exists
+      ActiveRecord::SchemaMigration.create_table
+
+      ActiveRecord::Base.connection.migration_context.migrations_status
+    end
+
+    def build_pending_scripts_list
+      migrations_status.map do |status, version, name|
+        next unless status == 'down'
+
+        {
+          name: name,
+          version: version
+        }
+      end.compact
+    end
+  end
+end

data/app/interactors/active_record_migration_ui/migrate_migration_script.rb

@@ -0,0 +1,40 @@
+module ActiveRecordMigrationUi
+  class MigrateMigrationScript
+    include Interactor
+
+    def call
+      sanity_checks!
+
+      migration_paths = ActiveRecord::Migrator.migrations_paths
+      migration_context = ActiveRecord::MigrationContext.new(migration_paths)
+
+      # Lets the logger broadcasting the logs to the UI
+      ActiveRecordMigrationUi.running_migration = true
+
+      # In case something went wrong in the migration script, an exception is
+      # thrown
+      migration_context.migrate(context.version.to_i)
+
+      # Preents the logger to broadcast the logs to the UI
+      ActiveRecordMigrationUi.running_migration = false
+
+      context.final_state = 'up'
+    rescue StandardError
+      context.final_state = 'failed'
+    end
+
+    private
+
+    def sanity_checks!
+      unless context.version
+        context.fail!(errors: { version: 'is missing' })
+      end
+
+      return if context.version =~ /\d+/
+
+      context.fail!(errors: {
+        version: 'is invalid (Expected numbers like 20180323142544).'
+      })
+    end
+  end
+end

data/app/interactors/active_record_migration_ui/notify_migration_script_as_done_or_fail.rb

@@ -0,0 +1,34 @@
+module ActiveRecordMigrationUi
+  class NotifyMigrationScriptAsDoneOrFail
+    include Interactor
+
+    def call
+      sanity_checks!
+
+      # Emit a message through the WebSocket to notify the front that the given
+      # migration script version changes the state to the given final_state.
+      ActionCable.server.broadcast ActiveRecordMigrationUi.ac_channel_name,
+                                   command: 'migrate',
+                                   version: context.version,
+                                   new_status: context.final_state
+    end
+
+    private
+
+    def sanity_checks!
+      unless context.version
+        context.fail!(errors: { version: 'is missing' })
+      end
+
+      unless context.version =~ /\d+/
+        context.fail!(errors: {
+          version: 'is invalid (Expected numbers like 20180323142544).'
+        })
+      end
+
+      return if context.final_state
+
+      context.fail!(errors: { final_state: 'is missing' })
+    end
+  end
+end

data/app/interactors/active_record_migration_ui/notify_migration_script_as_running.rb

@@ -0,0 +1,31 @@
+module ActiveRecordMigrationUi
+  class NotifyMigrationScriptAsRunning
+    include Interactor
+
+    def call
+      sanity_checks!
+
+      # Emit a message through the WebSocket to notify the front that the given
+      # migration script version changes the state to running, which will show
+      # a loader next to the migration script.
+      ActionCable.server.broadcast ActiveRecordMigrationUi.ac_channel_name,
+                                   command: 'migrate',
+                                   version: context.version,
+                                   new_status: 'running'
+    end
+
+    private
+
+    def sanity_checks!
+      unless context.version
+        context.fail!(errors: { version: 'is missing' })
+      end
+
+      return if context.version =~ /\d+/
+
+      context.fail!(errors: {
+        version: 'is invalid (Expected numbers like 20180323142544).'
+      })
+    end
+  end
+end

data/app/interactors/active_record_migration_ui/organise_migrating_script.rb

@@ -0,0 +1,11 @@
+module ActiveRecordMigrationUi
+  class OrganiseMigratingScript
+    include Interactor::Organizer
+
+    organize FindAllPendingMigrationScripts,
+             EnsureMigrationVersionIsIncludedInPendingScripts,
+             NotifyMigrationScriptAsRunning,
+             MigrateMigrationScript,
+             NotifyMigrationScriptAsDoneOrFail
+  end
+end

data/app/views/layouts/active_record_migration_ui/application.html.erb

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html class="h-100">
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>ActiveRecord Migration Ui</title>
+    <% if ActiveRecordMigrationUi.configuration.webpacker_host %>
+      <%= javascript_pack_tag 'application', host: ActiveRecordMigrationUi.configuration.webpacker_host %>
+    <% end %>
+
+    <%= action_cable_meta_tag %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body class="h-100">
+    <div id="app" class="h-100" />
+
+    <!--- Avoids using webpacker helpers so that you can use this gem without
+          webpack allowing to use it in previous Rails versions --->
+    <script type="text/javascript">
+      fetch('/ar-migration-ui-packs/manifest.json')
+        .then(response => response.json())
+        .then(json => [json['application.js'], json['application.css']])
+        .then(([jsPath, cssPath]) => {
+          // Equivalent to stylesheet_pack_tag 'application'
+          let link = document.createElement('link')
+          link.rel = 'stylesheet'
+          link.href = cssPath
+          document.head.appendChild(link)
+
+          // Equivalent to javascript_pack_tag 'application'
+          let script = document.createElement('script')
+          script.src = jsPath
+          document.head.appendChild(script)
+        })
+    </script>
+  </body>
+</html>