composite_primary_keys 14.0.4 → 14.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7f4289f2367e4fc8315bd9055e077e7daa2f3ca842bbb1c40e5755241379416
-  data.tar.gz: 5f247da837ba1da9f64ba23efaa9cbe9aade3f12f2f9c879736106b9c14570ff
+  metadata.gz: 4feff3a4f8ce272695c7a081666b99f3e9b79b206dce5acf9728c0c2c0cb2d9a
+  data.tar.gz: f5d7533a624427d056ad9fd7576242a2b6318ed584939bea834de44bd8d618af
 SHA512:
-  metadata.gz: 01fc103302338a90c5b914e3da13fab9bfa4ca1a8d37a5f182de3755e3893321094fc018dbda672351a43cda77a0c73ef00cb7a63adeafe5b8688335f26fed64
-  data.tar.gz: fb900706022a8d2ccfb4169e18292c6e412c9d20b1ccea6e3f25c83ddfbea993546605e34ea8addf152cd1a3f13133186a480253a3542e697e7324879bcc2662
+  metadata.gz: a2e52091afe3577f46df1e0093ad6d4d6167a250e27ec7776af7706b8ec01fce0539f15a0bcaa1d12273ac2ed8055cddcc6fef5536b5e7ae8761d4158c2f9a6a
+  data.tar.gz: 8159181dd45c05ba6aad2a57ff482bdf8471904d6990517e04a992bc177e42b5cb201dfb48ff7e645ecfb2e23270ed129a9a6666b87a6412d07a3163200e4d72

data/History.rdoc

@@ -1,3 +1,15 @@
+== 14.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)
+* Add Ruby 3.2 to CI and update checkout action versions (Peter Goldstein)
+* Fix grammatical correction in README.rdoc (Sam Corl)
+* Add an assertion for previously_new_record? (Akinori Musha)
+* Fix validate_each (Benjamin Fleischer)
+* Reduce ambiguity by avoiding #normalize (Mitsuhiro Shibuya)
+* Accept strings in has_many ids assignment (Mitsuhiro Shibuya)
+* Make CompositeKeys respond to #to_param consistently with ActiveRecord::Base (Mitsuhiro Shibuya)
+
 == 14.0.4 (2022-02-13)
 * Fix for changed method in Rails 7.0.2 (Yota)
 
@@ -15,6 +27,9 @@
 == 14.0.0 (2022-01-9)
 * Update to ActiveRecord 7.0 (Sammy Larbi)
 
+== 13.0.4 (2022-12-05)
+* Fix previously_new_record? not being set to true after create (Akinori MUSHA)
+
 == 13.0.3 (2022-01-09)
 * Remove override on ActiveRecord::Base#to_param. That method has moved to Integration
   so no longer works. #541. (Charlie Savage)

data/README.rdoc

@@ -2,7 +2,7 @@
 
 == Summary
 
-ActiveRecords infamously doesn't support composite primary keys.
+ActiveRecord infamously doesn't support composite primary keys.
 This gem, composite_primary_keys, or CPK for short, extends ActiveRecord
 to support composite keys.
 
@@ -72,7 +72,7 @@ But first, lets check out our primary keys.
   Membership.primary_key  # => [:user_id, :group_id] # composite keys
   Membership.primary_key.to_s # => "user_id,group_id"
 
-Now we want to be able to find instances using the same syntax we always use for ActiveRecords…
+Now we want to be able to find instances using the same syntax we always use for ActiveRecords.
 
   MembershipStatus.find(1)    # single id returns single instance
   => <MembershipStatus:0x392a8c8 @attributes={"id"=>"1", "status"=>"Active"}>

data/lib/composite_primary_keys/associations/collection_association.rb

@@ -1,32 +1,39 @@
-module CompositePrimaryKeys
-  module CollectionAssociation
-    def ids_writer(ids)
-      primary_key = reflection.association_primary_key
-      pk_type = klass.type_for_attribute(primary_key)
-      ids = Array(ids).reject(&:blank?)
-      ids.map! { |i| pk_type.cast(i) }
-
-      # CPK-
-      if primary_key.is_a?(Array)
-        predicate = CompositePrimaryKeys::Predicates.cpk_in_predicate(klass.arel_table, reflection.association_primary_key, ids)
-        records = klass.where(predicate).index_by do |r|
-          reflection.association_primary_key.map{ |k| r.send(k) }
-        end.values_at(*ids)
-      else
-        records = klass.where(primary_key => ids).index_by do |r|
-          r.public_send(primary_key)
-        end.values_at(*ids).compact
-      end
-
-      if records.size != ids.size
-        found_ids = records.map { |record| record.public_send(primary_key) }
-        not_found_ids = ids - found_ids
-        klass.all.raise_record_not_found_exception!(ids, records.size, ids.size, primary_key, not_found_ids)
-      else
-        replace(records)
-      end
-    end
-  end
-end
-
+module CompositePrimaryKeys
+  module CollectionAssociation
+    def ids_writer(ids)
+      primary_key = reflection.association_primary_key
+      ids = Array(ids).reject(&:blank?)
+
+      # CPK-
+      if primary_key.is_a?(Array)
+        ids = ids.map { |id| CompositePrimaryKeys::CompositeKeys.parse(id) }
+        primary_key.each_with_index do |key, i|
+          pk_type = klass.type_for_attribute(key)
+          ids.each { |id| id[i] = pk_type.cast(id[i]) }
+        end
+
+        predicate = CompositePrimaryKeys::Predicates.cpk_in_predicate(klass.arel_table, reflection.association_primary_key, ids)
+        records = klass.where(predicate).index_by do |r|
+          reflection.association_primary_key.map{ |k| r.send(k) }
+        end.values_at(*ids).compact
+      else
+        pk_type = klass.type_for_attribute(primary_key)
+        ids.map! { |i| pk_type.cast(i) }
+
+        records = klass.where(primary_key => ids).index_by do |r|
+          r.public_send(primary_key)
+        end.values_at(*ids).compact
+      end
+
+      if records.size != ids.size
+        found_ids = records.map { |record| record.public_send(primary_key) }
+        not_found_ids = ids - found_ids
+        klass.all.raise_record_not_found_exception!(ids, records.size, ids.size, primary_key, not_found_ids)
+      else
+        replace(records)
+      end
+    end
+  end
+end
+
 ActiveRecord::Associations::CollectionAssociation.prepend CompositePrimaryKeys::CollectionAssociation

data/lib/composite_primary_keys/composite_arrays.rb

@@ -1,86 +1,88 @@
-module CompositePrimaryKeys
-  ID_SEP     = ','
-  ID_SET_SEP = ';'
-  ESCAPE_CHAR = '^'
-
-  module ArrayExtension
-    def to_composite_keys
-      CompositeKeys.new(self)
-    end
-  end
-
-  # Convert mixed representation of CPKs (by strings or arrays) to normalized
-  # representation (just by arrays).
-  #
-  # `ids` is Array that may contain:
-  # 1. A CPK represented by an array or a string.
-  # 2. An array of CPKs represented by arrays or strings.
-  #
-  # There is an issue. Let `ids` contain an array with serveral strings. We can't distinguish case 1
-  # from case 2 there in general. E.g. the item can be an array containing appropriate number of strings,
-  # and each string can contain appropriate number of commas. We consider case 2 to win there.
-  def self.normalize(ids, cpk_size)
-    ids.map do |id|
-      if Utils.cpk_as_array?(id, cpk_size) && id.any? { |item| !Utils.cpk_as_string?(item, cpk_size) }
-        # CPK as an array - case 1
-        id
-      elsif id.is_a?(Array)
-        # An array of CPKs - case 2
-        normalize(id, cpk_size)
-      elsif id.is_a?(String)
-        # CPK as a string - case 1
-        CompositeKeys.parse(id)
-      else
-        id
-      end
-    end
-  end
-
-  class CompositeKeys < Array
-
-    def self.parse(value)
-      case value
-      when Array
-        value.to_composite_keys
-      when String
-        value.split(ID_SEP).map { |key| Utils.unescape_string_key(key) }.to_composite_keys
-      else
-        raise(ArgumentError, "Unsupported type: #{value}")
-      end
-    end
-
-    def to_s
-      # Doing this makes it easier to parse Base#[](attr_name)
-      map { |key| Utils.escape_string_key(key.to_s) }.join(ID_SEP)
-    end
-  end
-
-  module Utils
-    class << self
-      def escape_string_key(key)
-        key.gsub(Regexp.union(ESCAPE_CHAR, ID_SEP)) do |unsafe|
-          "#{ESCAPE_CHAR}#{unsafe.ord.to_s(16).upcase}"
-        end
-      end
-
-      def unescape_string_key(key)
-        key.gsub(/#{Regexp.escape(ESCAPE_CHAR)}[0-9a-fA-F]{2}/) do |escaped|
-          char = escaped.slice(1, 2).hex.chr
-          (char == ESCAPE_CHAR || char == ID_SEP) ? char : escaped
-        end
-      end
-
-      def cpk_as_array?(value, pk_size)
-        # We don't permit Array to be an element of CPK.
-        value.is_a?(Array) && value.size == pk_size && value.none? { |item| item.is_a?(Array) }
-      end
-
-      def cpk_as_string?(value, pk_size)
-        value.is_a?(String) && value.count(ID_SEP) == pk_size - 1
-      end
-    end
-  end
-  private_constant :Utils
-end
-
-Array.send(:include, CompositePrimaryKeys::ArrayExtension)
+module CompositePrimaryKeys
+  ID_SEP     = ','
+  ID_SET_SEP = ';'
+  ESCAPE_CHAR = '^'
+
+  module ArrayExtension
+    def to_composite_keys
+      CompositeKeys.new(self)
+    end
+  end
+
+  # Convert mixed representation of CPKs (by strings or arrays) to normalized
+  # representation (just by arrays).
+  #
+  # `ids` is Array that may contain:
+  # 1. A CPK represented by an array or a string.
+  # 2. An array of CPKs represented by arrays or strings.
+  #
+  # There is an issue. Let `ids` contain an array with serveral strings. We can't distinguish case 1
+  # from case 2 there in general. E.g. the item can be an array containing appropriate number of strings,
+  # and each string can contain appropriate number of commas. We consider case 2 to win there.
+  def self.normalize(ids, cpk_size)
+    ids.map do |id|
+      if Utils.cpk_as_array?(id, cpk_size) && id.any? { |item| !Utils.cpk_as_string?(item, cpk_size) }
+        # CPK as an array - case 1
+        id
+      elsif id.is_a?(Array)
+        # An array of CPKs - case 2
+        normalize(id, cpk_size)
+      elsif id.is_a?(String)
+        # CPK as a string - case 1
+        CompositeKeys.parse(id)
+      else
+        id
+      end
+    end
+  end
+
+  class CompositeKeys < Array
+
+    def self.parse(value)
+      case value
+      when Array
+        value.to_composite_keys
+      when String
+        value.split(ID_SEP).map { |key| Utils.unescape_string_key(key) }.to_composite_keys
+      else
+        raise(ArgumentError, "Unsupported type: #{value}")
+      end
+    end
+
+    def to_s
+      # Doing this makes it easier to parse Base#[](attr_name)
+      map { |key| Utils.escape_string_key(key.to_s) }.join(ID_SEP)
+    end
+
+    alias_method :to_param, :to_s
+  end
+
+  module Utils
+    class << self
+      def escape_string_key(key)
+        key.gsub(Regexp.union(ESCAPE_CHAR, ID_SEP)) do |unsafe|
+          "#{ESCAPE_CHAR}#{unsafe.ord.to_s(16).upcase}"
+        end
+      end
+
+      def unescape_string_key(key)
+        key.gsub(/#{Regexp.escape(ESCAPE_CHAR)}[0-9a-fA-F]{2}/) do |escaped|
+          char = escaped.slice(1, 2).hex.chr
+          (char == ESCAPE_CHAR || char == ID_SEP) ? char : escaped
+        end
+      end
+
+      def cpk_as_array?(value, pk_size)
+        # We don't permit Array to be an element of CPK.
+        value.is_a?(Array) && value.size == pk_size && value.none? { |item| item.is_a?(Array) }
+      end
+
+      def cpk_as_string?(value, pk_size)
+        value.is_a?(String) && value.count(ID_SEP) == pk_size - 1
+      end
+    end
+  end
+  private_constant :Utils
+end
+
+Array.send(:include, CompositePrimaryKeys::ArrayExtension)

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/validations/uniqueness.rb

@@ -1,32 +1,40 @@
-module ActiveRecord
-  module Validations
-    class UniquenessValidator
-      def validate_each(record, attribute, value)
-        finder_class = find_finder_class_for(record)
-        value = map_enum_attribute(finder_class, attribute, value)
-
-        relation = build_relation(finder_class, attribute, value)
-        if record.persisted?
-          # CPK
-          if finder_class.primary_key.is_a?(Array)
-            predicate = finder_class.cpk_id_predicate(finder_class.arel_table, finder_class.primary_key, record.id_in_database || record.id)
-            relation = relation.where.not(predicate)
-          elsif finder_class.primary_key
-            relation = relation.where.not(finder_class.primary_key => record.id_in_database)
-          else
-            raise UnknownPrimaryKey.new(finder_class, "Can not validate uniqueness for persisted record without primary key.")
-          end
-        end
-        relation = scope_relation(record, relation)
-        relation = relation.merge(options[:conditions]) if options[:conditions]
-
-        if relation.exists?
-          error_options = options.except(:case_sensitive, :scope, :conditions)
-          error_options[:value] = value
-
-          record.errors.add(attribute, :taken, **error_options)
-        end
-      end
-    end
-  end
-end
+module ActiveRecord
+  module Validations
+    class UniquenessValidator
+      def validate_each(record, attribute, value)
+        finder_class = find_finder_class_for(record)
+        value = map_enum_attribute(finder_class, attribute, value)
+
+        relation = build_relation(finder_class, attribute, value)
+        if record.persisted?
+          # CPK
+          if finder_class.primary_key.is_a?(Array)
+            predicate = finder_class.cpk_id_predicate(finder_class.arel_table, finder_class.primary_key, record.id_in_database || record.id)
+            relation = relation.where.not(predicate)
+          elsif finder_class.primary_key
+            relation = relation.where.not(finder_class.primary_key => record.id_in_database)
+          else
+            raise UnknownPrimaryKey.new(finder_class, "Can not validate uniqueness for persisted record without primary key.")
+          end
+        end
+        relation = scope_relation(record, relation)
+        if options[:conditions]
+          conditions = options[:conditions]
+
+          relation = if conditions.arity.zero?
+            relation.instance_exec(&conditions)
+          else
+            relation.instance_exec(record, &conditions)
+          end
+        end
+
+        if relation.exists?
+          error_options = options.except(:case_sensitive, :scope, :conditions)
+          error_options[:value] = value
+
+          record.errors.add(attribute, :taken, **error_options)
+        end
+      end
+    end
+  end
+end

data/lib/composite_primary_keys/version.rb

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

data/test/fixtures/room_assignment.rb

@@ -1,14 +1,18 @@
-class RoomAssignment < ActiveRecord::Base
-  self.primary_keys = :student_id, :dorm_id, :room_id
-  belongs_to :student
-  belongs_to :room, :foreign_key => [:dorm_id, :room_id], :primary_key => [:dorm_id, :room_id]
-  validates_uniqueness_of :student_id
-
-  before_destroy do |record|
-    puts record
-  end
-
-  after_destroy do |record|
-    puts record
-  end
-end
+class RoomAssignment < ActiveRecord::Base
+  self.primary_keys = :student_id, :dorm_id, :room_id
+  belongs_to :student
+  belongs_to :room, :foreign_key => [:dorm_id, :room_id], :primary_key => [:dorm_id, :room_id]
+  validates :student_id, uniqueness: {
+    conditions: ->(record) {
+      where(student_id: record.student_id) # enough just to exercise this code path
+    }
+  }
+
+  before_destroy do |record|
+    puts record
+  end
+
+  after_destroy do |record|
+    puts record
+  end
+end

data/test/test_associations.rb

@@ -367,7 +367,29 @@ class TestAssociations < ActiveSupport::TestCase
     assert_equal(false, associations.send('foreign_key_present?'))
   end
 
-  def test_ids_equals_for_non_CPK_case
+  def test_assignment_by_ids_as_arrays
+    room = Room.create dorm: dorms(:branner), room_id: 4
+    room.room_assignment_ids = [[3, 1, 2], [4, 1, 2]]
+    room.save!
+    assert_equal room.room_assignments.map(&:student_id), [3, 4]
+  end
+
+  def test_assignment_by_ids_as_arrays_that_contains_a_comma
+    room = Room.create dorm: dorms(:branner), room_id: 4
+    e = assert_raises ActiveRecord::RecordNotFound do
+      room.room_assignment_ids = [['5,,', '5,,', '5,,']]
+    end
+    assert_match /'student_id,dorm_id,room_id'=\[\[5, 5, 5\]\]/, e.message
+  end
+
+  def test_assignment_by_ids_as_strings
+    room = Room.create dorm: dorms(:branner), room_id: 4
+    room.room_assignment_ids = ['3,1,2', '4,1,2']
+    room.save!
+    assert_equal room.room_assignments.map(&:student_id), [3, 4]
+  end
+
+  def test_assignment_by_ids_for_non_CPK_case
     article = Article.new
     article.reading_ids = Reading.pluck(:id)
     assert_equal article.reading_ids, Reading.pluck(:id)

data/test/test_composite_arrays.rb

@@ -1,38 +1,44 @@
-require File.expand_path('../abstract_unit', __FILE__)
-
-class CompositeArraysTest < ActiveSupport::TestCase
-
-  def test_new_primary_keys
-    keys = CompositePrimaryKeys::CompositeKeys.new
-    assert_not_nil keys
-    assert_equal '', keys.to_s
-    assert_equal '', "#{keys}"
-  end
-
-  def test_initialize_primary_keys
-    keys = CompositePrimaryKeys::CompositeKeys.new([1,2,3])
-    assert_not_nil keys
-    assert_equal '1,2,3', keys.to_s
-    assert_equal '1,2,3', "#{keys}"
-  end
-
-  def test_to_composite_keys
-    keys = [1,2,3].to_composite_keys
-    assert_equal CompositePrimaryKeys::CompositeKeys, keys.class
-    assert_equal '1,2,3', keys.to_s
-  end
-
-  def test_parse
-    assert_equal ['1', '2'], CompositePrimaryKeys::CompositeKeys.parse('1,2')
-    assert_equal ['The USA', '^Washington, D.C.'],
-                 CompositePrimaryKeys::CompositeKeys.parse('The USA,^5EWashington^2C D.C.')
-    assert_equal ['The USA', '^Washington, D.C.'],
-                 CompositePrimaryKeys::CompositeKeys.parse(['The USA', '^Washington, D.C.'])
-  end
-
-  def test_to_s
-    assert_equal '1,2', CompositePrimaryKeys::CompositeKeys.new([1, 2]).to_s
-    assert_equal 'The USA,^5EWashington^2C D.C.',
-                 CompositePrimaryKeys::CompositeKeys.new(['The USA', '^Washington, D.C.']).to_s
-  end
-end
+require File.expand_path('../abstract_unit', __FILE__)
+
+class CompositeArraysTest < ActiveSupport::TestCase
+
+  def test_new_primary_keys
+    keys = CompositePrimaryKeys::CompositeKeys.new
+    assert_not_nil keys
+    assert_equal '', keys.to_s
+    assert_equal '', "#{keys}"
+  end
+
+  def test_initialize_primary_keys
+    keys = CompositePrimaryKeys::CompositeKeys.new([1,2,3])
+    assert_not_nil keys
+    assert_equal '1,2,3', keys.to_s
+    assert_equal '1,2,3', "#{keys}"
+  end
+
+  def test_to_composite_keys
+    keys = [1,2,3].to_composite_keys
+    assert_equal CompositePrimaryKeys::CompositeKeys, keys.class
+    assert_equal '1,2,3', keys.to_s
+  end
+
+  def test_parse
+    assert_equal ['1', '2'], CompositePrimaryKeys::CompositeKeys.parse('1,2')
+    assert_equal ['The USA', '^Washington, D.C.'],
+                 CompositePrimaryKeys::CompositeKeys.parse('The USA,^5EWashington^2C D.C.')
+    assert_equal ['The USA', '^Washington, D.C.'],
+                 CompositePrimaryKeys::CompositeKeys.parse(['The USA', '^Washington, D.C.'])
+  end
+
+  def test_to_s
+    assert_equal '1,2', CompositePrimaryKeys::CompositeKeys.new([1, 2]).to_s
+    assert_equal 'The USA,^5EWashington^2C D.C.',
+                 CompositePrimaryKeys::CompositeKeys.new(['The USA', '^Washington, D.C.']).to_s
+  end
+
+  def test_to_param
+    assert_equal '1,2', CompositePrimaryKeys::CompositeKeys.new([1, 2]).to_param
+    assert_equal 'The USA,^5EWashington^2C D.C.',
+                 CompositePrimaryKeys::CompositeKeys.new(['The USA', '^Washington, D.C.']).to_param
+  end
+end

data/test/test_create.rb

@@ -1,218 +1,219 @@
-require File.expand_path('../abstract_unit', __FILE__)
-
-class TestCreate < ActiveSupport::TestCase
-  fixtures :articles, :students, :dorms, :rooms, :room_assignments, :reference_types, :reference_codes, :streets, :suburbs
-
-  CLASSES = {
-    :single => {
-      :class => ReferenceType,
-      :primary_keys => :reference_type_id,
-      :create => {:reference_type_id => 10, :type_label => 'NEW_TYPE', :abbreviation => 'New Type'}
-    },
-    :dual   => {
-      :class => ReferenceCode,
-      :primary_keys => [:reference_type_id, :reference_code],
-      :create => {:reference_type_id => 1, :reference_code => 20, :code_label => 'NEW_CODE', :abbreviation => 'New Code'}
-    }
-  }
-
-  def setup
-    self.class.classes = CLASSES
-  end
-
-  def test_setup
-    testing_with do
-      assert_not_nil @klass_info[:create]
-    end
-  end
-
-  def test_create
-    testing_with do
-      assert new_obj = @klass.create(@klass_info[:create])
-      assert !new_obj.new_record?
-      assert new_obj.id
-    end
-  end
-
-  def test_create_no_id
-    testing_with do
-      begin
-        @obj = @klass.create(@klass_info[:create].except(@klass.primary_key))
-        @successful = !composite?
-      rescue ActiveRecord::CompositeKeyError
-        @successful = false
-      rescue
-        flunk "Incorrect exception raised: #{$!}, #{$!.class}"
-      end
-      assert_equal composite?, !@successful, "Create should have failed for composites; #{@obj.inspect}"
-    end
-  end
-
-  def test_create_with_array
-    date = Date.new(2027, 01, 27)
-    tariff = Tariff.create!(id: [10, date], amount: 27)
-    refute_nil(tariff)
-    assert_equal([10, date], tariff.id)
-    assert_equal(date, tariff.start_date)
-    assert_equal(27, tariff.amount)
-  end
-
-  def test_create_with_partial_serial
-    attributes = {:location_id => 100}
-
-    # SQLite does not support an autoincrementing field in a composite key
-    if Department.connection.class.name == "ActiveRecord::ConnectionAdapters::SQLite3Adapter"
-      attributes[:id] = 200
-    end
-
-    department = Department.new(attributes)
-    assert_nil(department.attributes[:id])
-
-    department.save!
-    refute_nil(department.attributes["id"])
-    assert_equal(100, department.location_id)
-  end
-
-  def test_create_with_id
-    department = Department.create!(id: [2, 3])
-    assert_equal([2, 3], department.id)
-    assert_equal(2, department.attributes["id"])
-    assert_equal(3, department.attributes["location_id"])
-
-    department.reload
-    assert_equal([2, 3], department.id)
-    assert_equal(2, department.attributes["id"])
-    assert_equal(3, department.attributes["location_id"])
-  end
-
-  def test_create_on_association
-    suburb = Suburb.first
-    suburb.streets.create(:name => "my street")
-    street = Street.find_by_name('my street')
-    assert_equal(suburb.city_id, street.city_id)
-    assert_equal(suburb.suburb_id, street.suburb_id)
-  end
-
-  def test_create_on_association_when_belongs_to_is_single_key
-    rt = ReferenceType.first
-    rt.reference_codes.create(:reference_code => 4321, :code_label => 'foo', :abbreviation => 'bar')
-    rc = ReferenceCode.find_by_reference_code(4321)
-    assert_equal(rc.reference_type_id, rt.reference_type_id)
-  end
-
-  def test_new_habtm
-    restaurant = Restaurant.new(:franchise_id => 101,
-                                :store_id => 201,
-                                :name => "My Store")
-
-    restaurant.suburbs << Suburb.new(:city_id => 24,
-                                     :suburb_id => 25,
-                                     :name => "My Suburb")
-
-    restaurant.save!
-
-    # Test restaurant
-    assert_equal(101, restaurant.franchise_id)
-    assert_equal(201, restaurant.store_id)
-    assert_equal("My Store", restaurant.name)
-    assert_equal(1, restaurant.suburbs.length)
-
-    # Test suburbs
-    suburb = restaurant.suburbs[0]
-    assert_equal(24, suburb.city_id)
-    assert_equal(25, suburb.suburb_id)
-    assert_equal("My Suburb", suburb.name)
-  end
-
-  def test_create_habtm
-    restaurant = Restaurant.create(:franchise_id => 100,
-                                   :store_id => 200,
-                                   :name => "My Store")
-
-    restaurant.suburbs.create(:city_id => 24,
-                              :suburb_id => 25,
-                              :name => "My Suburb")
-
-    # Test restaurant
-    assert_equal(100, restaurant.franchise_id)
-    assert_equal(200, restaurant.store_id)
-    assert_equal("My Store", restaurant.name)
-
-    assert_equal(1, restaurant.suburbs.reload.length)
-
-    # Test suburbs
-    suburb = restaurant.suburbs[0]
-    assert_equal(24, suburb.city_id)
-    assert_equal(25, suburb.suburb_id)
-    assert_equal("My Suburb", suburb.name)
-  end
-
-  def test_has_many_ids_1
-    dorm = dorms(:toyon)
-    room = Room.new(:dorm_id => dorm.id, :room_id => 5)
-    room.save!
-
-    student1 = students(:kelly)
-
-    RoomAssignment.delete_all
-
-    assignment1 = RoomAssignment.new(:student_id => student1.id, :dorm_id => room.dorm_id, :room_id => room.room_id)
-    assignment1.save!
-
-    room.room_assignment_ids = [[assignment1.student_id, assignment1.dorm_id, assignment1.room_id]]
-    room.save!
-
-    assert_equal(1, room.room_assignments.length)
-    assert_equal(assignment1, room.room_assignments.first)
-  end
-
-  def test_has_many_ids_2
-    dorm = dorms(:toyon)
-    room = Room.new(:dorm_id => dorm.id, :room_id => 5)
-    room.save!
-
-    student1 = students(:kelly)
-    student2 = students(:jordan)
-
-    RoomAssignment.delete_all
-
-    assignment1 = RoomAssignment.new(:student_id => student1.id, :dorm_id => room.dorm_id, :room_id => room.room_id)
-    assignment1.save!
-
-    assignment2 = RoomAssignment.new(:student_id => student2.id, :dorm_id => room.dorm_id, :room_id => room.room_id)
-    assignment2.save!
-
-    room.room_assignment_ids = [[assignment1.student_id, assignment1.dorm_id, assignment1.room_id],
-                                [assignment2.student_id, assignment2.dorm_id, assignment2.room_id]]
-    room.save!
-
-    assert_equal(2, room.room_assignments.length)
-    assert_equal(assignment1, room.room_assignments[0])
-    assert_equal(assignment2, room.room_assignments[1])
-  end
-
-  def test_find_or_create_by
-    suburb = Suburb.find_by(:city_id => 3, :suburb_id => 1)
-    assert_nil(suburb)
-
-    suburb = Suburb.find_or_create_by!(:name => 'New Suburb', :city_id => 3, :suburb_id => 1)
-    refute_nil(suburb)
-  end
-
-  def test_cache
-    Suburb.cache do
-      # Suburb does not exist
-      suburb = Suburb.find_by(:city_id => 10, :suburb_id => 10)
-      assert_nil(suburb)
-
-      # Create it
-      suburb = Suburb.create!(:name => 'New Suburb', :city_id => 10, :suburb_id => 10)
-
-      # Should be able to find it
-      suburb = Suburb.find_by(:city_id => 10)
-      refute_nil(suburb)
-      refute_nil(suburb.city_id)
-      refute_nil(suburb.suburb_id)
-    end
-  end
-end
+require File.expand_path('../abstract_unit', __FILE__)
+
+class TestCreate < ActiveSupport::TestCase
+  fixtures :articles, :students, :dorms, :rooms, :room_assignments, :reference_types, :reference_codes, :streets, :suburbs
+
+  CLASSES = {
+    :single => {
+      :class => ReferenceType,
+      :primary_keys => :reference_type_id,
+      :create => {:reference_type_id => 10, :type_label => 'NEW_TYPE', :abbreviation => 'New Type'}
+    },
+    :dual   => {
+      :class => ReferenceCode,
+      :primary_keys => [:reference_type_id, :reference_code],
+      :create => {:reference_type_id => 1, :reference_code => 20, :code_label => 'NEW_CODE', :abbreviation => 'New Code'}
+    }
+  }
+
+  def setup
+    self.class.classes = CLASSES
+  end
+
+  def test_setup
+    testing_with do
+      assert_not_nil @klass_info[:create]
+    end
+  end
+
+  def test_create
+    testing_with do
+      assert new_obj = @klass.create(@klass_info[:create])
+      assert !new_obj.new_record?
+      assert new_obj.id
+      assert new_obj.previously_new_record?
+    end
+  end
+
+  def test_create_no_id
+    testing_with do
+      begin
+        @obj = @klass.create(@klass_info[:create].except(@klass.primary_key))
+        @successful = !composite?
+      rescue ActiveRecord::CompositeKeyError
+        @successful = false
+      rescue
+        flunk "Incorrect exception raised: #{$!}, #{$!.class}"
+      end
+      assert_equal composite?, !@successful, "Create should have failed for composites; #{@obj.inspect}"
+    end
+  end
+
+  def test_create_with_array
+    date = Date.new(2027, 01, 27)
+    tariff = Tariff.create!(id: [10, date], amount: 27)
+    refute_nil(tariff)
+    assert_equal([10, date], tariff.id)
+    assert_equal(date, tariff.start_date)
+    assert_equal(27, tariff.amount)
+  end
+
+  def test_create_with_partial_serial
+    attributes = {:location_id => 100}
+
+    # SQLite does not support an autoincrementing field in a composite key
+    if Department.connection.class.name == "ActiveRecord::ConnectionAdapters::SQLite3Adapter"
+      attributes[:id] = 200
+    end
+
+    department = Department.new(attributes)
+    assert_nil(department.attributes[:id])
+
+    department.save!
+    refute_nil(department.attributes["id"])
+    assert_equal(100, department.location_id)
+  end
+
+  def test_create_with_id
+    department = Department.create!(id: [2, 3])
+    assert_equal([2, 3], department.id)
+    assert_equal(2, department.attributes["id"])
+    assert_equal(3, department.attributes["location_id"])
+
+    department.reload
+    assert_equal([2, 3], department.id)
+    assert_equal(2, department.attributes["id"])
+    assert_equal(3, department.attributes["location_id"])
+  end
+
+  def test_create_on_association
+    suburb = Suburb.first
+    suburb.streets.create(:name => "my street")
+    street = Street.find_by_name('my street')
+    assert_equal(suburb.city_id, street.city_id)
+    assert_equal(suburb.suburb_id, street.suburb_id)
+  end
+
+  def test_create_on_association_when_belongs_to_is_single_key
+    rt = ReferenceType.first
+    rt.reference_codes.create(:reference_code => 4321, :code_label => 'foo', :abbreviation => 'bar')
+    rc = ReferenceCode.find_by_reference_code(4321)
+    assert_equal(rc.reference_type_id, rt.reference_type_id)
+  end
+
+  def test_new_habtm
+    restaurant = Restaurant.new(:franchise_id => 101,
+                                :store_id => 201,
+                                :name => "My Store")
+
+    restaurant.suburbs << Suburb.new(:city_id => 24,
+                                     :suburb_id => 25,
+                                     :name => "My Suburb")
+
+    restaurant.save!
+
+    # Test restaurant
+    assert_equal(101, restaurant.franchise_id)
+    assert_equal(201, restaurant.store_id)
+    assert_equal("My Store", restaurant.name)
+    assert_equal(1, restaurant.suburbs.length)
+
+    # Test suburbs
+    suburb = restaurant.suburbs[0]
+    assert_equal(24, suburb.city_id)
+    assert_equal(25, suburb.suburb_id)
+    assert_equal("My Suburb", suburb.name)
+  end
+
+  def test_create_habtm
+    restaurant = Restaurant.create(:franchise_id => 100,
+                                   :store_id => 200,
+                                   :name => "My Store")
+
+    restaurant.suburbs.create(:city_id => 24,
+                              :suburb_id => 25,
+                              :name => "My Suburb")
+
+    # Test restaurant
+    assert_equal(100, restaurant.franchise_id)
+    assert_equal(200, restaurant.store_id)
+    assert_equal("My Store", restaurant.name)
+
+    assert_equal(1, restaurant.suburbs.reload.length)
+
+    # Test suburbs
+    suburb = restaurant.suburbs[0]
+    assert_equal(24, suburb.city_id)
+    assert_equal(25, suburb.suburb_id)
+    assert_equal("My Suburb", suburb.name)
+  end
+
+  def test_has_many_ids_1
+    dorm = dorms(:toyon)
+    room = Room.new(:dorm_id => dorm.id, :room_id => 5)
+    room.save!
+
+    student1 = students(:kelly)
+
+    RoomAssignment.delete_all
+
+    assignment1 = RoomAssignment.new(:student_id => student1.id, :dorm_id => room.dorm_id, :room_id => room.room_id)
+    assignment1.save!
+
+    room.room_assignment_ids = [[assignment1.student_id, assignment1.dorm_id, assignment1.room_id]]
+    room.save!
+
+    assert_equal(1, room.room_assignments.length)
+    assert_equal(assignment1, room.room_assignments.first)
+  end
+
+  def test_has_many_ids_2
+    dorm = dorms(:toyon)
+    room = Room.new(:dorm_id => dorm.id, :room_id => 5)
+    room.save!
+
+    student1 = students(:kelly)
+    student2 = students(:jordan)
+
+    RoomAssignment.delete_all
+
+    assignment1 = RoomAssignment.new(:student_id => student1.id, :dorm_id => room.dorm_id, :room_id => room.room_id)
+    assignment1.save!
+
+    assignment2 = RoomAssignment.new(:student_id => student2.id, :dorm_id => room.dorm_id, :room_id => room.room_id)
+    assignment2.save!
+
+    room.room_assignment_ids = [[assignment1.student_id, assignment1.dorm_id, assignment1.room_id],
+                                [assignment2.student_id, assignment2.dorm_id, assignment2.room_id]]
+    room.save!
+
+    assert_equal(2, room.room_assignments.length)
+    assert_equal(assignment1, room.room_assignments[0])
+    assert_equal(assignment2, room.room_assignments[1])
+  end
+
+  def test_find_or_create_by
+    suburb = Suburb.find_by(:city_id => 3, :suburb_id => 1)
+    assert_nil(suburb)
+
+    suburb = Suburb.find_or_create_by!(:name => 'New Suburb', :city_id => 3, :suburb_id => 1)
+    refute_nil(suburb)
+  end
+
+  def test_cache
+    Suburb.cache do
+      # Suburb does not exist
+      suburb = Suburb.find_by(:city_id => 10, :suburb_id => 10)
+      assert_nil(suburb)
+
+      # Create it
+      suburb = Suburb.create!(:name => 'New Suburb', :city_id => 10, :suburb_id => 10)
+
+      # Should be able to find it
+      suburb = Suburb.find_by(:city_id => 10)
+      refute_nil(suburb)
+      refute_nil(suburb.city_id)
+      refute_nil(suburb.suburb_id)
+    end
+  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: 14.0.4
+  version: 14.0.5
 platform: ruby
 authors:
 - Charlie Savage
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2023-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -216,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Composite key support for ActiveRecord