mongoid 4.0.2 → 5.0.0

data/lib/mongoid/criteria.rb

@@ -4,7 +4,6 @@ require "mongoid/criteria/inspectable"
 require "mongoid/criteria/marshalable"
 require "mongoid/criteria/modifiable"
 require "mongoid/criteria/scopable"
-require "mongoid/sessions/options"
 
 module Mongoid
 
@@ -23,7 +22,7 @@ module Mongoid
     include Marshalable
     include Modifiable
     include Scopable
-    include Sessions::Options
+    include Clients::Options
 
     # Static array used to check with method missing - we only need to ever
     # instantiate once.
@@ -196,7 +195,7 @@ module Mongoid
     end
 
     # Eager loads all the provided relations. Will load all the documents
-    # into the identity map who's ids match based on the extra query for the
+    # into the identity map whose ids match based on the extra query for the
     # ids.
     #
     # @note This will work for embedded relations that reference another
@@ -293,7 +292,7 @@ module Mongoid
       options.merge!(criteria.options)
       self.documents = criteria.documents.dup unless criteria.documents.empty?
       self.scoping_options = criteria.scoping_options
-      self.inclusions = (inclusions + criteria.inclusions.dup).uniq
+      self.inclusions = (inclusions + criteria.inclusions).uniq
       self
     end
 
@@ -335,6 +334,9 @@ module Mongoid
     def only(*args)
       return clone if args.flatten.empty?
       args = args.flatten
+      if (args & Fields::IDS).empty?
+        args.unshift(:_id)
+      end
       if klass.hereditary?
         super(*args.push(:_type))
       else
@@ -342,6 +344,37 @@ module Mongoid
       end
     end
 
+    # Set the read preference for the criteria.
+    #
+    # @example Set the read preference.
+    #   criteria.read(mode: :primary_preferred)
+    #
+    # @param [ Hash ] value The mode preference.
+    #
+    # @return [ Criteria ] The cloned criteria.
+    #
+    # @since 5.0.0
+    def read(value = nil)
+      clone.tap do |criteria|
+        criteria.options.merge!(read: value)
+      end
+    end
+
+    # Overriden to exclude _id from the fields.
+    #
+    # @example Exclude fields returned from the database.
+    #   Band.without(:name)
+    #
+    # @param [ Array<Symbol> ] args The names of the fields.
+    #
+    # @return [ Criteria ] The cloned criteria.
+    #
+    # @since 4.0.3
+    def without(*args)
+      args -= Fields::IDS
+      super(*args)
+    end
+
     # Returns true if criteria responds to the given method.
     #
     # @example Does the criteria respond to the method?

data/lib/mongoid/document.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require "mongoid/positional"
 require "mongoid/evolvable"
 require "mongoid/extensions"
 require "mongoid/errors"
@@ -168,7 +167,7 @@ module Mongoid
       embedded_relations.each_pair do |name, meta|
         without_autobuild do
           relation, stored = send(name), meta.store_as
-          if attributes.has_key?(stored) || !relation.blank?
+          if attributes.key?(stored) || !relation.blank?
             if relation
               attributes[stored] = relation.as_document
             else
@@ -262,7 +261,7 @@ module Mongoid
     #
     # @since 2.4.0
     def model_key
-      @model_cache_key ||= "#{self.class.model_name.cache_key}"
+      @model_cache_key ||= self.class.model_name.cache_key
     end
 
     # Implement this for calls to flatten on array.
@@ -327,7 +326,7 @@ module Mongoid
       #
       # @since 1.0.0
       def _types
-        @_type ||= (descendants + [ self ]).uniq.map { |t| t.to_s }
+        @_type ||= (descendants + [ self ]).uniq.map(&:to_s)
       end
 
       # Set the i18n scope to overwrite ActiveModel.

data/lib/mongoid/errors/{mixed_session_configuration.rb → mixed_client_configuration.rb}

@@ -2,23 +2,23 @@
 module Mongoid
   module Errors
 
-    # This error is raised when a session configuration contains both a uri and
+    # This error is raised when a client configuration contains both a uri and
     # other standard options.
-    class MixedSessionConfiguration < MongoidError
+    class MixedClientConfiguration < MongoidError
 
       # Initialize the error.
       #
       # @example Initialize the error.
-      #   MixedSessionConfiguration.new(:name, {})
+      #   MixedClientConfiguration.new(:name, {})
       #
-      # @param [ Symbol ] name The name of the session config.
+      # @param [ Symbol ] name The name of the client config.
       # @param [ Hash ] config The configuration options.
       #
       # @since 3.0.0
       def initialize(name, config)
         super(
           compose_message(
-            "mixed_session_configuration",
+            "mixed_client_configuration",
             { name: name, config: config }
           )
         )

data/lib/mongoid/errors/mongoid_error.rb

@@ -7,6 +7,8 @@ module Mongoid
     # translating the messages.
     class MongoidError < StandardError
 
+      attr_reader :problem, :summary, :resolution
+
       BASE_KEY = "mongoid.errors.messages"
 
       # Compose the message.
@@ -18,13 +20,17 @@ module Mongoid
       #
       # @since 3.0.0
       def compose_message(key, attributes)
-        @problem = problem(key, attributes)
-        @summary = summary(key, attributes)
-        @resolution = resolution(key, attributes)
+        @problem = translate_problem(key, attributes)
+        @summary = translate_summary(key, attributes)
+        @resolution = translate_resolution(key, attributes)
+        @problem_title = translate("message_title", {})
+        @summary_title = translate("summary_title", {})
+        @resolution_title = translate("resolution_title", {})
+
 
-        "\nProblem:\n  #{@problem}"+
-        "\nSummary:\n  #{@summary}"+
-        "\nResolution:\n  #{@resolution}"
+        "\n#{@problem_title}:\n  #{@problem}"+
+        "\n#{@summary_title}:\n  #{@summary}"+
+        "\n#{@resolution_title}:\n  #{@resolution}"
       end
 
       private
@@ -54,7 +60,7 @@ module Mongoid
       # @return [ String ] The problem.
       #
       # @since 3.0.0
-      def problem(key, attributes)
+      def translate_problem(key, attributes)
         translate("#{key}.message", attributes)
       end
 
@@ -69,7 +75,7 @@ module Mongoid
       # @return [ String ] The summary.
       #
       # @since 3.0.0
-      def summary(key, attributes)
+      def translate_summary(key, attributes)
         translate("#{key}.summary", attributes)
       end
 
@@ -84,7 +90,7 @@ module Mongoid
       # @return [ String ] The resolution.
       #
       # @since 3.0.0
-      def resolution(key, attributes)
+      def translate_resolution(key, attributes)
         translate("#{key}.resolution", attributes)
       end
     end

data/lib/mongoid/errors/no_client_config.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when attempting to create a new client that does
+    # not have a named configuration.
+    class NoClientConfig < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   NoClientConfig.new(:secondary)
+      #
+      # @param [ String, Symbol ] name The name of the client.
+      #
+      # @since 3.0.0
+      def initialize(name)
+        super(compose_message("no_client_config", { name: name }))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/{no_session_database.rb → no_client_database.rb}

@@ -2,13 +2,13 @@
 module Mongoid
   module Errors
 
-    # This error is raised when a session is configured without a database.
-    class NoSessionDatabase < MongoidError
+    # This error is raised when a client is configured without a database.
+    class NoClientDatabase < MongoidError
 
       # Create the new error.
       #
       # @example Create the new error.
-      #   NoSessionDatabase.new(:default, {}})
+      #   NoClientDatabase.new(:default, {}})
       #
       # @param [ Symbol, String ] name The db config key.
       # @param [ Hash ] config The hash configuration options.
@@ -17,7 +17,7 @@ module Mongoid
       def initialize(name, config)
         super(
           compose_message(
-            "no_session_database",
+            "no_client_database",
             { name: name, config: config }
           )
         )

data/lib/mongoid/errors/{no_session_hosts.rb → no_client_hosts.rb}

@@ -2,13 +2,13 @@
 module Mongoid
   module Errors
 
-    # This error is raised when a session is configured without hosts.
-    class NoSessionHosts < MongoidError
+    # This error is raised when a client is configured without hosts.
+    class NoClientHosts < MongoidError
 
       # Create the new error.
       #
       # @example Create the new error.
-      #   NoSessionHosts.new(:default, {}})
+      #   NoClientHosts.new(:default, {}})
       #
       # @param [ Symbol, String ] name The db config key.
       # @param [ Hash ] config The hash configuration options.
@@ -17,7 +17,7 @@ module Mongoid
       def initialize(name, config)
         super(
           compose_message(
-            "no_session_hosts",
+            "no_client_hosts",
             { name: name, config: config }
           )
         )

data/lib/mongoid/errors/{no_sessions_config.rb → no_clients_config.rb}

@@ -2,18 +2,18 @@
 module Mongoid
   module Errors
 
-    # This error is raised when no sessions exists in the database
+    # This error is raised when no clients exists in the database
     # configuration.
-    class NoSessionsConfig < MongoidError
+    class NoClientsConfig < MongoidError
 
       # Create the new error.
       #
       # @example Create the error.
-      #   NoSessionsConfig.new
+      #   NoClientsConfig.new
       #
       # @since 3.0.0
       def initialize
-        super(compose_message("no_sessions_config", {}))
+        super(compose_message("no_clients_config", {}))
       end
     end
   end

data/lib/mongoid/errors/no_default_client.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when a default client is not defined.
+    class NoDefaultClient < MongoidError
+
+      # Create the new error with the defined client names.
+      #
+      # @example Create the new error.
+      #   NoDefaultClient.new([ :secondary ])
+      #
+      # @param [ Array<Symbol> ] keys The defined clients.
+      #
+      # @since 3.0.0
+      def initialize(keys)
+        super(
+          compose_message("no_default_client", { keys: keys.join(", ") })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors.rb

@@ -22,17 +22,17 @@ require "mongoid/errors/invalid_time"
 require "mongoid/errors/invalid_value"
 require "mongoid/errors/inverse_not_found"
 require "mongoid/errors/mixed_relations"
-require "mongoid/errors/mixed_session_configuration"
+require "mongoid/errors/mixed_client_configuration"
 require "mongoid/errors/nested_attributes_metadata_not_found"
-require "mongoid/errors/no_default_session"
+require "mongoid/errors/no_default_client"
 require "mongoid/errors/no_environment"
 require "mongoid/errors/no_map_reduce_output"
 require "mongoid/errors/no_metadata"
 require "mongoid/errors/no_parent"
-require "mongoid/errors/no_session_config"
-require "mongoid/errors/no_sessions_config"
-require "mongoid/errors/no_session_database"
-require "mongoid/errors/no_session_hosts"
+require "mongoid/errors/no_client_config"
+require "mongoid/errors/no_clients_config"
+require "mongoid/errors/no_client_database"
+require "mongoid/errors/no_client_hosts"
 require "mongoid/errors/readonly_attribute"
 require "mongoid/errors/readonly_document"
 require "mongoid/errors/scope_overwrite"

data/lib/mongoid/extensions/hash.rb

@@ -24,7 +24,11 @@ module Mongoid
       #
       # @since 3.0.0
       def __mongoize_object_id__
-        update_values(&:__mongoize_object_id__)
+        if id = self['$oid']
+          BSON::ObjectId.from_string(id)
+        else
+          update_values(&:__mongoize_object_id__)
+        end
       end
 
       # Consolidate the key/values in the hash under an atomic $set.

data/lib/mongoid/extensions/object.rb

@@ -115,8 +115,9 @@ module Mongoid
       #
       # @since 2.0.0.rc.1
       def ivar(name)
-        if instance_variable_defined?("@_#{name}")
-          return instance_variable_get("@_#{name}")
+        var_name = "@_#{name}"
+        if instance_variable_defined?(var_name)
+          return instance_variable_get(var_name)
         else
           false
         end

data/lib/mongoid/extensions/set.rb

@@ -9,7 +9,7 @@ module Mongoid
       # @example Mongoize the object.
       #   set.mongoize
       #
-      # @return [ Hash ] The object mongoized.
+      # @return [ Array ] The object mongoized.
       #
       # @since 3.0.0
       def mongoize
@@ -21,9 +21,9 @@ module Mongoid
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @example Demongoize the object.
-        #   Set.demongoize({ "min" => 1, "max" => 5 })
+        #   Set.demongoize([1, 2, 3])
         #
-        # @param [ Hash ] object The object to demongoize.
+        # @param [ Array ] object The object to demongoize.
         #
         # @return [ Set ] The set.
         #
@@ -36,11 +36,11 @@ module Mongoid
         # type.
         #
         # @example Mongoize the object.
-        #   Set.mongoize(1..3)
+        #   Set.mongoize(Set.new([1,2,3]))
         #
         # @param [ Set ] object The object to mongoize.
         #
-        # @return [ Hash ] The object mongoized.
+        # @return [ Array ] The object mongoized.
         #
         # @since 3.0.0
         def mongoize(object)

data/lib/mongoid/factory.rb

@@ -5,6 +5,8 @@ module Mongoid
   module Factory
     extend self
 
+    TYPE = "_type".freeze
+
     # Builds a new +Document+ from the supplied attributes.
     #
     # @example Build the document.
@@ -16,7 +18,7 @@ module Mongoid
     #
     # @return [ Document ] The instantiated document.
     def build(klass, attributes = nil)
-      type = (attributes || {})["_type"]
+      type = (attributes || {})[TYPE]
       if type && klass._types.include?(type)
         type.constantize.new(attributes)
       else
@@ -37,7 +39,7 @@ module Mongoid
     #
     # @return [ Document ] The instantiated document.
     def from_db(klass, attributes = nil, selected_fields = nil)
-      type = (attributes || {})["_type"]
+      type = (attributes || {})[TYPE]
       if type.blank?
         klass.instantiate(attributes, selected_fields)
       else

data/lib/mongoid/fields.rb

@@ -32,6 +32,11 @@ module Mongoid
       time: Time
     }.with_indifferent_access
 
+    # Constant for all names of the id field in a document.
+    #
+    # @since 5.0.0
+    IDS = [ :_id, :id, '_id', 'id' ].freeze
+
     included do
       class_attribute :aliased_fields
       class_attribute :localized_fields
@@ -93,7 +98,7 @@ module Mongoid
     #
     # @since 2.4.0
     def apply_default(name)
-      unless attributes.has_key?(name)
+      unless attributes.key?(name)
         if field = fields[name]
           default = field.eval_default(self)
           unless default.nil? || field.lazy?
@@ -358,7 +363,7 @@ module Mongoid
         field_options = field.options
 
         Fields.options.each_pair do |option_name, handler|
-          if field_options.has_key?(option_name)
+          if field_options.key?(option_name)
             handler.call(self, field, field_options[option_name])
           end
         end

data/lib/mongoid/findable.rb

@@ -19,7 +19,9 @@ module Mongoid
       :each,
       :each_with_index,
       :extras,
-      :find_and_modify,
+      :find_one_and_delete,
+      :find_one_and_replace,
+      :find_one_and_update,
       :find_or_create_by,
       :find_or_create_by!,
       :find_or_initialize_by,
@@ -34,6 +36,7 @@ module Mongoid
       :min,
       :none,
       :pluck,
+      :read,
       :sum,
       :text_search,
       :update,

data/lib/mongoid/indexable.rb

@@ -31,10 +31,10 @@ module Mongoid
         index_specifications.each do |spec|
           key, options = spec.key, spec.options
           if database = options[:database]
-            with(read: :primary, database: database).
-              collection.indexes.create(key, options.except(:database))
+            with(read: { mode: :primary }, database: database).
+              collection.indexes.create_one(key, options.except(:database))
           else
-            with(read: :primary).collection.indexes.create(key, options)
+            with(read: { mode: :primary }).collection.indexes.create_one(key, options)
           end
         end and true
       end
@@ -50,12 +50,18 @@ module Mongoid
       # @since 3.0.0
       def remove_indexes
         indexed_database_names.each do |database|
-          collection = with(read: :primary, database: database).collection
-          collection.indexes.each do |spec|
-            unless spec["name"] == "_id_"
-              collection.indexes.drop(spec["key"])
+          collection = with(read: { mode: :primary }, database: database).collection
+          begin
+            collection.indexes.each do |spec|
+              unless spec["name"] == "_id_"
+                collection.indexes.drop_one(spec["key"])
+                logger.info(
+                  "MONGOID: Removed index '#{spec["name"]}' on collection " +
+                  "'#{collection.name}' in database '#{database}'."
+                )
+              end
             end
-          end
+          rescue Mongo::Error::OperationFailure; end
         end and true
       end
 
@@ -142,7 +148,7 @@ module Mongoid
       #
       # @since 4.0.0
       def index_keys
-        index_specifications.map{ |spec| spec.key }
+        index_specifications.map(&:key)
       end
     end
   end

data/lib/mongoid/persistable/creatable.rb

@@ -61,7 +61,7 @@ module Mongoid
           _parent.insert
         else
           selector = _parent.atomic_selector
-          _root.collection.find(selector).update(positionally(selector, atomic_inserts))
+          _root.collection.find(selector).update_one(atomic_inserts)
         end
       end
 
@@ -76,7 +76,7 @@ module Mongoid
       #
       # @since 4.0.0
       def insert_as_root
-        collection.insert(as_document)
+        collection.insert_one(as_document)
       end
 
       # Post process an insert, which sets the new record attribute to false

data/lib/mongoid/persistable/deletable.rb

@@ -62,7 +62,7 @@ module Mongoid
         _parent.remove_child(self) if notifying_parent?(options)
         if _parent.persisted?
           selector = _parent.atomic_selector
-          _root.collection.find(selector).update(positionally(selector, atomic_deletes))
+          _root.collection.find(selector).update_one(atomic_deletes)
         end
         true
       end
@@ -78,7 +78,7 @@ module Mongoid
       #
       # @since 4.0.0
       def delete_as_root
-        collection.find(atomic_selector).remove
+        collection.find(atomic_selector).delete_one
         true
       end
 
@@ -140,7 +140,7 @@ module Mongoid
           selector.merge!(_type: name) if hereditary?
           coll = collection
           deleted = coll.find(selector).count
-          coll.find(selector).remove_all
+          coll.find(selector).delete_many
           deleted
         end
       end

data/lib/mongoid/persistable/incrementable.rb

@@ -17,7 +17,7 @@ module Mongoid
       #
       # @param [ Hash ] increments The field/inc increment pairs.
       #
-      # @return [ true, false ] If the increment succeeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def inc(increments)

data/lib/mongoid/persistable/logical.rb

@@ -16,7 +16,7 @@ module Mongoid
       #
       # @param [ Hash ] operations The bitwise operations.
       #
-      # @return [ true, false ] If the operation succeeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def bit(operations)

data/lib/mongoid/persistable/poppable.rb

@@ -21,7 +21,7 @@ module Mongoid
       #
       # @param [ Hash ] pops The field/value pop operations.
       #
-      # @return [ true, false ] If the operation succeeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def pop(pops)

data/lib/mongoid/persistable/pullable.rb

@@ -17,7 +17,7 @@ module Mongoid
       #
       # @param [ Hash ] pulls The field/value pull pairs.
       #
-      # @return [ true, false ] If the operation succeeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def pull(pulls)
@@ -37,7 +37,7 @@ module Mongoid
       #
       # @param [ Hash ] pulls The pull all operations.
       #
-      # @return [ true, false ] If the operation succeeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def pull_all(pulls)

data/lib/mongoid/persistable/pushable.rb

@@ -16,7 +16,7 @@ module Mongoid
       #
       # @param [ Hash ] adds The field/value pairs to add.
       #
-      # @return [ true, false ] If the operation succeeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def add_to_set(adds)
@@ -43,7 +43,7 @@ module Mongoid
       #
       # @param [ Hash ] pushes The $push operations.
       #
-      # @return [ true, false ] If the operation succeeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def push(pushes)

data/lib/mongoid/persistable/renamable.rb

@@ -17,7 +17,7 @@ module Mongoid
       #
       # @param [ Hash ] renames The rename pairs of old name/new name.
       #
-      # @return [ true, false ] If the rename suceeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def rename(renames)

data/lib/mongoid/persistable/settable.rb

@@ -16,7 +16,7 @@ module Mongoid
       #
       # @param [ Hash ] setters The field/value pairs to set.
       #
-      # @return [ true ] If the operation succeeded.
+      # @return [ Document ] The document.
       #
       # @since 4.0.0
       def set(setters)