Methods
#
A
B
C
D
E
F
I
L
M
S
T
U
Z
Included Modules
Constants
COMMON_YEAR_DAYS_IN_MONTH = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
 
DATE_FORMATS = { :db => '%Y-%m-%d %H:%M:%S', :number => '%Y%m%d%H%M%S', :nsec => '%Y%m%d%H%M%S%9N', :time => '%H:%M', :short => '%d %b %H:%M', :long => '%B %d, %Y %H:%M', :long_ordinal => lambda { |time| day_format = ActiveSupport::Inflector.ordinalize(time.day) time.strftime("%B #{day_format}, %Y %H:%M") }, :rfc822 => lambda { |time| offset_format = time.formatted_offset(false) time.strftime("%a, %d %b %Y %H:%M:%S #{offset_format}") } }
 
Attributes
[RW] zone_default
Instance Public methods
<=>(other)
Also aliased as: compare_without_coercion
===(other)

Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 15
def ===(other)
  super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone))
end
_dump(*args)
Also aliased as: _dump_without_zone
# File activesupport/lib/active_support/core_ext/time/marshal.rb, line 24
def _dump(*args)
  obj = dup
  obj.instance_variable_set('@_zone', zone)
  obj.send :_dump_without_zone, *args
end
_dump_without_zone(*args)
Alias for: _dump
_load(marshaled_time)
# File activesupport/lib/active_support/core_ext/time/marshal.rb, line 8
def _load(marshaled_time)
  time = _load_without_zone(marshaled_time)
  time.instance_eval do
    if zone = defined?(@_zone) && remove_instance_variable('@_zone')
      ary = to_a
      ary[0] += subsec if ary[0] == sec
      ary[-1] = zone
      utc? ? Time.utc(*ary) : Time.local(*ary)
    else
      self
    end
  end
end
acts_like_time?()

Duck-types as a Time-like class. See Object#acts_like?.

# File activesupport/lib/active_support/core_ext/time/acts_like.rb, line 5
def acts_like_time?
  true
end
advance(options)

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

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 134
def advance(options)
  unless options[:weeks].nil?
    options[:weeks], partial_weeks = options[:weeks].divmod(1)
    options[:days] = options.fetch(:days, 0) + 7 * partial_weeks
  end

  unless options[:days].nil?
    options[:days], partial_days = options[:days].divmod(1)
    options[:hours] = options.fetch(:hours, 0) + 24 * partial_days
  end

  d = to_date.advance(options)
  time_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
  seconds_to_advance =        options.fetch(:seconds, 0) +
    options.fetch(:minutes, 0) * 60 +
    options.fetch(:hours, 0) * 3600

  if seconds_to_advance.zero?
    time_advanced_by_date
  else
    time_advanced_by_date.since(seconds_to_advance)
  end
end
ago(seconds)

Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 160
def ago(seconds)
  since(-seconds)
end
all_day()

Returns a Range representing the whole day of the current time.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 224
def all_day
  beginning_of_day..end_of_day
end
all_month()

Returns a Range representing the whole month of the current time.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 235
def all_month
  beginning_of_month..end_of_month
end
all_quarter()

Returns a Range representing the whole quarter of the current time.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 240
def all_quarter
  beginning_of_quarter..end_of_quarter
end
all_week(start_day = Date.beginning_of_week)

Returns a Range representing the whole week of the current time. Week starts on start_day, default is Date.week_startor config.week_startwhen set.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 230
def all_week(start_day = Date.beginning_of_week)
  beginning_of_week(start_day)..end_of_week(start_day)
end
all_year()

Returns a Range representing the whole year of the current time.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 245
def all_year
  beginning_of_year..end_of_year
end
at_beginning_of_day()
Alias for: beginning_of_day
at_beginning_of_hour()
Alias for: beginning_of_hour
at_beginning_of_minute()
Alias for: beginning_of_minute
at_end_of_day()
Alias for: end_of_day
at_end_of_hour()
Alias for: end_of_hour
at_end_of_minute()
Alias for: end_of_minute
at_midnight()
Alias for: beginning_of_day
at_with_coercion(*args)

Layers additional behavior on Time.at so that ActiveSupport::TimeWithZone and DateTime instances can be used when called with a single argument

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 71
def at_with_coercion(*args)
  return at_without_coercion(*args) if args.size != 1

  # Time.at can be called with a time or numerical value
  time_or_number = args.first

  if time_or_number.is_a?(ActiveSupport::TimeWithZone) || time_or_number.is_a?(DateTime)
    at_without_coercion(time_or_number.to_f).getlocal
  else
    at_without_coercion(time_or_number)
  end
end
beginning_of_day()

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

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 173
def beginning_of_day
  #(self - seconds_since_midnight).change(usec: 0)
  change(:hour => 0)
end
beginning_of_hour()

Returns a new Time representing the start of the hour (x:00)

Also aliased as: at_beginning_of_hour
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 193
def beginning_of_hour
  change(:min => 0)
end
beginning_of_minute()

Returns a new Time representing the start of the minute (x:xx:00)

Also aliased as: at_beginning_of_minute
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 209
def beginning_of_minute
  change(:sec => 0)
end
change(options)

Returns a new Time where one or more of the elements have been changed according to the optionsparameter. 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. The optionsparameter takes a hash with any of these keys: :year, :month, :day, :hour, :min, :sec, :usec.

Time.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => Time.new(2012, 8, 1, 22, 35, 0)
Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => Time.new(1981, 8, 1, 22, 35, 0)
Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => Time.new(1981, 8, 29, 0, 0, 0)
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 112
def change(options)
  new_year  = options.fetch(:year, year)
  new_month = options.fetch(:month, month)
  new_day   = options.fetch(:day, day)
  new_hour  = options.fetch(:hour, hour)
  new_min   = options.fetch(:min, options[:hour] ? 0 : min)
  new_sec   = options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec)
  new_usec  = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))

  if utc?
    ::Time.utc(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
  elsif zone
    ::Time.local(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
  else
    ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec + (new_usec.to_r / 1000000), utc_offset)
  end
end
compare_with_coercion(other)

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

Also aliased as: <=>
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 281
def compare_with_coercion(other)
  # we're avoiding Time#to_datetime cause it's expensive
  if other.is_a?(Time)
    compare_without_coercion(other.to_time)
  else
    to_datetime <=> other
  end
end
compare_without_coercion(other)
Alias for: <=>
current()

Returns Time.zone.nowwhen Time.zoneor config.time_zoneare set, otherwise just returns Time.now.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 65
def current
  ::Time.zone ? ::Time.zone.now : ::Time.now
end
days_in_month(month, year = now.year)

Return the number of days in the given month. If no year is specified, it will use the current year.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 21
def days_in_month(month, year = now.year)
  if month == 2 && ::Date.gregorian_leap?(year)
    29
  else
    COMMON_YEAR_DAYS_IN_MONTH[month]
  end
end
end_of_day()

Returns a new Time representing the end of the day, 23:59:59.999999 (.999999999 in ruby1.9)

Also aliased as: at_end_of_day
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 182
def end_of_day
  change(
    :hour => 23,
    :min => 59,
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end
end_of_hour()

Returns a new Time representing the end of the hour, x:59:59.999999 (.999999999 in ruby1.9)

Also aliased as: at_end_of_hour
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 199
def end_of_hour
  change(
    :min => 59,
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end
end_of_minute()

Returns a new Time representing the end of the minute, x:xx:59.999999 (.999999999 in ruby1.9)

Also aliased as: at_end_of_minute
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 215
def end_of_minute
  change(
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end
eql?(other)
Also aliased as: eql_without_coercion
Alias for: eql_with_coercion
eql_with_coercion(other)

Layers additional behavior on #eql? so that ActiveSupport::TimeWithZone instances can be eql? to an equivalent Time

Also aliased as: eql?
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 294
def eql_with_coercion(other)
  # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do eql? comparison
  other = other.comparable_time if other.respond_to?(:comparable_time)
  eql_without_coercion(other)
end
eql_without_coercion(other)
Alias for: eql?
find_zone(time_zone)
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 72
def find_zone(time_zone)
  find_zone!(time_zone) rescue nil
end
find_zone!(time_zone)

Returns a TimeZone instance or nil, or raises an ArgumentError for invalid timezones.

# File activesupport/lib/active_support/core_ext/time/zones.rb, line 52
def find_zone!(time_zone)
  if !time_zone || time_zone.is_a?(ActiveSupport::TimeZone)
    time_zone
  else
    # lookup timezone based on identifier (unless we've been passed a TZInfo::Timezone)
    unless time_zone.respond_to?(:period_for_local)
      time_zone = ActiveSupport::TimeZone[time_zone] || TZInfo::Timezone.get(time_zone)
    end

    # Return if a TimeZone instance, or wrap in a TimeZone instance if a TZInfo::Timezone
    if time_zone.is_a?(ActiveSupport::TimeZone)
      time_zone
    else
      ActiveSupport::TimeZone.create(time_zone.name, nil, time_zone)
    end
  end
rescue TZInfo::InvalidTimezoneIdentifier
  raise ArgumentError, "Invalid Timezone: #{time_zone}"
end
formatted_offset(colon = true, alternate_utc_string = nil)

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 activesupport/lib/active_support/core_ext/time/conversions.rb, line 60
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon)
end
in(seconds)
Alias for: since
in_time_zone(zone = ::Time.zone)

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.zoneas 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 activesupport/lib/active_support/core_ext/time/zones.rb, line 89
def in_time_zone(zone = ::Time.zone)
  if zone
    ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.find_zone!(zone))
  else
    self
  end
end
local_time(*args)

DEPRECATED: Use +Time#local+ instead.

Wraps class method time_with_datetime_fallbackwith utc_or_localset to :local.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 59
def local_time(*args)
  ActiveSupport::Deprecation.warn 'local_time is deprecated. Use Time#local instead', caller
  time_with_datetime_fallback(:local, *args)
end
midnight()
Alias for: beginning_of_day
minus_with_coercion(other)

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

Also aliased as: -
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 272
def minus_with_coercion(other)
  other = other.comparable_time if other.respond_to?(:comparable_time)
  other.is_a?(DateTime) ? to_f - other.to_f : minus_without_coercion(other)
end
minus_without_coercion(other)
Alias for: -
minus_without_duration(other)
Alias for: -
seconds_since_midnight()

Seconds since midnight: Time.now.seconds_since_midnight

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 88
def seconds_since_midnight
  to_i - change(:hour => 0).to_i + (usec / 1.0e+6)
end
seconds_until_end_of_day()

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
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 97
def seconds_until_end_of_day
  end_of_day.to_i - to_i
end
since(seconds)

Returns a new Time representing the time a number of seconds since the instance time

Also aliased as: in
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 165
def since(seconds)
  self + seconds
rescue
  to_datetime.since(seconds)
end
time_with_datetime_fallback(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0, usec=0)

DEPRECATED: Use +Time#utc+ or +Time#local+ instead.

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 activesupport/lib/active_support/core_ext/time/calculations.rb, line 34
def time_with_datetime_fallback(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0, usec=0)
  ActiveSupport::Deprecation.warn 'time_with_datetime_fallback is deprecated. Use Time#utc or Time#local instead', caller
  time = ::Time.send(utc_or_local, year, month, day, hour, min, sec, usec)

  # This check is needed because Time.utc(y) returns a time object in the 2000s for 0 <= y <= 138.
  if time.year == year
    time
  else
    ::DateTime.civil_from_format(utc_or_local, year, month, day, hour, min, sec)
  end
rescue
  ::DateTime.civil_from_format(utc_or_local, year, month, day, hour, min, sec)
end
to_default_s(format = :default)
Alias for: to_s
to_formatted_s(format = :default)

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"

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]  = ->(time) { time.strftime("%B #{time.day.ordinalize}") }
Also aliased as: to_s
# File activesupport/lib/active_support/core_ext/time/conversions.rb, line 46
def to_formatted_s(format = :default)
  if formatter = DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_default_s
  end
end
to_s(format = :default)
Also aliased as: to_default_s
Alias for: to_formatted_s
use_zone(time_zone)

Allows override of Time.zonelocally inside supplied block; resets Time.zoneto existing value when done.

# File activesupport/lib/active_support/core_ext/time/zones.rb, line 41
def use_zone(time_zone)
  new_zone = find_zone!(time_zone)
  begin
    old_zone, ::Time.zone = ::Time.zone, new_zone
    yield
  ensure
    ::Time.zone = old_zone
  end
end
utc_time(*args)

DEPRECATED: Use +Time#utc+ instead.

Wraps class method time_with_datetime_fallbackwith utc_or_localset to :utc.

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 51
def utc_time(*args)
  ActiveSupport::Deprecation.warn 'utc_time is deprecated. Use Time#utc instead', caller
  time_with_datetime_fallback(:utc, *args)
end
zone()

Returns the TimeZone for the current request, if this has been set (via #zone=). If Time.zone has not been set for the current request, returns the TimeZone specified in config.time_zone.

# File activesupport/lib/active_support/core_ext/time/zones.rb, line 9
def zone
  Thread.current[:time_zone] || zone_default
end
zone=(time_zone)

Sets Time.zoneto 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.zoneon a per request basis and reset it when the request is done. current_user.time_zonejust 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
    if logged_in?
      Time.use_zone(current_user.time_zone) { yield }
    else
      yield
    end
  end
end
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 36
def zone=(time_zone)
  Thread.current[:time_zone] = find_zone!(time_zone)
end