activerecord-import 1.0.4 → 2.0.0

data/test/import_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('../test_helper', __FILE__)
 
 describe "#import" do
@@ -159,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
 
@@ -169,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
 
@@ -252,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
@@ -395,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
@@ -526,7 +576,11 @@ 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, updated_at: 2.years.ago.utc, updated_on: 2.years.ago.utc)
-        ActiveRecord::Base.default_timezone = :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 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]]
@@ -642,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 }]
 
@@ -679,14 +741,8 @@ describe "#import" do
       ]
       Book.import books
       assert_equal 2, Book.count
-
-      if ENV['AR_VERSION'].to_i >= 5.0
-        assert_equal 'draft', Book.first.read_attribute('status')
-        assert_equal 'published', Book.last.read_attribute('status')
-      else
-        assert_equal 0, Book.first.read_attribute('status')
-        assert_equal 1, Book.last.read_attribute('status')
-      end
+      assert_equal 'draft', Book.first.read_attribute('status')
+      assert_equal 'published', Book.last.read_attribute('status')
     end
 
     it 'should be able to import enum fields with default value' do
@@ -696,32 +752,19 @@ describe "#import" do
       ]
       Book.import books
       assert_equal 1, Book.count
-
-      if ENV['AR_VERSION'].to_i >= 5.0
-        assert_equal 'draft', Book.first.read_attribute('status')
-      else
-        assert_equal 0, Book.first.read_attribute('status')
-      end
+      assert_equal 'draft', Book.first.read_attribute('status')
     end
 
-    if ENV['AR_VERSION'].to_f > 4.1
-      it 'should be able to import enum fields by name' do
-        Book.delete_all if Book.count > 0
-        books = [
-          Book.new(author_name: "Foo", title: "Baz", status: :draft),
-          Book.new(author_name: "Foo2", title: "Baz2", status: :published),
-        ]
-        Book.import books
-        assert_equal 2, Book.count
-
-        if ENV['AR_VERSION'].to_i >= 5.0
-          assert_equal 'draft', Book.first.read_attribute('status')
-          assert_equal 'published', Book.last.read_attribute('status')
-        else
-          assert_equal 0, Book.first.read_attribute('status')
-          assert_equal 1, Book.last.read_attribute('status')
-        end
-      end
+    it 'should be able to import enum fields by name' do
+      Book.delete_all if Book.count > 0
+      books = [
+        Book.new(author_name: "Foo", title: "Baz", status: :draft),
+        Book.new(author_name: "Foo2", title: "Baz2", status: :published),
+      ]
+      Book.import books
+      assert_equal 2, Book.count
+      assert_equal 'draft', Book.first.read_attribute('status')
+      assert_equal 'published', Book.last.read_attribute('status')
     end
   end
 
@@ -734,13 +777,8 @@ describe "#import" do
       Book.import columns, values
       assert_equal 2, Book.count
 
-      if ENV['AR_VERSION'].to_i >= 5.0
-        assert_equal 'draft', Book.first.read_attribute('status')
-        assert_equal 'published', Book.last.read_attribute('status')
-      else
-        assert_equal 0, Book.first.read_attribute('status')
-        assert_equal 1, Book.last.read_attribute('status')
-      end
+      assert_equal 'draft', Book.first.read_attribute('status')
+      assert_equal 'published', Book.last.read_attribute('status')
     end
   end
 
@@ -900,4 +938,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,9 @@
+# frozen_string_literal: true
+
+class Author < ActiveRecord::Base
+  if ENV['AR_VERSION'].to_f >= 8.0
+    has_many :composite_books, foreign_key: [:id, :author_id], inverse_of: :author
+  elsif 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,9 +1,18 @@
+# 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 || ENV['AR_VERSION'].to_f >= 8.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
-  enum status: [:draft, :published] if ENV['AR_VERSION'].to_f >= 4.1
+  if ENV['AR_VERSION'].to_f >= 8.0
+    enum :status, [:draft, :published]
+  else
+    enum status: [:draft, :published]
+  end
 end

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 || ENV['AR_VERSION'].to_f >= 8.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,12 @@
+# frozen_string_literal: true
+
+class CompositeChapter < ActiveRecord::Base
+  if ENV['AR_VERSION'].to_f >= 8.0
+    belongs_to :composite_book, inverse_of: :composite_chapters,
+                                foreign_key: [:composite_book_id, :author_id]
+  elsif 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 || ENV['AR_VERSION'].to_f >= 8.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

data/test/models/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Group < ActiveRecord::Base
   self.table_name = 'group'
 end

data/test/models/order.rb

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

data/test/models/playing_card.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class PlayingCard < ActiveRecord::Base
+end

data/test/models/promotion.rb

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

data/test/models/question.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Question < ActiveRecord::Base
   has_one :rule
 end

data/test/models/rule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Rule < ActiveRecord::Base
   belongs_to :question
 end

data/test/models/tag.rb

@@ -1,4 +1,12 @@
+# frozen_string_literal: true
+
 class Tag < ActiveRecord::Base
-  self.primary_keys = :tag_id, :publisher_id unless ENV["SKIP_COMPOSITE_PK"]
+  if ENV['AR_VERSION'].to_f <= 7.0
+    self.primary_keys = :tag_id, :publisher_id unless ENV["SKIP_COMPOSITE_PK"]
+  else
+    self.primary_key = [:tag_id, :publisher_id] unless ENV["SKIP_COMPOSITE_PK"]
+  end
+  self.primary_key = [:tag_id, :publisher_id] unless ENV["SKIP_COMPOSITE_PK"]
   has_many :books, inverse_of: :tag
+  has_many :tag_aliases, inverse_of: :tag
 end

data/test/models/tag_alias.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class TagAlias < ActiveRecord::Base
+  unless ENV["SKIP_COMPOSITE_PK"]
+    if ENV['AR_VERSION'].to_f <= 7.0 || ENV['AR_VERSION'].to_f >= 8.0
+      belongs_to :tag, foreign_key: [:tag_id, :parent_id], required: true
+    else
+      belongs_to :tag, query_constraints: [:tag_id, :parent_id], required: true
+    end
+  end
+end

data/test/models/topic.rb

@@ -1,4 +1,11 @@
+# frozen_string_literal: true
+
 class Topic < ActiveRecord::Base
+  if ENV['AR_VERSION'].to_f >= 6.0
+    self.ignored_columns = [:priority]
+  end
+  alias_attribute :name, :title
+
   validates_presence_of :author_name
   validates :title, numericality: { only_integer: true }, on: :context_test
   validates :title, uniqueness: true
@@ -9,6 +16,7 @@ class Topic < ActiveRecord::Base
   before_validation -> { errors.add(:title, :invalid) if title == 'invalid' }
 
   has_many :books, inverse_of: :topic
+  has_many :novels, inverse_of: :topic, class_name: "Book"
   belongs_to :parent, class_name: "Topic"
 
   composed_of :description, mapping: [%w(title title), %w(author_name author_name)], allow_nil: true, class_name: "TopicDescription"

data/test/models/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class User < ActiveRecord::Base
   has_many :user_tokens, primary_key: :name, foreign_key: :user_name
 end

data/test/models/user_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UserToken < ActiveRecord::Base
   belongs_to :user, primary_key: :name, foreign_key: :user_name
   validates :user, presence: true

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?
@@ -17,8 +19,15 @@ class Widget < ActiveRecord::Base
 
   default_scope -> { where(active: true) }
 
-  serialize :data, Hash
-  serialize :json_data, JSON
+  if ENV['AR_VERSION'].to_f >= 7.1
+    serialize :data, coder: YAML
+    serialize :json_data, coder: JSON
+    serialize :custom_data, coder: CustomCoder.new
+  else
+    serialize :data, Hash
+    serialize :json_data, JSON
+    serialize :custom_data, CustomCoder.new
+  end
+
   serialize :unspecified_data
-  serialize :custom_data, CustomCoder.new
 end

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