reversible_data_migration 0.1.1

data/.gitignore

@@ -0,0 +1,4 @@
+db
+.test.db
+gem*
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    reversible_data_migration (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    diff-lcs (1.1.3)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sqlite3 (1.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.3.14)
+  reversible_data_migration!
+  rspec
+  sqlite3

data/Manifest

@@ -0,0 +1,4 @@
+README.rdoc
+Rakefile
+lib/reversable_data_migration.rb
+Manifest

data/README.md

@@ -0,0 +1,27 @@
+# Reversible Data Migration
+
+Need to update a small amount of data in migration? But still want to make it reversable? Reversable Data Migration comes to the rescue.
+
+## Example usage
+
+```ruby
+class RemoveStateFromProduct < ActiveRecord::Migration
+  def self.up
+    backup_data = []
+    Product.all.each do |product|
+      backup_data << {:id => product.id, :state => product.state}
+    end
+    backup backup_data
+    remove_column :products, :state
+  end
+  def self.down
+    add_column :products, :state, :string
+    restore Product
+  end
+end
+```
+## Installing
+
+    gem install reversible_data_migration
+
+## Rails 2 & 3 supported

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/reversible_data_migration.rb

@@ -0,0 +1,94 @@
+module ReversibleDataMigration
+
+  def location_backup_files
+    "#{(Rails.version =~ /^2/) ? RAILS_ROOT : Rails.root.to_s}/db/migrate/backup_data"
+  end
+  
+  def default_backupfile
+    "#{location_backup_files}/#{name.underscore}.yml" # name.underscore => name of migration 
+  end
+  
+  def full_path_of file
+    "#{location_backup_files}/#{file}.yml"
+  end
+  
+  def default_or_specific_file file
+    if file
+      full_path_of file
+    else
+      default_backupfile
+    end
+  end
+  
+  def backup data, file=nil
+    unless File.directory?(location_backup_files)
+      FileUtils.mkdir_p(location_backup_files)
+    end
+    file = default_or_specific_file(file)
+    puts "-- writing backup data (#{data.count} records) to #{file}"
+    File.open( file , 'w' ) do |out|
+      YAML.dump( data, out ) 
+    end
+  end
+  
+  def destroy_created_records klass, file=nil
+    file = default_or_specific_file(file)
+    test_record = first_record(file)
+    process_records(klass, file){ |object, object_hash| object.destroy }
+    raise "Destroying objects failed" if test_record.blank? || test_record[:id].blank? || klass.find_by_id(test_record[:id]) 
+  end
+  
+  def restore klass, file=nil
+    file = default_or_specific_file(file)
+    test_record = first_record file
+    puts "-- restore data from #{file}"
+    process_records(klass,file) do |object, object_hash|
+      object_hash.select{|k,v| k != :id}.each do |key, value|
+        object.send("#{key}=", value)
+      end
+      object.save
+    end
+  end
+
+  def restore_batch
+    @transaction = true
+    @to_delete_after_transaction = []
+    yield
+    @to_delete_after_transaction.each do |file|
+      delete_file(file) 
+    end
+  end  
+    
+  private
+  
+  def process_records klass, file
+    count = 0
+    File.open( file ) { |yf| YAML::load( yf ) }.each do |object_hash|
+      object = klass.find object_hash[:id]
+      yield object, object_hash
+      count += 1
+    end
+    puts "-- processed #{count} records"
+    unless @transaction
+      delete_file(file) 
+    else
+      @to_delete_after_transaction << file
+    end
+  end
+  
+  def delete_file file
+    puts "-- deleting backupfile #{file}"
+    File.delete file 
+  end
+  
+  def first_record file
+    File.open( file ) { |yf| YAML::load( yf ) }.first
+  end
+  
+end
+
+if Rails.version =~ /^2/
+  ActiveRecord::Migration.send(:extend, ReversibleDataMigration)
+else
+  ActiveRecord::Migration.send(:include, ReversibleDataMigration)
+end

data/reversable_data_migration.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "reversible_data_migration"
+  s.version     = File.open(File.expand_path("../VERSION", __FILE__)).read
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tom Maeckelberghe"]
+  s.email       = ["tom.maeckelberghe@gmail.com"]
+  s.homepage    = "https://github.com/tomkurt/reversible_data_migration"
+  s.summary     = %q{Makes activerecord data migrations reversible.}
+  s.description = %q{Backup data is saved to yaml files. The reverse process load the yaml and restores the records. Works for new and updates not for deletions.}
+  
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "activerecord", "2.3.14"
+
+  s.rubyforge_project = "reversible_migration_helper"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/backup_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+module ReversibleDataMigration
+  RAILS_ROOT = File.dirname(__FILE__)
+end 
+
+describe ReversibleDataMigration do
+  
+  before :each do
+    Product.delete_all
+    `rm -rf #{File.dirname(__FILE__)}/db` 
+    Product.create!(:state => "available")
+    Product.create!(:state => "not_available")
+  end
+
+  it "should write backup data to a yml file with the name of the migration" do
+
+    class RemoveStateFromProduct < ActiveRecord::Migration
+      def self.up
+        backup_data = []
+        Product.all.each do |product|
+          backup_data << {:id => product.id, :state => product.state}
+        end
+        backup backup_data
+      end
+    end
+
+    RemoveStateFromProduct.up
+
+    yaml = File.open( File.dirname(__FILE__) + "/db/migrate/backup_data/remove_state_from_product.yml" ) { |yf| YAML::load( yf ) }
+
+    yaml.should == [
+      {:id => 1, :state => "available"},
+      {:id => 2, :state => "not_available"}
+    ]
+  end
+
+  it "should write backup data to a yml file with the name given by the user" do
+
+    class RemoveStateFromProduct < ActiveRecord::Migration
+      def self.up
+        backup_data = []
+        Product.all.each do |product|
+          backup_data << {:id => product.id, :state => product.state}
+        end
+        backup backup_data, "some_name"
+      end
+    end
+
+    RemoveStateFromProduct.up
+
+    yaml = File.open( File.dirname(__FILE__) + "/db/migrate/backup_data/some_name.yml" ) { |yf| YAML::load( yf ) }
+
+    yaml.should == [
+      {:id => 3, :state => "available"},
+      {:id => 4, :state => "not_available"}
+    ]
+  end
+
+  it "should rollback properly" do
+
+    class RemoveStateFromProduct < ActiveRecord::Migration
+      def self.up
+        backup_data = []
+        Product.all.each do |product|
+          backup_data << {:id => product.id, :state => product.state}
+        end
+        backup backup_data
+        remove_column :products, :state
+      end
+
+      def self.down
+        add_column :products, :state, :string
+        restore Product
+      end
+    end
+
+    RemoveStateFromProduct.up
+    RemoveStateFromProduct.down
+  end
+
+  it "should delete created records" do
+
+    class RemoveStateFromProduct < ActiveRecord::Migration
+      def self.up
+        backup [{:id => Product.create.id}]
+      end
+
+      def self.down
+        destroy_created_records Product
+      end
+    end
+
+    RemoveStateFromProduct.up
+    Product.count.should == 3
+    RemoveStateFromProduct.down
+    Product.count.should == 2
+  end
+
+
+  it "should remove backup files after everything is recovered" do 
+    class RemoveStateFromProduct < ActiveRecord::Migration
+      def self.up
+        product = Product.first
+        backup [{:id => product.id, :state => product.state}]
+        product.update_attribute("state", "something")
+        backup [{:id => Product.create.id}], "second_backup"
+      end
+
+      def self.down
+        restore_batch do
+          restore Product
+          destroy_created_records Product, "second_backup"
+        end
+      end
+    end
+
+    RemoveStateFromProduct.up
+    RemoveStateFromProduct.down 
+    
+    backup_files.should ==  []
+  end
+
+
+  it "should keep backup files if an error occurs" do 
+    class RemoveStateFromProduct < ActiveRecord::Migration
+      def self.up
+        product = Product.first
+        backup [{:id => product.id, :state => product.state}]
+        product.update_attribute("state", "something")
+        backup [{:id => Product.create.id}], "second_backup"
+      end
+
+      def self.down
+        restore_batch do
+          restore Product
+          raise "error"
+          destroy_created_records Product, "second_backup"
+        end
+      end
+    end
+
+    RemoveStateFromProduct.up
+    RemoveStateFromProduct.down rescue nil
+    
+    backup_files.should ==  ["remove_state_from_product.yml", "second_backup.yml"]
+  end
+
+private
+
+  def backup_files
+    `ls #{File.join(File.dirname(__FILE__),  'db/migrate/backup_data')}`.split("\n")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'sqlite3'
+require 'active_record'
+class Rails
+  def self.version
+  	"2"
+  end
+end
+require 'reversible_data_migration'
+
+RSpec.configure do |config|
+  
+end
+
+
+
+# connect to database.  This will create one if it doesn't exist
+MY_DB_NAME = ".test.db"
+`rm #{MY_DB_NAME}`
+MY_DB = SQLite3::Database.new(MY_DB_NAME)
+
+# get active record set up
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => MY_DB_NAME)
+
+# create your AR class
+class Product < ActiveRecord::Base
+
+end
+
+# do a quick pseudo migration.  This should only get executed on the first run
+if !Product.table_exists?
+  ActiveRecord::Base.connection.create_table(:products) do |t|
+    t.column :state, :string
+  end
+end
+
+$stdout = File.new('/dev/null', 'w')

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: reversible_data_migration
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Tom Maeckelberghe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 3
+        - 14
+        version: 2.3.14
+  type: :development
+  version_requirements: *id003
+description: Backup data is saved to yaml files. The reverse process load the yaml and restores the records. Works for new and updates not for deletions.
+email: 
+- tom.maeckelberghe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Manifest
+- README.md
+- Rakefile
+- VERSION
+- lib/reversible_data_migration.rb
+- reversable_data_migration.gemspec
+- spec/backup_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tomkurt/reversible_data_migration
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: reversible_migration_helper
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Makes activerecord data migrations reversible.
+test_files: []
+