mongoid 2.4.10 → 3.0.0

data/lib/mongoid/threaded.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require "mongoid/threaded/lifecycle"
 
-module Mongoid #:nodoc:
+module Mongoid
 
   # This module contains logic for easy access to objects that have a lifecycle
   # on the current thread.
@@ -13,7 +13,7 @@ module Mongoid #:nodoc:
     # @example Begin entry into the stack.
     #   Threaded.begin(:create)
     #
-    # @param [ Symbol ] name The name of the stack
+    # @param [ String ] name The name of the stack
     #
     # @return [ true ] True.
     #
@@ -22,6 +22,44 @@ module Mongoid #:nodoc:
       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?
@@ -61,7 +99,19 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.0
     def stack(name)
-      Thread.current[:"[mongoid]:#{name}-stack"] ||= []
+      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.
@@ -76,16 +126,19 @@ module Mongoid #:nodoc:
       validations_for(document.class).push(document.id)
     end
 
-    # Clear out all the safety options set using the safely proxy.
+    # Clear out all the persistence options.
     #
-    # @example Clear out the options.
-    #   Threaded.clear_safety_options!
+    # @example Clear out the persistence options.
+    #   Threaded.clear_persistence_options(Band)
     #
-    # @return [ nil ] nil
+    # @param [ Class ] klass The model class.
     #
-    # @since 2.1.0
-    def clear_safety_options!
-      Thread.current[:"[mongoid]:safety-options"] = nil
+    # @return [ true ] true.
+    #
+    # @since 2.0.0
+    def clear_persistence_options(klass)
+      Thread.current["[mongoid][#{klass}]:persistence-options"] = nil
+      true
     end
 
     # Clear out all options set on a one-time basis.
@@ -95,10 +148,21 @@ module Mongoid #:nodoc:
     #
     # @since 2.3.0
     def clear_options!
-      clear_safety_options!
       self.timeless = false
     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.
@@ -120,7 +184,61 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def identity_map
-      Thread.current[:"[mongoid]:identity-map"] ||= IdentityMap.new
+      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 insert consumer from the current thread.
@@ -132,7 +250,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def insert(name)
-      Thread.current[:"[mongoid][#{name}]:insert-consumer"]
+      Thread.current["[mongoid][#{name}]:insert-consumer"]
     end
 
     # Set the insert consumer on the current thread.
@@ -146,33 +264,36 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def set_insert(name, consumer)
-      Thread.current[:"[mongoid][#{name}]:insert-consumer"] = consumer
+      Thread.current["[mongoid][#{name}]:insert-consumer"] = consumer
     end
 
-    # Get the safety options for the current thread.
+    # Get the persistence options for the current thread.
+    #
+    # @example Get the persistence options.
+    #   Threaded.persistence_options(Band)
     #
-    # @example Get the safety options.
-    #   Threaded.safety_options
+    # @param [ Class ] klass The model class.
     #
-    # @return [ Hash ] The current safety options.
+    # @return [ Hash ] The current persistence options.
     #
     # @since 2.1.0
-    def safety_options
-      Thread.current[:"[mongoid]:safety-options"]
+    def persistence_options(klass)
+      Thread.current["[mongoid][#{klass}]:persistence-options"]
     end
 
-    # Set the safety options on the current thread.
+    # Set the persistence options on the current thread.
     #
-    # @example Set the safety options.
-    #   Threaded.safety_options = { :fsync => true }
+    # @example Set the persistence options.
+    #   Threaded.set_persistence_options(Band, { safe: { fsync: true }})
     #
-    # @param [ Hash ] options The safety options.
+    # @param [ Class ] klass The model class.
+    # @param [ Hash ] options The persistence options.
     #
-    # @return [ Hash ] The safety options.
+    # @return [ Hash ] The persistence options.
     #
     # @since 2.1.0
-    def safety_options=(options)
-      Thread.current[:"[mongoid]:safety-options"] = options
+    def set_persistence_options(klass, options)
+      Thread.current["[mongoid][#{klass}]:persistence-options"] = options
     end
 
     # Get the field selection options from the current thread.
@@ -184,7 +305,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.4
     def selection
-      Thread.current[:"[mongoid]:selection"]
+      Thread.current["[mongoid]:selection"]
     end
 
     # Set the field selection on the current thread.
@@ -198,7 +319,33 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.4
     def selection=(value)
-      Thread.current[:"[mongoid]:selection"] = value
+      Thread.current["[mongoid]:selection"] = value
+    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.
@@ -210,7 +357,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def scope_stack
-      Thread.current[:"[mongoid]:scope-stack"] ||= {}
+      Thread.current["[mongoid]:scope-stack"] ||= {}
     end
 
     # Get the value of the one-off timeless call.
@@ -222,7 +369,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.3.0
     def timeless
-      !!Thread.current[:"[mongoid]:timeless"]
+      !!Thread.current["[mongoid]:timeless"]
     end
 
     # Set the value of the one-off timeless call.
@@ -234,33 +381,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.3.0
     def timeless=(value)
-      Thread.current[:"[mongoid]:timeless"] = value
-    end
-
-    # Get the update consumer from the current thread.
-    #
-    # @example Get the update consumer.
-    #   Threaded.update
-    #
-    # @return [ Object ] The atomic update consumer.
-    #
-    # @since 2.1.0
-    def update_consumer(klass)
-      Thread.current[:"[mongoid][#{klass}]:update-consumer"]
-    end
-
-    # Set the update consumer on the current thread.
-    #
-    # @example Set the update consumer.
-    #   Threaded.update = consumer
-    #
-    # @param [ Object ] consumer The update consumer.
-    #
-    # @return [ Object ] The update consumer.
-    #
-    # @since 2.1.0
-    def set_update_consumer(klass, consumer)
-      Thread.current[:"[mongoid][#{klass}]:update-consumer"] = consumer
+      Thread.current["[mongoid]:timeless"] = value
     end
 
     # Is the current thread setting timestamps?
@@ -275,6 +396,20 @@ module Mongoid #:nodoc:
       !timeless
     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?
@@ -289,6 +424,18 @@ module Mongoid #:nodoc:
       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.
@@ -298,9 +445,22 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.9
     def validations
-      Thread.current[:"[mongoid]: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.

data/lib/mongoid/timestamps/created.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
   module Timestamps
     # This module handles the behaviour for setting up document created at
     # timestamp.
@@ -7,8 +7,8 @@ module Mongoid #:nodoc:
       extend ActiveSupport::Concern
 
       included do
-        field :created_at, :type => Time
-        set_callback :create, :before, :set_created_at, :if => :timestamping?
+        field :created_at, type: Time
+        set_callback :create, :before, :set_created_at, if: :timestamping?
       end
 
       # Update the created_at field on the Document to the current time. This is
@@ -17,7 +17,11 @@ module Mongoid #:nodoc:
       # @example Set the created at time.
       #   person.set_created_at
       def set_created_at
-        self.created_at = Time.now.utc if !created_at
+        if !created_at
+          time = Time.now.utc
+          self.updated_at = time if is_a?(Updated) && !updated_at_changed?
+          self.created_at = time
+        end
       end
     end
   end

data/lib/mongoid/timestamps/timeless.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
   module Timestamps
 
     # This module adds behaviour for turning off timestamping in single or
@@ -16,7 +16,8 @@ module Mongoid #:nodoc:
       #
       # @since 2.3.0
       def timeless
-        tap { Threaded.timeless = true }
+        Threaded.timeless = true
+        self
       end
 
       # Are we currently timestamping?
@@ -31,7 +32,7 @@ module Mongoid #:nodoc:
         Threaded.timestamping?
       end
 
-      module ClassMethods #:nodoc
+      module ClassMethods
 
         # Begin an execution that should skip timestamping.
         #
@@ -42,7 +43,8 @@ module Mongoid #:nodoc:
         #
         # @since 2.3.0
         def timeless
-          tap { Threaded.timeless = true }
+          Threaded.timeless = true
+          self
         end
       end
     end

data/lib/mongoid/timestamps/updated.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
   module Timestamps
     # This module handles the behaviour for setting up document updated at
     # timestamp.
@@ -7,8 +7,9 @@ module Mongoid #:nodoc:
       extend ActiveSupport::Concern
 
       included do
-        field :updated_at, :type => Time
-        set_callback :save, :before, :set_updated_at, :if => :able_to_set_updated_at?
+        field :updated_at, type: Time
+        set_callback :create, :before, :set_updated_at, if: :able_to_set_updated_at?
+        set_callback :update, :before, :set_updated_at, if: :able_to_set_updated_at?
       end
 
       # Update the updated_at field on the Document to the current time.

data/lib/mongoid/timestamps.rb

@@ -3,7 +3,7 @@ require "mongoid/timestamps/created"
 require "mongoid/timestamps/updated"
 require "mongoid/timestamps/timeless"
 
-module Mongoid #:nodoc:
+module Mongoid
 
   # This module handles the behaviour for setting up document created at and
   # updated at timestamps.

data/lib/mongoid/unit_of_work.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+module Mongoid
+
+  # This module handles unit of work functionality with regards to the identity
+  # map.
+  module UnitOfWork
+
+    # We can process a unit of work in Mongoid and have the identity map
+    # automatically clear itself out after the work is complete.
+    #
+    # @example Process a unit of work.
+    #   Mongoid.unit_of_work do
+    #     Person.create(title: "Sir")
+    #   end
+    #
+    # @example Process with identity map disabled on the current thread.
+    #   Mongoid.unit_of_work(disable: :current) do
+    #     Person.create(title: "Sir")
+    #   end
+    #
+    # @example Process with identity map disabled on all threads.
+    #   Mongoid.unit_of_work(disable: :all) do
+    #     Person.create(title: "Sir")
+    #   end
+    #
+    # @param [ Hash ] options The disabling options.
+    #
+    # @option [ Symbol ] :disable Either :all or :current to indicate whether
+    #   to temporarily disable the identity map on the current thread or all
+    #   threads.
+    #
+    # @return [ Object ] The result of the block.
+    #
+    # @since 2.1.0
+    def unit_of_work(options = {})
+      disable = options[:disable]
+      begin
+        Threaded.disable_identity_map(disable) if disable
+        yield if block_given?
+      ensure
+        if disable
+          Threaded.enable_identity_map(disable)
+        else
+          IdentityMap.clear
+        end
+      end
+    end
+
+    # Are we currently using the identity map?
+    #
+    # @example Is the identity map currently enabled?
+    #   Mongoid.using_identity_map?
+    #
+    # @return [ true, false ] If the identity map is in use.
+    #
+    # @since 3.0.0
+    def using_identity_map?
+      Mongoid.identity_map_enabled? && Threaded.identity_map_enabled?
+    end
+  end
+end

data/lib/mongoid/validations/associated.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Validations #:nodoc:
+module Mongoid
+  module Validations
 
     # Validates whether or not an association is valid or not. Will correctly
     # handle has one and has many associations.

data/lib/mongoid/validations/format.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Validations #:nodoc:
+module Mongoid
+  module Validations
 
     # Validates that the specified attributes do or do not match a certain
     # regular expression.

data/lib/mongoid/validations/presence.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Validations #:nodoc:
+module Mongoid
+  module Validations
 
     # Validates that the specified attributes are not blank (as defined by
     # Object#blank?).
@@ -28,13 +28,43 @@ module Mongoid #:nodoc:
       def validate_each(document, attribute, value)
         field = document.fields[attribute.to_s]
         if field.try(:localized?) && !value.blank?
-          value.each_pair do |locale, value|
-            document.errors.add(attribute, :blank_on_locale, options.merge(:location => locale)) if value.blank?
+          value.each_pair do |_locale, _value|
+            document.errors.add(
+              attribute,
+              :blank_in_locale,
+              options.merge(location: _locale)
+            ) if _value.blank?
+          end
+        elsif document.relations.has_key?(attribute.to_s)
+          if relation_or_fk_missing?(document, attribute, value)
+            document.errors.add(attribute, :blank, options)
           end
         else
           document.errors.add(attribute, :blank, options) if value.blank?
         end
       end
+
+      private
+
+      # Returns true if the relation is blank or the foreign key is blank.
+      #
+      # @api private
+      #
+      # @example Check is the relation or fk is blank.
+      #   validator.relation_or_fk_mising(doc, :name, "")
+      #
+      # @param [ Document ] doc The document.
+      # @param [ Symbol ] attr The attribute.
+      # @param [ Object ] value The value.
+      #
+      # @return [ true, false ] If the doc is missing.
+      #
+      # @since 3.0.0
+      def relation_or_fk_missing?(doc, attr, value)
+        return true if value.blank? && doc.send(attr).blank?
+        metadata = doc.relations[attr.to_s]
+        metadata.stores_foreign_key? && doc.send(metadata.foreign_key).blank?
+      end
     end
   end
 end