lazy_migrate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb0ab56b35f054e0c36cfa34b6833f9ff08e06010369b5014ae0ae16e0f25b77
+  data.tar.gz: f9a007bbf94a7f522d33cd8b62838f6aa23fb32af6e93ccfba7ea0f7919cac80
+SHA512:
+  metadata.gz: adf695d57368567d9ce1641bb49d806dff313f764eb6085c153a4ea616b5f8bc253e96899c1ff6589418bc0b4d6011bafa05814d3796f96ed4ebb63ad3f2a844
+  data.tar.gz: 167c264d4a7324af4e7481ab48fe364d0095f015d702a2065f90a02899235bd20c9f0df876dcb7b3320de6af0eee3117d2adaa7c10d262cdcdc2d89a39c7de5e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lazy_migrate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    lazy_migrate (0.1.0)
+      tty-prompt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    tty-color (0.5.1)
+    tty-cursor (0.7.1)
+    tty-prompt (0.22.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.8.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  lazy_migrate!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jesse Duffield
+
+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,39 @@
+# LazyMigrate
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lazy_migrate`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lazy_migrate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy_migrate
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lazy_migrate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require './lib/lazy_migrate'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :run do
+  LazyMigrate.run
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lazy_migrate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/exe/lazy_migrate

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'lazy_migrate'
+LazyMigrate.run

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lazy_migrate.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lazy_migrate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lazy_migrate"
+  spec.version       = LazyMigrate::VERSION
+  spec.authors       = ["Jesse Duffield"]
+  spec.email         = ["jessedduffield@gmail.com"]
+
+  spec.summary       = 'A little terminal UI for managing schema migrations'
+  spec.description   = 'lazy_migrate lets you easily see which migrations have and have not been run, and makes it easy to up/down/migrate/rollback your migrations through a terminal UI. You can even bump migration versions in the event that you\'ve just pulled master and somebody else merged their migration before yours.'
+  spec.homepage      = "https://github.com/jesseduffield/lazy_migrate"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.22.0'
+end

data/lib/lazy_migrate.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "lazy_migrate/version"
+require "lazy_migrate/migrator"
+
+module LazyMigrate
+  def self.run
+    Migrator.run
+  end
+end

data/lib/lazy_migrate/migrator.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+require 'active_record'
+require 'rails'
+
+module LazyMigrate
+  class Migrator
+    class << self
+      MIGRATE = 'migrate'
+      ROLLBACK = 'rollback'
+      UP = 'up'
+      DOWN = 'down'
+      REDO = 'redo'
+      BRING_TO_TOP = 'bring to top'
+
+      def run
+        loop do
+          catch(:done) do
+            on_done = -> { throw :done }
+
+            load_migration_paths
+            migrations = find_migrations
+
+            prompt = TTY::Prompt.new(active_color: :bright_green)
+            prompt.ok("\nDatabase: #{ActiveRecord::Base.connection_config[:database]}\n")
+
+            select_migration_prompt(prompt: prompt, migrations: migrations, on_done: on_done)
+          end
+        end
+      rescue TTY::Reader::InputInterrupt
+        puts
+      end
+
+      private
+
+      def select_migration_prompt(prompt:, migrations:, on_done:)
+        prompt.select('Pick a migration') do |menu|
+          migrations.each { |migration|
+            name = render_migration_option(migration)
+
+            menu.choice(
+              name,
+              -> {
+                select_action_prompt(
+                  on_done: on_done,
+                  prompt: prompt,
+                  context: context,
+                  migration: migration,
+                )
+              }
+            )
+          }
+        end
+      end
+
+      def select_action_prompt(on_done:, context:, prompt:, migration:)
+        if !migration[:has_file]
+          prompt.error("\nMigration file not found for migration #{migration[:version]}")
+          prompt_any_key(prompt)
+          on_done.()
+        end
+
+        option_map = obtain_option_map(context: context)
+
+        prompt.select("\nWhat would you like to do for #{migration[:version]} #{name}?") do |inner_menu|
+          options_for_migration(status: migration[:status]).each do |option|
+            inner_menu.choice(option, -> {
+              with_unsafe_error_capture do
+                option_map[option].(migration)
+              end
+              prompt_any_key(prompt)
+              on_done.()
+            })
+          end
+
+          inner_menu.choice('cancel', on_done)
+        end
+      end
+
+      def options_for_migration(status:)
+        common_options = [MIGRATE, ROLLBACK, BRING_TO_TOP]
+        specific_options = if status == 'up'
+          [DOWN, REDO]
+        else
+          [UP]
+        end
+        specific_options + common_options
+      end
+
+      def obtain_option_map(context:)
+        {
+          UP => ->(migration) { context.run(:up, migration[:version]) },
+          DOWN => ->(migration) { context.run(:down, migration[:version]) },
+          REDO => ->(migration) {
+            context.run(:down, migration[:version])
+            context.run(:up, migration[:version])
+          },
+          MIGRATE => ->(migration) { context.up(migration[:version]) },
+          ROLLBACK => ->(migration) {
+            # for some reason in https://github.com/rails/rails/blob/5-2-stable/activerecord/lib/active_record/migration.rb#L1221
+            # we stop before the selected version. I have no idea why.
+            # I could override the logic here but it wouldn't
+            # work when trying to rollback the final migration.
+            context.down(migration[:version])
+          },
+          BRING_TO_TOP => ->(migration) { bring_to_top(migration) },
+        }
+      end
+
+      def load_migration_paths
+        ActiveRecord::Migrator.migrations_paths.each do |path|
+          Dir[Rails.application.root.join("#{path}/**/*.rb")].each { |file| load file }
+        end
+      end
+
+      def find_migrations
+        context.migrations_status
+          .reverse
+          .map { |status, version, name|
+            # This depends on how rails reports a file is missing.
+            # This is no doubt subject to change so be wary.
+            has_file = name != '********** NO FILE **********'
+
+            { status: status, version: version.to_i, name: name, has_file: has_file }
+          }
+      end
+
+      def render_migration_option(migration)
+        "#{migration[:status].ljust(6)}#{migration[:version].to_s.ljust(16)}#{migration[:name].ljust(50)}"
+      end
+
+      # bring_to_top updates the version of a migration to bring it to the top of the
+      # migration list. If the migration had already been up'd it will mark the
+      # new migration file as upped as well. The former version number will be
+      # removed from the schema_migrations table.
+      def bring_to_top(migration)
+        filename = context.migrations.find { |m| m.version == migration[:version] }&.filename
+
+        if filename.nil?
+          raise("No file found for migration #{migration[:version]}")
+        end
+
+        last = last_version
+        new_version = ActiveRecord::Migration.next_migration_number(last ? last + 1 : 0)
+
+        # replace the version
+        basename = File.basename(filename)
+        dir = File.dirname(filename)
+        new_basename = "#{new_version}_#{basename.split('_')[1..].join('_')}"
+        new_filename = File.join(dir, new_basename)
+
+        File.rename(filename, new_filename)
+
+        if migration[:status] == 'up'
+          ActiveRecord::SchemaMigration.create(version: new_version)
+        end
+
+        ActiveRecord::SchemaMigration.find_by(version: migration[:version])&.destroy!
+      end
+
+      def last_version
+        context.migrations.last&.version
+      end
+
+      def prompt_any_key(prompt)
+        prompt.keypress("\nPress any key to continue")
+      end
+
+      def with_unsafe_error_capture
+        yield
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        # I am aware you should not rescue 'Exception' exceptions but I think this is is an 'exceptional' use case
+        puts "\n#{e.class}: #{e.message}\n#{e.backtrace.take(5).join("\n")}"
+      end
+
+      def context
+        ActiveRecord::MigrationContext.new(Rails.root.join('db', 'migrate'))
+      end
+    end
+  end
+
+  def self.run
+    Migrator.show
+  end
+end

data/lib/lazy_migrate/version.rb

@@ -0,0 +1,3 @@
+module LazyMigrate
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: lazy_migrate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jesse Duffield
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description: lazy_migrate lets you easily see which migrations have and have not been
+  run, and makes it easy to up/down/migrate/rollback your migrations through a terminal
+  UI. You can even bump migration versions in the event that you've just pulled master
+  and somebody else merged their migration before yours.
+email:
+- jessedduffield@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/exe/lazy_migrate
+- bin/setup
+- lazy_migrate.gemspec
+- lib/lazy_migrate.rb
+- lib/lazy_migrate/migrator.rb
+- lib/lazy_migrate/version.rb
+homepage: https://github.com/jesseduffield/lazy_migrate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jesseduffield/lazy_migrate
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A little terminal UI for managing schema migrations
+test_files: []