MONGOID-5663 [Monkey Patch Removal] Remove Object#__sortable__ (#5708)

* Remove Object#__sortable__ monkey patch, which is only used in Contextual::Memory. Its been moved to private method with a minor amount of refactoring. Existing tests already cover all the functionality.

* deprecate __sortable__ instead of removing it

---------

Co-authored-by: Jamis Buck <[email protected]>

Author: johnnyshields

lib/mongoid/contextual/memory.rb

@@ -627,23 +627,24 @@ def apply_sorting
         end
       end
 
-      # Compare two values, checking for nil.
+      # Compare two values, handling the cases when
+      # either value is nil.
       #
       # @api private
       #
       # @example Compare the two objects.
       #   context.compare(a, b)
       #
       # @param [ Object ] a The first object.
-      # @param [ Object ] b The first object.
+      # @param [ Object ] b The second object.
       #
       # @return [ Integer ] The comparison value.
       def compare(a, b)
-        case
-        when a.nil? then b.nil? ? 0 : 1
-        when b.nil? then -1
-        else a <=> b
-        end
+        return 0 if a.nil? && b.nil?
+        return 1 if a.nil?
+        return -1 if b.nil?
+
+        compare_operand(a) <=> compare_operand(b)
       end
 
       # Sort the documents in place.
@@ -655,9 +656,8 @@ def compare(a, b)
       def in_place_sort(values)
         documents.sort! do |a, b|
           values.map do |field, direction|
-            a_value, b_value = a[field], b[field]
-            direction * compare(a_value.__sortable__, b_value.__sortable__)
-          end.find { |value| !value.zero? } || 0
+            direction * compare(a[field], b[field])
+          end.detect { |value| !value.zero? } || 0
         end
       end
 
@@ -683,6 +683,23 @@ def _session
         @criteria.send(:_session)
       end
 
+      # Get the operand value to be used in comparison.
+      # Adds capability to sort boolean values.
+      #
+      # @example Get the comparison operand.
+      #   compare_operand(true) #=> 1
+      #
+      # @param [ Object ] value The value to be used in comparison.
+      #
+      # @return [ Integer | Object ] The comparison operand.
+      def compare_operand(value)
+        case value
+        when TrueClass then 1
+        when FalseClass then 0
+        else value
+        end
+      end
+
       # Retrieve the value for the current document at the given field path.
       #
       # For example, if I have the following models:

lib/mongoid/extensions/false_class.rb

@@ -3,19 +3,19 @@
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to FalseClass.
     module FalseClass
-
       # Get the value of the object as a mongo friendly sort value.
       #
       # @example Get the object as sort criteria.
       #   object.__sortable__
       #
       # @return [ Integer ] 0.
+      # @deprecated
       def __sortable__
         0
       end
+      Mongoid.deprecate(self, :__sortable__)
 
       # Is the passed value a boolean?
       #
@@ -35,4 +35,4 @@ def is_a?(other)
   end
 end
 
-::FalseClass.__send__(:include, Mongoid::Extensions::FalseClass)
+FalseClass.include Mongoid::Extensions::FalseClass

lib/mongoid/extensions/object.rb

@@ -60,9 +60,11 @@ def __setter__
       #   object.__sortable__
       #
       # @return [ Object ] self.
+      # @deprecated
       def __sortable__
         self
       end
+      Mongoid.deprecate(self, :__sortable__)
 
       # Conversion of an object to an $inc-able value.
       #

lib/mongoid/extensions/true_class.rb

@@ -3,19 +3,19 @@
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to TrueClass
     module TrueClass
-
       # Get the value of the object as a mongo friendly sort value.
       #
       # @example Get the object as sort criteria.
       #   object.__sortable__
       #
       # @return [ Integer ] 1.
+      # @deprecated
       def __sortable__
         1
       end
+      Mongoid.deprecate(self, :__sortable__)
 
       # Is the passed value a boolean?
       #
@@ -35,4 +35,4 @@ def is_a?(other)
   end
 end
 
-::TrueClass.__send__(:include, Mongoid::Extensions::TrueClass)
+TrueClass.include Mongoid::Extensions::TrueClass

spec/mongoid/extensions/false_class_spec.rb

@@ -5,13 +5,6 @@
 
 describe Mongoid::Extensions::FalseClass do
 
-  describe "#__sortable__" do
-
-    it "returns 0" do
-      expect(false.__sortable__).to eq(0)
-    end
-  end
-
   describe "#is_a?" do
 
     context "when provided a Boolean" do

spec/mongoid/extensions/object_spec.rb

@@ -128,13 +128,6 @@
     end
   end
 
-  describe "#__sortable__" do
-
-    it "returns self" do
-      expect(object.__sortable__).to eq(object)
-    end
-  end
-
   describe ".demongoize" do
 
     let(:object) do

spec/mongoid/extensions/true_class_spec.rb

@@ -5,13 +5,6 @@
 
 describe Mongoid::Extensions::TrueClass do
 
-  describe "#__sortable__" do
-
-    it "returns 1" do
-      expect(true.__sortable__).to eq(1)
-    end
-  end
-
   describe "#is_a?" do
 
     context "when provided a Boolean" do