mongoid 3.0.23 → 3.1.0

data/lib/mongoid/contextual/mongo.rb

@@ -4,6 +4,7 @@ require "mongoid/contextual/aggregable/mongo"
 require "mongoid/contextual/command"
 require "mongoid/contextual/eager"
 require "mongoid/contextual/find_and_modify"
+require "mongoid/contextual/geo_near"
 require "mongoid/contextual/map_reduce"
 
 module Mongoid
@@ -13,25 +14,10 @@ module Mongoid
       include Aggregable::Mongo
       include Atomic
       include Eager
+      include Queryable
 
-      # @attribute [r] collection The collection to query against.
-      # @attribute [r] criteria The criteria for the context.
-      # @attribute [r] klass The klass for the criteria.
       # @attribute [r] query The Moped query.
-      attr_reader :collection, :criteria, :klass, :query
-
-      # Is the enumerable of matching documents empty?
-      #
-      # @example Is the context empty?
-      #   context.blank?
-      #
-      # @return [ true, false ] If the context is empty.
-      #
-      # @since 3.0.0
-      def blank?
-        !exists?
-      end
-      alias :empty? :blank?
+      attr_reader :query
 
       # Is the context cached?
       #
@@ -145,12 +131,15 @@ module Mongoid
       # @example Do any documents exist for the context.
       #   context.exists?
       #
+      # @note We don't use count here since Mongo does not use counted
+      #   b-tree indexes, unless a count is already cached then that is
+      #   used to determine the value.
+      #
       # @return [ true, false ] If the count is more than zero.
       #
       # @since 3.0.0
       def exists?
-        # Don't use count here since Mongo does not use counted b-tree indexes
-        !query.dup.select(_id: 1).limit(1).entries.first.nil?
+        @exists ||= check_existence
       end
 
       # Run an explain on the criteria.
@@ -196,12 +185,63 @@ module Mongoid
       #
       # @since 3.0.0
       def first
-        apply_sorting
-        apply_id_sorting
-        with_eager_loading(query.first)
+        if cached? && cache_loaded?
+          documents.first
+        else
+          with_sorting do
+            with_eager_loading(query.first)
+          end
+        end
       end
       alias :one :first
 
+      # Execute a $geoNear command against the database.
+      #
+      # @example Find documents close to 10, 10.
+      #   context.geo_near([ 10, 10 ])
+      #
+      # @example Find with spherical distance.
+      #   context.geo_near([ 10, 10 ]).spherical
+      #
+      # @example Find with a max distance.
+      #   context.geo_near([ 10, 10 ]).max_distance(0.5)
+      #
+      # @example Provide a distance multiplier.
+      #   context.geo_near([ 10, 10 ]).distance_multiplier(1133)
+      #
+      # @param [ Array<Float> ] coordinates The coordinates.
+      #
+      # @return [ GeoNear ] The GeoNear command.
+      #
+      # @since 3.1.0
+      def geo_near(coordinates)
+        GeoNear.new(collection, criteria, coordinates)
+      end
+
+      # Invoke the block for each element of Contextual. Create a new array
+      # containing the values returned by the block.
+      #
+      # If the symbol field name is passed instead of the block, additional
+      # optimizations would be used.
+      #
+      # @example Map by some field.
+      #   context.map(:field1)
+      #
+      # @exmaple Map with block.
+      #   context.map(&:field1)
+      #
+      # @param [ Symbol ] field The field name.
+      #
+      # @return [ Array ] The result of mapping.
+      def map(field = nil, &block)
+        if block_given?
+          super(&block)
+        else
+          field = field.to_sym
+          criteria.only(field).map(&field.to_proc)
+        end
+      end
+
       # Create the new Mongo context. This delegates operations to the
       # underlying driver - in Mongoid's case Moped.
       #
@@ -230,8 +270,9 @@ module Mongoid
       #
       # @since 3.0.0
       def last
-        apply_inverse_sorting
-        with_eager_loading(query.first)
+        with_inverse_sorting do
+          with_eager_loading(query.first)
+        end
       end
 
       # Get's the number of documents matching the query selector.
@@ -276,6 +317,25 @@ module Mongoid
         MapReduce.new(collection, criteria, map, reduce)
       end
 
+      # Pluck the single field values from the database. Will return duplicates
+      # if they exist and only works for top level fields.
+      #
+      # @example Pluck a field.
+      #   context.pluck(:_id)
+      #
+      # @note This method will return the raw db values - it performs no custom
+      #   serialization.
+      #
+      # @param [ String, Symbol ] field The field to pluck.
+      #
+      # @return [ Array<Object> ] The plucked values.
+      #
+      # @since 3.1.0
+      def pluck(field)
+        normalized = field.to_s
+        query.select(normalized => 1).map{ |doc| doc[normalized] }.compact
+      end
+
       # Skips the provided number of documents.
       #
       # @example Skip the documents.
@@ -305,7 +365,10 @@ module Mongoid
         if block_given?
           super(&block)
         else
-          query.sort(values) and self
+          # update the criteria
+          @criteria = criteria.order_by(values)
+          apply_option(:sort)
+          self
         end
       end
 
@@ -314,7 +377,7 @@ module Mongoid
       # @example Update the first matching document.
       #   context.update({ "$set" => { name: "Smiths" }})
       #
-      # @param [ Hash ] attributes The new attributes for each document.
+      # @param [ Hash ] attributes The new attributes for the document.
       #
       # @return [ nil, false ] False if no attributes were provided.
       #
@@ -339,6 +402,24 @@ module Mongoid
 
       private
 
+      # Checks if any documents exist in the database.
+      #
+      # @api private
+      #
+      # @example Check for document existsence.
+      #   context.check_existence
+      #
+      # @return [ true, false ] If documents exist.
+      #
+      # @since 3.1.0
+      def check_existence
+        if cached? && cache_loaded?
+          !documents.empty?
+        else
+          @count ? @count > 0 : !query.dup.select(_id: 1).limit(1).entries.first.nil?
+        end
+      end
+
       # Update the documents for the provided method.
       #
       # @api private
@@ -355,7 +436,7 @@ module Mongoid
       def update_documents(attributes, method = :update)
         return false unless attributes
         attributes = Hash[attributes.map { |k, v| [klass.database_field_name(k.to_s), v] }]
-        query.send(method, attributes.__consolidate__)
+        query.send(method, attributes.__consolidate__(klass))
       end
 
       # Apply the field limitations.
@@ -372,55 +453,32 @@ module Mongoid
         end
       end
 
-      # Apply the skip option.
+      # Apply the options.
       #
       # @api private
       #
-      # @example Apply the skip option.
-      #   context.apply_skip
+      # @example Apply all options.
+      #   context.apply_options
       #
-      # @since 3.0.0
-      def apply_skip
-        if spec = criteria.options[:skip]
-          query.skip(spec)
+      # @since 3.1.0
+      def apply_options
+        apply_fields
+        [ :hint, :limit, :skip, :sort, :batch_size, :max_scan ].each do |name|
+          apply_option(name)
         end
       end
 
-      # Apply the limit option.
+      # Apply an option.
       #
       # @api private
       #
-      # @example Apply the limit option.
-      #   context.apply_limit
-      #
-      # @since 3.0.0
-      def apply_limit
-        if spec = criteria.options[:limit]
-          query.limit(spec)
-        end
-      end
-
-      # Map the sort symbols to the correct MongoDB values.
-      #
-      # @example Apply the sorting params.
-      #   context.apply_sorting
-      #
-      # @since 3.0.0
-      def apply_sorting
-        if spec = criteria.options[:sort]
-          query.sort(spec)
-        end
-      end
-
-      # Apply the hint option
-      #
-      # @example Apply the hint params.
-      #   context.apply_hint
+      # @example Apply the skip option.
+      #   context.apply_option(:skip)
       #
-      # @since 3.0.0
-      def apply_hint
-        if spec = criteria.options[:hint]
-          query.hint(spec)
+      # @since 3.1.0
+      def apply_option(name)
+        if spec = criteria.options[name]
+          query.send(name, spec)
         end
       end
 
@@ -429,27 +487,39 @@ module Mongoid
       #
       # @api private
       #
-      # @example Apply the id sorting params.
-      #   context.apply_dd_sorting
+      # @example Apply the id sorting params to the given block
+      #   context.with_sorting
       #
       # @since 3.0.0
-      def apply_id_sorting
-        unless criteria.options.has_key?(:sort)
-          query.sort(_id: 1)
+      def with_sorting
+        begin
+          unless criteria.options.has_key?(:sort)
+            query.sort(_id: 1)
+          end
+          yield
+        ensure
+          apply_option(:sort)
         end
       end
 
       # Map the inverse sort symbols to the correct MongoDB values.
       #
-      # @example Apply the inverse sorting params.
-      #   context.apply_inverse_sorting
+      #  @api private
+      #
+      # @example Apply the inverse sorting params to the given block
+      #   context.with_inverse_sorting
       #
       # @since 3.0.0
-      def apply_inverse_sorting
-        if spec = criteria.options[:sort]
-          query.sort(Hash[spec.map{|k, v| [k, -1*v]}])
-        else
-          query.sort(_id: -1)
+      def with_inverse_sorting
+        begin
+          if spec = criteria.options[:sort]
+            query.sort(Hash[spec.map{|k, v| [k, -1*v]}])
+          else
+            query.sort(_id: -1)
+          end
+          yield
+        ensure
+          apply_option(:sort)
         end
       end
 
@@ -524,20 +594,6 @@ module Mongoid
         end
       end
 
-      # Apply all the optional criterion.
-      #
-      # @example Apply the options.
-      #   context.apply_options
-      #
-      # @since 3.0.0
-      def apply_options
-        apply_fields
-        apply_limit
-        apply_skip
-        apply_sorting
-        apply_hint
-      end
-
       # If we are limiting results, we need to set the field limitations on a
       # thread local to avoid overriding the default values.
       #

data/lib/mongoid/contextual/queryable.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    module Queryable
+
+      # @attribute [r] collection The collection to query against.
+      # @attribute [r] criteria The criteria for the context.
+      # @attribute [r] klass The klass for the criteria.
+      attr_reader :collection, :criteria, :klass
+
+      # Is the enumerable of matching documents empty?
+      #
+      # @example Is the context empty?
+      #   context.blank?
+      #
+      # @return [ true, false ] If the context is empty.
+      #
+      # @since 3.0.0
+      def blank?
+        !exists?
+      end
+      alias :empty? :blank?
+    end
+  end
+end

data/lib/mongoid/copyable.rb

@@ -18,7 +18,10 @@ module Mongoid
     #
     # @return [ Document ] The new document.
     def clone
-      attrs = clone_document.except("_id")
+      # @note This next line is here to address #2704, even though having an
+      # _id and id field in the document would cause problems with Mongoid
+      # elsewhere.
+      attrs = clone_document.except("_id", "id")
       self.class.new(attrs, without_protection: true)
     end
     alias :dup :clone

data/lib/mongoid/criteria.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 require "mongoid/criterion/inspection"
+require "mongoid/criterion/findable"
 require "mongoid/criterion/marshalable"
+require "mongoid/criterion/modifiable"
 require "mongoid/criterion/scoping"
 
 module Mongoid
@@ -16,7 +18,9 @@ module Mongoid
     include Contextual
     include Origin::Queryable
     include Criterion::Inspection
+    include Criterion::Findable
     include Criterion::Marshalable
+    include Criterion::Modifiable
     include Criterion::Scoping
 
     attr_accessor :embedded, :klass
@@ -48,23 +52,6 @@ module Mongoid
       entries.as_json(options)
     end
 
-    # Build a document given the selector and return it.
-    # Complex criteria, such as $in and $or operations will get ignored.
-    #
-    # @example build the document.
-    #   Person.where(:title => "Sir").build
-    #
-    # @example Build with selectors getting ignored.
-    #   Person.where(:age.gt => 5).build
-    #
-    # @return [ Document ] A non-persisted document.
-    #
-    # @since 2.0.0
-    def build(attrs = {}, &block)
-      create_document(:new, attrs, &block)
-    end
-    alias :new :build
-
     # Tells the criteria that the cursor that gets returned needs to be
     # cached. This is so multiple iterations don't hit the database multiple
     # times, however this is not advisable when working with large data sets
@@ -90,41 +77,6 @@ module Mongoid
       options[:cache] == true
     end
 
-    # Create a document in the database given the selector and return it.
-    # Complex criteria, such as $in and $or operations will get ignored.
-    #
-    # @example Create the document.
-    #   Person.where(:title => "Sir").create
-    #
-    # @example Create with selectors getting ignored.
-    #   Person.where(:age.gt => 5).create
-    #
-    # @return [ Document ] A newly created document.
-    #
-    # @since 2.0.0.rc.1
-    def create(attrs = {}, &block)
-      create_document(:create, attrs, &block)
-    end
-
-    # Create a document in the database given the selector and return it.
-    # Complex criteria, such as $in and $or operations will get ignored.
-    # If validation fails, an error will be raised.
-    #
-    # @example Create the document.
-    #   Person.where(:title => "Sir").create
-    #
-    # @example Create with selectors getting ignored.
-    #   Person.where(:age.gt => 5).create
-    #
-    # @raise [ Errors::Validations ] on a validation error.
-    #
-    # @return [ Document ] A newly created document.
-    #
-    # @since 3.0.0
-    def create!(attrs = {}, &block)
-      create_document(:create!, attrs, &block)
-    end
-
     # Get the documents from the embedded criteria.
     #
     # @example Get the documents.
@@ -162,24 +114,6 @@ module Mongoid
       !!@embedded
     end
 
-    # Execute the criteria or raise an error if no documents found.
-    #
-    # @example Execute or raise
-    #   criteria.execute_or_raise(id)
-    #
-    # @param [ Object ] args The arguments passed.
-    #
-    # @raise [ Errors::DocumentNotFound ] If nothing returned.
-    #
-    # @return [ Document, Array<Document> ] The document(s).
-    #
-    # @since 2.0.0
-    def execute_or_raise(ids, multi)
-      result = multiple_from_map_or_db(ids)
-      check_for_missing_documents!(result, ids)
-      multi ? result : result.first
-    end
-
     # Extract a single id from the provided criteria. Could be in an $and
     # query or a straight _id query.
     #
@@ -226,72 +160,6 @@ module Mongoid
       end
     end
 
-    # Find the matchind document(s) in the criteria for the provided ids.
-    #
-    # @example Find by an id.
-    #   criteria.find(Moped::BSON::ObjectId.new)
-    #
-    # @example Find by multiple ids.
-    #   criteria.find([ Moped::BSON::ObjectId.new, Moped::BSON::ObjectId.new ])
-    #
-    # @param [ Array<Moped::BSON::ObjectId> ] args The ids to search for.
-    #
-    # @return [ Array<Document>, Document ] The matching document(s).
-    #
-    # @since 1.0.0
-    def find(*args)
-      ids = args.__find_args__
-      raise_invalid if ids.any?(&:nil?)
-      for_ids(ids).execute_or_raise(ids, args.multi_arged?)
-    end
-
-    # Find the first +Document+ given the conditions, or creates a new document
-    # with the conditions that were supplied.
-    #
-    # @example Find or create the document.
-    #   Person.find_or_create_by(:attribute => "value")
-    #
-    # @param [ Hash ] attrs The attributes to check.
-    #
-    # @return [ Document ] A matching or newly created document.
-    def find_or_create_by(attrs = {}, &block)
-      find_or(:create, attrs, &block)
-    end
-
-    # Find the first +Document+ given the conditions, or initializes a new document
-    # with the conditions that were supplied.
-    #
-    # @example Find or initialize the document.
-    #   Person.find_or_initialize_by(:attribute => "value")
-    #
-    # @param [ Hash ] attrs The attributes to check.
-    #
-    # @return [ Document ] A matching or newly initialized document.
-    def find_or_initialize_by(attrs = {}, &block)
-      find_or(:new, attrs, &block)
-    end
-
-    # 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.
-    def for_ids(ids)
-      ids = mongoize_ids(ids)
-      method = extract_id ? :all_of : :where
-      if ids.size > 1
-        send(method, { _id: { "$in" => ids }})
-      else
-        send(method, { _id: ids.first })
-      end
-    end
-
     # When freezing a criteria we need to initialize the context first
     # otherwise the setting of the context on attempted iteration will raise a
     # runtime error.
@@ -306,39 +174,6 @@ module Mongoid
       context and inclusions and super
     end
 
-    # Get the document from the identity map, and if not found hit the
-    # database.
-    #
-    # @example Get the document from the map or criteria.
-    #   criteria.from_map_or_db
-    #
-    # @return [ Document ] The found document.
-    #
-    # @since 2.2.1
-    def from_map_or_db
-      id = extract_id
-      id = klass.fields["_id"].mongoize(id) if id
-      doc = IdentityMap.get(klass, id || selector.except("_type"))
-      return nil if doc == {}
-      doc && doc.matches?(selector) ? doc : first
-    end
-
-    # 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 [ ids ] The searched ids.
-    #
-    # @return [ Array<Document> ] The found documents.
-    def multiple_from_map_or_db(ids)
-      return entries if embedded?
-      ids = mongoize_ids(ids)
-      result = from_identity_map(ids)
-      ids.empty? ? result : result + from_database(ids)
-    end
-
     # Initialize the new criteria.
     #
     # @example Init the new criteria.
@@ -468,7 +303,7 @@ module Mongoid
     #
     # @since 1.0.0
     def only(*args)
-      return clone if args.empty?
+      return clone if args.flatten.empty?
       args = args.flatten
       if klass.hereditary?
         super(*args.push(:_type))
@@ -589,6 +424,24 @@ module Mongoid
       crit
     end
 
+    # Find documents by the provided javascript and scope. Uses a $where but is
+    # different from +Criteria#where+ in that it will pass a code object to the
+    # query instead of a pure string. Safe against Javascript injection
+    # attacks.
+    #
+    # @example Find by javascript.
+    #   Band.for_js("this.name = param", param: "Tool")
+    #
+    # @param [ String ] javascript The javascript to execute in the $where.
+    # @param [ Hash ] scope The scope for the code.
+    #
+    # @return [ Criteria ] The criteria.
+    #
+    # @since 3.1.0
+    def for_js(javascript, scope = {})
+      js_query(Moped::BSON::Code.new(javascript, scope))
+    end
+
     private
 
     # Are documents in the query missing, and are we configured to raise an
@@ -612,45 +465,6 @@ module Mongoid
       end
     end
 
-    # Create a document given the provided method and attributes from the
-    # existing selector.
-    #
-    # @api private
-    #
-    # @example Create a new document.
-    #   criteria.create_document(:new, {})
-    #
-    # @param [ Symbol ] method Either :new or :create.
-    # @param [ Hash ] attrs Additional attributes to use.
-    #
-    # @return [ Document ] The new or saved document.
-    #
-    # @since 3.0.0
-    def create_document(method, attrs = {}, &block)
-      klass.__send__(method,
-        selector.reduce(attrs) do |hash, (key, value)|
-          unless key.to_s =~ /\$/ || value.is_a?(Hash)
-            hash[key] = value
-          end
-          hash
-        end, &block)
-    end
-
-    # Find the first object or create/initialize it.
-    #
-    # @api private
-    #
-    # @example Find or perform an action.
-    #   Person.find_or(:create, :name => "Dev")
-    #
-    # @param [ Symbol ] method The method to invoke.
-    # @param [ Hash ] attrs The attributes to query or set.
-    #
-    # @return [ Document ] The first or new document.
-    def find_or(method, attrs = {}, &block)
-      where(attrs).first || send(method, attrs, &block)
-    end
-
     # Clone or dup the current +Criteria+. This will return a new criteria with
     # the selector, options, klass, embedded options, etc intact.
     #
@@ -675,44 +489,6 @@ module Mongoid
       super
     end
 
-    # 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
-    def from_database(ids)
-      (ids.size > 1 ? any_in(id: ids) : where(id: ids.first)).entries
-    end
-
-    # Get documents from the identity map only.
-    #
-    # @api private
-    #
-    # @example Get documents from the identity map.
-    #   criteria.from_identity_map(ids)
-    #
-    # @param [ Array<Object> ] ids The ids to fetch with.
-    #
-    # @return [ Array<Document> ] The matching documents.
-    #
-    # @since 3.0.0
-    def from_identity_map(ids)
-      result = []
-      selection = selector_with_type_selection
-      ids.reject! do |id|
-        doc = IdentityMap.get(klass, id)
-        doc && doc.matches?(selection) ? result.push(doc) : false
-      end
-      result
-    end
-
     # Used for chaining +Criteria+ scopes together in the for of class methods
     # on the +Document+ the criteria is for.
     #
@@ -748,34 +524,6 @@ module Mongoid
       selector.merge!(type_selection) if type_selectable?
     end
 
-    # 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
-    def mongoize_ids(ids)
-      ids.map{ |id| klass.fields["_id"].mongoize(id) }
-    end
-
-    # Convenience method of raising an invalid options error.
-    #
-    # @example Raise the error.
-    #   criteria.raise_invalid
-    #
-    # @raise [ Errors::InvalidOptions ] The error.
-    #
-    # @since 2.0.0
-    def raise_invalid
-      raise Errors::InvalidFind.new
-    end
-
     # Is the criteria type selectable?
     #
     # @api private