MONGOID-5509: Deprecate all feature flags which were introduced in Mongoid 7.x (#5489)

* Deprecate the use_activesupport_time_zone_deprecated config option.

* Typo

* Mongoid 8.1 should deprecate all feature flags which were introduced in the 7.x series, with intent to remove them in Mongoid 9.0.

---------

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

Author: johnnyshields

docs/reference/configuration.txt

@@ -280,7 +280,7 @@ for details on driver options.
       # error. (default: true)
       belongs_to_required_by_default: true
 
-      # Maintain broken behavior of sum over empty result sets for backwards
+      # (Deprecated) Maintain broken behavior of sum over empty result sets for backwards
       # compatibility. When calculating a sum on a field with a null context,
       # for example:
       #
@@ -297,12 +297,12 @@ for details on driver options.
       # (default: false)
       #broken_aggregables: true
 
-      # Ignore aliased fields in embedded documents when performing pluck and
+      # (Deprecated) Ignore aliased fields in embedded documents when performing pluck and
       # distinct operations, for backwards compatibility.
       # (default: false)
       #broken_alias_handling: true
 
-      # Maintain broken `and' method behavior that existed in Mongoid 7.3
+      # (Deprecated) Maintain broken `and' method behavior that existed in Mongoid 7.3
       # and earlier for backwards compatibility: in some situations, conditions
       # already present in a Criteria object would be replaced by newer
       # conditions when `and' method is used instead of the new conditions
@@ -325,12 +325,12 @@ for details on driver options.
       # (default: false)
       #broken_and: true
 
-      # When exiting a nested `with_scope' block, set the current scope to
+      # (Deprecated) When exiting a nested `with_scope' block, set the current scope to
       # nil instead of the parent scope for backwards compatibility.
       # (default: false)
       #broken_scoping: true
 
-      # Maintain broken update behavior in some cases for backwards
+      # (Deprecated) Maintain broken update behavior in some cases for backwards
       # compatibility.
       #
       # In Mongoid 7.3 and earlier, when assigning a value to an embedded
@@ -350,7 +350,7 @@ for details on driver options.
       # (default: false)
       #broken_updates: true
 
-      # Time objects in Ruby have nanosecond precision, whereas MongoDB server
+      # (Deprecated) Time objects in Ruby have nanosecond precision, whereas MongoDB server
       # can only store times with millisecond precision. Set this option to
       # true to truncate times to millisecond precision when performing
       # queries on already loaded embedded associations (this is also called
@@ -383,13 +383,13 @@ for details on driver options.
       # to parent contexts by default. (default: false)
       join_contexts: false
 
-      # When this flag is true, the attributes method on a document will return
+      # (Deprecated) When this flag is true, the attributes method on a document will return
       # a BSON::Document when that document is retrieved from the database, and
       # a Hash otherwise. When this flag is false, the attributes method will
       # always return a Hash. (default: false)
       #legacy_attributes: true
 
-      # Maintain legacy behavior of pluck and distinct, which does not demongoize
+      # (Deprecated) Maintain legacy behavior of pluck and distinct, which does not demongoize
       # values on returning them. Setting this option to false will cause
       # pluck and distinct to return demongoized values. Setting this option to
       # false will also allow retrieving *_translations fields from pluck and
@@ -409,7 +409,7 @@ for details on driver options.
       # (default: false)
       #legacy_readonly: true
 
-      # Maintain legacy behavior of === on Mongoid document classes, which
+      # (Deprecated) Maintain legacy behavior of === on Mongoid document classes, which
       # returns true in a number of cases where Ruby's === implementation would
       # return false. Note that the behavior of === on Mongoid document
       # instances differs from both the behavior of === on document classes
@@ -426,13 +426,13 @@ for details on driver options.
       # as a BSON::Decimal128 instead of a string. (default: true)
       #map_big_decimal_to_decimal128: true
 
-      # Force ``BSON::ObjectId#as_json`` method to return the hash
+      # (Deprecated) Force ``BSON::ObjectId#as_json`` method to return the hash
       # { "$oid" => id.to_s }. When this option is false, and bson-ruby 5
       # is used, the return value will be the hexadecimal ObjectId string only.
       # (default: false)
       #object_id_as_json_oid: true
 
-      # When chaining the same operators that use the same field, setting this
+      # (Deprecated) When chaining the same operators that use the same field, setting this
       # feature flag to false will cause those operators to be combined using an
       # and. Setting this feature flag to true will cause the later chained
       # operators to overwrite the earlier ones. (default: false)

lib/mongoid/config.rb

@@ -398,13 +398,28 @@ def global_client
       end
     end
 
-    module DeprecateUseActivesupportTimeZone
-      def use_activesupport_time_zone=(value)
-        Mongoid::Warnings.warn_use_activesupport_time_zone_deprecated
-        super
+    module DeprecatedOptions
+      OPTIONS = %i[ use_activesupport_time_zone
+                    broken_aggregables
+                    broken_alias_handling
+                    broken_and
+                    broken_scoping
+                    broken_updates
+                    compare_time_by_ms
+                    legacy_attributes
+                    legacy_pluck_distinct
+                    legacy_triple_equals
+                    object_id_as_json_oid
+                    overwrite_chained_operators ]
+
+      OPTIONS.each do |option|
+        define_method(:"#{option}=") do |value|
+          Mongoid::Warnings.send(:"warn_#{option}_deprecated")
+          super(value)
+        end
       end
     end
 
-    prepend DeprecateUseActivesupportTimeZone
+    prepend DeprecatedOptions
   end
 end

lib/mongoid/warnings.rb

@@ -25,7 +25,18 @@ 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 :use_activesupport_time_zone_deprecated, 'Config option :use_activesupport_time_zone is deprecated and should be removed from your config. It will always be true beginning in Mongoid 9.0.'
+    warning :broken_aggregables_deprecated, 'Config option :broken_aggregables is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_alias_handling_deprecated, 'Config option :broken_alias_handling is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_and_deprecated, 'Config option :broken_and is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_scoping_deprecated, 'Config option :broken_scoping is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_updates_deprecated, 'Config option :broken_updates is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :compare_time_by_ms_deprecated, 'Config option :compare_time_by_ms is deprecated. It will always be true beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_attributes_deprecated, 'Config option :legacy_attributes is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_pluck_distinct_deprecated, 'Config option :legacy_pluck_distinct is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_triple_equals_deprecated, 'Config option :legacy_triple_equals is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :object_id_as_json_oid_deprecated, 'Config option :object_id_as_json_oid is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :overwrite_chained_operators_deprecated, 'Config option :overwrite_chained_operators is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
     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

@@ -937,29 +937,45 @@ def self.logger
     end
   end
 
-  describe '#use_activesupport_time_zone=' do
+  describe 'deprecations' do
+    { use_activesupport_time_zone: true,
+      broken_aggregables: false,
+      broken_alias_handling: false,
+      broken_and: false,
+      broken_scoping: false,
+      broken_updates: false,
+      compare_time_by_ms: true,
+      legacy_attributes: false,
+      legacy_pluck_distinct: false,
+      legacy_triple_equals: false,
+      object_id_as_json_oid: false,
+      overwrite_chained_operators: false }.each do |option, default|
+
+      context ":#{option} option" do
 
-    before do
-      Mongoid::Warnings.class_eval do
-        @use_activesupport_time_zone_deprecated = false
-      end
-    end
+        before do
+          Mongoid::Warnings.class_eval do
+            instance_variable_set(:"@#{option}_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
+        let(:matcher) do
+          /Config option :#{option}.+\. It will always be #{default} 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 true' do
+          it 'gives a deprecation warning' do
+            expect(Mongoid.logger).to receive(:warn).with(matcher)
+            described_class.send(:"#{option}=", 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
+        context 'when set to false' do
+          it 'gives a deprecation warning' do
+            expect(Mongoid.logger).to receive(:warn).with(matcher)
+            described_class.send(:"#{option}=", false)
+          end
+        end
       end
     end
   end