MONGOID-5222 update mongoize update strings

Author: neilshweky

lib/mongoid/extensions/array.rb

@@ -87,7 +87,7 @@ def multi_arged?
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Array ] The object.
+      # @return [ Array | nil ] The object or nil.
       def mongoize
         ::Array.mongoize(self)
       end
@@ -144,7 +144,9 @@ def __mongoize_fk__(association, object)
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Array ] The object mongoized.
+        # @raise [ Errors::InvalidValue ] if the value is uncastable.
+        #
+        # @return [ Array | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
           if object.is_a?(::Array)

lib/mongoid/extensions/big_decimal.rb

@@ -20,7 +20,7 @@ def __to_inc__
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Object ] The object.
+      # @return [ String | BSON::Decimal128 | nil ] The object or nil.
       def mongoize
         ::BigDecimal.mongoize(self)
       end
@@ -62,8 +62,11 @@ def demongoize(object)
         #
         # @param [ Object ] object The object to Mongoize
         #
+        # @raise [ Errors::InvalidValue ] if the value is uncastable.
+        #
         # @return [ String | BSON::Decimal128 | nil ] A String or Decimal128
-        #   representing the object or nil.
+        #   representing the object or nil. String if Mongoid.map_big_decimal_to_decimal128
+        #   is false, BSON::Decimal128 otherwise.
         def mongoize(object)
           return if object.nil?
           return if object.is_a?(String) && object.blank?

lib/mongoid/extensions/binary.rb

@@ -10,7 +10,7 @@ module Binary
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Object ] The object.
+      # @return [ BSON::Binary | nil ] The object.
       def mongoize
         BSON::Binary.mongoize(self)
       end
@@ -24,8 +24,9 @@ module ClassMethods
         #
         # @param [ Object ] object The object to Mongoize
         #
-        # @return [ String | Symbol | BSON::Binary | nil ] A String or Binary
-        #   representing the object or nil.
+        # @raise [ Errors::InvalidValue ] if the value is uncastable.
+        #
+        # @return [ BSON::Binary | nil ] A Binary representing the object or nil.
         def mongoize(object)
           return if object.nil?
           case object

lib/mongoid/extensions/boolean.rb

@@ -11,7 +11,9 @@ class << self
       # @example Mongoize the object.
       #   Boolean.mongoize("123.11")
       #
-      # @return [ String ] The object mongoized.
+      # @raise [ Errors::InvalidValue ] if the value is uncastable.
+      #
+      # @return [ true | false | nil ] The object mongoized or nil.
       def mongoize(object)
         return if object.nil?
         if object.to_s =~ (/\A(true|t|yes|y|on|1|1.0)\z/i)

lib/mongoid/extensions/date.rb

@@ -50,7 +50,9 @@ def demongoize(object)
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Time ] The object mongoized.
+        # @raise [ Errors::InvalidValue ] if the value is uncastable.
+        #
+        # @return [ Time | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
           unless object.blank?

lib/mongoid/extensions/float.rb

@@ -34,7 +34,9 @@ module ClassMethods
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ String ] The object mongoized.
+        # @raise [ Errors::InvalidValue ] if the value is uncastable.
+        #
+        # @return [ Float | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
           return if object.is_a?(String) && object.blank?

lib/mongoid/extensions/hash.rb

@@ -148,7 +148,7 @@ def __nested__(string)
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Hash ] The object.
+      # @return [ Hash | nil ] The object mongoized or nil.
       def mongoize
         ::Hash.mongoize(self)
       end
@@ -217,7 +217,9 @@ module ClassMethods
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Hash ] The object mongoized.
+        # @raise [ Errors::InvalidValue ] if the value is uncastable.
+        #
+        # @return [ Hash | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
           if object.is_a?(Hash)

lib/mongoid/extensions/integer.rb

@@ -42,7 +42,9 @@ module ClassMethods
         # @example Mongoize the object.
         #   BigDecimal.mongoize("123.11")
         #
-        # @return [ String ] The object mongoized.
+        # @raise [ Errors::InvalidValue ] if the value is uncastable.
+        #
+        # @return [ Integer | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
           return if object.is_a?(String) && object.blank?

lib/mongoid/extensions/range.rb

@@ -20,7 +20,7 @@ def __find_args__
       # @example Mongoize the object.
       #   range.mongoize
       #
-      # @return [ Hash ] The object mongoized.
+      # @return [ Range | nil ] The object mongoized or nil.
       def mongoize
         ::Range.mongoize(self)
       end
@@ -59,9 +59,11 @@ def demongoize(object)
         # @example Mongoize the object.
         #   Range.mongoize(1..3)
         #
-        # @param [ Range ] object The object to mongoize.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Hash ] The object mongoized.
+        # @raise [ Errors::InvalidValue ] if the value is uncastable.
+        #
+        # @return [ Range | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
           case object

lib/mongoid/extensions/regexp.rb

@@ -12,9 +12,9 @@ module ClassMethods
         # @example Mongoize the object.
         #   Regexp.mongoize(/\A[abc]/)
         #
-        # @param [ Regexp, String ] object The object to mongoize.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Regexp ] The object mongoized.
+        # @return [ Regexp | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
           case object