activerecord-import 0.25.0 → 1.7.0

data/test/support/postgresql/import_examples.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 def should_support_postgresql_import_functionality
   should_support_recursive_import
 
@@ -37,6 +38,12 @@ def should_support_postgresql_import_functionality
         assert !topic.changed?
       end
 
+      if ENV['AR_VERSION'].to_f > 4.1
+        it "moves the dirty changes to previous_changes" do
+          assert topic.previous_changes.present?
+        end
+      end
+
       it "marks models as persisted" do
         assert !topic.new_record?
         assert topic.persisted?
@@ -96,6 +103,8 @@ def should_support_postgresql_import_functionality
           books.first.id.to_s
         end
       end
+      let(:true_returning_value) { ENV['AR_VERSION'].to_f >= 5.0 ? true : 't' }
+      let(:false_returning_value) { ENV['AR_VERSION'].to_f >= 5.0 ? false : 'f' }
 
       it "creates records" do
         assert_difference("Book.count", +1) { result }
@@ -110,6 +119,26 @@ def should_support_postgresql_import_functionality
         assert_equal [%w(King It)], result.results
       end
 
+      context "when given an empty array" do
+        let(:result) { Book.import([], returning: %w(title)) }
+
+        setup { result }
+
+        it "returns empty arrays for ids and results" do
+          assert_equal [], result.ids
+          assert_equal [], result.results
+        end
+      end
+
+      context "when a returning column is a serialized attribute" do
+        let(:vendor) { Vendor.new(hours: { monday: '8-5' }) }
+        let(:result) { Vendor.import([vendor], returning: %w(hours)) }
+
+        it "creates records" do
+          assert_difference("Vendor.count", +1) { result }
+        end
+      end
+
       context "when primary key and returning overlap" do
         let(:result) { Book.import(books, returning: %w(id title)) }
 
@@ -124,6 +153,34 @@ def should_support_postgresql_import_functionality
         end
       end
 
+      context "when returning is raw sql" do
+        let(:result) { Book.import(books, returning: "title, (xmax = '0') AS inserted") }
+
+        setup { result }
+
+        it "returns ids" do
+          assert_equal [book_id], result.ids
+        end
+
+        it "returns specified columns" do
+          assert_equal [['It', true_returning_value]], result.results
+        end
+      end
+
+      context "when returning contains raw sql" do
+        let(:result) { Book.import(books, returning: [:title, "id, (xmax = '0') AS inserted"]) }
+
+        setup { result }
+
+        it "returns ids" do
+          assert_equal [book_id], result.ids
+        end
+
+        it "returns specified columns" do
+          assert_equal [['It', book_id, true_returning_value]], result.results
+        end
+      end
+
       context "setting model attributes" do
         let(:code) { 'abc' }
         let(:discount) { 0.10 }
@@ -153,6 +210,14 @@ def should_support_postgresql_import_functionality
             assert_equal updated_promotion.discount, discount
           end
         end
+
+        context 'returning raw sql' do
+          let(:returning_columns) { [:discount, "(xmax = '0') AS inserted"] }
+
+          it "sets custom model attributes" do
+            assert_equal updated_promotion.inserted, false_returning_value
+          end
+        end
       end
     end
   end
@@ -228,10 +293,34 @@ def should_support_postgresql_import_functionality
         assert_equal({}, Vendor.first.json_data)
       end
     end
+
+    %w(json jsonb).each do |json_type|
+      describe "with pure #{json_type} fields" do
+        let(:data) { { a: :b } }
+        let(:json_field_name) { "pure_#{json_type}_data" }
+        it "imports the values from saved records" do
+          vendor = Vendor.create!(name: 'Vendor 1', json_field_name => data)
+
+          Vendor.import [vendor], on_duplicate_key_update: [json_field_name]
+          assert_equal(data.as_json, vendor.reload[json_field_name])
+        end
+      end
+    end
+  end
+
+  describe "with enum field" do
+    let(:vendor_type) { "retailer" }
+    it "imports the correct values for enum fields" do
+      vendor = Vendor.new(name: 'Vendor 1', vendor_type: vendor_type)
+      assert_difference "Vendor.count", +1 do
+        Vendor.import [vendor]
+      end
+      assert_equal(vendor_type, Vendor.first.vendor_type)
+    end
   end
 
   describe "with binary field" do
-    let(:binary_value) { "\xE0'c\xB2\xB0\xB3Bh\\\xC2M\xB1m\\I\xC4r".force_encoding('ASCII-8BIT') }
+    let(:binary_value) { "\xE0'c\xB2\xB0\xB3Bh\\\xC2M\xB1m\\I\xC4r".dup.force_encoding('ASCII-8BIT') }
     it "imports the correct values for binary fields" do
       alarms = [Alarm.new(device_id: 1, alarm_type: 1, status: 1, secret_key: binary_value)]
       assert_difference "Alarm.count", +1 do
@@ -240,6 +329,42 @@ def should_support_postgresql_import_functionality
       assert_equal(binary_value, Alarm.first.secret_key)
     end
   end
+
+  unless ENV["SKIP_COMPOSITE_PK"]
+    describe "with composite foreign keys" do
+      let(:account_id) { 555 }
+      let(:customer) { Customer.new(account_id: account_id, name: "foo") }
+      let(:order) { Order.new(account_id: account_id, amount: 100, customer: customer) }
+
+      it "imports and correctly maps foreign keys" do
+        assert_difference "Customer.count", +1 do
+          Customer.import [customer]
+        end
+
+        assert_difference "Order.count", +1 do
+          Order.import [order]
+        end
+
+        db_customer = Customer.last
+        db_order = Order.last
+
+        assert_equal db_customer.orders.last, db_order
+        assert_not_equal db_order.customer_id, nil
+      end
+
+      it "should import models with auto-incrementing ID successfully" do
+        author = Author.create!(name: "Foo Barson")
+
+        books = []
+        2.times do |i|
+          books << CompositeBook.new(author_id: author.id, title: "book #{i}")
+        end
+        assert_difference "CompositeBook.count", +2 do
+          CompositeBook.import books
+        end
+      end
+    end
+  end
 end
 
 def should_support_postgresql_upsert_functionality
@@ -295,6 +420,30 @@ def should_support_postgresql_upsert_functionality
       end
 
       context "using a hash" do
+        context "with :columns :all" do
+          let(:columns) { %w( id title author_name author_email_address parent_id ) }
+          let(:updated_values) { [[99, "Book - 2nd Edition", "Jane Doe", "janedoe@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: :all }, validate: false)
+          end
+
+          setup do
+            values = [[99, "Book", "John Doe", "john@doe.com", 17, 3]]
+            Topic.import columns + ['replies_count'], values, validate: false
+          end
+
+          it "should update all specified columns" do
+            perform_import
+            updated_topic = Topic.find(99)
+            assert_equal 'Book - 2nd Edition', updated_topic.title
+            assert_equal 'Jane Doe', updated_topic.author_name
+            assert_equal 'janedoe@example.com', updated_topic.author_email_address
+            assert_equal 57, updated_topic.parent_id
+            assert_equal 3, updated_topic.replies_count
+          end
+        end
+
         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]] }
@@ -312,7 +461,7 @@ def should_support_postgresql_upsert_functionality
           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: columns }
+              Topic.import columns, [%w(foo, bar)], { on_duplicate_key_update: { columns: columns }.freeze }.freeze
             end
           end
 

data/test/support/shared_examples/on_duplicate_key_ignore.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def should_support_on_duplicate_key_ignore
   describe "#import" do
     extend ActiveSupport::TestCase::ImportAssertions

data/test/support/shared_examples/on_duplicate_key_update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def should_support_basic_on_duplicate_key_update
   describe "#import" do
     extend ActiveSupport::TestCase::ImportAssertions
@@ -24,7 +26,7 @@ def should_support_basic_on_duplicate_key_update
           User.import(updated_users, on_duplicate_key_update: [:name])
           assert User.count == updated_users.length
           User.all.each_with_index do |user, i|
-            assert_equal user.name, users[i].name + ' Rothschild'
+            assert_equal user.name, "#{users[i].name} Rothschild"
             assert_equal 1, user.lock_version
           end
         end
@@ -48,7 +50,7 @@ def should_support_basic_on_duplicate_key_update
           User.import(columns, updated_values, on_duplicate_key_update: [:name])
           assert User.count == updated_values.length
           User.all.each_with_index do |user, i|
-            assert_equal user.name, users[i].name + ' Rothschild'
+            assert_equal user.name, "#{users[i].name} Rothschild"
             assert_equal 1, user.lock_version
           end
         end
@@ -70,9 +72,19 @@ def should_support_basic_on_duplicate_key_update
           User.import(updated_values, on_duplicate_key_update: [:name])
           assert User.count == updated_values.length
           User.all.each_with_index do |user, i|
-            assert_equal user.name, users[i].name + ' Rothschild'
+            assert_equal user.name, "#{users[i].name} Rothschild"
             assert_equal 1, user.lock_version
           end
+          updated_values2 = User.all.map do |user|
+            user.name += ' jr.'
+            { id: user.id, name: user.name }
+          end
+          User.import(updated_values2, on_duplicate_key_update: [:name])
+          assert User.count == updated_values2.length
+          User.all.each_with_index do |user, i|
+            assert_equal user.name, "#{users[i].name} Rothschild jr."
+            assert_equal 2, user.lock_version
+          end
         end
 
         it 'upsert optimistic lock columns other than lock_version by model' do
@@ -92,7 +104,7 @@ def should_support_basic_on_duplicate_key_update
           Account.import(updated_accounts, on_duplicate_key_update: [:id, :name])
           assert Account.count == updated_accounts.length
           Account.all.each_with_index do |user, i|
-            assert_equal user.name, accounts[i].name + ' Rothschild'
+            assert_equal user.name, "#{accounts[i].name} Rothschild"
             assert_equal 1, user.lock
           end
         end
@@ -116,7 +128,7 @@ def should_support_basic_on_duplicate_key_update
           Account.import(columns, updated_values, on_duplicate_key_update: [:name])
           assert Account.count == updated_values.length
           Account.all.each_with_index do |user, i|
-            assert_equal user.name, accounts[i].name + ' Rothschild'
+            assert_equal user.name, "#{accounts[i].name} Rothschild"
             assert_equal 1, user.lock
           end
         end
@@ -138,7 +150,7 @@ def should_support_basic_on_duplicate_key_update
           Account.import(updated_values, on_duplicate_key_update: [:name])
           assert Account.count == updated_values.length
           Account.all.each_with_index do |user, i|
-            assert_equal user.name, accounts[i].name + ' Rothschild'
+            assert_equal user.name, "#{accounts[i].name} Rothschild"
             assert_equal 1, user.lock
           end
         end
@@ -160,10 +172,11 @@ def should_support_basic_on_duplicate_key_update
           Bike::Maker.import(updated_makers, on_duplicate_key_update: [:name])
           assert Bike::Maker.count == updated_makers.length
           Bike::Maker.all.each_with_index do |maker, i|
-            assert_equal maker.name, makers[i].name + ' bikes'
+            assert_equal maker.name, "#{makers[i].name} bikes"
             assert_equal 1, maker.lock_version
           end
         end
+
         it 'update the lock_version of models separated by namespaces by array' do
           makers = [
             Bike::Maker.new(name: 'Yamaha'),
@@ -183,7 +196,7 @@ def should_support_basic_on_duplicate_key_update
           Bike::Maker.import(columns, updated_values, on_duplicate_key_update: [:name])
           assert Bike::Maker.count == updated_values.length
           Bike::Maker.all.each_with_index do |maker, i|
-            assert_equal maker.name, makers[i].name + ' bikes'
+            assert_equal maker.name, "#{makers[i].name} bikes"
             assert_equal 1, maker.lock_version
           end
         end
@@ -205,14 +218,66 @@ def should_support_basic_on_duplicate_key_update
           Bike::Maker.import(updated_values, on_duplicate_key_update: [:name])
           assert Bike::Maker.count == updated_values.length
           Bike::Maker.all.each_with_index do |maker, i|
-            assert_equal maker.name, makers[i].name + ' bikes'
+            assert_equal maker.name, "#{makers[i].name} bikes"
             assert_equal 1, maker.lock_version
           end
         end
       end
+
+      context 'with locking disabled' do
+        it 'does not update the lock_version' do
+          users = [
+            User.new(name: 'Salomon'),
+            User.new(name: 'Nathan')
+          ]
+          User.import(users)
+          assert User.count == users.length
+          User.all.each do |user|
+            assert_equal 0, user.lock_version
+          end
+          updated_users = User.all.map do |user|
+            user.name += ' Rothschild'
+            user
+          end
+
+          ActiveRecord::Base.lock_optimistically = false # Disable locking
+          User.import(updated_users, on_duplicate_key_update: [:name])
+          ActiveRecord::Base.lock_optimistically = true # Enable locking
+
+          assert User.count == updated_users.length
+          User.all.each_with_index do |user, i|
+            assert_equal user.name, "#{users[i].name} Rothschild"
+            assert_equal 0, user.lock_version
+          end
+        end
+      end
     end
 
     context "with :on_duplicate_key_update" do
+      describe 'using :all' do
+        let(:columns) { %w( id title author_name author_email_address parent_id ) }
+        let(:updated_values) { [[99, "Book - 2nd Edition", "Jane Doe", "janedoe@example.com", 57]] }
+
+        macro(:perform_import) do |*opts|
+          Topic.import columns, updated_values, opts.extract_options!.merge(on_duplicate_key_update: :all, validate: false)
+        end
+
+        setup do
+          values = [[99, "Book", "John Doe", "john@doe.com", 17, 3]]
+          Topic.import columns + ['replies_count'], values, validate: false
+        end
+
+        it 'updates all specified columns' do
+          perform_import
+          updated_topic = Topic.find(99)
+          assert_equal 'Book - 2nd Edition', updated_topic.title
+          assert_equal 'Jane Doe', updated_topic.author_name
+          assert_equal 'janedoe@example.com', updated_topic.author_email_address
+          assert_equal 57, updated_topic.parent_id
+          assert_equal 3, updated_topic.replies_count
+        end
+      end
+
       describe "argument safety" do
         it "should not modify the passed in :on_duplicate_key_update array" do
           assert_nothing_raised do
@@ -222,6 +287,26 @@ def should_support_basic_on_duplicate_key_update
         end
       end
 
+      context "with timestamps enabled" do
+        let(:time) { Chronic.parse("5 minutes from now") }
+
+        it 'should not overwrite changed updated_at with current timestamp' do
+          topic = Topic.create(author_name: "Jane Doe", title: "Book")
+          timestamp = Time.now.utc
+          topic.updated_at = timestamp
+          Topic.import [topic], on_duplicate_key_update: :all, validate: false
+          assert_equal timestamp.to_s, Topic.last.updated_at.to_s
+        end
+
+        it 'should update updated_at with current timestamp' do
+          topic = Topic.create(author_name: "Jane Doe", title: "Book")
+          Timecop.freeze(time) do
+            Topic.import [topic], on_duplicate_key_update: [:updated_at], validate: false
+            assert_in_delta time.to_i, topic.reload.updated_at.to_i, 1.second
+          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
@@ -260,6 +345,34 @@ def should_support_basic_on_duplicate_key_update
           should_support_on_duplicate_key_update
           should_update_fields_mentioned
         end
+
+        context "using column aliases" do
+          let(:columns) { %w( id title author_name author_email_address parent_id ) }
+          let(:update_columns) { %w(title author_email_address parent_id) }
+
+          context "with column aliases in column list" do
+            let(:columns) { %w( id name author_name author_email_address parent_id ) }
+            should_support_on_duplicate_key_update
+            should_update_fields_mentioned
+          end
+
+          context "with column aliases in update columns list" do
+            let(:update_columns) { %w(name author_email_address parent_id) }
+            should_support_on_duplicate_key_update
+            should_update_fields_mentioned
+          end
+        end
+
+        if ENV['AR_VERSION'].to_i >= 6.0
+          context "using ignored columns" do
+            let(:columns) { %w( id title author_name author_email_address parent_id priority ) }
+            let(:values) { [[99, "Book", "John Doe", "john@doe.com", 17, 1]] }
+            let(:update_columns) { %w(name author_email_address parent_id priority) }
+            let(:updated_values) { [[99, "Book - 2nd Edition", "Author Should Not Change", "johndoe@example.com", 57, 2]] }
+            should_support_on_duplicate_key_update
+            should_update_fields_mentioned
+          end
+        end
       end
 
       context "with a table that has a non-standard primary key" do

data/test/support/shared_examples/recursive_import.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def should_support_recursive_import
   describe "importing objects with associations" do
     let(:new_topics) { Build(num_topics, :topic_with_book) }
@@ -11,7 +13,7 @@ def should_support_recursive_import
     let(:num_chapters) { 18 }
     let(:num_endnotes) { 24 }
 
-    let(:new_question_with_rule) { FactoryGirl.build :question, :with_rule }
+    let(:new_question_with_rule) { FactoryBot.build :question, :with_rule }
 
     it 'imports top level' do
       assert_difference "Topic.count", +num_topics do
@@ -138,6 +140,15 @@ def should_support_recursive_import
       books.each do |book|
         assert_equal book.topic_id, second_new_topic.id
       end
+
+      books.each { |book| book.topic_id = nil }
+      assert_no_difference "Book.count", books.size do
+        Book.import books, validate: false, on_duplicate_key_update: [:topic_id]
+      end
+
+      books.each do |book|
+        assert_nil book.topic_id, nil
+      end
     end
 
     unless ENV["SKIP_COMPOSITE_PK"]
@@ -154,6 +165,24 @@ def should_support_recursive_import
           assert_equal 1, tags[0].tag_id
           assert_equal 2, tags[1].tag_id
         end
+
+        if ENV['AR_VERSION'].to_f >= 7.1
+          it "should import models with auto-incrementing ID successfully with recursive set to true" do
+            author = Author.create!(name: "Foo Barson")
+            books = []
+            2.times do |i|
+              books << CompositeBook.new(author_id: author.id, title: "Book #{i}", composite_chapters: [
+                                           CompositeChapter.new(title: "Book #{i} composite chapter 1"),
+                                           CompositeChapter.new(title: "Book #{i} composite chapter 2"),
+                                         ])
+            end
+            assert_difference "CompositeBook.count", +2 do
+              assert_difference "CompositeChapter.count", +4 do
+                CompositeBook.import books, recursive: true
+              end
+            end
+          end
+        end
       end
     end
 
@@ -167,7 +196,7 @@ def should_support_recursive_import
       end
     end
 
-    # If adapter supports on_duplicate_key_update, it is only applied to top level models so that SQL with invalid
+    # If adapter supports on_duplicate_key_update and specific columns are specified, it is only applied to top level models so that SQL with invalid
     # columns, keys, etc isn't generated for child associations when doing recursive import
     if ActiveRecord::Base.connection.supports_on_duplicate_key_update?
       describe "on_duplicate_key_update" do
@@ -181,6 +210,103 @@ def should_support_recursive_import
             end
           end
         end
+
+        context "when :all fields are updated" do
+          setup do
+            Topic.import new_topics, recursive: true
+          end
+
+          it "updates associated objects" do
+            new_author_name = 'Richard Bachman'
+            topic = new_topics.first
+            topic.books.each do |book|
+              book.author_name = new_author_name
+            end
+            assert_nothing_raised do
+              Topic.import new_topics, recursive: true, on_duplicate_key_update: :all
+            end
+            Topic.find(topic.id).books.each do |book|
+              assert_equal new_author_name, book.author_name
+            end
+          end
+        end
+      end
+
+      describe "recursive_on_duplicate_key_update" do
+        let(:new_topics) { Build(1, :topic_with_book) }
+
+        setup do
+          Topic.import new_topics, recursive: true
+        end
+
+        it "updates associated objects" do
+          new_author_name = 'Richard Bachman'
+          topic = new_topics.first
+          topic.books.each do |book|
+            book.author_name = new_author_name
+          end
+
+          assert_nothing_raised do
+            Topic.import new_topics,
+              recursive: true,
+              on_duplicate_key_update: [:id],
+              recursive_on_duplicate_key_update: {
+                books: { conflict_target: [:id], columns: [:author_name] }
+              }
+          end
+          Topic.find(topic.id).books.each do |book|
+            assert_equal new_author_name, book.author_name
+          end
+        end
+
+        it "updates nested associated objects" do
+          new_chapter_title = 'The Final Chapter'
+          book = new_topics.first.books.first
+          book.author_name = 'Richard Bachman'
+
+          example_chapter = book.chapters.first
+          example_chapter.title = new_chapter_title
+
+          assert_nothing_raised do
+            Topic.import new_topics,
+              recursive: true,
+              on_duplicate_key_update: [:id],
+              recursive_on_duplicate_key_update: {
+                books: { conflict_target: [:id], columns: [:author_name] },
+                chapters: { conflict_target: [:id], columns: [:title] }
+              }
+          end
+          assert_equal new_chapter_title, Chapter.find(example_chapter.id).title
+        end
+      end
+    end
+
+    # If returning option is provided, it is only applied to top level models so that SQL with invalid
+    # columns, keys, etc isn't generated for child associations when doing recursive import
+    describe "returning" do
+      let(:new_topics) { Build(1, :topic_with_book) }
+
+      it "imports objects with associations" do
+        assert_difference "Topic.count", +1 do
+          Topic.import new_topics, recursive: true, returning: [:content], validate: false
+          new_topics.each do |topic|
+            assert_not_nil topic.id
+          end
+        end
+      end
+    end
+
+    # If no returning option is provided, it is ignored
+    describe "no returning" do
+      let(:new_topics) { Build(1, :topic_with_book) }
+
+      it "is ignored and imports objects with associations" do
+        assert_difference "Topic.count", +1 do
+          Topic.import new_topics, recursive: true, no_returning: true, validate: false
+          new_topics.each do |topic|
+            assert_not_nil topic.id
+          end
+        end
       end
     end
   end