mongoid 3.0.23 → 3.1.0

data/lib/mongoid/relations/macros.rb

@@ -58,6 +58,7 @@ module Mongoid
           self.embedded = true
           relate(name, meta)
           builder(name, meta).creator(name, meta)
+          add_counter_cache_callbacks(meta) if meta.counter_cached?
           meta
         end
 
@@ -140,6 +141,7 @@ module Mongoid
           meta = reference_one_to_one(name, options, Referenced::In, &block)
           aliased_fields[name.to_s] = meta.foreign_key
           touchable(meta)
+          add_counter_cache_callbacks(meta) if meta.counter_cached?
           meta
         end
 

data/lib/mongoid/relations/marshalable.rb

@@ -25,7 +25,6 @@ module Mongoid
       # @since 3.0.15
       def marshal_load(data)
         @base, @target, @metadata = data
-        extend_proxy(metadata.extension) if metadata.extension?
       end
     end
   end

data/lib/mongoid/relations/metadata.rb

@@ -138,6 +138,34 @@ module Mongoid
         @constraint ||= Constraint.new(self)
       end
 
+      # Does the metadata have a counter cache?
+      #
+      # @example Is the metadata counter_cached?
+      #   metadata.counter_cached?
+      #
+      # @return [ true, false ] If the metadata has counter_cache
+      #
+      # @since 3.1.0
+      def counter_cached?
+        !!self[:counter_cache]
+      end
+
+      # Returns the counter cache column name
+      #
+      # @example Get the counter cache column.
+      #   metadata.counter_cache_column_name
+      #
+      # @return [ String ] The counter cache column
+      #
+      # @since 3.1.0
+      def counter_cache_column_name
+        if self[:counter_cache] == true
+          "#{inverse_class_name.demodulize.underscore.pluralize}_count"
+        else
+          self[:counter_cache].to_s
+        end
+      end
+
       # Get the criteria that is used to query for this metadata's relation.
       #
       # @example Get the criteria.
@@ -361,6 +389,7 @@ module Mongoid
   autobuild:    #{autobuilding?}
   class_name:   #{class_name}
   cyclic:       #{cyclic.inspect}
+  counter_cache:#{counter_cached?}
   dependent:    #{dependent.inspect}
   inverse_of:   #{inverse_of.inspect}
   key:          #{key}
@@ -477,13 +506,13 @@ module Mongoid
       # @example Get the inverse metadata.
       #   metadata.inverse_metadata(doc)
       #
-      # @param [ Document ] document The document to check.
+      # @param [ Document, Class ] object The document or class.
       #
       # @return [ Metadata ] The inverse metadata.
       #
       # @since 2.1.0
-      def inverse_metadata(document)
-        document.reflect_on_association(inverse(document))
+      def inverse_metadata(object)
+        object.reflect_on_association(inverse(object))
       end
 
       # Returns the inverse_of option of the relation.
@@ -521,8 +550,7 @@ module Mongoid
       #
       # @since 2.0.0.rc.1
       def inverse_setter(other = nil)
-        inv = inverse(other)
-        inv ? "#{inv}=" : nil
+        inverse(other).__setter__
       end
 
       # Returns the name of the field in which to store the name of the class
@@ -548,7 +576,7 @@ module Mongoid
       #
       # @since 2.0.0.rc.1
       def inverse_type_setter
-        @inverse_type_setter ||= inverse_type ? "#{inverse_type}=" : nil
+        @inverse_type_setter ||= inverse_type.__setter__
       end
 
       # Returns the name of the field in which to store the name of the inverse
@@ -573,7 +601,7 @@ module Mongoid
       #
       # @return [ String ] The name of the setter.
       def inverse_of_field_setter
-        @inverse_of_field_setter ||= inverse_of_field ? "#{inverse_of_field}=" : nil
+        @inverse_of_field_setter ||= inverse_of_field.__setter__
       end
 
       # This returns the key that is to be used to grab the attributes for the
@@ -705,6 +733,18 @@ module Mongoid
         @polymorphic ||= (!!self[:as] || !!self[:polymorphic])
       end
 
+      # Get the primary key field for finding the related document.
+      #
+      # @example Get the primary key.
+      #   metadata.primary_key
+      #
+      # @return [ String ] The primary key field.
+      #
+      # @since 3.1.0
+      def primary_key
+        @primary_key ||= (self[:primary_key] || "_id").to_s
+      end
+
       # Get the relation associated with this metadata.
       #
       # @example Get the relation.
@@ -727,7 +767,7 @@ module Mongoid
       #
       # @since 2.0.0.rc.1
       def setter
-        @setter ||= "#{name.to_s}="
+        @setter ||= "#{name}="
       end
 
       # Returns the name of the field in which to store the name of the class
@@ -740,7 +780,7 @@ module Mongoid
       #
       # @since 2.0.0.rc.1
       def type
-        @type ||= polymorphic? ? "#{as.to_s}_type" : nil
+        @type ||= polymorphic? ? "#{as}_type" : nil
       end
 
       # Gets the setter for the field that sets the type of document on a
@@ -753,7 +793,7 @@ module Mongoid
       #
       # @since 2.0.0.rc.1
       def type_setter
-        @type_setter ||= type ? "#{type}=" : nil
+        @type_setter ||= type.__setter__
       end
 
 
@@ -844,6 +884,18 @@ module Mongoid
         !!self[:touch]
       end
 
+      # Returns the metadata class types.
+      #
+      # @example Get the relation class types.
+      #   metadata.type_relation
+      #
+      # @return [ Hash ] The hash with relation class types.
+      #
+      # @since 3.1.0
+      def type_relation
+        { _type: { "$in" => klass._types }}
+      end
+
       private
 
       # Returns the class name for the relation.
@@ -1089,7 +1141,7 @@ module Mongoid
       # @since 2.0.0.rc.1
       def determine_key
         return store_as.to_s if relation.embedded?
-        relation.stores_foreign_key? ? foreign_key : "_id"
+        relation.stores_foreign_key? ? foreign_key : primary_key
       end
 
       # Determine the name of the inverse relation.

data/lib/mongoid/relations/options.rb

@@ -10,6 +10,7 @@ module Mongoid
       # These options are available to all relations.
       COMMON = [
         :class_name,
+        :counter_cache,
         :extend,
         :inverse_class_name,
         :inverse_of,

data/lib/mongoid/relations/proxy.rb

@@ -171,6 +171,49 @@ module Mongoid
         raise Errors::UnsavedDocument.new(base, doc)
       end
 
+      # Return the name of defined callback method
+      #
+      # @example returns the before_add callback method name
+      #   callback_method(:before_add)
+      #
+      # @param [ Symbol ] which callback
+      #
+      # @return [ Array ] with callback methods to be executed, the array may have symbols and Procs
+      #
+      # @since 3.1.0
+      def callback_method(callback_name)
+        methods = []
+        if metadata[callback_name]
+          if metadata[callback_name].is_a? Array
+            methods.concat(metadata[callback_name])
+          else
+            methods << metadata[callback_name]
+          end
+        end
+        methods
+      end
+
+      # Executes a callback method
+      #
+      # @example execute the before add callback
+      #   execute_callback(:before_add)
+      #
+      # @param [ Symbol ] callback to be executed
+      #
+      # @since 3.1.0
+      def execute_callback(callback, doc)
+        callback_method = callback_method(callback)
+        if callback_method
+          callback_method.each do |c|
+            if c.is_a? Proc
+              c.call(base, doc)
+            else
+              base.send c, doc
+            end
+          end
+        end
+      end
+
       class << self
 
         # Apply ordering to the criteria if it was defined on the relation.
@@ -204,11 +247,11 @@ module Mongoid
           klass, foreign_key = metadata.klass, metadata.foreign_key
           eager_loaded = klass.any_in(foreign_key => ids).entries
           ids.each do |id|
-            IdentityMap.clear_many(klass, { foreign_key => id })
+            IdentityMap.clear_many(klass, metadata.type_relation.merge!(foreign_key => id))
           end
           eager_loaded.each do |doc|
             base_id = doc.__send__(foreign_key)
-            yield(doc, { foreign_key => base_id })
+            yield(doc,  metadata.type_relation.merge!(foreign_key => base_id))
           end
         end
       end

data/lib/mongoid/relations/referenced/in.rb

@@ -119,7 +119,7 @@ module Mongoid
           #
           # @since 2.1.0
           def criteria(metadata, object, type = nil)
-            type.where(_id: object)
+            type.where(metadata.primary_key => object)
           end
 
           # Get the criteria that is used to eager load a relation of this
@@ -266,7 +266,16 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :autobuild, :autosave, :dependent, :foreign_key, :index, :polymorphic, :touch ]
+            [
+              :autobuild,
+              :autosave,
+              :dependent,
+              :foreign_key,
+              :index,
+              :polymorphic,
+              :primary_key,
+              :touch
+            ]
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/referenced/many.rb

@@ -105,11 +105,13 @@ module Mongoid
         #
         # @since 2.1.0
         def delete(document)
+          execute_callback :before_remove, document
           target.delete(document) do |doc|
             if doc
               unbind_one(doc)
               cascade!(doc) if !_assigning?
             end
+            execute_callback :after_remove, doc
           end
         end
 
@@ -250,11 +252,20 @@ module Mongoid
           unless metadata.destructive?
             nullify
           else
+            after_remove_error = nil
             criteria.delete_all
-            target.clear do |doc|
+            many = target.clear do |doc|
+              execute_callback :before_remove, doc
               unbind_one(doc)
               doc.destroyed = true
+              begin
+                execute_callback :after_remove, doc
+              rescue => e
+                after_remove_error = e
+              end
             end
+            raise after_remove_error if after_remove_error
+            many
           end
         end
         alias :clear :purge
@@ -313,9 +324,11 @@ module Mongoid
         #
         # @since 2.0.0.rc.1
         def append(document)
+          execute_callback :before_add, document
           target.push(document)
           characterize_one(document)
           bind_one(document)
+          execute_callback :after_add, document
         end
 
         # Instantiate the binding associated with this relation.
@@ -354,7 +367,11 @@ module Mongoid
         #
         # @since 2.0.0.beta.1
         def criteria
-          Many.criteria(metadata, Conversions.flag(base.id, metadata), base.class)
+          Many.criteria(
+            metadata,
+            Conversions.flag(base.send(metadata.primary_key), metadata),
+            base.class
+          )
         end
 
         # Perform the necessary cascade operations for documents that just got
@@ -693,7 +710,18 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :as, :autosave, :dependent, :foreign_key, :order ]
+            [
+              :after_add,
+              :after_remove,
+              :as,
+              :autosave,
+              :before_add,
+              :before_remove,
+              :dependent,
+              :foreign_key,
+              :order,
+              :primary_key
+            ]
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/referenced/many_to_many.rb

@@ -136,6 +136,9 @@ module Mongoid
         #
         # @since 2.0.0.rc.1
         def nullify
+          target.each do |doc|
+            execute_callback :before_remove, doc
+          end
           unless metadata.forced_nil_inverse?
             criteria.pull(inverse_foreign_key, base.id)
           end
@@ -145,12 +148,20 @@ module Mongoid
               base.send(foreign_key).clear
             )
           end
-          target.clear do |doc|
+          after_remove_error = nil
+          many_to_many = target.clear do |doc|
             unbind_one(doc)
             unless metadata.forced_nil_inverse?
               doc.changed_attributes.delete(inverse_foreign_key)
             end
+            begin
+              execute_callback :after_remove, doc
+            rescue => e
+              after_remove_error = e
+            end
           end
+          raise after_remove_error if after_remove_error
+          many_to_many
         end
         alias :nullify_all :nullify
         alias :clear :nullify
@@ -203,9 +214,11 @@ module Mongoid
         #
         # @since 2.0.0.rc.1
         def append(document)
+          execute_callback :before_add, document
           target.push(document)
           characterize_one(document)
           bind_one(document)
+          execute_callback :after_add, document
         end
 
         # Instantiate the binding associated with this relation.
@@ -300,7 +313,11 @@ module Mongoid
           #
           # @since 2.1.0
           def criteria(metadata, object, type = nil)
-            apply_ordering(metadata.klass.all_of(_id: { "$in" => object || [] }), metadata)
+            apply_ordering(
+              metadata.klass.all_of(
+                metadata.primary_key => { "$in" => object || [] }
+              ), metadata
+            )
           end
 
           # Get the criteria that is used to eager load a relation of this
@@ -445,7 +462,18 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :autosave, :dependent, :foreign_key, :index, :order ]
+            [
+              :after_add,
+              :after_remove,
+              :autosave,
+              :before_add,
+              :before_remove,
+              :dependent,
+              :foreign_key,
+              :index,
+              :order,
+              :primary_key
+            ]
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/referenced/one.rb

@@ -275,7 +275,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :as, :autobuild, :autosave, :dependent, :foreign_key ]
+            [ :as, :autobuild, :autosave, :dependent, :foreign_key, :primary_key ]
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/targets/enumerable.rb

@@ -163,7 +163,7 @@ module Mongoid
               yield(doc)
             end
           else
-            _unloaded.each do |doc|
+            unloaded_documents.each do |doc|
               document = _added.delete(doc.id) || _loaded.delete(doc.id) || doc
               _loaded[document.id] = document
               yield(document)
@@ -448,6 +448,10 @@ module Mongoid
             ul ||
             _added.values.try(location)
         end
+
+        def unloaded_documents
+          _unloaded.selector.values.any?(&:blank_criteria?) ? [] : _unloaded
+        end
       end
     end
   end