mongoid_heroku_stable 4.0.0

data/lib/mongoid/state.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+module Mongoid
+
+  # This module contains the behaviour for getting the various states a
+  # document can transition through.
+  module State
+
+    attr_writer :destroyed, :flagged_for_destroy, :new_record
+
+    # Returns true if the +Document+ has not been persisted to the database,
+    # false if it has. This is determined by the variable @new_record
+    # and NOT if the object has an id.
+    #
+    # @example Is the document new?
+    #   person.new_record?
+    #
+    # @return [ true, false ] True if new, false if not.
+    def new_record?
+      @new_record ||= false
+    end
+
+    # Checks if the document has been saved to the database. Returns false
+    # if the document has been destroyed.
+    #
+    # @example Is the document persisted?
+    #   person.persisted?
+    #
+    # @return [ true, false ] True if persisted, false if not.
+    def persisted?
+      !new_record? && !destroyed?
+    end
+
+    # Returns whether or not the document has been flagged for deletion, but
+    # not destroyed yet. Used for atomic pulls of child documents.
+    #
+    # @example Is the document flagged?
+    #   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
+    alias :marked_for_destruction? :flagged_for_destroy?
+
+    # Returns true if the +Document+ has been succesfully destroyed, and false
+    # if it hasn't. This is determined by the variable @destroyed and NOT
+    # by checking the database.
+    #
+    # @example Is the document destroyed?
+    #   person.destroyed?
+    #
+    # @return [ true, false ] True if destroyed, false if not.
+    def destroyed?
+      @destroyed ||= false
+    end
+    alias :deleted? :destroyed?
+
+    # Determine if the document can be pushed.
+    #
+    # @example Is this pushable?
+    #   person.pushable?
+    #
+    # @return [ true, false ] Is the document new and embedded?
+    def pushable?
+      new_record? &&
+        embedded_many? &&
+        _parent.persisted? &&
+        !_parent.delayed_atomic_sets[atomic_path]
+    end
+
+    # Determine if the document can be set.
+    #
+    # @example Is this settable?
+    #   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
+
+    # Is the document updateable?
+    #
+    # @example Is the document updateable?
+    #   person.updateable?
+    #
+    # @return [ true, false ] If the document is changed and persisted.
+    #
+    # @since 2.1.0
+    def updateable?
+      persisted? && changed?
+    end
+  end
+end

data/lib/mongoid/threaded.rb

@@ -0,0 +1,383 @@
+# encoding: utf-8
+require "mongoid/threaded/lifecycle"
+
+module Mongoid
+
+  # This module contains logic for easy access to objects that have a lifecycle
+  # on the current thread.
+  module Threaded
+    extend self
+
+    # Begin entry into a named thread local stack.
+    #
+    # @example Begin entry into the stack.
+    #   Threaded.begin_execution(:create)
+    #
+    # @param [ String ] name The name of the stack
+    #
+    # @return [ true ] True.
+    #
+    # @since 2.4.0
+    def begin_execution(name)
+      stack(name).push(true)
+    end
+
+    # Get the global database override.
+    #
+    # @example Get the global database override.
+    #   Threaded.database_override
+    #
+    # @return [ String, Symbol ] The override.
+    #
+    # @since 3.0.0
+    def database_override
+      Thread.current["[mongoid]:db-override"]
+    end
+
+    # Set the global database override.
+    #
+    # @example Set the global database override.
+    #   Threaded.database_override = :testing
+    #
+    # @param [ String, Symbol ] The global override name.
+    #
+    # @return [ String, Symbol ] The override.
+    #
+    # @since 3.0.0
+    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"] ||= {}
+    end
+
+    # Are in the middle of executing the named stack
+    #
+    # @example Are we in the stack execution?
+    #   Threaded.executing?(:create)
+    #
+    # @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
+
+    # Exit from a named thread local stack.
+    #
+    # @example Exit from the stack.
+    #   Threaded.exit_execution(:create)
+    #
+    # @param [ Symbol ] name The name of the stack
+    #
+    # @return [ true ] True.
+    #
+    # @since 2.4.0
+    def exit_execution(name)
+      stack(name).pop
+    end
+
+    # Get the named stack.
+    #
+    # @example Get a stack by name
+    #   Threaded.stack(:create)
+    #
+    # @param [ Symbol ] name The name of the stack
+    #
+    # @return [ Array ] The stack.
+    #
+    # @since 2.4.0
+    def stack(name)
+      Thread.current["[mongoid]:#{name}-stack"] ||= []
+    end
+
+    # Begin autosaving a document on the current thread.
+    #
+    # @example Begin autosave.
+    #   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
+
+    # Begin validating a document on the current thread.
+    #
+    # @example Begin validation.
+    #   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
+
+    # Exit autosaving a document on the current thread.
+    #
+    # @example Exit autosave.
+    #   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
+
+    # Exit validating a document on the current thread.
+    #
+    # @example Exit validation.
+    #   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
+    end
+
+    # Get the field selection options from the current thread.
+    #
+    # @example Get the field selection options.
+    #   Threaded.selection
+    #
+    # @param [ Integer ] criteria_instance_id The criteria instance id.
+    #
+    # @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
+    end
+
+    # Set the field selection on the current thread.
+    #
+    # @example Set the field selection.
+    #   Threaded.set_selection(Person, { field: 1 })
+    #
+    # @param [ Integer ] criteria_instance_id The criteria instance id.
+    # @param [ Hash ] value The current field selection.
+    #
+    # @return [ Hash ] The field selection.
+    #
+    # @since 2.4.4
+    def set_selection(criteria_instance_id, value)
+      Thread.current["[mongoid][selections]"] ||= {}
+      Thread.current["[mongoid][selections]"][criteria_instance_id] = value
+    end
+
+    # Delete the field selection on the current thread.
+    #
+    # @example Delete the field selection.
+    #   Threaded.delete_selection(Person)
+    #
+    # @param [ Integer ] criteria_instance_id The criteria instance id.
+    #
+    # @return [ Boolean ] Whether there was a field selection.
+    #
+    # @since 3.0.7
+    def delete_selection(criteria_instance_id)
+      selections = Thread.current["[mongoid][selections]"]
+      return false unless selections
+      !!selections.delete(criteria_instance_id)
+    end
+
+    # Get the global session override.
+    #
+    # @example Get the global session override.
+    #   Threaded.session_override
+    #
+    # @return [ String, Symbol ] The override.
+    #
+    # @since 3.0.0
+    def session_override
+      Thread.current["[mongoid]:session-override"]
+    end
+
+    # Set the global session override.
+    #
+    # @example Set the global session override.
+    #   Threaded.session_override = :testing
+    #
+    # @param [ String, Symbol ] The global override name.
+    #
+    # @return [ String, Symbol ] The override.
+    #
+    # @since 3.0.0
+    def session_override=(name)
+      Thread.current["[mongoid]:session-override"] = name
+    end
+
+    # Get the mongoid scope stack for chained criteria.
+    #
+    # @example Get the scope stack.
+    #   Threaded.scope_stack
+    #
+    # @return [ Hash ] The scope stack.
+    #
+    # @since 2.1.0
+    def scope_stack
+      Thread.current["[mongoid]:scope-stack"] ||= {}
+    end
+
+    # Is the document autosaved on the current thread?
+    #
+    # @example Is the document autosaved?
+    #   Threaded.autosaved?(doc)
+    #
+    # @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
+
+    # Is the document validated on the current thread?
+    #
+    # @example Is the document validated?
+    #   Threaded.validated?(doc)
+    #
+    # @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
+
+    # Get all autosaves on the current thread.
+    #
+    # @example Get all autosaves.
+    #   Threaded.autosaves
+    #
+    # @return [ Hash ] The current autosaves.
+    #
+    # @since 3.0.0
+    def autosaves
+      Thread.current["[mongoid]:autosaves"] ||= {}
+    end
+
+    # Get all validations on the current thread.
+    #
+    # @example Get all validations.
+    #   Threaded.validations
+    #
+    # @return [ Hash ] The current validations.
+    #
+    # @since 2.1.9
+    def validations
+      Thread.current["[mongoid]:validations"] ||= {}
+    end
+
+    # Get all autosaves on the current thread for the class.
+    #
+    # @example Get all autosaves.
+    #   Threaded.autosaves_for(Person)
+    #
+    # @param [ Class ] The class to check.
+    #
+    # @return [ Array ] The current autosaves.
+    #
+    # @since 3.0.0
+    def autosaves_for(klass)
+      autosaves[klass] ||= []
+    end
+    # Get all validations on the current thread for the class.
+    #
+    # @example Get all validations.
+    #   Threaded.validations_for(Person)
+    #
+    # @param [ Class ] The class to check.
+    #
+    # @return [ Array ] The current validations.
+    #
+    # @since 2.1.9
+    def validations_for(klass)
+      validations[klass] ||= []
+    end
+  end
+end