activerecord-import 0.25.0 → 1.7.0

data/lib/activerecord-import/mysql2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 warn <<-MSG
 [DEPRECATION] loading activerecord-import via 'require "activerecord-import/<adapter-name>"'
   is deprecated. Update to autorequire using 'require "activerecord-import"'. See

data/lib/activerecord-import/postgresql.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 warn <<-MSG
 [DEPRECATION] loading activerecord-import via 'require "activerecord-import/<adapter-name>"'
   is deprecated. Update to autorequire using 'require "activerecord-import"'. See

data/lib/activerecord-import/sqlite3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 warn <<-MSG
 [DEPRECATION] loading activerecord-import via 'require "activerecord-import/<adapter-name>"'
   is deprecated. Update to autorequire using 'require "activerecord-import"'. See

data/lib/activerecord-import/synchronize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord # :nodoc:
   class Base # :nodoc:
     # Synchronizes the passed in ActiveRecord instances with data
@@ -39,8 +41,8 @@ module ActiveRecord # :nodoc:
 
         next unless matched_instance
 
-        instance.send :clear_aggregation_cache
-        instance.send :clear_association_cache
+        instance.instance_variable_set :@association_cache, {}
+        instance.send :clear_aggregation_cache if instance.respond_to?(:clear_aggregation_cache, true)
         instance.instance_variable_set :@attributes, matched_instance.instance_variable_get(:@attributes)
 
         if instance.respond_to?(:clear_changes_information)

data/lib/activerecord-import/value_sets_parser.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/array'
+
 module ActiveRecord::Import
   class ValueSetTooLargeError < StandardError
     attr_reader :size
+
     def initialize(msg = "Value set exceeds max size", size = 0)
       @size = size
       super(msg)

data/lib/activerecord-import/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Import
-    VERSION = "0.25.0".freeze
+    VERSION = "1.7.0"
   end
 end

data/lib/activerecord-import.rb

@@ -1,4 +1,5 @@
-# rubocop:disable Style/FileName
+# frozen_string_literal: true
+
 require "active_support/lazy_load_hooks"
 
 ActiveSupport.on_load(:active_record) do

data/test/adapters/jdbcmysql.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "jdbcmysql"

data/test/adapters/jdbcpostgresql.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "jdbcpostgresql"

data/test/adapters/jdbcsqlite3.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "jdbcsqlite3"

data/test/adapters/makara_postgis.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "postgis"

data/test/adapters/mysql2.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "mysql2"

data/test/adapters/mysql2_makara.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "mysql2_makara"

data/test/adapters/mysql2spatial.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "mysql2spatial"

data/test/adapters/postgis.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "postgis"

data/test/adapters/postgresql.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "postgresql"

data/test/adapters/postgresql_makara.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "postgresql"

data/test/adapters/seamless_database_pool.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "seamless_database_pool"

data/test/adapters/spatialite.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "spatialite"

data/test/adapters/sqlite3.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ENV["ARE_DB"] = "sqlite3"

data/test/adapters/trilogy.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+ENV["ARE_DB"] = "trilogy"
+
+if ENV['AR_VERSION'].to_f <= 7.0
+  require "activerecord-trilogy-adapter"
+  require "trilogy_adapter/connection"
+  ActiveRecord::Base.extend TrilogyAdapter::Connection
+end

data/test/database.yml.sample

@@ -8,6 +8,7 @@ common: &common
 mysql2: &mysql2
   <<: *common
   adapter: mysql2
+  host: mysql
 
 mysql2spatial:
   <<: *mysql2
@@ -19,6 +20,7 @@ postgresql: &postgresql
   <<: *common
   username: postgres
   adapter: postgresql
+  host: postgresql
   min_messages: warning
 
 postresql_makara:
@@ -50,3 +52,8 @@ sqlite3: &sqlite3
 
 spatialite:
   <<: *sqlite3
+
+trilogy:
+  <<: *common
+  adapter: trilogy
+  host: mysql

data/test/{travis → github}/database.yml

@@ -1,7 +1,8 @@
 common: &common
   username: root
-  password:
+  password: root
   encoding: utf8
+  collation: utf8_general_ci
   host:     localhost
   database: activerecord_import_test
 
@@ -37,6 +38,7 @@ oracle:
 postgresql: &postgresql
   <<: *common
   username: postgres
+  password: postgres
   adapter: postgresql
   min_messages: warning
 
@@ -64,3 +66,7 @@ sqlite3: &sqlite3
 
 spatialite:
   <<: *sqlite3
+
+trilogy:
+  <<: *common
+  adapter: trilogy

data/test/import_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('../test_helper', __FILE__)
 
 describe "#import" do
@@ -17,6 +19,11 @@ describe "#import" do
     assert_equal error.message, "Last argument should be a two dimensional array '[[]]'. First element in array was a String"
   end
 
+  it "warns you that you're passing more data than you ought to" do
+    error = assert_raise(ArgumentError) { Topic.import %w(title author_name), [['Author #1', 'Book #1', 0]] }
+    assert_equal error.message, "Number of values (8) exceeds number of columns (7)"
+  end
+
   it "should not produce an error when importing empty arrays" do
     assert_nothing_raised do
       Topic.import []
@@ -154,6 +161,25 @@ describe "#import" do
           Tag.import columns, values, validate: false
         end
       end
+
+      it "should import models that are required to belong to models with composite primary keys" do
+        tag = Tag.create!(tag_id: 1, publisher_id: 1, tag: 'Mystery')
+        valid_tag_alias = TagAlias.new(tag_id: tag.tag_id, parent_id: tag.publisher_id, alias: 'Detective')
+        invalid_tag_aliases = [
+          TagAlias.new(tag_id: nil, parent_id: nil, alias: 'Detective'),
+          TagAlias.new(tag_id: tag.tag_id, parent_id: nil, alias: 'Detective'),
+          TagAlias.new(tag_id: nil, parent_id: tag.publisher_id, alias: 'Detective'),
+        ]
+
+        assert_difference "TagAlias.count", +1 do
+          TagAlias.import [valid_tag_alias]
+        end
+        invalid_tag_aliases.each do |invalid_tag_alias|
+          assert_no_difference "TagAlias.count" do
+            TagAlias.import [invalid_tag_alias]
+          end
+        end
+      end
     end
   end
 
@@ -164,7 +190,17 @@ describe "#import" do
       assert_difference "Dictionary.count", +1 do
         Dictionary.import dictionaries
       end
-      assert_equal "Dictionary", Dictionary.first.type
+      assert_equal "Dictionary", Dictionary.last.type
+    end
+
+    it "should import arrays successfully" do
+      columns = [:author_name, :title]
+      values =  [["Noah Webster", "Webster's Dictionary"]]
+
+      assert_difference "Dictionary.count", +1 do
+        Dictionary.import columns, values
+      end
+      assert_equal "Dictionary", Dictionary.last.type
     end
   end
 
@@ -210,9 +246,9 @@ describe "#import" do
       end
 
       it "should ignore uniqueness validators" do
-        Topic.import columns, valid_values, validate: true
+        Topic.import columns, valid_values
         assert_difference "Topic.count", +2 do
-          Topic.import columns, valid_values, validate: true
+          Topic.import columns, valid_values
         end
       end
 
@@ -247,6 +283,16 @@ describe "#import" do
         end
       end
 
+      it "should index the failed instances by their poistion in the set if `track_failures` is true" do
+        index_offset = valid_values.length
+        results = Topic.import columns, valid_values + invalid_values, validate: true, track_validation_failures: true
+        assert_equal invalid_values.size, results.failed_instances.size
+        invalid_values.each_with_index do |value_set, index|
+          assert_equal index + index_offset, results.failed_instances[index].first
+          assert_equal value_set.first, results.failed_instances[index].last.title
+        end
+      end
+
       it "should set ids in valid models if adapter supports setting primary key of imported objects" do
         if ActiveRecord::Base.supports_setting_primary_key_of_imported_objects?
           Topic.import (invalid_models + valid_models), validate: true
@@ -294,6 +340,36 @@ describe "#import" do
         end
       end
     end
+
+    context "with uniqueness validators included" do
+      it "should not import duplicate records" do
+        Topic.import columns, valid_values
+        assert_no_difference "Topic.count" do
+          Topic.import columns, valid_values, validate_uniqueness: true
+        end
+      end
+    end
+
+    context "when validatoring presence of belongs_to association" do
+      it "should not import records without foreign key" do
+        assert_no_difference "UserToken.count" do
+          UserToken.import [:token], [['12345abcdef67890']]
+        end
+      end
+
+      it "should import records with foreign key" do
+        assert_difference "UserToken.count", +1 do
+          UserToken.import [:user_name, :token], [%w("Bob", "12345abcdef67890")]
+        end
+      end
+
+      it "should not mutate the defined validations" do
+        UserToken.import [:user_name, :token], [%w("Bob", "12345abcdef67890")]
+        ut = UserToken.new
+        ut.valid?
+        assert_includes ut.errors.messages, :user
+      end
+    end
   end
 
   context "without :validation option" do
@@ -360,6 +436,15 @@ describe "#import" do
         assert_equal 3, result.num_inserts if Topic.supports_import?
       end
     end
+
+    it "should accept and call an optional callable to run after each batch" do
+      lambda_called = 0
+
+      my_proc = ->(_row_count, _batches, _batch, _duration) { lambda_called += 1 }
+      Topic.import Build(10, :topics), batch_size: 4, batch_progress: my_proc
+
+      assert_equal 3, lambda_called
+    end
   end
 
   context "with :synchronize option" do
@@ -490,11 +575,15 @@ describe "#import" do
 
     context "when the timestamps columns are present" do
       setup do
-        @existing_book = Book.create(title: "Fell", author_name: "Curry", publisher: "Bayer", created_at: 2.years.ago.utc, created_on: 2.years.ago.utc)
-        ActiveRecord::Base.default_timezone = :utc
+        @existing_book = Book.create(title: "Fell", author_name: "Curry", publisher: "Bayer", created_at: 2.years.ago.utc, created_on: 2.years.ago.utc, updated_at: 2.years.ago.utc, updated_on: 2.years.ago.utc)
+        if ActiveRecord.respond_to?(:default_timezone)
+          ActiveRecord.default_timezone = :utc
+        else
+          ActiveRecord::Base.default_timezone = :utc
+        end
         Timecop.freeze(time) do
           assert_difference "Book.count", +2 do
-            Book.import %w(title author_name publisher created_at created_on), [["LDAP", "Big Bird", "Del Rey", nil, nil], [@existing_book.title, @existing_book.author_name, @existing_book.publisher, @existing_book.created_at, @existing_book.created_on]]
+            Book.import %w(title author_name publisher created_at created_on updated_at updated_on), [["LDAP", "Big Bird", "Del Rey", nil, nil, nil, nil], [@existing_book.title, @existing_book.author_name, @existing_book.publisher, @existing_book.created_at, @existing_book.created_on, @existing_book.updated_at, @existing_book.updated_on]]
           end
         end
         @new_book, @existing_book = Book.last 2
@@ -523,6 +612,23 @@ describe "#import" do
       it "should set the updated_on column for new records" do
         assert_in_delta time.to_i, @new_book.updated_on.to_i, 1.second
       end
+
+      it "should not set the updated_at column for existing records" do
+        assert_equal 2.years.ago.utc.strftime("%Y:%d"), @existing_book.updated_at.strftime("%Y:%d")
+      end
+
+      it "should not set the updated_on column for existing records" do
+        assert_equal 2.years.ago.utc.strftime("%Y:%d"), @existing_book.updated_on.strftime("%Y:%d")
+      end
+
+      it "should not set the updated_at column on models if changed" do
+        timestamp = Time.now.utc
+        books = [
+          Book.new(author_name: "Foo", title: "Baz", created_at: timestamp, updated_at: timestamp)
+        ]
+        Book.import books
+        assert_equal timestamp.strftime("%Y:%d"), Book.last.updated_at.strftime("%Y:%d")
+      end
     end
 
     context "when a custom time zone is set" do
@@ -567,7 +673,7 @@ describe "#import" do
 
   context "importing through an association scope" do
     { has_many: :chapters, polymorphic: :discounts }.each do |association_type, association|
-      book   = FactoryGirl.create :book
+      book   = FactoryBot.create :book
       scope  = book.public_send association
       klass  = { chapters: Chapter, discounts: Discount }[association]
       column = { chapters: :title,  discounts: :amount  }[association]
@@ -590,6 +696,14 @@ describe "#import" do
           assert_equal [val1, val2], scope.map(&column).sort
         end
 
+        context "for cards and decks" do
+          it "works when the polymorphic name is different than base class name" do
+            deck = Deck.create(id: 1, name: 'test')
+            deck.cards.import [:id, :deck_type], [[1, 'PlayingCard']]
+            assert_equal deck.cards.first.deck_type, "PlayingCard"
+          end
+        end
+
         it "works importing array of hashes" do
           scope.import [{ column => val1 }, { column => val2 }]
 
@@ -609,7 +723,7 @@ describe "#import" do
 
   context "importing model with polymorphic belongs_to" do
     it "works without error" do
-      book     = FactoryGirl.create :book
+      book     = FactoryBot.create :book
       discount = Discount.new(discountable: book)
 
       Discount.import([discount])
@@ -848,4 +962,33 @@ describe "#import" do
       end
     end
   end
+  describe "importing model with after_initialize callback" do
+    let(:columns) { %w(name size) }
+    let(:valid_values) { [%w("Deer", "Small"), %w("Monkey", "Medium")] }
+    let(:invalid_values) do
+      [
+        { name: "giraffe", size: "Large" },
+        { size: "Medium" } # name is missing
+      ]
+    end
+    context "with validation checks turned off" do
+      it "should import valid data" do
+        Animal.import(columns, valid_values, validate: false)
+        assert_equal 2, Animal.count
+      end
+      it "should raise ArgumentError" do
+        assert_raise(ArgumentError) { Animal.import(invalid_values, validate: false) }
+      end
+    end
+
+    context "with validation checks turned on" do
+      it "should import valid data" do
+        Animal.import(columns, valid_values, validate: true)
+        assert_equal 2, Animal.count
+      end
+      it "should raise ArgumentError" do
+        assert_raise(ArgumentError) { Animal.import(invalid_values, validate: true) }
+      end
+    end
+  end
 end

data/test/jdbcmysql/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/jdbcpostgresql/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/jdbcsqlite3/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/makara_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/models/account.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Account < ActiveRecord::Base
   self.locking_column = :lock
 end

data/test/models/alarm.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class Alarm < ActiveRecord::Base
 end

data/test/models/animal.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Animal < ActiveRecord::Base
+  after_initialize :validate_name_presence, if: :new_record?
+  def validate_name_presence
+    raise ArgumentError if name.nil?
+  end
+end

data/test/models/author.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Author < ActiveRecord::Base
+  if ENV['AR_VERSION'].to_f >= 7.1
+    has_many :composite_books, query_constraints: [:id, :author_id], inverse_of: :author
+  end
+end

data/test/models/bike_maker.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Bike
   def self.table_name_prefix
     'bike_'
   end
+
   class Maker < ActiveRecord::Base
   end
 end

data/test/models/book.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 class Book < ActiveRecord::Base
   belongs_to :topic, inverse_of: :books
-  belongs_to :tag, foreign_key: [:tag_id, :parent_id]
-
+  if ENV['AR_VERSION'].to_f <= 7.0
+    belongs_to :tag, foreign_key: [:tag_id, :parent_id] unless ENV["SKIP_COMPOSITE_PK"]
+  else
+    belongs_to :tag, query_constraints: [:tag_id, :parent_id] unless ENV["SKIP_COMPOSITE_PK"]
+  end
   has_many :chapters, inverse_of: :book
   has_many :discounts, as: :discountable
   has_many :end_notes, inverse_of: :book

data/test/models/car.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Car < ActiveRecord::Base
   self.primary_key = :Name
 end

data/test/models/card.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Card < ActiveRecord::Base
+  belongs_to :deck, polymorphic: true
+end

data/test/models/chapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Chapter < ActiveRecord::Base
   belongs_to :book, inverse_of: :chapters
   validates :title, presence: true

data/test/models/composite_book.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class CompositeBook < ActiveRecord::Base
+  self.primary_key = %i[id author_id]
+  belongs_to :author
+  if ENV['AR_VERSION'].to_f <= 7.0
+    unless ENV["SKIP_COMPOSITE_PK"]
+      has_many :composite_chapters, inverse_of: :composite_book,
+                                    foreign_key: [:id, :author_id]
+    end
+  else
+    has_many :composite_chapters, inverse_of: :composite_book,
+                                  query_constraints: [:id, :author_id]
+  end
+
+  def self.sequence_name
+    "composite_book_id_seq"
+  end
+end

data/test/models/composite_chapter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class CompositeChapter < ActiveRecord::Base
+  if ENV['AR_VERSION'].to_f >= 7.1
+    belongs_to :composite_book, inverse_of: :composite_chapters,
+                                query_constraints: [:composite_book_id, :author_id]
+  end
+  validates :title, presence: true
+end

data/test/models/customer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Customer < ActiveRecord::Base
+  unless ENV["SKIP_COMPOSITE_PK"]
+    if ENV['AR_VERSION'].to_f <= 7.0
+      has_many :orders,
+               inverse_of: :customer,
+               primary_key: %i(account_id id),
+               foreign_key: %i(account_id customer_id)
+    else
+      has_many :orders,
+               inverse_of: :customer,
+               primary_key: %i(account_id id),
+               query_constraints: %i(account_id customer_id)
+    end
+
+  end
+end

data/test/models/deck.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Deck < ActiveRecord::Base
+  has_many :cards
+  def self.polymorphic_name
+    "PlayingCard"
+  end
+end

data/test/models/dictionary.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'book'
 
 class Dictionary < Book

data/test/models/discount.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Discount < ActiveRecord::Base
   belongs_to :discountable, polymorphic: true
 end

data/test/models/end_note.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class EndNote < ActiveRecord::Base
   belongs_to :book, inverse_of: :end_notes
   validates :note, presence: true