activerecord-import 1.0.2 → 1.7.0

data/test/models/vendor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Vendor < ActiveRecord::Base
   store :preferences, accessors: [:color], coder: JSON
 

data/test/models/widget.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CustomCoder
   def load(value)
     if value.nil?

data/test/mysql2/import_test.rb

@@ -1,5 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
-require File.expand_path(File.dirname(__FILE__) + '/../support/assertions')
-require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/import_examples')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+require File.expand_path("#{File.dirname(__FILE__)}/../support/assertions")
+require File.expand_path("#{File.dirname(__FILE__)}/../support/mysql/import_examples")
 
 should_support_mysql_import_functionality

data/test/mysql2_makara/import_test.rb

@@ -1,6 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+# frozen_string_literal: true
 
-require File.expand_path(File.dirname(__FILE__) + '/../support/assertions')
-require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/import_examples')
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+
+require File.expand_path("#{File.dirname(__FILE__)}/../support/assertions")
+require File.expand_path("#{File.dirname(__FILE__)}/../support/mysql/import_examples")
 
 should_support_mysql_import_functionality

data/test/mysqlspatial2/import_test.rb

@@ -1,6 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+# frozen_string_literal: true
 
-require File.expand_path(File.dirname(__FILE__) + '/../support/assertions')
-require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/import_examples')
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+
+require File.expand_path("#{File.dirname(__FILE__)}/../support/assertions")
+require File.expand_path("#{File.dirname(__FILE__)}/../support/mysql/import_examples")
 
 should_support_mysql_import_functionality

data/test/postgis/import_test.rb

@@ -1,5 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
-require File.expand_path(File.dirname(__FILE__) + '/../support/postgresql/import_examples')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+require File.expand_path("#{File.dirname(__FILE__)}/../support/postgresql/import_examples")
 
 should_support_postgresql_import_functionality
 

data/test/postgresql/import_test.rb

@@ -1,4 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
-require File.expand_path(File.dirname(__FILE__) + '/../support/postgresql/import_examples')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+require File.expand_path("#{File.dirname(__FILE__)}/../support/postgresql/import_examples")
 
 should_support_postgresql_import_functionality

data/test/schema/generic_schema.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 ActiveRecord::Schema.define do
   create_table :schema_info, force: :cascade do |t|
-    t.integer :version, unique: true
+    t.integer :version
   end
+  add_index :schema_info, :version, unique: true
+
   SchemaInfo.create version: SchemaInfo::VERSION
 
   create_table :group, force: :cascade do |t|
@@ -20,6 +24,7 @@ ActiveRecord::Schema.define do
     t.boolean :approved, default: '1'
     t.integer :replies_count
     t.integer :parent_id
+    t.integer :priority, default: 0
     t.string :type
     t.datetime :created_at
     t.datetime :created_on
@@ -52,6 +57,20 @@ ActiveRecord::Schema.define do
     t.string :name
   end
 
+  create_table :cards, force: :cascade do |t|
+    t.string :name
+    t.string :deck_type
+    t.integer :deck_id
+  end
+
+  create_table :decks, force: :cascade do |t|
+    t.string :name
+  end
+
+  create_table :playing_cards, force: :cascade do |t|
+    t.string :name
+  end
+
   create_table :books, force: :cascade do |t|
     t.string :title, null: false
     t.string :publisher, null: false, default: 'Default Publisher'
@@ -190,5 +209,22 @@ ActiveRecord::Schema.define do
           PRIMARY KEY (tag_id, publisher_id)
       );
     ).split.join(' ').strip
+
+    create_table :tag_aliases, force: :cascade do |t|
+      t.integer :tag_id, null: false
+      t.integer :parent_id, null: false
+      t.string :alias, null: false
+    end
+  end
+
+  create_table :customers, force: :cascade do |t|
+    t.integer :account_id
+    t.string :name
+  end
+
+  create_table :orders, force: :cascade do |t|
+    t.integer :account_id
+    t.integer :customer_id
+    t.integer :amount
   end
 end

data/test/schema/jdbcpostgresql_schema.rb

@@ -1 +1,3 @@
-require File.expand_path(File.dirname(__FILE__) + '/postgresql_schema')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/postgresql_schema")

data/test/schema/mysql2_schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ActiveRecord::Schema.define do
   create_table :books, force: :cascade do |t|
     t.string :title, null: false

data/test/schema/postgis_schema.rb

@@ -1 +1,3 @@
-require File.expand_path(File.dirname(__FILE__) + '/postgresql_schema')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/postgresql_schema")

data/test/schema/postgresql_schema.rb

@@ -1,10 +1,21 @@
+# frozen_string_literal: true
+
 ActiveRecord::Schema.define do
   execute('CREATE extension IF NOT EXISTS "hstore";')
   execute('CREATE extension IF NOT EXISTS "pgcrypto";')
   execute('CREATE extension IF NOT EXISTS "uuid-ossp";')
 
+  # create ENUM if it does not exist yet
+  begin
+    execute('CREATE TYPE vendor_type AS ENUM (\'wholesaler\', \'retailer\');')
+  rescue ActiveRecord::StatementInvalid
+    execute('ALTER TYPE vendor_type ADD VALUE IF NOT EXISTS \'wholesaler\';')
+    execute('ALTER TYPE vendor_type ADD VALUE IF NOT EXISTS \'retailer\';')
+  end
+
   create_table :vendors, id: :uuid, force: :cascade do |t|
     t.string :name, null: true
+    t.text :hours
     t.text :preferences
 
     if t.respond_to?(:json)
@@ -29,6 +40,8 @@ ActiveRecord::Schema.define do
       t.text :json_data
     end
 
+    t.column :vendor_type, :vendor_type
+
     t.datetime :created_at
     t.datetime :updated_at
   end
@@ -44,4 +57,38 @@ ActiveRecord::Schema.define do
   end
 
   add_index :alarms, [:device_id, :alarm_type], unique: true, where: 'status <> 0'
+
+  unless ENV["SKIP_COMPOSITE_PK"]
+    create_table :authors, force: :cascade do |t|
+      t.string :name
+    end
+
+    execute %(
+      DROP SEQUENCE IF EXISTS composite_book_id_seq CASCADE;
+      CREATE SEQUENCE composite_book_id_seq
+          AS integer
+          START WITH 1
+          INCREMENT BY 1
+          NO MINVALUE
+          NO MAXVALUE
+          CACHE 1;
+
+      DROP TABLE IF EXISTS composite_books;
+      CREATE TABLE composite_books (
+          id bigint DEFAULT nextval('composite_book_id_seq'::regclass) NOT NULL,
+          title character varying,
+          author_id bigint
+       );
+
+      ALTER TABLE ONLY composite_books ADD CONSTRAINT fk_rails_040a418131 FOREIGN KEY (author_id) REFERENCES authors(id);
+    ).split.join(' ').strip
+  end
+
+  create_table :composite_chapters, force: :cascade do |t|
+    t.string :title
+    t.integer :composite_book_id, null: false
+    t.integer :author_id, null: false
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
 end

data/test/schema/sqlite3_schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ActiveRecord::Schema.define do
   create_table :alarms, force: true do |t|
     t.column :device_id, :integer, null: false

data/test/schema/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SchemaInfo < ActiveRecord::Base
   if respond_to?(:table_name=)
     self.table_name = 'schema_info'

data/test/sqlite3/import_test.rb

@@ -1,4 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
-require File.expand_path(File.dirname(__FILE__) + '/../support/sqlite3/import_examples')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+require File.expand_path("#{File.dirname(__FILE__)}/../support/sqlite3/import_examples")
 
 should_support_sqlite3_import_functionality

data/test/support/active_support/test_case_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ActiveSupport::TestCase
   include ActiveRecord::TestFixtures
 

data/test/support/assertions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ActiveSupport::TestCase
   module ImportAssertions
     def self.extended(klass)

data/test/support/factories.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   sequence(:book_title) { |n| "Book #{n}" }
   sequence(:chapter_title) { |n| "Chapter #{n}" }

data/test/support/generate.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class ActiveSupport::TestCase
-  def Build(*args) # rubocop:disable Style/MethodName
+  def Build(*args) # rubocop:disable Naming/MethodName
     n = args.shift if args.first.is_a?(Numeric)
     factory = args.shift
     factory_bot_args = args.shift || {}
@@ -13,7 +15,7 @@ class ActiveSupport::TestCase
     end
   end
 
-  def Generate(*args) # rubocop:disable Style/MethodName
+  def Generate(*args) # rubocop:disable Naming/MethodName
     n = args.shift if args.first.is_a?(Numeric)
     factory = args.shift
     factory_bot_args = args.shift || {}

data/test/support/mysql/import_examples.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 def should_support_mysql_import_functionality
   # Forcefully disable strict mode for this session.
   ActiveRecord::Base.connection.execute "set sql_mode='STRICT_ALL_TABLES'"

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
 
@@ -102,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 }
@@ -116,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)) }
 
@@ -130,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 }
@@ -159,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
@@ -249,8 +308,19 @@ def should_support_postgresql_import_functionality
     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
@@ -259,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

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,11 +218,39 @@ 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
@@ -304,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