composite_primary_keys 13.0.4 → 13.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875a5dc3886b5b887bbcb77bdcb0bfa40ad377e5084fd1bcdf3a71b5c226dbc3
-  data.tar.gz: 9cad15004b91f80917564f623855836217c2ce8e745eb5e6fc47464f10c7cf0c
+  metadata.gz: d0759acf9a94a27e2baafbc5cf15b334f5364b4424120adfcd59a4ed9f783267
+  data.tar.gz: cae92844f0543e33b85b91620d06ab9032cda41c6e9e7ef27bfeec81d1e2027e
 SHA512:
-  metadata.gz: f771c6c4266eb770f685c7fc0960c344c10b7666a24240c59b456afa2c4c52c058e530e8e3d1ddfb4575468eb5eaf30a77b141216820eb028d774fc9f9593326
-  data.tar.gz: 33d2e087cdfc10ea336038a5ffabdb5dd878133ba11ed874ee2d6bd7cf5e572f9acf8b3a996bf04b402c161ffe49d2237ae7284266b58e6eed98b53a890ca7e5
+  metadata.gz: 85d3dfab843abaf4371da5717d5b0962b281e81e9e3294fd2154571bec87d3e46b6852cc36be0de1c8aebec0f892a74c04e49296409d94d842bd18a0e7380534
+  data.tar.gz: 5d31a6dca9bd32215fcdf42c095eee41d6f6f56aef08c2ebda5dfef5d33686636f631542a029636da0dd7c6565bd48f8f99f606d137db532db9544aaee72b790

data/History.rdoc

@@ -1,4 +1,12 @@
-== 13.0.4
+== 13.0.6 (2023-02-04)
+* Fix #577 (Charlie Savage)
+
+== 13.0.5 (2023-02-04)
+* Improve query generation for cpk_in_predicate. This reduces the length of
+queries when loading many keys and enables Postgres to use index scans
+more frequently. (Andrew Kiellor)
+
+== 13.0.4 (2022-12-05)
 * Fix previously_new_record? not being set to true after create
 
 == 13.0.3 (2022-01-09)

data/lib/composite_primary_keys/associations/preloader/association.rb

@@ -33,20 +33,28 @@ module ActiveRecord
           end
         end
 
-        def records_by_owner
-          @records_by_owner ||= preloaded_records.each_with_object({}) do |record, result|
-            key = if association_key_name.is_a?(Array)
-                    Array(record[association_key_name]).map do |key|
-                      convert_key(key)
-                    end
-                  else
-                    convert_key(record[association_key_name])
-                  end
-            owners_by_key[key].each do |owner|
-              (result[owner] ||= []) << record
+        def load_records
+          # owners can be duplicated when a relation has a collection association join
+          # #compare_by_identity makes such owners different hash keys
+          @records_by_owner = {}.compare_by_identity
+          raw_records = owner_keys.empty? ? [] : records_for(owner_keys)
+
+          @preloaded_records = raw_records.select do |record|
+            assignments = false
+
+            owners_by_key[convert_key(record[association_key_name])].each do |owner|
+              entries = (@records_by_owner[owner] ||= [])
+
+              if reflection.collection? || entries.empty?
+                entries << record
+                assignments = true
+              end
             end
+
+            assignments
           end
         end
+
       end
     end
   end

data/lib/composite_primary_keys/composite_predicates.rb

@@ -51,9 +51,59 @@ module CompositePrimaryKeys
     end
 
     def cpk_in_predicate(table, primary_keys, ids)
+      if primary_keys.length == 2
+        cpk_in_predicate_with_grouped_keys(table, primary_keys, ids)
+      else
+        cpk_in_predicate_with_non_grouped_keys(table, primary_keys, ids)
+      end
+    end
+
+    def cpk_in_predicate_with_non_grouped_keys(table, primary_keys, ids)
       and_predicates = ids.map do |id|
         cpk_id_predicate(table, primary_keys, id)
       end
+
+      cpk_or_predicate(and_predicates)
+    end
+
+    def cpk_in_predicate_with_grouped_keys(table, primary_keys, ids)
+      keys_by_first_column_name = Hash.new { |hash, key| hash[key] = [] }
+      keys_by_second_column_name = Hash.new { |hash, key| hash[key] = [] }
+
+      ids.map.each do |first_key_part, second_key_part|
+        keys_by_first_column_name[first_key_part] << second_key_part
+        keys_by_second_column_name[second_key_part] << first_key_part
+      end
+
+      low_cardinality_column_name, high_cardinality_column_name, groups = \
+        if keys_by_first_column_name.size <= keys_by_second_column_name.size
+          [primary_keys.first, primary_keys.second, keys_by_first_column_name]
+        else
+          [primary_keys.second, primary_keys.first, keys_by_second_column_name]
+        end
+
+      and_predicates = groups.map do |low_cardinality_value, high_cardinality_values|
+        non_nil_high_cardinality_values = high_cardinality_values.compact
+        in_clause = table[high_cardinality_column_name].in(non_nil_high_cardinality_values)
+        inclusion_clauses = if non_nil_high_cardinality_values.size != high_cardinality_values.size
+                              Arel::Nodes::Grouping.new(
+                                Arel::Nodes::Or.new(
+                                  in_clause,
+                                  table[high_cardinality_column_name].eq(nil)
+                                )
+                              )
+                            else
+                              in_clause
+                            end
+
+        Arel::Nodes::And.new(
+          [
+            table[low_cardinality_column_name].eq(low_cardinality_value),
+            inclusion_clauses
+          ]
+        )
+      end
+
       cpk_or_predicate(and_predicates)
     end
   end

data/lib/composite_primary_keys/version.rb

@@ -2,7 +2,7 @@ module CompositePrimaryKeys
   module VERSION
     MAJOR = 13
     MINOR = 0
-    TINY  = 4
+    TINY  = 6
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/test/abstract_unit.rb

@@ -1,4 +1,4 @@
-spec_name = ENV['ADAPTER'] || 'sqlite'
+spec_name = ENV['ADAPTER'] || 'postgresql'
 require 'bundler'
 require 'minitest/autorun'
 

data/test/test_bug.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../abstract_unit', __FILE__)
+
+require "bundler/inline"
+
+
+require "minitest/autorun"
+require "logger"
+
+# This connection will do for database-independent bug reports.
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Schema.define do
+  create_table :parents, force: true do |t|
+  end
+
+  create_table :children, id: false, force: true do |t|
+    t.bigint :id
+    t.bigint :parent_id
+  end
+end
+
+class Parent < ActiveRecord::Base
+end
+
+class Child < ActiveRecord::Base
+  belongs_to :parent
+end
+
+class BugTest < Minitest::Test
+  def test_association_stuff
+    p1 = Parent.create!
+    p2 = Parent.create!
+    p3 = Parent.create!
+    Child.create!(id: 100, parent_id: p1.id)
+    Child.create!(id: 100, parent_id: p2.id)
+    Child.create!(id: 100, parent_id: p3.id)
+
+    children = Child.preload(:parent)
+    # if uncomment following line, this test pass
+    # children = Child.all
+    parents = children.map(&:parent)
+    assert_equal [p1.id, p2.id, p3.id], parents.map(&:id)
+  end
+end

data/test/test_predicates.rb

@@ -1,60 +1,130 @@
-require File.expand_path('../abstract_unit', __FILE__)
-
-class TestPredicates < ActiveSupport::TestCase
-  fixtures :departments
-
-  include CompositePrimaryKeys::Predicates
-
-  def test_or
-    dep = Department.arel_table
-
-    predicates = Array.new
-
-    3.times do |i|
-      predicates << dep[:id].eq(i)
-    end
-
-    connection = ActiveRecord::Base.connection
-    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
-    expected = "(#{quoted} = 0 OR #{quoted} = 1 OR #{quoted} = 2)"
-
-    pred = cpk_or_predicate(predicates)
-    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
-  end
-
-  def test_or_with_many_values
-    dep = Arel::Table.new(:departments)
-
-    predicates = Array.new
-
-    number_of_predicates = 3000 # This should really be big
-    number_of_predicates.times do |i|
-      predicates << dep[:id].eq(i)
-    end
-
-    connection = ActiveRecord::Base.connection
-    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
-    expected_ungrouped = ((0...number_of_predicates).map { |i| "#{quoted} = #{i}" }).join(' OR ')
-    expected = "(#{expected_ungrouped})"
-
-    pred = cpk_or_predicate(predicates)
-    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
-  end
-
-  def test_and
-    dep = Department.arel_table
-
-    predicates = Array.new
-
-    3.times do |i|
-      predicates << dep[:id].eq(i)
-    end
-
-    connection = ActiveRecord::Base.connection
-    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
-    expected = "#{quoted} = 0 AND #{quoted} = 1 AND #{quoted} = 2"
-
-    pred = cpk_and_predicate(predicates)
-    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
-  end
-end
+require File.expand_path('../abstract_unit', __FILE__)
+
+class TestPredicates < ActiveSupport::TestCase
+  fixtures :departments
+
+  include CompositePrimaryKeys::Predicates
+
+  def test_or
+    dep = Department.arel_table
+
+    predicates = Array.new
+
+    3.times do |i|
+      predicates << dep[:id].eq(i)
+    end
+
+    connection = ActiveRecord::Base.connection
+    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    expected = "(#{quoted} = 0 OR #{quoted} = 1 OR #{quoted} = 2)"
+
+    pred = cpk_or_predicate(predicates)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_or_with_many_values
+    dep = Arel::Table.new(:departments)
+
+    predicates = Array.new
+
+    number_of_predicates = 3000 # This should really be big
+    number_of_predicates.times do |i|
+      predicates << dep[:id].eq(i)
+    end
+
+    connection = ActiveRecord::Base.connection
+    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    expected_ungrouped = ((0...number_of_predicates).map { |i| "#{quoted} = #{i}" }).join(' OR ')
+    expected = "(#{expected_ungrouped})"
+
+    pred = cpk_or_predicate(predicates)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_and
+    dep = Department.arel_table
+
+    predicates = Array.new
+
+    3.times do |i|
+      predicates << dep[:id].eq(i)
+    end
+
+    connection = ActiveRecord::Base.connection
+    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    expected = "#{quoted} = 0 AND #{quoted} = 1 AND #{quoted} = 2"
+
+    pred = cpk_and_predicate(predicates)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in
+    dep = Department.arel_table
+
+    primary_keys = [[1, 1], [1, 2]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "#{quoted_id_column} = 1 AND #{quoted_location_id_column} IN (1, 2)"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in_with_low_cardinality_second_key_part
+    dep = Department.arel_table
+
+    primary_keys = [[1, 1], [2, 1]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "#{quoted_location_id_column} = 1 AND #{quoted_id_column} IN (1, 2)"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in_with_nil_primary_key_part
+    dep = Department.arel_table
+
+    primary_keys = [[nil, 1], [nil, 2]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "#{quoted_id_column} IS NULL AND #{quoted_location_id_column} IN (1, 2)"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in_with_nil_secondary_key_part
+    dep = Department.arel_table
+
+    primary_keys = [[1, 1], [1, nil]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "#{quoted_id_column} = 1 AND (#{quoted_location_id_column} IN (1) OR #{quoted_location_id_column} IS NULL)"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in_with_multiple_primary_key_parts
+    dep = Department.arel_table
+
+    primary_keys = [[1, 1], [1, 2], [2, 3], [2, 4]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "(#{quoted_id_column} = 1 AND #{quoted_location_id_column} IN (1, 2) OR #{quoted_id_column} = 2 AND #{quoted_location_id_column} IN (3, 4))"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composite_primary_keys
 version: !ruby/object:Gem::Version
-  version: 13.0.4
+  version: 13.0.6
 platform: ruby
 authors:
 - Charlie Savage
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -171,6 +171,7 @@ files:
 - test/test_associations.rb
 - test/test_attribute_methods.rb
 - test/test_attributes.rb
+- test/test_bug.rb
 - test/test_calculations.rb
 - test/test_callbacks.rb
 - test/test_composite_arrays.rb
@@ -216,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Composite key support for ActiveRecord
@@ -226,6 +227,7 @@ test_files:
 - test/test_associations.rb
 - test/test_attribute_methods.rb
 - test/test_attributes.rb
+- test/test_bug.rb
 - test/test_calculations.rb
 - test/test_callbacks.rb
 - test/test_composite_arrays.rb