mongoid 7.1.7 → 7.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93d8b658e53d12f1deb7a131e3d58155fead7576955078187f3b3181072c193f
-  data.tar.gz: 35e629224f7495969e5a695a9641043ad61b92d61b57926b1d1956bd2f5e1d7c
+  metadata.gz: da086175f8b41ffc6991262225460da5577f7ea47d3c355f34e072ff5c78d5f1
+  data.tar.gz: 7797a83ed15fd55f0ec8aba1a43569393f99f037a7f1013aeb0770f0aa4c3000
 SHA512:
-  metadata.gz: 33920733722a4da26c23190788ef198d86d0d3edfcedc3d53bc7364d9abfbda7c54634af875c678757745c1d18b225457ef8e0a5b5711db7e76b93350548d14b
-  data.tar.gz: cb0acea4219ce1972fe67b63f988b0f31197ab44142288e5af4fe84e63f602dbc9b7dcc23edbf54cc5e465288c23346f62d3cf0632e0b37a59fabc6acb1c6925
+  metadata.gz: f18e6f9ca45ce9cc406a32983d031388c5f6a76100de18fcdf036163bf08c74f4f15a1e77a02c6445e37f2824ec6ecf549514bf78447f7876b8d52d2c2fb4947
+  data.tar.gz: ca7b9fe36e273d4e2dab3680dbaa973450eb2b87ae58a9d462bba6ec95d27de1479255175a9d7971b32e61b5a43726d7b7855134c5ec733b75e126e6e51fb408

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

@@ -22,8 +22,11 @@ task :install => :build do
   system "sudo gem install mongoid-#{Mongoid::VERSION}.gem"
 end
 
-task :release do
-  raise "Please use ./release.sh to release"
+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"
 end
 
 RSpec::Core::RakeTask.new("spec") do |spec|
@@ -35,6 +38,13 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
+task :ci do
+  $LOAD_PATH.push File.expand_path("../spec", __FILE__)
+  require 'support/spec_organizer'
+
+  SpecOrganizer.new.run
+end
+
 task :default => :spec
 
 desc "Generate all documentation"
@@ -56,3 +66,5 @@ namespace :release do
     end
   end
 end
+
+task :release => ['release:check_private_key', 'release:do']

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
@@ -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/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/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

@@ -46,7 +46,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/association/referenced/has_one/proxy.rb

@@ -54,14 +54,9 @@ module Mongoid
           #
           # @since 2.0.0.rc.1
           def substitute(replacement)
-            # If the same object currently associated is being assigned,
-            # rebind the association and save the target but do not destroy
-            # the target.
-
             unbind_one
             if persistable?
-              # TODO can this entire method be skipped if self == replacement?
-              if _association.destructive? && self != replacement
+              if _association.destructive?
                 send(_association.dependent)
               else
                 save if persisted?

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/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.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/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