mongoid 7.2.1 → 9.0.0

data/lib/mongoid/extensions/object_id.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to BSON::ObjectId.
     module ObjectId
 
       # Evolve the object id.
@@ -11,8 +13,6 @@ module Mongoid
       #   object_id.__evolve_object_id__
       #
       # @return [ BSON::ObjectId ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -28,8 +28,6 @@ module Mongoid
         # @param [ Object ] object The object to evolve.
         #
         # @return [ BSON::ObjectId ] The object id.
-        #
-        # @since 3.0.0
         def evolve(object)
           object.__evolve_object_id__
         end
@@ -42,8 +40,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ BSON::ObjectId ] The object id.
-        #
-        # @since 3.0.0
         def mongoize(object)
           object.__mongoize_object_id__
         end

data/lib/mongoid/extensions/range.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to Range class.
     module Range
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
 
       # Get the range as arguments for a find.
       #
@@ -11,11 +15,11 @@ module Mongoid
       #   range.__find_args__
       #
       # @return [ Array ] The range as an array.
-      #
-      # @since 3.0.0
+      # @deprecated
       def __find_args__
         to_a
       end
+      Mongoid.deprecate(self, :__find_args__)
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
@@ -23,9 +27,7 @@ module Mongoid
       # @example Mongoize the object.
       #   range.mongoize
       #
-      # @return [ Hash ] The object mongoized.
-      #
-      # @since 3.0.0
+      # @return [ Hash | nil ] The object mongoized or nil.
       def mongoize
         ::Range.mongoize(self)
       end
@@ -36,14 +38,11 @@ module Mongoid
       #   range.resizable?
       #
       # @return [ true ] True.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
 
       module ClassMethods
-
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @example Demongoize the object.
@@ -51,11 +50,21 @@ module Mongoid
         #
         # @param [ Hash ] object The object to demongoize.
         #
-        # @return [ Range ] The range.
-        #
-        # @since 3.0.0
+        # @return [ Range | nil ] The range, or nil if object cannot be represented as range.
         def demongoize(object)
-          object.nil? ? nil : ::Range.new(object["min"], object["max"], object["exclude_end"])
+          return if object.nil?
+          if object.is_a?(Hash)
+            hash = object.slice('min', 'max', 'exclude_end', :min, :max, :exclude_end)
+            unless hash.blank?
+              begin
+                ::Range.new(hash["min"] || hash[:min],
+                            hash["max"] || hash[:max],
+                            hash["exclude_end"] || hash[:exclude_end])
+              rescue ArgumentError
+                nil
+              end
+            end
+          end
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -64,18 +73,33 @@ module Mongoid
         # @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.
-        #
-        # @since 3.0.0
+        # @return [ Hash | nil ] The object mongoized or nil.
         def mongoize(object)
-          return nil if object.nil?
-          return object if object.is_a?(::Hash)
-          return object if object.is_a?(String)
-          hash = { "min" => object.first, "max" => object.last }
+          return if object.nil?
+          case object
+          when Hash then __mongoize_hash__(object)
+          when Range then __mongoize_range__(object)
+          end
+        end
+
+        private
+
+        def __mongoize_hash__(object)
+          hash = object.stringify_keys
+          hash.slice!('min', 'max', 'exclude_end')
+          hash.compact!
+          hash.transform_values!(&:mongoize)
+          hash.blank? ? nil : hash
+        end
+
+        def __mongoize_range__(object)
+          hash = {}
+          hash['min'] = object.begin.mongoize if object.begin
+          hash['max'] = object.end.mongoize if object.end
           if object.respond_to?(:exclude_end?) && object.exclude_end?
-            hash.merge!("exclude_end" => true)
+            hash['exclude_end'] = true
           end
           hash
         end
@@ -84,5 +108,4 @@ module Mongoid
   end
 end
 
-::Range.__send__(:include, Mongoid::Extensions::Range)
-::Range.extend(Mongoid::Extensions::Range::ClassMethods)
+Range.include(Mongoid::Extensions::Range)

data/lib/mongoid/extensions/raw_value.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+# Wrapper class used when a value cannot be casted in evolve method.
+module Mongoid
+
+  # Instantiates a new Mongoid::RawValue object. Used as a syntax shortcut.
+  #
+  # @example Create a Mongoid::RawValue object.
+  #   Mongoid::RawValue("Beagle")
+  #
+  # @return [ Mongoid::RawValue ] The object.
+  def RawValue(*args)
+    RawValue.new(*args)
+  end
+
+  # Represents a value which cannot be type-casted between Ruby and MongoDB.
+  class RawValue
+
+    attr_reader :raw_value
+
+    def initialize(raw_value)
+      @raw_value = raw_value
+    end
+
+    # Returns a string containing a human-readable representation of
+    # the object, including the inspection of the underlying value.
+    #
+    # @return [ String ] The object inspection.
+    def inspect
+      "RawValue: #{raw_value.inspect}"
+    end
+  end
+end

data/lib/mongoid/extensions/regexp.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Regexp class.
     module Regexp
 
       module ClassMethods
@@ -13,15 +15,20 @@ module Mongoid
         # @example Mongoize the object.
         #   Regexp.mongoize(/\A[abc]/)
         #
-        # @param [ Regexp, String ] object The object to mongoize.
-        #
-        # @return [ Regexp ] The object mongoized.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @since 3.0.0
+        # @return [ Regexp | nil ] The object mongoized or nil.
         def mongoize(object)
-          return nil if object.nil?
-          ::Regexp.new(object)
+          return if object.nil?
+          case object
+          when String then ::Regexp.new(object)
+          when ::Regexp then object
+          when BSON::Regexp::Raw then object.compile
+          end
+        rescue RegexpError
+          nil
         end
+        alias :demongoize :mongoize
       end
     end
   end

data/lib/mongoid/extensions/set.rb

@@ -1,25 +1,33 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
-    module Set
 
+    # Adds type-casting behavior to Set class.
+    module Set
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
       #
       # @example Mongoize the object.
       #   set.mongoize
       #
-      # @return [ Array ] The object mongoized.
-      #
-      # @since 3.0.0
+      # @return [ Array | nil ] The object mongoized or nil.
       def mongoize
         ::Set.mongoize(self)
       end
 
-      module ClassMethods
+      # Returns whether the object's size can be changed.
+      #
+      # @example Is the object resizable?
+      #   object.resizable?
+      #
+      # @return [ true ] true.
+      def resizable?
+        true
+      end
 
+      module ClassMethods
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @example Demongoize the object.
@@ -28,10 +36,11 @@ module Mongoid
         # @param [ Array ] object The object to demongoize.
         #
         # @return [ Set ] The set.
-        #
-        # @since 3.0.0
         def demongoize(object)
-          ::Set.new(object)
+          case object
+          when ::Set then object
+          when ::Array then ::Set.new(object)
+          end
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -42,11 +51,13 @@ module Mongoid
         #
         # @param [ Set ] object The object to mongoize.
         #
-        # @return [ Array ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @return [ Array | nil ] The object mongoized or nil.
         def mongoize(object)
-          object.to_a
+          return if object.nil?
+          case object
+          when ::Set then ::Array.mongoize(object.to_a).uniq
+          when ::Array then ::Array.mongoize(object).uniq
+          end
         end
       end
     end

data/lib/mongoid/extensions/string.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to String class.
     module String
 
       # @attribute [rw] unconvertable_to_bson If the document is unconvertable.
+      # @deprecated
       attr_accessor :unconvertable_to_bson
+      Mongoid.deprecate(self, :unconvertable_to_bson, :unconvertable_to_bson=)
 
       # Evolve the string into an object id if possible.
       #
       # @example Evolve the string.
       #   "test".__evolve_object_id__
       #
-      # @return [ String, BSON::ObjectId ] The evolved string.
-      #
-      # @since 3.0.0
+      # @return [ String | BSON::ObjectId ] The evolved string.
       def __evolve_object_id__
         convert_to_object_id
       end
@@ -25,9 +27,7 @@ module Mongoid
       # @example Evolve the string.
       #   "test".__mongoize_object_id__
       #
-      # @return [ String, BSON::ObjectId, nil ] The mongoized string.
-      #
-      # @since 3.0.0
+      # @return [ String | BSON::ObjectId | nil ] The mongoized string.
       def __mongoize_object_id__
         convert_to_object_id unless blank?
       end
@@ -40,21 +40,17 @@ module Mongoid
       #   "2012-01-01".__mongoize_time__
       #   # => 2012-01-01 00:00:00 -0500
       #
+      # @raise [ ArgumentError ] The string is not a valid time string.
+      #
       # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
       #   configured default time zone corresponding to this string.
-      #
-      # @since 3.0.0
       def __mongoize_time__
-        # This extra parse from Time is because ActiveSupport::TimeZone
-        # either returns nil or Time.now if the string is empty or invalid,
-        # which is a regression from pre-3.0 and also does not agree with
-        # the core Time API.
-        parsed = ::Time.parse(self)
-        if ::Time == ::Time.configured
-          parsed
-        else
-          ::Time.configured.parse(self)
-        end
+        # This extra Time.parse is required to raise an error if the string
+        # is not a valid time string. ActiveSupport::TimeZone does not
+        # perform this check.
+        ::Time.parse(self)
+
+        ::Time.zone.parse(self)
       end
 
       # Convert the string to a collection friendly name.
@@ -63,8 +59,6 @@ module Mongoid
       #   "namespace/model".collectionize
       #
       # @return [ String ] The string in collection friendly form.
-      #
-      # @since 1.0.0
       def collectionize
         tableize.gsub("/", "_")
       end
@@ -74,12 +68,12 @@ module Mongoid
       # @example Is the string an id value?
       #   "_id".mongoid_id?
       #
-      # @return [ true, false ] If the string is id or _id.
-      #
-      # @since 2.3.1
+      # @return [ true | false ] If the string is id or _id.
+      # @deprecated
       def mongoid_id?
         self =~ /\A(|_)id\z/
       end
+      Mongoid.deprecate(self, :mongoid_id?)
 
       # Is the string a number? The literals "NaN", "Infinity", and "-Infinity"
       # are counted as numbers.
@@ -87,9 +81,7 @@ module Mongoid
       # @example Is the string a number.
       #   "1234.23".numeric?
       #
-      # @return [ true, false ] If the string is a number.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If the string is a number.
       def numeric?
         !!Float(self)
       rescue ArgumentError
@@ -102,8 +94,6 @@ module Mongoid
       #   "model=".reader
       #
       # @return [ String ] The string stripped of "=".
-      #
-      # @since 1.0.0
       def reader
         delete("=").sub(/\_before\_type\_cast\z/, '')
       end
@@ -113,21 +103,17 @@ module Mongoid
       # @example Is the string a setter method?
       #   "model=".writer?
       #
-      # @return [ true, false ] If the string contains "=".
-      #
-      # @since 1.0.0
+      # @return [ true | false ] If the string contains "=".
       def writer?
         include?("=")
       end
 
       # Is this string a valid_method_name?
       #
-      # @example Is the string a valid Ruby idenfier for use as a method name
+      # @example Is the string a valid Ruby identifier for use as a method name
       #   "model=".valid_method_name?
       #
-      # @return [ true, false ] If the string contains a valid Ruby identifier.
-      #
-      # @since 3.0.15
+      # @return [ true | false ] If the string contains a valid Ruby identifier.
       def valid_method_name?
         /[@$"-]/ !~ self
       end
@@ -137,24 +123,23 @@ module Mongoid
       # @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
+      # @return [ true | false ] If the string ends with "_before_type_cast"
       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?
       #   object.unconvertable_to_bson?
       #
-      # @return [ true, false ] If the object is unconvertable.
-      #
-      # @since 2.2.1
+      # @return [ true | false ] If the object is unconvertable.
+      # @deprecated
       def unconvertable_to_bson?
         @unconvertable_to_bson ||= false
       end
+      Mongoid.deprecate(self, :unconvertable_to_bson?)
 
       private
 
@@ -165,29 +150,13 @@ module Mongoid
       # @example Convert to the object id.
       #   string.convert_to_object_id
       #
-      # @return [ String, BSON::ObjectId ] The string or the id.
-      #
-      # @since 3.0.0
+      # @return [ String | BSON::ObjectId ] The string or the id.
       def convert_to_object_id
         BSON::ObjectId.legal?(self) ? BSON::ObjectId.from_string(self) : self
       end
 
       module ClassMethods
 
-        # Convert the object from its mongo friendly ruby type to this type.
-        #
-        # @example Demongoize the object.
-        #   String.demongoize(object)
-        #
-        # @param [ Object ] object The object to demongoize.
-        #
-        # @return [ String ] The object.
-        #
-        # @since 3.0.0
-        def demongoize(object)
-          object.try(:to_s)
-        end
-
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
         #
@@ -197,11 +166,10 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
-          demongoize(object)
+          object.try(:to_s)
         end
+        alias :demongoize :mongoize
       end
     end
   end

data/lib/mongoid/extensions/symbol.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Symbol class.
     module Symbol
 
       # Is the symbol a valid value for a Mongoid id?
@@ -10,29 +12,15 @@ module Mongoid
       # @example Is the string an id value?
       #   :_id.mongoid_id?
       #
-      # @return [ true, false ] If the symbol is :id or :_id.
-      #
-      # @since 2.3.1
+      # @return [ true | false ] If the symbol is :id or :_id.
+      # @deprecated
       def mongoid_id?
         to_s.mongoid_id?
       end
+      Mongoid.deprecate(self, :mongoid_id?)
 
       module ClassMethods
 
-        # Convert the object from its mongo friendly ruby type to this type.
-        #
-        # @example Demongoize the object.
-        #   Symbol.demongoize(object)
-        #
-        # @param [ Object ] object The object to demongoize.
-        #
-        # @return [ Symbol ] The object.
-        #
-        # @since 3.0.0
-        def demongoize(object)
-          object.try(:to_sym)
-        end
-
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
         #
@@ -41,12 +29,11 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Symbol ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @return [ Symbol | nil ] The object mongoized or nil.
         def mongoize(object)
-          demongoize(object)
+          object.try(:to_sym)
         end
+        alias :demongoize :mongoize
       end
     end
   end