mongoid 7.3.5 → 7.4.0

data/lib/mongoid/railtie.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "rails"
 require "rails/mongoid"
@@ -8,8 +7,6 @@ module Rails
   module Mongoid
 
     # Hooks Mongoid into Rails 3 and higher.
-    #
-    # @since 2.0.0
     class Railtie < Rails::Railtie
 
       # Mapping of rescued exceptions to HTTP responses
@@ -18,8 +15,6 @@ module Rails
       #   railtie.rescue_responses
       #
       # @ return [Hash] rescued responses
-      #
-      # @since 2.4.3
       def self.rescue_responses
         {
           "Mongoid::Errors::DocumentNotFound" => :not_found,
@@ -45,14 +40,10 @@ module Rails
       #       config.mongoid.logger = Logger.new(STDERR, :warn)
       #     end
       #   end
-      #
-      # @since 2.0.0
       config.mongoid = ::Mongoid::Config
 
       # Initialize Mongoid. This will look for a mongoid.yml in the config
       # directory and configure mongoid appropriately.
-      #
-      # @since 2.0.0
       initializer "mongoid.load-config" do
         config_file = Rails.root.join("config", "mongoid.yml")
         if config_file.file?
@@ -72,8 +63,6 @@ module Rails
 
       # Set the proper error types for Rails. DocumentNotFound errors should be
       # 404s and not 500s, validation errors are 422s.
-      #
-      # @since 2.0.0
       config.after_initialize do
         unless config.action_dispatch.rescue_responses
           ActionDispatch::ShowExceptions.rescue_responses.update(Railtie.rescue_responses)
@@ -86,8 +75,6 @@ module Rails
       #
       # This will happen for every request in development, once in other
       # environments.
-      #
-      # @since 2.0.0
       initializer "mongoid.preload-models" do |app|
         config.to_prepare do
           ::Rails::Mongoid.preload_models(app)
@@ -98,8 +85,6 @@ module Rails
       # code, so we have no way in the intitializer to know if we are
       # generating a mongoid.yml. So instead of failing, we catch all the
       # errors and print them out.
-      #
-      # @since 3.0.0
       def handle_configuration_error(e)
         puts "There is a configuration error with the current mongoid.yml."
         puts e.message

data/lib/mongoid/railties/controller_runtime.rb

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

data/lib/mongoid/reloadable.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # This module handles reloading behavior of documents.
-  #
-  # @since 4.0.0
   module Reloadable
 
     # Reloads the +Document+ attributes from the database. If the document has
@@ -18,8 +15,6 @@ module Mongoid
     # @raise [ Errors::DocumentNotFound ] If the document was deleted.
     #
     # @return [ Document ] The document, reloaded.
-    #
-    # @since 1.0.0
     def reload
       if @atomic_selector
         # Clear atomic_selector cache for sharded clusters. MONGOID-5076
@@ -27,7 +22,7 @@ module Mongoid
       end
 
       reloaded = _reload
-      if Mongoid.raise_not_found_error && reloaded.empty?
+      if Mongoid.raise_not_found_error && (reloaded.nil? || reloaded.empty?)
         raise Errors::DocumentNotFound.new(self.class, _id, _id)
       end
       @attributes = reloaded
@@ -50,8 +45,6 @@ module Mongoid
     #   document._reload
     #
     # @return [ Hash ] The reloaded attributes.
-    #
-    # @since 2.3.2
     def _reload
       embedded? ? reload_embedded_document : reload_root_document
     end
@@ -62,8 +55,6 @@ module Mongoid
     #   document.reload_root_document
     #
     # @return [ Hash ] The reloaded attributes.
-    #
-    # @since 2.3.2
     def reload_root_document
       {}.merge(collection.find(atomic_selector, session: _session).read(mode: :primary).first || {})
     end
@@ -74,11 +65,9 @@ module Mongoid
     #   document.reload_embedded_document
     #
     # @return [ Hash ] The reloaded attributes.
-    #
-    # @since 2.3.2
     def reload_embedded_document
       extract_embedded_attributes({}.merge(
-        collection(_root).find(_root.atomic_selector).read(mode: :primary).first
+        collection(_root).find(_root.atomic_selector, session: _session).read(mode: :primary).first
       ))
     end
 
@@ -89,9 +78,8 @@ module Mongoid
     #
     # @param [ Hash ] attributes The document in the db.
     #
-    # @return [ Hash ] The document's extracted attributes.
-    #
-    # @since 2.3.2
+    # @return [ Hash | nil ] The document's extracted attributes or nil if the
+    #   document doesn't exist.
     def extract_embedded_attributes(attributes)
       atomic_position.split(".").inject(attributes) do |attrs, part|
         attrs = attrs[part =~ /\d/ ? part.to_i : part]

data/lib/mongoid/scopable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # This module contains behavior for all Mongoid scoping - named scopes,
   # default scopes, and criteria accessors via scoped and unscoped.
-  #
-  # @since 4.0.0
   module Scopable
     extend ActiveSupport::Concern
 
@@ -27,8 +24,6 @@ module Mongoid
     #   document.apply_default_scoping
     #
     # @return [ true, false ] If default scoping was applied.
-    #
-    # @since 4.0.0
     def apply_default_scoping
       if default_scoping
         default_scoping.call.selector.each do |field, value|
@@ -52,8 +47,6 @@ module Mongoid
       #   Band.scopes
       #
       # @return [ Hash ] The scopes defined for this class
-      #
-      # @since 3.1.4
       def scopes
         defined_scopes = {}
         ancestors.reverse.each do |klass|
@@ -86,8 +79,6 @@ module Mongoid
       # @raise [ Errors::InvalidScope ] If the scope is not a proc or criteria.
       #
       # @return [ Proc ] The default scope.
-      #
-      # @since 1.0.0
       def default_scope(value = nil)
         value = Proc.new { yield } if block_given?
         check_scope_validity(value)
@@ -100,8 +91,6 @@ module Mongoid
       #   Band.default_scopable?
       #
       # @return [ true, false ] If the default scope can be applied.
-      #
-      # @since 3.0.0
       def default_scopable?
         default_scoping? && !Threaded.without_default_scope?(self)
       end
@@ -114,8 +103,6 @@ module Mongoid
       #   Model.queryable
       #
       # @return [ Criteria ] The queryable.
-      #
-      # @since 3.0.0
       def queryable
         crit = Threaded.current_scope(self) || Criteria.new(self)
         crit.embedded = true if (crit.klass.embedded? && !crit.klass.cyclic?)
@@ -141,8 +128,6 @@ module Mongoid
       #
       # @raise [ Errors::InvalidScope ] If the scope is not a proc.
       # @raise [ Errors::ScopeOverwrite ] If the scope name already exists.
-      #
-      # @since 1.0.0
       def scope(name, value, &block)
         normalized = name.to_sym
         check_scope_validity(value)
@@ -169,8 +154,6 @@ module Mongoid
       # @option options [ Array ] :sort Optional sorting options.
       #
       # @return [ Criteria ] A scoped criteria.
-      #
-      # @since 3.0.0
       def scoped(options = nil)
         queryable.scoped(options)
       end
@@ -189,8 +172,6 @@ module Mongoid
       #
       # @return [ Criteria, Object ] The unscoped criteria or result of the
       #   block.
-      #
-      # @since 3.0.0
       def unscoped
         if block_given?
           without_default_scope do
@@ -207,8 +188,6 @@ module Mongoid
       #   Model.with_default_scope
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 3.0.0
       def with_default_scope
         queryable.with_default_scope
       end
@@ -223,14 +202,17 @@ module Mongoid
       # @param [ Criteria ] criteria The criteria to apply.
       #
       # @return [ Criteria ] The yielded criteria.
-      #
-      # @since 1.0.0
       def with_scope(criteria)
+        previous = Threaded.current_scope(self)
         Threaded.set_current_scope(criteria, self)
         begin
           yield criteria
         ensure
-          Threaded.set_current_scope(nil, self)
+          if Mongoid.broken_scoping
+            Threaded.set_current_scope(nil, self)
+          else
+            Threaded.set_current_scope(previous, self)
+          end
         end
       end
 
@@ -242,8 +224,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the block.
-      #
-      # @since 3.0.0
       def without_default_scope
         Threaded.begin_without_default_scope(self)
         yield
@@ -264,8 +244,6 @@ module Mongoid
       #
       # @raise [ Errors::ScopeOverwrite ] If the name exists and configured to
       #   raise the error.
-      #
-      # @since 2.1.0
       def check_scope_name(name)
         if _declared_scopes[name] || respond_to?(name, true)
           if Mongoid.scope_overwrite_exception
@@ -292,8 +270,6 @@ module Mongoid
       # @param [ Object ] value The intended scope.
       #
       # @raise [ Errors::InvalidScope ] If the scope is not a valid object.
-      #
-      # @since 3.0.0
       def check_scope_validity(value)
         unless value.respond_to?(:call)
           raise Errors::InvalidScope.new(self, value)
@@ -311,8 +287,6 @@ module Mongoid
       # @param [ Symbol ] name The method/scope name.
       #
       # @return [ Method ] The defined method.
-      #
-      # @since 3.0.0
       def define_scope_method(name)
         singleton_class.class_eval do
           define_method(name) do |*args|
@@ -336,8 +310,6 @@ module Mongoid
       #   Model.process_default_scope(value)
       #
       # @param [ Criteria, Proc ] value The default scope value.
-      #
-      # @since 3.0.5
       def process_default_scope(value)
         if existing = default_scoping
           ->{ existing.call.merge(value.to_proc.call) }

data/lib/mongoid/selectable.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # Provides behavior for generating the selector for a specific document.
-  #
-  # @since 4.0.0
   module Selectable
     extend ActiveSupport::Concern
 
@@ -17,8 +14,6 @@ module Mongoid
     #   document.atomic_selector
     #
     # @return [ Hash ] The document's selector.
-    #
-    # @since 1.0.0
     def atomic_selector
       @atomic_selector ||=
         (embedded? ? embedded_atomic_selector : root_atomic_selector_in_db)
@@ -34,8 +29,6 @@ module Mongoid
     #   document.embedded_atomic_selector
     #
     # @return [ Hash ] The embedded document selector.
-    #
-    # @since 4.0.0
     def embedded_atomic_selector
       if persisted? && _id_changed?
         _parent.atomic_selector
@@ -50,8 +43,6 @@ module Mongoid
     # @api private
     #
     # @return [ Hash ] The root document selector.
-    #
-    # @since 4.0.0
     def root_atomic_selector_in_db
       { "_id" => _id }.merge!(shard_key_selector_in_db)
     end

data/lib/mongoid/serializable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # This module provides the extra behavior for including associations in JSON
   # and XML serialization.
-  #
-  # @since 4.0.0
   module Serializable
     extend ActiveSupport::Concern
 
@@ -42,8 +39,6 @@ module Mongoid
     # @option options [ Symbol ] :methods What methods to include.
     #
     # @return [ Hash ] The document, ready to be serialized.
-    #
-    # @since 2.0.0.rc.6
     def serializable_hash(options = nil)
       options ||= {}
       attrs = {}
@@ -73,8 +68,6 @@ module Mongoid
     #   document.send(:field_names)
     #
     # @return [ Array<String> ] The names of the fields.
-    #
-    # @since 3.0.0
     def field_names(options)
       names = (as_attributes.keys + attribute_names).uniq.sort
 
@@ -104,8 +97,6 @@ module Mongoid
     # @param [ Hash ] options The options.
     #
     # @return [ Object ] The attribute.
-    #
-    # @since 3.0.0
     def serialize_attribute(attrs, name, names, options)
       if relations.key?(name)
         value = send(name)
@@ -129,8 +120,6 @@ module Mongoid
     # @option options [ Symbol ] :include What associations to include
     # @option options [ Symbol ] :only Limit the fields to only these.
     # @option options [ Symbol ] :except Dont include these fields.
-    #
-    # @since 2.0.0.rc.6
     def serialize_relations(attributes = {}, options = {})
       inclusions = options[:include]
       relation_names(inclusions).each do |name|
@@ -151,8 +140,6 @@ module Mongoid
     # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
     #
     # @return [ Array<Symbol> ] The names of the included associations.
-    #
-    # @since 2.0.0.rc.6
     def relation_names(inclusions)
       inclusions.is_a?(Hash) ? inclusions.keys : Array.wrap(inclusions)
     end
@@ -168,8 +155,6 @@ module Mongoid
     # @param [ Symbol ] name The name of the association.
     #
     # @return [ Hash ] The options for the association.
-    #
-    # @since 2.0.0.rc.6
     def relation_options(inclusions, options, name)
       if inclusions.is_a?(Hash)
         inclusions[name]

data/lib/mongoid/shardable.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # This module contains behavior for adding shard key fields to updates.
-  #
-  # @since 4.0.0
   module Shardable
     extend ActiveSupport::Concern
 
@@ -46,8 +43,6 @@ module Mongoid
     #   model.shard_key_fields
     #
     # @return [ Array<String> ] The shard key field names.
-    #
-    # @since 1.0.0
     def shard_key_fields
       self.class.shard_key_fields
     end
@@ -97,8 +92,6 @@ module Mongoid
       #
       #     shard_key first_name: 1, last_name: 1
       #   end
-      #
-      # @since 2.0.0
       def shard_key(*args)
         unless args.first.is_a?(Hash)
           # Shorthand syntax

data/lib/mongoid/stateful.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
@@ -39,8 +38,6 @@ module Mongoid
     #   document.flagged_for_destroy?
     #
     # @return [ true, false ] If the document is flagged.
-    #
-    # @since 2.3.2
     def flagged_for_destroy?
       @flagged_for_destroy ||= false
     end
@@ -78,8 +75,6 @@ module Mongoid
     #   document.readonly?
     #
     # @return [ true, false ] If the document is readonly.
-    #
-    # @since 4.0.0
     def readonly?
       __selected_fields != nil
     end
@@ -90,8 +85,6 @@ module Mongoid
     #   person.settable?
     #
     # @return [ true, false ] Is this document a new embeds one?
-    #
-    # @since 2.1.0
     def settable?
       new_record? && embedded_one? && _parent.persisted?
     end
@@ -102,8 +95,6 @@ module Mongoid
     #   person.updateable?
     #
     # @return [ true, false ] If the document is changed and persisted.
-    #
-    # @since 2.1.0
     def updateable?
       persisted? && changed?
     end

data/lib/mongoid/stringified_symbol.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 # A class which sends values to the database as Strings but returns them to the user as Symbols.
 module Mongoid
@@ -10,7 +9,7 @@ module Mongoid
       # Convert the object from its mongo friendly ruby type to this type.
       #
       # @example Demongoize the object.
-      #   Symbol.demongoize(object)
+      #   Mongoid::StringifiedSymbol.demongoize(object)
       #
       # @param [ Object ] object The object to demongoize.
       #
@@ -29,7 +28,7 @@ module Mongoid
       # type.
       #
       # @example Mongoize the object.
-      #   Symbol.mongoize("123.11")
+      #   Mongoid::StringifiedSymbol.mongoize("123.11")
       #
       # @param [ Object ] object The object to mongoize.
       #

data/lib/mongoid/tasks/database.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Tasks
@@ -13,8 +12,6 @@ module Mongoid
       #   Mongoid::Tasks::Database.create_indexes
       #
       # @return [ Array<Class> ] The indexed models.
-      #
-      # @since 2.1.0
       def create_indexes(models = ::Mongoid.models)
         models.each do |model|
           next if model.index_specifications.empty?
@@ -72,8 +69,6 @@ module Mongoid
       #   Mongoid::Tasks::Database.remove_undefined_indexes
       #
       # @return [ Hash{Class => Array(Hash)}] The list of indexes that were removed by model.
-      #
-      # @since 4.0.0
       def remove_undefined_indexes(models = ::Mongoid.models)
         undefined_indexes(models).each do |model, indexes|
           indexes.each do |index|

data/lib/mongoid/threaded/lifecycle.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Threaded
@@ -26,8 +25,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The yielded value.
-      #
-      # @since 2.2.0
       def _assigning
         Threaded.begin_execution(ASSIGN)
         yield
@@ -41,8 +38,6 @@ module Mongoid
       #   proxy._assigning?
       #
       # @return [ true, false ] If the thread is assigning.
-      #
-      # @since 2.1.0
       def _assigning?
         Threaded.executing?(ASSIGN)
       end
@@ -55,8 +50,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The return value of the block.
-      #
-      # @since 2.1.0
       def _binding
         Threaded.begin_execution(BIND)
         yield
@@ -70,8 +63,6 @@ module Mongoid
       #   proxy.binding?
       #
       # @return [ true, false ] If the thread is binding.
-      #
-      # @since 2.1.0
       def _binding?
         Threaded.executing?(BIND)
       end
@@ -84,8 +75,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The return value of the block.
-      #
-      # @since 2.1.0
       def _building
         Threaded.begin_execution(BUILD)
         yield
@@ -99,8 +88,6 @@ module Mongoid
       #   proxy._building?
       #
       # @return [ true, false ] If the thread is building.
-      #
-      # @since 2.1.0
       def _building?
         Threaded.executing?(BUILD)
       end
@@ -111,8 +98,6 @@ module Mongoid
       #   proxy.creating?
       #
       # @return [ true, false ] If the thread is creating.
-      #
-      # @since 2.1.0
       def _creating?
         Threaded.executing?(CREATE)
       end
@@ -125,8 +110,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The return value of the block.
-      #
-      # @since 2.3.2
       def _loading
         Threaded.begin_execution(LOAD)
         yield
@@ -140,8 +123,6 @@ module Mongoid
       #   proxy._loading?
       #
       # @return [ true, false ] If the thread is loading.
-      #
-      # @since 2.3.2
       def _loading?
         Threaded.executing?(LOAD)
       end
@@ -156,8 +137,6 @@ module Mongoid
         #   end
         #
         # @return [ Object ] The return value of the block.
-        #
-        # @since 2.1.0
         def _creating
           Threaded.begin_execution(CREATE)
           yield