activerecord 3.2.19 → 5.0.0

data/lib/active_record/associations/join_dependency.rb

@@ -1,213 +1,297 @@
 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
+      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
+            }
+          }
+          @name_and_alias_cache = tables.each_with_object({}) { |table,h|
+            h[table.node] = table.columns.map { |column|
+              [column.name, column.alias]
+            }
+          }
+        end
 
-      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
-
-      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)
+        def columns
+          @tables.flat_map(&:column_aliases)
         end
-        self
-      end
 
-      def join_associations
-        join_parts.last(join_parts.length - 1)
-      end
+        # An array of [column_name, alias] pairs for the table
+        def column_aliases(node)
+          @name_and_alias_cache[node]
+        end
 
-      def join_base
-        join_parts.first
-      end
+        def column_alias(node, column)
+          @alias_cache[node][column]
+        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
+        class Table < Struct.new(:node, :columns) # :nodoc:
+          def table
+            Arel::Nodes::TableAlias.new node.table, node.aliased_table_name
+          end
 
-      def instantiate(rows)
-        primary_key = join_base.aliased_primary_key
-        parents = {}
+          def column_aliases
+            t = table
+            columns.map { |column| t[column.name].as Arel.sql column.alias }
+          end
+        end
+        Column = Struct.new(:name, :alias)
+      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
+      attr_reader :alias_tracker, :base_klass, :join_root
 
-        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
-
-            remove_duplicate_results!(reflection.klass, parent_records, associations[name]) unless parent_records.empty?
+          associations.each do |k,v|
+            cache = hash[k] ||= {}
+            walk_tree v, cache
           end
+        else
+          raise ConfigurationError, associations.inspect
         end
       end
 
-      protected
+      # base is the base class on which operation is taking place.
+      # associations is the list of associations which are joined using hash, symbol or array.
+      # joins is the list of all string join commands and arel nodes.
+      #
+      #  Example :
+      #
+      #  class Physician < ActiveRecord::Base
+      #    has_many :appointments
+      #    has_many :patients, through: :appointments
+      #  end
+      #
+      #  If I execute `@physician.patients.to_a` then
+      #    base # => Physician
+      #    associations # => []
+      #    joins # =>  [#<Arel::Nodes::InnerJoin: ...]
+      #
+      #  However if I execute `Physician.joins(:appointments).to_a` then
+      #    base # => Physician
+      #    associations # => [:appointments]
+      #    joins # =>  []
+      #
+      def initialize(base, associations, joins)
+        @alias_tracker = AliasTracker.create_with_joins(base.connection, base.table_name, joins, base.type_caster)
+        tree = self.class.make_tree associations
+        @join_root = JoinBase.new base, build(tree, base)
+        @join_root.children.each { |child| construct_tables! @join_root, child }
+      end
 
-      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]
-        end
-        ref[association.reflection.name] ||= {}
+      def reflections
+        join_root.drop(1).map!(&:reflection)
       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 on #{parent.active_record.name}; 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 join_constraints(outer_joins, join_type)
+        joins = join_root.children.flat_map { |child|
+
+          if join_type == Arel::Nodes::OuterJoin
+            make_left_outer_joins join_root, child
+          else
+            make_inner_joins join_root, 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)
+        }
+
+        joins.concat outer_joins.flat_map { |oj|
+          if join_root.match? oj.join_root
+            walk join_root, oj.join_root
+          else
+            oj.join_root.children.flat_map { |child|
+              make_outer_joins oj.join_root, child
+            }
           end
-        else
-          raise ConfigurationError, associations.inspect
-        end
+        }
+      end
+
+      def 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
 
-      def find_join_association(name_or_reflection, parent)
-        if String === name_or_reflection
-          name_or_reflection = name_or_reflection.to_sym
+      def instantiate(result_set, aliases)
+        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)
+            construct(parent, join_root, row_hash, result_set, seen, model_cache, aliases)
+          }
         end
 
-        join_associations.detect { |j|
-          j.reflection == name_or_reflection && j.parent == parent
+        parents.values
+      end
+
+      private
+
+      def make_constraints(parent, child, tables, join_type)
+        chain         = child.reflection.chain
+        foreign_table = parent.table
+        foreign_klass = parent.base_klass
+        child.join_constraints(foreign_table, foreign_klass, child, join_type, tables, child.reflection.scope_chain, chain)
+      end
+
+      def make_outer_joins(parent, child)
+        tables    = table_aliases_for(parent, child)
+        join_type = Arel::Nodes::OuterJoin
+        info      = make_constraints parent, child, tables, join_type
+
+        [info] + child.children.flat_map { |c| make_outer_joins(child, c) }
+      end
+
+      def make_left_outer_joins(parent, child)
+        tables    = child.tables
+        join_type = Arel::Nodes::OuterJoin
+        info      = make_constraints parent, child, tables, join_type
+
+        [info] + child.children.flat_map { |c| make_left_outer_joins(child, c) }
+      end
+
+      def make_inner_joins(parent, child)
+        tables    = child.tables
+        join_type = Arel::Nodes::InnerJoin
+        info      = make_constraints parent, child, tables, join_type
+
+        [info] + child.children.flat_map { |c| make_inner_joins(child, c) }
+      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)
+          )
         }
       end
 
-      def remove_uniq_by_reflection(reflection, records)
-        if reflection && reflection.collection?
-          records.each { |record| record.send(reflection.name).target.uniq! }
-        end
+      def construct_tables!(parent, node)
+        node.tables = table_aliases_for(parent, node)
+        node.children.each { |child| construct_tables! node, child }
       end
 
-      def build_join_association(reflection, parent)
-        JoinAssociation.new(reflection, self, parent)
+      def table_alias_for(reflection, parent, join)
+        name = "#{reflection.plural_name}_#{parent.table_name}"
+        name << "_join" if join
+        name
       end
 
-      def construct(parent, associations, join_parts, row)
-        case associations
-        when Symbol, String
-          name = associations.to_s
+      def walk(left, right)
+        intersection, missing = right.children.map { |node1|
+          [left.children.find { |node2| node1.match? node2 }, node1]
+        }.partition(&:first)
 
-          join_part = join_parts.detect { |j|
-            j.reflection.name.to_s == name &&
-              j.parent_table_name == parent.class.table_name }
+        ojs = missing.flat_map { |_,n| make_outer_joins left, n }
+        intersection.flat_map { |l,r| walk l, r }.concat ojs
+      end
 
-            raise(ConfigurationError, "No such association") unless join_part
+      def find_reflection(klass, name)
+        klass._reflect_on_association(name) or
+          raise ConfigurationError, "Can't join '#{ klass.name }' to association named '#{ name }'; perhaps you misspelled it?"
+      end
 
-            join_parts.delete(join_part)
-            construct_association(parent, join_part, row)
-        when Array
-          associations.each do |association|
-            construct(parent, association, join_parts, row)
-          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
+      def build(associations, base_klass)
+        associations.map do |name, right|
+          reflection = find_reflection base_klass, name
+          reflection.check_validity!
+          reflection.check_eager_loadable!
+
+          if reflection.polymorphic?
+            raise EagerLoadPolymorphicError.new(reflection)
           end
-        else
-          raise ConfigurationError, associations.inspect
+
+          JoinAssociation.new reflection, build(right, reflection.klass)
         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(ar_parent, parent, row, rs, seen, model_cache, aliases)
+        return if ar_parent.nil?
 
-        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)
+        parent.children.each do |node|
+          if node.reflection.collection?
+            other = ar_parent.association(node.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)
+          elsif ar_parent.association_cached?(node.reflection.name)
+            model = ar_parent.association(node.reflection.name).target
+            construct(model, node, row, rs, seen, model_cache, aliases)
+            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.base_klass][id]
+
+          if model
+            construct(model, node, row, rs, seen, model_cache, aliases)
           else
-            raise ConfigurationError, "unknown macro: #{join_part.reflection.macro}"
+            model = construct_model(ar_parent, node, row, model_cache, id, aliases)
+            model.readonly!
+            seen[ar_parent.object_id][node.base_klass][id] = model
+            construct(model, node, row, rs, seen, model_cache, aliases)
           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)
+      def construct_model(record, node, row, model_cache, id, aliases)
+        model = model_cache[node][id] ||= node.instantiate(row,
+                                                           aliases.column_aliases(node))
+        other = record.association(node.reflection.name)
+
+        if node.reflection.collection?
+          other.target.push(model)
+        else
+          other.target = model
+        end
+
+        other.set_inverse_instance(model)
+        model
       end
     end
   end

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

@@ -2,34 +2,37 @@ 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
+        attr_reader :owners, :reflection, :preload_scope, :model, :klass
+        attr_reader :preloaded_records
+
+        def initialize(klass, owners, reflection, preload_scope)
+          @klass         = klass
+          @owners        = owners
+          @reflection    = reflection
+          @preload_scope = preload_scope
+          @model         = owners.first && owners.first.class
+          @scope         = nil
+          @preloaded_records = []
         end
 
-        def run
-          unless owners.first.association(reflection.name).loaded?
-            preload
-          end
+        def run(preloader)
+          preload(preloader)
         end
 
-        def preload
+        def preload(preloader)
           raise NotImplementedError
         end
 
-        def scoped
-          @scoped ||= build_scope
+        def scope
+          @scope ||= build_scope
         end
 
         def records_for(ids)
-          scoped.where(association_key.in(ids))
+          query_scope(ids)
+        end
+
+        def query_scope(ids)
+          scope.where(association_key_name => ids)
         end
 
         def table
@@ -44,7 +47,7 @@ module ActiveRecord
         # 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]
+          klass.arel_attribute(association_key_name, table)
         end
 
         # The name of the key on the model which declares the association
@@ -52,72 +55,104 @@ module ActiveRecord
           raise NotImplementedError
         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
-          end
-        end
-
         def options
           reflection.options
         end
 
         private
 
-        def associated_records_by_owner
-          owners_map = owners_by_key
-          owner_keys = owners_map.keys.compact
+        def associated_records_by_owner(preloader)
+          records = load_records
+          owners.each_with_object({}) do |owner, result|
+            result[owner] = records[convert_key(owner[owner_key_name])] || []
+          end
+        end
 
-          if klass.nil? || owner_keys.empty?
-            records = []
+        def owner_keys
+          unless defined?(@owner_keys)
+            @owner_keys = owners.map do |owner|
+              owner[owner_key_name]
+            end
+            @owner_keys.uniq!
+            @owner_keys.compact!
+          end
+          @owner_keys
+        end
+
+        def key_conversion_required?
+          @key_conversion_required ||= association_key_type != owner_key_type
+        end
+
+        def convert_key(key)
+          if key_conversion_required?
+            key.to_s
           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
+            key
           end
+        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 association_key_type
+          @klass.type_for_attribute(association_key_name.to_s).type
+        end
 
-            owners_map[owner_key].each do |owner|
-              records_by_owner[owner] << record
-            end
+        def owner_key_type
+          @model.type_for_attribute(owner_key_name.to_s).type
+        end
+
+        def load_records
+          return {} if owner_keys.empty?
+          # 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
+          slices  = owner_keys.each_slice(klass.connection.in_clause_length || owner_keys.size)
+          @preloaded_records = slices.flat_map do |slice|
+            records_for(slice)
+          end
+          @preloaded_records.group_by do |record| 
+            convert_key(record[association_key_name])
           end
-          records_by_owner
+        end
+
+        def reflection_scope
+          @reflection_scope ||= reflection.scope ? klass.unscoped.instance_exec(nil, &reflection.scope) : klass.unscoped
         end
 
         def build_scope
-          scope = klass.scoped
+          scope = klass.unscoped
 
-          scope = scope.where(process_conditions(options[:conditions]))
-          scope = scope.where(process_conditions(preload_options[:conditions]))
+          values = reflection_scope.values
+          preload_values = preload_scope.values
 
-          scope = scope.select(preload_options[:select] || options[:select] || table[Arel.star])
-          scope = scope.includes(preload_options[:include] || options[:include])
+          scope.where_clause = reflection_scope.where_clause + preload_scope.where_clause
+          scope.references_values = Array(values[:references]) + Array(preload_values[:references])
 
-          if options[:as]
-            scope = scope.where(
-              klass.table_name => {
-                reflection.type => model.base_class.sti_name
-              }
-            )
+          if preload_values[:select] || values[:select]
+            scope._select!(preload_values[:select] || values[:select])
+          end
+          scope.includes! preload_values[:includes] || values[:includes]
+          if preload_scope.joins_values.any?
+            scope.joins!(preload_scope.joins_values)
+          else
+            scope.joins!(reflection_scope.joins_values)
           end
 
-          scope
-        end
+          if order_values = preload_values[:order] || values[:order]
+            scope.order!(order_values)
+          end
+
+          if preload_values[:reordering] || values[:reordering]
+            scope.reordering_value = true
+          end
+
+          if preload_values[:readonly] || values[:readonly]
+            scope.readonly!
+          end
 
-        def process_conditions(conditions)
-          if conditions.respond_to?(:to_proc)
-            conditions = klass.send(:instance_eval, &conditions)
+          if options[:as]
+            scope.where!(klass.table_name => { reflection.type => model.base_class.sti_name })
           end
 
-          conditions
+          scope.unscope_values = Array(values[:unscope]) + Array(preload_values[:unscope])
+          klass.default_scoped.merge(scope)
         end
       end
     end