activerecord-import 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32b6a19035fc43e21eeb0c6750e622a2605daf865b05aa9d551a697768456595
-  data.tar.gz: 7ba72ad6b48a05f52299bf6a49a487c880c82beacda25c6d6d6510a2d87bdf47
+  metadata.gz: 5aeed63fcbc9ad647ab901931265d2765baf5d0e5a1e9d2cf2c68af32dd5e1be
+  data.tar.gz: 47480cc7244aada4bc69ba28043e8ab85ae1cece4420db4453400425a5773126
 SHA512:
-  metadata.gz: ac0cb801e0c0883ec3f09432cb500c919fda756c22b6a4fb29bf3e0ecb3ce0aa0a8700e1112ff9340c9f5f7cdb756618eeba5dcae1ce06602216d21c82506ae4
-  data.tar.gz: 572f5ea800559cb5fa928d1c82f4e1ef03edac7d1bed5e4bb2849423fdd8fc01bf235f829ef2ab1d230de8832e0d078615e60fc8feb8a48a92f74bb94e7b23a9
+  metadata.gz: 5f6b5749dd6ce81784f7016c6227a6d0f5047c59a45beb13616853a89599ac507241012a92c3e4f9996c7a465d4d926e0e8d1183af1854f7a0c8a05e2e59219f
+  data.tar.gz: 72b00e7a5c61af3923b618ebe0d96f945a7af145f38ec5312962220b925e1dfc918da6028bb48d8ff7842c32584b34b06cec8fd8288dbb83212ca035f7a16c08

data/.github/workflows/test.yaml

@@ -34,7 +34,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 3.2
+          - 3.3
         env:
           - AR_VERSION: '7.1'
             RUBYOPT: --enable-frozen-string-literal
@@ -43,6 +43,15 @@ jobs:
           - AR_VERSION: 6.1
             RUBYOPT: --enable-frozen-string-literal
         include:
+          - ruby: 3.2
+            env:
+              AR_VERSION: '7.1'
+          - ruby: 3.2
+            env:
+              AR_VERSION: '7.0'
+          - ruby: 3.2
+            env:
+              AR_VERSION: 6.1
           - ruby: 3.1
             env:
               AR_VERSION: '7.1'
@@ -126,7 +135,7 @@ jobs:
           bundle exec rake test:spatialite
           bundle exec rake test:sqlite3
       - name: Run trilogy tests
-        if: ${{ matrix.env.AR_VERSION >= '7.0' && matrix.ruby != 'jruby' }}
+        if: ${{ matrix.env.AR_VERSION >= '7.0' && !startsWith(matrix.ruby, 'jruby') }}
         run: bundle exec rake test:trilogy
   lint:
     runs-on: ubuntu-latest

data/.gitignore

@@ -13,12 +13,16 @@ tmtags
 ## VIM
 *.swp
 
+## Idea
+.idea
+
 ## PROJECT::GENERAL
 coverage
 rdoc
 pkg
 *.gem
 *.lock
+.byebug_history
 
 ## PROJECT::SPECIFIC
 log/*.log

data/.rubocop_todo.yml

@@ -24,3 +24,7 @@ Lint/UnusedMethodArgument:
 Style/CombinableLoops:
   Exclude:
     - 'test/support/shared_examples/recursive_import.rb'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/activerecord-import.rb'

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Changes in 1.7.0
+
+### New Features
+
+* Add support for ActiveRecord 7.1 composite primary keys. Thanks to @fragkakis via \##837.
+* Add support for upserting associations when doing recursive imports. Thanks to @ramblex via \##778.
+
 ## Changes in 1.6.0
 
 ### New Features

data/README.markdown

@@ -265,7 +265,7 @@ Book.import books, recursive: true
 Key                       | Options               | Default            | Description
 ------------------------- | --------------------- | ------------------ | -----------
 :validate                 | `true`/`false`        | `true`             | Whether or not to run `ActiveRecord` validations (uniqueness skipped). This option will always be true when using `import!`.
-:validate_uniqueness      | `true`/`false`        | `false`            | Whether or not to run uniqueness validations, has potential pitfalls, use with caution (requires `>= v0.27.0`).
+:validate_uniqueness      | `true`/`false`        | `false`            | Whether or not to run ActiveRecord uniqueness validations. Beware this will incur an sql query per-record (N+1 queries). (requires `>= v0.27.0`).
 :validate_with_context    | `Symbol`              |`:create`/`:update` | Allows passing an ActiveModel validation context for each model. Default is `:create` for new records and `:update` for existing ones.
 :track_validation_failures| `true`/`false`        | `false`            | When this is set to true, `failed_instances` will be an array of arrays, with each inner array having the form `[:index_in_dataset, :object_with_errors]`
 :on_duplicate_key_ignore  | `true`/`false`        | `false`            | Allows skipping records with duplicate keys. See [here](#duplicate-key-ignore) for more details.
@@ -274,6 +274,7 @@ Key                       | Options               | Default            | Descrip
 :synchronize              | `Array`               | N/A                | An array of ActiveRecord instances. This synchronizes existing instances in memory with updates from the import.
 :timestamps               | `true`/`false`        | `true`             | Enables/disables timestamps on imported records.
 :recursive                | `true`/`false`        | `false`            | Imports has_many/has_one associations (PostgreSQL only).
+:recursive_on_duplicate_key_update | `Hash`       | N/A                | Allows upsert logic to be used for recursive associations. The hash key is the association name and the value has the same options as `:on_duplicate_key_update`. See [here](#duplicate-key-update) for more details.
 :batch_size               | `Integer`             | total # of records | Max number of records to insert per import
 :raise_error              | `true`/`false`        | `false`            | Raises an exception at the first invalid record. This means there will not be a result object returned. The `import!` method is a shortcut for this.
 :all_or_none              | `true`/`false`        | `false`            | Will not import any records if there is a record with validation errors.

data/lib/activerecord-import/import.rb

@@ -857,6 +857,15 @@ class ActiveRecord::Base
 
     private
 
+    def associated_options(options, associated_class)
+      return options unless options.key?(:recursive_on_duplicate_key_update)
+
+      table_name = associated_class.arel_table.name.to_sym
+      options.merge(
+        on_duplicate_key_update: options[:recursive_on_duplicate_key_update][table_name]
+      )
+    end
+
     def set_attributes_and_mark_clean(models, import_result, timestamps, options)
       return if models.nil?
       models -= import_result.failed_instances
@@ -941,7 +950,7 @@ class ActiveRecord::Base
           association = association.target
           next if association.blank? || model.public_send(column_name).present?
 
-          association_primary_key = Array(association_reflection.association_primary_key)[column_index]
+          association_primary_key = Array(association_reflection.association_primary_key.tr("[]:", "").split(", "))[column_index]
           model.public_send("#{column_name}=", association.send(association_primary_key))
         end
       end
@@ -963,7 +972,11 @@ class ActiveRecord::Base
 
       associated_objects_by_class.each_value do |associations|
         associations.each_value do |associated_records|
-          associated_records.first.class.bulk_import(associated_records, options) unless associated_records.empty?
+          next if associated_records.empty?
+
+          associated_class = associated_records.first.class
+          associated_class.bulk_import(associated_records,
+                                       associated_options(options, associated_class))
         end
       end
     end
@@ -996,7 +1009,10 @@ class ActiveRecord::Base
 
         changed_objects = association.select { |a| a.new_record? || a.changed? }
         changed_objects.each do |child|
-          child.public_send("#{association_reflection.foreign_key}=", model.id)
+          Array(association_reflection.inverse_of&.foreign_key || association_reflection.foreign_key).each_with_index do |column, index|
+            child.public_send("#{column}=", Array(model.id)[index])
+          end
+
           # For polymorphic associations
           association_name = if model.class.respond_to?(:polymorphic_name)
             model.class.polymorphic_name

data/lib/activerecord-import/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Import
-    VERSION = "1.6.0"
+    VERSION = "1.7.0"
   end
 end

data/lib/activerecord-import.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Naming/FileName
 # frozen_string_literal: true
 
 require "active_support/lazy_load_hooks"

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

@@ -2,8 +2,11 @@
 
 class Book < ActiveRecord::Base
   belongs_to :topic, inverse_of: :books
-  belongs_to :tag, foreign_key: [:tag_id, :parent_id] unless ENV["SKIP_COMPOSITE_PK"]
-
+  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/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

@@ -2,9 +2,17 @@
 
 class Customer < ActiveRecord::Base
   unless ENV["SKIP_COMPOSITE_PK"]
-    has_many :orders,
-      inverse_of: :customer,
-      primary_key: %i(account_id id),
-      foreign_key: %i(account_id customer_id)
+    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/order.rb

@@ -2,9 +2,16 @@
 
 class Order < ActiveRecord::Base
   unless ENV["SKIP_COMPOSITE_PK"]
-    belongs_to :customer,
-      inverse_of: :orders,
-      primary_key: %i(account_id id),
-      foreign_key: %i(account_id customer_id)
+    if ENV['AR_VERSION'].to_f <= 7.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/tag.rb

@@ -1,7 +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

@@ -2,6 +2,10 @@
 
 class TagAlias < ActiveRecord::Base
   unless ENV["SKIP_COMPOSITE_PK"]
-    belongs_to :tag, foreign_key: [:tag_id, :parent_id], required: true
+    if ENV['AR_VERSION'].to_f <= 7.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/schema/postgresql_schema.rb

@@ -57,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/support/postgresql/import_examples.rb

@@ -351,6 +351,18 @@ def should_support_postgresql_import_functionality
         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

data/test/support/shared_examples/recursive_import.rb

@@ -165,6 +165,24 @@ def should_support_recursive_import
           assert_equal 1, tags[0].tag_id
           assert_equal 2, tags[1].tag_id
         end
+
+        if ENV['AR_VERSION'].to_f >= 7.1
+          it "should import models with auto-incrementing ID successfully with recursive set to true" do
+            author = Author.create!(name: "Foo Barson")
+            books = []
+            2.times do |i|
+              books << CompositeBook.new(author_id: author.id, title: "Book #{i}", composite_chapters: [
+                                           CompositeChapter.new(title: "Book #{i} composite chapter 1"),
+                                           CompositeChapter.new(title: "Book #{i} composite chapter 2"),
+                                         ])
+            end
+            assert_difference "CompositeBook.count", +2 do
+              assert_difference "CompositeChapter.count", +4 do
+                CompositeBook.import books, recursive: true
+              end
+            end
+          end
+        end
       end
     end
 
@@ -213,6 +231,54 @@ def should_support_recursive_import
           end
         end
       end
+
+      describe "recursive_on_duplicate_key_update" do
+        let(:new_topics) { Build(1, :topic_with_book) }
+
+        setup do
+          Topic.import new_topics, recursive: true
+        end
+
+        it "updates associated objects" do
+          new_author_name = 'Richard Bachman'
+          topic = new_topics.first
+          topic.books.each do |book|
+            book.author_name = new_author_name
+          end
+
+          assert_nothing_raised do
+            Topic.import new_topics,
+              recursive: true,
+              on_duplicate_key_update: [:id],
+              recursive_on_duplicate_key_update: {
+                books: { conflict_target: [:id], columns: [:author_name] }
+              }
+          end
+          Topic.find(topic.id).books.each do |book|
+            assert_equal new_author_name, book.author_name
+          end
+        end
+
+        it "updates nested associated objects" do
+          new_chapter_title = 'The Final Chapter'
+          book = new_topics.first.books.first
+          book.author_name = 'Richard Bachman'
+
+          example_chapter = book.chapters.first
+          example_chapter.title = new_chapter_title
+
+          assert_nothing_raised do
+            Topic.import new_topics,
+              recursive: true,
+              on_duplicate_key_update: [:id],
+              recursive_on_duplicate_key_update: {
+                books: { conflict_target: [:id], columns: [:author_name] },
+                chapters: { conflict_target: [:id], columns: [:title] }
+              }
+          end
+          assert_equal new_chapter_title, Chapter.find(example_chapter.id).title
+        end
+      end
     end
 
     # If returning option is provided, it is only applied to top level models so that SQL with invalid

data/test/test_helper.rb

@@ -33,7 +33,9 @@ require 'chronic'
 begin
   require 'composite_primary_keys'
 rescue LoadError
-  ENV["SKIP_COMPOSITE_PK"] = "true"
+  if ENV['AR_VERSION'].to_f <= 7.1
+    ENV['SKIP_COMPOSITE_PK'] = 'true'
+  end
 end
 
 # Support MySQL 5.7

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-import
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Zach Dennis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -127,11 +127,14 @@ files:
 - test/models/account.rb
 - test/models/alarm.rb
 - test/models/animal.rb
+- test/models/author.rb
 - test/models/bike_maker.rb
 - test/models/book.rb
 - test/models/car.rb
 - test/models/card.rb
 - test/models/chapter.rb
+- test/models/composite_book.rb
+- test/models/composite_chapter.rb
 - test/models/customer.rb
 - test/models/deck.rb
 - test/models/dictionary.rb
@@ -226,11 +229,14 @@ test_files:
 - test/models/account.rb
 - test/models/alarm.rb
 - test/models/animal.rb
+- test/models/author.rb
 - test/models/bike_maker.rb
 - test/models/book.rb
 - test/models/car.rb
 - test/models/card.rb
 - test/models/chapter.rb
+- test/models/composite_book.rb
+- test/models/composite_chapter.rb
 - test/models/customer.rb
 - test/models/deck.rb
 - test/models/dictionary.rb