mongoid 7.1.2 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd29f8f1d696ba937654fcd72eb3669ac9ba501465828b7eba0f7b707e606f5b
-  data.tar.gz: c9f4a8dbb8a105a7e596019760d100913ddd008972b34f7595674ad7c49d4159
+  metadata.gz: 6a81d403f49ffcc37e06200c91ab90a6205604730f7169ceb4a07d057ae61193
+  data.tar.gz: 045ce8ed60ab931f1406e52f25f9e486d670ec1c76dff86ee3b299cbeca0adfe
 SHA512:
-  metadata.gz: 0e00e8d47e7af2fec23380035bcdbd0badc438552aed52aa0f462e246274e7f77220190d99bb6a83a1a90b8e0a41d19103c94fa454382635a2c193d52260c322
-  data.tar.gz: 709300f2570059e460cd341cbaffe7da6328df142825bb726b65cbc377d6ba5129cf7fc973a40fc2de10a50307f49ac0f71db98b0edbb8a65c9cb33910e9d66f
+  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.
 
@@ -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/Rakefile

@@ -1,14 +1,23 @@
 # frozen_string_literal: true
 
 require "bundler"
+require "bundler/gem_tasks"
 Bundler.setup
 
+ROOT = File.expand_path(File.join(File.dirname(__FILE__)))
+
+$: << File.join(ROOT, 'spec/shared/lib')
+
 require "rake"
 require "rspec/core/rake_task"
+require 'mrss/spec_organizer'
 
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "mongoid/version"
 
+tasks = Rake.application.instance_variable_get('@tasks')
+tasks['release:do'] = tasks.delete('release')
+
 task :gem => :build
 task :build do
   system "gem build mongoid.gemspec"
@@ -18,11 +27,8 @@ task :install => :build do
   system "sudo gem install mongoid-#{Mongoid::VERSION}.gem"
 end
 
-task :release => :build do
-  system "git tag -a v#{Mongoid::VERSION} -m 'Tagging #{Mongoid::VERSION}'"
-  system "git push --tags"
-  system "gem push mongoid-#{Mongoid::VERSION}.gem"
-  system "rm mongoid-#{Mongoid::VERSION}.gem"
+task :release do
+  raise "Please use ./release.sh to release"
 end
 
 RSpec::Core::RakeTask.new("spec") do |spec|
@@ -34,6 +40,32 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
+CLASSIFIERS = [
+  [%r,^mongoid/attribute,, :attributes],
+  [%r,^mongoid/association/[or],, :associations_referenced],
+  [%r,^mongoid/association,, :associations],
+  [%r,^mongoid,, :unit],
+  [%r,^integration,, :integration],
+  [%r,^rails,, :rails],
+]
+
+RUN_PRIORITY = %i(
+  unit attributes associations_referenced associations
+  integration rails
+)
+
+def spec_organizer
+  Mrss::SpecOrganizer.new(
+    root: ROOT,
+    classifiers: CLASSIFIERS,
+    priority_order: RUN_PRIORITY,
+  )
+end
+
+task :ci do
+  spec_organizer.run
+end
+
 task :default => :spec
 
 desc "Generate all documentation"
@@ -47,3 +79,11 @@ namespace :docs do
     system "yardoc -o #{out} --title mongoid-#{Mongoid::VERSION}"
   end
 end
+
+namespace :release do
+  task :check_private_key do
+    unless File.exist?('gem-private_key.pem')
+      raise "No private key present, cannot release"
+    end
+  end
+end

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
@@ -105,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}',
@@ -118,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
@@ -249,7 +285,7 @@ en:
             Example:\n
             \_\_class Band\n
             \_\_\_\_include Mongoid::Document\n
-            \_\_\_\_store_in collection: 'artists', database: 'secondary'\n
+            \_\_\_\_store_in collection: 'artists', database: 'music'\n
             \_\_end\n\n"
         invalid_storage_parent:
           message: "Invalid store_in call on class %{klass}."
@@ -543,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.rb

@@ -111,4 +111,27 @@ module Mongoid
   #
   # @since 1.0.0
   def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
+
+
+  # Module used to prepend the discriminator key assignment function to change
+  # the value assigned to the discriminator key to a string.
+  #
+  # @api private
+  module GlobalDiscriminatorKeyAssignment
+    # This class is used for obtaining the method definition location for
+    # Mongoid methods.
+    class InvalidFieldHost
+      include Mongoid::Document
+    end
+
+    def discriminator_key=(value)
+      Mongoid::Fields::Validators::Macro.validate_field_name(InvalidFieldHost, value)
+      value = value.to_s
+      super
+    end
+  end
+
+  class << self
+    prepend GlobalDiscriminatorKeyAssignment
+  end
 end

data/lib/mongoid/association/accessors.rb

@@ -131,15 +131,50 @@ module Mongoid
       # @api private
       def _mongoid_filter_selected_fields(assoc_key)
         return nil unless __selected_fields
+
+        projecting_assoc = false
+
         filtered = {}
         __selected_fields.each do |k, v|
           bits = k.split('.')
+
+          # If we are asked to project an association, we need all of that
+          # association's fields. However, we may be asked to project
+          # an association *and* its fields in the same query. In this case
+          # behavior differs according to server version:
+          #
+          # 4.2 and lower take the most recent projection specification, meaning
+          # projecting foo followed by foo.bar effectively projects foo.bar and
+          # projecting foo.bar followed by foo effectively projects foo.
+          # To match this behavior we need to track when we are being asked
+          # to project the association and when we are asked to project a field,
+          # and if we are asked to project the association last we need to
+          # remove any field projections.
+          #
+          # 4.4 (and presumably higher) do not allow projection to be on an
+          # association and its field, so it doesn't matter what we do. Hence
+          # we just need to handle the 4.2 and lower case correctly.
           if bits.first == assoc_key
-            bits.shift
-            filtered[bits.join('.')] = v
+            # Projecting the entire association OR some of its fields
+            if bits.length > 1
+              # Projecting a field
+              bits.shift
+              filtered[bits.join('.')] = v
+              projecting_assoc = false
+            else
+              # Projecting the entire association
+              projecting_assoc = true
+            end
           end
         end
 
+        if projecting_assoc
+          # The last projection was of the entire association; we may have
+          # also been projecting fields, but discard the field projections
+          # and return nil indicating we want the entire association.
+          return nil
+        end
+
         # Positional projection is specified as "foo.$". In this case the
         # document that the $ is referring to should be retrieved with all
         # fields. See https://docs.mongodb.com/manual/reference/operator/projection/positional/

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/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/referenced/belongs_to/binding.rb

@@ -76,7 +76,7 @@ module Mongoid
           # @since 3.0.0
           def check_polymorphic_inverses!(doc)
             inverses = _association.inverses(doc)
-            if inverses.count > 1 && _base.send(_association.foreign_key).nil?
+            if inverses.length > 1 && _base.send(_association.foreign_key).nil?
               raise Errors::InvalidSetPolymorphicRelation.new(
                   _association.name, _base.class.name, _target.class.name
               )

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
 

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?
           #

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)