mongoid 7.1.11 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a1a3273952d5a0d0eb20c5a9864eaccec98bcb9b07647450a8fc86795a46c9
-  data.tar.gz: a992b0cea4ac0ddc46e622b405dae7e0d1eab46ff800655d4fa21b39a7b88561
+  metadata.gz: 6a81d403f49ffcc37e06200c91ab90a6205604730f7169ceb4a07d057ae61193
+  data.tar.gz: 045ce8ed60ab931f1406e52f25f9e486d670ec1c76dff86ee3b299cbeca0adfe
 SHA512:
-  metadata.gz: 3ac4c55216f2ee6e351afcadab0800c42fc39306b9d7e60dc31ddbeb3bc3a314e7b79961fa785b34ee267bf7d07343a4cb0ac787a9457ad9498783b6baaa5fa5
-  data.tar.gz: 0c4f99da1d7845b4736fe7cfb5000067462c7c91c20fb5af1ac351f4eb8562212d3a21e958e1f239b59f1bfde5a57f9f621bf18e260560622a388f5f6f657a25
+  metadata.gz: bebd7b18d65049cd7d0793319a65bf1868f3c9addf09c21c7b4dbf315deb2fda27cf1a8f27be5288245ab2b1c830d21752de9042d01fb9b31579cab7536ccdcf
+  data.tar.gz: 4a4b231ce42eb8b5bf07eca5131ff4b9e5c838a0965996adcf9a529ad6c398f11e0c9e4e5d7cc005fe969e4851a50a2d6aab7c436af433a809c6090ff1927b9c

data/README.md

@@ -1,5 +1,7 @@
-# Mongoid
-[![Code Climate](https://codeclimate.com/github/mongodb/mongoid.svg)](https://codeclimate.com/github/mongodb/mongoid)
+Mongoid
+[![Gem Version][rubygems-img]][rubygems-url]
+[![Inline docs][inch-img]][inch-url]
+====
 
 Mongoid is an ODM (Object-Document Mapper) framework for MongoDB in Ruby.
 
@@ -17,7 +19,7 @@ Compatibility
 
 Mongoid supports and is tested against:
 
-- MRI 2.3-3.0
+- MRI 2.3-2.7
 - JRuby 9.2
 - MongoDB server 2.6-4.4
 
@@ -63,3 +65,8 @@ Credits
 -------
 
 Durran Jordan: durran at gmail dot com
+
+[rubygems-img]: https://badge.fury.io/rb/mongoid.svg
+[rubygems-url]: http://badge.fury.io/rb/mongoid
+[inch-img]: http://inch-ci.org/github/mongodb/mongoid.svg?branch=master
+[inch-url]: http://inch-ci.org/github/mongodb/mongoid

data/lib/config/locales/en.yml

@@ -7,6 +7,7 @@ en:
         message_title: "message"
         summary_title: "summary"
         resolution_title: "resolution"
+
         ambiguous_relationship:
           message: "Ambiguous associations %{candidates} defined on %{klass}."
           summary:
@@ -43,6 +44,8 @@ en:
           resolution: "Most likely this is caused by passing parameters directly
             through to the find, and the parameter either is not present or the
             key from which it is accessed is incorrect."
+        destroy_restrict_with_error_dependencies_exist:
+          "is not empty and prevents the document from being destroyed"
         document_not_destroyed:
           message: "%{klass} with id %{id} was not destroyed."
           summary: "When calling %{klass}#destroy! and a callback halts the destroy
@@ -77,12 +80,6 @@ en:
             different collections so a simple id lookup is not sufficient enough."
           resolution: "Don't attempt to perform this action and have patience,
             maybe this will be supported in the future."
-        empty_config_file:
-          message: "Empty configuration file: %{path}."
-          summary: "Your mongoid.yml configuration file appears to be empty."
-          resolution: "Ensure your configuration file contains the correct contents.
-            Please consult the following page with respect to Mongoid's configuration:
-            https://docs.mongodb.com/mongoid/current/reference/configuration/"
         invalid_collection:
           message: "Access to the collection for %{klass} is not allowed."
           summary: "%{klass}.collection was called, and %{klass} is an embedded
@@ -97,13 +94,6 @@ en:
             A collation option is only supported if the query is executed on a MongoDB server
             with version >= 3.4."
           resolution: "Remove the collation option from the query."
-        invalid_config_file:
-          message: "Invalid configuration file: %{path}."
-          summary: "Your mongoid.yml configuration file does not contain the
-            correct file structure."
-          resolution: "Ensure your configuration file contains the correct contents.
-            Please consult the following page with respect to Mongoid's configuration:
-            https://docs.mongodb.com/mongoid/current/reference/configuration/"
         invalid_config_option:
           message: "Invalid configuration option: %{name}."
           summary: "A invalid configuration option was provided in your
@@ -118,6 +108,32 @@ en:
           summary: "An invalid dependent strategy was defined for the association:
             %{association}. The valid strategies are: %{valid_strategies}."
           resolution: "Change the dependent strategy to one of the valid types."
+        invalid_discriminator_key_target:
+          message: "Setting the discriminator key on a child class is not allowed."
+          summary: "The discriminator key on the class %{class_name} was attempted
+            to be changed. Changing the discriminator key on a child class is not
+            allowed."
+          resolution: "Try setting the discriminator key on %{superclass} or one of %{class_name}'s
+            ancestors."
+        invalid_elem_match_operator:
+          message: "Invalid $elemMatch operator '%{operator}'."
+          summary: "You misspelled an operator or are using an operator that
+            Mongoid does not support."
+          resolution: "Valid field operators are: %{valid_operators}.
+            Ensure you are using one of these operators."
+        invalid_estimated_count_criteria:
+          message: "Invalid criteria for estimated_count."
+          summary: "Estimated count is strictly a collection-level operation and cannot be called
+            on a filtered critera."
+          resolution: "Try calling estimated_count directly on the class: %{class_name}.estimated_count.\n\n
+            \_If the class defines a default scope, use unscoped: %{class_name}.unscoped.estimated_count."
+        invalid_expression_operator:
+          message: "Invalid expression operator '%{operator}'."
+          summary: "You misspelled an operator, are using an operator that
+            Mongoid does not support, or are trying to use a field-level
+            operator on expression level."
+          resolution: "Valid expression operators are: %{valid_operators}.
+            Ensure you are using one of these operators."
         invalid_field:
           message: "Defining a field named '%{name}' is not allowed."
           summary: "Defining this field would override the method '%{name}',
@@ -131,6 +147,13 @@ en:
             allowed, and don't use these names. These include names that also
             conflict with core Ruby methods on Object, Module, Enumerable, or
             included gems that inject methods into these or Mongoid internals."
+        invalid_field_operator:
+          message: "Invalid field operator '%{operator}'."
+          summary: "You misspelled an operator, are using an operator that
+            Mongoid does not support, or are trying to use an expression-level
+            operator on field level."
+          resolution: "Valid field operators are: %{valid_operators}.
+            Ensure you are using one of these operators."
         invalid_field_option:
           message: "Invalid option :%{option} provided for field :%{name}."
           summary: "Mongoid requires that you only provide valid options on each
@@ -556,7 +579,7 @@ en:
             the validations."
         delete_restriction:
           message: "Cannot delete %{document} because of dependent '%{relation}'."
-          summary: "When defining '%{relation}' with a :dependent => :restrict,
+          summary: "When defining '%{relation}' with a :dependent => :restrict_with_error,
             Mongoid will raise an error when attempting to delete the
             %{document} when the child '%{relation}' still has documents in it."
           resolution: "Don't attempt to delete the parent %{document} when

data/lib/mongoid/association/depending.rb

@@ -41,11 +41,6 @@ module Mongoid
           :restrict_with_error
       ]
 
-      # The error message when a strategy cannot delete objects because there are associated objects.
-      #
-      # @since 7.0
-      RESTRICT_ERROR_MSG = 'Cannot delete record because associated objects exist.'.freeze
-
       # Attempt to add the cascading information for the document to know how
       # to handle associated documents on a removal.
       #
@@ -131,7 +126,7 @@ module Mongoid
 
       def _dependent_restrict_with_error!(association)
         if (relation = send(association.name)) && !relation.blank?
-          errors.add(association.name, RESTRICT_ERROR_MSG)
+          errors.add(association.name, :destroy_restrict_with_error_dependencies_exist)
           throw(:abort, false)
         end
       end

data/lib/mongoid/association/embedded/embeds_many/proxy.rb

@@ -415,7 +415,7 @@ module Mongoid
           # @param [ Proc ] block Optional block to pass.
           #
           # @return [ Criteria, Object ] A Criteria or return value from the target.
-          ruby2_keywords def method_missing(name, *args, &block)
+          def method_missing(name, *args, &block)
             return super if _target.respond_to?(name)
             klass.send(:with_scope, criteria) do
               criteria.public_send(name, *args, &block)

data/lib/mongoid/association/many.rb

@@ -11,7 +11,7 @@ module Mongoid
       include ::Enumerable
 
       def_delegators :criteria, :avg, :max, :min, :sum
-      def_delegators :_target, :length, :size
+      def_delegators :_target, :length, :size, :any?
 
       # Is the association empty?
       #
@@ -22,7 +22,7 @@ module Mongoid
       #
       # @since 2.1.0
       def blank?
-        size == 0
+        !any?
       end
 
       # Creates a new document on the references many association. This will
@@ -207,7 +207,7 @@ module Mongoid
       #
       # @return [ Document ] A matching document or a new/created one.
       def find_or(method, attrs = {}, type = nil, &block)
-        attrs["_type"] = type.to_s if type
+        attrs[klass.discriminator_key] = type.discriminator_value if type
         where(attrs).first || send(method, attrs, type, &block)
       end
     end

data/lib/mongoid/association/proxy.rb

@@ -133,7 +133,7 @@ module Mongoid
       # @param [ String, Symbol ] name The name of the method.
       # @param [ Array ] args The arguments passed to the method.
       #
-      ruby2_keywords def method_missing(name, *args, &block)
+      def method_missing(name, *args, &block)
         _target.send(name, *args, &block)
       end
 

data/lib/mongoid/association/referenced/belongs_to/buildable.rb

@@ -31,7 +31,7 @@ module Mongoid
           private
 
           def execute_query(object, type)
-            query_criteria(object, type).limit(-1).first(id_sort: :none)
+            query_criteria(object, type).limit(1).first(id_sort: :none)
           end
 
           def query_criteria(object, type)

data/lib/mongoid/association/referenced/has_and_belongs_to_many/proxy.rb

@@ -101,7 +101,7 @@ module Mongoid
 
           # Delete the document from the association. This will set the foreign key
           # on the document to nil. If the dependent options on the association are
-          # :delete or :destroy the appropriate removal will occur.
+          # :delete_all or :destroy the appropriate removal will occur.
           #
           # @example Delete the document.
           #   person.posts.delete(post)

data/lib/mongoid/association/referenced/has_many/enumerable.rb

@@ -216,6 +216,40 @@ module Mongoid
               end
             end
 
+            # Returns whether the association has any documents, optionally
+            # subject to the provided filters.
+            #
+            # This method returns true if the association has any persisted
+            # documents and if it has any not yet persisted documents.
+            #
+            # If the association is already loaded, this method inspects the
+            # loaded documents and does not query the database. If the
+            # association is not loaded, the argument-less and block-less
+            # version does not load the association; the other versions
+            # (that delegate to Enumerable) may or may not load the association
+            # completely depending on whether it is iterated to completion.
+            #
+            # This method can take a parameter and a block. The behavior with
+            # either the paramater or the block is delegated to the standard
+            # library Enumerable module.
+            #
+            # Note that when Enumerable's any? method is invoked with both
+            # a block and a pattern, it only uses the pattern.
+            #
+            # @param [ Object ] condition The condition that documents
+            #   must satisfy. See Enumerable documentation for details.
+            #
+            # @return [ true, false ] If the association has any documents.
+            def any?(*args)
+              return super if args.any? || block_given?
+
+              if _loaded?
+                in_memory.length > 0
+              else
+                _unloaded.exists? || _added.length > 0
+              end
+            end
+
             # Get the first document in the enumerable. Will check the persisted
             # documents first. Does not load the entire enumerable.
             #
@@ -395,7 +429,8 @@ module Mongoid
             #
             # @since 2.1.0
             def reset
-              _loaded.clear and _added.clear
+              _loaded.clear
+              _added.clear
               @executed = false
             end
 
@@ -498,7 +533,7 @@ module Mongoid
               end
             end
 
-            ruby2_keywords def method_missing(name, *args, &block)
+            def method_missing(name, *args, &block)
               entries.send(name, *args, &block)
             end
 

data/lib/mongoid/association/referenced/has_many/proxy.rb

@@ -90,7 +90,7 @@ module Mongoid
 
           # Delete the document from the association. This will set the foreign key
           # on the document to nil. If the dependent options on the association are
-          # :delete or :destroy the appropriate removal will occur.
+          # :delete_all or :destroy the appropriate removal will occur.
           #
           # @example Delete the document.
           #   person.posts.delete(post)
@@ -170,6 +170,13 @@ module Mongoid
 
           # Determine if any documents in this association exist in the database.
           #
+          # If the association contains documents but all of the documents
+          # exist only in the application, i.e. have not been persisted to the
+          # database, this method returns false.
+          #
+          # This method queries the database on each invocation even if the
+          # association is already loaded into memory.
+          #
           # @example Are there persisted documents?
           #   person.posts.exists?
           #
@@ -436,7 +443,7 @@ module Mongoid
           # @return [ Criteria, Object ] A Criteria or return value from the target.
           #
           # @since 2.0.0.beta.1
-          ruby2_keywords def method_missing(name, *args, &block)
+          def method_missing(name, *args, &block)
             if _target.respond_to?(name)
               _target.send(name, *args, &block)
             else

data/lib/mongoid/association/referenced/has_one/buildable.rb

@@ -35,6 +35,14 @@ module Mongoid
           private
 
           def clear_associated(object)
+            unless inverse
+              raise Errors::InverseNotFound.new(
+                  @owner_class,
+                  name,
+                  object.class,
+                  foreign_key,
+              )
+            end
             if object && (associated = object.send(inverse))
               associated.substitute(nil)
             end
@@ -46,7 +54,7 @@ module Mongoid
           end
 
           def execute_query(object, base)
-            query_criteria(object, base).limit(-1).first(id_sort: :none)
+            query_criteria(object, base).limit(1).first(id_sort: :none)
           end
 
           def with_polymorphic_criterion(criteria, base)

data/lib/mongoid/atomic/modifiers.rb

@@ -193,7 +193,7 @@ module Mongoid
       def push_conflict?(field)
         name = field.split(".", 2)[0]
         set_fields.has_key?(name) || pull_fields.has_key?(name) ||
-          (push_fields.keys.count { |item| item =~ /#{name}/ } > 1)
+          (push_fields.keys.count { |item| item.split('.', 2).first == name } > 1)
       end
 
       # Get the conflicting pull modifications.

data/lib/mongoid/attributes/dynamic.rb

@@ -116,7 +116,7 @@ module Mongoid
       #
       # @since 4.0.0
       def inspect_dynamic_fields
-        keys = attributes.keys - fields.keys - relations.keys - ["_id", "_type"]
+        keys = attributes.keys - fields.keys - relations.keys - ["_id", self.class.discriminator_key]
         return keys.map do |name|
           "#{name}: #{attributes[name].inspect}"
         end

data/lib/mongoid/attributes.rb

@@ -160,11 +160,6 @@ module Mongoid
     # @since 1.0.0
     def write_attribute(name, value)
       field_name = database_field_name(name)
-
-      if attribute_missing?(field_name)
-        raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'"
-      end
-
       if attribute_writable?(field_name)
         _assigning do
           validate_attribute_value(field_name, value)
@@ -182,8 +177,6 @@ module Mongoid
           end
           typed_value
         end
-      else
-        # TODO: MONGOID-5072
       end
     end
     alias :[]= :write_attribute
@@ -301,7 +294,7 @@ module Mongoid
     def read_raw_attribute(name)
       normalized = database_field_name(name.to_s)
       if attribute_missing?(normalized)
-        raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'"
+        raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'."
       end
       if hash_dot_syntax?(normalized)
         attributes.__nested__(normalized)

data/lib/mongoid/clients/factory.rb

@@ -69,11 +69,28 @@ module Mongoid
         end
       end
 
+      MONGOID_WRAPPING_LIBRARY = {
+        name: 'Mongoid',
+        version: VERSION,
+      }.freeze
+
+      def driver_version
+        Mongo::VERSION.split('.')[0...2].map(&:to_i)
+      end
+
       def options(configuration)
         config = configuration.dup
         options = config.delete(:options) || {}
         options[:platform] = PLATFORM_DETAILS
         options[:app_name] = Mongoid::Config.app_name if Mongoid::Config.app_name
+        if (driver_version <=> [2, 13]) >= 0
+          wrap_lib = if options[:wrapping_libraries]
+            [MONGOID_WRAPPING_LIBRARY] + options[:wrapping_libraries]
+          else
+            [MONGOID_WRAPPING_LIBRARY]
+          end
+          options[:wrapping_libraries] = wrap_lib
+        end
         options.reject{ |k, v| k == :hosts }.to_hash.symbolize_keys!
       end
     end

data/lib/mongoid/composable.rb

@@ -6,6 +6,7 @@ require "mongoid/findable"
 require "mongoid/indexable"
 require "mongoid/inspectable"
 require "mongoid/interceptable"
+require "mongoid/matcher"
 require "mongoid/matchable"
 require "mongoid/persistable"
 require "mongoid/reloadable"

data/lib/mongoid/config/environment.rb

@@ -52,15 +52,7 @@ module Mongoid
       # @api private
       def load_yaml(path, environment = nil)
         env = environment ? environment.to_s : env_name
-        contents = File.new(path).read
-        if contents.empty?
-          raise Mongoid::Errors::EmptyConfigFile.new(path)
-        end
-        data = YAML.load(ERB.new(contents).result)
-        unless data.is_a?(Hash)
-          raise Mongoid::Errors::InvalidConfigFile.new(path)
-        end
-        data[env]
+        YAML.load(ERB.new(File.new(path).read).result)[env]
       end
     end
   end

data/lib/mongoid/config.rb

@@ -32,6 +32,9 @@ module Mongoid
     # error.
     option :belongs_to_required_by_default, default: true
 
+    # Set the global discriminator key.
+    option :discriminator_key, default: "_type"
+
     # Raise an exception when a field is redefined.
     option :duplicate_fields_exception, default: false
 

data/lib/mongoid/contextual/atomic.rb

@@ -173,18 +173,13 @@ module Mongoid
       # @example Unset the field on the matches.
       #   context.unset(:name)
       #
-      # @param [ String | Symbol | Array<String|Symbol> | Hash ] args
-      #   The name(s) of the field(s) to unset.
-      #   If a Hash is specified, its keys will be used irrespective of what
-      #   each key's value is, even if the value is nil or false.
+      # @param [ String, Symbol, Array ] args The name of the fields.
       #
       # @return [ nil ] Nil.
       #
       # @since 3.0.0
       def unset(*args)
-        fields = args.map { |a| a.is_a?(Hash) ? a.keys : a }
-                     .__find_args__
-                     .map { |f| [database_field_name(f), true] }
+        fields = args.__find_args__.collect { |f| [database_field_name(f), true] }
         view.update_many("$unset" => Hash[fields])
       end
 

data/lib/mongoid/contextual/mongo.rb

@@ -71,7 +71,26 @@ module Mongoid
       # @since 3.0.0
       def count(options = {}, &block)
         return super(&block) if block_given?
-        try_cache(:count) { view.count(options) }
+        try_cache(:count) { view.count_documents(options) }
+      end
+
+      # Get the estimated number of documents matching the query.
+      #
+      # Unlike count, estimated_count does not take a block because it is not
+      # traditionally defined (with a block) on Enumarable like count is.
+      #
+      # @example Get the estimated number of matching documents.
+      #   context.estimated_count
+      #
+      # @param [ Hash ] options The options, such as maxTimeMS to be factored
+      #   into the count.
+      #
+      # @return [ Integer ] The number of matches.
+      def estimated_count(options = {})
+        unless self.criteria.selector.empty?
+          raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(self.klass)
+        end
+        try_cache(:estimated_count) { view.estimated_document_count(options) }
       end
 
       # Delete all documents in the database that match the selector.
@@ -258,12 +277,12 @@ module Mongoid
         return documents.first if cached? && cache_loaded?
         try_cache(:first) do
           if sort = view.sort || ({ _id: 1 } unless opts[:id_sort] == :none)
-            if raw_doc = view.sort(sort).limit(-1).first
+            if raw_doc = view.sort(sort).limit(1).first
               doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           else
-            if raw_doc = view.limit(-1).first
+            if raw_doc = view.limit(1).first
               doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
@@ -372,7 +391,7 @@ module Mongoid
       def last(opts = {})
         try_cache(:last) do
           with_inverse_sorting(opts) do
-            if raw_doc = view.limit(-1).first
+            if raw_doc = view.limit(1).first
               doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end

data/lib/mongoid/contextual/none.rb

@@ -112,9 +112,6 @@ module Mongoid
         entries.length
       end
       alias :size :length
-
-      alias :find_first :first
-      alias :one :first
     end
   end
 end

data/lib/mongoid/copyable.rb

@@ -23,8 +23,12 @@ module Mongoid
       # elsewhere.
       attrs = clone_document.except("_id", "id")
       dynamic_attrs = {}
+      _attribute_names = self.attribute_names
       attrs.reject! do |attr_name, value|
-        dynamic_attrs.merge!(attr_name => value) unless self.attribute_names.include?(attr_name)
+        unless _attribute_names.include?(attr_name)
+          dynamic_attrs[attr_name] = value
+          true
+        end
       end
       self.class.new(attrs).tap do |object|
         dynamic_attrs.each do |attr_name, value|
@@ -76,8 +80,8 @@ module Mongoid
 
         if association.is_a?(Association::Embedded::EmbedsMany)
           attrs[association.key].each do |attr|
-            embedded_klass = if type = attr['_type']
-              type.constantize
+            embedded_klass = if type = attr[self.class.discriminator_key]
+              association.relation_class.get_discriminator_mapping(type) || association.relation_class
             else
               association.relation_class
             end

data/lib/mongoid/criteria/queryable/key.rb

@@ -33,7 +33,7 @@ module Mongoid
       #
       # A yet more more complex example is the following condition:
       #
-      #   Foo.geo_spacial(:boundary.intersects_point => [1, 10])
+      #   Foo.geo_spatial(:boundary.intersects_point => [1, 10])
       #
       # Processing this condition will cause a Key instance to be created as
       # follows:

data/lib/mongoid/criteria/queryable/mergeable.rb

@@ -237,9 +237,9 @@ module Mongoid
         # Similarly, this method should never need to expand a literal value
         # and an operator at the same time.
         #
-        # @param [ Hash ] Criteria including Key instances.
+        # @param [ Hash ] expr Criteria including Key instances.
         #
-        # @return [ Hash ] Expanded criteria.
+        # @return [ Hash ] The expanded criteria.
         private def _mongoid_expand_keys(expr)
           unless expr.is_a?(Hash)
             raise ArgumentError, 'Argument must be a Hash'