mongoid 7.3.5 → 7.5.0

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

data/lib/mongoid/threaded.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/threaded/lifecycle"
 
@@ -12,18 +11,12 @@ module Mongoid
     DATABASE_OVERRIDE_KEY = "[mongoid]:db-override"
 
     # Constant for the key to store clients.
-    #
-    # @since 5.0.0
     CLIENTS_KEY = "[mongoid]:clients"
 
     # The key to override the client.
-    #
-    # @since 5.0.0
     CLIENT_OVERRIDE_KEY = "[mongoid]:client-override"
 
     # The key for the current thread's scope stack.
-    #
-    # @since 2.0.0
     CURRENT_SCOPE_KEY = "[mongoid]:current-scope"
 
     AUTOSAVES_KEY = "[mongoid]:autosaves"
@@ -43,8 +36,6 @@ module Mongoid
     # @param [ String ] name The name of the stack
     #
     # @return [ true ] True.
-    #
-    # @since 2.4.0
     def begin_execution(name)
       stack(name).push(true)
     end
@@ -55,8 +46,6 @@ module Mongoid
     #   Threaded.database_override
     #
     # @return [ String, Symbol ] The override.
-    #
-    # @since 3.0.0
     def database_override
       Thread.current[DATABASE_OVERRIDE_KEY]
     end
@@ -69,8 +58,6 @@ module Mongoid
     # @param [ String, Symbol ] name The global override name.
     #
     # @return [ String, Symbol ] The override.
-    #
-    # @since 3.0.0
     def database_override=(name)
       Thread.current[DATABASE_OVERRIDE_KEY] = name
     end
@@ -83,8 +70,6 @@ module Mongoid
     # @param [ Symbol ] name The name of the stack
     #
     # @return [ true ] If the stack is being executed.
-    #
-    # @since 2.4.0
     def executing?(name)
       !stack(name).empty?
     end
@@ -97,8 +82,6 @@ module Mongoid
     # @param [ Symbol ] name The name of the stack
     #
     # @return [ true ] True.
-    #
-    # @since 2.4.0
     def exit_execution(name)
       stack(name).pop
     end
@@ -111,8 +94,6 @@ module Mongoid
     # @param [ Symbol ] name The name of the stack
     #
     # @return [ Array ] The stack.
-    #
-    # @since 2.4.0
     def stack(name)
       Thread.current[STACK_KEYS[name]] ||= []
     end
@@ -123,8 +104,6 @@ module Mongoid
     #   Threaded.begin_autosave(doc)
     #
     # @param [ Document ] document The document to autosave.
-    #
-    # @since 3.0.0
     def begin_autosave(document)
       autosaves_for(document.class).push(document._id)
     end
@@ -135,8 +114,6 @@ module Mongoid
     #   Threaded.begin_validate(doc)
     #
     # @param [ Document ] document The document to validate.
-    #
-    # @since 2.1.9
     def begin_validate(document)
       validations_for(document.class).push(document._id)
     end
@@ -147,8 +124,6 @@ module Mongoid
     #   Threaded.exit_autosave(doc)
     #
     # @param [ Document ] document The document to autosave.
-    #
-    # @since 3.0.0
     def exit_autosave(document)
       autosaves_for(document.class).delete_one(document._id)
     end
@@ -159,8 +134,6 @@ module Mongoid
     #   Threaded.exit_validate(doc)
     #
     # @param [ Document ] document The document to validate.
-    #
-    # @since 2.1.9
     def exit_validate(document)
       validations_for(document.class).delete_one(document._id)
     end
@@ -195,8 +168,6 @@ module Mongoid
     #   Threaded.client_override
     #
     # @return [ String, Symbol ] The override.
-    #
-    # @since 5.0.0
     def client_override
       Thread.current[CLIENT_OVERRIDE_KEY]
     end
@@ -209,8 +180,6 @@ module Mongoid
     # @param [ String, Symbol ] name The global override name.
     #
     # @return [ String, Symbol ] The override.
-    #
-    # @since 3.0.0
     def client_override=(name)
       Thread.current[CLIENT_OVERRIDE_KEY] = name
     end
@@ -224,8 +193,6 @@ module Mongoid
     # @param [ Klass ] klass The class type of the scope.
     #
     # @return [ Criteria ] The scope.
-    #
-    # @since 5.0.0
     def current_scope(klass = nil)
       if klass && Thread.current[CURRENT_SCOPE_KEY].respond_to?(:keys)
         Thread.current[CURRENT_SCOPE_KEY][
@@ -244,8 +211,6 @@ module Mongoid
     # @param [ Criteria ] scope The current scope.
     #
     # @return [ Criteria ] The scope.
-    #
-    # @since 5.0.0
     def current_scope=(scope)
       Thread.current[CURRENT_SCOPE_KEY] = scope
     end
@@ -259,8 +224,6 @@ module Mongoid
     # @param [ Class ] klass The current model class.
     #
     # @return [ Criteria ] The scope.
-    #
-    # @since 5.0.1
     def set_current_scope(scope, klass)
       if scope.nil?
         if Thread.current[CURRENT_SCOPE_KEY]
@@ -293,8 +256,6 @@ module Mongoid
     # @param [ Document ] document The document to check.
     #
     # @return [ true, false ] If the document is autosaved.
-    #
-    # @since 2.1.9
     def autosaved?(document)
       autosaves_for(document.class).include?(document._id)
     end
@@ -307,8 +268,6 @@ module Mongoid
     # @param [ Document ] document The document to check.
     #
     # @return [ true, false ] If the document is validated.
-    #
-    # @since 2.1.9
     def validated?(document)
       validations_for(document.class).include?(document._id)
     end
@@ -319,8 +278,6 @@ module Mongoid
     #   Threaded.autosaves
     #
     # @return [ Hash ] The current autosaves.
-    #
-    # @since 3.0.0
     def autosaves
       Thread.current[AUTOSAVES_KEY] ||= {}
     end
@@ -331,8 +288,6 @@ module Mongoid
     #   Threaded.validations
     #
     # @return [ Hash ] The current validations.
-    #
-    # @since 2.1.9
     def validations
       Thread.current[VALIDATIONS_KEY] ||= {}
     end
@@ -345,8 +300,6 @@ module Mongoid
     # @param [ Class ] klass The class to check.
     #
     # @return [ Array ] The current autosaves.
-    #
-    # @since 3.0.0
     def autosaves_for(klass)
       autosaves[klass] ||= []
     end
@@ -358,8 +311,6 @@ module Mongoid
     # @param [ Class ] klass The class to check.
     #
     # @return [ Array ] The current validations.
-    #
-    # @since 2.1.9
     def validations_for(klass)
       validations[klass] ||= []
     end
@@ -370,8 +321,6 @@ module Mongoid
     #   Threaded.set_session(session)
     #
     # @param [ Mongo::Session ] session The session to save.
-    #
-    # @since 6.4.0
     def set_session(session)
       Thread.current[:session] = session
     end
@@ -382,8 +331,6 @@ module Mongoid
     #   Threaded.get_session
     #
     # @return [ Mongo::Session, nil ] The session cached on this thread or nil.
-    #
-    # @since 6.4.0
     def get_session
       Thread.current[:session]
     end
@@ -394,8 +341,6 @@ module Mongoid
     #   Threaded.clear_session
     #
     # @return [ nil ]
-    #
-    # @since 6.4.0
     def clear_session
       session = get_session
       session.end_session if session

data/lib/mongoid/timestamps/created/short.rb

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

data/lib/mongoid/timestamps/created.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/timestamps/created/short"