MONGOID-5246 Flip feature flags for 8.0 (#5177)

* MONGOID-5246 Flip feature flags for 8.0

* legacy_pluck_distinct

* show examples to change the values

* legacy_pluck_distinct

* legacy_pluck_distinct

* pluck distinct

* account for bigdecimal flag

* RUBY-2928

* use config_override

* fix findable spec

Co-authored-by: Oleg Pudeyev <[email protected]>

Author: p-mongo

docs/reference/configuration.txt

@@ -282,13 +282,13 @@ for details on driver options.
       # Product.where(impossible_condition: true).sum(:price)
       #
       # ... return nil instead of 0.
-      # (default: true in Mongoid 7, will change to false in Mongoid 8)
-      broken_aggregables: true
+      # (default: false)
+      #broken_aggregables: true
 
       # Ignore aliased fields in embedded documents when performing pluck and
       # distinct operations, for backwards compatibility.
-      # (default: true in Mongoid 7, will change to false in Mongoid 8)
-      broken_alias_handling: true
+      # (default: false)
+      #broken_alias_handling: true
 
       # Maintain broken `and' method behavior that existed in Mongoid 7.3
       # and earlier for backwards compatibility: in some situations, conditions
@@ -310,13 +310,13 @@ for details on driver options.
       # This is obviously incorrect as the {"$in"=>[2021]} clause is lost.
       # Notice that the clause is only lost when both clauses are added using
       # the #and method.
-      # (default: true in Mongoid 7, will change to false in Mongoid 8)
-      broken_and: true
+      # (default: false)
+      #broken_and: true
 
       # When exiting a nested `with_scope' block, set the current scope to
       # nil instead of the parent scope for backwards compatibility.
-      # (default: true in Mongoid 7, will change to false in Mongoid 8)
-      broken_scoping: true
+      # (default: false)
+      #broken_scoping: true
 
       # Maintain broken update behavior in some cases for backwards
       # compatibility.
@@ -335,8 +335,8 @@ for details on driver options.
       # In Mongoid 7.3 and earlier, canvas.palette would be nil when we would
       # expect it to be palette. Set this option to true to keep this behavior,
       # set the option to false to perform the second update correctly.
-      # (default: true in Mongoid 7, will change to false in Mongoid 8)
-      broken_updates: true
+      # (default: false)
+      #broken_updates: true
 
       # Time objects in Ruby have nanosecond precision, whereas MongoDB server
       # can only store times with millisecond precision. Set this option to
@@ -347,9 +347,8 @@ for details on driver options.
       # which documents are being queried. Setting this option to false will
       # produce different results for queries on embedded associations that
       # are already loaded into memory vs queries on unloaded associations and
-      # top-level models. (default: false in Mongoid 7, will change to true
-      # in Mongoid 8).
-      compare_time_by_ms: false
+      # top-level models. (default: true)
+      #compare_time_by_ms: false
 
       # Set the global discriminator key. (default: "_type")
       discriminator_key: "_type"
@@ -370,17 +369,17 @@ for details on driver options.
       # 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.
-      # (default: true in Mongoid 7, will change to false in Mongoid 8)
-      legacy_pluck_distinct: true
+      # (default: false)
+      #legacy_pluck_distinct: true
 
       # 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
       # and from Ruby's behavior of === on simple object instances regardless
       # of the value of this option.
-      # (default: true in Mongoid 7, will change to false in Mongoid 8)
-      legacy_triple_equals: true
+      # (default: false)
+      #legacy_triple_equals: true
 
       # Set the Mongoid and Ruby driver log levels when Mongoid is not using
       # Ruby on Rails logger instance. (default: :info)
@@ -393,8 +392,8 @@ for details on driver options.
       # 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: true in Mongoid 7, will change to false in Mongoid 8)
-      object_id_as_json_oid: true
+      # (default: false)
+      #object_id_as_json_oid: true
 
       # Preload all models in development, needed when models use
       # inheritance. (default: false)

docs/release-notes/mongoid-7.5.txt

@@ -18,6 +18,27 @@ please consult GitHub releases for detailed release notes and JIRA for
 the complete list of issues fixed in each release, including bug fixes.
 
 
+Default Option Values Changed
+-----------------------------
+
+**Breaking change:** The following options have had their default values
+changed in Mongoid 7.5:
+
+- ``:broken_aggregables`` => ``false``
+- ``:broken_alias_handling`` => ``false``
+- ``:broken_and`` => ``false``
+- ``:broken_scoping`` => ``false``
+- ``:broken_updates`` => ``false``
+- ``:compare_time_by_ms`` => ``true``
+- ``:legacy_pluck_distinct`` => ``false``
+- ``:legacy_triple_equals`` => ``false``
+- ``:map_big_decimal_to_decimal128`` => ``true``
+- ``:object_id_as_json_oid`` => ``false``
+
+Please refer to :ref:`configuration option <configuration-options>` for
+the description and effects of each of these options.
+
+
 Order of Callback Invocation
 ----------------------------
 

lib/mongoid/config.rb

@@ -75,44 +75,44 @@ module Config
     option :use_utc, default: false
 
     # Store BigDecimals as Decimal128s instead of strings in the db.
-    option :map_big_decimal_to_decimal128, default: false
+    option :map_big_decimal_to_decimal128, default: true
 
     # Update embedded documents correctly when setting it, unsetting it
     # and resetting it. See MONGOID-5206 and MONGOID-5240 for more details.
-    option :broken_updates, default: true
+    option :broken_updates, default: false
 
     # Maintain legacy behavior of === on Mongoid documents, which returns
     # true in a number of cases where Ruby's === implementation would
     # return false.
-    option :legacy_triple_equals, default: true
+    option :legacy_triple_equals, default: false
 
     # When exiting a nested `with_scope' block, set the current scope to
     # nil instead of the parent scope for backwards compatibility.
-    option :broken_scoping, default: true
+    option :broken_scoping, default: false
 
     # Maintain broken behavior of sum over empty result sets for backwards
     # compatibility.
-    option :broken_aggregables, default: true
+    option :broken_aggregables, default: false
 
     # Ignore aliased fields in embedded documents when performing pluck and
     # distinct operations, for backwards compatibility.
-    option :broken_alias_handling, default: true
+    option :broken_alias_handling, default: false
 
     # Maintain broken `and' behavior when using the same operator on the same
     # field multiple times for backwards compatibility.
-    option :broken_and, default: true
+    option :broken_and, default: false
 
     # Use millisecond precision when comparing Time objects with the _matches?
     # function.
-    option :compare_time_by_ms, default: false
+    option :compare_time_by_ms, default: true
 
     # Use bson-ruby's implementation of as_json for BSON::ObjectId instead of
     # the one monkey-patched into Mongoid.
-    option :object_id_as_json_oid, default: true
+    option :object_id_as_json_oid, default: false
 
     # Maintain legacy behavior of pluck and distinct, which does not
     # demongoize the values on returning them.
-    option :legacy_pluck_distinct, default: true
+    option :legacy_pluck_distinct, default: false
 
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.

spec/integration/matcher_operator_data/type_decimal.yml

@@ -29,12 +29,13 @@
   matches: false
   min_server_version: 3.4
 
-- name: BigDecimal field - does not match
+# Requires :map_big_decimal_to_decimal128 option to be true.
+- name: BigDecimal field - matches
   document:
     big_decimal_field: !ruby/object:BigDecimal
       18:0.42e2
   query:
     big_decimal_field:
       $type: 19
-  matches: false
+  matches: true
   min_server_version: 3.4

spec/mongoid/config_spec.rb

@@ -267,70 +267,70 @@
 
   context 'when setting the map_big_decimal_to_decimal128 option in the config' do
     let(:option) { :map_big_decimal_to_decimal128 }
-    let(:default) { false }
+    let(:default) { true }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the broken_updates option in the config' do
     let(:option) { :broken_updates }
-    let(:default) { true }
+    let(:default) { false }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the legacy_triple_equals option in the config' do
     let(:option) { :legacy_triple_equals }
-    let(:default) { true }
+    let(:default) { false }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the broken_scoping option in the config' do
     let(:option) { :broken_scoping }
-    let(:default) { true }
+    let(:default) { false }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the broken_aggregables option in the config' do
     let(:option) { :broken_aggregables }
-    let(:default) { true }
+    let(:default) { false }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the broken_alias_handling option in the config' do
     let(:option) { :broken_alias_handling }
-    let(:default) { true }
+    let(:default) { false }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the broken_and option in the config' do
     let(:option) { :broken_and }
-    let(:default) { true }
+    let(:default) { false }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the compare_time_by_ms option in the config' do
     let(:option) { :compare_time_by_ms }
-    let(:default) { false }
+    let(:default) { true }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the object_id_as_json_oid option in the config' do
     let(:option) { :object_id_as_json_oid }
-    let(:default) { true }
+    let(:default) { false }
 
     it_behaves_like "a config option"
   end
 
   context 'when setting the legacy_pluck_distinct option in the config' do
     let(:option) { :legacy_pluck_distinct }
-    let(:default) { true }
+    let(:default) { false }
 
     it_behaves_like "a config option"
   end

spec/mongoid/contextual/mongo_spec.rb

@@ -559,8 +559,22 @@
       context "when legacy_pluck_distinct is set" do
         config_override :legacy_pluck_distinct, true
 
-        it "returns the non-demongoized distinct field values" do
-          expect(context.distinct(:sales).sort).to eq([ "1E2", "2E3" ])
+        context 'when storing BigDecimal as string' do
+          config_override :map_big_decimal_to_decimal128, false
+
+          it "returns the non-demongoized distinct field values" do
+            expect(context.distinct(:sales).sort).to eq([ "1E2", "2E3" ])
+          end
+        end
+
+        context 'when storing BigDecimal as decimal128' do
+          config_override :map_big_decimal_to_decimal128, true
+
+          it "returns the non-demongoized distinct field values" do
+            pending 'RUBY-2928'
+
+            expect(context.distinct(:sales).sort).to eq([ BSON::Decimal128.new("1E2"), BSON::Decimal128.new("2E3") ])
+          end
         end
       end
 

spec/mongoid/criteria/queryable/extensions/big_decimal_spec.rb

@@ -7,6 +7,7 @@
   describe ".evolve" do
 
     context 'when map_big_decimal_to_decimal128 is false' do
+      config_override :map_big_decimal_to_decimal128, false
 
       context "when provided a big decimal" do
 
@@ -62,14 +63,7 @@
     end
 
     context 'when map_big_decimal_to_decimal128 is true' do
-
-      before do
-        Mongoid.map_big_decimal_to_decimal128 = true
-      end
-
-      after do
-        Mongoid.map_big_decimal_to_decimal128 = false
-      end
+      config_override :map_big_decimal_to_decimal128, true
 
       context "when provided a big decimal" do
 

spec/mongoid/criteria/queryable/selector_spec.rb

@@ -387,8 +387,20 @@ def localized?
             selector.send(method, "key", array)
           end
 
-          it "serializes each element in the array" do
-            expect(selector["key"]).to eq([ big_one.to_s, big_two.to_s ])
+          context 'when serializing bigdecimal to string' do
+            config_override :map_big_decimal_to_decimal128, false
+
+            it "serializes each element in the array" do
+              expect(selector["key"]).to eq([ big_one.to_s, big_two.to_s ])
+            end
+          end
+
+          context 'when serializing bigdecimal to decimal128' do
+            config_override :map_big_decimal_to_decimal128, true
+
+            it "serializes each element in the array" do
+              expect(selector["key"]).to eq([ BSON::Decimal128.new(big_one), BSON::Decimal128.new(big_two)])
+            end
           end
         end
       end