composite_primary_keys 12.0.0 → 12.0.5

data/lib/composite_primary_keys/connection_adapters/sqlserver/database_statements.rb

@@ -2,20 +2,41 @@ module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module DatabaseStatements
-        def sql_for_insert(sql, pk, id_value, sequence_name, binds)
-          sql = if pk && self.class.use_output_inserted
-            # CPK
-            # quoted_pk = SQLServer::Utils.extract_identifiers(pk).quoted
-            # sql.insert sql.index(/ (DEFAULT )?VALUES/), " OUTPUT INSERTED.#{quoted_pk}"
-            quoted_pks = [pk].flatten.map {|pk| "INSERTED.#{SQLServer::Utils.extract_identifiers(pk).quoted}"}
-            sql.dup.insert sql.index(/ (DEFAULT )?VALUES/), " OUTPUT #{quoted_pks.join(", ")}"
-          else
-            "#{sql}; SELECT CAST(SCOPE_IDENTITY() AS bigint) AS Ident"
+        def sql_for_insert(sql, pk, binds)
+          if pk.nil?
+            table_name = query_requires_identity_insert?(sql)
+            pk = primary_key(table_name)
           end
 
-          # CPK
-          # super
-          [sql, binds]
+          sql = if pk && use_output_inserted? && !database_prefix_remote_server?
+                  # CPK
+                  #quoted_pk = SQLServer::Utils.extract_identifiers(pk).quoted
+                  quoted_pk = Array(pk).map {|subkey| SQLServer::Utils.extract_identifiers(subkey).quoted}
+
+                  table_name ||= get_table_name(sql)
+                  exclude_output_inserted = exclude_output_inserted_table_name?(table_name, sql)
+                  if exclude_output_inserted
+                    id_sql_type = exclude_output_inserted.is_a?(TrueClass) ? "bigint" : exclude_output_inserted
+                    # CPK
+                    # <<~SQL.squish
+                    #   DECLARE @ssaIdInsertTable table (#{quoted_pk} #{id_sql_type});
+                    #   #{sql.dup.insert sql.index(/ (DEFAULT )?VALUES/), " OUTPUT INSERTED.#{quoted_pk} INTO @ssaIdInsertTable"}
+                    #   SELECT CAST(#{quoted_pk.join(',')} AS #{id_sql_type}) FROM @ssaIdInsertTable
+                    # SQL
+                    <<~SQL.squish
+                      DECLARE @ssaIdInsertTable table (#{quoted_pk.map {|subkey| "#{subkey} #{id_sql_type}"}.join(", ")});
+                      #{sql.dup.insert sql.index(/ (DEFAULT )?VALUES/), " OUTPUT INSERTED.#{quoted_pk.join(', INSERTED.')} INTO @ssaIdInsertTable"}
+                      SELECT #{quoted_pk.map {|subkey| "CAST(#{subkey} AS #{id_sql_type}) #{subkey}"}.join(", ")} FROM @ssaIdInsertTable
+                    SQL
+                  else
+                    # CPK
+                    # sql.dup.insert sql.index(/ (DEFAULT )?VALUES/), " OUTPUT INSERTED.#{quoted_pk}"
+                    sql.dup.insert sql.index(/ (DEFAULT )?VALUES/), " OUTPUT INSERTED.#{quoted_pk.join(', INSERTED.')}"
+                  end
+                else
+                  "#{sql}; SELECT CAST(SCOPE_IDENTITY() AS bigint) AS Ident"
+                end
+          super
         end
       end
     end

data/lib/composite_primary_keys/core.rb

@@ -40,7 +40,7 @@ module ActiveRecord
 
         record = statement.execute([id], connection)&.first
         unless record
-          raise RecordNotFound.new("Couldn't find #{name} with '#{key}'=#{id}", name, key, id)
+          raise ::ActiveRecord::RecordNotFound.new("Couldn't find #{name} with '#{key}'=#{id}", name, key, id)
         end
         record
       end

data/lib/composite_primary_keys/persistence.rb

@@ -65,8 +65,8 @@ module ActiveRecord
       )
 
       # CPK
-      if self.composite? && self.id.compact.empty?
-        self.id = new_id
+      if self.composite?
+        self.id = self.id.zip(Array(new_id)).map {|id1, id2| id2.nil? ? id1 : id2}
       else
         self.id ||= new_id if self.class.primary_key
       end

data/lib/composite_primary_keys/relation.rb

@@ -27,15 +27,8 @@ module ActiveRecord
       stmt = Arel::UpdateManager.new
       # CPK
       if @klass.composite?
-        stmt.table(table)
-
-        arel_attributes = primary_keys.map do |key|
-          arel_attribute(key)
-        end.to_composite_keys
-
-        subselect = subquery_for(arel_attributes, arel)
-
-        stmt.wheres = [arel_attributes.in(subselect)]
+        stmt.table(arel_table)
+        cpk_subquery(stmt)
       else
         stmt.table(arel.join_sources.empty? ? table : arel.source)
         stmt.key = arel_attribute(primary_key)
@@ -75,22 +68,16 @@ module ActiveRecord
       end
 
       stmt = Arel::DeleteManager.new
-      # CPK
-      if @klass.composite?
-        stmt.from(table)
-
-        arel_attributes = primary_keys.map do |key|
-          arel_attribute(key)
-        end.to_composite_keys
 
-        subselect = subquery_for(arel_attributes, arel)
-
-        stmt.wheres = [arel_attributes.in(subselect)]
+      if @klass.composite?
+        stmt.from(arel_table)
+        cpk_subquery(stmt)
       else
         stmt.from(arel.join_sources.empty? ? table : arel.source)
         stmt.key = arel_attribute(primary_key)
         stmt.wheres = arel.constraints
       end
+
       stmt.take(arel.limit)
       stmt.offset(arel.offset)
       stmt.order(*arel.orders)
@@ -102,17 +89,105 @@ module ActiveRecord
     end
 
     # CPK
-    def subquery_for(key, select)
-      subselect = select.clone
-      subselect.projections = key
+    def cpk_subquery(stmt)
+      # For update and delete statements we need a way to specify which records should
+      # get updated. By default, Rails creates a nested IN subquery that uses the primary
+      # key. Postgresql, Sqlite, MariaDb and Oracle support IN subqueries with multiple
+      # columns but MySQL and SqlServer do not. Instead SQL server supports EXISTS queries
+      # and MySQL supports obfuscated IN queries. Thus we need to check the type of
+      # database adapter to decide how to proceed.
+      if defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) && connection.is_a?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+        cpk_mysql_subquery(stmt)
+      elsif defined?(ActiveRecord::ConnectionAdapters::SQLServerAdapter) && connection.is_a?(ActiveRecord::ConnectionAdapters::SQLServerAdapter)
+        cpk_exists_subquery(stmt)
+      else
+        cpk_in_subquery(stmt)
+      end
+    end
+
+    # Used by postgresql, sqlite, mariadb and oracle. Example query:
+    #
+    # UPDATE reference_codes
+    # SET ...
+    # WHERE (reference_codes.reference_type_id, reference_codes.reference_code) IN
+    #      (SELECT reference_codes.reference_type_id, reference_codes.reference_code
+    #       FROM reference_codes)
+    def cpk_in_subquery(stmt)
+      # Setup the subquery
+      subquery = arel.clone
+      subquery.projections = primary_keys.map do |key|
+        arel_table[key]
+      end
+
+      where_fields = primary_keys.map do |key|
+        arel_table[key]
+      end
+      where = Arel::Nodes::Grouping.new(where_fields).in(subquery)
+      stmt.wheres = [where]
+    end
+
+    # CPK. This is an alternative to IN subqueries. It is used by sqlserver.
+    # Example query:
+    #
+    # UPDATE reference_codes
+    # SET ...
+    # WHERE EXISTS
+    #  (SELECT 1
+    #  FROM reference_codes cpk_child
+    #  WHERE reference_codes.reference_type_id = cpk_child.reference_type_id AND
+    #        reference_codes.reference_code = cpk_child.reference_code)
+    def cpk_exists_subquery(stmt)
+      arel_attributes = primary_keys.map do |key|
+        arel_attribute(key)
+      end.to_composite_keys
+
+      # Clone the query
+      subselect = arel.clone
+
+      # Alias the table - we assume just one table
+      aliased_table = subselect.froms.first
+      aliased_table.table_alias = "cpk_child"
+
+      # Project - really we could just set this to "1"
+      subselect.projections = arel_attributes
+
+      # Setup correlation to the outer query via where clauses
+      primary_keys.map do |key|
+        outer_attribute = arel_table[key]
+        inner_attribute = aliased_table[key]
+        where = outer_attribute.eq(inner_attribute)
+        subselect.where(where)
+      end
+      stmt.wheres = [Arel::Nodes::Exists.new(subselect)]
+    end
+
+    # CPK. This is the old way CPK created subqueries and is used by MySql.
+    # MySQL does not support referencing the same table that is being UPDATEd or
+    # DELETEd in a subquery so we obfuscate it. The ugly query looks like this:
+    #
+    # UPDATE `reference_codes`
+    # SET ...
+    # WHERE (reference_codes.reference_type_id, reference_codes.reference_code) IN
+    #  (SELECT reference_type_id,reference_code
+    #   FROM (SELECT DISTINCT `reference_codes`.`reference_type_id`, `reference_codes`.`reference_code`
+    #         FROM `reference_codes`) __active_record_temp)
+    def cpk_mysql_subquery(stmt)
+      arel_attributes = primary_keys.map do |key|
+        arel_attribute(key)
+      end.to_composite_keys
+
+      subselect = arel.clone
+      subselect.projections = arel_attributes
 
       # Materialize subquery by adding distinct
       # to work with MySQL 5.7.6 which sets optimizer_switch='derived_merge=on'
-      subselect.distinct unless select.limit || select.offset || select.orders.any?
+      subselect.distinct unless arel.limit || arel.offset || arel.orders.any?
+
+      key_name = arel_attributes.map(&:name).join(',')
 
-      key_name = Array(key).map {|a_key| a_key.name }.join(',')
+      manager = Arel::SelectManager.new(subselect.as("__active_record_temp")).project(Arel.sql(key_name))
 
-      Arel::SelectManager.new(subselect.as("__active_record_temp")).project(Arel.sql(key_name))
+      stmt.wheres = [Arel::Nodes::In.new(arel_attributes, manager.ast)]
     end
   end
 end

data/lib/composite_primary_keys/relation/finder_methods.rb

@@ -83,7 +83,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?
 
@@ -96,7 +96,7 @@ module CompositePrimaryKeys
         case ids.size
         when 0
           error_message = "Couldn't find #{model_name} without an ID"
-          raise RecordNotFound.new(error_message, model_name, primary_key)
+          raise ::ActiveRecord::RecordNotFound.new(error_message, model_name, primary_key)
         when 1
           result = find_one(ids.first)
           expects_array ? [ result ] : result
@@ -154,10 +154,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/relation/predicate_builder/association_query_value.rb

@@ -6,7 +6,7 @@ module ActiveRecord
         if associated_table.association_join_foreign_key.is_a?(Array)
           if ids.is_a?(ActiveRecord::Relation)
             ids.map do |id|
-              id.ids_hash
+              associated_table.association_join_foreign_key.zip(id.id).to_h
             end
           else
             [associated_table.association_join_foreign_key.zip(ids).to_h]

data/lib/composite_primary_keys/validations/uniqueness.rb

@@ -24,7 +24,7 @@ module ActiveRecord
           error_options = options.except(:case_sensitive, :scope, :conditions)
           error_options[:value] = value
 
-          record.errors.add(attribute, :taken, error_options)
+          record.errors.add(attribute, :taken, **error_options)
         end
       end
     end

data/lib/composite_primary_keys/version.rb

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

data/test/abstract_unit.rb

@@ -1,12 +1,10 @@
 spec_name = ENV['ADAPTER'] || 'sqlite'
 require 'bundler'
-Bundler.require(:default, spec_name.to_sym)
+require 'minitest/autorun'
 
-# To make debugging easier, test within this source tree versus an installed gem
-$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+Bundler.setup(:default, spec_name.to_sym)
+Bundler.require(:default, spec_name.to_sym)
 require 'composite_primary_keys'
-require 'minitest/autorun'
-require 'active_support/test_case'
 
 # Require the connection spec
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))

data/test/fixtures/article.rb

@@ -2,5 +2,9 @@ class Article < ActiveRecord::Base
   validates :id, uniqueness: true, numericality: true, allow_nil: true, allow_blank: true, on: :create
   has_many :readings, :dependent => :delete_all
   has_many :users, :through => :readings
+
+  has_many :comments, :dependent => :delete_all
+  has_many :employee_commentators, :through => :comments, :source => :person, :source_type => :employee
+  has_many :user_commentators, :through => :comments, :source => :person, :source_type => "User"
 end
 

data/test/fixtures/articles.yml

@@ -1,7 +1,8 @@
 first:
-  id: 1
   name: Article One
   
 second:
-  id: 2
-  name: Article Two
+  name: Article Two
+
+third:
+  name: Article Three

data/test/fixtures/comment.rb

@@ -1,7 +1,5 @@
 class Comment < ActiveRecord::Base
   belongs_to :person, :polymorphic => true
-  belongs_to :hack
-
-  enum :shown => [ :true, :false ]
+  belongs_to :article
 end
 

data/test/fixtures/comments.yml

@@ -1,16 +1,17 @@
-comment1:
+employee_comment:
   id: 1
+  article: first
   person_id: 1
   person_type: Employee
-  
-comment2:
+
+user_comment_1:
   id: 2
+  article: second
   person_id: 1
   person_type: User
-  hack_id: 7
-  
-comment3:
+
+user_comment_2:
   id: 3
-  person_id: 7
-  person_type: Hack
-  
+  article: second
+  person_id: 2
+  person_type: User

data/test/fixtures/db_definitions/db2-create-tables.sql

@@ -1,17 +1,3 @@
-CREATE TABLE topics (
-  id integer NOT NULL,  
-  name varchar(50) default NULL,  
-  feed_size integer default NULL, 
-  PRIMARY KEY (id)
-);
-
-CREATE TABLE topic_sources (
-  topic_id integer NOT NULL,
-  platform varchar(50) NOT NULL,
-  keywords varchar(50) default NULL,
-  PRIMARY KEY (topic_id,platform)
-);
-
 CREATE TABLE reference_types (
   reference_type_id integer NOT NULL generated by default as identity (start with 100, increment by 1, no cache),  
   type_label varchar(50) default NULL,  

data/test/fixtures/db_definitions/db2-drop-tables.sql

@@ -14,6 +14,4 @@ drop table PRODUCT_TARIFFS;
 drop table KITCHEN_SINK;
 drop table RESTAURANTS;
 drop table RESTAURANTS_SUBURBS;
-drop table PRODUCTS_RESTAURANTS;
-drop table TOPICS;
-drop table TOPIC_SOURCES;
+drop table PRODUCTS_RESTAURANTS;

data/test/fixtures/db_definitions/mysql.sql

@@ -1,17 +1,3 @@
-create table topics (
-    id int not null auto_increment,
-    name varchar(50) default null,  
-    feed_size int default null, 
-    primary key (id)
-);
-
-create table topic_sources (
-    topic_id int not null,
-    platform varchar(50) not null,
-    keywords varchar(50) default null,
-    primary key (topic_id,platform)
-);
-
 create table reference_types (
     reference_type_id int not null auto_increment,
     type_label varchar(50) default null,
@@ -52,7 +38,7 @@ create table product_tariffs (
 );
 
 create table suburbs (
-    city_id int not null,
+    city_id int not null auto_increment,
     suburb_id int not null,
     name varchar(50) not null,
     primary key (city_id, suburb_id)
@@ -86,7 +72,7 @@ create table readings (
     primary key (id)
 );
 
-create table groups (
+create table `groups` (
     id int not null auto_increment,
     name varchar(50) not null,
     primary key (id)
@@ -107,9 +93,9 @@ create table membership_statuses (
 );
 
 create table departments (
-    department_id int not null,
+    id int not null auto_increment,
     location_id int not null,
-    primary key (department_id, location_id)
+    primary key (id, location_id)
 );
 
 create table employees (
@@ -122,16 +108,9 @@ create table employees (
 
 create table comments (
     id int not null auto_increment,
-    person_id int default null,
-    shown int default null,
-    person_type varchar(100) default null,
-    hack_id int default null,
-    primary key (id)
-);
-
-create table hacks (
-    id int not null auto_increment,
-    name varchar(50) not null,
+    article_id int not null,
+    person_id int not null,
+    person_type varchar(100) not null,
     primary key (id)
 );
 
@@ -184,13 +163,6 @@ create table room_assignments (
     room_id int not null
 );
 
-create table seats (
-  flight_number int not null,
-  seat          int not null,
-  customer      int,
-  primary key (flight_number, seat)
-);
-
 create table capitols (
   country varchar(100) not null,
   city varchar(100) not null,
@@ -206,13 +178,4 @@ create table products_restaurants (
 create table employees_groups (
   employee_id int not null,
   group_id int not null
-);
-
-create table pk_called_ids (
-  id integer not null,
-  reference_code int not null,
-  code_label varchar(50) default null,
-  abbreviation varchar(50) default null,
-  description varchar(50) default null,
-  primary key (id, reference_code)
 );