mongoid 3.1.6 → 4.0.2

data/lib/mongoid/relations/touchable.rb

@@ -4,6 +4,39 @@ module Mongoid
     module Touchable
       extend ActiveSupport::Concern
 
+      # Touch the document, in effect updating its updated_at timestamp and
+      # optionally the provided field to the current time. If any belongs_to
+      # relations exist with a touch option, they will be updated as well.
+      #
+      # @example Update the updated_at timestamp.
+      #   document.touch
+      #
+      # @example Update the updated_at and provided timestamps.
+      #   document.touch(:audited)
+      #
+      # @note This will not autobuild relations if those options are set.
+      #
+      # @param [ Symbol ] field The name of an additional field to update.
+      #
+      # @return [ true/false ] false if record is new_record otherwise true.
+      #
+      # @since 3.0.0
+      def touch(field = nil)
+        return false if _root.new_record?
+        current = Time.now
+        field = database_field_name(field)
+        write_attribute(:updated_at, current) if respond_to?("updated_at=")
+        write_attribute(field, current) if field
+
+        touches = touch_atomic_updates(field)
+        unless touches.empty?
+          selector = atomic_selector
+          _root.collection.where(selector).update(positionally(selector, touches))
+        end
+        run_callbacks(:touch)
+        true
+      end
+
       module ClassMethods
 
         # Add the metadata to the touchable relations if the touch option was
@@ -21,7 +54,7 @@ module Mongoid
           if metadata.touchable?
             name = metadata.name
             method_name = define_relation_touch_method(name)
-            after_create method_name
+            after_save method_name
             after_destroy method_name
             after_touch method_name
           end

data/lib/mongoid/{reloading.rb → reloadable.rb}

@@ -1,7 +1,10 @@
 # encoding: utf-8
 module Mongoid
+
   # This module handles reloading behaviour of documents.
-  module Reloading
+  #
+  # @since 4.0.0
+  module Reloadable
 
     # Reloads the +Document+ attributes from the database. If the document has
     # not been saved then an error will get raised if the configuration option
@@ -18,14 +21,13 @@ module Mongoid
     def reload
       reloaded = _reload
       if Mongoid.raise_not_found_error && reloaded.empty?
-        raise Errors::DocumentNotFound.new(self.class, id, id)
+        raise Errors::DocumentNotFound.new(self.class, _id, _id)
       end
       @attributes = reloaded
       @attributes_before_type_cast = {}
       changed_attributes.clear
       apply_defaults
       reload_relations
-      IdentityMap.set(self)
       run_callbacks(:find) unless _find_callbacks.empty?
       run_callbacks(:initialize) unless _initialize_callbacks.empty?
       self
@@ -55,7 +57,7 @@ module Mongoid
     #
     # @since 2.3.2
     def reload_root_document
-      {}.merge(with(consistency: :strong).collection.find(_id: id).one || {})
+      {}.merge(with(read: :primary).collection.find(_id: _id).one || {})
     end
 
     # Reload the embedded document.
@@ -68,7 +70,7 @@ module Mongoid
     # @since 2.3.2
     def reload_embedded_document
       extract_embedded_attributes({}.merge(
-        _root.with(consistency: :strong).collection.find(_id: _root.id).one
+        _root.with(read: :primary).collection.find(_id: _root._id).one
       ))
     end
 

data/lib/mongoid/{scoping.rb → scopable.rb}

@@ -1,9 +1,12 @@
 # encoding: utf-8
+
 module Mongoid
 
   # This module contains behaviour for all Mongoid scoping - named scopes,
   # default scopes, and criteria accessors via scoped and unscoped.
-  module Scoping
+  #
+  # @since 4.0.0
+  module Scopable
     extend ActiveSupport::Concern
 
     included do
@@ -12,6 +15,27 @@ module Mongoid
       self._declared_scopes = {}
     end
 
+    private
+
+    # Apply the default scoping to the attributes of the document, as long as
+    # they are not complex queries.
+    #
+    # @api private
+    #
+    # @example Apply the default scoping.
+    #   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|
+          attributes[field] = value unless value.respond_to?(:each_pair)
+        end
+      end
+    end
+
     module ClassMethods
 
       # Returns a hash of all the scopes defined for this class, including
@@ -22,7 +46,7 @@ module Mongoid
       #     include Mongoid::Document
       #     field :active, type: Boolean
       #
-      #     scope :active, where(active: true)
+      #     scope :active, -> { where(active: true) }
       #   end
       #   Band.scopes
       #
@@ -104,14 +128,14 @@ module Mongoid
       #     field :active, type: Boolean
       #     field :count, type: Integer
       #
-      #     scope :active, where(active: true)
+      #     scope :active, -> { where(active: true) }
       #     scope :at_least, ->(count){ where(:count.gt => count) }
       #   end
       #
       # @param [ Symbol ] name The name of the scope.
-      # @param [ Proc, Criteria ] conditions The conditions of the scope.
+      # @param [ Proc ] conditions The conditions of the scope.
       #
-      # @raise [ Errors::InvalidScope ] If the scope is not a proc or criteria.
+      # @raise [ Errors::InvalidScope ] If the scope is not a proc.
       # @raise [ Errors::ScopeOverwrite ] If the scope name already exists.
       #
       # @since 1.0.0
@@ -120,7 +144,7 @@ module Mongoid
         check_scope_validity(value)
         check_scope_name(normalized)
         _declared_scopes[normalized] = {
-          scope: strip_default_scope(value),
+          scope: value,
           extension: Module.new(&block)
         }
         define_scope_method(normalized)
@@ -279,7 +303,7 @@ module Mongoid
       #
       # @since 3.0.0
       def check_scope_validity(value)
-        unless value.respond_to?(:to_proc)
+        unless value.respond_to?(:call)
           raise Errors::InvalidScope.new(self, value)
         end
       end
@@ -298,15 +322,15 @@ module Mongoid
       #
       # @since 3.0.0
       def define_scope_method(name)
-        (class << self; self; end).class_eval <<-SCOPE, __FILE__, __LINE__ + 1
-          def #{name}(*args)
-            scoping = _declared_scopes[:#{name}]
+        singleton_class.class_eval do
+          define_method name do |*args|
+            scoping = _declared_scopes[name]
             scope, extension = scoping[:scope][*args], scoping[:extension]
-            criteria = with_default_scope.merge(scope || all)
+            criteria = with_default_scope.merge(scope || queryable)
             criteria.extend(extension)
             criteria
           end
-        SCOPE
+        end
       end
 
       # Process the default scope value. If one already exists, we merge the
@@ -327,30 +351,6 @@ module Mongoid
           value.to_proc
         end
       end
-
-      # Strip the default scope from the provided value, if it is a criteria.
-      # This is used by named scopes - they should not have the default scoping
-      # applied to them.
-      #
-      # @api private
-      #
-      # @example Strip the default scope.
-      #   Model.strip_default_scope
-      #
-      # @param [ Proc, Criteria ] value The value to strip from.
-      #
-      # @return [ Proc ] The stripped criteria, as a proc.
-      #
-      # @since 3.0.0
-      def strip_default_scope(value)
-        if value.is_a?(Criteria)
-          default = default_scoping.try(:call)
-          value.remove_scoping(default)
-          value.to_proc
-        else
-          value
-        end
-      end
     end
   end
 end

data/lib/mongoid/selectable.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+module Mongoid
+
+  # Provides behaviour for generating the selector for a specific document.
+  #
+  # @since 4.0.0
+  module Selectable
+    extend ActiveSupport::Concern
+
+    # Get the atomic selector for the document. This is a hash in the simplest
+    # case { "_id" => id }, but can become more complex for embedded documents
+    # and documents that use a shard key.
+    #
+    # @example Get the document's atomic selector.
+    #   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)
+    end
+
+    private
+
+    # Get the atomic selector for an embedded document.
+    #
+    # @api private
+    #
+    # @example Get the embedded atomic selector.
+    #   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
+      else
+        _parent.atomic_selector.merge("#{atomic_path}._id" => _id)
+      end
+    end
+
+    # Get the atomic selector for a root document.
+    #
+    # @api private
+    #
+    # @example Get the root atomic selector.
+    #   document.root_atomic_selector
+    #
+    # @return [ Hash ] The root document selector.
+    #
+    # @since 4.0.0
+    def root_atomic_selector
+      { "_id" => _id }.merge!(shard_key_selector)
+    end
+  end
+end

data/lib/mongoid/{serialization.rb → serializable.rb}

@@ -3,9 +3,18 @@ module Mongoid
 
   # This module provides the extra behaviour for including relations in JSON
   # and XML serialization.
-  module Serialization
+  #
+  # @since 4.0.0
+  module Serializable
     extend ActiveSupport::Concern
 
+    # We need to redefine where the JSON configuration is getting defined,
+    # similar to +ActiveRecord+.
+    included do
+      undef_method :include_root_in_json
+      delegate :include_root_in_json, to: ::Mongoid
+    end
+
     # Gets the document as a serializable hash, used by ActiveModel's JSON
     # serializer.
     #
@@ -93,7 +102,7 @@ module Mongoid
         attrs[name] = value ? value.serializable_hash(options) : nil
       elsif names.include?(name) && !fields.has_key?(name)
         attrs[name] = read_attribute(name)
-      else
+      elsif !attribute_missing?(name)
         attrs[name] = send(name)
       end
     end

data/lib/mongoid/sessions.rb

@@ -1,90 +1,18 @@
 # encoding: utf-8
 require "mongoid/sessions/factory"
 require "mongoid/sessions/validators"
+require "mongoid/sessions/storage_options"
+require "mongoid/sessions/thread_options"
+require "mongoid/sessions/options"
 
 module Mongoid
   module Sessions
     extend ActiveSupport::Concern
-
-    included do
-      cattr_accessor :default_collection_name, :storage_options
-      self.default_collection_name = self.name.collectionize.to_sym
-    end
-
-    # Get the collection for this model from the session. Will check for an
-    # overridden collection name from the store_in macro or the collection
-    # with a pluralized model name.
-    #
-    # @example Get the model's collection.
-    #   Model.collection
-    #
-    # @return [ Moped::Collection ] The collection.
-    #
-    # @since 3.0.0
-    def collection
-      self.class.collection
-    end
-
-    # Get the name of the collection this model persists to. This will be
-    # either the pluralized class name or the option defined in the store_in
-    # macro.
-    #
-    # @example Get the collection name.
-    #   Model.collection_name
-    #
-    # @return [ String ] The name of the collection.
-    #
-    # @since 3.0.0
-    def collection_name
-      self.class.collection_name
-    end
-
-    # Get the session for this model. This is determined in the following order:
-    #
-    #   1. Any custom configuration provided by the 'store_in' macro.
-    #   2. The 'default' session as provided in the mongoid.yml
-    #
-    # @example Get the session.
-    #   model.mongo_session
-    #
-    # @return [ Moped::Session ] The default moped session.
-    #
-    # @since 3.0.0
-    def mongo_session
-      self.class.mongo_session
-    end
-
-    # Tell the next persistance operation to store in a specific collection,
-    # database or session.
-    #
-    # @example Save the current document to a different collection.
-    #   model.with(collection: "secondary").save
-    #
-    # @example Save the current document to a different database.
-    #   model.with(database: "secondary").save
-    #
-    # @example Save the current document to a different session.
-    #   model.with(session: "replica_set").save
-    #
-    # @example Save with a combination of options.
-    #   model.with(session: "sharded", database: "secondary").save
-    #
-    # @param [ Hash ] options The storage options.
-    #
-    # @option options [ String, Symbol ] :collection The collection name.
-    # @option options [ String, Symbol ] :database The database name.
-    # @option options [ String, Symbol ] :session The session name.
-    #
-    # @return [ Document ] The current document.
-    #
-    # @since 3.0.0
-    def with(options)
-      Threaded.set_persistence_options(self.class, options)
-      self
-    end
+    include StorageOptions
+    include ThreadOptions
+    include Options
 
     class << self
-
       # Clear all sessions from the current thread.
       #
       # @example Clear all sessions.
@@ -138,79 +66,29 @@ module Mongoid
       end
     end
 
-    module ClassMethods
-
-      # Clear all persistence options from the current thread.
-      #
-      # @example Clear the persistence options.
-      #   Mongoid::Sessions.clear_persistence_options
-      #
-      # @return [ true ] True.
-      #
-      # @since 3.0.0
-      def clear_persistence_options
-        Threaded.clear_persistence_options(self)
-      end
-
-      # Get the collection for this model from the session. Will check for an
-      # overridden collection name from the store_in macro or the collection
-      # with a pluralized model name.
-      #
-      # @example Get the model's collection.
-      #   Model.collection
-      #
-      # @return [ Moped::Collection ] The collection.
-      #
-      # @since 3.0.0
-      def collection
-        if opts = persistence_options
-          coll = mongo_session.with(opts)[opts[:collection] || collection_name]
-          clear_persistence_options unless validating_with_query? || _loading_revision?
-          coll
-        else
-          mongo_session[collection_name]
-        end
-      end
+    # Get the collection for this model from the session. Will check for an
+    # overridden collection name from the store_in macro or the collection
+    # with a pluralized model name.
+    #
+    # @example Get the model's collection.
+    #   Model.collection
+    #
+    # @return [ Moped::Collection ] The collection.
+    #
+    # @since 3.0.0
+    def collection
+      mongo_session[collection_name]
+    end
 
-      # Get the name of the collection this model persists to. This will be
-      # either the pluralized class name or the option defined in the store_in
-      # macro.
-      #
-      # @example Get the collection name.
-      #   Model.collection_name
-      #
-      # @return [ Symbol ] The name of the collection.
-      #
-      # @since 3.0.0
-      def collection_name
-        __collection_name__
-      end
+    def mongo_session
+      super || self.class.mongo_session
+    end
 
-      # Get the default database name for this model.
-      #
-      # @example Get the default database name.
-      #   Model.database_name
-      #
-      # @return [ Symbol ] The name of the database.
-      #
-      # @since 3.0.0
-      def database_name
-        __database_name__
-      end
+    def collection_name
+      super || self.class.collection_name
+    end
 
-      # Get the overridden database name. This either can be overridden by
-      # using +Model.with+ or by overriding at the global level via
-      # +Mongoid.override_database(:name)+.
-      #
-      # @example Get the overridden database name.
-      #   Model.database_override
-      #
-      # @return [ String, Symbol ] The overridden database name.
-      #
-      # @since 3.0.0
-      def database_override
-        persistence_options.try { |opts| opts[:database] } || Threaded.database_override
-      end
+    module ClassMethods
 
       # Get the session for this model. This is determined in the following order:
       #
@@ -224,209 +102,23 @@ module Mongoid
       #
       # @since 3.0.0
       def mongo_session
-        session = __session__
-        session.use(database_override || current_database_name(session))
-        session
+        session = Sessions.with_name(session_name)
+        session.use(database_name)
+        self.persistence_options ? session.with(self.persistence_options) : session
       end
 
-      # Get the persistence options from the current thread.
-      #
-      # @example Get the persistence options.
-      #   Model.persistence_options
-      #
-      # @return [ Hash ] The persistence options.
-      #
-      # @since 3.0.0
-      def persistence_options
-        Threaded.persistence_options(self)
-      end
-
-      # Get the overridden session name. This either can be overridden by
-      # using +Model.with+ or by overriding at the global level via
-      # +Mongoid.override_session(:name)+.
-      #
-      # @example Get the overridden session name.
-      #   Model.session_override
-      #
-      # @return [ String, Symbol ] The overridden session name.
-      #
-      # @since 3.0.0
-      def session_override
-        persistence_options.try { |opts| opts[:session] } || Threaded.session_override
-      end
-
-      # Give this model specific custom default storage options.
-      #
-      # @example Store this model by default in "artists"
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in collection: "artists"
-      #   end
-      #
-      # @example Store this model by default in the sharded db.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in database: "echo_shard"
-      #   end
-      #
-      # @example Store this model by default in a different session.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in session: "secondary"
-      #   end
-      #
-      # @example Store this model with a combination of options.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in collection: "artists", database: "secondary"
-      #   end
-      #
-      # @param [ Hash ] options The storage options.
-      #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :session The session name.
-      #
-      # @return [ Class ] The model class.
-      #
-      # @since 3.0.0
-      def store_in(options)
-        Validators::Storage.validate(self, options)
-        self.storage_options ||= {}
-        self.storage_options.merge!(options)
-      end
-
-      # Tell the next persistance operation to store in a specific collection,
-      # database or session.
-      #
-      # @example Create a document in a different collection.
-      #   Model.with(collection: "secondary").create(name: "test")
-      #
-      # @example Create a document in a different database.
-      #   Model.with(database: "secondary").create(name: "test")
-      #
-      # @example Create a document in a different session.
-      #   Model.with(session: "secondary").create(name: "test")
-      #
-      # @example Create with a combination of options.
-      #   Model.with(session: "sharded", database: "secondary").create
-      #
-      # @param [ Hash ] options The storage options.
-      #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :session The session name.
-      #
-      # @return [ Class ] The model class.
-      #
-      # @since 3.0.0
-      def with(options)
-        Threaded.set_persistence_options(self, options)
-        self
-      end
-
-      private
-
-      # Get the name of the collection this model persists to.
-      #
-      # @example Get the collection name.
-      #   Model.__collection_name__
-      #
-      # @return [ Symbol ] The name of the collection.
-      #
-      # @since 3.0.0
-      def __collection_name__
-        if storage_options && name = storage_options[:collection]
-          __evaluate__(name)
-        else
-          default_collection_name
-        end
-      end
-
-      # Get the database name for the model.
-      #
-      # @example Get the database name.
-      #   Model.__database_name__
-      #
-      # @return [ Symbol ] The name of the database.
-      #
-      # @since 3.0.0
-      def __database_name__
-        if storage_options && name = storage_options[:database]
-          __evaluate__(name)
-        else
-          Mongoid.sessions[__session_name__][:database]
-        end
-      end
-
-      # Get the session name for the model.
-      #
-      # @example Get the session name.
-      #   Model.__session_name__
-      #
-      # @return [ Symbol ] The name of the session.
-      #
-      # @since 3.0.0
-      def __session_name__
-        if storage_options && name = storage_options[:session]
-          __evaluate__(name)
-        else
-          :default
-        end
-      end
-
-      # Get the session for this class.
+      # Get the collection for this model from the session. Will check for an
+      # overridden collection name from the store_in macro or the collection
+      # with a pluralized model name.
       #
-      # @example Get the session.
-      #   Model.__session__
+      # @example Get the model's collection.
+      #   Model.collection
       #
-      # @return [ Moped::Session ] The moped session.
+      # @return [ Moped::Collection ] The collection.
       #
       # @since 3.0.0
-      def __session__
-        if !(name = session_override).nil?
-          Sessions.with_name(name)
-        else
-          Sessions.with_name(__session_name__)
-        end
-      end
-
-      # Eval the provided value, either byt calling it if it responds to call
-      # or returning the value itself.
-      #
-      # @api private
-      #
-      # @example Evaluate the name.
-      #   Model.__evaluate__(:name)
-      #
-      # @param [ String, Symbol, Proc ] name The name.
-      #
-      # @return [ Symbol ] The value as a symbol.
-      #
-      # @since 3.1.0
-      def __evaluate__(name)
-        name.respond_to?(:call) ? name.call.to_sym : name.to_sym
-      end
-
-      # Get the name of the current database to use. Will check for a session
-      # override with a database first, then database name.
-      #
-      # @api private
-      #
-      # @example Get the current database name.
-      #   Model.current_database_name
-      #
-      # @param [ Moped::Session ] session The current session.
-      #
-      # @return [ Symbol ] The current database name.
-      #
-      # @since 3.1.0
-      def current_database_name(session)
-        if session_override && name = session.options[:database]
-          name
-        else
-          database_name
-        end
+      def collection
+        mongo_session[collection_name]
       end
     end
   end