legacy_migrations 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/legacy_migrations.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{legacy_migrations}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bernie Telles"]
-  s.date = %q{2010-03-15}
+  s.date = %q{2010-03-17}
   s.description = %q{Rails plugin for transferring or updating data between two db structures.}
   s.email = %q{bernardo.telles@dms.myflorida.com}
   s.extra_rdoc_files = [
@@ -31,8 +31,8 @@ Gem::Specification.new do |s|
      "lib/legacy_migrations/squirrel/extensions.rb",
      "lib/legacy_migrations/squirrel/paginator.rb",
      "lib/legacy_migrations/squirrel/squirrel.rb",
+     "lib/legacy_migrations/status_report.rb",
      "lib/legacy_migrations/transformations.rb",
-     "lib/legacy_migrations/validation_helper.rb",
      "rails/init.rb",
      "spec/db/schema.rb",
      "spec/db/test.sqlite3",

data/lib/legacy_migrations/status_report.rb

@@ -0,0 +1,94 @@
+module LegacyMigrations
+
+  #The StatusReport is returned from each transfer_from and update_from
+  #function. Its purpose is to keep track of all the operations
+  #you've done so far, and to help you log information about them 
+  #after they are complete.
+  #
+  #Each status report has a many operations (one for each transfer or update)
+  #
+  #Each Operation has a source, destination, type (transfer or update),
+  #inserts (array of records inserted), updates (array of records updated),
+  #validation errors, sequence and source type.
+  #
+  class StatusReport
+    include Singleton
+    attr_reader :operations, :sequence
+
+    def add_operation(args)
+      @sequence ? @sequence += 1 : @sequence = 1
+      @operations ||= []
+      operation = Operation.new(args.merge({:sequence => @sequence}))
+      @operations << operation
+      operation
+    end
+
+    def operation_with(*args)
+      @operations ||= []
+      @operations.first do |operation|
+        result = true
+        args.each do |property, value|
+          result = false unless operation.send(property) == value
+        end
+        result
+      end[0]
+    end
+  end
+
+  class ValidationError
+    attr_accessor :source_record, :destination_record, :errors
+    def initialize(destination_record, source_record)
+      @source_record = source_record.dup
+      @destination_record = destination_record.dup
+      @errors = @destination_record.errors.dup
+    end
+    def pretty_output
+      puts "Validation error saving record. Invalid columns:"
+      @errors.each do |attr, error|
+        puts "     #{attr} in the new record #{error}"
+        puts "     Value of #{attr}: #{@destination_record.send(attr.to_sym)}"
+      end
+      puts "     Source record: #{@source_record.inspect}"
+    end
+  end
+
+  class Operation
+    attr_accessor :source, :destination, :source_type, 
+                  :sequence, :inserts, :updates,
+                  :validation_errors, :type
+
+    def initialize(properties)
+      properties.each do |property, value|
+        send("#{property.to_s}=", value) if respond_to? "#{property.to_s}="
+      end
+    end
+
+    def record_update(updated_record)
+      @updates ||= []
+      @updates << updated_record
+    end
+
+    def record_insert(new_record)
+      @inserts ||= []
+      @inserts << new_record
+
+    end
+
+    def add_validation_error(new_record, from_record)
+      @validation_errors ||= []
+      validation_error = ValidationError.new(new_record, from_record)
+      @validation_errors << validation_error
+      validation_error
+    end
+
+    def description
+      inserts = @inserts.try(:size) || 0
+      updates = @updates.try(:size) || 0
+      insert_phrase = "#{inserts} #{inserts == 1 ? 'insert' : 'inserts'}"
+      update_phrase = "#{updates} #{updates == 1 ? 'update' : 'updates'}"
+      actions = [insert_phrase, update_phrase].join(' and ') << '.'
+      "#{@type.capitalize} of data from #{@source.to_s.pluralize} to #{@destination.to_s.pluralize} resulted in #{actions}"
+    end
+  end
+
+end

data/lib/legacy_migrations.rb

@@ -24,20 +24,29 @@ module LegacyMigrations
   def transfer_from(from_table, *args, &block)
 
     configure_transfer(from_table, *args) { yield }
+    @current_operation = StatusReport.instance.add_operation :source => @from_table,
+                                        :destination => @to_table,
+                                        :source_type => args.extract_options![:source_type] || :active_record,
+                                        :type => 'transfer'
+
 
     source_iterator(@limit, @type).each do |from_record|
       new_destination_record(from_record)
     end
+    @status_report
   end
 
   def update_from(from_table, *args, &block)
 
     configure_transfer(from_table, *args) { yield }
 
+    @current_operation = StatusReport.instance.add_operation :source => @from_table,
+                                        :destination => @to_table,
+                                        :source_type => args.extract_options![:source_type] || :active_record,
+                                        :type => 'update'
     source_iterator(@limit, @type).each do |from_record|
       matching_records = @conditions.call(from_record)
 
-      #debugger if from_record.name == 'smithers'
       unless matching_records.empty?
         matching_records.each do |to_record|
           @columns.each do |to, from|
@@ -45,15 +54,17 @@ module LegacyMigrations
           end
 
           if @options[:validate]
-            report_validation_errors(to_record, from_record)
+            report_validation_errors(to_record, from_record, 'update')
           else
             to_record.save(false)
+            @current_operation.record_update(to_record)
           end
         end
       else
         new_destination_record(from_record)
       end
     end
+    @status_report
   end
 
   private
@@ -65,6 +76,7 @@ module LegacyMigrations
 
     @from_table = from_table
     @to_table = @options[:to]
+    @status_report = StatusReport.instance
 
     yield
 
@@ -80,15 +92,23 @@ module LegacyMigrations
       new_record = @to_table.new(columns)
 
       if @options[:validate]
-        report_validation_errors(new_record, from_record)
+        report_validation_errors(new_record, from_record, 'insert')
       else
         new_record.save(false)
+        @current_operation.record_insert(new_record)
       end
   end
+
+  def report_validation_errors(new_record, from_record, type = 'insert')
+    if new_record.save
+      @current_operation.send("record_#{type}", new_record)
+    else
+      puts @current_operation.add_validation_error(new_record, from_record).pretty_output
+    end
+  end
 end
 include LegacyMigrations
 include LegacyMigrations::Transformations
-include LegacyMigrations::ValidationHelper
 include LegacyMigrations::SourceIterators
 include LegacyMigrations::RowMatchers
 

data/spec/legacy_migrations_spec.rb

@@ -66,6 +66,31 @@ describe LegacyMigrations do
       Animal.find_by_name('albert').should be_instance_of(Animal)
       Animal.find_by_first_name('albert').should be_instance_of(Animal)
     end
+    it "always returns a full status report" do
+      Person.create(:name => 'aoeu')
+      transfer_from Person, :to => Animal do
+        from :name, :to => :name
+      end
+      a = update_from Person, :to => Animal do
+        based_on do
+          name == from.name
+        end
+        from :name, :to => :name
+      end
+      a.operations.size == 2
+      a.operations[1].type == 'update'
+    end
+
+    it "records all changes by default" do
+      Person.create(:name => 'aoeu')
+      a = transfer_from Person, :to => Animal do
+        from :name, :to => :name
+      end
+      operation = a.operations.last
+      operation.inserts.size.should == 1
+      operation.inserts[0].should be_instance_of Animal
+      operation.description.should == "Transfer of data from People to Animals resulted in 1 insert and 0 updates."
+    end
   end
   describe 'update_from' do
     it "updates with simple column matching" do

data/spec/lib/transformations_spec.rb

@@ -36,7 +36,6 @@ describe "transformations" do
         end
       end
       Animal.first.first_name.should == 'MY FIRST NAME'
-
     end
     describe "match_same_name_attributes" do
       it "transfers same-name attributes" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: legacy_migrations
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Bernie Telles
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-15 00:00:00 -04:00
+date: 2010-03-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,8 +46,8 @@ files:
 - lib/legacy_migrations/squirrel/extensions.rb
 - lib/legacy_migrations/squirrel/paginator.rb
 - lib/legacy_migrations/squirrel/squirrel.rb
+- lib/legacy_migrations/status_report.rb
 - lib/legacy_migrations/transformations.rb
-- lib/legacy_migrations/validation_helper.rb
 - rails/init.rb
 - spec/db/schema.rb
 - spec/db/test.sqlite3

data/lib/legacy_migrations/validation_helper.rb

@@ -1,14 +0,0 @@
-module LegacyMigrations
-  module ValidationHelper
-    def report_validation_errors(new_record, from_record)
-      unless new_record.save
-        puts "Validation error saving new record. Invalid columns:"
-        new_record.errors.each do |attr, error|
-          puts "     #{attr} in the new record #{error}"
-          puts "     Value of #{attr}: #{new_record.send(attr.to_sym)}"
-        end
-        puts "     Source record: #{from_record.inspect}"
-      end
-    end
-  end
-end