module Mongoid::Association::EagerLoadable

This module defines the eager loading behavior for criteria.

Public Instance Methods

eager_load(docs) click to toggle source

Load the associations for the given documents.

@param [ Array<Mongoid::Document> ] docs The documents.

@return [ Array<Mongoid::Document> ] The given documents.

# File lib/mongoid/association/eager_loadable.rb, line 25
def eager_load(docs)
  docs.tap do |d|
    if eager_loadable?
      preload(criteria.inclusions, d)
    end
  end
end
eager_loadable?() click to toggle source

Indicates whether the criteria has association inclusions which should be eager loaded.

@return [ true | false ] Whether to eager load.

# File lib/mongoid/association/eager_loadable.rb, line 16
def eager_loadable?
  !criteria.inclusions.empty?
end
preload(associations, docs) click to toggle source

Load the associations for the given documents. This will be done recursively to load the associations of the given documents’ associated documents.

@param [ Array<Mongoid::Association::Relatable> ] associations

The associations to load.

@param [ Array<Mongoid::Document> ] docs The documents.

# File lib/mongoid/association/eager_loadable.rb, line 40
def preload(associations, docs)
  assoc_map = associations.group_by(&:inverse_class_name)
  docs_map = {}
  queue = [ klass.to_s ]

  while klass = queue.shift
    if as = assoc_map.delete(klass)
      as.each do |assoc|
        queue << assoc.class_name

        # If this class is nested in the inclusion tree, only load documents
        # for the association above it. If there is no parent association,
        # we will include documents from the documents passed to this method.
        ds = docs
        if assoc.parent_inclusions.length > 0
          ds = assoc.parent_inclusions.map{ |p| docs_map[p].to_a }.flatten
        end

        res = assoc.relation.eager_loader([assoc], ds).run

        docs_map[assoc.name] ||= [].to_set
        docs_map[assoc.name].merge(res)
      end
    end
  end
end