Merge pull request #837 from fragkakis/rails_71_composite_pks

Rails 7.1 composite pks support

.gitignore

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

lib/activerecord-import/import.rb

@@ -941,7 +941,7 @@ def load_association_ids(model)
           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
@@ -996,7 +996,10 @@ def find_associated_objects_for_import(associated_objects_by_class, model)
 
         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

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

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

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

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

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

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

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

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

test/schema/postgresql_schema.rb

@@ -57,4 +57,38 @@
   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

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

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
 

test/test_helper.rb

@@ -33,7 +33,9 @@
 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