activerecord-import 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aedb604a103a355bb35e3373239fb12e1e9877cd
-  data.tar.gz: 235a13a5819d9181aaa478686ec42596c54806fe
+  metadata.gz: d4441271287712d8e44b9cac793f2b8b8d315988
+  data.tar.gz: ec27555ffefb8a071bcf3c54b354a8b56b6e68c2
 SHA512:
-  metadata.gz: 8e9349db11dd48246fb292215d4dd43efd2c8fe0c2e544e6fa585d4ad0aa7eb2ba612d8b7a84bbbaf991958b8c7897135314c6e73b4520d05a31861ec68ba5e7
-  data.tar.gz: 58de95004307eb2cfe48d0a6e534313612ed90c69df08e1bdb0372cb065d857189d23fa12552d652d0fbfb4a7ba91cedcba8c7c14c44dfd72c5bff26442bf0bd
+  metadata.gz: fbafbd6476a5f7c3681b26e85e3f4960fb69b6065697a173426392f91f1a89c188dd83b1b16c1639645ba33b8a1fbba97a91dea7e20186692c8ca3e33b9eaf41
+  data.tar.gz: 54f3499be94b3c1b44a99128c39bb9f964e5bcb8da8549dbd66fe5d568a14f195d8b60f2c17a8dab9b5745ba7efb9db58950b433377aee510f4586e1a3cf2074

data/.travis.yml

@@ -17,7 +17,7 @@ env:
 
 matrix:
   include:
-    - rvm: jruby-9.1.9.0
+    - rvm: jruby-9.1.14.0
       env: AR_VERSION=4.2
       before_install:
         - gem update --system

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## Changes in 0.21.0
+
+### New Features
+
+* Allow SQL subqueries (objects that respond to .to_sql) to be passed as values. Thanks
+  to @jalada, @jkowens via \#471
+* Raise an ArgumentError when importing an array of hashes if any of the
+  hash objects have different keys. Thanks to @mbell697 via \#465.
+
+### Fixes
+
+* Fix issue loading incorrect foreign key value when syncing belongs_to
+  associations with custom foreign key columns. Thanks to @marcgreenstock, @jkowens via \#470.
+* Fix issue importing models with polymorphic belongs_to associations.
+  Thanks to @zorab47, @jkowens via \#476.
+* Fix issue importing STI models with ActiveRecord 4.0. Thanks to
+  @kazuki-st, @jkowens via \#478.
+
 ## Changes in 0.20.2
 
 ### Fixes

data/Gemfile

@@ -18,9 +18,9 @@ end
 platforms :jruby do
   gem "jdbc-mysql"
   gem "jdbc-postgres"
-  gem "activerecord-jdbcsqlite3-adapter"
-  gem "activerecord-jdbcmysql-adapter"
-  gem "activerecord-jdbcpostgresql-adapter"
+  gem "activerecord-jdbcsqlite3-adapter",    "~> 1.3"
+  gem "activerecord-jdbcmysql-adapter",      "~> 1.3"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 1.3"
 end
 
 # Support libs

data/gemfiles/5.1.gemfile

@@ -1 +1,2 @@
 gem 'activerecord', '~> 5.1.0'
+gem 'composite_primary_keys', '~> 10.0'

data/lib/activerecord-import/import.rb

@@ -247,6 +247,9 @@ class ActiveRecord::Base
     #  BlogPost.import posts
     #
     #  # Example using array_of_hash_objects
+    #  # NOTE: column_names will be determined by using the keys of the first hash in the array. If later hashes in the
+    #  # array have different keys an exception will be raised. If you have hashes to import with different sets of keys
+    #  # we recommend grouping these into batches before importing.
     #  values = [ {author_name: 'zdennis', title: 'test post'} ], [ {author_name: 'jdoe', title: 'another test post'} ] ]
     #  BlogPost.import values
     #
@@ -470,12 +473,18 @@ class ActiveRecord::Base
         if args.length == 2
           array_of_hashes = args.last
           column_names = args.first.dup
+          allow_extra_hash_keys = true
         else
           array_of_hashes = args.first
           column_names = array_of_hashes.first.keys
+          allow_extra_hash_keys = false
         end
 
         array_of_attributes = array_of_hashes.map do |h|
+          error_message = validate_hash_import(h, column_names, allow_extra_hash_keys)
+
+          raise ArgumentError, error_message if error_message
+
           column_names.map do |key|
             h[key]
           end
@@ -613,7 +622,7 @@ class ActiveRecord::Base
           next if column_names.include?(name_as_sym)
 
           is_sti = (name_as_sym == inheritance_column.to_sym && self < base_class)
-          value = value.first if is_sti
+          value = Array(value).first if is_sti
 
           column_names << name_as_sym
           array_of_attributes.each { |attrs| attrs << value }
@@ -711,10 +720,12 @@ class ActiveRecord::Base
     def load_association_ids(model)
       association_reflections = model.class.reflect_on_all_associations(:belongs_to)
       association_reflections.each do |association_reflection|
+        next if association_reflection.options[:polymorphic]
         association = model.association(association_reflection.name)
         association = association.target
-        if association && association.id
-          model.public_send("#{association_reflection.foreign_key}=", association.id)
+        if association
+          association_primary_key = association_reflection.association_primary_key
+          model.public_send("#{association_reflection.foreign_key}=", association.send(association_primary_key))
         end
       end
     end
@@ -782,6 +793,8 @@ class ActiveRecord::Base
           # be sure to query sequence_name *last*, only if cheaper tests fail, because it's costly
           if val.nil? && column.name == primary_key && !sequence_name.blank?
             connection_memo.next_value_for_sequence(sequence_name)
+          elsif val.respond_to?(:to_sql)
+            "(#{val.to_sql})"
           elsif column
             if respond_to?(:type_caster)                                         # Rails 5.0 and higher
               type = type_for_attribute(column.name)
@@ -846,5 +859,42 @@ class ActiveRecord::Base
     def validations_array_for_column_names_and_attributes( column_names, array_of_attributes ) # :nodoc:
       array_of_attributes.map { |values| Hash[column_names.zip(values)] }
     end
+
+    # Checks that the imported hash has the required_keys, optionally also checks that the hash has
+    # no keys beyond those required when `allow_extra_keys` is false.
+    # returns `nil` if validation passes, or an error message if it fails
+    def validate_hash_import(hash, required_keys, allow_extra_keys) # :nodoc:
+      extra_keys = allow_extra_keys ? [] : hash.keys - required_keys
+      missing_keys = required_keys - hash.keys
+
+      return nil if extra_keys.empty? && missing_keys.empty?
+
+      if allow_extra_keys
+        <<-EOS
+Hash key mis-match.
+
+When importing an array of hashes with provided columns_names, each hash must contain keys for all column_names.
+
+Required keys: #{column_names}
+Missing keys: #{missing_keys}
+
+Hash: #{hash}
+        EOS
+      else
+        <<-EOS
+Hash key mis-match.
+
+When importing an array of hashes, all hashes must have the same keys.
+If you have records that are missing some values, we recommend you either set default values
+for the missing keys or group these records into batches by key set before importing.
+
+Required keys: #{column_names}
+Extra keys: #{extra_keys}
+Missing keys: #{missing_keys}
+
+Hash: #{hash}
+        EOS
+      end
+    end
   end
 end

data/lib/activerecord-import/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Import
-    VERSION = "0.20.2".freeze
+    VERSION = "0.21.0".freeze
   end
 end

data/test/import_test.rb

@@ -86,6 +86,54 @@ describe "#import" do
         assert_nil t.author_email_address
       end
     end
+
+    context "with extra keys" do
+      let(:values) do
+        [
+          { title: "LDAP", author_name: "Jerry Carter" },
+          { title: "Rails Recipes", author_name: "Chad Fowler", author_email_address: "cfowler@test.com" } # author_email_address is unknown
+        ]
+      end
+
+      it "should fail when column names are not specified" do
+        err = assert_raises ArgumentError do
+          Topic.import values, validate: false
+        end
+
+        assert err.message.include? 'Extra keys: [:author_email_address]'
+      end
+
+      it "should succeed when column names are specified" do
+        assert_difference "Topic.count", +2 do
+          Topic.import columns, values, validate: false
+        end
+      end
+    end
+
+    context "with missing keys" do
+      let(:values) do
+        [
+          { title: "LDAP", author_name: "Jerry Carter" },
+          { title: "Rails Recipes" } # author_name is missing
+        ]
+      end
+
+      it "should fail when column names are not specified" do
+        err = assert_raises ArgumentError do
+          Topic.import values, validate: false
+        end
+
+        assert err.message.include? 'Missing keys: [:author_name]'
+      end
+
+      it "should fail on missing hash key from specified column names" do
+        err = assert_raises ArgumentError do
+          Topic.import %i(author_name), values, validate: false
+        end
+
+        assert err.message.include? 'Missing keys: [:author_name]'
+      end
+    end
   end
 
   unless ENV["SKIP_COMPOSITE_PK"]
@@ -545,6 +593,17 @@ describe "#import" do
     end
   end
 
+  context "importing model with polymorphic belongs_to" do
+    it "works without error" do
+      book     = FactoryGirl.create :book
+      discount = Discount.new(discountable: book)
+
+      Discount.import([discount])
+
+      assert_equal 1, Discount.count
+    end
+  end
+
   context 'When importing models with Enum fields' do
     it 'should be able to import enum fields' do
       Book.delete_all if Book.count > 0
@@ -760,5 +819,19 @@ describe "#import" do
         end
       end
     end
+
+    context "with objects that respond to .to_sql as values" do
+      let(:columns) { %w(title author_name) }
+      let(:valid_values) { [["LDAP", Book.select("'Jerry Carter'").limit(1)], ["Rails Recipes", Book.select("'Chad Fowler'").limit(1)]] }
+
+      it "should import data" do
+        assert_difference "Topic.count", +2 do
+          Topic.import! columns, valid_values
+          topics = Topic.all
+          assert_equal "Jerry Carter", topics.first.author_name
+          assert_equal "Chad Fowler", topics.last.author_name
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-import
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.21.0
 platform: ruby
 authors:
 - Zach Dennis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Bulk insert extension for ActiveRecord