activerecord-import 0.2.5 → 0.2.6

data/Rakefile

@@ -41,6 +41,8 @@ ADAPTERS.each do |adapter|
   namespace :test do
     desc "Runs #{adapter} database tests."
     Rake::TestTask.new(adapter) do |t|
+      # FactoryGirl has an issue with warnings, so turn off, so noisy
+      # t.warning = true
       t.test_files = FileList["test/adapters/#{adapter}.rb", "test/*_test.rb", "test/active_record/*_test.rb", "test/#{adapter}/**/*_test.rb"]
     end
     task adapter

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/lib/activerecord-import/base.rb

@@ -25,3 +25,4 @@ end
 this_dir = Pathname.new File.dirname(__FILE__)
 require this_dir.join("import")
 require this_dir.join("active_record/adapters/abstract_adapter")
+require this_dir.join("synchronize")

data/lib/activerecord-import/import.rb

@@ -129,6 +129,11 @@ class ActiveRecord::Base
     #  BlogPost.import posts, :synchronize=>[ post ]
     #  puts post.author_name # => 'yoda'
     #
+    #  # Example synchronizing unsaved/new instances in memory by using a uniqued imported field
+    #  posts = [BlogPost.new(:title => "Foo"), BlogPost.new(:title => "Bar")]
+    #  BlogPost.import posts, :synchronize => posts
+    #  puts posts.first.new_record? # => false
+    #
     # == On Duplicate Key Update (MySQL only)
     #
     # The :on_duplicate_key_update option can be either an Array or a Hash. 
@@ -178,6 +183,9 @@ class ActiveRecord::Base
             end
           # end
         end
+        # supports empty array
+      elsif args.last.is_a?( Array ) and args.last.empty?
+        return ActiveRecord::Import::Result.new([], 0) if args.last.empty?
         # supports 2-element array and array
       elsif args.size == 2 and args.first.is_a?( Array ) and args.last.is_a?( Array )
         column_names, array_of_attributes = args
@@ -209,7 +217,8 @@ class ActiveRecord::Base
       end
 
       if options[:synchronize]
-        synchronize( options[:synchronize] )
+        sync_keys = options[:synchronize_keys] || [self.primary_key]
+        synchronize( options[:synchronize], sync_keys)
       end
 
       return_obj.num_inserts = 0 if return_obj.num_inserts.nil?

data/lib/activerecord-import/synchronize.rb

@@ -0,0 +1,55 @@
+module ActiveRecord # :nodoc:
+  class Base # :nodoc:
+      
+    # Synchronizes the passed in ActiveRecord instances with data
+    # from the database. This is like calling reload on an individual
+    # ActiveRecord instance but it is intended for use on multiple instances. 
+    # 
+    # This uses one query for all instance updates and then updates existing
+    # instances rather sending one query for each instance
+    #
+    # == Examples
+    # # Synchronizing existing models by matching on the primary key field
+    # posts = Post.find_by_author("Zach")
+    # <.. out of system changes occur to change author name from Zach to Zachary..>
+    # Post.synchronize posts
+    # posts.first.author # => "Zachary" instead of Zach
+    # 
+    # # Synchronizing using custom key fields
+    # posts = Post.find_by_author("Zach")
+    # <.. out of system changes occur to change the address of author 'Zach' to 1245 Foo Ln ..>
+    # Post.synchronize posts, [:name] # queries on the :name column and not the :id column
+    # posts.first.address # => "1245 Foo Ln" instead of whatever it was
+    #
+    def self.synchronize(instances, keys=[self.primary_key])
+      return if instances.empty?
+
+      conditions = {}
+      order = ""
+      
+      key_values = keys.map { |key| instances.map(&"#{key}".to_sym) }
+      keys.zip(key_values).each { |key, values| conditions[key] = values }
+      order = keys.map{ |key| "#{key} ASC" }.join(",")
+      
+      klass = instances.first.class
+
+      fresh_instances = klass.find( :all, :conditions=>conditions, :order=>order )
+      instances.each do |instance|
+        matched_instance = fresh_instances.detect do |fresh_instance|
+          keys.all?{ |key| fresh_instance.send(key) == instance.send(key) }
+        end
+        
+        if matched_instance
+          instance.clear_aggregation_cache
+          instance.clear_association_cache
+          instance.instance_variable_set '@attributes', matched_instance.attributes
+        end
+      end
+    end
+
+    # See ActiveRecord::ConnectionAdapters::AbstractAdapter.synchronize
+    def synchronize(instances, key=[ActiveRecord::Base.primary_key])
+      self.class.synchronize(instances, key)
+    end
+  end
+end

data/test/import_test.rb

@@ -12,6 +12,13 @@ describe "#import" do
     end
   end
 
+  it "should not produce an error when importing empty arrays" do
+    assert_nothing_raised do
+      Topic.import []
+      Topic.import %w(title author_name), []
+    end
+  end
+
   context "with :validation option" do
     let(:columns) { %w(title author_name) }
     let(:valid_values) { [[ "LDAP", "Jerry Carter"], ["Rails Recipes", "Chad Fowler"]] }
@@ -59,6 +66,26 @@ describe "#import" do
     end
   end
   
+  context "with :synchronize option" do
+    context "synchronizing on new records" do
+      let(:new_topics) { Build(3, :topics) }
+    
+      it "doesn't reload any data (doesn't work)" do
+        Topic.import new_topics, :synchronize => new_topics
+        assert new_topics.all?(&:new_record?), "No record should have been reloaded"
+      end
+    end
+    
+    context "synchronizing on new records with explicit conditions" do
+      let(:new_topics) { Build(3, :topics) }
+
+      it "reloads data for existing in-memory instances" do
+        Topic.import(new_topics, :synchronize => new_topics, :synchronize_key => [:title] )
+        assert new_topics.all?(&:new_record?), "Records should have been reloaded"
+      end      
+    end
+  end
+  
   context "with an array of unsaved model instances" do
     let(:topic) { Build(:topic, :title => "The RSpec Book", :author_name => "David Chelimsky")}
     let(:topics) { Build(9, :topics) }
@@ -135,6 +162,13 @@ describe "#import" do
     end
   end
   
+  context "with an array of columns and an array of values" do
+    it "should import ids when specified" do
+      Topic.import [:id, :author_name, :title], [[99, "Bob Jones", "Topic 99"]]
+      assert_equal 99, Topic.last.id
+    end
+  end
+  
   context "ActiveRecord timestamps" do
     context "when the timestamps columns are present" do
       setup do
@@ -210,5 +244,4 @@ describe "#import" do
       assert_equal "05/14/2010".to_date, Topic.last.last_read.to_date
     end
   end
-
 end

data/test/support/mysql/import_examples.rb

@@ -142,4 +142,30 @@ def should_support_mysql_import_functionality
     end
   
   end
+
+  describe "#import with :synchronization option" do
+    let(:topics){ Array.new } 
+    let(:values){ [ [topics.first.id, "Jerry Carter"], [topics.last.id, "Chad Fowler"] ]}
+    let(:columns){ %W(id author_name) }
+    
+    setup do
+      topics << Topic.create!(:title=>"LDAP", :author_name=>"Big Bird")
+      topics << Topic.create!(:title=>"Rails Recipes", :author_name=>"Elmo") 
+    end
+    
+    it "synchronizes passed in ActiveRecord model instances with the data just imported" do
+      columns2update = [ 'author_name' ]
+      
+      expected_count = Topic.count
+      Topic.import( columns, values,
+        :validate=>false,
+        :on_duplicate_key_update=>columns2update,
+        :synchronize=>topics )
+    
+      assert_equal expected_count, Topic.count, "no new records should have been created!"
+      assert_equal "Jerry Carter",  topics.first.author_name, "wrong author!"
+      assert_equal "Chad Fowler", topics.last.author_name, "wrong author!"
+    end
+  end
+
 end

data/test/synchronize_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe ".synchronize" do
+  let(:topics){ Generate(3, :topics) }
+  let(:titles){ %w(one two three) }
+  
+  setup do
+    # update records outside of ActiveRecord knowing about it
+    Topic.connection.execute( "UPDATE #{Topic.table_name} SET title='#{titles[0]}_haha' WHERE id=#{topics[0].id}", "Updating record 1 without ActiveRecord" )
+    Topic.connection.execute( "UPDATE #{Topic.table_name} SET title='#{titles[1]}_haha' WHERE id=#{topics[1].id}", "Updating record 2 without ActiveRecord" )
+    Topic.connection.execute( "UPDATE #{Topic.table_name} SET title='#{titles[2]}_haha' WHERE id=#{topics[2].id}", "Updating record 3 without ActiveRecord" )
+  end
+  
+  it "reloads data for the specified records" do
+    Book.synchronize topics
+
+    actual_titles = topics.map(&:title)
+    assert_equal "#{titles[0]}_haha", actual_titles[0], "the first record was not correctly updated"
+    assert_equal "#{titles[1]}_haha", actual_titles[1], "the second record was not correctly updated"
+    assert_equal "#{titles[2]}_haha", actual_titles[2], "the third record was not correctly updated"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activerecord-import
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Zach Dennis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 -05:00
+date: 2011-04-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,10 +42,8 @@ extensions: []
 
 extra_rdoc_files: 
 - README.markdown
-- README.textile
 files: 
 - README.markdown
-- README.textile
 - Rakefile
 - VERSION
 - lib/activerecord-import.rb
@@ -64,6 +62,7 @@ files:
 - lib/activerecord-import/mysql2.rb
 - lib/activerecord-import/postgresql.rb
 - lib/activerecord-import/sqlite3.rb
+- lib/activerecord-import/synchronize.rb
 - test/active_record/connection_adapter_test.rb
 - test/adapters/mysql.rb
 - test/adapters/mysql2.rb
@@ -84,6 +83,7 @@ files:
 - test/support/generate.rb
 - test/support/mysql/assertions.rb
 - test/support/mysql/import_examples.rb
+- test/synchronize_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/zdennis/activerecord-import
@@ -140,4 +140,5 @@ test_files:
 - test/support/generate.rb
 - test/support/mysql/assertions.rb
 - test/support/mysql/import_examples.rb
+- test/synchronize_test.rb
 - test/test_helper.rb

data/README.textile

@@ -1,62 +0,0 @@
-h1. activerecord-import
-
-activerecord-import is a library for bulk inserting data using ActiveRecord. 
-
-h2. Why activerecord-import?
-
-Because plain-vanilla, out-of-the-box ActiveRecord doesn't provide support for inserting large amounts of data efficiently. With vanilla ActiveRecord you would have to perform individual save operations on each model:
-
-<pre>
-10.times do |i|
-  Book.create! :name => "book #{i}"
-end
-</pre> 
-
-This may work fine if all you have is 10 records, but if you have hundreds, thousands, or millions of records it can turn into a nightmare. This is where activerecord-import comes into play. 
-
-h2. An Introductory Example
-
-Here's an example with equivalent behaviour using the @#import@ method:
-
-<pre>
-books = []
-10.times do |i| 
-  books << Book.new(:name => "book #{i}")
-end
-Book.import books
-</pre>
-
-This call to import does whatever is most efficient for the underlying database adapter.  Pretty slick, eh?
-
-h2. Features
-
-Here's a list of some of the high-level features that activerecord-import provides:
-
-* activerecord-import can work with raw columns and arrays of values (fastest)
-* activerecord-import works with model objects (faster)
-* activerecord-import can perform validations (fast)
-* activerecord-import can perform on duplicate key updates (requires mysql)
-
-
-h1. Upgrading from ar-extensions
-
-activerecord-import replaces the ar-extensions library and is compatible with Rails 3. It provides the exact same API for importing data, but it does not include any additional ar-extensions functionality.
-
-h1. License
-
-This is licensed under the ruby license. 
-
-h1. Author
-
-Zach Dennis (zach.dennis@gmail.com)
-
-h1. Contributors
-
-* Blythe Dunham
-* Gabe da Silveira
-* Henry Work
-* James Herdman
-* Marcus Crafter
-* Thibaud Guillaume-Gentil
-* Mark Van Holstyn 
-* Victor Costan