activerecord-import 0.27.0 → 1.4.1

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
 
@@ -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
@@ -303,6 +349,27 @@ describe "#import" do
         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
@@ -369,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
@@ -499,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
@@ -532,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
@@ -599,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 }]
 
@@ -857,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,3 +1,5 @@
+# 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')

data/test/jdbcpostgresql/import_test.rb

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

data/test/jdbcsqlite3/import_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 require File.expand_path(File.dirname(__FILE__) + '/../support/sqlite3/import_examples')
 

data/test/makara_postgis/import_test.rb

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

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/bike_maker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bike
   def self.table_name_prefix
     'bike_'

data/test/models/book.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Book < ActiveRecord::Base
   belongs_to :topic, inverse_of: :books
   belongs_to :tag, foreign_key: [:tag_id, :parent_id]

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/customer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Customer < ActiveRecord::Base
+  has_many :orders,
+    inverse_of: :customer,
+    primary_key: %i(account_id id),
+    foreign_key: %i(account_id customer_id)
+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,8 @@
+# frozen_string_literal: true
+
+class Order < ActiveRecord::Base
+  belongs_to :customer,
+    inverse_of: :orders,
+    primary_key: %i(account_id id),
+    foreign_key: %i(account_id customer_id)
+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,7 @@
+# frozen_string_literal: true
+
 class Tag < ActiveRecord::Base
   self.primary_keys = :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,5 @@
+# frozen_string_literal: true
+
+class TagAlias < ActiveRecord::Base
+  belongs_to :tag, foreign_key: [:tag_id, :parent_id], required: true
+end

data/test/models/topic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Topic < ActiveRecord::Base
   validates_presence_of :author_name
   validates :title, numericality: { only_integer: true }, on: :context_test

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,6 @@
+# frozen_string_literal: true
+
 class UserToken < ActiveRecord::Base
   belongs_to :user, primary_key: :name, foreign_key: :user_name
+  validates :user, presence: true
 end

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,3 +1,5 @@
+# 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')

data/test/mysql2_makara/import_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 require File.expand_path(File.dirname(__FILE__) + '/../support/assertions')

data/test/mysqlspatial2/import_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 require File.expand_path(File.dirname(__FILE__) + '/../support/assertions')

data/test/postgis/import_test.rb

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

data/test/postgresql/import_test.rb

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

data/test/schema/generic_schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ActiveRecord::Schema.define do
   create_table :schema_info, force: :cascade do |t|
     t.integer :version, unique: true
@@ -52,6 +54,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 +206,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 @@
+# 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 @@
+# frozen_string_literal: true
+
 require File.expand_path(File.dirname(__FILE__) + '/postgresql_schema')

data/test/schema/postgresql_schema.rb

@@ -1,13 +1,28 @@
+# 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 => e
+    # since PostgreSQL does not support IF NOT EXISTS when creating a TYPE,
+    # rescue the error and check the error class
+    raise unless e.cause.is_a? PG::DuplicateObject
+    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)
+      t.json :pure_json_data
       t.json :data
     else
       t.text :data
@@ -20,6 +35,7 @@ ActiveRecord::Schema.define do
     end
 
     if t.respond_to?(:jsonb)
+      t.jsonb :pure_jsonb_data
       t.jsonb :settings
       t.jsonb :json_data, null: false, default: {}
     else
@@ -27,6 +43,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

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,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 require File.expand_path(File.dirname(__FILE__) + '/../support/sqlite3/import_examples')
 

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'"