mlins-active_migration 1.0.2 → 1.0.3

data/lib/active_migration/key_mapper.rb

@@ -0,0 +1,117 @@
+module ActiveMigration
+  # The keymapper allows you to serialize and deserialize primary keys.  This is useful in maintaining foreign key
+  # relationships, if you choose not to migrate the primary key.
+  #
+  # To serialize the keys you simply:
+  #
+  #   write_key_map true
+  #
+  #
+  # To deserialize the key for a foreign key you can specifiy the keymap as the third element:
+  #
+  #   map [['product_id','product_id', :product_migration]]
+  #                 ]
+  #
+  # If you'd like to access the key from a callback or anywhere outside the mappings array, you can use:
+  #
+  #   mapped_key(:products, old_key)
+  #
+  module KeyMapper
+
+    # The path to store the serialized(YAML) keys.
+    #
+    # Defaults to '/tmp'
+    #
+    mattr_accessor :storage_path
+    self.storage_path = '/tmp'
+
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :run, :key_mapping
+        alias_method_chain :migrate_field, :key_mapping
+        alias_method_chain :save, :key_mapping
+        class << self
+          attr_accessor :map_keys
+
+          # Tells ActiveMigration to serialize the primary key of the legacy model.
+          #
+          #   write_key_map true
+          #
+          def write_key_map(map_keys)
+            @map_keys = map_keys
+          end
+          alias map_keys= write_key_map
+        end
+      end
+    end
+
+    def run_with_key_mapping #:nodoc:
+      run_without_key_mapping
+      serialize_key_map(self.storage_path, self.class.to_s.demodulize.underscore) if self.class.map_keys
+    end
+
+    private
+
+    def migrate_field_with_key_mapping #:nodoc:
+      unless @mapping[2].nil?
+        load_keymap(@mapping[2].to_s)
+        key = mapped_key(@mapping[2], @legacy_record.instance_eval(@mapping[0]))
+        old_value = @legacy_record.__send__(@mapping[0])
+        @legacy_record.__send__(@mapping[0] + '=', key)
+      end
+      migrate_field_without_key_mapping
+      @legacy_record.__send__(@mapping[0] + '=', old_value) unless old_value.nil?
+    end
+
+    def save_with_key_mapping #:nodoc:
+      save_without_key_mapping
+      map_primary_key(@active_record.id, @legacy_record.id) if self.class.map_keys
+    end
+
+    def map_primary_key(active_id, legacy_id) #:nodoc:
+      map_name = self.class.to_s.demodulize.underscore
+      load_keymap(map_name)
+      @maps[map_name] ||= {}
+      @maps[map_name][handle_composite(legacy_id)] = handle_composite(active_id)
+    end
+
+    def serialize_key_map(data_path, filename) #:nodoc:
+      load_keymap(filename)
+      map_name = self.class.to_s.demodulize.underscore
+      FileUtils.mkdir_p(data_path)
+      FileUtils.rm_rf(File.join(data_path, (filename + "_map.yml")))
+      File.open(File.join(data_path, (filename + "_map.yml")), 'w') do |file|
+        file.write @maps[map_name].to_yaml
+      end
+      logger.info("#{self.class.to_s} wrote keymap successfully to #{File.join(data_path, (filename + "_map.yml"))}")
+    end
+
+    # Lazy loader...
+    def load_keymap(map) #:nodoc:
+      @maps ||= Hash.new
+      if @maps[map].nil? && File.file?(File.join(self.storage_path, map.to_s + "_map.yml"))
+        @maps[map] = YAML.load(File.open(File.join(self.storage_path, map.to_s + "_map.yml")))
+        logger.debug("#{self.class.to_s} lazy loaded #{map} successfully.")
+      end
+    end
+
+    # Returns the deserialized mapped key when provided with the former key.
+    #
+    #  mapped_key(:products, 2)
+    #
+    def mapped_key(map, key)
+      load_keymap(map.to_s)
+      @maps[map.to_s][handle_composite(key)]
+    end
+
+    # Handles composite primary keys.  This assumes you're using the composite_primary_keys gem by Dr. Nic.
+    #
+    # If id is an array join them with '_' otherwise just return the id.
+    #
+    def handle_composite(id)
+      return id.join('_') if id.is_a?(Array)
+      id
+    end
+
+  end
+end

data/lib/active_migration/version.rb

@@ -0,0 +1,9 @@
+module ActiveMigration #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 3
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/active_migration.rb

@@ -0,0 +1,48 @@
+#--
+# Copyright (c) 2008 Matt Lins
+#
+# 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.
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+unless defined? ActiveSupport
+  active_support_path = File.dirname(__FILE__) + "/../../activesupport/lib"
+  if File.exist?(active_support_path)
+    $:.unshift active_support_path
+    require 'active_support'
+  else
+    require 'rubygems'
+    gem 'activesupport'
+    require 'active_support'
+  end
+end
+
+require 'active_migration/base'
+require 'active_migration/key_mapper'
+require 'active_migration/callbacks'
+require 'active_migration/dependencies'
+
+ActiveMigration::Base.class_eval do
+  include ActiveMigration::KeyMapper
+  include ActiveMigration::Callbacks
+  include ActiveMigration::Dependencies
+end

data/lib/activemigration.rb

@@ -0,0 +1 @@
+require 'active_migration'

data/spec/base_spec.rb

@@ -0,0 +1,223 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require File.dirname(__FILE__) + '/fixtures/product_one_migration'
+require File.dirname(__FILE__) + '/fixtures/product_five_migration'
+require File.dirname(__FILE__) + '/fixtures/product_six_migration'
+require File.dirname(__FILE__) + '/fixtures/product_seven_migration'
+require File.dirname(__FILE__) + '/fixtures/product_eight_migration'
+require File.dirname(__FILE__) + '/fixtures/product_nine_migration'
+
+describe 'A migration' do
+
+  before do
+    ActiveMigration::Base.logger = mock('logger', :null_object => true)
+    @legacy_record = mock('legacy_model', :id => 1, :name => 'Beer')
+    @active_record = mock('active_model', :id => 1, :name= => 'Beer', :save => true)
+    @active_record.stub!(:changed?).and_return(true,false)
+    Product.stub!(:new).and_return(@active_record)
+    Product.stub!(:table_name).and_return('some_new_table')
+    Legacy::Product.stub!(:count).and_return(1)
+    Legacy::Product.stub!(:find).and_return([@legacy_record])
+    Legacy::Product.stub!(:table_name).and_return('some_old_table')
+  end
+
+  it "should find the legacy records" do
+    Legacy::Product.should_receive(:find).and_return([@legacy_record])
+    ProductOneMigration.new.run
+  end
+
+  it "should create a new active record" do
+    Product.should_receive(:new).and_return(@active_record)
+    ProductOneMigration.new.run
+  end
+
+  it "should get the legacy name value" do
+    @legacy_record.should_receive(:name).and_return("Beer")
+    ProductOneMigration.new.run
+  end
+
+  it "should set the active name value to the legacy value" do
+    @active_record.should_receive(:name=).with("Beer").and_return("Beer")
+    ProductOneMigration.new.run
+  end
+
+  it "should attempt to save the active record" do
+    @active_record.should_receive(:save).and_return(true)
+    ProductOneMigration.new.run
+  end
+
+  it "should call #handle_success" do
+    @migration = ProductOneMigration.new
+    @migration.should_receive(:handle_success)
+    @migration.run
+  end
+
+  describe "with specified find parameters (other than limit and offset)" do
+
+    it "should find the legacy records with the specified parameters" do
+      Legacy::Product.should_receive(:find).with(:all, {:conditions => ['name = ?', 'matt'], :include => :manufacturer}).and_return([@legacy_record])
+      ProductFiveMigration.new.run
+    end
+
+  end
+
+  describe "with the skip flag set before #migrate_field" do
+
+    before do
+      @migration = ProductSevenMigration.new
+      @active_record.stub!(:valid?).and_return(false)
+      @active_record.stub!(:errors).and_return([])
+    end
+
+    it "should not receive #save" do
+      @active_record.should_not_receive(:save)
+      @migration.run
+    end
+
+    it "should receive #handle_success" do
+      @migration.should_receive(:handle_success)
+      @migration.run
+    end
+
+  end
+
+  describe "with the validation flag set to false" do
+
+    before do
+      @migration = ProductNineMigration.new
+      @active_record.stub!(:valid?).and_return(false)
+      @active_record.stub!(:errors).and_return([])
+    end
+
+    it "should recieve #save with false" do
+      @active_record.should_receive(:save).with(false).and_return(true)
+      @migration.run
+    end
+
+    it "should receive #handle_success" do
+      @migration.should_receive(:handle_success)
+      @migration.run
+    end
+
+  end
+
+  describe "with the skip flag set in #handle_error" do
+
+    before do
+      @migration = ProductEightMigration.new
+      @active_record.stub!(:save).and_return(false)
+      @active_record.stub!(:valid?).and_return(false)
+      @active_record.stub!(:errors).and_return([])
+    end
+
+    it "should only call save once and then skip the migration" do
+      @active_record.should_receive(:save).once.and_return(false)
+      @migration.run
+    end
+
+    it "should receive #handle_success" do
+      @migration.should_receive(:handle_success)
+      @migration.run
+    end
+
+  end
+
+  describe "with specified limit and offset in find parameters" do
+
+    before do
+      @legacy_recordset = []
+      10.times {@legacy_recordset.push(@legacy_record)}
+      Legacy::Product.stub!(:count).and_return(10)
+      Legacy::Product.stub!(:find).and_return(@legacy_recordset)
+    end
+
+    it "should not use the specified offset in the find parameters" do
+      Legacy::Product.should_not_receive(:find).with(:all, {:limit => 5, :offset => 3})
+      ProductOneMigration.new.run
+    end
+
+    it "should call find with a limit of max_rows(5) and an offset of 0 once" do
+      Legacy::Product.should_receive(:find).with(:all, {:limit => 5, :offset => 0}).once.and_return(@legacy_recordset)
+      ProductOneMigration.new.run
+    end
+
+    it "should call find with a limit of max_rows(5) and an offset of 5 once" do
+      Legacy::Product.should_receive(:find).with(:all, {:limit => 5, :offset => 5}).once.and_return(@legacy_recordset)
+      ProductOneMigration.new.run
+    end
+
+  end
+
+  describe "with the update flag set for the active model" do
+
+    before do
+      Product.stub!(:find).and_return(@active_record)
+    end
+
+    it "should call find on the active model" do
+      Product.should_receive(:find).with(1).and_return(@active_record)
+      ProductSixMigration.new.run
+    end
+
+    it "should not create a new active record" do
+      Product.should_not_receive(:new)
+      ProductSixMigration.new.run
+    end
+
+  end
+
+  describe "with invalid data in the active record" do
+
+    before do
+      @errors = mock('errors_object', :null_object => true)
+      @active_record.stub!(:name).and_return('Beer')
+      @active_record.stub!(:save).and_return(false)
+      @active_record.stub!(:save!).and_return(true)
+      @active_record.stub!(:valid?).and_return(false, true)
+      @active_record.stub!(:errors).and_return(@errors)
+      @migration = ProductOneMigration.new
+      @migration.stub!(:handle_error).and_return("new_value")
+    end
+
+    it "should attempt to save the active record" do
+      @active_record.should_receive(:save).and_return(false)
+      @migration.run
+    end
+
+    it "should call #handle_error" do
+      @migration.should_receive(:handle_error)
+      @migration.run
+    end
+
+  end
+
+  describe "with @active_record set as an Array" do
+
+    before do
+      @record1 = mock('active_model1', :id => 1, :name= => 'Beer', :save => true)
+      @record2 = mock('active_model2', :id => 2, :name= => 'Beer', :save => true)
+      @record1.stub!(:changed?).and_return(true,false)
+      @record2.stub!(:changed?).and_return(true,false)
+      @active_record = [@record1, @record2]
+      Product.stub!(:new).and_return(@active_record)
+    end
+
+    it "should call save on record1" do
+      @record1.should_receive(:save).and_return(true)
+      ProductOneMigration.new.run
+    end
+
+    it "should call save on record2" do
+      @record2.should_receive(:save).and_return(true)
+      ProductOneMigration.new.run
+    end
+
+    it "should receive handle_success for each record" do
+      @migration = ProductOneMigration.new
+      @migration.should_receive(:handle_success).twice
+      @migration.run
+    end
+
+  end
+
+end

data/spec/callbacks_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require File.dirname(__FILE__) + '/fixtures/product_one_migration'
+require File.dirname(__FILE__) + '/fixtures/product_ten_migration'
+
+describe "A migration" do
+
+  before do
+    ActiveMigration::Base.logger = mock('logger', :null_object => true)
+    @legacy_record = mock('legacy_model', :id => 1, :name => 'Beer')
+    @active_record = mock('active_model', :id => 1, :name= => 'Beer', :save => true)
+    @active_record.stub!(:changed?).and_return(true,false)
+    Product.stub!(:new).and_return(@active_record)
+    Product.stub!(:table_name).and_return('some_new_table')
+    Legacy::Product.stub!(:count).and_return(1)
+    Legacy::Product.stub!(:find).and_return([@legacy_record])
+    Legacy::Product.stub!(:table_name).and_return('some_old_table')
+    @migration = ProductOneMigration.new
+  end
+
+  describe "when active_record_mode is set to :create" do
+
+    create_callbacks = ActiveMigration::Callbacks::CALLBACKS - %w(before_update after_update)
+
+    create_callbacks.each do |callback|
+      it "should call ##{callback}" do
+        @migration.should_receive(callback).once
+        @migration.run
+      end
+    end
+
+  end
+
+  describe "when active_record_mode is set to :update" do
+
+    before do
+      @migration = ProductTenMigration.new
+      Product.stub!(:find).and_return(@active_record)
+    end
+
+    update_callbacks = ActiveMigration::Callbacks::CALLBACKS - %w(before_create after_create)
+
+    update_callbacks.each do |callback|
+      it "should call ##{callback}" do
+        @migration.should_receive(callback).once
+        @migration.run
+      end
+    end
+
+  end
+
+end

data/spec/dependencies_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require File.dirname(__FILE__) + '/fixtures/product_two_migration'
+
+ManufacturerMigration = Class.new
+
+describe "A migration" do
+
+  before do
+    ActiveMigration::Base.logger = mock('logger', :null_object => true)
+    @dependent_record = mock("dependency_model", :run => nil)
+    @legacy_record = mock('legacy_model', :id => 1, :name => 'Beer')
+    @active_record = mock('active_model', :id => 1, :name= => 'Beer', :save => true)
+    @active_record.stub!(:changed?).and_return(true,false)
+    Product.stub!(:new).and_return(@active_record)
+    Product.stub!(:table_name).and_return('some_new_table')
+    Legacy::Product.stub!(:count).and_return(1)
+    Legacy::Product.stub!(:find).and_return([@legacy_record])
+    Legacy::Product.stub!(:table_name).and_return('some_old_table')
+    ManufacturerMigration.stub!(:new).and_return(@dependent_record)
+    ManufacturerMigration.stub!(:run).and_return(nil)
+    ManufacturerMigration.stub!(:completed?).and_return(false)
+    ManufacturerMigration.stub!(:is_completed).and_return(true)
+  end
+
+  it "should instansiate it's dependencies" do
+    ManufacturerMigration.should_receive(:new).and_return(@dependent_record)
+    ProductTwoMigration.new.run
+  end
+
+  it "should run it's dependencies" do
+    @dependent_record.should_receive(:run).and_return(nil)
+    ProductTwoMigration.new.run
+  end
+
+end

data/spec/fixtures/product_eight_migration.rb

@@ -0,0 +1,13 @@
+class ProductEightMigration < ActiveMigration::Base
+
+  set_active_model 'Product'
+
+  set_legacy_model 'Legacy::Product'
+
+  map              [['name', 'name']]
+
+  def handle_error
+    @skip = true
+  end
+
+end

data/spec/fixtures/product_five_migration.rb

@@ -0,0 +1,11 @@
+class ProductFiveMigration < ActiveMigration::Base
+
+  set_active_model 'Product'
+
+  set_legacy_model 'Legacy::Product',
+                    :conditions => ['name = ?', 'matt'],
+                    :include => :manufacturer
+
+  map              [['name', 'name']]
+
+end

data/spec/fixtures/product_four_migration.rb

@@ -0,0 +1,9 @@
+class ProductFourMigration < ActiveMigration::Base
+
+  set_active_model 'Product'
+
+  set_legacy_model 'Legacy::Product'
+
+  map              [['supplier_id' , 'supplier_id', :products]]
+
+end

data/spec/fixtures/product_nine_migration.rb

@@ -0,0 +1,13 @@
+class ProductNineMigration < ActiveMigration::Base
+
+  set_active_model 'Product'
+
+  set_legacy_model 'Legacy::Product'
+
+  map              [['name', 'name']]
+
+  def before_save
+    @validate_record = false
+  end
+
+end

data/spec/fixtures/product_one_migration.rb

@@ -0,0 +1,11 @@
+class ProductOneMigration < ActiveMigration::Base
+
+  set_active_model 'Product'
+
+  set_legacy_model 'Legacy::Product',
+                   :limit => 5,
+                   :offset => 3 # This is for specing only, this element will be deleted.
+
+  map              [['name', 'name']]
+
+end

data/spec/fixtures/product_seven_migration.rb

@@ -0,0 +1,13 @@
+class ProductSevenMigration < ActiveMigration::Base
+
+  set_active_model 'Product'
+
+  set_legacy_model 'Legacy::Product'
+
+  map              [['name', 'name']]
+
+  def before_migrate_field
+    @skip = true
+  end
+
+end

data/spec/fixtures/product_six_migration.rb

@@ -0,0 +1,10 @@
+class ProductSixMigration < ActiveMigration::Base
+
+  set_active_model 'Product',
+                   :update
+
+  set_legacy_model 'Legacy::Product'
+
+  map              [['name', 'name']]
+
+end

data/spec/fixtures/product_ten_migration.rb

@@ -0,0 +1,12 @@
+class ProductTenMigration < ActiveMigration::Base
+
+  set_active_model 'Product',
+                   :mode => :update
+
+  set_legacy_model 'Legacy::Product',
+                   :limit => 5,
+                   :offset => 3 # This is for specing only, this element will be deleted.
+
+  map              [['name', 'name']]
+
+end

data/spec/fixtures/product_three_migration.rb

@@ -0,0 +1,11 @@
+class ProductThreeMigration < ActiveMigration::Base
+
+  set_active_model    'Product'
+
+  set_legacy_model    'Legacy::Product'
+
+  map                 [['name', 'name']]
+
+  write_key_map       true
+
+end

data/spec/fixtures/product_two_migration.rb

@@ -0,0 +1,11 @@
+class ProductTwoMigration < ActiveMigration::Base
+
+  set_active_model 'Product'
+
+  set_legacy_model 'Legacy::Product'
+
+  map              [['name', 'name']]
+
+  set_dependencies [:manufacturer_migration]
+
+end