composite_primary_keys 11.2.0 → 11.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76e658e30475707dc7495c8f5f5647c18ad0a67edc3cc5787a312a1785418524
-  data.tar.gz: f824d0c22fb21ec5d7d8311047433a6661cb5c134549ee46460e6c693b0cbe4c
+  metadata.gz: 9568b1a0261ca52beff062804d3885a795fe4193c9289b140c49c3c36ea199fb
+  data.tar.gz: b458b36aa5e082fc060838953e56eaea26557c4a9570d161c03420ded1a8097e
 SHA512:
-  metadata.gz: 0721b3f2dcb649fd585baf7facf0747d73edf8929e1f7c2ef9b4522ce3824b23d94cec7caafd810d7ea77e03043ee3cc31abfd6dca16eb012556be147c634fe0
-  data.tar.gz: 40282b497748d0a9eda0cc461c38c4dc91714560022fa37e7466e085a65ea2bd53b85f50cd5845560a2ab43e0c24544b76faf493457f9f9f166ce3761b420285
+  metadata.gz: 70cbc4245e31da5701b16dfe7fa109cfe1f395311446537567804b4a378ea6cd2c33d771b00b72e6cd0833a6365b6adcba03a3df4e6564668d298d28f89abbad
+  data.tar.gz: 52df628c9b690b8855f8dbfb52394fca4f07d674aba598b00439cf036138ef73b7975f82c434c185b9c4d4ee4537f70070c27007c2bb5ff81422c513b1a5b96f

data/History.rdoc

@@ -1,3 +1,11 @@
+== 11.3.1 (2020-04-01)
+* Fix overriding AbstractReflection for activerecord 5.2.4 (Sergey Semyonov)
+* Fix handling CPK with fields containing comma (Sergey Semyonov)
+* Fixed incorrect SQL condition for joining by CPK (Sergey Semyonov)
+* Update travis.yml file (Sergey Semyonov)
+* Add tests for composite keys with default values (Daniel Wiklund)
+* Fix create record where one or more of the primary keys has a default value (Daniel Wiklund)
+
 == 11.2.0 (2019-03-16)
 * When creating new records, honor composite key autoincrementing fields if possible (Antti Pitkänen)
 * Update Association#run to more closely match ActiveRecord (Fabian Mersch)

data/lib/composite_primary_keys.rb

@@ -26,7 +26,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 unless defined?(ActiveRecord)
   require 'rubygems'
-  gem 'activerecord', '~> 5.2.1'
+  gem 'activerecord', '~> 5.2.4'
   require 'active_record'
 end
 

data/lib/composite_primary_keys/base.rb

@@ -123,7 +123,7 @@ module ActiveRecord
       end
 
       def to_param
-        persisted? ? to_key.join(CompositePrimaryKeys::ID_SEP) : nil
+        persisted? ? to_key.to_composite_keys.to_s : nil
       end
     end
   end

data/lib/composite_primary_keys/composite_arrays.rb

@@ -1,6 +1,7 @@
 module CompositePrimaryKeys
   ID_SEP     = ','
   ID_SET_SEP = ';'
+  ESCAPE_CHAR = '^'
 
   module ArrayExtension
     def to_composite_keys
@@ -8,12 +9,27 @@ module CompositePrimaryKeys
     end
   end
 
-  def self.normalize(ids)
+  # 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 several 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 id.is_a?(Array)
-        normalize(id)
-      elsif id.is_a?(String) && id.index(ID_SEP)
-        id.split(ID_SEP)
+      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
@@ -27,7 +43,7 @@ module CompositePrimaryKeys
       when Array
         value.to_composite_keys
       when String
-        self.new(value.split(ID_SEP))
+        value.split(ID_SEP).map { |key| Utils.unescape_string_key(key) }.to_composite_keys
       else
         raise(ArgumentError, "Unsupported type: #{value}")
       end
@@ -43,9 +59,36 @@ module CompositePrimaryKeys
 
     def to_s
       # Doing this makes it easier to parse Base#[](attr_name)
-      join(ID_SEP)
+      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)

data/lib/composite_primary_keys/connection_adapters/abstract_adapter.rb

@@ -4,7 +4,7 @@ module ActiveRecord
       def quote_column_names(name)
         Array(name).map do |col|
           quote_column_name(col.to_s)
-        end.join(CompositePrimaryKeys::ID_SEP)
+        end.to_composite_keys.to_s
       end
     end
   end

data/lib/composite_primary_keys/persistence.rb

@@ -64,8 +64,9 @@ module ActiveRecord
       new_id = self.class._insert_record(attributes_values)
 
       # CPK
-      if self.composite? && self.id.compact.empty?
-        self.id = new_id
+      if self.composite?
+        # Merge together the specified id with the new id (specified id gets precedence)
+        self.id = self.id.zip(Array(new_id)).map {|id1, id2| (id1 || id2)}
       else
         self.id ||= new_id if self.class.primary_key
       end

data/lib/composite_primary_keys/reflection.rb

@@ -1,19 +1,28 @@
 module ActiveRecord
   module Reflection
     class AbstractReflection
-      def build_join_constraint(table, foreign_table)
+      # Overriding for activerecord v5.2.4
+      def join_scope(table, foreign_table, foreign_klass)
+        predicate_builder = predicate_builder(table)
+        scope_chain_items = join_scopes(table, predicate_builder)
+        klass_scope       = klass_join_scope(table, predicate_builder)
+
         key         = join_keys.key
         foreign_key = join_keys.foreign_key
 
         # CPK
-        #constraint = table[key].eq(foreign_table[foreign_key])
-        constraint = cpk_join_predicate(table, key, foreign_table, foreign_key)
+        # klass_scope.where!(table[key].eq(foreign_table[foreign_key]))
+        klass_scope.where!(cpk_join_predicate(table, key, foreign_table, foreign_key))
+
+        if type
+          klass_scope.where!(type => foreign_klass.polymorphic_name)
+        end
 
         if klass.finder_needs_type_condition?
-          table.create_and([constraint, klass.send(:type_condition, table)])
-        else
-          constraint
+          klass_scope.where!(klass.send(:type_condition, table))
         end
+
+        scope_chain_items.inject(klass_scope, &:merge!)
       end
     end
   end

data/lib/composite_primary_keys/relation/finder_methods.rb

@@ -79,7 +79,7 @@ module CompositePrimaryKeys
 
         # CPK
         # expects_array = ids.first.kind_of?(Array)
-        ids = CompositePrimaryKeys.normalize(ids)
+        ids = CompositePrimaryKeys.normalize(ids, @klass.primary_keys.length)
         expects_array = ids.flatten != ids.flatten(1)
         return ids.first if expects_array && ids.first.empty?
 
@@ -156,10 +156,10 @@ module CompositePrimaryKeys
         # CPK
         if composite?
           ids = if ids.length == 1
-            ids.first.split(CompositePrimaryKeys::ID_SEP).to_composite_keys
-          else
-            ids.to_composite_keys
-          end
+                  CompositePrimaryKeys::CompositeKeys.parse(ids.first)
+                else
+                  ids.to_composite_keys
+                end
         end
 
         return find_some_ordered(ids) unless order_values.present?

data/lib/composite_primary_keys/version.rb

@@ -1,8 +1,8 @@
 module CompositePrimaryKeys
   module VERSION
     MAJOR = 11
-    MINOR = 2
-    TINY  = 0
+    MINOR = 3
+    TINY  = 1
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/test/fixtures/cpk_with_default_value.rb

@@ -0,0 +1,3 @@
+class CpkWithDefaultValue < ActiveRecord::Base
+  self.primary_keys = :record_id, :record_version
+end

data/test/fixtures/cpk_with_default_values.yml

@@ -0,0 +1,7 @@
+first:
+  record_id: 1
+  record_version: First
+  
+second:
+  record_id: 1
+  record_version: Second

data/test/fixtures/db_definitions/mysql.sql

@@ -215,4 +215,10 @@ create table pk_called_ids (
   abbreviation varchar(50) default null,
   description varchar(50) default null,
   primary key (id, reference_code)
-);
+);
+
+create table cpk_with_default_values (
+  record_id integer not null,
+  record_version varchar(50) default '' not null,
+  primary key (record_id, record_version)
+);

data/test/fixtures/db_definitions/oracle.drop.sql

@@ -45,4 +45,6 @@ drop table capitols;
 drop table products_restaurants;
 drop table employees_groups;
 drop table pk_called_ids;
-drop sequence pk_called_ids_seq;
+drop sequence pk_called_ids_seq;
+drop table cpk_with_default_values;
+drop sequence cpk_with_default_values_seq;

data/test/fixtures/db_definitions/oracle.sql

@@ -234,3 +234,11 @@ create table pk_called_ids (
     description       varchar(50) default null,
     constraint pk_called_ids_pk primary key (id, reference_code)
 );
+
+create sequence cpk_with_default_values_seq start with 1000;
+
+create table cpk_with_default_values (
+    record_id         int not null,
+    record_version    varchar(50) default '' not null,
+    constraint cpk_with_default_values_pk primary key (record_id, record_version)
+);

data/test/fixtures/db_definitions/postgresql.sql

@@ -218,3 +218,9 @@ create table pk_called_ids (
     description       varchar(50) default null,
     primary key (id, reference_code)
 );
+
+create table cpk_with_default_values (
+    record_id serial not null,
+    record_version varchar(50) default '' not null,
+    primary key (record_id, record_version)
+);

data/test/fixtures/db_definitions/sqlite.sql

@@ -204,3 +204,9 @@ create table pk_called_ids (
     description       varchar(50) default null,
     primary key (id, reference_code)
 );
+
+create table cpk_with_default_values (
+    record_id integer not null,
+    record_version    varchar(50) default '' not null,
+    primary key (record_id, record_version)
+);

data/test/fixtures/db_definitions/sqlserver.sql

@@ -210,4 +210,11 @@ CREATE TABLE pk_called_ids (
     description       [varchar](50) default null
     CONSTRAINT [pk_called_ids_pk] PRIMARY KEY
         ( [id], [reference_code] )
-);
+);
+
+CREATE TABLE cpk_with_default_values (
+    record_id         [int] IDENTITY(1000,1) NOT NULL,
+    record_version    [varchar](50) default '' NOT NULL
+    CONSTRAINT [cpk_with_default_values_pk] PRIMARY KEY
+        ( [record_id], [record_version] )
+);

data/test/test_composite_arrays.rb

@@ -21,4 +21,18 @@ class CompositeArraysTest < ActiveSupport::TestCase
     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

data/test/test_create.rb

@@ -1,7 +1,7 @@
 require File.expand_path('../abstract_unit', __FILE__)
 
 class TestCreate < ActiveSupport::TestCase
-  fixtures :articles, :students, :dorms, :rooms, :room_assignments, :reference_types, :reference_codes, :streets, :suburbs
+  fixtures :articles, :students, :dorms, :rooms, :room_assignments, :reference_types, :reference_codes, :streets, :suburbs, :cpk_with_default_values
 
   CLASSES = {
     :single => {
@@ -172,4 +172,26 @@ class TestCreate < ActiveSupport::TestCase
 
     assert_equal('Validation failed: Id has already been taken', error.to_s)
   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_create_when_pk_has_default_value
+    first = CpkWithDefaultValue.create!
+    refute_nil(first.record_id)
+    assert_equal('', first.record_version)
+
+    second = CpkWithDefaultValue.create!(record_id: first.record_id, record_version: 'Same id, different version')
+    assert_equal(first.record_id, second.record_id)
+    assert_equal('Same id, different version', second.record_version)
+
+    third = CpkWithDefaultValue.create!(record_version: 'Created by version only')
+    refute_nil(third.record_id)
+    assert_equal('Created by version only', third.record_version)
+  end
 end

data/test/test_find.rb

@@ -41,6 +41,14 @@ class TestFind < ActiveSupport::TestCase
     assert_equal(['The Netherlands', 'Amsterdam'], capitol.id)
   end
 
+  def test_find_with_strings_with_comma_as_composite_keys
+    capitol = Capitol.create!(country: 'The USA', city: 'Washington, D.C.')
+    assert_equal ['The USA', 'Washington, D.C.'], capitol.id
+
+    assert_equal capitol, Capitol.find(['The USA', 'Washington, D.C.'])
+    assert_equal capitol, Capitol.find(capitol.to_param)
+  end
+
   def test_find_each
     room_assignments = []
     RoomAssignment.find_each(:batch_size => 2) do |assignment|

data/test/test_ids.rb

@@ -40,6 +40,9 @@ class TestIds < ActiveSupport::TestCase
     testing_with do
       assert_equal '1,1', @first.to_param if composite?
     end
+
+    capitol = Capitol.create!(country: 'The USA', city: 'Washington, D.C.')
+    assert_equal 'The USA,Washington^2C D.C.', capitol.to_param
   end
 
   def test_ids_to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composite_primary_keys
 version: !ruby/object:Gem::Version
-  version: 11.2.0
+  version: 11.3.1
 platform: ruby
 authors:
 - Charlie Savage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-16 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.2.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -147,13 +147,14 @@ files:
 - test/connections/databases.ci.yml
 - test/connections/databases.example.yml
 - test/connections/databases.yml
-- test/db_test.rb
 - test/fixtures/article.rb
 - test/fixtures/articles.yml
 - test/fixtures/capitol.rb
 - test/fixtures/capitols.yml
 - test/fixtures/comment.rb
 - test/fixtures/comments.yml
+- test/fixtures/cpk_with_default_value.rb
+- test/fixtures/cpk_with_default_values.yml
 - test/fixtures/db_definitions/db2-create-tables.sql
 - test/fixtures/db_definitions/db2-drop-tables.sql
 - test/fixtures/db_definitions/mysql.sql
@@ -272,13 +273,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Composite key support for ActiveRecord
 test_files:
 - test/abstract_unit.rb
-- test/db_test.rb
 - test/README_tests.rdoc
 - test/setup.rb
 - test/test_aliases.rb

data/test/db_test.rb

@@ -1,53 +0,0 @@
-# assoc_test.rb
-
-path = File.expand_path(File.join(File.basename(__FILE__), "..", "lib", "composite_primary_keys"))
-puts path
-
-require File.join(path)
-require 'active_record'
-
-$configuration = {
-  :adapter  => 'postgresql',
-  :database => 'cpk_test',
-  :username => 'postgres'
-}
-
-ActiveRecord::Base.establish_connection($configuration) unless ActiveRecord::Base.connected?
-
-module GlobePG
-  class PGBase < ActiveRecord::Base
-    self.abstract_class = true
-   # establish_connection($configuration) unless connected?
-  end
-end
-
-module GlobePG
-  class TeacherToSchool < PGBase
-    set_table_name 'teacher_to_school'
-    self.primary_keys = ['teacherid', 'schoolid']
-
-    belongs_to :globe_teacher, :foreign_key => 'teacherid'
-    belongs_to :globe_school, :foreign_key => 'schoolid'
-  end
-end
-
-module GlobePG
-  class GlobeSchool < PGBase
-    set_table_name 'globe_school'
-    self.primary_key = 'schoolid'
-    has_many :teacher_to_schools, :foreign_key => :schoolid
-    has_many :globe_teachers, :through => :teacher_to_schools
-  end
-end
-
-module GlobePG
-  class GlobeTeacher < PGBase
-    set_table_name 'globe_teacher'
-    self.primary_key = 'teacherid'
-    has_many :teacher_to_schools, :foreign_key => :teacherid
-    has_many :globe_schools, :through => :teacher_to_schools
-  end
-end
-
-teacher = GlobePG::GlobeTeacher.find_by_teacherid('ZZGLOBEY')
-p teacher.globe_schools