activerecord 3.2.6 → 6.0.0

data/lib/active_record/associations/join_dependency.rb

@@ -1,214 +1,258 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Associations
     class JoinDependency # :nodoc:
-      autoload :JoinPart,        'active_record/associations/join_dependency/join_part'
-      autoload :JoinBase,        'active_record/associations/join_dependency/join_base'
-      autoload :JoinAssociation, 'active_record/associations/join_dependency/join_association'
-
-      attr_reader :join_parts, :reflections, :alias_tracker, :active_record
-
-      def initialize(base, associations, joins)
-        @active_record = base
-        @table_joins   = joins
-        @join_parts    = [JoinBase.new(base)]
-        @associations  = {}
-        @reflections   = []
-        @alias_tracker = AliasTracker.new(base.connection, joins)
-        @alias_tracker.aliased_name_for(base.table_name) # Updates the count for base.table_name to 1
-        build(associations)
-      end
+      autoload :JoinBase,        "active_record/associations/join_dependency/join_base"
+      autoload :JoinAssociation, "active_record/associations/join_dependency/join_association"
 
-      def graft(*associations)
-        associations.each do |association|
-          join_associations.detect {|a| association == a} ||
-            build(association.reflection.name, association.find_parent_in(self) || join_base, association.join_type)
+      class Aliases # :nodoc:
+        def initialize(tables)
+          @tables = tables
+          @alias_cache = tables.each_with_object({}) { |table, h|
+            h[table.node] = table.columns.each_with_object({}) { |column, i|
+              i[column.name] = column.alias
+            }
+          }
+          @columns_cache = tables.each_with_object({}) { |table, h|
+            h[table.node] = table.columns
+          }
         end
-        self
-      end
-
-      def join_associations
-        join_parts.last(join_parts.length - 1)
-      end
 
-      def join_base
-        join_parts.first
-      end
+        def columns
+          @tables.flat_map(&:column_aliases)
+        end
 
-      def columns
-        join_parts.collect { |join_part|
-          table = join_part.aliased_table
-          join_part.column_names_with_alias.collect{ |column_name, aliased_name|
-            table[column_name].as Arel.sql(aliased_name)
-          }
-        }.flatten
-      end
+        def column_aliases(node)
+          @columns_cache[node]
+        end
 
-      def instantiate(rows)
-        primary_key = join_base.aliased_primary_key
-        parents = {}
+        def column_alias(node, column)
+          @alias_cache[node][column]
+        end
 
-        records = rows.map { |model|
-          primary_id = model[primary_key]
-          parent = parents[primary_id] ||= join_base.instantiate(model)
-          construct(parent, @associations, join_associations, model)
-          parent
-        }.uniq
+        Table = Struct.new(:node, :columns) do # :nodoc:
+          def column_aliases
+            t = node.table
+            columns.map { |column| t[column.name].as Arel.sql column.alias }
+          end
+        end
+        Column = Struct.new(:name, :alias)
+      end
 
-        remove_duplicate_results!(active_record, records, @associations)
-        records
+      def self.make_tree(associations)
+        hash = {}
+        walk_tree associations, hash
+        hash
       end
 
-      def remove_duplicate_results!(base, records, associations)
+      def self.walk_tree(associations, hash)
         case associations
         when Symbol, String
-          reflection = base.reflections[associations]
-          remove_uniq_by_reflection(reflection, records)
+          hash[associations.to_sym] ||= {}
         when Array
-          associations.each do |association|
-            remove_duplicate_results!(base, records, association)
+          associations.each do |assoc|
+            walk_tree assoc, hash
           end
         when Hash
-          associations.keys.each do |name|
-            reflection = base.reflections[name]
-            remove_uniq_by_reflection(reflection, records)
-
-            parent_records = []
-            records.each do |record|
-              if descendant = record.send(reflection.name)
-                if reflection.collection?
-                  parent_records.concat descendant.target.uniq
-                else
-                  parent_records << descendant
-                end
-              end
-            end
+          associations.each do |k, v|
+            cache = hash[k] ||= {}
+            walk_tree v, cache
+          end
+        else
+          raise ConfigurationError, associations.inspect
+        end
+      end
+
+      def initialize(base, table, associations, join_type)
+        tree = self.class.make_tree associations
+        @join_root = JoinBase.new(base, table, build(tree, base))
+        @join_type = join_type
+      end
+
+      def reflections
+        join_root.drop(1).map!(&:reflection)
+      end
 
-            remove_duplicate_results!(reflection.klass, parent_records, associations[name]) unless parent_records.empty?
+      def join_constraints(joins_to_add, alias_tracker)
+        @alias_tracker = alias_tracker
+
+        construct_tables!(join_root)
+        joins = make_join_constraints(join_root, join_type)
+
+        joins.concat joins_to_add.flat_map { |oj|
+          construct_tables!(oj.join_root)
+          if join_root.match? oj.join_root
+            walk(join_root, oj.join_root, oj.join_type)
+          else
+            make_join_constraints(oj.join_root, oj.join_type)
           end
+        }
+      end
+
+      def instantiate(result_set, &block)
+        primary_key = aliases.column_alias(join_root, join_root.primary_key)
+
+        seen = Hash.new { |i, object_id|
+          i[object_id] = Hash.new { |j, child_class|
+            j[child_class] = {}
+          }
+        }
+
+        model_cache = Hash.new { |h, klass| h[klass] = {} }
+        parents = model_cache[join_root]
+        column_aliases = aliases.column_aliases join_root
+
+        message_bus = ActiveSupport::Notifications.instrumenter
+
+        payload = {
+          record_count: result_set.length,
+          class_name: join_root.base_klass.name
+        }
+
+        message_bus.instrument("instantiation.active_record", payload) do
+          result_set.each { |row_hash|
+            parent_key = primary_key ? row_hash[primary_key] : row_hash
+            parent = parents[parent_key] ||= join_root.instantiate(row_hash, column_aliases, &block)
+            construct(parent, join_root, row_hash, seen, model_cache)
+          }
         end
+
+        parents.values
+      end
+
+      def apply_column_aliases(relation)
+        relation._select!(-> { aliases.columns })
       end
 
       protected
+        attr_reader :join_root, :join_type
 
-      def cache_joined_association(association)
-        associations = []
-        parent = association.parent
-        while parent != join_base
-          associations.unshift(parent.reflection.name)
-          parent = parent.parent
-        end
-        ref = @associations
-        associations.each do |key|
-          ref = ref[key]
+      private
+        attr_reader :alias_tracker
+
+        def aliases
+          @aliases ||= Aliases.new join_root.each_with_index.map { |join_part, i|
+            columns = join_part.column_names.each_with_index.map { |column_name, j|
+              Aliases::Column.new column_name, "t#{i}_r#{j}"
+            }
+            Aliases::Table.new(join_part, columns)
+          }
         end
-        ref[association.reflection.name] ||= {}
-      end
 
-      def build(associations, parent = nil, join_type = Arel::InnerJoin)
-        parent ||= join_parts.last
-        case associations
-        when Symbol, String
-          reflection = parent.reflections[associations.to_s.intern] or
-          raise ConfigurationError, "Association named '#{ associations }' was not found; perhaps you misspelled it?"
-          unless join_association = find_join_association(reflection, parent)
-            @reflections << reflection
-            join_association = build_join_association(reflection, parent)
-            join_association.join_type = join_type
-            @join_parts << join_association
-            cache_joined_association(join_association)
-          end
-          join_association
-        when Array
-          associations.each do |association|
-            build(association, parent, join_type)
+        def construct_tables!(join_root)
+          join_root.each_children do |parent, child|
+            child.tables = table_aliases_for(parent, child)
           end
-        when Hash
-          associations.keys.sort_by { |a| a.to_s }.each do |name|
-            join_association = build(name, parent, join_type)
-            build(associations[name], join_association, join_type)
+        end
+
+        def make_join_constraints(join_root, join_type)
+          join_root.children.flat_map do |child|
+            make_constraints(join_root, child, join_type)
           end
-        else
-          raise ConfigurationError, associations.inspect
         end
-      end
 
-      def find_join_association(name_or_reflection, parent)
-        if String === name_or_reflection
-          name_or_reflection = name_or_reflection.to_sym
+        def make_constraints(parent, child, join_type)
+          foreign_table = parent.table
+          foreign_klass = parent.base_klass
+          joins = child.join_constraints(foreign_table, foreign_klass, join_type, alias_tracker)
+          joins.concat child.children.flat_map { |c| make_constraints(child, c, join_type) }
         end
 
-        join_associations.detect { |j|
-          j.reflection == name_or_reflection && j.parent == parent
-        }
-      end
+        def table_aliases_for(parent, node)
+          node.reflection.chain.map { |reflection|
+            alias_tracker.aliased_table_for(
+              reflection.table_name,
+              table_alias_for(reflection, parent, reflection != node.reflection),
+              reflection.klass.type_caster
+            )
+          }
+        end
 
-      def remove_uniq_by_reflection(reflection, records)
-        if reflection && reflection.collection?
-          records.each { |record| record.send(reflection.name).target.uniq! }
+        def table_alias_for(reflection, parent, join)
+          name = reflection.alias_candidate(parent.table_name)
+          join ? "#{name}_join" : name
         end
-      end
 
-      def build_join_association(reflection, parent)
-        JoinAssociation.new(reflection, self, parent)
-      end
+        def walk(left, right, join_type)
+          intersection, missing = right.children.map { |node1|
+            [left.children.find { |node2| node1.match? node2 }, node1]
+          }.partition(&:first)
 
-      def construct(parent, associations, join_parts, row)
-        case associations
-        when Symbol, String
-          name = associations.to_s
+          joins = intersection.flat_map { |l, r| r.table = l.table; walk(l, r, join_type) }
+          joins.concat missing.flat_map { |_, n| make_constraints(left, n, join_type) }
+        end
 
-          join_part = join_parts.detect { |j|
-            j.reflection.name.to_s == name &&
-              j.parent_table_name == parent.class.table_name }
+        def find_reflection(klass, name)
+          klass._reflect_on_association(name) ||
+            raise(ConfigurationError, "Can't join '#{klass.name}' to association named '#{name}'; perhaps you misspelled it?")
+        end
 
-            raise(ConfigurationError, "No such association") unless join_part
+        def build(associations, base_klass)
+          associations.map do |name, right|
+            reflection = find_reflection base_klass, name
+            reflection.check_validity!
+            reflection.check_eager_loadable!
 
-            join_parts.delete(join_part)
-            construct_association(parent, join_part, row)
-        when Array
-          associations.each do |association|
-            construct(parent, association, join_parts, row)
+            if reflection.polymorphic?
+              raise EagerLoadPolymorphicError.new(reflection)
+            end
+
+            JoinAssociation.new(reflection, build(right, reflection.klass))
           end
-        when Hash
-          associations.sort_by { |k,_| k.to_s }.each do |association_name, assoc|
-            association = construct(parent, association_name, join_parts, row)
-            construct(association, assoc, join_parts, row) if association
+        end
+
+        def construct(ar_parent, parent, row, seen, model_cache)
+          return if ar_parent.nil?
+
+          parent.children.each do |node|
+            if node.reflection.collection?
+              other = ar_parent.association(node.reflection.name)
+              other.loaded!
+            elsif ar_parent.association_cached?(node.reflection.name)
+              model = ar_parent.association(node.reflection.name).target
+              construct(model, node, row, seen, model_cache)
+              next
+            end
+
+            key = aliases.column_alias(node, node.primary_key)
+            id = row[key]
+            if id.nil?
+              nil_association = ar_parent.association(node.reflection.name)
+              nil_association.loaded!
+              next
+            end
+
+            model = seen[ar_parent.object_id][node][id]
+
+            if model
+              construct(model, node, row, seen, model_cache)
+            else
+              model = construct_model(ar_parent, node, row, model_cache, id)
+
+              seen[ar_parent.object_id][node][id] = model
+              construct(model, node, row, seen, model_cache)
+            end
           end
-        else
-          raise ConfigurationError, associations.inspect
         end
-      end
 
-      def construct_association(record, join_part, row)
-        return if record.id.to_s != join_part.parent.record_id(row).to_s
+        def construct_model(record, node, row, model_cache, id)
+          other = record.association(node.reflection.name)
 
-        macro = join_part.reflection.macro
-        if macro == :has_one
-          return record.association(join_part.reflection.name).target if record.association_cache.key?(join_part.reflection.name)
-          association = join_part.instantiate(row) unless row[join_part.aliased_primary_key].nil?
-          set_target_and_inverse(join_part, association, record)
-        else
-          association = join_part.instantiate(row) unless row[join_part.aliased_primary_key].nil?
-          case macro
-          when :has_many, :has_and_belongs_to_many
-            other = record.association(join_part.reflection.name)
-            other.loaded!
-            other.target.push(association) if association
-            other.set_inverse_instance(association)
-          when :belongs_to
-            set_target_and_inverse(join_part, association, record)
+          model = model_cache[node][id] ||=
+            node.instantiate(row, aliases.column_aliases(node)) do |m|
+              other.set_inverse_instance(m)
+            end
+
+          if node.reflection.collection?
+            other.target.push(model)
           else
-            raise ConfigurationError, "unknown macro: #{join_part.reflection.macro}"
+            other.target = model
           end
-        end
-        association
-      end
 
-      def set_target_and_inverse(join_part, association, record)
-        other = record.association(join_part.reflection.name)
-        other.target = association
-        other.set_inverse_instance(association)
-      end
+          model.readonly! if node.readonly?
+          model
+        end
     end
   end
 end

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

@@ -1,126 +1,132 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Associations
     class Preloader
       class Association #:nodoc:
-        attr_reader :owners, :reflection, :preload_options, :model, :klass
-
-        def initialize(klass, owners, reflection, preload_options)
-          @klass           = klass
-          @owners          = owners
-          @reflection      = reflection
-          @preload_options = preload_options || {}
-          @model           = owners.first && owners.first.class
-          @scoped          = nil
-          @owners_by_key   = nil
+        def initialize(klass, owners, reflection, preload_scope)
+          @klass         = klass
+          @owners        = owners
+          @reflection    = reflection
+          @preload_scope = preload_scope
+          @model         = owners.first && owners.first.class
         end
 
         def run
-          unless owners.first.association(reflection.name).loaded?
-            preload
+          if !preload_scope || preload_scope.empty_scope?
+            owners.each do |owner|
+              associate_records_to_owner(owner, records_by_owner[owner] || [])
+            end
+          else
+            # Custom preload scope is used and
+            # the association can not be marked as loaded
+            # Loading into a Hash instead
+            records_by_owner
           end
+          self
         end
 
-        def preload
-          raise NotImplementedError
+        def records_by_owner
+          # owners can be duplicated when a relation has a collection association join
+          # #compare_by_identity makes such owners different hash keys
+          @records_by_owner ||= preloaded_records.each_with_object({}.compare_by_identity) do |record, result|
+            owners_by_key[convert_key(record[association_key_name])].each do |owner|
+              (result[owner] ||= []) << record
+            end
+          end
         end
 
-        def scoped
-          @scoped ||= build_scope
+        def preloaded_records
+          return @preloaded_records if defined?(@preloaded_records)
+          @preloaded_records = owner_keys.empty? ? [] : records_for(owner_keys)
         end
 
-        def records_for(ids)
-          scoped.where(association_key.in(ids))
-        end
+        private
+          attr_reader :owners, :reflection, :preload_scope, :model, :klass
 
-        def table
-          klass.arel_table
-        end
+          # The name of the key on the associated records
+          def association_key_name
+            reflection.join_primary_key(klass)
+          end
 
-        # The name of the key on the associated records
-        def association_key_name
-          raise NotImplementedError
-        end
+          # The name of the key on the model which declares the association
+          def owner_key_name
+            reflection.join_foreign_key
+          end
 
-        # This is overridden by HABTM as the condition should be on the foreign_key column in
-        # the join table
-        def association_key
-          table[association_key_name]
-        end
+          def associate_records_to_owner(owner, records)
+            association = owner.association(reflection.name)
+            if reflection.collection?
+              association.target = records
+            else
+              association.target = records.first
+            end
+          end
 
-        # The name of the key on the model which declares the association
-        def owner_key_name
-          raise NotImplementedError
-        end
+          def owner_keys
+            @owner_keys ||= owners_by_key.keys
+          end
 
-        # We're converting to a string here because postgres will return the aliased association
-        # key in a habtm as a string (for whatever reason)
-        def owners_by_key
-          @owners_by_key ||= owners.group_by do |owner|
-            key = owner[owner_key_name]
-            key && key.to_s
+          def owners_by_key
+            @owners_by_key ||= owners.each_with_object({}) do |owner, result|
+              key = convert_key(owner[owner_key_name])
+              (result[key] ||= []) << owner if key
+            end
           end
-        end
 
-        def options
-          reflection.options
-        end
+          def key_conversion_required?
+            unless defined?(@key_conversion_required)
+              @key_conversion_required = (association_key_type != owner_key_type)
+            end
 
-        private
+            @key_conversion_required
+          end
 
-        def associated_records_by_owner
-          owners_map = owners_by_key
-          owner_keys = owners_map.keys.compact
+          def convert_key(key)
+            if key_conversion_required?
+              key.to_s
+            else
+              key
+            end
+          end
 
-          if klass.nil? || owner_keys.empty?
-            records = []
-          else
-            # Some databases impose a limit on the number of ids in a list (in Oracle it's 1000)
-            # Make several smaller queries if necessary or make one query if the adapter supports it
-            sliced  = owner_keys.each_slice(model.connection.in_clause_length || owner_keys.size)
-            records = sliced.map { |slice| records_for(slice) }.flatten
+          def association_key_type
+            @klass.type_for_attribute(association_key_name).type
           end
 
-          # Each record may have multiple owners, and vice-versa
-          records_by_owner = Hash[owners.map { |owner| [owner, []] }]
-          records.each do |record|
-            owner_key = record[association_key_name].to_s
+          def owner_key_type
+            @model.type_for_attribute(owner_key_name).type
+          end
 
-            owners_map[owner_key].each do |owner|
-              records_by_owner[owner] << record
+          def records_for(ids)
+            scope.where(association_key_name => ids).load do |record|
+              # Processing only the first owner
+              # because the record is modified but not an owner
+              owner = owners_by_key[convert_key(record[association_key_name])].first
+              association = owner.association(reflection.name)
+              association.set_inverse_instance(record)
             end
           end
-          records_by_owner
-        end
-
-        def build_scope
-          scope = klass.scoped
 
-          scope = scope.where(process_conditions(options[:conditions]))
-          scope = scope.where(process_conditions(preload_options[:conditions]))
-
-          scope = scope.select(preload_options[:select] || options[:select] || table[Arel.star])
-          scope = scope.includes(preload_options[:include] || options[:include])
+          def scope
+            @scope ||= build_scope
+          end
 
-          if options[:as]
-            scope = scope.where(
-              klass.table_name => {
-                reflection.type => model.base_class.sti_name
-              }
-            )
+          def reflection_scope
+            @reflection_scope ||= reflection.scope ? reflection.scope_for(klass.unscoped) : klass.unscoped
           end
 
-          scope
-        end
+          def build_scope
+            scope = klass.scope_for_association
 
-        def process_conditions(conditions)
-          if conditions.respond_to?(:to_proc)
-            conditions = klass.send(:instance_eval, &conditions)
-          end
+            if reflection.type && !reflection.through_reflection?
+              scope.where!(reflection.type => model.polymorphic_name)
+            end
 
-          if conditions
-            klass.send(:sanitize_sql, conditions)
+            scope.merge!(reflection_scope) if reflection.scope
+            scope.merge!(preload_scope) if preload_scope
+            scope
           end
-        end
       end
     end
   end