MONGOID-5490: Deprecate :use_activesupport_time_zone (#5488)

* Deprecate the use_activesupport_time_zone_deprecated config option.

* Typo

* Update config.rb

* Update mongoid-8.1.txt

---------

Co-authored-by: shields <[email protected]>

Author: johnnyshields

docs/reference/configuration.txt

@@ -450,7 +450,7 @@ for details on driver options.
       # existing method. (default: false)
       scope_overwrite_exception: false
 
-      # Use ActiveSupport's time zone in time operations instead of
+      # (Deprecated) Use ActiveSupport's time zone in time operations instead of
       # the Ruby default time zone. See the time zone section below for
       # further information. (default: true)
       use_activesupport_time_zone: true
@@ -463,6 +463,7 @@ for details on driver options.
       # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
       # indexes in the background by default. (default: false)
       background_indexing: false
+
     # Configure driver-specific options. (optional)
     driver_options:
       # When this flag is turned off, inline options will be correctly
@@ -768,7 +769,11 @@ Note that MongoDB stores all times in UTC without time zone information.
 
 Mongoid offers the following time zone-related configuration options:
 
-- ``use_activesupport_time_zone``: If true, prefer to work with times using
+- ``use_activesupport_time_zone``:
+  This option is deprecated and will be removed in Mongoid 9.0,
+  always behaving as true.
+
+  If true (default), prefer to work with times using
   ``ActiveSupport::TimeWithZone``. Values in fields of type ``Time``
   will be returned as instances of ``ActiveSupport::TimeWithZone``.
   When parsing times without time zone information (such as when
@@ -787,6 +792,7 @@ Mongoid offers the following time zone-related configuration options:
   Also note that Mongoid may still utilize both ``Time`` and
   ``ActiveSupport::TimeWithZone`` classes internally, as appropriate,
   regardless of the ``use_activesupport_time_zone`` setting.
+
 - ``use_utc``:
   If true, times stored in MongoDB will be returned in UTC.
   If false, times stored in MongoDB will be returned in local time

docs/release-notes/mongoid-8.1.txt

@@ -17,6 +17,16 @@ The complete list of releases is available `on GitHub
 please consult GitHub releases for detailed release notes and JIRA for
 the complete list of issues fixed in each release, including bug fixes.
 
+
+Deprecated ``use_activesupport_time_zone`` config option
+--------------------------------------------------------
+
+The config option ``use_activesupport_time_zone`` has been deprecated.
+Beginning in Mongoid 9.0, it will be ignored and always behave as true.
+Since ``use_activesupport_time_zone`` currently defaults to true, it is
+safe to remove from your config file at this time.
+
+
 Added ``load_async`` method on ``Criteria`` to asynchronously load documents
 ----------------------------------------------------------------------------
 

lib/mongoid/config.rb

@@ -72,6 +72,7 @@ module Config
 
     # Use ActiveSupport's time zone in time operations instead of the
     # Ruby default time zone.
+    # @deprecated
     option :use_activesupport_time_zone, default: true
 
     # Return stored times as UTC.
@@ -396,5 +397,14 @@ def global_client
         client
       end
     end
+
+    module DeprecateUseActivesupportTimeZone
+      def use_activesupport_time_zone=(value)
+        Mongoid::Warnings.warn_use_activesupport_time_zone_deprecated
+        super
+      end
+    end
+
+    prepend DeprecateUseActivesupportTimeZone
   end
 end

lib/mongoid/extensions/time.rb

@@ -34,6 +34,8 @@ module ClassMethods
         #   ::Time.configured
         #
         # @return [ Time ] The configured time.
+        #
+        # @deprecated
         def configured
           Mongoid.use_activesupport_time_zone? ? (::Time.zone || ::Time) : ::Time
         end

lib/mongoid/warnings.rb

@@ -25,6 +25,7 @@ def warning(id, message)
     warning :as_json_compact_deprecated, '#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.'
     warning :symbol_type_deprecated, 'The BSON Symbol type is deprecated by MongoDB. Please use String or StringifiedSymbol field types instead of the Symbol field type.'
     warning :legacy_readonly, 'The readonly! method will only mark the document readonly when the legacy_readonly feature flag is switched off.'
+    warning :use_activesupport_time_zone_deprecated, 'Config option :use_activesupport_time_zone is deprecated and should be removed from your config. It will be always true beginning in Mongoid 9.0.'
     warning :mutable_ids, 'In Mongoid 9.0 the _id field will be immutable. In earlier versions of 8.x, mutating the _id field was supported inconsistently. Prepare your code for 9.0 by setting Mongoid::Config.immutable_ids to true.'
   end
 end

spec/mongoid/config_spec.rb

@@ -936,4 +936,31 @@ def self.logger
       end
     end
   end
+
+  describe '#use_activesupport_time_zone=' do
+
+    before do
+      Mongoid::Warnings.class_eval do
+        @use_activesupport_time_zone_deprecated = false
+      end
+    end
+
+    let(:warning) do
+      "Config option :use_activesupport_time_zone is deprecated and should be removed from your config. It will be always true beginning in Mongoid 9.0."
+    end
+
+    context 'when set to true' do
+      it 'does not give a deprecation warning' do
+        expect(Mongoid.logger).to receive(:warn).with(warning)
+        described_class.use_activesupport_time_zone = true
+      end
+    end
+
+    context 'when set to false' do
+      it 'gives a deprecation warning' do
+        expect(Mongoid.logger).to receive(:warn).with(warning)
+        described_class.use_activesupport_time_zone = false
+      end
+    end
+  end
 end