mongoid 3.1.5 → 8.0.2

data/lib/mongoid/threaded.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/threaded/lifecycle"
 
 module Mongoid
@@ -6,6 +7,25 @@ module Mongoid
   # This module contains logic for easy access to objects that have a lifecycle
   # on the current thread.
   module Threaded
+
+    DATABASE_OVERRIDE_KEY = "[mongoid]:db-override"
+
+    # Constant for the key to store clients.
+    CLIENTS_KEY = "[mongoid]:clients"
+
+    # The key to override the client.
+    CLIENT_OVERRIDE_KEY = "[mongoid]:client-override"
+
+    # The key for the current thread's scope stack.
+    CURRENT_SCOPE_KEY = "[mongoid]:current-scope"
+
+    AUTOSAVES_KEY = "[mongoid]:autosaves"
+    VALIDATIONS_KEY = "[mongoid]:validations"
+
+    STACK_KEYS = Hash.new do |hash, key|
+      hash[key] = "[mongoid]:#{key}-stack"
+    end
+
     extend self
 
     # Begin entry into a named thread local stack.
@@ -16,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
@@ -27,11 +45,9 @@ module Mongoid
     # @example Get the global database override.
     #   Threaded.database_override
     #
-    # @return [ String, Symbol ] The override.
-    #
-    # @since 3.0.0
+    # @return [ String | Symbol ] The override.
     def database_override
-      Thread.current["[mongoid]:db-override"]
+      Thread.current[DATABASE_OVERRIDE_KEY]
     end
 
     # Set the global database override.
@@ -39,25 +55,11 @@ module Mongoid
     # @example Set the global database override.
     #   Threaded.database_override = :testing
     #
-    # @param [ String, Symbol ] The global override name.
+    # @param [ String | Symbol ] name The global override name.
     #
-    # @return [ String, Symbol ] The override.
-    #
-    # @since 3.0.0
+    # @return [ String | Symbol ] The override.
     def database_override=(name)
-      Thread.current["[mongoid]:db-override"] = name
-    end
-
-    # Get the database sessions from the current thread.
-    #
-    # @example Get the database sessions.
-    #   Threaded.sessions
-    #
-    # @return [ Hash ] The sessions.
-    #
-    # @since 3.0.0
-    def sessions
-      Thread.current["[mongoid]:sessions"] ||= {}
+      Thread.current[DATABASE_OVERRIDE_KEY] = name
     end
 
     # Are in the middle of executing the named stack
@@ -68,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
@@ -82,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
@@ -96,10 +94,8 @@ module Mongoid
     # @param [ Symbol ] name The name of the stack
     #
     # @return [ Array ] The stack.
-    #
-    # @since 2.4.0
     def stack(name)
-      Thread.current["[mongoid]:#{name}-stack"] ||= []
+      Thread.current[STACK_KEYS[name]] ||= []
     end
 
     # Begin autosaving a document on the current thread.
@@ -108,10 +104,8 @@ 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)
+      autosaves_for(document.class).push(document._id)
     end
 
     # Begin validating a document on the current thread.
@@ -120,25 +114,8 @@ 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
-
-    # Clear out all the persistence options.
-    #
-    # @example Clear out the persistence options.
-    #   Threaded.clear_persistence_options(Band)
-    #
-    # @param [ Class ] klass The model class.
-    #
-    # @return [ true ] true.
-    #
-    # @since 2.0.0
-    def clear_persistence_options(klass)
-      Thread.current["[mongoid][#{klass}]:persistence-options"] = nil
-      true
+      validations_for(document.class).push(document._id)
     end
 
     # Exit autosaving a document on the current thread.
@@ -147,10 +124,8 @@ 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)
+      autosaves_for(document.class).delete_one(document._id)
     end
 
     # Exit validating a document on the current thread.
@@ -159,190 +134,118 @@ 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
-
-    # Get the identity map off the current thread.
-    #
-    # @example Get the identity map.
-    #   Threaded.identity_map
-    #
-    # @return [ IdentityMap ] The identity map.
-    #
-    # @since 2.1.0
-    def identity_map
-      Thread.current["[mongoid]:identity-map"] ||= IdentityMap.new
-    end
-
-    # Is the identity map enabled on the current thread?
-    #
-    # @example Is the identity map enabled?
-    #   Threaded.identity_map_enabled?
-    #
-    # @return [ true, false ] If the identity map is enabled.
-    #
-    # @since 3.0.0
-    def identity_map_enabled?
-      Thread.current["[mongoid]:identity-map-enabled"] != false
-    end
-
-    # Disable the identity map on either the current thread or all threads.
-    #
-    # @example Disable the identity map on all threads.
-    #   Threaded.disable_identity_map(:all)
-    #
-    # @example Disable the identity map on the current thread.
-    #   Threaded.disable_identity_map(:current)
-    #
-    # @param [ Symbol ] option The disabling option.
-    #
-    # @since 3.0.0
-    def disable_identity_map(option)
-      if option == :all
-        Thread.list.each do |thread|
-          thread["[mongoid]:identity-map-enabled"] = false
-        end
-      else
-        Thread.current["[mongoid]:identity-map-enabled"] = false
-      end
-    end
-
-    # Enable the identity map on either the current thread or all threads.
-    #
-    # @example Enable the identity map on all threads.
-    #   Threaded.enable_identity_map(:all)
-    #
-    # @example Enable the identity map on the current thread.
-    #   Threaded.enable_identity_map(:current)
-    #
-    # @param [ Symbol ] option The disabling option.
-    #
-    # @since 3.0.0
-    def enable_identity_map(option)
-      if option == :all
-        Thread.list.each do |thread|
-          thread["[mongoid]:identity-map-enabled"] = true
-        end
-      else
-        Thread.current["[mongoid]:identity-map-enabled"] = true
-      end
+      validations_for(document.class).delete_one(document._id)
     end
 
-    # Get the persistence options for the current thread.
+    # Begin suppressing default scopes for given model on the current thread.
     #
-    # @example Get the persistence options.
-    #   Threaded.persistence_options(Band)
+    # @example Begin without default scope stack.
+    #   Threaded.begin_without_default_scope(klass)
     #
-    # @param [ Class ] klass The model class.
+    # @param [ Class ] klass The model to suppress default scoping on.
     #
-    # @return [ Hash ] The current persistence options.
-    #
-    # @since 2.1.0
-    def persistence_options(klass)
-      Thread.current["[mongoid][#{klass}]:persistence-options"]
+    # @api private
+    def begin_without_default_scope(klass)
+      stack(:without_default_scope).push(klass)
     end
 
-    # Set the persistence options on the current thread.
-    #
-    # @example Set the persistence options.
-    #   Threaded.set_persistence_options(Band, { safe: { fsync: true }})
+    # Exit suppressing default scopes for given model on the current thread.
     #
-    # @param [ Class ] klass The model class.
-    # @param [ Hash ] options The persistence options.
+    # @example Exit without default scope stack.
+    #   Threaded.exit_without_default_scope(klass)
     #
-    # @return [ Hash ] The persistence options.
+    # @param [ Class ] klass The model to unsuppress default scoping on.
     #
-    # @since 2.1.0
-    def set_persistence_options(klass, options)
-      Thread.current["[mongoid][#{klass}]:persistence-options"] = options
+    # @api private
+    def exit_without_default_scope(klass)
+      stack(:without_default_scope).delete(klass)
     end
 
-    # Get the field selection options from the current thread.
-    #
-    # @example Get the field selection options.
-    #   Threaded.selection
+    # Get the global client override.
     #
-    # @param [ Integer ] criteria_instance_id The criteria instance id.
+    # @example Get the global client override.
+    #   Threaded.client_override
     #
-    # @return [ Hash ] The field selection.
-    #
-    # @since 2.4.4
-    def selection(criteria_instance_id)
-      selections = Thread.current["[mongoid][selections]"]
-      selections[criteria_instance_id] if selections
+    # @return [ String | Symbol ] The override.
+    def client_override
+      Thread.current[CLIENT_OVERRIDE_KEY]
     end
 
-    # Set the field selection on the current thread.
-    #
-    # @example Set the field selection.
-    #   Threaded.set_selection(Person, { field: 1 })
+    # Set the global client override.
     #
-    # @param [ Integer ] criteria_instance_id The criteria instance id.
-    # @param [ Hash ] value The current field selection.
+    # @example Set the global client override.
+    #   Threaded.client_override = :testing
     #
-    # @return [ Hash ] The field selection.
+    # @param [ String | Symbol ] name The global override name.
     #
-    # @since 2.4.4
-    def set_selection(criteria_instance_id, value)
-      Thread.current["[mongoid][selections]"] ||= {}
-      Thread.current["[mongoid][selections]"][criteria_instance_id] = value
+    # @return [ String | Symbol ] The override.
+    def client_override=(name)
+      Thread.current[CLIENT_OVERRIDE_KEY] = name
     end
 
-    # Delete the field selection on the current thread.
-    #
-    # @example Delete the field selection.
-    #   Threaded.delete_selection(Person)
+    # Get the current Mongoid scope.
     #
-    # @param [ Integer ] criteria_instance_id The criteria instance id.
+    # @example Get the scope.
+    #   Threaded.current_scope(klass)
+    #   Threaded.current_scope
     #
-    # @return [ Boolean ] Whether there was a field selection.
+    # @param [ Klass ] klass The class type of the scope.
     #
-    # @since 3.0.7
-    def delete_selection(criteria_instance_id)
-      selections = Thread.current["[mongoid][selections]"]
-      return false unless selections
-      !!selections.delete(criteria_instance_id)
+    # @return [ Criteria ] The scope.
+    def current_scope(klass = nil)
+      if klass && Thread.current[CURRENT_SCOPE_KEY].respond_to?(:keys)
+        Thread.current[CURRENT_SCOPE_KEY][
+            Thread.current[CURRENT_SCOPE_KEY].keys.find { |k| k <= klass }
+        ]
+      else
+        Thread.current[CURRENT_SCOPE_KEY]
+      end
     end
 
-    # Get the global session override.
+    # Set the current Mongoid scope.
     #
-    # @example Get the global session override.
-    #   Threaded.session_override
+    # @example Set the scope.
+    #   Threaded.current_scope = scope
     #
-    # @return [ String, Symbol ] The override.
+    # @param [ Criteria ] scope The current scope.
     #
-    # @since 3.0.0
-    def session_override
-      Thread.current["[mongoid]:session-override"]
+    # @return [ Criteria ] The scope.
+    def current_scope=(scope)
+      Thread.current[CURRENT_SCOPE_KEY] = scope
     end
 
-    # Set the global session override.
+    # Set the current Mongoid scope. Safe for multi-model scope chaining.
     #
-    # @example Set the global session override.
-    #   Threaded.session_override = :testing
+    # @example Set the scope.
+    #   Threaded.current_scope(scope, klass)
     #
-    # @param [ String, Symbol ] The global override name.
+    # @param [ Criteria ] scope The current scope.
+    # @param [ Class ] klass The current model class.
     #
-    # @return [ String, Symbol ] The override.
-    #
-    # @since 3.0.0
-    def session_override=(name)
-      Thread.current["[mongoid]:session-override"] = name
+    # @return [ Criteria ] The scope.
+    def set_current_scope(scope, klass)
+      if scope.nil?
+        if Thread.current[CURRENT_SCOPE_KEY]
+          Thread.current[CURRENT_SCOPE_KEY].delete(klass)
+          Thread.current[CURRENT_SCOPE_KEY] = nil if Thread.current[CURRENT_SCOPE_KEY].empty?
+        end
+      else
+        Thread.current[CURRENT_SCOPE_KEY] ||= {}
+        Thread.current[CURRENT_SCOPE_KEY][klass] = scope
+      end
     end
 
-    # Get the mongoid scope stack for chained criteria.
+    # Is the given klass' default scope suppressed on the current thread?
     #
-    # @example Get the scope stack.
-    #   Threaded.scope_stack
+    # @example Is the given klass' default scope suppressed?
+    #   Threaded.without_default_scope?(klass)
     #
-    # @return [ Hash ] The scope stack.
+    # @param [ Class ] klass The model to check for default scope suppression.
     #
-    # @since 2.1.0
-    def scope_stack
-      Thread.current["[mongoid]:scope-stack"] ||= {}
+    # @api private
+    def without_default_scope?(klass)
+      stack(:without_default_scope).include?(klass)
     end
 
     # Is the document autosaved on the current thread?
@@ -352,11 +255,9 @@ module Mongoid
     #
     # @param [ Document ] document The document to check.
     #
-    # @return [ true, false ] If the document is autosaved.
-    #
-    # @since 2.1.9
+    # @return [ true | false ] If the document is autosaved.
     def autosaved?(document)
-      autosaves_for(document.class).include?(document.id)
+      autosaves_for(document.class).include?(document._id)
     end
 
     # Is the document validated on the current thread?
@@ -366,11 +267,9 @@ module Mongoid
     #
     # @param [ Document ] document The document to check.
     #
-    # @return [ true, false ] If the document is validated.
-    #
-    # @since 2.1.9
+    # @return [ true | false ] If the document is validated.
     def validated?(document)
-      validations_for(document.class).include?(document.id)
+      validations_for(document.class).include?(document._id)
     end
 
     # Get all autosaves on the current thread.
@@ -379,10 +278,8 @@ module Mongoid
     #   Threaded.autosaves
     #
     # @return [ Hash ] The current autosaves.
-    #
-    # @since 3.0.0
     def autosaves
-      Thread.current["[mongoid]:autosaves"] ||= {}
+      Thread.current[AUTOSAVES_KEY] ||= {}
     end
 
     # Get all validations on the current thread.
@@ -391,10 +288,8 @@ module Mongoid
     #   Threaded.validations
     #
     # @return [ Hash ] The current validations.
-    #
-    # @since 2.1.9
     def validations
-      Thread.current["[mongoid]:validations"] ||= {}
+      Thread.current[VALIDATIONS_KEY] ||= {}
     end
 
     # Get all autosaves on the current thread for the class.
@@ -402,11 +297,9 @@ module Mongoid
     # @example Get all autosaves.
     #   Threaded.autosaves_for(Person)
     #
-    # @param [ Class ] The class to check.
+    # @param [ Class ] klass The class to check.
     #
     # @return [ Array ] The current autosaves.
-    #
-    # @since 3.0.0
     def autosaves_for(klass)
       autosaves[klass] ||= []
     end
@@ -415,13 +308,43 @@ module Mongoid
     # @example Get all validations.
     #   Threaded.validations_for(Person)
     #
-    # @param [ Class ] The class to check.
+    # @param [ Class ] klass The class to check.
     #
     # @return [ Array ] The current validations.
-    #
-    # @since 2.1.9
     def validations_for(klass)
       validations[klass] ||= []
     end
+
+    # Cache a session for this thread.
+    #
+    # @example Save a session for this thread.
+    #   Threaded.set_session(session)
+    #
+    # @param [ Mongo::Session ] session The session to save.
+    def set_session(session)
+      Thread.current[:session] = session
+    end
+
+    # Get the cached session for this thread.
+    #
+    # @example Get the session for this thread.
+    #   Threaded.get_session
+    #
+    # @return [ Mongo::Session | nil ] The session cached on this thread or nil.
+    def get_session
+      Thread.current[:session]
+    end
+
+    # Clear the cached session for this thread.
+    #
+    # @example Clear this thread's session.
+    #   Threaded.clear_session
+    #
+    # @return [ nil ]
+    def clear_session
+      session = get_session
+      session.end_session if session
+      Thread.current[:session] = nil
+    end
   end
 end

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

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

data/lib/mongoid/timestamps/created.rb

@@ -1,16 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/timestamps/created/short"
 
 module Mongoid
   module Timestamps
-    # This module handles the behaviour for setting up document created at
+    # This module handles the behavior for setting up document created at
     # timestamp.
     module Created
       extend ActiveSupport::Concern
 
       included do
+        include Mongoid::Timestamps::Timeless
+
         field :created_at, type: Time
-        set_callback :create, :before, :set_created_at, if: :timestamping?
+        set_callback :create, :before, :set_created_at
       end
 
       # Update the created_at field on the Document to the current time. This is
@@ -19,11 +22,12 @@ module Mongoid
       # @example Set the created at time.
       #   person.set_created_at
       def set_created_at
-        if !created_at
-          time = Time.now.utc
+        if !timeless? && !created_at
+          time = Time.configured.now
           self.updated_at = time if is_a?(Updated) && !updated_at_changed?
           self.created_at = time
         end
+        clear_timeless_option
       end
     end
   end

data/lib/mongoid/timestamps/short.rb

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

data/lib/mongoid/timestamps/timeless.rb

@@ -1,27 +1,26 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Timestamps
 
-    # This module adds behaviour for turning off timestamping in single or
+    # This module adds behavior for turning off timestamping in single or
     # multiple calls.
     module Timeless
       extend ActiveSupport::Concern
 
-      included do
-        class_attribute :timestamping
-        self.timestamping = true
-      end
-
       # Clears out the timeless option.
       #
       # @example Clear the timeless option.
       #   document.clear_timeless_option
       #
       # @return [ true ] True.
-      #
-      # @since 3.1.4
       def clear_timeless_option
-        self.class.timestamping = true
+        if self.persisted?
+          self.class.clear_timeless_option_on_update
+        else
+          self.class.clear_timeless_option
+        end
+        true
       end
 
       # Begin an execution that should skip timestamping.
@@ -30,13 +29,25 @@ module Mongoid
       #   person.timeless.save
       #
       # @return [ Document ] The document this was called on.
-      #
-      # @since 2.3.0
       def timeless
-        self.class.timestamping = false
+        self.class.timeless
         self
       end
 
+      def timeless?
+        self.class.timeless?
+      end
+
+      class << self
+        extend Forwardable
+
+        def timeless_table
+          Thread.current['[mongoid]:timeless'] ||= Hash.new
+        end
+
+        def_delegators :timeless_table, :[]=, :[]
+      end
+
       private
 
       module ClassMethods
@@ -47,12 +58,37 @@ module Mongoid
         #   Person.timeless.create(:title => "Sir")
         #
         # @return [ Class ] The class this was called on.
-        #
-        # @since 2.3.0
         def timeless
-          self.timestamping = false
+          counter = 0
+          counter += 1 if self < Mongoid::Timestamps::Created
+          counter += 1 if self < Mongoid::Timestamps::Updated
+          Timeless[name] = counter
           self
         end
+
+        def clear_timeless_option
+          if counter = Timeless[name]
+            counter -= 1
+            set_timeless_counter(counter)
+          end
+          true
+        end
+
+        def clear_timeless_option_on_update
+          if counter = Timeless[name]
+            counter -= 1 if self < Mongoid::Timestamps::Created
+            counter -= 1 if self < Mongoid::Timestamps::Updated
+            set_timeless_counter(counter)
+          end
+        end
+
+        def set_timeless_counter(counter)
+          Timeless[name] = (counter == 0) ? nil : counter
+        end
+
+        def timeless?
+          !!Timeless[name]
+        end
       end
     end
   end