legacy_migrations 0.2.3 → 0.2.4

data/README

@@ -40,5 +40,8 @@ OR, copy all columns with the same name
     match_same_name_attributes
   end
 
+Here's a slightly more thorough blog post about it:
+
+http://frontended.com/?p=89
 
 Copyright (c) 2010 Bernie Telles, released under the MIT license

data/VERSION

@@ -1 +1,5 @@
-0.2.3
+<<<<<<< HEAD
+0.2.4
+=======
+0.3.5
+>>>>>>> 55c756bc1f14cf99fb577c11c32db7fb293dc12e

data/legacy_migrations.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{legacy_migrations}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bernie Telles"]
-  s.date = %q{2010-03-17}
+  s.date = %q{2010-08-25}
   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 = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "install.rb",
      "legacy_migrations.gemspec",
      "lib/legacy_migrations.rb",
+     "lib/legacy_migrations/future_storage.rb",
      "lib/legacy_migrations/row_matchers.rb",
      "lib/legacy_migrations/source_iterators.rb",
      "lib/legacy_migrations/squirrel.rb",
@@ -46,7 +47,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/btelles/legacy_migrations}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Rails plugin for transferring or updating data between two db structures.}
   s.test_files = [
     "spec/legacy_migrations_spec.rb",
@@ -60,7 +61,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])

data/lib/legacy_migrations/future_storage.rb

@@ -0,0 +1,5 @@
+module LegacyMigrations
+  class FutureStorage < Hash
+    include Singleton
+  end
+end

data/lib/legacy_migrations/source_iterators.rb

@@ -12,7 +12,7 @@ module LegacyMigrations
             rows_processed += 1
             break if rows_processed == limit[:limit].to_i
           end
-          FasterCSV::Table.new(fewer_rows)
+          CSV::Table.new(fewer_rows)
         else
           @from_table
         end

data/lib/legacy_migrations/transformations.rb

@@ -69,6 +69,24 @@ module LegacyMigrations
       end
     end
 
+    def stored(stored_attribute, *args)
+      options = args.extract_options!
+
+      if options[:if]
+        if_method = Proc.new {|record| send(options[:if], record)}
+      else
+        if_method = Proc.new {|record| true }
+      end
+      custom_method = Proc.new {|record| 
+        if if_method.call(record)
+          FutureStorage.instance[@from_table.to_s][record.id][stored_attribute]
+        else
+          nil
+        end
+      }
+      @columns.merge!({options[:to] => custom_method})
+    end
+
     private
 
     def columns_from_options(columns, options)

data/lib/legacy_migrations.rb

@@ -1,5 +1,8 @@
 require 'legacy_migrations/transformations'
+require 'legacy_migrations/future_storage'
 require 'legacy_migrations/squirrel'
+require 'legacy_migrations/source_iterators'
+require 'legacy_migrations/row_matchers'
 module LegacyMigrations
 
   # Define a source and destination table to transfer data
@@ -11,15 +14,31 @@ module LegacyMigrations
   #   This is useful when you're trying to find faulty data in the source
   #   table, and don't want to run the entire dataset.
   # * <tt>:validate</tt> - Default = true. Use ActiveRecord validations
-  #   when saving destination data.
+  #   when saving the destination rows.
   # * <tt>:source_type</tt> - Default = :active_record. Sets the source
   #   destination type.
   #   Options:
-  #   _:active_record_: Assumes the From option is a class that inherits
+  #   _:active\_record_: Assumes the From option is a class that inherits
   #   from ActiveRecord::Base, then iterates through each record of From
   #   table by using *From*.all.each...
   #   _:other_: Assumes the From option is an iterable 'collection' whose 
-  #   elements/items can respond to all columns speficied in the given block.
+  #   elements/items can respond to all source methods speficied in the given block.
+  # * <tt>:store_as</tt> - Stores the generated destination record as a key
+  #   that is retrievable in other transformations. Note that for this to work, the 
+  #   source object must respond to the method <tt>id</tt> which returns
+  #   a value that is unique for all rows within the table (usually 
+  #   this is just a primary key).
+  #
+  #   _Example_
+  #   <tt>
+  #   transfer_from Mammal, :to => Species, :store_as => 'new_animal' do
+  #     match_same_name_attributes
+  #   end
+  #
+  #   transfer_from Person, :to => Animal do
+  #     stored 'new_animal', :to => :species
+  #   end
+  #   </tt>
   #   
   def transfer_from(from_table, *args, &block)
 
@@ -36,6 +55,52 @@ module LegacyMigrations
     @status_report
   end
 
+  # Define a source and destination table with which to update data
+  #
+  # This method accepts all of the same options as <tt>transfer_from</tt>.
+  #
+  # In addition, you'll need to use a series of columns that match data
+  # from the source to the destination. For example, if your source  and 
+  # destination data have a social security number, then you'd use the
+  # social security number to match records from the two rows. The following
+  # is how you would do that.
+  #
+  # <tt>
+  # update_from SourceTable, :to => DestinationTable do 
+  #   based_on do
+  #     ssn == from.social_security_number
+  #   end
+  #
+  #   from :last_name, :to => :last_name
+  # end
+  # </tt>
+  #
+  # Note that when using the 'based_on' method, the left-hannd item always
+  # corresponds to a column method on the destination table.
+  # 
+  # The methods available in the based_on block correspond to the well-known
+  # squirrel plugin's syntax. Here's a quick review of the possible operators:
+  #
+  # Handles comparisons in the query. This class is analagous to the columns in the database.
+  # When comparing the Condition to a value, the operators are used as follows:
+  # * ==, === : Straight-up Equals. Can also be used as the "IN" operator if the operand is an Array.
+  # Additionally, when the oprand is +nil+, the comparison is correctly generates as "IS NULL"."
+  # * =~ : The LIKE and REGEXP operators. If the operand is a String, it will generate a LIKE
+  # comparison. If it is a Regexp, the REGEXP operator will be used. NOTE: MySQL regular expressions
+  # are NOT the same as Ruby regular expressions. Also NOTE: No wildcards are inserted into the LIKE
+  # comparison, so you may add them where you wish.
+  # * <=> : Performs a BETWEEN comparison, as long as the operand responds to both #first and #last,
+  # which both Ranges and Arrays do.
+  # * > : A simple greater-than comparison.
+  # * >= : Greater-than or equal-to.
+  # * < : A simple less-than comparison.
+  # * <= : Less-than or equal-to.
+  # * contains? : Like =~, except automatically surrounds the operand in %s, which =~ does not do.
+  # * nil? : Works exactly like "column == nil", but in a nicer syntax, which is what Squirrel is all about.
+  #
+  # ==== Options
+  #
+  # 
   def update_from(from_table, *args, &block)
 
     configure_transfer(from_table, *args) { yield }
@@ -59,6 +124,7 @@ module LegacyMigrations
             to_record.save(false)
             @current_operation.record_update(to_record)
           end
+          store_as(to_record, from_record)
         end
       else
         new_destination_record(from_record)
@@ -68,22 +134,35 @@ module LegacyMigrations
   end
 
   private
-  
+
   def configure_transfer(from_table, *args, &block)
     @columns = {}
 
     @options = {:validate => true}.merge(args.extract_options!)
 
+
     @from_table = from_table
     @to_table = @options[:to]
+
+    add_storage_attribute if @options[:store_as].present?
+
     @status_report = StatusReport.instance
 
     yield
 
-    @limit = @options[:limit] ? {:limit, @options[:limit]} : {}
+    @limit = @options[:limit] ? {:limit => @options[:limit]} : {}
     @type  = @options[:source_type] ? @options[:source_type] : :active_record
   end
 
+  def add_storage_attribute
+    symbol_attr = @options[:store_as].to_sym
+    @from_table.first.class.class_eval do
+      define_method(symbol_attr) do
+        FutureStorage.instance[self.class.to_s][self.id][symbol_attr]
+      end
+    end
+  end
+
   def new_destination_record(from_record)
       columns = @columns.inject({}) do |result, attributes|
         result[attributes[0]]= attributes[1].call(from_record)
@@ -97,6 +176,16 @@ module LegacyMigrations
         new_record.save(false)
         @current_operation.record_insert(new_record)
       end
+      store_as(new_record, from_record)
+  end
+
+  def store_as(new_record, from_record)
+    if @options[:store_as].present?
+      @future_storage = FutureStorage.instance
+      @future_storage[@from_table.to_s] ||= {}
+      @future_storage[@from_table.to_s][from_record.id] ||= {}
+      @future_storage[@from_table.to_s][from_record.id].merge!({@options[:store_as].to_sym => new_record})
+    end
   end
 
   def report_validation_errors(new_record, from_record, type = 'insert')
@@ -106,6 +195,7 @@ module LegacyMigrations
       puts @current_operation.add_validation_error(new_record, from_record).pretty_output
     end
   end
+
 end
 include LegacyMigrations
 include LegacyMigrations::Transformations

data/spec/db/schema.rb

@@ -3,6 +3,7 @@
   create_table :people, :force => true do |t|
     t.string :name
     t.string :not_name
+    t.string :city
     t.integer :age
   end
 
@@ -11,11 +12,16 @@
     t.string :not_name
     t.integer :age 
     t.string :first_name
+    t.integer :city_id
   end
 
   create_table :sex, :force => true do |t|
     t.string :name
   end
 
+  create_table :cities, :force => true do |t|
+    t.string :name
+  end
+
 end
 

data/spec/legacy_migrations_spec.rb

@@ -27,7 +27,7 @@ describe LegacyMigrations do
     end
     it "accepts a CSV file" do
       person = "a simple name,age\nalbert,123"
-      person_csv = FasterCSV.parse(person, :headers => :first_row)
+      person_csv = CSV.parse(person, :headers => :first_row)
       transfer_from person_csv, :to => Animal, :source_type => :csv do
         from 'a simple name', :to => :name
       end
@@ -35,7 +35,7 @@ describe LegacyMigrations do
     end
     it "limits a CSV file" do
       person = "a simple name,age\nalbert,123\nsmith,54"
-      person_csv = FasterCSV.parse(person, :headers => :first_row)
+      person_csv = CSV.parse(person, :headers => :first_row)
       transfer_from person_csv, :to => Animal, :source_type => :csv, :limit => 1 do
         from 'a simple name', :to => :name
       end
@@ -55,7 +55,7 @@ describe LegacyMigrations do
     end
     it "rewinds a CSV source" do
       person = "name,age\nalbert,123\nsmith,54"
-      person_csv = FasterCSV.parse(person, :headers => :first_row)
+      person_csv = CSV.parse(person, :headers => :first_row)
       transfer_from person_csv, :to => Animal, :source_type => :csv do
         from :name, :to => :name
       end

data/spec/lib/transformations_spec.rb

@@ -1,6 +1,7 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper.rb'))
 
 describe "transformations" do
+  require 'ruby-debug'
   describe 'from' do
     it "transfers attributes, given the two names" do
       Person.create(:name => 'my first name')
@@ -64,5 +65,20 @@ describe "transformations" do
         animal.not_name.should == nil
       end
     end
+    describe "store_as" do
+      it "stores a given row for future reference by another transfer or update function" do
+        Person.create(:name => 'choose_me', :not_name => 'not_this_one', :city => 'tally')
+        transfer_from Person, :to => City, :store_as => 'my_city' do
+          from :city, :to => :name
+        end
+        transfer_from Person, :to => Animal do
+          match_same_name_attributes
+          stored :my_city, :to => :city
+        end
+
+        animal = Animal.first
+        animal.city.name.should == 'tally'
+      end
+    end
   end
 end

data/spec/models.rb

@@ -6,9 +6,14 @@ end
 
 class Animal < ActiveRecord::Base
   validates_format_of :name, :with => /^(\D)*$/, :allow_nil => true
+  belongs_to :city
   #name
   #not_name
   #first_name
   #age
 end
+
+class City < ActiveRecord::Base
+  has_many :animals
+end
 require 'legacy_migrations'

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ $:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 plugin_spec_dir = File.dirname(__FILE__)
 
 load(File.join(plugin_spec_dir, "db", "schema.rb"))
-require 'fastercsv'
+require 'csv'
 require 'models'
 
   # == Fixtures

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: legacy_migrations
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Bernie Telles
@@ -9,19 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-17 00:00:00 -04:00
+date: 2010-08-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 description: Rails plugin for transferring or updating data between two db structures.
 email: bernardo.telles@dms.myflorida.com
 executables: []
@@ -40,6 +52,7 @@ files:
 - install.rb
 - legacy_migrations.gemspec
 - lib/legacy_migrations.rb
+- lib/legacy_migrations/future_storage.rb
 - lib/legacy_migrations/row_matchers.rb
 - lib/legacy_migrations/source_iterators.rb
 - lib/legacy_migrations/squirrel.rb
@@ -67,21 +80,27 @@ 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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rails plugin for transferring or updating data between two db structures.