mongoid 5.4.1 → 7.4.0

data/lib/mongoid/document.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/positional"
 require "mongoid/evolvable"
 require "mongoid/extensions"
 require "mongoid/errors"
 require "mongoid/threaded"
-require "mongoid/relations"
 require "mongoid/atomic"
 require "mongoid/attributes"
 require "mongoid/contextual"
@@ -14,7 +14,9 @@ require "mongoid/criteria"
 require "mongoid/factory"
 require "mongoid/fields"
 require "mongoid/timestamps"
+require "mongoid/association"
 require "mongoid/composable"
+require "mongoid/touchable"
 
 module Mongoid
 
@@ -23,6 +25,7 @@ module Mongoid
   module Document
     extend ActiveSupport::Concern
     include Composable
+    include Mongoid::Touchable::InstanceMethods
 
     attr_accessor :__selected_fields
     attr_reader :new_record
@@ -31,16 +34,21 @@ module Mongoid
       Mongoid.register_model(self)
     end
 
+    # Regex for matching illegal BSON keys.
+    # Note that bson 4.1 has the constant BSON::String::ILLEGAL_KEY
+    # 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.
+    ILLEGAL_KEY = /(\A[$])|(\.)/.freeze
+
     # Freezes the internal attributes of the document.
     #
     # @example Freeze the document
     #   document.freeze
     #
     # @return [ Document ] The document.
-    #
-    # @since 2.0.0
     def freeze
-      as_document.freeze and self
+      as_attributes.freeze and self
     end
 
     # Checks if the document is frozen
@@ -49,8 +57,6 @@ module Mongoid
     #   document.frozen?
     #
     # @return [ true, false ] True if frozen, else false.
-    #
-    # @since 2.0.0
     def frozen?
       attributes.frozen?
     end
@@ -65,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
@@ -79,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
@@ -98,14 +100,11 @@ 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
         @new_record = true
         @attributes ||= {}
-        with(self.class.persistence_options)
         apply_pre_processed_defaults
         apply_default_scoping
         process_attributes(attrs) do
@@ -124,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
@@ -136,10 +133,8 @@ 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
+      (persisted? || destroyed?) ? [ _id.to_s ] : nil
     end
 
     # Return an array with this +Document+ only in it.
@@ -148,8 +143,6 @@ module Mongoid
     #   document.to_a
     #
     # @return [ Array<Document> ] An array with the document as its only item.
-    #
-    # @since 1.0.0
     def to_a
       [ self ]
     end
@@ -162,44 +155,35 @@ module Mongoid
     #   person.as_document
     #
     # @return [ Hash ] A hash of all attributes in the hierarchy.
-    #
-    # @since 1.0.0
     def as_document
-      return attributes if frozen?
-      embedded_relations.each_pair do |name, meta|
-        without_autobuild do
-          relation, stored = send(name), meta.store_as
-          if attributes.key?(stored) || !relation.blank?
-            if relation
-              attributes[stored] = relation.as_document
-            else
-              attributes.delete(stored)
-            end
-          end
-        end
-      end
-      attributes
+      BSON::Document.new(as_attributes)
     end
 
     # Calls #as_json on the document with additional, Mongoid-specific options.
     #
+    # @note Rails 6 changes return value of as_json for non-primitive types
+    #   such as BSON::ObjectId. In Rails <= 5, as_json returned these as
+    #   instances of the class. In Rails 6, these are returned serialized to
+    #   primitive types (e.g. {"$oid"=>"5bcfc40bde340b37feda98e9"}).
+    #   See https://github.com/rails/rails/commit/2e5cb980a448e7f4ab00df6e9ad4c1cc456616aa
+    #   for more information.
+    #
     # @example Get the document as json.
     #   document.as_json(compact: true)
     #
     # @param [ Hash ] options The options.
     #
-    # @option options [ true, false ] :compact Whether to include fields with
-    #   nil values in the json document.
+    # @option options [ true, false ] :compact (Deprecated) Whether to include fields
+    #   with nil values in the json document.
     #
     # @return [ Hash ] The document as json.
-    #
-    # @since 5.1.0
     def as_json(options = nil)
-      if options && (options[:compact] == true)
-        super(options).reject! { |k,v| v.nil? }
-      else
-        super(options)
+      rv = super
+      if options && options[:compact]
+        Mongoid.logger.warn('#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.')
+        rv = rv.compact
       end
+      rv
     end
 
     # Returns an instance of the specified class with the attributes,
@@ -213,8 +197,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"
@@ -223,12 +205,13 @@ module Mongoid
       became = klass.new(clone_document)
       became._id = _id
       became.instance_variable_set(:@changed_attributes, changed_attributes)
-      became.instance_variable_set(:@errors, ActiveModel::Errors.new(became))
-      became.errors.instance_variable_set(:@messages, errors.instance_variable_get(:@messages))
+      new_errors = ActiveModel::Errors.new(became)
+      new_errors.copy!(errors)
+      became.instance_variable_set(:@errors, new_errors)
       became.instance_variable_set(:@new_record, new_record?)
       became.instance_variable_set(:@destroyed, destroyed?)
-      became.changed_attributes["_type"] = self.class.to_s
-      became._type = klass.to_s
+      became.changed_attributes[klass.discriminator_key] = self.class.discriminator_value
+      became[klass.discriminator_key] = klass.discriminator_value
 
       # mark embedded docs as persisted
       embedded_relations.each_pair do |name, meta|
@@ -243,34 +226,11 @@ module Mongoid
       became
     end
 
-    # Print out the cache key. This will append different values on the
-    # plural model name.
-    #
-    # If new_record?     - will append /new
-    # If not             - will append /id-updated_at.to_s(:nsec)
-    # Without updated_at - will append /id
-    #
-    # This is usually called insode a cache() block
-    #
-    # @example Returns the cache key
-    #   document.cache_key
-    #
-    # @return [ String ] the string with or without updated_at
-    #
-    # @since 2.4.0
-    def cache_key
-      return "#{model_key}/new" if new_record?
-      return "#{model_key}/#{id}-#{updated_at.utc.to_s(:nsec)}" if do_or_do_not(:updated_at)
-      "#{model_key}/#{id}"
-    end
-
     private
 
     # Returns the logger
     #
     # @return [ Logger ] The configured logger or a default Logger instance.
-    #
-    # @since 2.2.0
     def logger
       Mongoid.logger
     end
@@ -281,40 +241,29 @@ 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
 
-    # Implement this for calls to flatten on array.
-    #
-    # @example Get the document as an array.
-    #   document.to_ary
-    #
-    # @return [ nil ] Always nil.
-    #
-    # @since 2.1.0
-    def to_ary
-      nil
+    def as_attributes
+      return attributes if frozen?
+      embedded_relations.each_pair do |name, meta|
+        without_autobuild do
+          relation, stored = send(name), meta.store_as
+          if attributes.key?(stored) || !relation.blank?
+            if !relation.nil?
+              attributes[stored] = relation.send(:as_attributes)
+            else
+              attributes.delete(stored)
+            end
+          end
+        end
+      end
+      attributes
     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.
-      #
-      # @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.
       #
@@ -326,8 +275,6 @@ module Mongoid
       #   criteria.
       #
       # @return [ Document ] A new document.
-      #
-      # @since 1.0.0
       def instantiate(attrs = nil, selected_fields = nil)
         attributes = attrs || {}
         doc = allocate
@@ -346,17 +293,25 @@ module Mongoid
       #   document._types
       #
       # @return [ Array<Class> ] All subclasses of the current document.
-      #
-      # @since 1.0.0
       def _types
-        @_type ||= (descendants + [ self ]).uniq.map(&:to_s)
+        @_type ||= (descendants + [ self ]).uniq.map(&:discriminator_value)
+      end
+
+      # Clear the @_type cache. This is generally called when changing the discriminator
+      # key/value on a class.
+      #
+      # @example Get the types.
+      #   document._mongoid_clear_types
+      #
+      # @api private
+      def _mongoid_clear_types
+        @_type = nil
+        superclass._mongoid_clear_types if hereditary?
       end
 
       # Set the i18n scope to overwrite ActiveModel.
       #
       # @return [ Symbol ] :mongoid
-      #
-      # @since 2.0.0
       def i18n_scope
         :mongoid
       end
@@ -367,8 +322,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,8 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # This module contains the behaviour of Mongoid's clone/dup of documents.
+  # 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.
     #
@@ -12,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
@@ -27,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"]
@@ -42,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.
@@ -56,11 +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,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # This error is raised in case of an ambigous relationship.
+    # This error is raised in case of an ambiguous association.
     #
-    # @example An ambigous relationship.
+    # @example An ambiguous association.
     #   class Person
     #     include Mongoid::Document
     #
@@ -24,15 +25,13 @@ module Mongoid
       #
       # @example Create the error.
       #   AmbiguousRelationship.new(
-      #     Person, Drug, :person, [ :drugs, #   :evil_drugs ]
+      #     Person, Drug, :person, [ :drugs, :evil_drugs ]
       #   )
       #
       # @param [ Class ] klass The base class.
       # @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,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -13,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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a method on Criteria is given a nil argument.
+    class CriteriaArgumentRequired < MongoidError
+
+      # Creates the new exception instance.
+      #
+      # @api private
+      def initialize(query_method)
+        super(compose_message("criteria_argument_required",
+          query_method: query_method))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/delete_restriction.rb

@@ -1,29 +1,26 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # This error is raised when calling #save! or .create! on a model when one
-    # of the callbacks returns false.
+    # This error is raised when attempting to destroy a model which has
+    # an association with dependency option set to restrict.
     class DeleteRestriction < MongoidError
 
       # Create the new callbacks error.
       #
-      # @example Create the new callbacks error.
-      #   Callbacks.new(Post, :create!)
-      #
-      # @param [ Class ] document
-      # @param [ Symbol ] relation
-      #
-      # @since 3.0.0
-      def initialize(document, relation)
+      # @param [ Document ] document The document that was attempted to be
+      #   destroyed.
+      # @param [ Symbol ] association_name The name of the dependent
+      #   association that prevents the document from being deleted.
+      def initialize(document, association_name)
         super(
           compose_message(
             "delete_restriction",
-            { document: document.class, relation: relation }
+            { document: document.class, relation: association_name }
           )
         )
       end
     end
   end
 end
-

data/lib/mongoid/errors/document_not_destroyed.rb

@@ -1,22 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 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,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -50,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(", ")
@@ -68,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(", ") + " ..."
@@ -86,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
@@ -98,8 +93,6 @@ 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"

data/lib/mongoid/errors/eager_load.rb

@@ -1,9 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
     # This error is raised when attempting to eager load a many to many
-    # relation.
+    # association.
+    #
+    # @deprecated No longer used by Mongoid per MONGOID-4841.
     class EagerLoad < MongoidError
 
       # Create the new eager load error.
@@ -11,9 +14,7 @@ module Mongoid
       # @example Create the new eager load error.
       #   EagerLoad.new(:preferences)
       #
-      # @param [ Symbol ] name The name of the relation.
-      #
-      # @since 2.2.0
+      # @param [ Symbol ] name The name of the association.
       def initialize(name)
         super(compose_message("eager_load", { name: name }))
       end

data/lib/mongoid/errors/empty_config_file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when an empty configuration file is attempted to be
+    # loaded.
+    class EmptyConfigFile < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ String ] path The path of the config file used.
+      #
+      # @api private
+      def initialize(path)
+        super(
+          compose_message(
+            "empty_config_file",
+            { path: path }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/in_memory_collation_not_supported.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -10,8 +11,6 @@ module Mongoid
       #
       # @example Create the new unsupported collation error.
       #   InMemoryCollationNotSupported.new
-      #
-      # @since 5.2.0
       def initialize
         super(compose_message("in_memory_collation_not_supported"))
       end

data/lib/mongoid/errors/invalid_collection.rb

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