activerecord-import 0.1.0

data/lib/activerecord-import/mysql.rb

@@ -0,0 +1,2 @@
+require File.join File.dirname(__FILE__),  "base"
+ActiveRecord::Extensions.require_adapter "mysql"

data/lib/activerecord-import/postgresql.rb

@@ -0,0 +1,2 @@
+require File.join File.dirname(__FILE__),  "base"
+ActiveRecord::Extensions.require_adapter "postgresql"

data/lib/activerecord-import/sqlite3.rb

@@ -0,0 +1,2 @@
+require File.join File.dirname(__FILE__),  "base"
+ActiveRecord::Extensions.require_adapter "sqlite3"

data/test/active_record/connection_adapter_test.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+describe "ActiveRecord::ConnectionAdapter::AbstractAdapter" do
+  context "#get_insert_value_sets - computing insert value sets" do
+    let(:adapter){ ActiveRecord::ConnectionAdapters::AbstractAdapter }
+    let(:base_sql){ "INSERT INTO atable (a,b,c)" }
+    let(:values){ [ "(1,2,3)", "(2,3,4)", "(3,4,5)" ] }
+    
+    context "when the max allowed bytes is 33 and the base SQL is 26 bytes" do
+      it "should return 3 value sets when given 3 value sets of 7 bytes a piece" do
+        value_sets = adapter.get_insert_value_sets values, base_sql.size, max_allowed_bytes = 33
+        assert_equal 3, value_sets.size
+      end
+    end
+  
+    context "when the max allowed bytes is 40 and the base SQL is 26 bytes" do
+      it "should return 3 value sets when given 3 value sets of 7 bytes a piece" do
+        value_sets = adapter.get_insert_value_sets values, base_sql.size, max_allowed_bytes = 40
+        assert_equal 3, value_sets.size
+      end
+    end
+      
+    context "when the max allowed bytes is 41 and the base SQL is 26 bytes" do
+      it "should return 2 value sets when given 2 value sets of 7 bytes a piece" do
+        value_sets = adapter.get_insert_value_sets values, base_sql.size, max_allowed_bytes = 41
+        assert_equal 2, value_sets.size
+      end
+    end
+      
+    context "when the max allowed bytes is 48 and the base SQL is 26 bytes" do
+      it "should return 2 value sets when given 2 value sets of 7 bytes a piece" do
+        value_sets = adapter.get_insert_value_sets values, base_sql.size, max_allowed_bytes = 48
+        assert_equal 2, value_sets.size
+      end
+    end
+      
+    context "when the max allowed bytes is 49 and the base SQL is 26 bytes" do
+      it "should return 1 value sets when given 1 value sets of 7 bytes a piece" do
+        value_sets = adapter.get_insert_value_sets values, base_sql.size, max_allowed_bytes = 49
+        assert_equal 1, value_sets.size
+      end
+    end
+      
+    context "when the max allowed bytes is 999999 and the base SQL is 26 bytes" do
+      it "should return 1 value sets when given 1 value sets of 7 bytes a piece" do
+        value_sets = adapter.get_insert_value_sets values, base_sql.size, max_allowed_bytes = 999999
+        assert_equal 1, value_sets.size
+      end
+    end
+  end
+  
+end

data/test/adapters/mysql.rb

@@ -0,0 +1 @@
+ENV["ARE_DB"] = "mysql"

data/test/adapters/postgresql.rb

@@ -0,0 +1 @@
+ENV["ARE_DB"] = "postgresql"

data/test/adapters/sqlite3.rb

@@ -0,0 +1 @@
+ENV["ARE_DB"] = "sqlite3"

data/test/import_test.rb

@@ -0,0 +1,202 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe "#import" do
+  it "should return the number of inserts performed" do
+    # see ActiveRecord::ConnectionAdapters::AbstractAdapter test for more specifics
+    assert_difference "Topic.count", +10 do
+      result = Topic.import Build(3, :topics)
+      assert result.num_inserts > 0
+    
+      result = Topic.import Build(7, :topics)
+      assert result.num_inserts > 0
+    end
+  end
+
+  context "with :validation option" do
+    let(:columns) { %w(title author_name) }
+    let(:valid_values) { [[ "LDAP", "Jerry Carter"], ["Rails Recipes", "Chad Fowler"]] }
+    let(:invalid_values) { [[ "The RSpec Book", ""], ["Agile+UX", ""]] }
+  
+    context "with validation checks turned off" do
+      it "should import valid data" do
+        assert_difference "Topic.count", +2 do
+          result = Topic.import columns, valid_values, :validate => false
+        end
+      end
+  
+      it "should import invalid data" do
+        assert_difference "Topic.count", +2 do
+          result = Topic.import columns, invalid_values, :validate => false
+        end
+      end
+    end
+  
+    context "with validation checks turned on" do
+      it "should import valid data" do
+        assert_difference "Topic.count", +2 do
+          result = Topic.import columns, valid_values, :validate => true
+        end
+      end
+  
+      it "should not import invalid data" do
+        assert_no_difference "Topic.count" do
+          result = Topic.import columns, invalid_values, :validate => true
+        end
+      end
+  
+      it "should report the failed instances" do
+        results = Topic.import columns, invalid_values, :validate => true
+        assert_equal invalid_values.size, results.failed_instances.size
+        results.failed_instances.each{ |e| assert_kind_of Topic, e }
+      end
+  
+      it "should import valid data when mixed with invalid data" do
+        assert_difference "Topic.count", +2 do
+          result = Topic.import columns, valid_values + invalid_values, :validate => true
+        end
+        assert_equal 0, Topic.find_all_by_title(invalid_values.map(&:first)).count
+      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) }
+    let(:invalid_topics){ Build(7, :invalid_topics)}
+    
+    it "should import records based on those model's attributes" do
+      assert_difference "Topic.count", +9 do
+        result = Topic.import topics
+      end
+      
+      Topic.import [topic]
+      assert Topic.find_by_title_and_author_name("The RSpec Book", "David Chelimsky")
+    end
+  
+    it "should not overwrite existing records" do
+      topic = Generate(:topic, :title => "foobar")
+      assert_no_difference "Topic.count" do
+        begin
+          Topic.transaction do
+            topic.title = "baz"
+            Topic.import [topic]
+          end
+        rescue Exception
+          # PostgreSQL raises PgError due to key constraints
+          # I don't know why ActiveRecord doesn't catch these. *sigh*
+        end
+      end
+      assert_equal "foobar", topic.reload.title
+    end
+    
+    context "with validation checks turned on" do
+      it "should import valid models" do
+        assert_difference "Topic.count", +9 do
+          result = Topic.import topics, :validate => true
+        end
+      end
+      
+      it "should not import invalid models" do
+        assert_no_difference "Topic.count" do
+          result = Topic.import invalid_topics, :validate => true
+        end
+      end
+    end
+    
+    context "with validation checks turned off" do
+      it "should import invalid models" do
+        assert_difference "Topic.count", +7 do
+          result = Topic.import invalid_topics, :validate => false
+        end
+      end
+    end
+  end
+  
+  context "with an array of columns and an array of unsaved model instances" do
+    let(:topics) { Build(2, :topics) }
+    
+    it "should import records populating the supplied columns with the corresponding model instance attributes" do
+      assert_difference "Topic.count", +2 do
+        result = Topic.import [:author_name, :title], topics
+      end
+      
+      # imported topics should be findable by their imported attributes
+      assert Topic.find_by_author_name(topics.first.author_name)
+      assert Topic.find_by_author_name(topics.last.author_name)
+    end
+  
+    it "should not populate fields for columns not imported" do
+      topics.first.author_email_address = "zach.dennis@gmail.com"
+      assert_difference "Topic.count", +2 do
+        result = Topic.import [:author_name, :title], topics
+      end
+      
+      assert !Topic.find_by_author_email_address("zach.dennis@gmail.com")
+    end
+  end
+  
+  context "ActiveRecord timestamps" do
+    context "when the timestamps columns are present" do
+      setup do
+        Delorean.time_travel_to("5 minutes ago") do
+          assert_difference "Book.count", +1 do
+            result = Book.import [:title, :author_name, :publisher], [["LDAP", "Big Bird", "Del Rey"]]
+          end
+        end
+        @book = Book.last
+      end
+    
+      it "should set the created_at column for new records"  do
+        assert_equal 5.minutes.ago.strftime("%H:%M"), @book.created_at.strftime("%H:%M")
+      end
+  
+      it "should set the created_on column for new records" do
+        assert_equal 5.minutes.ago.strftime("%H:%M"), @book.created_on.strftime("%H:%M")
+      end
+  
+      it "should set the updated_at column for new records" do
+        assert_equal 5.minutes.ago.strftime("%H:%M"), @book.updated_at.strftime("%H:%M")
+      end
+  
+      it "should set the updated_on column for new records" do
+        assert_equal 5.minutes.ago.strftime("%H:%M"), @book.updated_on.strftime("%H:%M")
+      end
+    end
+    
+    context "when a custom time zone is set" do
+      setup do
+        original_timezone = ActiveRecord::Base.default_timezone
+        ActiveRecord::Base.default_timezone = :utc
+        Delorean.time_travel_to("5 minutes ago") do
+          assert_difference "Book.count", +1 do
+            result = Book.import [:title, :author_name, :publisher], [["LDAP", "Big Bird", "Del Rey"]]
+          end
+        end
+        ActiveRecord::Base.default_timezone = original_timezone
+        @book = Book.last
+      end
+  
+      it "should set the created_at and created_on timestamps for new records"  do
+        assert_equal 5.minutes.ago.utc.strftime("%H:%M"), @book.created_at.strftime("%H:%M")
+        assert_equal 5.minutes.ago.utc.strftime("%H:%M"), @book.created_on.strftime("%H:%M")
+      end
+  
+      it "should set the updated_at and updated_on timestamps for new records" do
+        assert_equal 5.minutes.ago.utc.strftime("%H:%M"), @book.updated_at.strftime("%H:%M")
+        assert_equal 5.minutes.ago.utc.strftime("%H:%M"), @book.updated_on.strftime("%H:%M")
+      end
+    end
+  end
+  
+  context "importing with database reserved words" do
+    let(:group) { Build(:group, :order => "superx") }
+    
+    it "should import just fine" do
+      assert_difference "Group.count", +1 do
+        result = Group.import [group]
+      end
+      assert_equal "superx", Group.first.order
+    end
+  end
+
+end

data/test/models/book.rb

@@ -0,0 +1,3 @@
+class Book < ActiveRecord::Base
+  belongs_to :topic
+end

data/test/models/group.rb

@@ -0,0 +1,3 @@
+class Group < ActiveRecord::Base
+  self.table_name = 'group'
+end

data/test/models/topic.rb

@@ -0,0 +1,7 @@
+class Topic < ActiveRecord::Base
+  validates_presence_of :author_name
+  has_many :books
+  belongs_to :parent, :class_name => "Topic"
+  
+  composed_of :description, :mapping => [ %w(title title), %w(author_name author_name)], :allow_nil => true, :class_name => "TopicDescription"
+end

data/test/mysql/import_test.rb

@@ -0,0 +1,118 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+require "activerecord-import/mysql"
+
+describe "#import with :on_duplicate_key_update option (mysql specific functionality)" do
+  extend ActiveSupport::TestCase::MySQLAssertions
+  
+  asssertion_group(:should_support_on_duplicate_key_update) do
+    should_not_update_fields_not_mentioned
+    should_update_foreign_keys
+    should_not_update_created_at_on_timestamp_columns
+    should_update_updated_at_on_timestamp_columns
+  end
+  
+  macro(:perform_import){ raise "supply your own #perform_import in a context below" }
+  macro(:updated_topic){ Topic.find(@topic) }
+  
+  context "given columns and values with :validation checks turned off" do
+    let(:columns){  %w( id title author_name author_email_address parent_id ) }
+    let(:values){ [ [ 99, "Book", "John Doe", "john@doe.com", 17 ] ] }
+    let(:updated_values){ [ [ 99, "Book - 2nd Edition", "Author Should Not Change", "johndoe@example.com", 57 ] ] }
+  
+    macro(:perform_import) do |*opts|
+      Topic.import columns, updated_values, opts.extract_options!.merge(:on_duplicate_key_update => update_columns, :validate => false)
+    end
+    
+    setup do
+      Topic.import columns, values, :validate => false
+      @topic = Topic.find 99
+    end
+    
+    context "using string column names" do
+      let(:update_columns){ [ "title", "author_email_address", "parent_id" ] }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned
+    end
+  
+    context "using symbol column names" do
+      let(:update_columns){ [ :title, :author_email_address, :parent_id ] }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned
+    end
+    
+    context "using string hash map" do
+      let(:update_columns){ { "title" => "title", "author_email_address" => "author_email_address", "parent_id" => "parent_id" } }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned
+    end
+  
+    context "using string hash map, but specifying column mismatches" do
+      let(:update_columns){ { "title" => "author_email_address", "author_email_address" => "title", "parent_id" => "parent_id" } }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned_with_hash_mappings
+    end
+  
+    context "using symbol hash map" do
+      let(:update_columns){ { :title => :title, :author_email_address => :author_email_address, :parent_id => :parent_id } }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned
+    end
+  
+    context "using symbol hash map, but specifying column mismatches" do
+      let(:update_columns){ { :title => :author_email_address, :author_email_address => :title, :parent_id => :parent_id } }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned_with_hash_mappings
+    end
+  end
+  
+  context "given array of model instances with :validation checks turned off" do
+    macro(:perform_import) do |*opts|
+      @topic.title = "Book - 2nd Edition"
+      @topic.author_name = "Author Should Not Change"
+      @topic.author_email_address = "johndoe@example.com"
+      @topic.parent_id = 57
+      Topic.import [@topic], opts.extract_options!.merge(:on_duplicate_key_update => update_columns, :validate => false)
+    end
+    
+    setup do
+      @topic = Generate(:topic, :id => 99, :author_name => "John Doe", :parent_id => 17)
+    end
+    
+    context "using string column names" do
+      let(:update_columns){ [ "title", "author_email_address", "parent_id" ] }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned
+    end
+  
+    context "using symbol column names" do
+      let(:update_columns){ [ :title, :author_email_address, :parent_id ] }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned
+    end
+    
+    context "using string hash map" do
+      let(:update_columns){ { "title" => "title", "author_email_address" => "author_email_address", "parent_id" => "parent_id" } }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned
+    end
+  
+    context "using string hash map, but specifying column mismatches" do
+      let(:update_columns){ { "title" => "author_email_address", "author_email_address" => "title", "parent_id" => "parent_id" } }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned_with_hash_mappings
+    end
+  
+    context "using symbol hash map" do
+      let(:update_columns){ { :title => :title, :author_email_address => :author_email_address, :parent_id => :parent_id } }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned
+    end
+  
+    context "using symbol hash map, but specifying column mismatches" do
+      let(:update_columns){ { :title => :author_email_address, :author_email_address => :title, :parent_id => :parent_id } }
+      should_support_on_duplicate_key_update
+      should_update_fields_mentioned_with_hash_mappings
+    end
+  end
+  
+end

data/test/schema/generic_schema.rb

@@ -0,0 +1,98 @@
+ActiveRecord::Schema.define do
+
+  create_table :schema_info, :force=>true do |t|
+    t.column :version, :integer, :unique=>true
+  end
+  SchemaInfo.create :version=>SchemaInfo::VERSION
+
+  create_table :group, :force => true do |t|
+    t.column :order, :string
+    t.timestamps
+  end
+
+  create_table :topics, :force=>true do |t|
+    t.column :title, :string, :null => false
+    t.column :author_name, :string
+    t.column :author_email_address, :string
+    t.column :written_on, :datetime
+    t.column :bonus_time, :time
+    t.column :last_read, :datetime
+    t.column :content, :text
+    t.column :approved, :boolean, :default=>'1'
+    t.column :replies_count, :integer
+    t.column :parent_id, :integer
+    t.column :type, :string
+    t.column :created_at, :datetime
+    t.column :created_on, :datetime
+    t.column :updated_at, :datetime
+    t.column :updated_on, :datetime
+  end
+
+  create_table :projects, :force=>true do |t|
+    t.column :name, :string
+    t.column :type, :string    
+  end
+  
+  create_table :developers, :force=>true do |t|
+    t.column :name, :string
+    t.column :salary, :integer, :default=>'70000'
+    t.column :created_at, :datetime
+    t.column :team_id, :integer
+    t.column :updated_at, :datetime
+  end
+
+  create_table :addresses, :force=>true do |t|
+    t.column :address, :string
+    t.column :city, :string
+    t.column :state, :string
+    t.column :zip, :string
+    t.column :developer_id, :integer
+  end
+
+  create_table :teams, :force=>true do |t|
+    t.column :name, :string
+  end
+  
+  create_table :books, :force=>true do |t|
+    t.column :title, :string, :null=>false
+    t.column :publisher, :string, :null=>false, :default => 'Default Publisher'
+    t.column :author_name, :string, :null=>false
+    t.column :created_at, :datetime
+    t.column :created_on, :datetime
+    t.column :updated_at, :datetime
+    t.column :updated_on, :datetime
+    t.column :publish_date, :date
+    t.column :topic_id, :integer
+    t.column :for_sale, :boolean, :default => true
+  end  
+
+  create_table :languages, :force=>true do |t|
+    t.column :name, :string
+    t.column :developer_id, :integer
+  end
+
+  create_table :shopping_carts, :force=>true do |t|
+    t.column :name, :string, :null => true
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+
+  create_table :cart_items, :force => true do |t|
+    t.column :shopping_cart_id, :string, :null => false
+    t.column :book_id, :string, :null => false
+    t.column :copies, :integer, :default => 1
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+
+  add_index :cart_items, [:shopping_cart_id, :book_id], :unique => true, :name => 'uk_shopping_cart_books'
+
+  create_table :animals, :force => true do |t|
+    t.column :name, :string, :null => false
+    t.column :size, :string, :default => nil
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+  
+  add_index :animals, [:name], :unique => true, :name => 'uk_animals'
+end