Module | ActiveSupport::CoreExtensions::DateTime::Calculations |
In: |
vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb
|
Enables the use of time calculations within DateTime itself
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.
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 49 49: def advance(options) 50: d = to_date.advance(options) 51: datetime_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day) 52: seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600 53: seconds_to_advance == 0 ? datetime_advanced_by_date : datetime_advanced_by_date.since(seconds_to_advance) 54: end
Returns a new DateTime representing the start of the day (0:00)
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 70 70: def beginning_of_day 71: change(:hour => 0) 72: 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 passed, then minute and sec is set to 0. If the hour and minute is passed, then sec is set to 0.
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 32 32: def change(options) 33: ::DateTime.civil( 34: options[:year] || self.year, 35: options[:month] || self.month, 36: options[:day] || self.day, 37: options[:hour] || self.hour, 38: options[:min] || (options[:hour] ? 0 : self.min), 39: options[:sec] || ((options[:hour] || options[:min]) ? 0 : self.sec), 40: options[:offset] || self.offset, 41: options[:start] || self.start 42: ) 43: end
Layers additional behavior on DateTime#<=> so that Time and ActiveSupport::TimeWithZone instances can be compared with a DateTime
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 104 104: def compare_with_coercion(other) 105: other = other.comparable_time if other.respond_to?(:comparable_time) 106: other = other.to_datetime unless other.acts_like?(:date) 107: compare_without_coercion(other) 108: end
Returns a new DateTime representing the end of the day (23:59:59)
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 78 78: def end_of_day 79: change(:hour => 23, :min => 59, :sec => 59) 80: end
Seconds since midnight: DateTime.now.seconds_since_midnight
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 25 25: def seconds_since_midnight 26: self.sec + (self.min * 60) + (self.hour * 3600) 27: end
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!
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 64 64: def since(seconds) 65: self + Rational(seconds.round, 86400) 66: end
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
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 88 88: def utc 89: new_offset(0) 90: end
Returns true if offset == 0
# File vendor/rails/activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 94 94: def utc? 95: offset == 0 96: end