composite_primary_keys 12.0.2 → 12.0.10

data/lib/composite_primary_keys/relation.rb

@@ -1,118 +1,193 @@
-module ActiveRecord
-  class Relation
-    alias :initialize_without_cpk :initialize
-    def initialize(klass, table: klass.arel_table, predicate_builder: klass.predicate_builder, values: {})
-      initialize_without_cpk(klass, table: table, predicate_builder: predicate_builder, values: values)
-      add_cpk_support if klass && klass.composite?
-    end
-
-    alias :initialize_copy_without_cpk :initialize_copy
-    def initialize_copy(other)
-      initialize_copy_without_cpk(other)
-      add_cpk_support if klass.composite?
-    end
-
-    def add_cpk_support
-      extend CompositePrimaryKeys::CompositeRelation
-    end
-
-    def update_all(updates)
-      raise ArgumentError, "Empty list of attributes to change" if updates.blank?
-
-      if eager_loading?
-        relation = apply_join_dependency
-        return relation.update_all(updates)
-      end
-
-      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)]
-      else
-        stmt.table(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)
-
-      if updates.is_a?(Hash)
-        if klass.locking_enabled? &&
-            !updates.key?(klass.locking_column) &&
-            !updates.key?(klass.locking_column.to_sym)
-          attr = arel_attribute(klass.locking_column)
-          updates[attr.name] = _increment_attribute(attr)
-        end
-        stmt.set _substitute_values(updates)
-      else
-        stmt.set Arel.sql(klass.sanitize_sql_for_assignment(updates, table.name))
-      end
-
-      @klass.connection.update stmt, "#{@klass} Update All"
-    end
-
-    def delete_all
-      invalid_methods = INVALID_METHODS_FOR_DELETE_ALL.select do |method|
-        value = @values[method]
-        method == :distinct ? value : value&.any?
-      end
-      if invalid_methods.any?
-        raise ActiveRecordError.new("delete_all doesn't support #{invalid_methods.join(', ')}")
-      end
-
-      if eager_loading?
-        relation = apply_join_dependency
-        return relation.delete_all
-      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)]
-      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)
-
-      affected = @klass.connection.delete(stmt, "#{@klass} Destroy")
-
-      reset
-      affected
-    end
-
-    # CPK
-    def subquery_for(key, select)
-      subselect = select.clone
-      subselect.projections = key
-
-      # 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?
-
-      key_name = Array(key).map {|a_key| a_key.name }.join(',')
-
-      Arel::SelectManager.new(subselect.as("__active_record_temp")).project(Arel.sql(key_name))
-    end
-  end
-end
+module ActiveRecord
+  class Relation
+    alias :initialize_without_cpk :initialize
+    def initialize(klass, table: klass.arel_table, predicate_builder: klass.predicate_builder, values: {})
+      initialize_without_cpk(klass, table: table, predicate_builder: predicate_builder, values: values)
+      add_cpk_support if klass && klass.composite?
+    end
+
+    alias :initialize_copy_without_cpk :initialize_copy
+    def initialize_copy(other)
+      initialize_copy_without_cpk(other)
+      add_cpk_support if klass.composite?
+    end
+
+    def add_cpk_support
+      extend CompositePrimaryKeys::CompositeRelation
+    end
+
+    def update_all(updates)
+      raise ArgumentError, "Empty list of attributes to change" if updates.blank?
+
+      if eager_loading?
+        relation = apply_join_dependency
+        return relation.update_all(updates)
+      end
+
+      stmt = Arel::UpdateManager.new
+      # CPK
+      if @klass.composite?
+        stmt.table(arel_table)
+        cpk_subquery(stmt)
+      else
+        stmt.table(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)
+
+      if updates.is_a?(Hash)
+        if klass.locking_enabled? &&
+            !updates.key?(klass.locking_column) &&
+            !updates.key?(klass.locking_column.to_sym)
+          attr = arel_attribute(klass.locking_column)
+          updates[attr.name] = _increment_attribute(attr)
+        end
+        stmt.set _substitute_values(updates)
+      else
+        stmt.set Arel.sql(klass.sanitize_sql_for_assignment(updates, table.name))
+      end
+
+      @klass.connection.update stmt, "#{@klass} Update All"
+    end
+
+    def delete_all
+      invalid_methods = INVALID_METHODS_FOR_DELETE_ALL.select do |method|
+        value = @values[method]
+        method == :distinct ? value : value&.any?
+      end
+      if invalid_methods.any?
+        raise ActiveRecordError.new("delete_all doesn't support #{invalid_methods.join(', ')}")
+      end
+
+      if eager_loading?
+        relation = apply_join_dependency
+        return relation.delete_all
+      end
+
+      stmt = Arel::DeleteManager.new
+
+      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)
+
+      affected = @klass.connection.delete(stmt, "#{@klass} Destroy")
+
+      reset
+      affected
+    end
+
+    # CPK
+    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 arel.limit || arel.offset || arel.orders.any?
+
+      key_name = arel_attributes.map(&:name).join(',')
+
+      manager = 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/version.rb

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

data/lib/composite_primary_keys.rb

@@ -1,118 +1,117 @@
-#--
-# Copyright (c) 2006-2016 Nic Williams and Charlie Savage
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-unless defined?(ActiveRecord)
-  require 'rubygems'
-  gem 'activerecord', '~>6.0.0'
-  require 'active_record'
-end
-
-# AR files we override
-require 'active_record/attribute_methods'
-require 'active_record/autosave_association'
-require 'active_record/counter_cache'
-require 'active_record/fixtures'
-require 'active_record/model_schema'
-require 'active_record/persistence'
-require 'active_record/reflection'
-require 'active_record/relation'
-require 'active_record/sanitization'
-require 'active_record/transactions'
-
-require 'active_record/associations/association'
-require 'active_record/associations/association_scope'
-require 'active_record/associations/foreign_association'
-require 'active_record/associations/has_many_association'
-require 'active_record/associations/has_many_through_association'
-require 'active_record/associations/join_dependency'
-require 'active_record/associations/preloader/association'
-require 'active_record/associations/singular_association'
-require 'active_record/associations/collection_association'
-require 'active_record/associations/through_association'
-
-require 'active_record/attribute_methods/primary_key'
-require 'active_record/attribute_methods/read'
-require 'active_record/attribute_methods/write'
-require 'active_record/nested_attributes'
-
-require 'active_record/connection_adapters/abstract/database_statements'
-require 'active_record/connection_adapters/abstract_adapter'
-require 'active_record/connection_adapters/postgresql/database_statements'
-
-require 'active_record/relation/where_clause'
-
-# CPK files
-require 'composite_primary_keys/attribute_methods'
-require 'composite_primary_keys/autosave_association'
-require 'composite_primary_keys/persistence'
-require 'composite_primary_keys/base'
-require 'composite_primary_keys/core'
-require 'composite_primary_keys/composite_arrays'
-require 'composite_primary_keys/composite_predicates'
-require 'composite_primary_keys/counter_cache'
-require 'composite_primary_keys/fixtures'
-require 'composite_primary_keys/reflection'
-require 'composite_primary_keys/relation'
-require 'composite_primary_keys/sanitization'
-require 'composite_primary_keys/transactions'
-require 'composite_primary_keys/version'
-
-require 'composite_primary_keys/associations/association'
-require 'composite_primary_keys/associations/association_scope'
-require 'composite_primary_keys/associations/foreign_association'
-require 'composite_primary_keys/associations/has_many_association'
-require 'composite_primary_keys/associations/has_many_through_association'
-require 'composite_primary_keys/associations/join_dependency'
-require 'composite_primary_keys/associations/preloader/association'
-require 'composite_primary_keys/associations/collection_association'
-require 'composite_primary_keys/associations/through_association'
-
-require 'composite_primary_keys/attribute_methods/primary_key'
-require 'composite_primary_keys/attribute_methods/read'
-require 'composite_primary_keys/attribute_methods/write'
-require 'composite_primary_keys/nested_attributes'
-
-require 'composite_primary_keys/connection_adapters/abstract/database_statements'
-require 'composite_primary_keys/connection_adapters/abstract_adapter'
-require 'composite_primary_keys/connection_adapters/postgresql/database_statements'
-require 'composite_primary_keys/connection_adapters/sqlserver/database_statements'
-
-require 'composite_primary_keys/relation/batches'
-require 'composite_primary_keys/relation/where_clause'
-require 'composite_primary_keys/relation/calculations'
-require 'composite_primary_keys/relation/finder_methods'
-require 'composite_primary_keys/relation/predicate_builder/association_query_value'
-require 'composite_primary_keys/relation/query_methods'
-
-require 'composite_primary_keys/validations/uniqueness'
-
-require 'composite_primary_keys/composite_relation'
-
-require 'composite_primary_keys/arel/to_sql'
-
-# SQL Servers Support - uncomment these lines
-#require 'activerecord-sqlserver-adapter/arel/visitors/sqlserver'
-#require 'composite_primary_keys/arel/sqlserver'
+#--
+# Copyright (c) 2006-2016 Nic Williams and Charlie Savage
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+unless defined?(ActiveRecord)
+  require 'rubygems'
+  gem 'activerecord', '~>6.0.0'
+  require 'active_record'
+end
+
+# ActiveModel files we override
+# _write_attribute
+require 'active_model/attribute_assignment'
+
+# ActiveRecord files we override
+require 'active_record/attribute_methods'
+require 'active_record/autosave_association'
+require 'active_record/counter_cache'
+require 'active_record/fixtures'
+require 'active_record/model_schema'
+require 'active_record/persistence'
+require 'active_record/reflection'
+require 'active_record/relation'
+require 'active_record/sanitization'
+require 'active_record/transactions'
+
+require 'active_record/associations/association'
+require 'active_record/associations/association_scope'
+require 'active_record/associations/foreign_association'
+require 'active_record/associations/has_many_association'
+require 'active_record/associations/has_many_through_association'
+require 'active_record/associations/join_dependency'
+require 'active_record/associations/preloader/association'
+require 'active_record/associations/singular_association'
+require 'active_record/associations/collection_association'
+require 'active_record/associations/through_association'
+
+require 'active_record/attribute_methods/primary_key'
+require 'active_record/attribute_methods/read'
+require 'active_record/attribute_methods/write'
+require 'active_record/nested_attributes'
+
+require 'active_record/connection_adapters/abstract/database_statements'
+require 'active_record/connection_adapters/abstract_adapter'
+require 'active_record/connection_adapters/postgresql/database_statements'
+
+require 'active_record/relation/where_clause'
+
+# CPK overrides
+require_relative 'composite_primary_keys/active_model/attribute_assignment'
+require_relative 'composite_primary_keys/attribute_methods'
+require_relative 'composite_primary_keys/autosave_association'
+require_relative 'composite_primary_keys/persistence'
+require_relative 'composite_primary_keys/base'
+require_relative 'composite_primary_keys/core'
+require_relative 'composite_primary_keys/composite_arrays'
+require_relative 'composite_primary_keys/composite_predicates'
+require_relative 'composite_primary_keys/counter_cache'
+require_relative 'composite_primary_keys/fixtures'
+require_relative 'composite_primary_keys/reflection'
+require_relative 'composite_primary_keys/relation'
+require_relative 'composite_primary_keys/sanitization'
+require_relative 'composite_primary_keys/transactions'
+require_relative 'composite_primary_keys/version'
+
+require_relative 'composite_primary_keys/associations/association'
+require_relative 'composite_primary_keys/associations/association_scope'
+require_relative 'composite_primary_keys/associations/foreign_association'
+require_relative 'composite_primary_keys/associations/has_many_association'
+require_relative 'composite_primary_keys/associations/has_many_through_association'
+require_relative 'composite_primary_keys/associations/join_dependency'
+require_relative 'composite_primary_keys/associations/preloader/association'
+require_relative 'composite_primary_keys/associations/collection_association'
+require_relative 'composite_primary_keys/associations/through_association'
+
+require_relative 'composite_primary_keys/attribute_methods/primary_key'
+require_relative 'composite_primary_keys/attribute_methods/read'
+require_relative 'composite_primary_keys/attribute_methods/write'
+require_relative 'composite_primary_keys/nested_attributes'
+
+require_relative 'composite_primary_keys/connection_adapters/abstract/database_statements'
+require_relative 'composite_primary_keys/connection_adapters/abstract_adapter'
+require_relative 'composite_primary_keys/connection_adapters/postgresql/database_statements'
+require_relative 'composite_primary_keys/connection_adapters/sqlserver/database_statements'
+
+require_relative 'composite_primary_keys/relation/batches'
+require_relative 'composite_primary_keys/relation/where_clause'
+require_relative 'composite_primary_keys/relation/calculations'
+require_relative 'composite_primary_keys/relation/finder_methods'
+require_relative 'composite_primary_keys/relation/predicate_builder/association_query_value'
+require_relative 'composite_primary_keys/relation/query_methods'
+
+require_relative 'composite_primary_keys/validations/uniqueness'
+
+require_relative 'composite_primary_keys/composite_relation'
+
+require_relative 'composite_primary_keys/arel/to_sql'
+require_relative 'composite_primary_keys/arel/sqlserver'