Parent

Class Index [+]

Quicksearch

Time

Constants

DATE_FORMATS
COMMON_YEAR_DAYS_IN_MONTH
DAYS_INTO_WEEK

Attributes

zone_default[RW]

Public Class Methods

===(other) click to toggle source

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:       other.is_a?(::Time)
14:     end
_load(marshaled_time) click to toggle source
    # 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
Also aliased as: _load_without_utc_flag
_load(marshaled_time) click to toggle source
    # 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[1] = zone
41:             utc? ? Time.utc(*ary) : Time.local(*ary)
42:           else
43:             self
44:           end
45:         end
46:       end
Also aliased as: _load_without_zone
_load_without_utc_flag(marshaled_time) click to toggle source
Alias for: _load
_load_without_zone(marshaled_time) click to toggle source
Alias for: _load
current() click to toggle source

Returns Time.zone.now when config.time_zone is set, otherwise just returns Time.now.

    # File lib/active_support/core_ext/time/calculations.rb, line 45
45:     def current
46:       ::Time.zone_default ? ::Time.zone.now : ::Time.now
47:     end
days_in_month(month, year = now.year) click to toggle source

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
local_time(*args) click to toggle source

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
time_with_datetime_fallback(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0, usec=0) click to toggle source

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
use_zone(time_zone) click to toggle source

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 37
37:     def use_zone(time_zone)
38:       old_zone, ::Time.zone = ::Time.zone, get_zone(time_zone)
39:       yield
40:     ensure
41:       ::Time.zone = old_zone
42:     end
utc_time(*args) click to toggle source

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
zone() click to toggle source

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
zone=(time_zone) click to toggle source

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 — current_user.time_zone just needs to return a string identifying the user’s preferred TimeZone:

  class ApplicationController < ActionController::Base
    before_filter :set_time_zone

    def set_time_zone
      Time.zone = current_user.time_zone
    end
  end
    # File lib/active_support/core_ext/time/zones.rb, line 32
32:     def zone=(time_zone)
33:       Thread.current[:time_zone] = get_zone(time_zone)
34:     end

Private Class Methods

get_zone(time_zone) click to toggle source
    # File lib/active_support/core_ext/time/zones.rb, line 45
45:       def get_zone(time_zone)
46:         return time_zone if time_zone.nil? || time_zone.is_a?(ActiveSupport::TimeZone)
47:         # lookup timezone based on identifier (unless we've been passed a TZInfo::Timezone)
48:         unless time_zone.respond_to?(:period_for_local)
49:           time_zone = ActiveSupport::TimeZone[time_zone] || TZInfo::Timezone.get(time_zone) rescue nil
50:         end
51:         # Return if a TimeZone instance, or wrap in a TimeZone instance if a TZInfo::Timezone
52:         if time_zone
53:           time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone.create(time_zone.name, nil, time_zone)
54:         end
55:       end

Public Instance Methods

-(other) click to toggle source
Alias for: minus_with_coercion
<=>(other) click to toggle source
Also aliased as: compare_without_coercion
_dump(*args) click to toggle source
    # 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
_dump(*args) click to toggle source
    # File lib/active_support/core_ext/time/marshal.rb, line 50
50:     def _dump(*args)
51:       obj = dup
52:       obj.instance_variable_set('@_zone', zone)
53:       obj._dump_without_zone(*args)
54:     end
_dump_without_utc_flag(*args) click to toggle source
Alias for: _dump
_dump_without_zone(*args) click to toggle source
Alias for: _dump
acts_like_time?() click to toggle source

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
advance(options) click to toggle source

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
ago(seconds) click to toggle source

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
at_beginning_of_day() click to toggle source
Alias for: beginning_of_day
at_beginning_of_month() click to toggle source
Alias for: beginning_of_month
at_beginning_of_quarter() click to toggle source
at_beginning_of_week() click to toggle source
Alias for: beginning_of_week
at_beginning_of_year() click to toggle source
Alias for: beginning_of_year
at_end_of_month() click to toggle source
Alias for: end_of_month
at_end_of_quarter() click to toggle source
Alias for: end_of_quarter
at_end_of_week() click to toggle source
Alias for: end_of_week
at_end_of_year() click to toggle source
Alias for: end_of_year
at_midnight() click to toggle source
Alias for: beginning_of_day
beginning_of_day() click to toggle source

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

     # File lib/active_support/core_ext/time/calculations.rb, line 181
181:   def beginning_of_day
182:     #(self - seconds_since_midnight).change(:usec => 0)
183:     change(:hour => 0, :min => 0, :sec => 0, :usec => 0)
184:   end
beginning_of_month() click to toggle source

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 195
195:   def beginning_of_month
196:     #self - ((self.mday-1).days + self.seconds_since_midnight)
197:     change(:day => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0)
198:   end
Also aliased as: at_beginning_of_month
beginning_of_quarter() click to toggle source

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 210
210:   def beginning_of_quarter
211:     beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= month })
212:   end
Also aliased as: at_beginning_of_quarter
beginning_of_week() click to toggle source

Returns a new Time representing the “start” of this week (Monday, 0:00)

     # File lib/active_support/core_ext/time/calculations.rb, line 161
161:   def beginning_of_week
162:     days_to_monday = wday!=0 ? wday-1 : 6
163:     (self - days_to_monday.days).midnight
164:   end
Also aliased as: monday, at_beginning_of_week
beginning_of_year() click to toggle source

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 222
222:   def beginning_of_year
223:     change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0, :usec => 0)
224:   end
Also aliased as: at_beginning_of_year
change(options) click to toggle source

Returns a new Time where one or more of the elements have been changed according to the options parameter. The time options (hour, minute, 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
compare_with_coercion(other) click to toggle source

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 275
275:   def compare_with_coercion(other)
276:     # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do <=> comparison
277:     other = other.comparable_time if other.respond_to?(:comparable_time)
278:     if other.acts_like?(:date)
279:       # other is a Date/DateTime, so coerce self #to_datetime and hand off to DateTime#<=>
280:       to_datetime.compare_without_coercion(other)
281:     else
282:       compare_without_coercion(other)
283:     end
284:   end
Also aliased as: <=>
compare_without_coercion(other) click to toggle source
Alias for: <=>
end_of_day() click to toggle source

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 190
190:   def end_of_day
191:     change(:hour => 23, :min => 59, :sec => 59, :usec => 999999.999)
192:   end
end_of_month() click to toggle source

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 202
202:   def end_of_month
203:     #self - ((self.mday-1).days + self.seconds_since_midnight)
204:     last_day = ::Time.days_in_month(month, year)
205:     change(:day => last_day, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999)
206:   end
Also aliased as: at_end_of_month
end_of_quarter() click to toggle source

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 216
216:   def end_of_quarter
217:     beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= month }).end_of_month
218:   end
Also aliased as: at_end_of_quarter
end_of_week() click to toggle source

Returns a new Time representing the end of this week, (end of Sunday)

     # File lib/active_support/core_ext/time/calculations.rb, line 169
169:   def end_of_week
170:     days_to_sunday = wday!=0 ? 7-wday : 0
171:     (self + days_to_sunday.days).end_of_day
172:   end
Also aliased as: at_end_of_week
end_of_year() click to toggle source

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 228
228:   def end_of_year
229:     change(:month => 12, :day => 31, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999)
230:   end
Also aliased as: at_end_of_year
formatted_offset(colon = true, alternate_utc_string = nil) click to toggle source

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
future?() click to toggle source

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
in(seconds) click to toggle source
Alias for: since
in_time_zone(zone = ::Time.zone) click to toggle source

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 70
70:   def in_time_zone(zone = ::Time.zone)
71:     return self unless zone
72: 
73:     ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.__send__(:get_zone, zone))
74:   end
midnight() click to toggle source
Alias for: beginning_of_day
minus_with_coercion(other) click to toggle source

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 266
266:   def minus_with_coercion(other)
267:     other = other.comparable_time if other.respond_to?(:comparable_time)
268:     other.is_a?(DateTime) ? to_f - other.to_f : minus_without_coercion(other)
269:   end
Also aliased as: -
minus_without_coercion(other) click to toggle source
Alias for: -
minus_without_duration(other) click to toggle source
Alias for: -
monday() click to toggle source
Alias for: beginning_of_week
months_ago(months) click to toggle source

Returns a new Time representing the time a number of specified months ago

     # File lib/active_support/core_ext/time/calculations.rb, line 121
121:   def months_ago(months)
122:     advance(:months => -months)
123:   end
months_since(months) click to toggle source

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 126
126:   def months_since(months)
127:     advance(:months => months)
128:   end
next_month() click to toggle source

Short-hand for months_since(1)

     # File lib/active_support/core_ext/time/calculations.rb, line 156
156:   def next_month
157:     months_since(1)
158:   end
next_week(day = :monday) click to toggle source

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 176
176:   def next_week(day = :monday)
177:     since(1.week).beginning_of_week.since(DAYS_INTO_WEEK[day].day).change(:hour => 0)
178:   end
next_year() click to toggle source

Short-hand for years_since(1)

     # File lib/active_support/core_ext/time/calculations.rb, line 146
146:   def next_year
147:     years_since(1)
148:   end
past?() click to toggle source

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
prev_month() click to toggle source

Short-hand for months_ago(1)

     # File lib/active_support/core_ext/time/calculations.rb, line 151
151:   def prev_month
152:     months_ago(1)
153:   end
prev_year() click to toggle source

Short-hand for years_ago(1)

     # File lib/active_support/core_ext/time/calculations.rb, line 141
141:   def prev_year
142:     years_ago(1)
143:   end
seconds_since_midnight() click to toggle source

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
since(seconds) click to toggle source

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
Also aliased as: in
to_date() click to toggle source

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
to_datetime() click to toggle source

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
to_default_s(format = :default) click to toggle source
Alias for: to_s
to_formatted_s(format = :default) click to toggle source

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:17"
  time.to_s(:time)                    # => "06:10:17"

  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"

Adding your own time formats to to_formatted_s

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
Also aliased as: to_s
to_s(format = :default) click to toggle source
Also aliased as: to_default_s
Alias for: to_formatted_s
to_time() click to toggle source

A method to keep Time, Date and DateTime instances interchangeable on conversions. In this case, it simply returns self.

    # File lib/active_support/core_ext/time/conversions.rb, line 71
71:   def to_time
72:     self
73:   end
today?() click to toggle source

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
tomorrow() click to toggle source

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 239
239:   def tomorrow
240:     advance(:days => 1)
241:   end
years_ago(years) click to toggle source

Returns a new Time representing the time a number of specified years ago

     # File lib/active_support/core_ext/time/calculations.rb, line 131
131:   def years_ago(years)
132:     advance(:years => -years)
133:   end
years_since(years) click to toggle source

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 136
136:   def years_since(years)
137:     advance(:years => years)
138:   end
yesterday() click to toggle source

Convenience method which returns a new Time representing the time 1 day ago

     # File lib/active_support/core_ext/time/calculations.rb, line 234
234:   def yesterday
235:     advance(:days => 1)
236:   end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.