MONGOID-5676 [Monkey Patch Removal] Remove Time#configured (#5716)

* Removes Time#configured monkey patch.

* Set UTC timezone by default

* More spec cleanup

* Re-add error check

* add release notes for removal of `Time.configured`

---------

Co-authored-by: Jamis Buck <[email protected]>

Author: johnnyshields

docs/release-notes/mongoid-9.0.txt

@@ -403,6 +403,46 @@ There are also rake tasks available, for convenience:
   $ rake mongoid:db:remove_search_indexes
 
 
+``Time.configured`` has been removed
+------------------------------------
+
+``Time.configured`` returned either the time object wrapping the configured
+time zone, or the standard Ruby ``Time`` class. This allowed you to query
+a time value even if no time zone had been configured.
+
+Mongoid now requires that you set a time zone if you intend to do
+anything with time values (including using timestamps in your documents).
+Any uses of ``Time.configured`` must be replaced with ``Time.zone``.
+
+... code-block:: ruby
+
+  # before:
+  puts Time.configured.now
+
+  # after:
+  puts Time.zone.now
+
+  # or, better for finding the current Time specifically:
+  puts Time.current
+
+If you do not set a time zone, you will see errors in your code related
+to ``nil`` values. If you are using Rails, the default time zone is already
+set to UTC. If you are not using Rails, you may set a time zone at the start
+of your program like this:
+
+... code-block:: ruby
+
+  Time.zone = 'UTC'
+
+This will set the time zone to UTC. You can see all available time zone names
+by running the following command:
+
+... code-block:: bash
+
+$ ruby -ractive_support/values/time_zone \
+  -e 'puts ActiveSupport::TimeZone::MAPPING.keys'
+
+
 Bug Fixes and Improvements
 --------------------------
 

lib/mongoid/criteria/queryable/extensions/date.rb

@@ -26,7 +26,7 @@ def __evolve_date__
           #
           # @return [ Time | ActiveSupport::TimeWithZone ] The date as a local time.
           def __evolve_time__
-            ::Time.configured.local(year, month, day)
+            ::Time.zone.local(year, month, day)
           end
 
           module ClassMethods

lib/mongoid/extensions/array.rb

@@ -52,7 +52,7 @@ def __mongoize_object_id__
       #   configured default time zone corresponding to date/time components
       #   in this array.
       def __mongoize_time__
-        ::Time.configured.local(*self)
+        ::Time.zone.local(*self)
       end
 
       # Is the array a set of multiple arguments in a method?

lib/mongoid/extensions/date.rb

@@ -17,7 +17,7 @@ module Date
       #   configured default time zone corresponding to local midnight of
       #   this date.
       def __mongoize_time__
-        ::Time.configured.local(year, month, day)
+        ::Time.zone.local(year, month, day)
       end
 
       # Turn the object from the ruby type we deal with to a Mongo friendly

lib/mongoid/extensions/float.rb

@@ -14,7 +14,7 @@ module Float
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       def __mongoize_time__
-        ::Time.configured.at(self)
+        ::Time.zone.at(self)
       end
 
       # Is the float a number?

lib/mongoid/extensions/integer.rb

@@ -14,7 +14,7 @@ module Integer
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       def __mongoize_time__
-        ::Time.configured.at(self)
+        ::Time.zone.at(self)
       end
 
       # Is the integer a number?

lib/mongoid/extensions/string.rb

@@ -40,19 +40,17 @@ def __mongoize_object_id__
       #   "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.

lib/mongoid/extensions/time.rb

@@ -30,19 +30,6 @@ def mongoize
 
       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
-          ::Time.zone || ::Time
-        end
-
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @example Demongoize the object.

lib/mongoid/timestamps/created.rb

@@ -24,9 +24,9 @@ module Created
       #   person.set_created_at
       def set_created_at
         if !timeless? && !created_at
-          time = Time.configured.now
-          self.updated_at = time if is_a?(Updated) && !updated_at_changed?
-          self.created_at = time
+          now = Time.current
+          self.updated_at = now if is_a?(Updated) && !updated_at_changed?
+          self.created_at = now
         end
         clear_timeless_option
       end

lib/mongoid/timestamps/updated.rb

@@ -25,7 +25,7 @@ module Updated
       #   person.set_updated_at
       def set_updated_at
         if able_to_set_updated_at?
-          self.updated_at = Time.configured.now unless updated_at_changed?
+          self.updated_at = Time.current unless updated_at_changed?
         end
 
         clear_timeless_option