migration_revert 1.0.0 → 1.1.0

data/README.md

@@ -6,14 +6,20 @@ 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.
+This gem introduces `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...
+Sounds useful? Give a +1 to https://github.com/rails/rails/pull/7627
+
+Also introduces `Migration#reversible` for data operations that can be reverted.
+
+Sounds useful also? Give a +1 to https://github.com/rails/rails/pull/8177
 
 ## Usage
 
+### revert
+
 Reverses the migration commands for the given block and
 the given migrations.
 
@@ -21,8 +27,6 @@ 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
@@ -37,7 +41,7 @@ This command can be nested.
       end
     end
 
-Or equivalently, if +TenderloveMigration+ is defined as in the
+Or equivalently, if `TenderloveMigration` is defined as in the
 documentation for Migration:
 
     class FixupTLMigration < ActiveRecord::Migration
@@ -50,6 +54,36 @@ documentation for Migration:
       end
     end
 
+This command can be nested.
+
+### reversible
+
+Used to specify an operation that can be run in one direction or another.
+Call the methods +up+ and +down+ of the yielded object to run a block
+only in one given direction.
+The whole block will be called in the right order within the migration.
+
+In the following example, the looping on users will always be done
+when the three columns 'first_name', 'last_name' and 'full_name' exist,
+even when migrating down:
+
+    class SplitNameMigration < ActiveRecord::Migration
+      def change
+        add_column :users, :first_name, :string
+        add_column :users, :last_name, :string
+
+        reversible do |dir|
+          User.reset_column_information
+          User.all.each do |u|
+            dir.up   { u.first_name, u.last_name = u.full_name.split(' ') }
+            dir.down { u.full_name = "#{u.first_name} #{u.last_name}" }
+            u.save
+          end
+        end
+
+        revert { add_column :users, :full_name, :string }
+      end
+    end
 
 ## Installation
 

data/lib/migration_revert/ext/command_recorder.rb

@@ -18,13 +18,26 @@ module ActiveRecord
       #
       def record(*command, &block)
         if @reverting
-          @commands << inverse_of(*command)
+          @commands << inverse_of(*command, &block)
         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|
+      # 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(command, args, &block)
+        method = :"invert_#{command}"
+        raise IrreversibleMigration unless respond_to?(method, true)
+        send(method, args, &block)
+      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, :transaction].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)
@@ -34,18 +47,10 @@ module ActiveRecord
       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)
+      private
+
+      def invert_transaction(args, &block)
+        [:transaction, args, block]
       end
     end
   end

data/lib/migration_revert/ext/migration.rb

@@ -7,8 +7,6 @@ module ActiveRecord
     # 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
@@ -36,6 +34,8 @@ module ActiveRecord
     #     end
     #   end
     #
+    # This command can be nested.
+    #
     def revert(*migration_classes)
       run(*migration_classes.reverse, :revert => true) unless migration_classes.empty?
       if block_given?
@@ -59,6 +59,46 @@ module ActiveRecord
       @connection.respond_to?(:reverting) && @connection.reverting
     end
 
+    class ReversibleBlockHelper < Struct.new(:reverting)
+      def up
+        yield unless reverting
+      end
+
+      def down
+        yield if reverting
+      end
+    end
+
+    # Used to specify an operation that can be run in one direction or another.
+    # Call the methods +up+ and +down+ of the yielded object to run a block
+    # only in one given direction.
+    # The whole block will be called in the right order within the migration.
+    # In the following example, the looping on users will always be done
+    # when the three columns 'first_name', 'last_name' and 'full_name' exist,
+    # even when migrating down:
+    #
+    #    class SplitName < ActiveRecord::Migration
+    #      def change
+    #        add_column :users, :first_name, :string
+    #        add_column :users, :last_name, :string
+    #
+    #        reversible do |dir|
+    #          User.reset_column_information
+    #          User.all.each do |u|
+    #            dir.up   { u.first_name, u.last_name = u.full_name.split(' ') }
+    #            dir.down { u.full_name = "#{u.first_name} #{u.last_name}" }
+    #            u.save
+    #          end
+    #        end
+    #
+    #        revert { add_column :users, :full_name, :string }
+    #      end
+    #    end
+    def reversible
+      helper = ReversibleBlockHelper.new(reverting?)
+      transaction{ yield helper }
+    end
+
     # Runs the given migration classes.
     # Last argument can specify options:
     # - :direction (default is :up)

data/lib/migration_revert/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: migration_revert
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-07 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord