mongoid 8.1.5 → 9.0.0

data/lib/mongoid/extensions/object.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to Object class.
     module Object
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
 
       # Evolve a plain object into an object id.
       #
@@ -21,25 +26,11 @@ module Mongoid
       #   object.__find_args__
       #
       # @return [ Object ] self.
-      def __find_args__
-        self
-      end
-
-      # Mongoize a plain object into a time.
-      #
-      # @note This method should not be used, because it does not
-      #   return correct results for non-Time objects. Override
-      #   __mongoize_time__ in classes that are time-like to return an
-      #   instance of Time or ActiveSupport::TimeWithZone.
-      #
-      # @example Mongoize the object.
-      #   object.__mongoize_time__
-      #
-      # @return [ Object ] self.
       # @deprecated
-      def __mongoize_time__
+      def __find_args__
         self
       end
+      Mongoid.deprecate(self, :__find_args__)
 
       # Try to form a setter from this object.
       #
@@ -47,9 +38,11 @@ module Mongoid
       #   object.__setter__
       #
       # @return [ String ] The object as a string plus =.
+      # @deprecated
       def __setter__
         "#{self}="
       end
+      Mongoid.deprecate(self, :__setter__)
 
       # Get the value of the object as a mongo friendly sort value.
       #
@@ -57,9 +50,11 @@ module Mongoid
       #   object.__sortable__
       #
       # @return [ Object ] self.
+      # @deprecated
       def __sortable__
         self
       end
+      Mongoid.deprecate(self, :__sortable__)
 
       # Conversion of an object to an $inc-able value.
       #
@@ -67,23 +62,12 @@ module Mongoid
       #   1.__to_inc__
       #
       # @return [ Object ] The object.
+      # @deprecated
       def __to_inc__
         self
       end
+      Mongoid.deprecate(self, :__to_inc__)
 
-      # Checks whether conditions given in this object are known to be
-      # unsatisfiable, i.e., querying with this object will always return no
-      # documents.
-      #
-      # This method is deprecated. Mongoid now uses
-      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
-      # for backwards compatibility only. It always returns false.
-      #
-      # @return [ false ] Always false.
-      # @deprecated
-      def blank_criteria?
-        false
-      end
 
       # Do or do not, there is no try. -- Yoda.
       #
@@ -95,9 +79,11 @@ module Mongoid
       #
       # @return [ Object | nil ] The result of the method call or nil if the
       #   method does not exist.
+      # @deprecated
       def do_or_do_not(name, *args)
         send(name, *args) if name && respond_to?(name)
       end
+      Mongoid.deprecate(self, :do_or_do_not)
 
       # Get the value for an instance variable or false if it doesn't exist.
       #
@@ -133,9 +119,11 @@ module Mongoid
       #   object.multi_arged?
       #
       # @return [ false ] false.
+      # @deprecated
       def multi_arged?
         false
       end
+      Mongoid.deprecate(self, :multi_arged?)
 
       # Is the object a number?
       #
@@ -194,26 +182,29 @@ module Mongoid
       #
       # @return [ Object | nil ] The result of the method call or nil if the
       #   method does not exist. Nil if the object is frozen.
+      # @deprecated
       def you_must(name, *args)
         frozen? ? nil : do_or_do_not(name, *args)
       end
+      Mongoid.deprecate(self, :you_must)
 
       module ClassMethods
-
         # Convert the provided object to a foreign key, given the metadata key
         # contstraint.
         #
         # @example Convert the object to a fk.
         #   Object.__mongoize_fk__(association, object)
         #
-        # @param [ Association ] association The association metadata.
+        # @param [ Mongoid::Association::Relatable ] association The association metadata.
         # @param [ Object ] object The object to convert.
         #
         # @return [ Object ] The converted object.
+        # @deprecated
         def __mongoize_fk__(association, object)
           return nil if !object || object == ""
           association.convert_to_foreign_key(object)
         end
+        Mongoid.deprecate(self, :__mongoize_fk__)
 
         # Convert the object from its mongo friendly ruby type to this type.
         #
@@ -244,7 +235,4 @@ module Mongoid
   end
 end
 
-::Object.__send__(:include, Mongoid::Extensions::Object)
-::Object.extend(Mongoid::Extensions::Object::ClassMethods)
-
-::Mongoid.deprecate(Object, :blank_criteria)
+Object.include Mongoid::Extensions::Object

data/lib/mongoid/extensions/object_id.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to BSON::ObjectId.
     module ObjectId
 
       # Evolve the object id.

data/lib/mongoid/extensions/range.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
+# 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.
       #
@@ -10,9 +15,11 @@ module Mongoid
       #   range.__find_args__
       #
       # @return [ Array ] The range as an array.
+      # @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.
@@ -36,7 +43,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @example Demongoize the object.
@@ -45,8 +51,6 @@ module Mongoid
         # @param [ Hash ] object The object to demongoize.
         #
         # @return [ Range | nil ] The range, or nil if object cannot be represented as range.
-        #
-        # @note Ruby 2.6 and lower do not support endless ranges that Ruby 2.7+ support.
         def demongoize(object)
           return if object.nil?
           if object.is_a?(Hash)
@@ -56,7 +60,7 @@ module Mongoid
                 ::Range.new(hash["min"] || hash[:min],
                             hash["max"] || hash[:max],
                             hash["exclude_end"] || hash[:exclude_end])
-              rescue ArgumentError # can be removed when Ruby version >= 2.7
+              rescue ArgumentError
                 nil
               end
             end
@@ -104,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,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Regexp class.
     module Regexp
 
       module ClassMethods

data/lib/mongoid/extensions/set.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+# 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.
       #
@@ -15,8 +17,17 @@ module Mongoid
         ::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.

data/lib/mongoid/extensions/string.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
+# 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.
       #
@@ -35,19 +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.
       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.
@@ -66,9 +69,11 @@ module Mongoid
       #   "_id".mongoid_id?
       #
       # @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.
@@ -123,15 +128,18 @@ module Mongoid
         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.
+      # @deprecated
       def unconvertable_to_bson?
         @unconvertable_to_bson ||= false
       end
+      Mongoid.deprecate(self, :unconvertable_to_bson?)
 
       private
 

data/lib/mongoid/extensions/symbol.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# 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,9 +13,11 @@ module Mongoid
       #   :_id.mongoid_id?
       #
       # @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
 

data/lib/mongoid/extensions/time.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Time class.
     module Time
 
       # Mongoizes a Time into a time.
@@ -27,19 +30,6 @@ module Mongoid
 
       module ClassMethods
 
-        # Get the configured time to use when converting - either the time zone
-        # or the time.
-        #
-        # @example Get the configured time.
-        #   ::Time.configured
-        #
-        # @return [ Time ] The configured time.
-        #
-        # @deprecated
-        def configured
-          Mongoid.use_activesupport_time_zone? ? (::Time.zone || ::Time) : ::Time
-        end
-
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @example Demongoize the object.
@@ -60,15 +50,13 @@ module Mongoid
             rescue ArgumentError
               nil
             end
+          elsif object.is_a?(BSON::Timestamp)
+            ::Time.at(object.seconds)
           end
 
           return if time.nil?
 
-          if Mongoid::Config.use_activesupport_time_zone?
-            time.in_time_zone(Mongoid.time_zone)
-          else
-            time
-          end
+          time.in_time_zone(Mongoid.time_zone)
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -83,7 +71,7 @@ module Mongoid
         def mongoize(object)
           return if object.blank?
           begin
-            time = object.__mongoize_time__
+            time = object.respond_to?(:__mongoize_time__) ? object.__mongoize_time__ : nil
           rescue ArgumentError
             return
           end

data/lib/mongoid/extensions/time_with_zone.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to ActiveSupport::TimeWithZone class.
     module TimeWithZone
 
       # Mongoizes an ActiveSupport::TimeWithZone into a time.
@@ -26,9 +29,10 @@ module Mongoid
       end
 
       # This code is copied from Time class extension in bson-ruby gem. It
-      # should be removed from here when added to bson-ruby.
-      # See https://jira.mongodb.org/browse/RUBY-2846.
+      # should be removed from here when the minimum BSON version is 5+.
+      # See https://jira.mongodb.org/browse/MONGOID-5491.
       def _bson_to_i
+        return super if defined?(super)
         # Workaround for JRuby's #to_i rounding negative timestamps up
         # rather than down (https://github.com/jruby/jruby/issues/6104)
         if BSON::Environment.jruby?

data/lib/mongoid/extensions/true_class.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to TrueClass
     module TrueClass
-
       # Get the value of the object as a mongo friendly sort value.
       #
       # @example Get the object as sort criteria.
       #   object.__sortable__
       #
       # @return [ Integer ] 1.
+      # @deprecated
       def __sortable__
         1
       end
+      Mongoid.deprecate(self, :__sortable__)
 
       # Is the passed value a boolean?
       #
@@ -32,4 +35,4 @@ module Mongoid
   end
 end
 
-::TrueClass.__send__(:include, Mongoid::Extensions::TrueClass)
+TrueClass.include Mongoid::Extensions::TrueClass

data/lib/mongoid/extensions.rb

@@ -1,36 +1,5 @@
 # frozen_string_literal: true
-
-class BSON::ObjectId
-  alias :bson_ruby_as_json :as_json
-
-  # Return a string representation of the object id for use in
-  # application-level JSON serialization.
-  #
-  # @example Get the object id as a JSON-serializable object.
-  #   object_id.as_json
-  #
-  # @return [ String ] The object id as a string.
-  def as_json(*args)
-    if Mongoid.object_id_as_json_oid
-      { "$oid" => to_s }
-    else
-      bson_ruby_as_json(*args)
-    end
-  end
-end
-
-class BSON::Document
-  # We need to override this as ActiveSupport creates a new Object, instead of a new Hash
-  # see https://github.com/rails/rails/commit/f1bad130d0c9bd77c94e43b696adca56c46a66aa
-  def transform_keys
-    return enum_for(:transform_keys) unless block_given?
-    result = {}
-    each_key do |key|
-      result[yield(key)] = self[key]
-    end
-    result
-  end
-end
+# rubocop:todo all
 
 require "mongoid/extensions/array"
 require "mongoid/extensions/big_decimal"
@@ -48,6 +17,7 @@ require "mongoid/extensions/nil_class"
 require "mongoid/extensions/object"
 require "mongoid/extensions/object_id"
 require "mongoid/extensions/range"
+require "mongoid/extensions/raw_value"
 require "mongoid/extensions/regexp"
 require "mongoid/extensions/set"
 require "mongoid/extensions/string"