migrate_safely 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2494a037e7a7b6bd5e25eeec717e15dbed6083a
+  data.tar.gz: 3a6898bdaa9e22e98da53d5baa27de6ac6648578
+SHA512:
+  metadata.gz: 76c71a3e53de068869a0fdeea418d76cf7923f392bd57b4109e221e1ed0da890fa183c4c56b3f09e5722b2d8e8b87c835799506cecde9a51eeffe74ed8363e90
+  data.tar.gz: 663f28a1a7fbc96d337cf2462da43fd83c1d869cb8d2d56dbd5ffdbf00360cc22cf786825ca339f5a6c41c0095fe5c2a303ec299512dd6715f8ec4217d8b0e17

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Remind
+
+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,40 @@
+MigrateSafely
+=============
+
+MigrateSafely is a [railtie](http://api.rubyonrails.org/classes/Rails/Railtie.html) that
+adds a confirmation prompt to the `rake db:migrate` command to prevent accidental migrations/rollbacks.
+
+Example:
+
+    $ rake db:migrate
+
+    database: my_database
+
+    Action   Migration ID    Migration Name
+    --------------------------------------------------
+    apply    20150916005809  Migration1
+    apply    20150917011452  Migration2
+
+    Are you sure you want to proceed? [y/n]:
+
+Accidental rollback prevention:
+
+    $ VERSION=foo20150917011452 rake db:migrate      # notice the typo in VERSION
+
+    database: my_database
+
+    Action   Migration ID    Migration Name
+    --------------------------------------------------
+    revert   20150914175134  Migration100
+    revert   20150902002737  Migration099
+    revert   20150901221908  Migration098
+    revert   20150901171434  Migration097
+    revert   20150831194113  Migration096
+    ...
+    revert   20150101004705  Migration001
+
+    Are you sure you want to proceed? [y/n]:
+
+## License
+
+[MIT License](LICENSE)

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/migrate_safely.rb

@@ -0,0 +1,5 @@
+module MigrateSafely
+end
+
+require 'migrate_safely/migration_outliner'
+require 'migrate_safely/railtie' if defined?(Rails)

data/lib/migrate_safely/migration_outliner.rb

@@ -0,0 +1,27 @@
+module MigrateSafely
+  class MigrationOutliner
+    Action = Struct.new(:version, :action, :name)
+
+    def self.pending_actions(target_version = nil)
+      current_version = ActiveRecord::Migrator.current_version
+      return [] if current_version == 0 && target_version == 0
+
+      direction = case
+      when target_version.nil?
+        :up
+      when current_version > target_version
+        :down
+      else
+        :up
+      end
+
+      migrations = ActiveRecord::Migrator.migrations(ActiveRecord::Migrator.migrations_paths)
+      runnable_migrations = ActiveRecord::Migrator.new(direction, migrations, target_version).runnable
+      action = direction == :up ? "apply" : "revert"
+
+      runnable_migrations.map do |m|
+        Action.new(m.version, action, m.name)
+      end
+    end
+  end
+end

data/lib/migrate_safely/railtie.rb

@@ -0,0 +1,7 @@
+module MigrateSafely
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "migrate_safely/tasks/migrate_safely.rake"
+    end
+  end
+end

data/lib/migrate_safely/tasks/migrate_safely.rake

@@ -0,0 +1,28 @@
+namespace :migrate_safely do
+  task :outline => :environment do
+    require 'migrate_safely/migration_outliner'
+
+    version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil # to_i is intentional, replicates ActiveRecord behavior
+    actions = MigrateSafely::MigrationOutliner.pending_actions(version)
+
+    unless actions.any?
+      abort "There are no migrations to be applied or reverted"
+    end
+
+    puts "\ndatabase: #{ActiveRecord::Base.connection_config[:database]}\n\n"
+    puts "#{'Action'.center(8)}  #{'Migration ID'.ljust(14)}  Migration Name"
+    puts "-" * 50
+    actions.each do |action|
+      puts "#{action.action.center(8)}  #{action.version.to_s.ljust(14)}  #{action.name}"
+    end
+    puts
+  end
+
+  task :confirm do
+    print "Are you sure you want to proceed? [y/n]: "
+    input = STDIN.gets.chomp
+    abort "Aborting" unless  %w(y yes yeah).include?(input.downcase)
+  end
+end
+
+Rake::Task["db:migrate"].enhance ["migrate_safely:outline", "migrate_safely:confirm"]

data/lib/migrate_safely/version.rb

@@ -0,0 +1,3 @@
+module MigrateSafely
+  VERSION = "0.0.1"
+end

data/test/fixtures/migrations/20150918000000_test_migration_1.rb

@@ -0,0 +1,9 @@
+class TestMigration1 < ActiveRecord::Migration
+  def self.up
+    puts "test migration1 applied"
+  end
+
+  def self.down
+    puts "test migration1 reverted"
+  end
+end

data/test/fixtures/migrations/20150918000001_test_migration_2.rb

@@ -0,0 +1,10 @@
+class TestMigration2 < ActiveRecord::Migration
+  def self.up
+    puts "test migration2 applied"
+  end
+
+  def self.down
+    puts "test migration2 reverted"
+  end
+end
+

data/test/fixtures/migrations/20150918000002_test_migration_3.rb

@@ -0,0 +1,11 @@
+class TestMigration3 < ActiveRecord::Migration
+  def self.up
+    puts "test migration3 applied"
+  end
+
+  def self.down
+    puts "test migration3 reverted"
+  end
+end
+
+

data/test/migrate_safely_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class MigrateSafelyTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, MigrateSafely
+  end
+end

data/test/migration_outliner_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+module MigrateSafely
+  class MigrationOutlinerTest < ActiveSupport::TestCase
+    setup do
+      ActiveRecord::Base.connection.begin_transaction(joinable: false)
+    end
+
+    teardown do
+      if ActiveRecord::Base.connection.transaction_open?
+        ActiveRecord::Base.connection.rollback_transaction
+      end
+    end
+
+    test "lists all pending migrations when version is not specified" do
+      pending_actions = MigrationOutliner.pending_actions
+      assert_equal [
+        MigrationOutliner::Action.new(20150918000000, "apply", "TestMigration1"),
+        MigrationOutliner::Action.new(20150918000001, "apply", "TestMigration2"),
+        MigrationOutliner::Action.new(20150918000002, "apply", "TestMigration3")
+      ], pending_actions
+    end
+
+    test "says will apply migrations up to version (inclusive) when the version is newer than current" do
+      pending_actions = MigrationOutliner.pending_actions(20150918000001)
+      assert_equal [
+        MigrationOutliner::Action.new(20150918000000, "apply", "TestMigration1"),
+        MigrationOutliner::Action.new(20150918000001, "apply", "TestMigration2")
+      ], pending_actions
+    end
+
+    test "says will revert migrations that are newer than version (not inclusive) when version is older than current" do
+      ActiveRecord::SchemaMigration.create!(version: "20150918000000")
+      ActiveRecord::SchemaMigration.create!(version: "20150918000001")
+
+      pending_actions = MigrationOutliner.pending_actions(20150918000000)
+      assert_equal [
+        MigrationOutliner::Action.new(20150918000001, "revert", "TestMigration2")
+      ], pending_actions
+    end
+
+    test "returns an empty list of actions if the version is equal to current" do
+      current_version = 20150918000000
+      ActiveRecord::SchemaMigration.create!(version: current_version.to_s)
+
+      pending_actions = MigrationOutliner.pending_actions(current_version)
+      assert_equal [], pending_actions
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+FIXTURES_ROOT = File.expand_path("../fixtures", __FILE__)
+
+require 'active_record'
+require 'active_support/testing/autorun'
+require 'active_support/test_case'
+require 'migrate_safely'
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: File.join(FIXTURES_ROOT, "db.sqlite3"),
+  pool: 1,
+  timeout: 5000
+)
+ActiveRecord::Migrator.migrations_paths = [File.join(FIXTURES_ROOT, "migrations")]

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: migrate_safely
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vlad Yarotsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds a confirmation prompt to rake db:migrate; Lists migrations to be
+  applied/reverted before proceeding.
+email:
+- vlad@remind101.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/migrate_safely.rb
+- lib/migrate_safely/migration_outliner.rb
+- lib/migrate_safely/railtie.rb
+- lib/migrate_safely/tasks/migrate_safely.rake
+- lib/migrate_safely/version.rb
+- test/fixtures/db.sqlite3
+- test/fixtures/migrations/20150918000000_test_migration_1.rb
+- test/fixtures/migrations/20150918000001_test_migration_2.rb
+- test/fixtures/migrations/20150918000002_test_migration_3.rb
+- test/migrate_safely_test.rb
+- test/migration_outliner_test.rb
+- test/test_helper.rb
+homepage: 
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Adds a confirmation prompt to rake db:migrate
+test_files:
+- test/fixtures/db.sqlite3
+- test/fixtures/migrations/20150918000000_test_migration_1.rb
+- test/fixtures/migrations/20150918000001_test_migration_2.rb
+- test/fixtures/migrations/20150918000002_test_migration_3.rb
+- test/migrate_safely_test.rb
+- test/migration_outliner_test.rb
+- test/test_helper.rb