mongoid 3.0.23 → 3.1.0

data/lib/mongoid/equality.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+module Mongoid
+
+  # This module contains the behaviour of Mongoid's clone/dup of documents.
+  module Equality
+
+    # Default comparison is via the string version of the id.
+    #
+    # @example Compare two documents.
+    #   person <=> other_person
+    #
+    # @param [ Document ] other The document to compare with.
+    #
+    # @return [ Integer ] -1, 0, 1.
+    #
+    # @since 1.0.0
+    def <=>(other)
+      attributes["_id"].to_s <=> other.attributes["_id"].to_s
+    end
+
+    # Performs equality checking on the document ids. For more robust
+    # equality checking please override this method.
+    #
+    # @example Compare for equality.
+    #   document == other
+    #
+    # @param [ Document, Object ] other The other object to compare with.
+    #
+    # @return [ true, false ] True if the ids are equal, false if not.
+    #
+    # @since 1.0.0
+    def ==(other)
+      self.class == other.class &&
+          attributes["_id"] == other.attributes["_id"]
+    end
+
+    # Performs class equality checking.
+    #
+    # @example Compare the classes.
+    #   document === other
+    #
+    # @param [ Document, Object ] other The other object to compare with.
+    #
+    # @return [ true, false ] True if the classes are equal, false if not.
+    #
+    # @since 1.0.0
+    def ===(other)
+      other.class == Class ? self.class === other : self == other
+    end
+
+    # Delegates to ==. Used when needing checks in hashes.
+    #
+    # @example Perform equality checking.
+    #   document.eql?(other)
+    #
+    # @param [ Document, Object ] other The object to check against.
+    #
+    # @return [ true, false ] True if equal, false if not.
+    #
+    # @since 1.0.0
+    def eql?(other)
+      self == (other)
+    end
+  end
+end
+

data/lib/mongoid/errors/mongoid_error.rb

@@ -18,9 +18,13 @@ module Mongoid
       #
       # @since 3.0.0
       def compose_message(key, attributes)
-        "\nProblem:\n  #{problem(key, attributes)}"+
-        "\nSummary:\n  #{summary(key, attributes)}"+
-        "\nResolution:\n  #{resolution(key, attributes)}"
+        @problem = problem(key, attributes)
+        @summary = summary(key, attributes)
+        @resolution = resolution(key, attributes)
+
+        "\nProblem:\n  #{@problem}"+
+        "\nSummary:\n  #{@summary}"+
+        "\nResolution:\n  #{@resolution}"
       end
 
       private

data/lib/mongoid/extensions/array.rb

@@ -53,6 +53,18 @@ module Mongoid
         ::Time.configured.local(*self)
       end
 
+      # Check if the array is part of a blank relation criteria.
+      #
+      # @example Is the array blank criteria?
+      #   [].blank_criteria?
+      #
+      # @return [ true, false ] If the array is blank criteria.
+      #
+      # @since 3.1.0
+      def blank_criteria?
+        any?(&:blank_criteria?)
+      end
+
       # Is the array a set of multiple arguments in a method?
       #
       # @example Is this multi args?
@@ -62,7 +74,7 @@ module Mongoid
       #
       # @since 3.0.0
       def multi_arged?
-        first.resizable? || size > 1
+        !first.is_a?(Hash) && first.resizable? || size > 1
       end
 
       # Turn the object from the ruby type we deal with to a Mongo friendly

data/lib/mongoid/extensions/date.rb

@@ -3,6 +3,9 @@ module Mongoid
   module Extensions
     module Date
 
+      # Constant for epoch - used when passing invalid times.
+      EPOCH = ::Date.new(1970, 1, 1)
+
       # Convert the date into a time.
       #
       # @example Convert the date to a time.
@@ -57,8 +60,12 @@ module Mongoid
         # @since 3.0.0
         def mongoize(object)
           unless object.blank?
-            time = object.__mongoize_time__
-            ::Time.utc(time.year, time.month, time.day)
+            begin
+              time = object.__mongoize_time__
+              ::Time.utc(time.year, time.month, time.day)
+            rescue ArgumentError
+              EPOCH
+            end
           end
         end
       end

data/lib/mongoid/extensions/hash.rb

@@ -35,18 +35,33 @@ module Mongoid
       # @return [ Hash ] A new consolidated hash.
       #
       # @since 3.0.0
-      def __consolidate__
+      def __consolidate__(klass)
         consolidated = {}
         each_pair do |key, value|
           if key =~ /\$/
+            value.each_pair do |_key, _value|
+              value[_key] = mongoize_for(klass, _key, _value)
+            end
             (consolidated[key] ||= {}).merge!(value)
           else
-            (consolidated["$set"] ||= {}).merge!(key => value)
+            (consolidated["$set"] ||= {}).merge!(key => mongoize_for(klass, key, value))
           end
         end
         consolidated
       end
 
+      # Check if the hash is part of a blank relation criteria.
+      #
+      # @example Is the hash blank criteria?
+      #   {}.blank_criteria?
+      #
+      # @return [ true, false ] If the hash is blank criteria.
+      #
+      # @since 3.1.0
+      def blank_criteria?
+        self == { "_id" => { "$in" => [] }}
+      end
+
       # Deletes an id value from the hash.
       #
       # @example Delete an id value.
@@ -135,6 +150,27 @@ module Mongoid
         criteria
       end
 
+      private
+
+      # Mongoize for the klass, key and value.
+      #
+      # @api private
+      #
+      # @example Mongoize for the klass, field and value.
+      #   {}.mongoize_for(Band, "name", "test")
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ String, Symbol ] The field key.
+      # @param [ Object ] value The value to mongoize.
+      #
+      # @return [ Object ] The mongoized value.
+      #
+      # @since 3.1.0
+      def mongoize_for(klass, key, value)
+        field = klass.fields[key.to_s]
+        field ? field.mongoize(value) : value
+      end
+
       module ClassMethods
 
         # Turn the object from the ruby type we deal with to a Mongo friendly

data/lib/mongoid/extensions/nil_class.rb

@@ -3,6 +3,18 @@ module Mongoid
   module Extensions
     module NilClass
 
+      # Try to form a setter from this object.
+      #
+      # @example Try to form a setter.
+      #   object.__setter__
+      #
+      # @return [ nil ] Always nil.
+      #
+      # @since 3.1.0
+      def __setter__
+        self
+      end
+
       # Get the name of a nil collection.
       #
       # @example Get the nil name.

data/lib/mongoid/extensions/object.rb

@@ -40,6 +40,18 @@ module Mongoid
         self
       end
 
+      # Try to form a setter from this object.
+      #
+      # @example Try to form a setter.
+      #   object.__setter__
+      #
+      # @return [ String ] The object as a string plus =.
+      #
+      # @since 3.1.0
+      def __setter__
+        "#{self}="
+      end
+
       # Get the value of the object as a mongo friendy sort value.
       #
       # @example Get the object as sort criteria.
@@ -64,6 +76,18 @@ module Mongoid
         self
       end
 
+      # Check if the object is part of a blank relation criteria.
+      #
+      # @example Is the object blank criteria?
+      #   "".blank_criteria?
+      #
+      # @return [ true, false ] If the object is blank criteria.
+      #
+      # @since 3.1.0
+      def blank_criteria?
+        false
+      end
+
       # Do or do not, there is no try. -- Yoda.
       #
       # @example Do or do not.

data/lib/mongoid/extensions/string.rb

@@ -81,7 +81,7 @@ module Mongoid
       #
       # @since 3.0.0
       def numeric?
-        true if Float(self) rescue (self == "NaN")
+        true if Float(self) rescue false
       end
 
       # Get the string as a getter string.
@@ -93,7 +93,7 @@ module Mongoid
       #
       # @since 1.0.0
       def reader
-        delete("=")
+        delete("=").sub(/\_before\_type\_cast$/, '')
       end
 
       # Convert the string to an array with the string in it.
@@ -132,6 +132,18 @@ module Mongoid
         /[@$"]/ !~ to_sym.inspect
       end
 
+      # Does the string end with _before_type_cast?
+      #
+      # @example Is the string a setter method?
+      #   "price_before_type_cast".before_type_cast?
+      #
+      # @return [ true, false ] If the string ends with "_before_type_cast"
+      #
+      # @since 3.1.0
+      def before_type_cast?
+        ends_with?("_before_type_cast")
+      end
+
       # Is the object not to be converted to bson on criteria creation?
       #
       # @example Is the object unconvertable?

data/lib/mongoid/extensions/time.rb

@@ -3,6 +3,9 @@ module Mongoid
   module Extensions
     module Time
 
+      # Constant for epoch - used when passing invalid times.
+      EPOCH = ::Time.utc(1970, 1, 1, 0, 0, 0)
+
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
       #
@@ -73,7 +76,7 @@ module Mongoid
               ::Time.at(time.to_i, time.usec).utc
             end
           rescue ArgumentError
-            raise Errors::InvalidTime.new(object)
+            EPOCH
           end
         end
       end

data/lib/mongoid/fields.rb

@@ -23,7 +23,6 @@ module Mongoid
       self.pre_processed_defaults = []
       self.post_processed_defaults = []
 
-      field(:_type, default: ->{ self.class.name if hereditary? }, type: String)
       field(
         :_id,
         default: ->{ Moped::BSON::ObjectId.new },
@@ -77,7 +76,7 @@ module Mongoid
       unless attributes.has_key?(name)
         if field = fields[name]
           default = field.eval_default(self)
-          unless default.nil?
+          unless default.nil? || field.lazy?
             attribute_will_change!(name)
             attributes[name] = default
           end
@@ -126,6 +125,21 @@ module Mongoid
       self.class.database_field_name(name)
     end
 
+    # Is the provided field a lazy evaluation?
+    #
+    # @example If the field is lazy settable.
+    #   doc.lazy_settable?(field, nil)
+    #
+    # @param [ Field ] field The field.
+    # @param [ Object ] value The current value.
+    #
+    # @return [ true, false ] If we set the field lazily.
+    #
+    # @since 3.1.0
+    def lazy_settable?(field, value)
+      !frozen? && value.nil? && field.lazy?
+    end
+
     # Is the document using object ids?
     #
     # @note Refactored from using delegate for class load performance.
@@ -336,6 +350,7 @@ module Mongoid
       #   person.name #=> returns the field
       #   person.name = "" #=> sets the field
       #   person.name? #=> Is the field present?
+      #   person.name_before_type_cast #=> returns the field before type cast
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Symbol ] meth The name of the accessor.
@@ -346,6 +361,7 @@ module Mongoid
         field = fields[name]
 
         create_field_getter(name, meth, field)
+        create_field_getter_before_type_cast(name, meth)
         create_field_setter(name, meth, field)
         create_field_check(name, meth)
 
@@ -369,9 +385,37 @@ module Mongoid
       def create_field_getter(name, meth, field)
         generated_methods.module_eval do
           re_define_method(meth) do
-            value = fields[name].demongoize(read_attribute(name))
-            attribute_will_change!(name) if value.resizable?
-            value
+            raw = read_attribute(name)
+            if lazy_settable?(field, raw)
+              write_attribute(name, field.eval_default(self))
+            else
+              value = field.demongoize(raw)
+              attribute_will_change!(name) if value.resizable?
+              value
+            end
+          end
+        end
+      end
+
+      # Create the getter_before_type_cast method for the provided field. If
+      # the attribute has been assigned, return the attribute before it was
+      # type cast. Otherwise, delegate to the getter.
+      #
+      # @example Create the getter_before_type_cast.
+      #   Model.create_field_getter_before_type_cast("name", "name")
+      #
+      # @param [ String ] name The name of the attribute.
+      # @param [ String ] meth The name of the method.
+      #
+      # @since 3.1.0
+      def create_field_getter_before_type_cast(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_before_type_cast") do
+            if has_attribute_before_type_cast?(name)
+              read_attribute_before_type_cast(name)
+            else
+              send meth
+            end
           end
         end
       end

data/lib/mongoid/fields/foreign_key.rb

@@ -69,6 +69,18 @@ module Mongoid
         end
       end
 
+      # Does this field do lazy default evaluation?
+      #
+      # @example Is the field lazy?
+      #   field.lazy?
+      #
+      # @return [ true, false ] If the field is lazy.
+      #
+      # @since 3.1.0
+      def lazy?
+        type.resizable?
+      end
+
       # Mongoize the object into the Mongo friendly value.
       #
       # @example Mongoize the object.

data/lib/mongoid/fields/standard.rb

@@ -95,6 +95,18 @@ module Mongoid
         end
       end
 
+      # Does this field do lazy default evaluation?
+      #
+      # @example Is the field lazy?
+      #   field.lazy?
+      #
+      # @return [ true, false ] If the field is lazy.
+      #
+      # @since 3.1.0
+      def lazy?
+        false
+      end
+
       # Is the field localized or not?
       #
       # @example Is the field localized?