activerecord-import-uuid 0.1

data/test/support/factories.rb

@@ -0,0 +1,57 @@
+FactoryGirl.define do
+  sequence(:book_title) { |n| "Book #{n}" }
+  sequence(:chapter_title) { |n| "Chapter #{n}" }
+  sequence(:end_note) { |n| "Endnote #{n}" }
+
+  factory :group do
+    sequence(:order) { |n| "Order #{n}" }
+  end
+
+  factory :invalid_topic, class: "Topic" do
+    sequence(:title) { |n| "Title #{n}" }
+    author_name nil
+  end
+
+  factory :topic do
+    sequence(:title) { |n| "Title #{n}" }
+    sequence(:author_name) { |n| "Author #{n}" }
+  end
+
+  factory :widget do
+    sequence(:w_id) { |n| n }
+  end
+
+  factory :question do
+    sequence(:body) { |n| "Text #{n}" }
+
+    trait :with_rule do
+      after(:build) do |question|
+        question.build_rule(FactoryGirl.attributes_for(:rule))
+      end
+    end
+  end
+
+  factory :rule do
+    sequence(:condition_text) { |n| "q_#{n}_#{n}" }
+  end
+
+  factory :topic_with_book, parent: :topic do
+    after(:build) do |topic|
+      2.times do
+        book = topic.books.build(title: FactoryGirl.generate(:book_title), author_name: 'Stephen King')
+        3.times do
+          book.chapters.build(title: FactoryGirl.generate(:chapter_title))
+        end
+
+        4.times do
+          book.end_notes.build(note: FactoryGirl.generate(:end_note))
+        end
+      end
+    end
+  end
+
+  factory :book do
+    title 'Tortilla Flat'
+    author_name 'John Steinbeck'
+  end
+end

data/test/support/generate.rb

@@ -0,0 +1,29 @@
+class ActiveSupport::TestCase
+  def Build(*args) # rubocop:disable Style/MethodName
+    n = args.shift if args.first.is_a?(Numeric)
+    factory = args.shift
+    factory_girl_args = args.shift || {}
+
+    if n
+      [].tap do |collection|
+        n.times.each { collection << FactoryGirl.build(factory.to_s.singularize.to_sym, factory_girl_args) }
+      end
+    else
+      FactoryGirl.build(factory.to_s.singularize.to_sym, factory_girl_args)
+    end
+  end
+
+  def Generate(*args) # rubocop:disable Style/MethodName
+    n = args.shift if args.first.is_a?(Numeric)
+    factory = args.shift
+    factory_girl_args = args.shift || {}
+
+    if n
+      [].tap do |collection|
+        n.times.each { collection << FactoryGirl.create(factory.to_s.singularize.to_sym, factory_girl_args) }
+      end
+    else
+      FactoryGirl.create(factory.to_s.singularize.to_sym, factory_girl_args)
+    end
+  end
+end

data/test/support/mysql/import_examples.rb

@@ -0,0 +1,85 @@
+# encoding: UTF-8
+def should_support_mysql_import_functionality
+  # Forcefully disable strict mode for this session.
+  ActiveRecord::Base.connection.execute "set sql_mode='STRICT_ALL_TABLES'"
+
+  should_support_basic_on_duplicate_key_update
+
+  describe "#import" do
+    context "with :on_duplicate_key_update and validation checks turned off" do
+      extend ActiveSupport::TestCase::ImportAssertions
+
+      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.id) }
+
+      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 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 "with :synchronization option" do
+      let(:topics) { [] }
+      let(:values) { [[topics.first.id, "Jerry Carter", "title1"], [topics.last.id, "Chad Fowler", "title2"]] }
+      let(:columns) { %w(id author_name title) }
+
+      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
+end

data/test/support/postgresql/import_examples.rb

@@ -0,0 +1,242 @@
+# encoding: UTF-8
+def should_support_postgresql_import_functionality
+  should_support_recursive_import
+
+  describe "#supports_imports?" do
+    it "should support import" do
+      assert ActiveRecord::Base.supports_import?
+    end
+  end
+
+  describe "#import" do
+    it "should import with a single insert" do
+      # see ActiveRecord::ConnectionAdapters::AbstractAdapter test for more specifics
+      assert_difference "Topic.count", +10 do
+        result = Topic.import Build(3, :topics)
+        assert_equal 1, result.num_inserts
+
+        result = Topic.import Build(7, :topics)
+        assert_equal 1, result.num_inserts
+      end
+    end
+
+    describe "with query cache enabled" do
+      setup do
+        unless ActiveRecord::Base.connection.query_cache_enabled
+          ActiveRecord::Base.connection.enable_query_cache!
+          @disable_cache_on_teardown = true
+        end
+      end
+
+      it "clears cache on insert" do
+        before_import = Topic.all.to_a
+
+        Topic.import(Build(2, :topics), validate: false)
+
+        after_import = Topic.all.to_a
+        assert_equal 2, after_import.size - before_import.size
+      end
+
+      teardown do
+        if @disable_cache_on_teardown
+          ActiveRecord::Base.connection.disable_query_cache!
+        end
+      end
+    end
+
+    describe "no_returning" do
+      let(:books) { [Book.new(author_name: "foo", title: "bar")] }
+
+      it "creates records" do
+        assert_difference "Book.count", +1 do
+          Book.import books, no_returning: true
+        end
+      end
+
+      it "returns no ids" do
+        assert_equal [], Book.import(books, no_returning: true).ids
+      end
+    end
+  end
+end
+
+def should_support_postgresql_upsert_functionality
+  should_support_basic_on_duplicate_key_update
+
+  describe "#import" do
+    extend ActiveSupport::TestCase::ImportAssertions
+
+    macro(:perform_import) { raise "supply your own #perform_import in a context below" }
+    macro(:updated_topic) { Topic.find(@topic.id) }
+
+    context "with :on_duplicate_key_ignore and 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]] }
+
+      setup do
+        Topic.import columns, values, validate: false
+      end
+
+      it "should not update any records" do
+        result = Topic.import columns, updated_values, on_duplicate_key_ignore: true, validate: false
+        assert_equal [], result.ids
+      end
+    end
+
+    context "with :on_duplicate_key_ignore and :recursive enabled" do
+      let(:new_topic) { Build(1, :topic_with_book) }
+      let(:mixed_topics) { Build(1, :topic_with_book) + new_topic + Build(1, :topic_with_book) }
+
+      setup do
+        Topic.import new_topic, recursive: true
+      end
+
+      # Recursive import depends on the primary keys of the parent model being returned
+      # on insert. With on_duplicate_key_ignore enabled, not all ids will be returned
+      # and it is possible that a model will be assigned the wrong id and then its children
+      # would be associated with the wrong parent.
+      it ":on_duplicate_key_ignore is ignored" do
+        assert_raise ActiveRecord::RecordNotUnique do
+          Topic.import mixed_topics, recursive: true, on_duplicate_key_ignore: true
+        end
+      end
+    end
+
+    context "with :on_duplicate_key_update and validation checks turned off" do
+      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
+
+      context "using a hash" do
+        context "with :columns a hash" 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: { conflict_target: :id, columns: update_columns }, validate: false)
+          end
+
+          setup do
+            Topic.import columns, values, validate: false
+            @topic = Topic.find 99
+          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 "with :constraint_name" do
+          let(:columns) { %w( id title author_name author_email_address parent_id ) }
+          let(:values) { [[100, "Book", "John Doe", "john@doe.com", 17]] }
+          let(:updated_values) { [[100, "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: { constraint_name: :topics_pkey, columns: update_columns }, validate: false)
+          end
+
+          setup do
+            Topic.import columns, values, validate: false
+            @topic = Topic.find 100
+          end
+
+          let(:update_columns) { [:title, :author_email_address, :parent_id] }
+          should_support_on_duplicate_key_update
+          should_update_fields_mentioned
+        end
+
+        context "default to the primary key" do
+          let(:columns) { %w( id title author_name author_email_address parent_id ) }
+          let(:values) { [[100, "Book", "John Doe", "john@doe.com", 17]] }
+          let(:updated_values) { [[100, "Book - 2nd Edition", "Author Should Not Change", "johndoe@example.com", 57]] }
+          let(:update_columns) { [:title, :author_email_address, :parent_id] }
+
+          setup do
+            Topic.import columns, values, validate: false
+            @topic = Topic.find 100
+          end
+
+          context "with no :conflict_target or :constraint_name" do
+            macro(:perform_import) do |*opts|
+              Topic.import columns, updated_values, opts.extract_options!.merge(on_duplicate_key_update: { columns: update_columns }, validate: false)
+            end
+
+            should_support_on_duplicate_key_update
+            should_update_fields_mentioned
+          end
+
+          context "with empty value for :conflict_target" do
+            macro(:perform_import) do |*opts|
+              Topic.import columns, updated_values, opts.extract_options!.merge(on_duplicate_key_update: { conflict_target: [], columns: update_columns }, validate: false)
+            end
+
+            should_support_on_duplicate_key_update
+            should_update_fields_mentioned
+          end
+
+          context "with empty value for :constraint_name" do
+            macro(:perform_import) do |*opts|
+              Topic.import columns, updated_values, opts.extract_options!.merge(on_duplicate_key_update: { constraint_name: '', columns: update_columns }, validate: false)
+            end
+
+            should_support_on_duplicate_key_update
+            should_update_fields_mentioned
+          end
+        end
+
+        context "with no :conflict_target or :constraint_name" do
+          context "with no primary key" do
+            it "raises ArgumentError" do
+              error = assert_raises ArgumentError do
+                Widget.import Build(1, :widgets), on_duplicate_key_update: [:data], validate: false
+              end
+              assert_match(/Expected :conflict_target or :constraint_name to be specified/, error.message)
+            end
+          end
+        end
+
+        context "with no :columns" do
+          let(:columns) { %w( id title author_name author_email_address ) }
+          let(:values) { [[100, "Book", "John Doe", "john@doe.com"]] }
+          let(:updated_values) { [[100, "Title Should Not Change", "Author Should Not Change", "john@nogo.com"]] }
+
+          macro(:perform_import) do |*opts|
+            Topic.import columns, updated_values, opts.extract_options!.merge(on_duplicate_key_update: { conflict_target: :id }, validate: false)
+          end
+
+          setup do
+            Topic.import columns, values, validate: false
+            @topic = Topic.find 100
+          end
+
+          should_update_updated_at_on_timestamp_columns
+        end
+      end
+    end
+  end
+end

data/test/support/shared_examples/on_duplicate_key_update.rb

@@ -0,0 +1,103 @@
+def should_support_basic_on_duplicate_key_update
+  describe "#import" do
+    extend ActiveSupport::TestCase::ImportAssertions
+
+    macro(:perform_import) { raise "supply your own #perform_import in a context below" }
+    macro(:updated_topic) { Topic.find(@topic.id) }
+
+    context "with :on_duplicate_key_update" do
+      describe "argument safety" do
+        it "should not modify the passed in :on_duplicate_key_update columns array" do
+          assert_nothing_raised do
+            columns = %w(title author_name).freeze
+            Topic.import columns, [%w(foo, bar)], on_duplicate_key_update: columns
+          end
+        end
+      end
+
+      context "with validation checks turned off" do
+        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
+
+        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 an empty array" do
+          let(:update_columns) { [] }
+          should_not_update_fields_not_mentioned
+          should_update_updated_at_on_timestamp_columns
+        end
+
+        context "using string column names" do
+          let(:update_columns) { %w(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
+      end
+
+      context "with a table that has a non-standard primary key" do
+        let(:columns) { [:promotion_id, :code] }
+        let(:values) { [[1, 'DISCOUNT1']] }
+        let(:updated_values) { [[1, 'DISCOUNT2']] }
+        let(:update_columns) { [:code] }
+
+        macro(:perform_import) do |*opts|
+          Promotion.import columns, updated_values, opts.extract_options!.merge(on_duplicate_key_update: update_columns, validate: false)
+        end
+        macro(:updated_promotion) { Promotion.find(@promotion.promotion_id) }
+
+        setup do
+          Promotion.import columns, values, validate: false
+          @promotion = Promotion.find 1
+        end
+
+        it "should update specified columns" do
+          perform_import
+          assert_equal 'DISCOUNT2', updated_promotion.code
+        end
+      end
+    end
+
+    context "with :on_duplicate_key_update turned off" do
+      let(:columns) { %w( id title author_name author_email_address parent_id ) }
+      let(:values) { [[100, "Book", "John Doe", "john@doe.com", 17]] }
+      let(:updated_values) { [[100, "Book - 2nd Edition", "This should raise an exception", "john@nogo.com", 57]] }
+
+      macro(:perform_import) do |*opts|
+        # `on_duplicate_key_update: false` is the tested feature
+        Topic.import columns, updated_values, opts.extract_options!.merge(on_duplicate_key_update: false, validate: false)
+      end
+
+      setup do
+        Topic.import columns, values, validate: false
+        @topic = Topic.find 100
+      end
+
+      it "should raise ActiveRecord::RecordNotUnique" do
+        assert_raise ActiveRecord::RecordNotUnique do
+          perform_import
+        end
+      end
+    end
+  end
+end