From ce73055139013d44b36d0c2cd3ab42146c0b4353 Mon Sep 17 00:00:00 2001 From: Olek Janiszewski Date: Tue, 16 Oct 2012 12:05:24 +0200 Subject: [PATCH] Add #seconds_until_end_of_day to DateTime and Time --- activesupport/CHANGELOG.md | 11 ++++- .../core_ext/date_time/calculations.rb | 9 ++++ .../core_ext/time/calculations.rb | 9 ++++ .../test/core_ext/date_time_ext_test.rb | 8 ++++ activesupport/test/core_ext/time_ext_test.rb | 48 +++++++++++++++++++ 5 files changed, 84 insertions(+), 1 deletion(-) diff --git a/activesupport/CHANGELOG.md b/activesupport/CHANGELOG.md index 8ef9ffb8db..1744d48c4b 100644 --- a/activesupport/CHANGELOG.md +++ b/activesupport/CHANGELOG.md @@ -1,5 +1,14 @@ ## Rails 4.0.0 (unreleased) ## +* Add `DateTime#seconds_until_end_of_day` and `Time#seconds_until_end_of_day` + as a complement for `seconds_from_midnight`; useful when setting expiration + times for caches, e.g.: + + <% cache('dashboard', expires_in: Date.current.seconds_until_end_of_day) do %> + ... + + *Olek Janiszewski* + * No longer proxy ActiveSupport::Multibyte#class. *Steve Klabnik* * Deprecate `ActiveSupport::TestCase#pending` method, use `skip` from MiniTest instead. *Carlos Antonio da Silva* @@ -65,7 +74,7 @@ *Jeremy Kemper* -* Add logger.push_tags and .pop_tags to complement logger.tagged: +* Add `logger.push_tags` and `.pop_tags` to complement logger.tagged: class Job def before diff --git a/activesupport/lib/active_support/core_ext/date_time/calculations.rb b/activesupport/lib/active_support/core_ext/date_time/calculations.rb index 0c6437b02b..f77d444479 100644 --- a/activesupport/lib/active_support/core_ext/date_time/calculations.rb +++ b/activesupport/lib/active_support/core_ext/date_time/calculations.rb @@ -32,6 +32,15 @@ def seconds_since_midnight sec + (min * 60) + (hour * 3600) end + # Returns the number of seconds until 23:59:59. + # + # DateTime.new(2012, 8, 29, 0, 0, 0).seconds_until_end_of_day # => 86399 + # DateTime.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103 + # DateTime.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0 + def seconds_until_end_of_day + end_of_day.to_i - to_i + end + # Returns a new DateTime where one or more of the elements have been changed # according to the +options+ parameter. The time options (:hour, # :minute, :sec) reset cascadingly, so if only the hour is diff --git a/activesupport/lib/active_support/core_ext/time/calculations.rb b/activesupport/lib/active_support/core_ext/time/calculations.rb index 931851d40e..46c9f05c15 100644 --- a/activesupport/lib/active_support/core_ext/time/calculations.rb +++ b/activesupport/lib/active_support/core_ext/time/calculations.rb @@ -62,6 +62,15 @@ def seconds_since_midnight to_i - change(:hour => 0).to_i + (usec / 1.0e+6) end + # Returns the number of seconds until 23:59:59. + # + # Time.new(2012, 8, 29, 0, 0, 0).seconds_until_end_of_day # => 86399 + # Time.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103 + # Time.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0 + def seconds_until_end_of_day + end_of_day.to_i - to_i + end + # Returns a new Time where one or more of the elements have been changed according # to the +options+ parameter. The time options (:hour, :min, # :sec, :usec) reset cascadingly, so if only the hour is passed, diff --git a/activesupport/test/core_ext/date_time_ext_test.rb b/activesupport/test/core_ext/date_time_ext_test.rb index b1d1e8ecb4..3353465c1c 100644 --- a/activesupport/test/core_ext/date_time_ext_test.rb +++ b/activesupport/test/core_ext/date_time_ext_test.rb @@ -61,6 +61,14 @@ def test_seconds_since_midnight assert_equal 86399,DateTime.civil(2005,1,1,23,59,59).seconds_since_midnight end + def test_seconds_until_end_of_day + assert_equal 0, DateTime.civil(2005,1,1,23,59,59).seconds_until_end_of_day + assert_equal 1, DateTime.civil(2005,1,1,23,59,58).seconds_until_end_of_day + assert_equal 60, DateTime.civil(2005,1,1,23,58,59).seconds_until_end_of_day + assert_equal 3660, DateTime.civil(2005,1,1,22,58,59).seconds_until_end_of_day + assert_equal 86399, DateTime.civil(2005,1,1,0,0,0).seconds_until_end_of_day + end + def test_beginning_of_day assert_equal DateTime.civil(2005,2,4,0,0,0), DateTime.civil(2005,2,4,10,10,10).beginning_of_day end diff --git a/activesupport/test/core_ext/time_ext_test.rb b/activesupport/test/core_ext/time_ext_test.rb index 6d6757a1b6..0e75104fc6 100644 --- a/activesupport/test/core_ext/time_ext_test.rb +++ b/activesupport/test/core_ext/time_ext_test.rb @@ -57,6 +57,54 @@ def test_seconds_since_midnight_at_daylight_savings_time_end end end + def test_seconds_until_end_of_day + assert_equal 0, Time.local(2005,1,1,23,59,59).seconds_until_end_of_day + assert_equal 1, Time.local(2005,1,1,23,59,58).seconds_until_end_of_day + assert_equal 60, Time.local(2005,1,1,23,58,59).seconds_until_end_of_day + assert_equal 3660, Time.local(2005,1,1,22,58,59).seconds_until_end_of_day + assert_equal 86399, Time.local(2005,1,1,0,0,0).seconds_until_end_of_day + end + + def test_seconds_until_end_of_day_at_daylight_savings_time_start + with_env_tz 'US/Eastern' do + # dt: US: 2005 April 3rd 2:00am ST => April 3rd 3:00am DT + assert_equal 21*3600, Time.local(2005,4,3,1,59,59).seconds_until_end_of_day, 'just before DST start' + assert_equal 21*3600-2, Time.local(2005,4,3,3,0,1).seconds_until_end_of_day, 'just after DST start' + end + + with_env_tz 'NZ' do + # dt: New Zealand: 2006 October 1st 2:00am ST => October 1st 3:00am DT + assert_equal 21*3600, Time.local(2006,10,1,1,59,59).seconds_until_end_of_day, 'just before DST start' + assert_equal 21*3600-2, Time.local(2006,10,1,3,0,1).seconds_until_end_of_day, 'just after DST start' + end + end + + def test_seconds_until_end_of_day_at_daylight_savings_time_end + with_env_tz 'US/Eastern' do + # st: US: 2005 October 30th 2:00am DT => October 30th 1:00am ST + # avoid setting a time between 1:00 and 2:00 since that requires specifying whether DST is active + assert_equal 24*3600, Time.local(2005,10,30,0,59,59).seconds_until_end_of_day, 'just before DST end' + assert_equal 22*3600-2, Time.local(2005,10,30,2,0,1).seconds_until_end_of_day, 'just after DST end' + + # now set a time between 1:00 and 2:00 by specifying whether DST is active + # uses: Time.local( sec, min, hour, day, month, year, wday, yday, isdst, tz ) + assert_equal 24*3600-30*60-1, Time.local(0,30,1,30,10,2005,0,0,true,ENV['TZ']).seconds_until_end_of_day, 'before DST end' + assert_equal 23*3600-30*60-1, Time.local(0,30,1,30,10,2005,0,0,false,ENV['TZ']).seconds_until_end_of_day, 'after DST end' + end + + with_env_tz 'NZ' do + # st: New Zealand: 2006 March 19th 3:00am DT => March 19th 2:00am ST + # avoid setting a time between 2:00 and 3:00 since that requires specifying whether DST is active + assert_equal 23*3600, Time.local(2006,3,19,1,59,59).seconds_until_end_of_day, 'just before DST end' + assert_equal 21*3600-2, Time.local(2006,3,19,3,0,1).seconds_until_end_of_day, 'just after DST end' + + # now set a time between 2:00 and 3:00 by specifying whether DST is active + # uses: Time.local( sec, min, hour, day, month, year, wday, yday, isdst, tz ) + assert_equal 23*3600-30*60-1, Time.local(0,30,2,19,3,2006,0,0,true, ENV['TZ']).seconds_until_end_of_day, 'before DST end' + assert_equal 22*3600-30*60-1, Time.local(0,30,2,19,3,2006,0,0,false,ENV['TZ']).seconds_until_end_of_day, 'after DST end' + end + end + def test_beginning_of_day assert_equal Time.local(2005,2,4,0,0,0), Time.local(2005,2,4,10,10,10).beginning_of_day with_env_tz 'US/Eastern' do -- GitLab