123456789_123456789_123456789_123456789_123456789_

Class: Time

Constant Summary

::DateAndTime::Calculations - Included

DAYS_INTO_WEEK

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

::DateAndTime::Compatibility - Included

::DateAndTime::Calculations - Included

#future?

Returns true if the date/time is in the future.

#past?

Returns true if the date/time is in the past.

#today?

Returns true if the date/time is today.

Instance Method Summary

::DateAndTime::Calculations - Included

#all_month

Returns a ::Range representing the whole month of the current date/time.

#all_quarter

Returns a ::Range representing the whole quarter of the current date/time.

#all_week

Returns a ::Range representing the whole week of the current date/time.

#all_year

Returns a ::Range representing the whole year of the current date/time.

#at_beginning_of_month
#at_beginning_of_quarter
#at_beginning_of_week
#at_beginning_of_year
#at_end_of_month
#at_end_of_quarter
#at_end_of_week
#at_end_of_year
#beginning_of_month

Returns a new date/time at the start of the month.

#beginning_of_quarter

Returns a new date/time at the start of the quarter.

#beginning_of_week

Returns a new date/time representing the start of this week on the given day.

#beginning_of_year

Return a new date/time at the beginning of the year.

#days_ago

Returns a new date/time the specified number of days ago.

#days_since

Returns a new date/time the specified number of days in the future.

#days_to_week_start

Returns the number of days to the start of the week on the given day.

#end_of_month

Returns a new date/time representing the end of the month.

#end_of_quarter

Returns a new date/time at the end of the quarter.

#end_of_week

Returns a new date/time representing the end of this week on the given day.

#end_of_year

Returns a new date/time representing the end of the year.

#last_month
#last_quarter
#last_week
#last_year
#monday

Returns Monday of this week assuming that week starts on Monday.

#months_ago

Returns a new date/time the specified number of months ago.

#months_since

Returns a new date/time the specified number of months in the future.

#next_month

Short-hand for months_since(1).

#next_quarter

Short-hand for months_since(3).

#next_week

Returns a new date/time representing the given day in the next week.

#next_year

Short-hand for years_since(1).

#prev_month

Short-hand for months_ago(1).

#prev_quarter

Short-hand for months_ago(3).

#prev_week

Returns a new date/time representing the given day in the previous week.

#prev_year

Short-hand for years_ago(1).

#sunday

Returns Sunday of this week assuming that week starts on Monday.

#tomorrow

Returns a new date/time representing tomorrow.

#weeks_ago

Returns a new date/time the specified number of weeks ago.

#weeks_since

Returns a new date/time the specified number of weeks in the future.

#years_ago

Returns a new date/time the specified number of years ago.

#years_since

Returns a new date/time the specified number of years in the future.

#yesterday

Returns a new date/time representing yesterday.

::DateAndTime::Zones - Included

#in_time_zone

Returns the simultaneous time in .zone if a zone is given or if .zone_default is set.

Class Attribute Details

.zone (rw)

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 12

def zone
  Thread.current[:time_zone] || zone_default
end

.zone=(time_zone) (rw)

Sets .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 .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
    if logged_in?
      Time.use_zone(current_user.time_zone) { yield }
    else
      yield
    end
  end
end
[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 39

def zone=(time_zone)
  Thread.current[:time_zone] = find_zone!(time_zone)
end

.zone_default (rw)

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 8

attr_accessor :zone_default

Class Method Details

.===(other)

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 15

def ===(other)
  super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone))
end

._load(marshaled_time)

[ GitHub ]

  
# 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

._load_without_zone

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/marshal.rb', line 7

alias_method :_load_without_zone, :_load

.at(*args)

Alias for .at_with_coercion.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 49

alias_method :at, :at_with_coercion

.at_with_coercion(*args) Also known as: .at

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 36

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

.at_without_coercion

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 48

alias_method :at_without_coercion, :at

.current

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 30

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.

[ GitHub ]

  
# 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

.find_zone(time_zone)

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 75

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.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 55

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

.use_zone(time_zone)

Allows override of .zone locally inside supplied block; resets .zone to existing value when done.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 44

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

Instance Attribute Details

#acts_like_time?Boolean (readonly)

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/acts_like.rb', line 5

def acts_like_time?
  true
end

Instance Method Details

#+(other)

Alias for #plus_with_duration.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 234

alias_method :+, :plus_with_duration

#-(other) Also known as: #minus_without_coercion

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 244

alias_method :-, :minus_with_duration

#<=>(other)

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 269

alias_method :<=>, :compare_with_coercion

#_dump(*args)

[ GitHub ]

  
# 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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/marshal.rb', line 23

alias_method :_dump_without_zone, :_dump

#advance(options)

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

Time.new(2015, 8, 1, 14, 35, 0).advance(seconds: 1) # => 2015-08-01 14:35:01 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(minutes: 1) # => 2015-08-01 14:36:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(hours: 1)   # => 2015-08-01 15:35:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(days: 1)    # => 2015-08-02 14:35:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(weeks: 1)   # => 2015-08-08 14:35:00 -0700
[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 121

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)
  d = d.gregorian if d.julian?
  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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 148

def ago(seconds)
  since(-seconds)
end

#all_day

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 222

def all_day
  beginning_of_day..end_of_day
end

#at_beginning_of_day

Alias for #beginning_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 167

alias :at_beginning_of_day :beginning_of_day

#at_beginning_of_hour

Alias for #beginning_of_hour.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 194

alias :at_beginning_of_hour :beginning_of_hour

#at_beginning_of_minute

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 210

alias :at_beginning_of_minute :beginning_of_minute

#at_end_of_day

Alias for #end_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 188

alias :at_end_of_day :end_of_day

#at_end_of_hour

Alias for #end_of_hour.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 204

alias :at_end_of_hour :end_of_hour

#at_end_of_minute

Alias for #end_of_minute.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 219

alias :at_end_of_minute :end_of_minute

#at_midday

Alias for #middle_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 175

alias :at_midday :middle_of_day

#at_middle_of_day

Alias for #middle_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 177

alias :at_middle_of_day :middle_of_day

#at_midnight

Alias for #beginning_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 166

alias :at_midnight :beginning_of_day

#at_noon

Alias for #middle_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 176

alias :at_noon :middle_of_day

#beginning_of_day Also known as: #midnight, #at_midnight, #at_beginning_of_day

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 161

def beginning_of_day
  #(self - seconds_since_midnight).change(usec: 0)
  change(:hour => 0)
end

#beginning_of_hour Also known as: #at_beginning_of_hour

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 191

def beginning_of_hour
  change(:min => 0)
end

#beginning_of_minute Also known as: #at_beginning_of_minute

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 207

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 options parameter. The time options (:hour, :min, :sec, :usec, :nsec) reset cascadingly, so if only the hour is passed, then minute, sec, usec and nsec is set to 0. If the hour and minute is passed, then sec, usec and nsec is set to 0. The options parameter takes a hash with any of these keys: :year, :month, :day, :hour, :min, :sec, :usec :nsec. Path either :usec or :nsec, not both.

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)
[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 85

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)

  if new_nsec = options[:nsec]
    raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec]
    new_usec = Rational(new_nsec, 1000)
  else
    new_usec  = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))
  end

  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
    raise ArgumentError, 'argument out of range' if new_usec >= 1000000
    ::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) Also known as: #<=>

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 258

def compare_with_coercion(other)
  # we're avoiding Time#to_datetime cause it's expensive
  if other.class == Time
    compare_without_coercion(other)
  elsif other.is_a?(Time)
    compare_without_coercion(other.to_time)
  else
    to_datetime <=> other
  end
end

#compare_without_coercion

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 268

alias_method :compare_without_coercion, :<=>

#end_of_day Also known as: #at_end_of_day

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 180

def end_of_day
  change(
    :hour => 23,
    :min => 59,
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end

#end_of_hour Also known as: #at_end_of_hour

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 197

def end_of_hour
  change(
    :min => 59,
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end

#end_of_minute Also known as: #at_end_of_minute

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 213

def end_of_minute
  change(
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end

#eql?(other)

Alias for #eql_with_coercion.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 279

alias_method :eql?, :eql_with_coercion

#eql_with_coercion(other) Also known as: #eql?

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 273

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 278

alias_method :eql_without_coercion, :eql?

#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"
[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 62

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.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 158

alias :in :since

#midday

Alias for #middle_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 173

alias :midday :middle_of_day

#middle_of_day Also known as: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day

Returns a new Time representing the middle of the day (12:00)

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 170

def middle_of_day
  change(:hour => 12)
end

#midnight

Alias for #beginning_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 165

alias :midnight :beginning_of_day

#minus_with_coercion(other) Also known as: #-

#- 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 #- will recognize

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 249

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 #-.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 253

alias_method :minus_without_coercion, :-

#minus_without_duration

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 243

alias_method :minus_without_duration, :-

#noon

Alias for #middle_of_day.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 174

alias :noon :middle_of_day

#plus_without_duration

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 233

alias_method :plus_without_duration, :+

#sec_fraction

Returns the fraction of a second as a Rational

Time.new(2012, 8, 29, 0, 0, 0.5).sec_fraction # => (1/2)
[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 69

def sec_fraction
  subsec
end

#seconds_since_midnight

Seconds since midnight: Time.now.seconds_since_midnight

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 53

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
[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 62

def seconds_until_end_of_day
  end_of_day.to_i - to_i
end

#since(seconds) Also known as: #in

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 153

def since(seconds)
  self + seconds
rescue
  to_datetime.since(seconds)
end

#to_default_s

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 55

alias_method :to_default_s, :to_s

#to_formatted_s(format = :default) Also known as: #to_s

Converts to a formatted string. See DATE_FORMATS for built-in 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"
time.to_formatted_s(:iso8601)      # => "2007-01-18T06:10:17-06:00"

Adding your own time formats to to_formatted_s

You can add your own formats to the 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}") }
[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 48

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)

Alias for #to_formatted_s.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 56

alias_method :to_s, :to_formatted_s

#to_time

Either return self or the time in the local system timezone depending on the setting of ActiveSupport.to_time_preserves_timezone.

[ GitHub ]

  
# File 'activesupport/lib/active_support/core_ext/time/compatibility.rb', line 11

def to_time
  preserve_timezone ? self : getlocal
end