Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances
# File lib/active_support/core_ext/time/calculations.rb, line 12 12: def ===(other) 13: super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone)) 14: end
# File lib/active_support/core_ext/time/marshal.rb, line 8 8: def _load(marshaled_time) 9: time = _load_without_utc_flag(marshaled_time) 10: time.instance_eval do 11: if defined?(@marshal_with_utc_coercion) 12: val = remove_instance_variable("@marshal_with_utc_coercion") 13: end 14: val ? utc : self 15: end 16: end
# File lib/active_support/core_ext/time/marshal.rb, line 35 35: def _load(marshaled_time) 36: time = _load_without_zone(marshaled_time) 37: time.instance_eval do 38: if zone = defined?(@_zone) && remove_instance_variable('@_zone') 39: ary = to_a 40: ary[0] += subsec if ary[0] == sec 41: ary[1] = zone 42: utc? ? Time.utc(*ary) : Time.local(*ary) 43: else 44: self 45: end 46: end 47: end
Returns Time.zone.now when Time.zone or config.time_zone are set, otherwise just returns Time.now.
# File lib/active_support/core_ext/time/calculations.rb, line 45 45: def current 46: ::Time.zone ? ::Time.zone.now : ::Time.now 47: end
Return the number of days in the given month. If no year is specified, it will use the current year.
# File lib/active_support/core_ext/time/calculations.rb, line 18 18: def days_in_month(month, year = now.year) 19: return 29 if month == 2 && ::Date.gregorian_leap?(year) 20: COMMON_YEAR_DAYS_IN_MONTH[month] 21: end
# File lib/active_support/core_ext/time/zones.rb, line 64 64: def find_zone(time_zone) 65: find_zone!(time_zone) rescue nil 66: end
Returns a TimeZone instance or nil, or raises an ArgumentError for invalid timezones.
# File lib/active_support/core_ext/time/zones.rb, line 52 52: def find_zone!(time_zone) 53: return time_zone if time_zone.nil? || time_zone.is_a?(ActiveSupport::TimeZone) 54: # lookup timezone based on identifier (unless we've been passed a TZInfo::Timezone) 55: unless time_zone.respond_to?(:period_for_local) 56: time_zone = ActiveSupport::TimeZone[time_zone] || TZInfo::Timezone.get(time_zone) 57: end 58: # Return if a TimeZone instance, or wrap in a TimeZone instance if a TZInfo::Timezone 59: time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone.create(time_zone.name, nil, time_zone) 60: rescue TZInfo::InvalidTimezoneIdentifier 61: raise ArgumentError, "Invalid Timezone: #{time_zone}" 62: end
Wraps class method time_with_datetime_fallback with utc_or_local set to :local.
# File lib/active_support/core_ext/time/calculations.rb, line 40 40: def local_time(*args) 41: time_with_datetime_fallback(:local, *args) 42: end
Returns a new Time if requested year can be accommodated by Ruby’s Time class (i.e., if year is within either 1970..2038 or 1902..2038, depending on system architecture); otherwise returns a DateTime.
# File lib/active_support/core_ext/time/calculations.rb, line 26 26: def time_with_datetime_fallback(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0, usec=0) 27: time = ::Time.send(utc_or_local, year, month, day, hour, min, sec, usec) 28: # This check is needed because Time.utc(y) returns a time object in the 2000s for 0 <= y <= 138. 29: time.year == year ? time : ::DateTime.civil_from_format(utc_or_local, year, month, day, hour, min, sec) 30: rescue 31: ::DateTime.civil_from_format(utc_or_local, year, month, day, hour, min, sec) 32: end
Allows override of Time.zone locally inside supplied block; resets Time.zone to existing value when done.
# File lib/active_support/core_ext/time/zones.rb, line 41 41: def use_zone(time_zone) 42: new_zone = find_zone!(time_zone) 43: begin 44: old_zone, ::Time.zone = ::Time.zone, new_zone 45: yield 46: ensure 47: ::Time.zone = old_zone 48: end 49: end
Wraps class method time_with_datetime_fallback with utc_or_local set to :utc.
# File lib/active_support/core_ext/time/calculations.rb, line 35 35: def utc_time(*args) 36: time_with_datetime_fallback(:utc, *args) 37: end
Returns the TimeZone for the current request, if this has been set (via Time.zone=). If Time.zone has not been set for the current request, returns the TimeZone specified in config.time_zone.
# File lib/active_support/core_ext/time/zones.rb, line 9 9: def zone 10: Thread.current[:time_zone] || zone_default 11: end
Sets Time.zone to a TimeZone object for the current request/thread.
This method accepts any of the following:
A Rails TimeZone object.
An identifier for a Rails TimeZone object (e.g., “Eastern Time (US & Canada)”, -5.hours).
A TZInfo::Timezone object.
An identifier for a TZInfo::Timezone object (e.g., “America/New_York“).
Here’s an example of how you might set Time.zone on a per request basis and reset it when the request is done. current_user.time_zone just needs to return a string identifying the user’s preferred time zone:
class ApplicationController < ActionController::Base around_filter :set_time_zone def set_time_zone old_time_zone = Time.zone Time.zone = current_user.time_zone if logged_in? yield ensure Time.zone = old_time_zone end end
# File lib/active_support/core_ext/time/zones.rb, line 36 36: def zone=(time_zone) 37: Thread.current[:time_zone] = find_zone!(time_zone) 38: end
# File lib/active_support/core_ext/time/marshal.rb, line 51 51: def _dump(*args) 52: obj = dup 53: obj.instance_variable_set('@_zone', zone) 54: obj._dump_without_zone(*args) 55: end
# File lib/active_support/core_ext/time/marshal.rb, line 20 20: def _dump(*args) 21: obj = dup 22: obj.instance_variable_set('@marshal_with_utc_coercion', utc?) 23: obj._dump_without_utc_flag(*args) 24: end
Duck-types as a Time-like class. See Object#acts_like?.
# File lib/active_support/core_ext/time/acts_like.rb, line 5 5: def acts_like_time? 6: true 7: end
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 lib/active_support/core_ext/time/calculations.rb, line 90 90: def advance(options) 91: unless options[:weeks].nil? 92: options[:weeks], partial_weeks = options[:weeks].divmod(1) 93: options[:days] = (options[:days] || 0) + 7 * partial_weeks 94: end 95: 96: unless options[:days].nil? 97: options[:days], partial_days = options[:days].divmod(1) 98: options[:hours] = (options[:hours] || 0) + 24 * partial_days 99: end 100: 101: d = to_date.advance(options) 102: time_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day) 103: seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600 104: seconds_to_advance == 0 ? time_advanced_by_date : time_advanced_by_date.since(seconds_to_advance) 105: end
Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension
# File lib/active_support/core_ext/time/calculations.rb, line 108 108: def ago(seconds) 109: since(-seconds) 110: end
Returns a Range representing the whole day of the current time.
# File lib/active_support/core_ext/time/calculations.rb, line 288 288: def all_day 289: beginning_of_day..end_of_day 290: end
Returns a Range representing the whole month of the current time.
# File lib/active_support/core_ext/time/calculations.rb, line 298 298: def all_month 299: beginning_of_month..end_of_month 300: end
Returns a Range representing the whole quarter of the current time.
# File lib/active_support/core_ext/time/calculations.rb, line 303 303: def all_quarter 304: beginning_of_quarter..end_of_quarter 305: end
Returns a Range representing the whole week of the current time. Week starts on start_day (default is :monday, i.e. end of Sunday).
# File lib/active_support/core_ext/time/calculations.rb, line 293 293: def all_week(start_day = :monday) 294: beginning_of_week(start_day)..end_of_week(start_day) 295: end
Returns a Range representing the whole year of the current time.
# File lib/active_support/core_ext/time/calculations.rb, line 308 308: def all_year 309: beginning_of_year..end_of_year 310: end
Returns a new Time representing the start of the day (0:00)
# File lib/active_support/core_ext/time/calculations.rb, line 210 210: def beginning_of_day 211: #(self - seconds_since_midnight).change(:usec => 0) 212: change(:hour => 0) 213: end
Returns a new Time representing the start of the hour (x:00)
# File lib/active_support/core_ext/time/calculations.rb, line 224 224: def beginning_of_hour 225: change(:min => 0) 226: end
Returns a new Time representing the start of the month (1st of the month, 0:00)
# File lib/active_support/core_ext/time/calculations.rb, line 239 239: def beginning_of_month 240: #self - ((self.mday-1).days + self.seconds_since_midnight) 241: change(:day => 1, :hour => 0) 242: end
Returns a new Time representing the start of the quarter (1st of january, april, july, october, 0:00)
# File lib/active_support/core_ext/time/calculations.rb, line 254 254: def beginning_of_quarter 255: beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= month }) 256: end
Returns a new Time representing the “start” of this week, week starts on start_day (default is :monday, i.e. Monday, 0:00).
# File lib/active_support/core_ext/time/calculations.rb, line 174 174: def beginning_of_week(start_day = :monday) 175: days_to_start = days_to_week_start(start_day) 176: (self - days_to_start.days).midnight 177: end
Returns a new Time representing the start of the year (1st of january, 0:00)
# File lib/active_support/core_ext/time/calculations.rb, line 266 266: def beginning_of_year 267: change(:month => 1, :day => 1, :hour => 0) 268: 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, then minute, sec, and usec is set to 0. If the hour and minute is passed, then sec and usec is set to 0.
# File lib/active_support/core_ext/time/calculations.rb, line 73 73: def change(options) 74: ::Time.send( 75: utc? ? :utc_time : :local_time, 76: options[:year] || year, 77: options[:month] || month, 78: options[:day] || day, 79: options[:hour] || hour, 80: options[:min] || (options[:hour] ? 0 : min), 81: options[:sec] || ((options[:hour] || options[:min]) ? 0 : sec), 82: options[:usec] || ((options[:hour] || options[:min] || options[:sec]) ? 0 : usec) 83: ) 84: end
Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared with a Time
# File lib/active_support/core_ext/time/calculations.rb, line 344 344: def compare_with_coercion(other) 345: # we're avoiding Time#to_datetime cause it's expensive 346: other.is_a?(Time) ? compare_without_coercion(other.to_time) : to_datetime <=> other 347: end
Returns number of days to start of this week, week starts on start_day (default is :monday).
# File lib/active_support/core_ext/time/calculations.rb, line 166 166: def days_to_week_start(start_day = :monday) 167: start_day_number = DAYS_INTO_WEEK[start_day] 168: current_day_number = wday != 0 ? wday - 1 : 6 169: days_span = current_day_number - start_day_number 170: days_span >= 0 ? days_span : 7 + days_span 171: end
Returns a new Time representing the end of the day, 23:59:59.999999 (.999999999 in ruby1.9)
# File lib/active_support/core_ext/time/calculations.rb, line 219 219: def end_of_day 220: change(:hour => 23, :min => 59, :sec => 59, :usec => 999999.999) 221: end
Returns a new Time representing the end of the hour, x:59:59.999999 (.999999999 in ruby1.9)
# File lib/active_support/core_ext/time/calculations.rb, line 230 230: def end_of_hour 231: change( 232: :min => 59, 233: :sec => 59, 234: :usec => 999999.999 235: ) 236: end
Returns a new Time representing the end of the month (end of the last day of the month)
# File lib/active_support/core_ext/time/calculations.rb, line 246 246: def end_of_month 247: #self - ((self.mday-1).days + self.seconds_since_midnight) 248: last_day = ::Time.days_in_month(month, year) 249: change(:day => last_day, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999) 250: end
Returns a new Time representing the end of the quarter (end of the last day of march, june, september, december)
# File lib/active_support/core_ext/time/calculations.rb, line 260 260: def end_of_quarter 261: beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= month }).end_of_month 262: end
Returns a new Time representing the end of this week, week starts on start_day (default is :monday, i.e. end of Sunday).
# File lib/active_support/core_ext/time/calculations.rb, line 187 187: def end_of_week(start_day = :monday) 188: days_to_end = 6 - days_to_week_start(start_day) 189: (self + days_to_end.days).end_of_day 190: end
Returns a new Time representing the end of the year (end of the 31st of december)
# File lib/active_support/core_ext/time/calculations.rb, line 272 272: def end_of_year 273: change(:month => 12, :day => 31, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999) 274: end
Layers additional behavior on Time#eql? so that ActiveSupport::TimeWithZone instances can be eql? to an equivalent Time
# File lib/active_support/core_ext/time/calculations.rb, line 353 353: def eql_with_coercion(other) 354: # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do eql? comparison 355: other = other.comparable_time if other.respond_to?(:comparable_time) 356: eql_without_coercion(other) 357: end
Returns the UTC offset as an +HH:MM formatted string.
Time.local(2000).formatted_offset # => "-06:00" Time.local(2000).formatted_offset(false) # => "-0600"
# File lib/active_support/core_ext/time/conversions.rb, line 54 54: def formatted_offset(colon = true, alternate_utc_string = nil) 55: utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon) 56: end
Tells whether the Time object’s time lies in the future
# File lib/active_support/core_ext/time/calculations.rb, line 61 61: def future? 62: self > ::Time.current 63: end
Returns the simultaneous time in Time.zone.
Time.zone = 'Hawaii' # => 'Hawaii' Time.utc(2000).in_time_zone # => Fri, 31 Dec 1999 14:00:00 HST -10:00
This method is similar to Time#localtime, except that it uses Time.zone as the local zone instead of the operating system’s time zone.
You can also pass in a TimeZone instance or string that identifies a TimeZone as an argument, and the conversion will be based on that zone instead of Time.zone.
Time.utc(2000).in_time_zone('Alaska') # => Fri, 31 Dec 1999 15:00:00 AKST -09:00
# File lib/active_support/core_ext/time/zones.rb, line 81 81: def in_time_zone(zone = ::Time.zone) 82: return self unless zone 83: 84: ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.find_zone!(zone)) 85: end
Time#- can also be used to determine the number of seconds between two Time instances. We’re layering on additional behavior so that ActiveSupport::TimeWithZone instances are coerced into values that Time#- will recognize
# File lib/active_support/core_ext/time/calculations.rb, line 335 335: def minus_with_coercion(other) 336: other = other.comparable_time if other.respond_to?(:comparable_time) 337: other.is_a?(DateTime) ? to_f - other.to_f : minus_without_coercion(other) 338: end
Returns a new Date/DateTime representing the start of this week. Week is assumed to start on a Monday. DateTime objects have their time set to 0:00.
# File lib/active_support/core_ext/time/calculations.rb, line 182 182: def monday 183: beginning_of_week 184: end
Returns a new Time representing the time a number of specified months ago
# File lib/active_support/core_ext/time/calculations.rb, line 126 126: def months_ago(months) 127: advance(:months => -months) 128: end
Returns a new Time representing the time a number of specified months in the future
# File lib/active_support/core_ext/time/calculations.rb, line 131 131: def months_since(months) 132: advance(:months => months) 133: end
Short-hand for months_since(1)
# File lib/active_support/core_ext/time/calculations.rb, line 161 161: def next_month 162: months_since(1) 163: end
Returns a new Time representing the start of the given day in next week (default is :monday).
# File lib/active_support/core_ext/time/calculations.rb, line 205 205: def next_week(day = :monday) 206: since(1.week).beginning_of_week.since(DAYS_INTO_WEEK[day].day).change(:hour => 0) 207: end
Short-hand for years_since(1)
# File lib/active_support/core_ext/time/calculations.rb, line 151 151: def next_year 152: years_since(1) 153: end
Tells whether the Time object’s time lies in the past
# File lib/active_support/core_ext/time/calculations.rb, line 51 51: def past? 52: self < ::Time.current 53: end
Short-hand for months_ago(1)
# File lib/active_support/core_ext/time/calculations.rb, line 156 156: def prev_month 157: months_ago(1) 158: end
Returns a new Time representing the start of the given day in the previous week (default is :monday).
# File lib/active_support/core_ext/time/calculations.rb, line 200 200: def prev_week(day = :monday) 201: ago(1.week).beginning_of_week.since(DAYS_INTO_WEEK[day].day).change(:hour => 0) 202: end
Short-hand for years_ago(1)
# File lib/active_support/core_ext/time/calculations.rb, line 146 146: def prev_year 147: years_ago(1) 148: end
Seconds since midnight: Time.now.seconds_since_midnight
# File lib/active_support/core_ext/time/calculations.rb, line 66 66: def seconds_since_midnight 67: to_i - change(:hour => 0).to_i + (usec / 1.0e+6) 68: end
Returns a new Time representing the time a number of seconds since the instance time
# File lib/active_support/core_ext/time/calculations.rb, line 113 113: def since(seconds) 114: self + seconds 115: rescue 116: to_datetime.since(seconds) 117: end
Returns a new Date/DateTime representing the end of this week. Week is assumed to start on a Monday. DateTime objects have their time set to 23:59:59.
# File lib/active_support/core_ext/time/calculations.rb, line 195 195: def sunday 196: end_of_week 197: end
Converts a Time object to a Date, dropping hour, minute, and second precision.
my_time = Time.now # => Mon Nov 12 22:59:51 -0500 2007 my_time.to_date # => Mon, 12 Nov 2007 your_time = Time.parse("1/13/2009 1:13:03 P.M.") # => Tue Jan 13 13:13:03 -0500 2009 your_time.to_date # => Tue, 13 Jan 2009
# File lib/active_support/core_ext/time/conversions.rb, line 65 65: def to_date 66: ::Date.new(year, month, day) 67: end
Converts a Time instance to a Ruby DateTime instance, preserving UTC offset.
my_time = Time.now # => Mon Nov 12 23:04:21 -0500 2007 my_time.to_datetime # => Mon, 12 Nov 2007 23:04:21 -0500 your_time = Time.parse("1/13/2009 1:13:03 P.M.") # => Tue Jan 13 13:13:03 -0500 2009 your_time.to_datetime # => Tue, 13 Jan 2009 13:13:03 -0500
# File lib/active_support/core_ext/time/conversions.rb, line 82 82: def to_datetime 83: ::DateTime.civil(year, month, day, hour, min, sec, Rational(utc_offset, 86400)) 84: end
Converts to a formatted string. See DATE_FORMATS for builtin formats.
This method is aliased to to_s.
time = Time.now # => Thu Jan 18 06:10:17 CST 2007 time.to_formatted_s(:time) # => "06:10" time.to_s(:time) # => "06:10" time.to_formatted_s(:db) # => "2007-01-18 06:10:17" time.to_formatted_s(:number) # => "20070118061017" time.to_formatted_s(:short) # => "18 Jan 06:10" time.to_formatted_s(:long) # => "January 18, 2007 06:10" time.to_formatted_s(:long_ordinal) # => "January 18th, 2007 06:10" time.to_formatted_s(:rfc822) # => "Thu, 18 Jan 2007 06:10:17 -0600"
You can add your own formats to the Time::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a time argument as the value.
# config/initializers/time_formats.rb Time::DATE_FORMATS[:month_and_year] = "%B %Y" Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }
# File lib/active_support/core_ext/time/conversions.rb, line 40 40: def to_formatted_s(format = :default) 41: if formatter = DATE_FORMATS[format] 42: formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter) 43: else 44: to_default_s 45: end 46: end
Tells whether the Time object’s time is today
# File lib/active_support/core_ext/time/calculations.rb, line 56 56: def today? 57: to_date == ::Date.current 58: end
Convenience method which returns a new Time representing the time 1 day since the instance time
# File lib/active_support/core_ext/time/calculations.rb, line 283 283: def tomorrow 284: advance(:days => 1) 285: end
Returns a new Time representing the time a number of specified weeks ago.
# File lib/active_support/core_ext/time/calculations.rb, line 121 121: def weeks_ago(weeks) 122: advance(:weeks => -weeks) 123: end
Returns a new Time representing the time a number of specified years ago
# File lib/active_support/core_ext/time/calculations.rb, line 136 136: def years_ago(years) 137: advance(:years => -years) 138: end
Returns a new Time representing the time a number of specified years in the future
# File lib/active_support/core_ext/time/calculations.rb, line 141 141: def years_since(years) 142: advance(:years => years) 143: end
Convenience method which returns a new Time representing the time 1 day ago
# File lib/active_support/core_ext/time/calculations.rb, line 278 278: def yesterday 279: advance(:days => 1) 280: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.