Merge remote-tracking branch 'remotes/origin/master' into MONGOID-5136-super-touch

Author: johnnyshields

docs/reference/compatibility.txt

@@ -31,7 +31,7 @@ specified Mongoid versions.
    :class: compatibility-large no-padding
 
    * - Mongoid
-     - Driver 2.14-2.10
+     - Driver 2.15-2.10
      - Driver 2.9-2.7
 
    * - 7.3

lib/mongoid/criteria/queryable/selectable.rb

@@ -552,7 +552,7 @@ def not(*criteria)
               end
               _mongoid_expand_keys(new_s).each do |k, v|
                 k = k.to_s
-                if c.selector[k] || k[0] == ?$
+                if c.selector[k] || k.start_with?('$')
                   c = c.send(:__multi__, [{'$nor' => [{k => v}]}], '$and')
                 else
                   if v.is_a?(Hash)
@@ -831,7 +831,7 @@ def expr_query(criterion)
           clone.tap do |query|
             normalized.each do |field, value|
               field_s = field.to_s
-              if field_s[0] == ?$
+              if field_s.start_with?('$')
                 # Query expression-level operator, like $and or $where
                 query.add_operator_expression(field_s, value)
               else

lib/mongoid/criteria/queryable/storable.rb

@@ -37,7 +37,7 @@ def add_field_expression(field, value)
             raise ArgumentError, "Field must be a string: #{field}"
           end
 
-          if field[0] == ?$
+          if field.start_with?('$')
             raise ArgumentError, "Field cannot be an operator (i.e. begin with $): #{field}"
           end
 
@@ -47,7 +47,7 @@ def add_field_expression(field, value)
             if value.is_a?(Hash) && selector[field].is_a?(Hash) &&
               value.keys.all? { |key|
                 key_s = key.to_s
-                key_s[0] == ?$ && !selector[field].key?(key_s)
+                key_s.start_with?('$') && !selector[field].key?(key_s)
               }
             then
               # Multiple operators can be combined on the same field by
@@ -184,7 +184,7 @@ def add_operator_expression(operator, op_expr)
             raise ArgumentError, "Operator must be a string: #{operator}"
           end
 
-          unless operator[0] == ?$
+          unless operator.start_with?('$')
             raise ArgumentError, "Operator must begin with $: #{operator}"
           end
 
@@ -219,7 +219,7 @@ def add_one_expression(field, value)
             raise ArgumentError, "Field must be a string: #{field}"
           end
 
-          if field[0] == ?$
+          if field.start_with?('$')
             add_operator_expression(field, value)
           else
             add_field_expression(field, value)

lib/mongoid/extensions.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-class BSON::ObjectId
-  def as_json(options = nil)
-    { "$oid" => to_s }
-  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

lib/mongoid/query_cache.rb

@@ -4,8 +4,14 @@ module Mongoid
 
   # A cache of database queries on a per-request basis.
   module QueryCache
-    class << self
+    # @api private
+    LEGACY_WARNING = <<~DOC
+      You are using the legacy Mongoid query cache which has known issues.
+      Please upgrade the `mongo' gem to at least 2.14.0 to use the improved driver query cache.
+      Refer to: https://docs.mongodb.com/mongoid/current/tutorials/mongoid-queries/#the-improved-driver-query-cache
+    DOC
 
+    class << self
       # Get the cached queries.
       #
       # @example Get the cached queries from the current thread.
@@ -73,6 +79,10 @@ def cache(&block)
         if defined?(Mongo::QueryCache)
           Mongo::QueryCache.cache(&block)
         else
+          @legacy_query_cache_warned ||= begin
+            Mongoid.logger.warn(LEGACY_WARNING)
+            true
+          end
           enabled = QueryCache.enabled?
           QueryCache.enabled = true
           begin

spec/mongoid/extensions_spec.rb

@@ -2,20 +2,6 @@
 
 require "spec_helper"
 
-describe BSON::ObjectId do
-
-  describe "#as_json" do
-
-    let(:object_id) do
-      described_class.new
-    end
-
-    it "returns the $oid plus string" do
-      expect(object_id.as_json).to eq("$oid" => object_id.to_s)
-    end
-  end
-end
-
 describe BSON::Document do
 
   describe "#symbolize_keys" do

spec/mongoid/query_cache_spec.rb

@@ -23,10 +23,27 @@
     SessionRegistry.instance.verify_sessions_ended!
   end
 
+  let(:reset_legacy_qc_warning) do
+    begin
+      Mongoid::QueryCache.remove_instance_variable('@legacy_query_cache_warned')
+    rescue NameError
+      # raised if the instance variable wasn't set
+    end
+  end
+
   describe '#cache' do
     context 'with driver query cache' do
       min_driver_version '2.14'
 
+      it 'does not log a deprecation warning' do
+        reset_legacy_qc_warning
+
+        expect_any_instance_of(Logger).to_not receive(:warn).with(
+          described_class::LEGACY_WARNING
+        )
+        described_class.cache { }
+      end
+
       context 'when query cache is not enabled' do
         before do
           Mongoid::QueryCache.enabled = false
@@ -179,6 +196,13 @@
     context 'with mongoid query cache' do
       max_driver_version '2.13'
 
+      it 'logs a deprecation warning' do
+        reset_legacy_qc_warning
+
+        expect_any_instance_of(Logger).to receive(:warn).with(described_class::LEGACY_WARNING)
+        described_class.cache { }
+      end
+
       context 'when query cache is not enabled' do
         before do
           Mongoid::QueryCache.enabled = false