migration_revert 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marc-Andre Lafortune
+
+MIT License
+
+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,66 @@
+# MigrationRevert
+
+Reversible migrations are very cool.
+
+Some commands are not reversible, for example the removal of a table or a column.
+
+Also, one downside is that it is now more difficult to write the reverse of a migration if `change` is used. When `up` and `down` were used, one could simply swap the code around.
+
+These commits introduce `Migration#revert` that makes it trivial to revert a past migration, in part or in whole, or do the doing a reversible removal of a table/column.
+
+Note that `revert` can even be called from legacy migrations using `up` & `down` and that it can revert legacy-style migrations too. For anyone changing their mind every second day, `revert` is fully nestable.
+
+To have complete revertible capability, I would like to introduce a modified syntax for `change_column` that would allow it to be revertible; pull request upcoming when I get a chance...
+
+## Usage
+
+Reverses the migration commands for the given block and
+the given migrations.
+
+The following migration will remove the table 'horses'
+and create the table 'apples' on the way up, and the reverse
+on the way down.
+
+This command can be nested.
+
+    class FixTLMigration < ActiveRecord::Migration
+      def change
+        revert do
+          create_table(:horses) do |t|
+            t.text :content
+            t.datetime :remind_at
+          end
+        end
+        create_table(:apples) do |t|
+          t.string :variety
+        end
+      end
+    end
+
+Or equivalently, if +TenderloveMigration+ is defined as in the
+documentation for Migration:
+
+    class FixupTLMigration < ActiveRecord::Migration
+      def change
+        revert TenderloveMigration
+
+        create_table(:apples) do |t|
+          t.string :variety
+        end
+      end
+    end
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'migration_revert'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install migration_revert

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/migration_revert.rb

@@ -0,0 +1,6 @@
+require "migration_revert/version"
+
+unless ActiveRecord::Migration::CommandRecorder.method_defined? :revert
+  require "migration_revert/ext/migration"
+  require "migration_revert/ext/command_recorder"
+end

data/lib/migration_revert/ext/command_recorder.rb

@@ -0,0 +1,52 @@
+module ActiveRecord
+  class Migration
+    class CommandRecorder
+      def revert
+        @reverting = !@reverting
+        previous = @commands
+        @commands = []
+        yield
+      ensure
+        @commands = previous.concat(@commands.reverse)
+        @reverting = !@reverting
+      end
+
+      # record +command+. +command+ should be a method name and arguments.
+      # For example:
+      #
+      #   recorder.record(:method_name, [:arg1, :arg2])
+      #
+      def record(*command, &block)
+        if @reverting
+          @commands << inverse_of(*command)
+        else
+          @commands << (command << block)
+        end
+      end
+
+      [:create_table, :create_join_table, :change_table, :rename_table, :add_column, :remove_column, :rename_index, :rename_column, :add_index, :remove_index, :add_timestamps, :remove_timestamps, :change_column, :change_column_default, :add_reference, :remove_reference].each do |method|
+        class_eval <<-EOV, __FILE__, __LINE__ + 1
+          def #{method}(*args, &block)          # def create_table(*args, &block)
+            record(:"#{method}", args, &block)  #   record(:create_table, args, &block)
+          end                                   # end
+        EOV
+      end
+      alias :add_belongs_to :add_reference
+      alias :remove_belongs_to :remove_reference
+
+      # Returns the inverse of the given command
+      #
+      #   recorder.inverse_of(:rename_table, [:old, :new])
+      #    # => [:rename_table, [:new, :old]]
+      #
+      # This method will raise an +IrreversibleMigration+ exception if it cannot
+      # invert the +commands+.
+      #
+      def inverse_of(name, args)
+        method = :"invert_#{name}"
+        raise IrreversibleMigration unless respond_to?(method, true)
+        send(method, args)
+      end
+    end
+  end
+end

data/lib/migration_revert/ext/migration.rb

@@ -0,0 +1,118 @@
+module ActiveRecord
+  class Migration
+    # Reverses the migration commands for the given block and
+    # the given migrations.
+    #
+    # The following migration will remove the table 'horses'
+    # and create the table 'apples' on the way up, and the reverse
+    # on the way down.
+    #
+    # This command can be nested.
+    #
+    #   class FixTLMigration < ActiveRecord::Migration
+    #     def change
+    #       revert do
+    #         create_table(:horses) do |t|
+    #           t.text :content
+    #           t.datetime :remind_at
+    #         end
+    #       end
+    #       create_table(:apples) do |t|
+    #         t.string :variety
+    #       end
+    #     end
+    #   end
+    #
+    # Or equivalently, if +TenderloveMigration+ is defined as in the
+    # documentation for Migration:
+    #
+    #   class FixupTLMigration < ActiveRecord::Migration
+    #     def change
+    #       revert TenderloveMigration
+    #
+    #       create_table(:apples) do |t|
+    #         t.string :variety
+    #       end
+    #     end
+    #   end
+    #
+    def revert(*migration_classes)
+      run(*migration_classes.reverse, :revert => true) unless migration_classes.empty?
+      if block_given?
+        if @connection.respond_to? :revert
+          @connection.revert { yield }
+        else
+          recorder = CommandRecorder.new(@connection)
+          @connection = recorder
+          suppress_messages do
+            @connection.revert { yield }
+          end
+          @connection = recorder.delegate
+          recorder.commands.each do |cmd, args, block|
+            send(cmd, *args, &block)
+          end
+        end
+      end
+    end
+
+    def reverting?
+      @connection.respond_to?(:reverting) && @connection.reverting
+    end
+
+    # Runs the given migration classes.
+    # Last argument can specify options:
+    # - :direction (default is :up)
+    # - :revert (default is false)
+    #
+    def run(*migration_classes)
+      opts = migration_classes.extract_options!
+      dir = opts[:direction] || :up
+      dir = (dir == :down ? :up : :down) if opts[:revert]
+      if reverting?
+        # If in revert and going :up, say, we want to execute :down without reverting, so
+        revert { run(*migration_classes, direction: dir, revert: true) }
+      else
+        migration_classes.each do |migration_class|
+          migration_class.new.exec_migration(@connection, dir)
+        end
+      end
+    end
+
+    # Execute this migration in the named direction
+    def migrate(direction)
+      return unless respond_to?(direction)
+
+      case direction
+      when :up   then announce "migrating"
+      when :down then announce "reverting"
+      end
+
+      time   = nil
+      ActiveRecord::Base.connection_pool.with_connection do |conn|
+        time = Benchmark.measure do
+          exec_migration(conn, direction)
+        end
+      end
+
+      case direction
+      when :up   then announce "migrated (%.4fs)" % time.real; write
+      when :down then announce "reverted (%.4fs)" % time.real; write
+      end
+    end
+
+    def exec_migration(conn, direction)
+      @connection = conn
+      if respond_to?(:change)
+        if direction == :down
+          revert { change }
+        else
+          change
+        end
+      else
+        send(direction)
+      end
+    ensure
+      @connection = nil
+    end
+  end
+end

data/lib/migration_revert/version.rb

@@ -0,0 +1,3 @@
+module MigrationRevert
+  VERSION = "1.0.0"
+end

data/migration_revert.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/migration_revert/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marc-Andre Lafortune"]
+  gem.email         = ["github@marc-andre.ca"]
+  gem.description   = %q{Revert ActiveRecord migrations}
+  gem.summary       = %q{Revert ActiveRecord migrations in part or in whole}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "migration_revert"
+  gem.require_paths = ["lib"]
+  gem.version       = MigrationRevert::VERSION
+  gem.add_runtime_dependency('activerecord', [">= 3.1.0"])
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: migration_revert
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Marc-Andre Lafortune
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Revert ActiveRecord migrations
+email:
+- github@marc-andre.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/migration_revert.rb
+- lib/migration_revert/ext/command_recorder.rb
+- lib/migration_revert/ext/migration.rb
+- lib/migration_revert/version.rb
+- migration_revert.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Revert ActiveRecord migrations in part or in whole
+test_files: []
+has_rdoc: