mongoid 5.4.1 → 6.0.0.beta

data/lib/mongoid/composable.rb

@@ -12,6 +12,7 @@ require "mongoid/scopable"
 require "mongoid/serializable"
 require "mongoid/shardable"
 require "mongoid/stateful"
+require "mongoid/cacheable"
 require "mongoid/traversable"
 require "mongoid/validatable"
 
@@ -32,7 +33,6 @@ module Mongoid
     include ActiveModel::Model
     include ActiveModel::ForbiddenAttributesProtection
     include ActiveModel::Serializers::JSON
-    include ActiveModel::Serializers::Xml
     include Atomic
     include Changeable
     include Clients
@@ -50,6 +50,7 @@ module Mongoid
     include Serializable
     include Shardable
     include Stateful
+    include Cacheable
     include Threaded::Lifecycle
     include Traversable
     include Validatable
@@ -76,6 +77,7 @@ module Mongoid
       Clients,
       Shardable,
       Stateful,
+      Cacheable,
       Threaded::Lifecycle,
       Traversable,
       Validatable,
@@ -84,6 +86,28 @@ module Mongoid
       ActiveModel::Validations
     ]
 
+    # These are methods names defined in included blocks that may conflict
+    # with user-defined relation or field names.
+    # They won't be in the list of Module.instance_methods on which the
+    # #prohibited_methods code below is dependent so we must track them
+    # separately.
+    #
+    # @return [ Array<Symbol> ] A list of reserved method names.
+    #
+    # @since 6.0.0
+    RESERVED_METHOD_NAMES = [ :fields,
+                              :aliased_fields,
+                              :localized_fields,
+                              :index_specifications,
+                              :shard_key_fields,
+                              :nested_attributes,
+                              :readonly_attributes,
+                              :storage_options,
+                              :cascades,
+                              :cyclic,
+                              :cache_timestamp_format
+                            ]
+
     class << self
 
       # Get a list of methods that would be a bad idea to define as field names
@@ -98,7 +122,7 @@ module Mongoid
       def prohibited_methods
         @prohibited_methods ||= MODULES.flat_map do |mod|
           mod.instance_methods.map(&:to_sym)
-        end
+        end + RESERVED_METHOD_NAMES
       end
     end
   end

data/lib/mongoid/config.rb

@@ -25,7 +25,7 @@ module Mongoid
     option :use_activesupport_time_zone, default: true
     option :use_utc, default: false
     option :log_level, default: :info
-    option :app_name, default: nil
+    option :belongs_to_required_by_default, default: true
 
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.

data/lib/mongoid/config/options.rb

@@ -31,7 +31,7 @@ module Mongoid
       def option(name, options = {})
         defaults[name] = settings[name] = options[:default]
 
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        class_eval <<-RUBY
           def #{name}
             settings[#{name.inspect}]
           end

data/lib/mongoid/contextual/aggregable/mongo.rb

@@ -124,6 +124,7 @@ module Mongoid
         def pipeline(field)
           db_field = "$#{database_field_name(field)}"
           pipeline = []
+          pipeline << { "$match" => criteria.selector }
           pipeline << { "$match" =>  criteria.exists(field => true).selector }
           pipeline << { "$sort" => criteria.options[:sort] } if criteria.options[:sort]
           pipeline << { "$skip" => criteria.options[:skip] } if criteria.options[:skip]

data/lib/mongoid/contextual/atomic.rb

@@ -106,21 +106,18 @@ module Mongoid
         view.update_many("$push" => collect_operations(pushes))
       end
 
-      # Perform an atomic $push/$each operation on the matching documents.
+      # Perform an atomic $pushAll operation on the matching documents.
       #
       # @example Push the values to the matching docs.
-      #   context.push_each(members: [ "Alan", "Fletch" ])
+      #   context.push(members: [ "Alan", "Fletch" ])
       #
       # @param [ Hash ] pushes The operations.
       #
       # @return [ nil ] Nil.
       #
-      # @since 5.4.0
-      def push_each(pushes)
-        push_each_updates = collect_operations(pushes).each.inject({}) do |ops, (field, elements)|
-          ops.merge!(field => { '$each' => elements })
-        end
-        view.update_many("$push" => push_each_updates)
+      # @since 3.0.0
+      def push_all(pushes)
+        view.update_many("$pushAll" => collect_operations(pushes))
       end
 
       # Perform an atomic $rename of fields on the matching documents.
@@ -160,7 +157,7 @@ module Mongoid
       # @example Unset the field on the matches.
       #   context.unset(:name)
       #
-      # @param [ String, Symbol, Array ] args The name of the fields.
+      # @param [ String, Symbol, Array ] fields The name of the fields.
       #
       # @return [ nil ] Nil.
       #

data/lib/mongoid/contextual/geo_near.rb

@@ -63,10 +63,9 @@ module Mongoid
       # @example Initialize the new map/reduce.
       #   MapReduce.new(criteria, map, reduce)
       #
-      # @param [ Mongo::Collection ] collection The collection to run the
-      #   operation on.
       # @param [ Criteria ] criteria The Mongoid criteria.
-      # @param [ String ] near
+      # @param [ String ] map The map js function.
+      # @param [ String ] reduce The reduce js function.
       #
       # @since 3.0.0
       def initialize(collection, criteria, near)

data/lib/mongoid/contextual/map_reduce.rb

@@ -32,13 +32,12 @@ module Mongoid
       #
       # @since 3.0.0
       def each
-        validate_out!
         if block_given?
-          @map_reduce.each do |doc|
+          documents.each do |doc|
             yield doc
           end
         else
-          @map_reduce.to_enum
+          to_enum
         end
       end
 
@@ -65,7 +64,7 @@ module Mongoid
       #
       # @since 3.0.0
       def finalize(function)
-        @map_reduce = @map_reduce.finalize(function)
+        command[:finalize] = function
         self
       end
 
@@ -80,9 +79,10 @@ module Mongoid
       #
       # @since 3.0.0
       def initialize(collection, criteria, map, reduce)
-        @collection = collection
-        @criteria = criteria
-        @map_reduce = @criteria.view.map_reduce(map, reduce)
+        @collection, @criteria = collection, criteria
+        command[:mapreduce] = collection.name.to_s
+        command[:map], command[:reduce] = map, reduce
+        apply_criteria_options
       end
 
       # Get the number of documents that were input into the map/reduce.
@@ -106,12 +106,11 @@ module Mongoid
       #
       # @since 3.0.0
       def js_mode
-        @map_reduce = @map_reduce.js_mode(true)
+        command[:jsMode] = true
         self
       end
 
       # Specifies where the map/reduce output is to be stored.
-      # Please see MongoDB documentation for supported map reduce options.
       #
       # @example Store output in memory.
       #   map_reduce.out(inline: 1)
@@ -125,9 +124,6 @@ module Mongoid
       # @example Store output in a collection, reducing existing documents.
       #   map_reduce.out(reduce: "collection_name")
       #
-      # @example Return results from map reduce.
-      #   map_reduce.out(inline: 1)
-      #
       # @param [ Hash ] location The place to store the results.
       #
       # @return [ MapReduce ] The map/reduce object.
@@ -138,7 +134,7 @@ module Mongoid
         normalized.update_values do |value|
           value.is_a?(::Symbol) ? value.to_s : value
         end
-        @map_reduce = @map_reduce.out(normalized)
+        command[:out] = normalized
         self
       end
 
@@ -163,12 +159,8 @@ module Mongoid
       #
       # @since 3.0.0
       def raw
-        validate_out!
-        cmd = command
-        opts = { read: cmd.delete(:read).options } if cmd[:read]
-        @map_reduce.database.command(cmd, opts || {}).first
+        results
       end
-      alias :results :raw
 
       # Execute the map/reduce, returning the raw output.
       # Useful when you don't care about map/reduce's ouptut.
@@ -204,7 +196,7 @@ module Mongoid
       #
       # @since 3.0.0
       def scope(object)
-        @map_reduce = @map_reduce.scope(object)
+        command[:scope] = object
         self
       end
 
@@ -240,14 +232,95 @@ module Mongoid
 }
       end
 
-      def command
-        @map_reduce.send(:map_reduce_spec)[:selector]
+      private
+
+      # Apply criteria specific options - query, sort, limit.
+      #
+      # @api private
+      #
+      # @example Apply the criteria options
+      #   map_reduce.apply_criteria_options
+      #
+      # @return [ nil ] Nothing.
+      #
+      # @since 3.0.0
+      def apply_criteria_options
+        command[:query] = criteria.selector
+        if sort = criteria.options[:sort]
+          command[:sort] = sort
+        end
+        if limit = criteria.options[:limit]
+          command[:limit] = limit
+        end
       end
 
-      private
+      # Get the result documents from the map/reduce. If the output was inline
+      # then we grab them from the results key. If the output was a temp
+      # collection then we need to execute a find on that collection.
+      #
+      # @api private
+      #
+      # @example Get the documents.
+      #   map_reduce.documents
+      #
+      # @return [ Array, Cursor ] The documents.
+      #
+      # @since 3.0.0
+      def documents
+        return results["results"] if results.has_key?("results")
+        view = client[output_collection].find
+        view.no_cursor_timeout if criteria.options[:timeout] == false
+        view
+      end
 
-      def validate_out!
-        raise Errors::NoMapReduceOutput.new({}) unless @map_reduce.out
+      # Get the collection that the map/reduce results were stored in.
+      #
+      # @api private
+      #
+      # @example Get the output collection.
+      #   map_reduce.output_collection
+      #
+      # @return [ Symbol, String ] The output collection.
+      #
+      # @since 3.0.0
+      def output_collection
+        command[:out].values.first
+      end
+
+      # Execute the map/reduce command and get the results.
+      #
+      # @api private
+      #
+      # @example Get the results.
+      #   map_reduce.results
+      #
+      # @return [ Hash ] The results of the command.
+      #
+      # @since 3.0.0
+      def results
+        raise Errors::NoMapReduceOutput.new(command) unless command[:out]
+        @results ||= __client__.command(command).first
+      end
+
+      # Get the client with the proper consistency.
+      #
+      # @api private
+      #
+      # @note We can use eventual if the output is set to inline.
+      #
+      # @example Get the client.
+      #   map_reduce.__client__
+      #
+      # @return [ Mongo::Client ] The client with consistency set.
+      #
+      # @since 3.0.15
+      def __client__
+        if command[:out][:inline] != 1
+          # @todo: close
+          client.with(read: { mode: :primary })
+        else
+          client
+        end
       end
     end
   end

data/lib/mongoid/contextual/memory.rb

@@ -130,7 +130,9 @@ module Mongoid
       #
       # @since 3.0.0
       def first
-        eager_load([documents.first]).first
+        doc = documents.first
+        eager_load_one(doc)
+        doc
       end
       alias :one :first
       alias :find_first :first
@@ -140,7 +142,7 @@ module Mongoid
       # @example Create the new context.
       #   Memory.new(criteria)
       #
-      # @param [ Criteria ] criteria The criteria.
+      # @param [ Criteria ] The criteria.
       #
       # @since 3.0.0
       def initialize(criteria)
@@ -163,7 +165,9 @@ module Mongoid
       #
       # @since 3.0.0
       def last
-        eager_load([documents.last]).first
+        doc = documents.last
+        eager_load_one(doc)
+        doc
       end
 
       # Get the length of matching documents in the context.
@@ -373,7 +377,6 @@ module Mongoid
       #
       # @since 3.0.0
       def apply_options
-        raise Errors::InMemoryCollationNotSupported.new if criteria.options[:collation]
         skip(criteria.options[:skip]).limit(criteria.options[:limit])
       end
 

data/lib/mongoid/contextual/mongo.rb

@@ -18,18 +18,7 @@ module Mongoid
       # Options constant.
       #
       # @since 5.0.0
-      OPTIONS = [ :hint,
-                  :limit,
-                  :skip,
-                  :sort,
-                  :batch_size,
-                  :max_scan,
-                  :snapshot,
-                  :comment,
-                  :read,
-                  :cursor_type,
-                  :collation
-                ].freeze
+      OPTIONS = [ :hint, :limit, :skip, :sort, :batch_size, :max_scan, :max_time_ms, :snapshot, :comment, :read ].freeze
 
       # @attribute [r] view The Mongo collection view.
       attr_reader :view
@@ -79,7 +68,9 @@ module Mongoid
       #
       # @since 3.0.0
       def delete
-        view.delete_many.deleted_count
+        self.count.tap do
+          view.delete_many
+        end
       end
       alias :delete_all :delete
 
@@ -92,10 +83,11 @@ module Mongoid
       #
       # @since 3.0.0
       def destroy
-        each.inject(0) do |count, doc|
+        destroyed = self.count
+        each do |doc|
           doc.destroy
-          count += 1
         end
+        destroyed
       end
       alias :destroy_all :destroy
 
@@ -110,7 +102,9 @@ module Mongoid
       #
       # @since 3.0.0
       def distinct(field)
-        view.distinct(klass.database_field_name(field))
+        view.distinct(klass.database_field_name(field)).map do |value|
+          value.class.demongoize(value)
+        end
       end
 
       # Iterate over the context. If provided a block, yield to a Mongoid
@@ -197,7 +191,7 @@ module Mongoid
       # @example Execute the command.
       #   context.find_one_and_update({ likes: 1 })
       #
-      # @param [ Hash ] replacement The replacement.
+      # @param [ Hash ] update The updates.
       # @param [ Hash ] options The command options.
       #
       # @option options [ :before, :after ] :return_document Return the updated document
@@ -233,21 +227,27 @@ module Mongoid
       # @example Get the first document.
       #   context.first
       #
-      # @note Mongoid previously added an _id sort when no sort parameters were
-      #   provided explicitly by the user. This caused bad performance issues
-      #   and was not expected, so #first/#last will no longer guarantee order
-      #   if no sorting parameters are provided. For order guarantees - a sort
-      #   must be explicitly provided.
+      # @note Automatically adding a sort on _id when no other sort is
+      #   defined on the criteria has the potential to cause bad performance issues.
+      #   If you experience unexpected poor performance when using #first or #last
+      #   and have no sort defined on the criteria, use the option { sort: :none }.
+      #   Be aware that #first/#last won't guarantee order in this case.
+      #
+      # @param [ Hash ] opts The options for the query returning the first document.
+      #
+      # @option opts [ :none ] :id_sort Don't apply a sort on _id if no other sort
+      #   is defined on the criteria.
       #
       # @return [ Document ] The first document.
       #
       # @since 3.0.0
-      def first
+      def first(opts = {})
         return documents.first if cached? && cache_loaded?
         try_cache(:first) do
-          if raw_doc = view.limit(-1).first
-            doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
-            eager_load([doc]).first
+          if sort = view.sort || ({ _id: 1 } unless opts[:id_sort] == :none)
+            with_eager_loading(view.sort(sort).limit(-1).first)
+          else
+            with_eager_loading(view.limit(-1).first)
           end
         end
       end
@@ -260,10 +260,7 @@ module Mongoid
       # @since 4.0.2
       def find_first
         return documents.first if cached? && cache_loaded?
-        if raw_doc = view.first
-          doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
-          eager_load([doc]).first
-        end
+        with_eager_loading(view.first)
       end
 
       # Execute a $geoNear command against the database.
@@ -298,7 +295,7 @@ module Mongoid
       # @example Map by some field.
       #   context.map(:field1)
       #
-      # @example Map with block.
+      # @exmaple Map with block.
       #   context.map(&:field1)
       #
       # @param [ Symbol ] field The field name.
@@ -308,7 +305,8 @@ module Mongoid
         if block_given?
           super(&block)
         else
-          criteria.pluck(field)
+          field = field.to_sym
+          criteria.only(field).map(&field.to_proc)
         end
       end
 
@@ -323,7 +321,7 @@ module Mongoid
       # @since 3.0.0
       def initialize(criteria)
         @criteria, @klass, @cache = criteria, criteria.klass, criteria.options[:cache]
-        @collection = @klass.with(criteria.persistence_options || {}).collection
+        @collection = @klass.collection
         criteria.send(:merge_type_selection)
         @view = collection.find(criteria.selector)
         apply_options
@@ -336,22 +334,22 @@ module Mongoid
       # @example Get the last document.
       #   context.last
       #
-      # @note Mongoid previously added an _id sort when no sort parameters were
-      #   provided explicitly by the user. This caused bad performance issues
-      #   and was not expected, so #first/#last will no longer guarantee order
-      #   if no sorting parameters are provided. For order guarantees - a sort
-      #   must be explicitly provided.
+      # @note Automatically adding a sort on _id when no other sort is
+      #   defined on the criteria has the potential to cause bad performance issues.
+      #   If you experience unexpected poor performance when using #first or #last
+      #   and have no sort defined on the criteria, use the option { sort: :none }.
+      #   Be aware that #first/#last won't guarantee order in this case.
+      #
+      # @param [ Hash ] opts The options for the query returning the first document.
       #
-      # @return [ Document ] The last document.
+      # @option opts [ :none ] :id_sort Don't apply a sort on _id if no other sort
+      #   is defined on the criteria.
       #
       # @since 3.0.0
-      def last
+      def last(opts = {})
         try_cache(:last) do
-          with_inverse_sorting do
-            if raw_doc = view.limit(-1).first
-              doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
-              eager_load([doc]).first
-            end
+          with_inverse_sorting(opts) do
+            with_eager_loading(view.limit(-1).first)
           end
         end
       end
@@ -407,7 +405,7 @@ module Mongoid
       # @note This method will return the raw db values - it performs no custom
       #   serialization.
       #
-      # @param [ String, Symbol, Array ] fields Fields to pluck.
+      # @param [ String, Symbol, Array ] field Fields to pluck.
       #
       # @return [ Array<Object, Array> ] The plucked values.
       #
@@ -559,6 +557,12 @@ module Mongoid
         if criteria.options[:timeout] == false
           @view = view.no_cursor_timeout
         end
+        if criteria.options[:cursor_type]
+          # @todo: update to use #cursor_type method on view when driver 2.3 is released.
+          # See RUBY-1080
+          @view = view.clone
+          @view.options.merge!(cursor_type: criteria.options[:cursor_type])
+        end
       end
 
       # Apply an option.
@@ -583,10 +587,10 @@ module Mongoid
       #   context.with_inverse_sorting
       #
       # @since 3.0.0
-      def with_inverse_sorting
+      def with_inverse_sorting(opts = {})
         begin
-          if spec = criteria.options[:sort]
-            @view = view.sort(Hash[spec.map{|k, v| [k, -1*v]}])
+          if sort = criteria.options[:sort] || ( { _id: 1 } unless opts[:id_sort] == :none )
+            @view = view.sort(Hash[sort.map{|k, v| [k, -1*v]}])
           end
           yield
         ensure
@@ -654,10 +658,15 @@ module Mongoid
       #
       # @since 3.0.0
       def documents_for_iteration
-        return documents if cached? && !documents.empty?
-        return view unless eager_loadable?
-        docs = view.map{ |doc| Factory.from_db(klass, doc, criteria.options[:fields]) }
-        eager_load(docs)
+        if cached? && !documents.empty?
+          documents
+        elsif eager_loadable?
+          docs = view.map{ |doc| Factory.from_db(klass, doc, criteria.options[:fields]) }
+          eager_load(docs)
+          docs
+        else
+          view
+        end
       end
 
       # Yield to the document.
@@ -674,7 +683,7 @@ module Mongoid
       # @since 3.0.0
       def yield_document(document, &block)
         doc = document.respond_to?(:_id) ?
-            document : Factory.from_db(klass, document, criteria.options[:fields])
+          document : Factory.from_db(klass, document, criteria.options[:fields])
         yield(doc)
         documents.push(doc) if cacheable?
       end