legacy_migrations 0.1.0

data/lib/legacy_migrations/transformations.rb

@@ -0,0 +1,76 @@
+module LegacyMigrations
+  module Transformations
+    
+    # Move data from the _from\_attribute_ in the 'from' table to a
+    # column _:to_ in the 'to' table
+    # 
+    # ==== Options
+    #
+    # * <tt>:to</tt> - (Required) Column in destination table to fill in with value in 'from'
+    # * <tt>:if</tt> - specify a function that takes one parameter (the source table's RECORD)
+    #   and returns true or false. The assignment is only made if the function returns a
+    #   non-false value.
+    # * <tt>&block</tt> - if passed a block, the block takes one parameter,
+    #   which is the value of the attribute in the _from_ parameter, then inserts the result of
+    #   the block into the destination attribute.
+    #   parameter and inserts the result of the block in the provided 'to' column.
+    def from(from_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
+      #anyone want to give this a try in another language? ;-)
+      custom_method = Proc.new {|record| 
+        if if_method.call(record)
+          if block_given?
+            yield(record.send(:[], from_attribute.to_s))
+          else
+            record.send(:[], from_attribute.to_s)
+          end
+        else
+          nil
+        end
+
+      }
+
+      @columns.merge!({options[:to] => custom_method})
+    end
+
+    # Shortcut for transferring data between similar tables. 
+    # For example, if two tables have a column named 'name', then using
+    # this function will transfer data from source table's 'name' column
+    # to the destination table's 'name' column.
+    #
+    # ==== Options
+    #
+    # * <tt>:only</tt> - Array of columns that you want to transfer, and 
+    #   that have the same name on both tables.
+    # * <tt>:except</tt> - Array of columns that you DON'T want to transfer,
+    #   but that have the same name on both tables.
+    def match_same_name_attributes(*options)
+
+      options = options.extract_options!
+      same_name_attributes = @from_table.columns.map(&:name) & @to_table.columns.map(&:name)
+
+      if same_name_attributes
+        same_name_attributes = columns_from_options(same_name_attributes, options)
+        same_name_attributes.each do |same_name_attribute|
+          from same_name_attribute, :to => same_name_attribute
+        end
+      end
+    end
+
+    private
+
+    def columns_from_options(columns, options)
+        columns.map!(&:to_sym)
+        columns = columns.select {|a| options[:only].include?(a)} if options[:only]
+        columns = columns.reject {|a| !options[:except].include?(a)} if options[:except]
+        columns
+    end
+  end
+end
+

data/lib/legacy_migrations/validation_helper.rb

@@ -0,0 +1,14 @@
+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

data/spec/db/schema.rb

@@ -0,0 +1,21 @@
+ ActiveRecord::Schema.define(:version => 0) do 
+
+  create_table :people, :force => true do |t|
+    t.string :name
+    t.string :not_name
+    t.integer :age
+  end
+
+  create_table :animals, :force => true do |t|
+    t.string :name
+    t.string :not_name
+    t.integer :age 
+    t.string :first_name
+  end
+
+  create_table :sex, :force => true do |t|
+    t.string :name
+  end
+
+end
+

data/spec/legacy_migrations_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper.rb'))
+
+describe LegacyMigrations do
+  require 'ruby-debug'
+  describe 'transfer_from' do
+    it "accepts a limit to the number of transfers to conduct" do
+      3.times {|a| Person.create(:name => 'my first name') }
+
+      transfer_from Person, :to => Animal, :limit => 2 do
+        match_same_name_attributes
+      end
+      Animal.all.count.should == 2
+    end
+    it "validates by default" do
+      Person.create(:name => 'aoeu 9')
+      transfer_from Person, :to => Animal do
+        match_same_name_attributes
+      end
+      Animal.all.count.should == 0
+    end
+    it "bypasses validation when the option is set" do
+      Person.create(:name => 'aoeu 9')
+      transfer_from Person, :to => Animal, :validate => false do
+        match_same_name_attributes
+      end
+      Animal.all.count.should == 1
+    end
+    it "accepts a CSV file" do
+      person = "a simple name,age\nalbert,123"
+      person_csv = FasterCSV.parse(person, :headers => :first_row)
+      transfer_from person_csv, :to => Animal, :source_type => :csv do
+        from 'a simple name', :to => :name
+      end
+      Animal.first.name.should == 'albert'
+    end
+    it "limits a CSV file" do
+      person = "a simple name,age\nalbert,123\nsmith,54"
+      person_csv = FasterCSV.parse(person, :headers => :first_row)
+      transfer_from person_csv, :to => Animal, :source_type => :csv, :limit => 1 do
+        from 'a simple name', :to => :name
+      end
+      Animal.all.count.should == 1
+    end
+  end
+  describe 'update_from' do
+    it "updates with simple column matching" do
+      Person.create(:name => 'smithers', :age => 4)
+      Animal.create(:name => 'smithers')
+      update_from Person, :to => Animal do
+
+        based_on do 
+          name == from.name
+        end
+
+        from :name, :to => :name
+        from :age, :to => :age
+      end
+      Animal.find_by_name('smithers').age.should == 4
+      Animal.all.count.should == 1
+    end
+    it "inserts if a matching record does not exist" do
+      Person.create(:name => 'smithers', :age => 4)
+      Person.create(:name => 'simpson', :age => 8)
+      Animal.create(:name => 'simpson')
+      update_from Person, :to => Animal do
+
+        based_on do
+          name == from.name
+        end
+
+        from :name, :to => :name
+        from :age, :to => :age
+      end
+      Animal.find_by_name('smithers').age.should == 4
+      Animal.find_by_name('simpson').age.should == 8
+      Animal.all.count.should == 2
+    end
+  end
+end
+

data/spec/lib/transformations_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper.rb'))
+
+describe "transformations" do
+  describe 'from' do
+    it "transfers attributes, given the two names" do
+      Person.create(:name => 'my first name')
+      transfer_from Person, :to => Animal do
+        from :name, :to => :first_name
+      end
+      Animal.first.first_name.should == 'my first name'
+    end
+    it "transfers attributes, given a block" do
+      Person.create(:name => 'my first name')
+      transfer_from Person, :to => Animal do
+        from :name, :to => :first_name do |name|
+          name.upcase
+        end
+      end
+      Animal.first.first_name.should == 'MY FIRST NAME'
+    end
+    it 'allows user to specify an :if function' do
+      def function_returning_false(from_record); false; end
+      Person.create(:name => 'my first name')
+      transfer_from Person, :to => Animal do
+        from :name, :to => :first_name, :if => :function_returning_false
+        from :name, :to => :name
+      end
+      Animal.first.first_name.should == nil
+      Animal.first.name.should == 'my first name'
+    end
+    describe "match_same_name_attributes" do
+      it "transfers same-name attributes" do
+        Person.create(:name => 'same name')
+        transfer_from Person, :to => Animal do
+          match_same_name_attributes
+        end
+        Animal.first.name.should == 'same name'
+      end
+      it "lets the user select all attributes EXCEPT a few for transfer" do
+        Person.create(:name => 'choose_me', :not_name => 'not_this_one')
+        transfer_from Person, :to => Animal do
+          match_same_name_attributes :except => [:name]
+        end
+        animal = Animal.first
+        animal.name.should == 'choose_me'
+        animal.not_name.should == nil
+      end
+      it "lets the user select only some attributes for transfer" do
+        Person.create(:name => 'only', :not_name => 'not_this')
+        transfer_from Person, :to => Animal do
+          match_same_name_attributes :only => [:name]
+        end
+        animal = Animal.first
+        animal.name.should == 'only'
+        animal.not_name.should == nil
+      end
+    end
+  end
+end

data/spec/models.rb

@@ -0,0 +1,14 @@
+class Person < ActiveRecord::Base
+  #name
+  #not_name
+  #age
+end
+
+class Animal < ActiveRecord::Base
+  validates_format_of :name, :with => /^(\D)*$/, :allow_nil => true
+  #name
+  #not_name
+  #first_name
+  #age
+end
+require 'legacy_migrations'

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+#if Rails::VERSION::STRING =~ /^3\..*/
+#  require 'rspec'
+#  require 'rspec-rails'
+#  require 'ruby-debug'
+#end
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','..','spec','spec_helper'))
+$TESTING=true
+$:.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 'models'
+
+  # == Fixtures
+  #
+if Rails::VERSION::STRING =~ /^3\..*/
+  Rspec.configure do |config|
+  end
+else
+  Spec::Runner.configure do |config|
+
+    config.use_transactional_fixtures = true
+    config.use_instantiated_fixtures  = false
+    config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: legacy_migrations
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bernie Telles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Rails plugin for transferring or updating data between two db structures.
+email: bernardo.telles@dms.myflorida.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- Rakefile
+- VERSION
+- config/database.yml
+- install.rb
+- lib/legacy_migrations.rb
+- lib/legacy_migrations/row_matchers.rb
+- lib/legacy_migrations/source_iterators.rb
+- lib/legacy_migrations/squirrel.rb
+- lib/legacy_migrations/squirrel/extensions.rb
+- lib/legacy_migrations/squirrel/paginator.rb
+- lib/legacy_migrations/squirrel/squirrel.rb
+- lib/legacy_migrations/transformations.rb
+- lib/legacy_migrations/validation_helper.rb
+- spec/db/schema.rb
+- spec/db/test.sqlite3
+- spec/legacy_migrations_spec.rb
+- spec/lib/transformations_spec.rb
+- spec/models.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- uninstall.rb
+- README
+has_rdoc: true
+homepage: http://github.com/btelles/legacy_migrations
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails plugin for transferring or updating data between two db structures.
+test_files: 
+- spec/legacy_migrations_spec.rb
+- spec/lib/transformations_spec.rb
+- spec/models.rb
+- spec/spec_helper.rb
+- spec/db/schema.rb