activerecord 4.2.11.3 → 5.0.7.2

data/lib/active_record/associations/join_dependency/join_part.rb

@@ -62,8 +62,8 @@ module ActiveRecord
           hash
         end
 
-        def instantiate(row, aliases)
-          base_klass.instantiate(extract_record(row, aliases))
+        def instantiate(row, aliases, &block)
+          base_klass.instantiate(extract_record(row, aliases), &block)
         end
       end
     end

data/lib/active_record/associations/preloader.rb

@@ -54,6 +54,8 @@ module ActiveRecord
         autoload :BelongsTo,           'active_record/associations/preloader/belongs_to'
       end
 
+      NULL_RELATION = Struct.new(:values, :where_clause, :joins_values).new({}, Relation::WhereClause.empty, [])
+
       # Eager loads the named associations for the given Active Record record(s).
       #
       # In this description, 'association name' shall refer to the name passed
@@ -88,9 +90,6 @@ module ActiveRecord
       #   [ :books, :author ]
       #   { author: :avatar }
       #   [ :books, { author: :avatar } ]
-
-      NULL_RELATION = Struct.new(:values, :bind_values).new({}, [])
-
       def preload(records, associations, preload_scope = nil)
         records       = Array.wrap(records).compact.uniq
         associations  = Array.wrap(associations)
@@ -107,6 +106,7 @@ module ActiveRecord
 
       private
 
+      # Loads all the given data into +records+ for the +association+.
       def preloaders_on(association, records, scope)
         case association
         when Hash
@@ -116,7 +116,7 @@ module ActiveRecord
         when String
           preloaders_for_one(association.to_sym, records, scope)
         else
-          raise ArgumentError, "#{association.inspect} was not recognised for preload"
+          raise ArgumentError, "#{association.inspect} was not recognized for preload"
         end
       end
 
@@ -132,6 +132,11 @@ module ActiveRecord
         }
       end
 
+      # Loads all the given data into +records+ for a singular +association+.
+      #
+      # Functions by instantiating a preloader class such as Preloader::HasManyThrough and
+      # call the +run+ method for each passed in class in the +records+ argument.
+      #
       # Not all records have the same class, so group then preload group on the reflection
       # itself so that if various subclass share the same association then we do not split
       # them unnecessarily
@@ -179,8 +184,13 @@ module ActiveRecord
         def self.new(klass, owners, reflection, preload_scope); self; end
         def self.run(preloader); end
         def self.preloaded_records; []; end
+        def self.owners; []; end
       end
 
+      # Returns a class containing the logic needed to load preload the data
+      # and attach it to a relation. For example +Preloader::Association+ or
+      # +Preloader::HasManyThrough+. The class returned implements a `run` method
+      # that accepts a preloader.
       def preloader_for(reflection, owners, rhs_klass)
         return NullPreloader unless rhs_klass
 

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

@@ -12,7 +12,6 @@ module ActiveRecord
           @preload_scope = preload_scope
           @model         = owners.first && owners.first.class
           @scope         = nil
-          @owners_by_key = nil
           @preloaded_records = []
         end
 
@@ -33,7 +32,7 @@ module ActiveRecord
         end
 
         def query_scope(ids)
-          scope.where(association_key.in(ids))
+          scope.where(association_key_name => ids)
         end
 
         def table
@@ -48,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
@@ -56,18 +55,6 @@ module ActiveRecord
           raise NotImplementedError
         end
 
-        def owners_by_key
-          @owners_by_key ||= if key_conversion_required?
-                               owners.group_by do |owner|
-                                 owner[owner_key_name].to_s
-                               end
-                             else
-                               owners.group_by do |owner|
-                                 owner[owner_key_name]
-                               end
-                             end
-        end
-
         def options
           reflection.options
         end
@@ -75,32 +62,47 @@ module ActiveRecord
         private
 
         def associated_records_by_owner(preloader)
-          owners_map = owners_by_key
-          owner_keys = owners_map.keys.compact
-
-          # Each record may have multiple owners, and vice-versa
-          records_by_owner = owners.each_with_object({}) do |owner,h|
-            h[owner] = []
+          records = load_records do |record|
+            owner = owners_by_key[convert_key(record[association_key_name])]
+            association = owner.association(reflection.name)
+            association.set_inverse_instance(record)
           end
 
-          if owner_keys.any?
-            # 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(klass.connection.in_clause_length || owner_keys.size)
+          owners.each_with_object({}) do |owner, result|
+            result[owner] = records[convert_key(owner[owner_key_name])] || []
+          end
+        end
 
-            records = load_slices sliced
-            records.each do |record, owner_key|
-              owners_map[owner_key].each do |owner|
-                records_by_owner[owner] << record
-              end
+        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
 
-          records_by_owner
+        def owners_by_key
+          unless defined?(@owners_by_key)
+            @owners_by_key = owners.each_with_object({}) do |owner, h|
+              h[convert_key(owner[owner_key_name])] = owner
+            end
+          end
+          @owners_by_key
         end
 
         def key_conversion_required?
-          association_key_type != owner_key_type
+          @key_conversion_required ||= association_key_type != owner_key_type
+        end
+
+        def convert_key(key)
+          if key_conversion_required?
+            key.to_s
+          else
+            key
+          end
         end
 
         def association_key_type
@@ -111,54 +113,33 @@ module ActiveRecord
           @model.type_for_attribute(owner_key_name.to_s).type
         end
 
-        def load_slices(slices)
-          @preloaded_records = slices.flat_map { |slice|
-            records_for(slice)
-          }
-
-          @preloaded_records.map { |record|
-            key = record[association_key_name]
-            key = key.to_s if key_conversion_required?
-
-            [record, key]
-          }
+        def load_records(&block)
+          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).load(&block)
+          end
+          @preloaded_records.group_by do |record| 
+            convert_key(record[association_key_name])
+          end
         end
 
         def reflection_scope
-          @reflection_scope ||= reflection.scope ? klass.unscoped.instance_exec(nil, &reflection.scope) : klass.unscoped
+          @reflection_scope ||= reflection.scope_for(klass)
         end
 
         def build_scope
-          scope = klass.unscoped
-
-          values         = reflection_scope.values
-          reflection_binds = reflection_scope.bind_values
-          preload_values = preload_scope.values
-          preload_binds  = preload_scope.bind_values
-
-          scope.where_values      = Array(values[:where])      + Array(preload_values[:where])
-          scope.references_values = Array(values[:references]) + Array(preload_values[:references])
-          scope.bind_values       = (reflection_binds + preload_binds)
-
-          scope._select!   preload_values[:select] || values[:select] || table[Arel.star]
-          scope.includes! preload_values[:includes] || values[:includes]
-          scope.joins! preload_values[:joins] || values[:joins]
-          scope.order! preload_values[:order] || values[:order]
-
-          if preload_values[:reordering] || values[:reordering]
-            scope.reordering_value = true
-          end
-
-          if preload_values[:readonly] || values[:readonly]
-            scope.readonly!
-          end
+          scope = klass.scope_for_association
 
-          if options[:as]
-            scope.where!(klass.table_name => { reflection.type => model.base_class.sti_name })
+          if reflection.type
+            scope.where!(reflection.type => model.base_class.sti_name)
           end
 
-          scope.unscope_values = Array(values[:unscope]) + Array(preload_values[:unscope])
-          klass.default_scoped.merge(scope)
+          scope.merge!(reflection_scope)
+          scope.merge!(preload_scope) if preload_scope != NULL_RELATION
+          scope
         end
       end
     end

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

@@ -2,22 +2,15 @@ module ActiveRecord
   module Associations
     class Preloader
       class CollectionAssociation < Association #:nodoc:
-
         private
 
-        def build_scope
-          super.order(preload_scope.values[:order] || reflection_scope.values[:order])
-        end
-
         def preload(preloader)
           associated_records_by_owner(preloader).each do |owner, records|
             association = owner.association(reflection.name)
             association.loaded!
             association.target.concat(records)
-            records.each { |record| association.set_inverse_instance(record) }
           end
         end
-
       end
     end
   end

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

@@ -8,7 +8,7 @@ module ActiveRecord
           records_by_owner = super
 
           if reflection_scope.distinct_value
-            records_by_owner.each_value { |records| records.uniq! }
+            records_by_owner.each_value(&:uniq!)
           end
 
           records_by_owner

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

@@ -2,7 +2,6 @@ module ActiveRecord
   module Associations
     class Preloader
       class HasOne < SingularAssociation #:nodoc:
-
         def association_key_name
           reflection.foreign_key
         end
@@ -10,13 +9,6 @@ module ActiveRecord
         def owner_key_name
           reflection.active_record_primary_key
         end
-
-        private
-
-        def build_scope
-          super.order(preload_scope.values[:order] || reflection_scope.values[:order])
-        end
-
       end
     end
   end

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

@@ -11,7 +11,6 @@ module ActiveRecord
 
             association = owner.association(reflection.name)
             association.target = record
-            association.set_inverse_instance(record) if record
           end
         end
 

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

@@ -18,7 +18,8 @@ module ActiveRecord
           through_records = owners.map do |owner|
             association = owner.association through_reflection.name
 
-            [owner, Array(association.reader)]
+            center = target_records_from_association(association)
+            [owner, Array(center)]
           end
 
           reset_association owners, through_reflection.name
@@ -37,28 +38,35 @@ module ActiveRecord
             }
           end
 
-          record_offset = {}
-          @preloaded_records.each_with_index do |record,i|
-            record_offset[record] = i
-          end
-
-          through_records.each_with_object({}) { |(lhs,center),records_by_owner|
+          through_records.each_with_object({}) do |(lhs,center), records_by_owner|
             pl_to_middle = center.group_by { |record| middle_to_pl[record] }
 
             records_by_owner[lhs] = pl_to_middle.flat_map do |pl, middles|
               rhs_records = middles.flat_map { |r|
                 association = r.association source_reflection.name
 
-                association.reader
+                target_records_from_association(association)
               }.compact
 
-              rhs_records.sort_by { |rhs| record_offset[rhs] }
+              # Respect the order on `reflection_scope` if it exists, else use the natural order.
+              if reflection_scope.values[:order].present?
+                @id_map ||= id_to_index_map @preloaded_records
+                rhs_records.sort_by { |rhs| @id_map[rhs] }
+              else
+                rhs_records
+              end
             end
-          }
+          end
         end
 
         private
 
+        def id_to_index_map(ids)
+          id_map = {}
+          ids.each_with_index { |id, index| id_map[id] = index }
+          id_map
+        end
+
         def reset_association(owners, association_name)
           should_reset = (through_scope != through_reflection.klass.unscoped) ||
              (reflection.options[:source_type] && through_reflection.collection?)
@@ -71,25 +79,36 @@ module ActiveRecord
           end
         end
 
-
         def through_scope
           scope = through_reflection.klass.unscoped
+          values = reflection_scope.values
 
           if options[:source_type]
             scope.where! reflection.foreign_type => options[:source_type]
           else
-            unless reflection_scope.where_values.empty?
-              scope.includes_values = Array(reflection_scope.values[:includes] || options[:source])
-              scope.where_values    = reflection_scope.values[:where]
-              scope.bind_values     = reflection_scope.bind_values
+            unless reflection_scope.where_clause.empty?
+              scope.includes_values = Array(values[:includes] || options[:source])
+              scope.where_clause = reflection_scope.where_clause
+              if joins = values[:joins]
+                scope.joins!(source_reflection.name => joins)
+              end
+              if left_outer_joins = values[:left_outer_joins]
+                scope.left_outer_joins!(source_reflection.name => left_outer_joins)
+              end
             end
 
-            scope.references! reflection_scope.values[:references]
-            scope = scope.order reflection_scope.values[:order] if scope.eager_loading?
+            scope.references! values[:references]
+            if scope.eager_loading? && order_values = values[:order]
+              scope = scope.order(order_values)
+            end
           end
 
           scope
         end
+
+        def target_records_from_association(association)
+          association.loaded? ? association.target : association.reader
+        end
       end
     end
   end

data/lib/active_record/associations/singular_association.rb

@@ -4,6 +4,11 @@ module ActiveRecord
       # Implements the reader method, e.g. foo.bar for Foo.has_one :bar
       def reader(force_reload = false)
         if force_reload && klass
+          ActiveSupport::Deprecation.warn(<<-MSG.squish)
+            Passing an argument to force an association to reload is now
+            deprecated and will be removed in Rails 5.1. Please call `reload_#{reflection.name}` instead.
+          MSG
+
           klass.uncached { reload }
         elsif !loaded? || stale_target?
           reload
@@ -32,6 +37,13 @@ module ActiveRecord
         record
       end
 
+      # Implements the reload reader method, e.g. foo.reload_bar for
+      # Foo.has_one :bar
+      def force_reload_reader
+        klass.uncached { reload }
+        target
+      end
+
       private
 
         def create_scope
@@ -39,7 +51,7 @@ module ActiveRecord
         end
 
         def get_records
-          return scope.limit(1).to_a if skip_statement_cache?
+          return scope.limit(1).records if skip_statement_cache?
 
           conn = klass.connection
           sc = reflection.association_scope_cache(conn, owner) do