RUBY-5651 Deprecate for_js API (#5721)

Author: comandeo-mongo

docs/release-notes/mongoid-9.0.txt

@@ -18,6 +18,12 @@ please consult GitHub releases for detailed release notes and JIRA for
 the complete list of issues fixed in each release, including bug fixes.
 
 
+``for_js`` method is deprecated
+-------------------------------
+
+The ``for_js`` method is deprecated and will be removed in Mongoid 10.0.
+
+
 Deprecated options removed
 --------------------------
 

lib/mongoid/contextual/mongo.rb

@@ -78,6 +78,8 @@ def count(options = {}, &block)
         if valid_for_count_documents?
           view.count_documents(options)
         else
+          # TODO: Remove this when we remove the deprecated for_js API.
+          # https://jira.mongodb.org/browse/MONGOID-5681
           view.count(options)
         end
       end
@@ -1049,6 +1051,9 @@ def process_raw_docs(raw_docs, limit)
       #
       # @return [ true | false ] whether or not the current context
       #   excludes a `$where` operator.
+      #
+      # TODO: Remove this method when we remove the deprecated for_js API.
+      # https://jira.mongodb.org/browse/MONGOID-5681
       def valid_for_count_documents?(hash = view.filter)
         # Note that `view.filter` is a BSON::Document, and all keys in a
         # BSON::Document are strings; we don't need to worry about symbol

lib/mongoid/criteria.rb

@@ -41,6 +41,8 @@ class Criteria
     include Clients::Sessions
     include Options
 
+    Mongoid.deprecate(self, :for_js)
+
     # Static array used to check with method missing - we only need to ever
     # instantiate once.
     CHECK = []
@@ -439,6 +441,8 @@ def without_options
     # @param [ Hash ] scope The scope for the code.
     #
     # @return [ Criteria ] The criteria.
+    #
+    # @deprecated
     def for_js(javascript, scope = {})
       code = if scope.empty?
         # CodeWithScope is not supported for $where as of MongoDB 4.4

lib/mongoid/deprecation.rb

@@ -6,10 +6,13 @@ module Mongoid
   # Utility class for logging deprecation warnings.
   class Deprecation < ::ActiveSupport::Deprecation
 
-    @gem_name = 'Mongoid'
+    def initialize
+      # Per change policy, deprecations will be removed in the next major version.
+      deprecation_horizon = "#{Mongoid::VERSION.split('.').first.to_i + 1}.0".freeze
+      gem_name = 'Mongoid'
+      super(deprecation_horizon, gem_name)
+    end
 
-    # Per change policy, deprecations will be removed in the next major version.
-    @deprecation_horizon = "#{Mongoid::VERSION.split('.').first.to_i + 1}.0".freeze
 
     # Overrides default ActiveSupport::Deprecation behavior
     # to use Mongoid's logger.

spec/mongoid/criteria_spec.rb

@@ -2977,6 +2977,12 @@ def self.ages; self; end
       Band.create!(name: "Depeche Mode")
     end
 
+    it 'is deprecated' do
+      expect(Mongoid.logger).to receive(:warn).with(/for_js is deprecated/).and_call_original
+
+      Band.for_js("this.name == 'Depeche Mode'")
+    end
+
     context "when the code has no scope" do
 
       let(:criteria) do