Changeset 8711

Timestamp:

01/23/08 22:22:36 (9 months ago)

Author:

gbuesing

Message:

Adding Time and DateTime #compare_with_coercion, which layers behavior on #<=> so that any combination of Time, DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared

Files:

• trunk/activesupport/CHANGELOG (modified) (1 diff)
• trunk/activesupport/lib/active_support/core_ext/date_time/calculations.rb (modified) (2 diffs)
• trunk/activesupport/lib/active_support/core_ext/time/calculations.rb (modified) (2 diffs)
• trunk/activesupport/lib/active_support/time_with_zone.rb (modified) (1 diff)
• trunk/activesupport/test/core_ext/date_time_ext_test.rb (modified) (1 diff)
• trunk/activesupport/test/core_ext/time_ext_test.rb (modified) (1 diff)
• trunk/activesupport/test/core_ext/time_with_zone_test.rb (modified) (1 diff)

trunk/activesupport/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Adding Time and DateTime #compare_with_coercion, which layers behavior on #<=> so that any combination of Time, DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared [Geoff Buesing]
-
-* TimeZone#now returns an ActiveSupport::TimeWithZone [Geoff Buesing]

trunk/activesupport/lib/active_support/core_ext/date_time/calculations.rb

@@ -8 +8 @@
-        def self.included(base) #:nodoc:
-          base.extend ClassMethods
+          
+          base.class_eval do
+            alias_method :compare_without_coercion, :<=>
+            alias_method :<=>, :compare_with_coercion
+          end
-        end
-
@@ -92 +97 @@
-          (offset * 86400).to_i
-        end
+        
+        # Layers additional behavior on DateTime#<=> so that Time and ActiveSupport::TimeWithZone instances can be compared with a DateTime
+        def compare_with_coercion(other)
+          other = other.comparable_time if other.respond_to?(:comparable_time)
+          other = other.to_datetime unless other.acts_like?(:date)
+          compare_without_coercion(other)
+        end
-      end
-    end

trunk/activesupport/lib/active_support/core_ext/time/calculations.rb

@@ -10 +10 @@
-            alias_method :plus_without_duration, :+
-            alias_method :+, :plus_with_duration
+            
-            alias_method :minus_without_duration, :-
-            alias_method :-, :minus_with_duration
+            
+            alias_method :compare_without_coercion, :<=>
+            alias_method :<=>, :compare_with_coercion
-          end
-        end
@@ -219 +223 @@
-          end
-        end
+        
+        # Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances
+        # can be chronologically compared with a Time
+        def compare_with_coercion(other)
+          # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do <=> comparision
+          other = other.comparable_time if other.respond_to?(:comparable_time)
+          if other.acts_like?(:date)
+            # other is a Date/DateTime, so coerce self #to_datetime and hand off to DateTime#<=>
+            to_datetime.compare_without_coercion(other)
+          else
+            compare_without_coercion(other)
+          end
+        end
-      end
-    end

trunk/activesupport/lib/active_support/time_with_zone.rb

@@ -106 +106 @@
-    # Use the time in UTC for comparisons
-    def <=>(other)
-      other = other.comparable_time if other.respond_to?(:comparable_time) # to coerce time from TimeWithZone
-      utc <=> other
-    end

trunk/activesupport/test/core_ext/date_time_ext_test.rb

@@ -254 +254 @@
-    assert_equal '-0500', dt.formatted_offset(false)
-  end
+  
+  def test_compare_with_time
+    assert_equal  1, DateTime.civil(2000) <=> Time.utc(1999, 12, 31, 23, 59, 59)
+    assert_equal  0, DateTime.civil(2000) <=> Time.utc(2000, 1, 1, 0, 0, 0)
+    assert_equal(-1, DateTime.civil(2000) <=> Time.utc(2000, 1, 1, 0, 0, 1))
+  end
+  
+  def test_compare_with_datetime
+    assert_equal  1, DateTime.civil(2000) <=> DateTime.civil(1999, 12, 31, 23, 59, 59)
+    assert_equal  0, DateTime.civil(2000) <=> DateTime.civil(2000, 1, 1, 0, 0, 0)
+    assert_equal(-1, DateTime.civil(2000) <=> DateTime.civil(2000, 1, 1, 0, 0, 1))
+  end
+  
+  def test_compare_with_time_with_zone
+    assert_equal  1, DateTime.civil(2000) <=> ActiveSupport::TimeWithZone.new( Time.utc(1999, 12, 31, 23, 59, 59) )
+    assert_equal  0, DateTime.civil(2000) <=> ActiveSupport::TimeWithZone.new( Time.utc(2000, 1, 1, 0, 0, 0) )
+    assert_equal(-1, DateTime.civil(2000) <=> ActiveSupport::TimeWithZone.new( Time.utc(2000, 1, 1, 0, 0, 1) ))
+  end
-
-  protected

trunk/activesupport/test/core_ext/time_ext_test.rb

@@ -425 +425 @@
-    end
-  end
+  
+  def test_compare_with_time
+    assert_equal  1, Time.utc(2000) <=> Time.utc(1999, 12, 31, 23, 59, 59, 999)
+    assert_equal  0, Time.utc(2000) <=> Time.utc(2000, 1, 1, 0, 0, 0)
+    assert_equal(-1, Time.utc(2000) <=> Time.utc(2000, 1, 1, 0, 0, 0, 001))
+  end
+  
+  def test_compare_with_datetime
+    assert_equal  1, Time.utc(2000) <=> DateTime.civil(1999, 12, 31, 23, 59, 59)
+    assert_equal  0, Time.utc(2000) <=> DateTime.civil(2000, 1, 1, 0, 0, 0)
+    assert_equal(-1, Time.utc(2000) <=> DateTime.civil(2000, 1, 1, 0, 0, 1))
+  end
+  
+  def test_compare_with_time_with_zone
+    assert_equal  1, Time.utc(2000) <=> ActiveSupport::TimeWithZone.new( Time.utc(1999, 12, 31, 23, 59, 59) )
+    assert_equal  0, Time.utc(2000) <=> ActiveSupport::TimeWithZone.new( Time.utc(2000, 1, 1, 0, 0, 0) )
+    assert_equal(-1, Time.utc(2000) <=> ActiveSupport::TimeWithZone.new( Time.utc(2000, 1, 1, 0, 0, 1) ))
+  end
-
-  protected

trunk/activesupport/test/core_ext/time_with_zone_test.rb

@@ -88 +88 @@
-      assert_equal "1999-12-31T19:00:00-05:00", @twz.xmlschema
-    end
-  
-
+
+_with_time
-      assert_equal  1, @twz <=> Time.utc(1999, 12, 31, 23, 59, 59)
-
+, 1, 1, 0, 0, 0
-      assert_equal(-1, @twz <=> Time.utc(2000, 1, 1, 0, 0, 1))
+    end
+
+    def test_compare_with_datetime
+      assert_equal  1, @twz <=> DateTime.civil(1999, 12, 31, 23, 59, 59)
+      assert_equal  0, @twz <=> DateTime.civil(2000, 1, 1, 0, 0, 0)
+      assert_equal(-1, @twz <=> DateTime.civil(2000, 1, 1, 0, 0, 1))
+    end
+
+    def test_compare_with_time_with_zone
+      assert_equal  1, @twz <=> ActiveSupport::TimeWithZone.new( Time.utc(1999, 12, 31, 23, 59, 59) )
+      assert_equal  0, @twz <=> ActiveSupport::TimeWithZone.new( Time.utc(2000, 1, 1, 0, 0, 0) )
+      assert_equal(-1, @twz <=> ActiveSupport::TimeWithZone.new( Time.utc(2000, 1, 1, 0, 0, 1) ))
-    end
-