module Mongoid::Criteria::Findable

Public Instance Methods

execute_or_raise(ids, multi) click to toggle source

Execute the criteria or raise an error if no documents found.

@example Execute or raise

criteria.execute_or_raise(id)

@param [ Object ] ids The arguments passed. @param [ true, false ] multi Whether there arguments were a list.

@raise [ Errors::DocumentNotFound ] If nothing returned.

@return [ Document, Array<Document> ] The document(s).

@since 2.0.0

# File lib/mongoid/criteria/findable.rb, line 21
def execute_or_raise(ids, multi)
  result = multiple_from_db(ids)
  check_for_missing_documents!(result, ids)
  multi ? result : result.first
end
find(*args) click to toggle source

Find the matchind document(s) in the criteria for the provided ids.

@example Find by an id.

criteria.find(BSON::ObjectId.new)

@example Find by multiple ids.

criteria.find([ BSON::ObjectId.new, BSON::ObjectId.new ])

@param [ Array<BSON::ObjectId> ] args The ids to search for.

@return [ Array<Document>, Document ] The matching document(s).

@since 1.0.0

# File lib/mongoid/criteria/findable.rb, line 40
def find(*args)
  ids = args.__find_args__
  raise_invalid if ids.any?(&:nil?)
  for_ids(ids).execute_or_raise(ids, args.multi_arged?)
end
for_ids(ids) click to toggle source

Adds a criterion to the Criteria that specifies an id that must be matched.

@example Add a single id criteria.

criteria.for_ids([ 1 ])

@example Add multiple id criteria.

criteria.for_ids([ 1, 2 ])

@param [ Array ] ids The array of ids.

@return [ Criteria ] The cloned criteria.

# File lib/mongoid/criteria/findable.rb, line 57
def for_ids(ids)
  ids = mongoize_ids(ids)
  if ids.size > 1
    send(id_finder, { _id: { "$in" => ids }})
  else
    send(id_finder, { _id: ids.first })
  end
end
multiple_from_db(ids) click to toggle source

Get the documents from the identity map, and if not found hit the database.

@example Get the documents from the map or criteria.

criteria.multiple_from_map_or_db(ids)

@param [ Array<Object> ] ids The searched ids.

@return [ Array<Document> ] The found documents.

# File lib/mongoid/criteria/findable.rb, line 75
def multiple_from_db(ids)
  return entries if embedded?
  ids = mongoize_ids(ids)
  ids.empty? ? [] : from_database(ids)
end

Private Instance Methods

from_database(ids) click to toggle source

Get documents from the database only.

@api private

@example Get documents from the database.

criteria.from_database(ids)

@param [ Array<Object> ] ids The ids to fetch with.

@return [ Array<Document> ] The matching documents.

@since 3.0.0

# File lib/mongoid/criteria/findable.rb, line 109
def from_database(ids)
  from_database_selector(ids).entries
end
from_database_selector(ids) click to toggle source
# File lib/mongoid/criteria/findable.rb, line 113
        def from_database_selector(ids)
  if ids.size > 1
    any_in(_id: ids)
  else
    where(_id: ids.first)
  end
end
id_finder() click to toggle source

Get the finder used to generate the id query.

@api private

@example Get the id finder.

criteria.id_finder

@return [ Symbol ] The name of the finder method.

@since 3.1.0

# File lib/mongoid/criteria/findable.rb, line 93
def id_finder
  @id_finder ||= extract_id ? :all_of : :where
end
mongoize_ids(ids) click to toggle source

Convert all the ids to their proper types.

@api private

@example Convert the ids.

criteria.mongoize_ids(ids)

@param [ Array<Object> ] ids The ids to convert.

@return [ Array<Object> ] The converted ids.

@since 3.0.0

# File lib/mongoid/criteria/findable.rb, line 133
def mongoize_ids(ids)
  ids.map do |id|
    id = id[:_id] if id.respond_to?(:keys) && id[:_id]
    klass.fields["_id"].mongoize(id)
  end
end
raise_invalid() click to toggle source

Convenience method of raising an invalid options error.

@example Raise the error.

criteria.raise_invalid

@raise [ Errors::InvalidOptions ] The error.

@since 2.0.0

# File lib/mongoid/criteria/findable.rb, line 148
def raise_invalid
  raise Errors::InvalidFind.new
end