mongoid 7.3.5 → 7.5.0

data/lib/mongoid/criteria.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/criteria/findable"
 require "mongoid/criteria/includable"
@@ -42,8 +41,6 @@ module Mongoid
 
     # Static array used to check with method missing - we only need to ever
     # instantiate once.
-    #
-    # @since 4.0.0
     CHECK = []
 
     attr_accessor :embedded, :klass, :parent_document, :association
@@ -56,8 +53,6 @@ module Mongoid
     # @param [ Object ] other The other +Enumerable+ or +Criteria+ to compare to.
     #
     # @return [ true, false ] If the objects are equal.
-    #
-    # @since 1.0.0
     def ==(other)
       return super if other.respond_to?(:selector)
       entries == other
@@ -127,6 +122,7 @@ module Mongoid
     #
     # @return [ Criteria ] The cloned criteria.
     def cache
+      Mongoid::Warnings.warn_criteria_cache_deprecated
       crit = clone
       crit.options.merge!(cache: true)
       crit
@@ -139,6 +135,7 @@ module Mongoid
     #
     # @return [ true, false ] If the criteria is flagged as cached.
     def cached?
+      Mongoid::Warnings.warn_criteria_cache_deprecated
       options[:cache] == true
     end
 
@@ -148,8 +145,6 @@ module Mongoid
     #   criteria.documents
     #
     # @return [ Array<Document> ] The documents.
-    #
-    # @since 3.0.0
     def documents
       @documents ||= []
     end
@@ -161,8 +156,6 @@ module Mongoid
     # @param [ Array<Document> ] docs The embedded documents.
     #
     # @return [ Array<Document> ] The embedded documents.
-    #
-    # @since 3.0.0
     def documents=(docs)
       @documents = docs
     end
@@ -173,8 +166,6 @@ module Mongoid
     #   criteria.embedded?
     #
     # @return [ true, false ] If the criteria is embedded.
-    #
-    # @since 3.0.0
     def embedded?
       !!@embedded
     end
@@ -186,8 +177,6 @@ module Mongoid
     #   criteria.extract_id
     #
     # @return [ Object ] The id.
-    #
-    # @since 2.3.0
     def extract_id
       selector.extract_id
     end
@@ -201,8 +190,6 @@ module Mongoid
     # @param [ Hash ] extras The extra driver options.
     #
     # @return [ Criteria ] The cloned criteria.
-    #
-    # @since 2.0.0
     def extras(extras)
       crit = clone
       crit.options.merge!(extras)
@@ -215,8 +202,6 @@ module Mongoid
     #   criteria.field_list
     #
     # @return [ Array<String> ] The fields.
-    #
-    # @since 2.0.0
     def field_list
       if options[:fields]
         options[:fields].keys.reject{ |key| key == klass.discriminator_key }
@@ -233,8 +218,6 @@ module Mongoid
     #   criteria.freeze
     #
     # @return [ Criteria ] The frozen criteria.
-    #
-    # @since 2.0.0
     def freeze
       context and inclusions and super
     end
@@ -245,8 +228,6 @@ module Mongoid
     #   Criteria.new(Band)
     #
     # @param [ Class ] klass The model class.
-    #
-    # @since 1.0.0
     def initialize(klass)
       @klass = klass
       @embedded = nil
@@ -288,8 +269,6 @@ module Mongoid
     # @param [ Criteria ] other The criteria to merge in.
     #
     # @return [ Criteria ] The merged criteria.
-    #
-    # @since 3.0.0
     def merge!(other)
       criteria = other.to_criteria
       selector.merge!(criteria.selector)
@@ -307,8 +286,6 @@ module Mongoid
     #   criteria.none
     #
     # @return [ Criteria ] The none criteria.
-    #
-    # @since 4.0.0
     def none
       @none = true and self
     end
@@ -319,8 +296,6 @@ module Mongoid
     #   criteria.empty_and_chainable?
     #
     # @return [ true, false ] If the criteria is a none.
-    #
-    # @since 4.0.0
     def empty_and_chainable?
       !!@none
     end
@@ -333,8 +308,6 @@ module Mongoid
     # @param [ Array<Symbol> ] args The names of the fields.
     #
     # @return [ Criteria ] The cloned criteria.
-    #
-    # @since 1.0.0
     def only(*args)
       args = args.flatten
       return clone if args.empty?
@@ -355,8 +328,6 @@ module Mongoid
     # @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)
@@ -371,8 +342,6 @@ module Mongoid
     # @param [ Array<Symbol> ] args The names of the fields.
     #
     # @return [ Criteria ] The cloned criteria.
-    #
-    # @since 4.0.3
     def without(*args)
       args -= id_fields
       super(*args)
@@ -399,8 +368,6 @@ module Mongoid
     #   criteria.to_criteria
     #
     # @return [ Criteria ] self.
-    #
-    # @since 3.0.0
     def to_criteria
       self
     end
@@ -411,8 +378,6 @@ module Mongoid
     #   criteria.to_proc
     #
     # @return [ Proc ] The wrapped criteria.
-    #
-    # @since 3.0.0
     def to_proc
       ->{ self }
     end
@@ -447,8 +412,6 @@ module Mongoid
     #   is embedded.
     #
     # @return [ Criteria ] The cloned selectable.
-    #
-    # @since 1.0.0
     def where(*args)
       # Historically this method required exactly one argument.
       # As of https://jira.mongodb.org/browse/MONGOID-4804 it also accepts
@@ -476,8 +439,6 @@ module Mongoid
     #   criteria.without_options
     #
     # @return [ Criteria ] The cloned criteria.
-    #
-    # @since 3.0.4
     def without_options
       crit = clone
       crit.options.clear
@@ -496,8 +457,6 @@ module Mongoid
     # @param [ Hash ] scope The scope for the code.
     #
     # @return [ Criteria ] The criteria.
-    #
-    # @since 3.1.0
     def for_js(javascript, scope = {})
       code = if scope.empty?
         # CodeWithScope is not supported for $where as of MongoDB 4.4
@@ -523,8 +482,6 @@ module Mongoid
     #
     # @raise [ Errors::DocumentNotFound ] If none are found and raising an
     #   error.
-    #
-    # @since 3.0.0
     def check_for_missing_documents!(result, ids)
       if (result.size < ids.size) && Mongoid.raise_not_found_error
         raise Errors::DocumentNotFound.new(klass, ids, ids - result.map(&:_id))
@@ -545,8 +502,6 @@ module Mongoid
     # @param [ Criteria ] other The criteria getting cloned.
     #
     # @return [ nil ] nil.
-    #
-    # @since 1.0.0
     def initialize_copy(other)
       @inclusions = other.inclusions.dup
       @scoping_options = other.scoping_options
@@ -565,8 +520,6 @@ module Mongoid
     # @param [ Array ] args The arguments.
     #
     # @return [ Object ] The result of the method call.
-    #
-    # @since 1.0.0
     ruby2_keywords def method_missing(name, *args, &block)
       if klass.respond_to?(name)
         klass.send(:with_scope, self) do
@@ -586,8 +539,6 @@ module Mongoid
     #   criteria.merge_type_selection
     #
     # @return [ true, false ] If type selection was added.
-    #
-    # @since 3.0.3
     def merge_type_selection
       selector.merge!(type_selection) if type_selectable?
     end
@@ -600,8 +551,6 @@ module Mongoid
     #   criteria.type_selectable?
     #
     # @return [ true, false ] If type selection should be added.
-    #
-    # @since 3.0.3
     def type_selectable?
       klass.hereditary? &&
         !selector.keys.include?(self.discriminator_key) &&
@@ -616,8 +565,6 @@ module Mongoid
     #   criteria.type_selection
     #
     # @return [ Hash ] The type selection.
-    #
-    # @since 3.0.3
     def type_selection
       klasses = klass._types
       if klasses.size > 1
@@ -635,8 +582,6 @@ module Mongoid
     #   criteria.selector_with_type_selection
     #
     # @return [ Hash ] The selector.
-    #
-    # @since 3.0.3
     def selector_with_type_selection
       type_selectable? ? selector.merge(type_selection) : selector
     end

data/lib/mongoid/document.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/positional"
 require "mongoid/evolvable"
@@ -40,8 +39,6 @@ module Mongoid
     # that should be used instead.
     # When ruby driver 2.3.0 is released and Mongoid can be updated
     # to require >= 2.3.0, the BSON constant can be used.
-    #
-    # @since 6.0.0
     ILLEGAL_KEY = /(\A[$])|(\.)/.freeze
 
     # Freezes the internal attributes of the document.
@@ -50,8 +47,6 @@ module Mongoid
     #   document.freeze
     #
     # @return [ Document ] The document.
-    #
-    # @since 2.0.0
     def freeze
       as_attributes.freeze and self
     end
@@ -62,8 +57,6 @@ module Mongoid
     #   document.frozen?
     #
     # @return [ true, false ] True if frozen, else false.
-    #
-    # @since 2.0.0
     def frozen?
       attributes.frozen?
     end
@@ -78,8 +71,6 @@ module Mongoid
     #   document.hash
     #
     # @return [ Integer ] The hash of the document's identity.
-    #
-    # @since 1.0.0
     def hash
       identity.hash
     end
@@ -92,8 +83,6 @@ module Mongoid
     #   document.identity
     #
     # @return [ Array ] An array containing [document.class, document._id]
-    #
-    # @since 3.0.0
     def identity
       [ self.class, self._id ]
     end
@@ -111,8 +100,6 @@ module Mongoid
     # @param [ Hash ] attrs The attributes to set up the document with.
     #
     # @return [ Document ] A new document.
-    #
-    # @since 1.0.0
     def initialize(attrs = nil)
       @__parent = nil
       _building do
@@ -136,8 +123,6 @@ module Mongoid
     #   document.model_name
     #
     # @return [ String ] The model name.
-    #
-    # @since 3.0.16
     def model_name
       self.class.model_name
     end
@@ -148,8 +133,6 @@ module Mongoid
     #   document.to_key
     #
     # @return [ String ] The id of the document or nil if new.
-    #
-    # @since 2.4.0
     def to_key
       (persisted? || destroyed?) ? [ _id.to_s ] : nil
     end
@@ -161,7 +144,7 @@ module Mongoid
     #
     # @return [ Array<Document> ] An array with the document as its only item.
     #
-    # @since 1.0.0
+    # @deprecated
     def to_a
       [ self ]
     end
@@ -174,8 +157,6 @@ module Mongoid
     #   person.as_document
     #
     # @return [ Hash ] A hash of all attributes in the hierarchy.
-    #
-    # @since 1.0.0
     def as_document
       BSON::Document.new(as_attributes)
     end
@@ -198,8 +179,6 @@ module Mongoid
     #   with nil values in the json document.
     #
     # @return [ Hash ] The document as json.
-    #
-    # @since 5.1.0
     def as_json(options = nil)
       rv = super
       if options && options[:compact]
@@ -220,8 +199,6 @@ module Mongoid
     # @param [ Class ] klass The class to become.
     #
     # @return [ Document ] An instance of the specified class.
-    #
-    # @since 2.0.0
     def becomes(klass)
       unless klass.include?(Mongoid::Document)
         raise ArgumentError, "A class which includes Mongoid::Document is expected"
@@ -256,8 +233,6 @@ module Mongoid
     # Returns the logger
     #
     # @return [ Logger ] The configured logger or a default Logger instance.
-    #
-    # @since 2.2.0
     def logger
       Mongoid.logger
     end
@@ -268,8 +243,6 @@ module Mongoid
     #   model.model_key
     #
     # @return [ String ] The model key.
-    #
-    # @since 2.4.0
     def model_key
       @model_cache_key ||= self.class.model_name.cache_key
     end
@@ -293,20 +266,6 @@ module Mongoid
 
     module ClassMethods
 
-      # Performs class equality checking.
-      #
-      # @example Compare the classes.
-      #   document === other
-      #
-      # @param [ Document, Object ] other The other object to compare with.
-      #
-      # @return [ true, false ] True if the classes are equal, false if not.
-      #
-      # @since 2.0.0.rc.4
-      def ===(other)
-        other.class == Class ? self <= other : other.is_a?(self)
-      end
-
       # Instantiate a new object, only when loaded from the database or when
       # the attributes have already been typecast.
       #
@@ -318,8 +277,6 @@ module Mongoid
       #   criteria.
       #
       # @return [ Document ] A new document.
-      #
-      # @since 1.0.0
       def instantiate(attrs = nil, selected_fields = nil)
         attributes = attrs || {}
         doc = allocate
@@ -338,8 +295,6 @@ module Mongoid
       #   document._types
       #
       # @return [ Array<Class> ] All subclasses of the current document.
-      #
-      # @since 1.0.0
       def _types
         @_type ||= (descendants + [ self ]).uniq.map(&:discriminator_value)
       end
@@ -359,8 +314,6 @@ module Mongoid
       # Set the i18n scope to overwrite ActiveModel.
       #
       # @return [ Symbol ] :mongoid
-      #
-      # @since 2.0.0
       def i18n_scope
         :mongoid
       end
@@ -371,8 +324,6 @@ module Mongoid
       #   Person.logger
       #
       # @return [ Logger ] The configured logger or a default Logger instance.
-      #
-      # @since 2.2.0
       def logger
         Mongoid.logger
       end

data/lib/mongoid/equality.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # This module contains the behavior of Mongoid's clone/dup of documents.
   module Equality
+    # Leave the current contents of this module outside of InstanceMethods
+    # to prevent cherry picking conflicts. For now...
+    extend ActiveSupport::Concern
 
     # Default comparison is via the string version of the id.
     #
@@ -14,8 +16,6 @@ module Mongoid
     # @param [ Document ] other The document to compare with.
     #
     # @return [ Integer ] -1, 0, 1.
-    #
-    # @since 1.0.0
     def <=>(other)
       attributes["_id"].to_s <=> other.attributes["_id"].to_s
     end
@@ -29,8 +29,6 @@ module Mongoid
     # @param [ Document, Object ] other The other object to compare with.
     #
     # @return [ true, false ] True if the ids are equal, false if not.
-    #
-    # @since 1.0.0
     def ==(other)
       self.class == other.class &&
           attributes["_id"] == other.attributes["_id"]
@@ -44,10 +42,12 @@ module Mongoid
     # @param [ Document, Object ] other The other object to compare with.
     #
     # @return [ true, false ] True if the classes are equal, false if not.
-    #
-    # @since 1.0.0
     def ===(other)
-      other.class == Class ? self.class === other : self == other
+      if Mongoid.legacy_triple_equals
+        super
+      else
+        other.class == Class ? self.class === other : self == other
+      end
     end
 
     # Delegates to ==. Used when needing checks in hashes.
@@ -58,10 +58,26 @@ module Mongoid
     # @param [ Document, Object ] other The object to check against.
     #
     # @return [ true, false ] True if equal, false if not.
-    #
-    # @since 1.0.0
     def eql?(other)
       self == (other)
     end
+
+    module ClassMethods
+      # Performs class equality checking.
+      #
+      # @example Compare the classes.
+      #   document === other
+      #
+      # @param [ Document, Object ] other The other object to compare with.
+      #
+      # @return [ true, false ] True if the classes are equal, false if not.
+      def ===(other)
+        if Mongoid.legacy_triple_equals
+          other.is_a?(self)
+        else
+          other.class == Class ? self <= other : other.is_a?(self)
+        end
+      end
+    end
   end
 end

data/lib/mongoid/errors/ambiguous_relationship.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
 
-    # This error is raised in case of an ambigous association.
+    # This error is raised in case of an ambiguous association.
     #
-    # @example An ambigous association.
+    # @example An ambiguous association.
     #   class Person
     #     include Mongoid::Document
     #
@@ -33,8 +32,6 @@ module Mongoid
       # @param [ Class ] inverse The inverse class.
       # @param [ Symbol ] name The relation name.
       # @param [ Array<Symbol> ] candidates The potential inverses.
-      #
-      # @since 3.0.0
       def initialize(klass, inverse, name, candidates)
         super(
           compose_message(

data/lib/mongoid/errors/callback.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -15,8 +14,6 @@ module Mongoid
       #
       # @param [ Class ] klass The class of the document.
       # @param [ Symbol ] method The name of the method.
-      #
-      # @since 2.2.0
       def initialize(klass, method)
         super(
           compose_message("callbacks", { klass: klass, method: method })

data/lib/mongoid/errors/criteria_argument_required.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors

data/lib/mongoid/errors/delete_restriction.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,6 @@ module Mongoid
       #   destroyed.
       # @param [ Symbol ] association_name The name of the dependent
       #   association that prevents the document from being deleted.
-      #
-      # @since 3.0.0
       def initialize(document, association_name)
         super(
           compose_message(

data/lib/mongoid/errors/document_not_destroyed.rb

@@ -1,24 +1,19 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
 
-    # Raised when attempting to destroy a document that had destory callbacks
+    # Raised when attempting to destroy a document that had destroy callbacks
     # return false.
-    #
-    # @since 4.0.0
     class DocumentNotDestroyed < MongoidError
 
-      # Instnatiate the exception.
+      # Instantiate the exception.
       #
       # @example Create the error.
       #   DocumentNotDestroyed.new(Band)
       #
       # @param [ Object ] id The document id.
       # @param [ Class ] klass The document class.
-      #
-      # @since 4.0.0
       def initialize(id, klass)
         super(compose_message("document_not_destroyed", { id: id.inspect, klass: klass }))
       end

data/lib/mongoid/errors/document_not_found.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -24,13 +23,13 @@ module Mongoid
       # @param [ Array ] unmatched The unmatched ids, if appropriate
       def initialize(klass, params, unmatched = nil)
         if !unmatched && !params.is_a?(Hash)
-          unmatched = Array(params)
+          unmatched = Array(params) if params
         end
 
         @klass, @params = klass, params
         super(
           compose_message(
-            message_key(params),
+            message_key(params, unmatched),
             {
               klass: klass.name,
               searched: searched(params),
@@ -52,8 +51,6 @@ module Mongoid
       # @param [ Object, Array ] unmatched The ids that did not match.
       #
       # @return [ String ] The missing string.
-      #
-      # @since 3.0.0
       def missing(unmatched)
         if unmatched.is_a?(::Array)
           unmatched.join(", ")
@@ -70,8 +67,6 @@ module Mongoid
       # @param [ Object, Array ] params The ids that were searched for.
       #
       # @return [ String ] The searched string.
-      #
-      # @since 3.0.0
       def searched(params)
         if params.is_a?(::Array)
           params.take(3).join(", ") + " ..."
@@ -88,8 +83,6 @@ module Mongoid
       # @param [ Object, Array ] params What was searched for.
       #
       # @return [ Integer ] The total number.
-      #
-      # @since 3.0.0
       def total(params)
         params.is_a?(::Array) ? params.count : 1
       end
@@ -100,12 +93,27 @@ module Mongoid
       #   error.problem
       #
       # @return [ String ] The problem.
-      #
-      # @since 3.0.0
-      def message_key(params)
-        case params
-          when Hash then "document_with_attributes_not_found"
-          else "document_not_found"
+      def message_key(params, unmatched)
+        if !params && !unmatched
+          "no_documents_found"
+        elsif Hash === params
+          "document_with_attributes_not_found"
+        elsif Hash === unmatched && unmatched.size >= 2
+          "document_with_shard_key_not_found"
+        else
+          "document_not_found"
+        end
+      end
+
+      # Get the shard key from the unmatched hash.
+      #
+      # @return [ String ] the shard key and value.
+      def shard_key(unmatched)
+        if Hash === unmatched
+          h = unmatched.dup
+          h.delete("_id")
+          h.delete(:_id)
+          h.map{|k,v| "#{k}: #{v}" }.join(", ")
         end
       end
     end

data/lib/mongoid/errors/eager_load.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -16,8 +15,6 @@ module Mongoid
       #   EagerLoad.new(:preferences)
       #
       # @param [ Symbol ] name The name of the association.
-      #
-      # @since 2.2.0
       def initialize(name)
         super(compose_message("eager_load", { name: name }))
       end

data/lib/mongoid/errors/empty_config_file.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors