Make <=> methods return nil if passed a non-comparable argument.

philr · philr · commit 587af7617083 · 2022-07-19T18:50:06.000+01:00
Resolves test case failures on ruby 2.2.0 and later due to Comparable#== no longer catching exceptions (https://bugs.ruby-lang.org/issues/7688). (cherry picked from commit ae0e708)
diff --git a/lib/tzinfo/country.rb b/lib/tzinfo/country.rb
@@ -137,7 +137,10 @@ def zone_info
         
     # Compare two Countries based on their code. Returns -1 if c is less
     # than self, 0 if c is equal to self and +1 if c is greater than self.
+    #
+    # Returns nil if c is not comparable with Country instances.
     def <=>(c)
+      return nil unless c.is_a?(Country)
       code <=> c.code
     end
     
diff --git a/lib/tzinfo/time_or_datetime.rb b/lib/tzinfo/time_or_datetime.rb
@@ -178,7 +178,15 @@ def sec
     # receiver is less than, equal to, or greater than timeOrDateTime.
     #
     # Milliseconds and smaller units are ignored in the comparison.
+    #
+    # Returns nil if the passed in timeOrDateTime is not comparable with
+    # TimeOrDateTime instances.
     def <=>(timeOrDateTime)
+      return nil unless timeOrDateTime.is_a?(TimeOrDateTime) ||
+                        timeOrDateTime.is_a?(Time) ||
+                        timeOrDateTime.is_a?(DateTime) ||
+                        timeOrDateTime.respond_to?(:to_i)
+
       if timeOrDateTime.is_a?(TimeOrDateTime)            
         orig = timeOrDateTime.to_orig
         
diff --git a/lib/tzinfo/timezone.rb b/lib/tzinfo/timezone.rb
@@ -498,10 +498,13 @@ def strftime(format, utc = Time.now.utc)
     
     # Compares two Timezones based on their identifier. Returns -1 if tz is less
     # than self, 0 if tz is equal to self and +1 if tz is greater than self.
+    #
+    # Returns nil if tz is not comparable with Timezone instances.
     def <=>(tz)
+      return nil unless tz.is_a?(Timezone)
       identifier <=> tz.identifier
     end
-    
+
     # Returns true if and only if the identifier of tz is equal to the 
     # identifier of this Timezone.
     def eql?(tz)
diff --git a/test/tc_country.rb b/test/tc_country.rb
@@ -114,6 +114,10 @@ def test_compare
     assert_equal(1, Country.get('US') <=> Country.get('FR'))
   end
   
+  def test_compare_non_comparable
+    assert_nil(Country.get('GB') <=> Object.new)
+  end
+  
   def test_equality
     assert_equal(true, Country.get('GB') == Country.get('GB'))
     assert_equal(false, Country.get('GB') == Country.get('US'))
diff --git a/test/tc_time_or_datetime.rb b/test/tc_time_or_datetime.rb
@@ -276,6 +276,12 @@ def test_compare_timestamp_str
     assert_equal(1, TimeOrDateTime.new(1143214323) <=> '1111678323')
   end
   
+  def test_compare_non_comparable
+    assert_nil(TimeOrDateTime.new(Time.utc(2006, 3, 24, 15, 32, 3)) <=> Object.new)
+    assert_nil(TimeOrDateTime.new(DateTime.new(2006, 3, 24, 15, 32, 3)) <=> Object.new)
+    assert_nil(TimeOrDateTime.new(1143214323) <=> Object.new)
+  end
+  
   def test_eql
     assert_equal(true, TimeOrDateTime.new(Time.utc(2006, 3, 24, 15, 32, 3)).eql?(TimeOrDateTime.new(Time.utc(2006, 3, 24, 15, 32, 3))))
     assert_equal(false, TimeOrDateTime.new(Time.utc(2006, 3, 24, 15, 32, 3)).eql?(TimeOrDateTime.new(DateTime.new(2006, 3, 24, 15, 32, 3))))
diff --git a/test/tc_timezone.rb b/test/tc_timezone.rb
@@ -907,6 +907,10 @@ def test_compare
     assert_equal(1, TestTimezone.new('Europe/Paris') <=> TestTimezone.new('America/New_York'))    
   end
   
+  def test_compare_non_comparable
+    assert_nil(TestTimezone.new('Europe/London') <=> Object.new)
+  end
+  
   def test_equality
     assert_equal(true, TestTimezone.new('Europe/London') == TestTimezone.new('Europe/London'))
     assert_equal(false, TestTimezone.new('Europe/London') == TestTimezone.new('Europe/london'))
