Enables the use of time calculations within DateTime itself

Methods
Classes and Modules
Module ActiveSupport::CoreExtensions::DateTime::Calculations::ClassMethods
Public Instance methods
advance(options)

Uses Date to provide precise Time calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days, :hours, :minutes, :seconds.

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 63
63:         def advance(options)
64:           d = to_date.advance(options)
65:           datetime_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
66:           seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600
67:           seconds_to_advance == 0 ? datetime_advanced_by_date : datetime_advanced_by_date.since(seconds_to_advance)
68:         end
ago(seconds)

Returns a new DateTime representing the time a number of seconds ago Do not use this method in combination with x.months, use months_ago instead!

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 72
72:         def ago(seconds)
73:           self.since(-seconds)
74:         end
at_beginning_of_day()

Alias for beginning_of_day

at_midnight()

Alias for beginning_of_day

beginning_of_day()

Returns a new DateTime representing the start of the day (0:00)

This method is also aliased as midnight at_midnight at_beginning_of_day

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 84
84:         def beginning_of_day
85:           change(:hour => 0)
86:         end
change(options)

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 passed, then minute and sec is set to 0. If the hour and minute is passed, then sec is set to 0.

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 46
46:         def change(options)
47:           ::DateTime.civil(
48:             options[:year]  || self.year,
49:             options[:month] || self.month,
50:             options[:day]   || self.day,
51:             options[:hour]  || self.hour,
52:             options[:min]   || (options[:hour] ? 0 : self.min),
53:             options[:sec]   || ((options[:hour] || options[:min]) ? 0 : self.sec),
54:             options[:offset]  || self.offset,
55:             options[:start]  || self.start
56:           )
57:         end
compare_with_coercion(other)

Layers additional behavior on DateTime#<=> so that Time and ActiveSupport::TimeWithZone instances can be compared with a DateTime

[ show source ]

     # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 118
118:         def compare_with_coercion(other)
119:           other = other.comparable_time if other.respond_to?(:comparable_time)
120:           other = other.to_datetime unless other.acts_like?(:date)
121:           compare_without_coercion(other)
122:         end
end_of_day()

Returns a new DateTime representing the end of the day (23:59:59)

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 92
92:         def end_of_day
93:           change(:hour => 23, :min => 59, :sec => 59)
94:         end
future?()

Tells whether the DateTime object‘s datetime lies in the future

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 34
34:         def future?
35:           self > ::DateTime.current
36:         end
getutc()

Alias for utc

in(seconds)

Alias for since

midnight()

Alias for beginning_of_day

past?()

Tells whether the DateTime object‘s datetime lies in the past

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 29
29:         def past?
30:           self < ::DateTime.current
31:         end
seconds_since_midnight()

Seconds since midnight: DateTime.now.seconds_since_midnight

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 39
39:         def seconds_since_midnight
40:           self.sec + (self.min * 60) + (self.hour * 3600)
41:         end
since(seconds)

Returns a new DateTime representing the time a number of seconds since the instance time Do not use this method in combination with x.months, use months_since instead!

This method is also aliased as in

[ show source ]

    # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 78
78:         def since(seconds)
79:           self + Rational(seconds.round, 86400)
80:         end
utc()

Adjusts DateTime to UTC by adding its offset value; offset is set to 0

Example: 

  DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24))       # => Mon, 21 Feb 2005 10:11:12 -0600
  DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24)).utc   # => Mon, 21 Feb 2005 16:11:12 +0000
This method is also aliased as getutc

[ show source ]

     # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 102
102:         def utc
103:           new_offset(0)
104:         end
utc?()

Returns true if offset == 0

[ show source ]

     # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 108
108:         def utc?
109:           offset == 0
110:         end
utc_offset()

Returns the offset value in seconds

[ show source ]

     # File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 113
113:         def utc_offset
114:           (offset * 86400).to_i
115:         end