Class: Time
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
ActiveRecord::Type::Time::Value
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
Inherits: | Object |
Defined in: | activesupport/lib/active_support/core_ext/time/zones.rb, activesupport/lib/active_support/core_ext/object/blank.rb, activesupport/lib/active_support/core_ext/object/json.rb, activesupport/lib/active_support/core_ext/time/acts_like.rb, activesupport/lib/active_support/core_ext/time/calculations.rb, activesupport/lib/active_support/core_ext/time/compatibility.rb, activesupport/lib/active_support/core_ext/time/conversions.rb |
Constant Summary
-
COMMON_YEAR_DAYS_IN_MONTH =
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 14[nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
-
DATE_FORMATS =
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 8{ db: "%Y-%m-%d %H:%M:%S", inspect: "%Y-%m-%d %H:%M:%S.%9N %z", number: "%Y%m%d%H%M%S", nsec: "%Y%m%d%H%M%S%9N", usec: "%Y%m%d%H%M%S%6N", 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}") }, iso8601: lambda { |time| time.iso8601 } }
::DateAndTime::Calculations
- Included
Class Attribute Summary
-
.zone
rw
Returns the TimeZone for the current request, if this has been set (via .zone=).
-
.zone=(time_zone)
rw
Sets .zone to a TimeZone object for the current request/thread.
- .zone_default rw
Class Method Summary
-
.===(other)
Overriding case equality method so that it returns true for
::ActiveSupport::TimeWithZone
instances. -
.at(*args, **kwargs)
Alias for .at_with_coercion.
-
.at_with_coercion(*args, **kwargs)
(also: .at)
Layers additional behavior on .at so that
::ActiveSupport::TimeWithZone
and::DateTime
instances can be used when called with a single argument. - .at_without_coercion
-
.current
Returns
Time.zone.now
when .zone orconfig.time_zone
are set, otherwise just returnsTime.now
. -
.days_in_month(month, year = current.year)
Returns the number of days in the given month.
-
.days_in_year(year = current.year)
Returns the number of days in the given year.
-
.find_zone(time_zone)
Returns a TimeZone instance matching the time zone provided.
-
.find_zone!(time_zone)
Returns a TimeZone instance matching the time zone provided.
-
.rfc3339(str)
Creates a
Time
instance from an RFC 3339 string. - .use_zone(time_zone)
Instance Attribute Summary
-
#acts_like_time? ⇒ Boolean
readonly
Duck-types as a Time-like class.
::DateAndTime::Compatibility
- Included
::DateAndTime::Calculations
- Included
#future? | Returns true if the date/time is in the future. |
#next_day? | Alias for DateAndTime::Calculations#tomorrow?. |
#on_weekday? | Returns true if the date/time does not fall on a Saturday or Sunday. |
#on_weekend? | Returns true if the date/time falls on a Saturday or Sunday. |
#past? | Returns true if the date/time is in the past. |
#prev_day? | Alias for DateAndTime::Calculations#yesterday?. |
#today? | Returns true if the date/time is today. |
#tomorrow | Returns a new date/time representing tomorrow. |
#tomorrow? | Returns true if the date/time is tomorrow. |
#yesterday | Returns a new date/time representing yesterday. |
#yesterday? | Returns true if the date/time is yesterday. |
Instance Method Summary
-
#+(other)
Alias for #plus_with_duration.
-
#-(other)
(also: #minus_without_coercion)
Alias for #minus_with_coercion.
-
#<=>(other)
Alias for #compare_with_coercion.
-
#advance(options)
Uses Date to provide precise
Time
calculations for years, months, and days according to the proleptic Gregorian calendar. -
#ago(seconds)
Returns a new
Time
representing the time a number of seconds ago, this is basically a wrapper around the::Numeric
extension. -
#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_midday
Alias for #middle_of_day.
-
#at_middle_of_day
Alias for #middle_of_day.
-
#at_midnight
Alias for #beginning_of_day.
-
#at_noon
Alias for #middle_of_day.
-
#beginning_of_day
(also: #midnight, #at_midnight, #at_beginning_of_day)
Returns a new
Time
representing the start of the day (0:00). -
#beginning_of_hour
(also: #at_beginning_of_hour)
Returns a new
Time
representing the start of the hour (x:00). -
#beginning_of_minute
(also: #at_beginning_of_minute)
Returns a new
Time
representing the start of the minute (x:xx:00). - #ceil(precision = 0)
-
#change(options)
Returns a new
Time
where one or more of the elements have been changed according to theoptions
parameter. -
#compare_with_coercion(other)
(also: #<=>)
Layers additional behavior on #<=> so that
::DateTime
and::ActiveSupport::TimeWithZone
instances can be chronologically compared with aTime
. - #compare_without_coercion
-
#end_of_day
(also: #at_end_of_day)
Returns a new
Time
representing the end of the day, 23:59:59.999999. -
#end_of_hour
(also: #at_end_of_hour)
Returns a new
Time
representing the end of the hour, x:59:59.999999. -
#end_of_minute
(also: #at_end_of_minute)
Returns a new
Time
representing the end of the minute, x:xx:59.999999. -
#eql?(other)
Alias for #eql_with_coercion.
-
#eql_with_coercion(other)
(also: #eql?)
Layers additional behavior on #eql? so that
::ActiveSupport::TimeWithZone
instances can be eql? to an equivalentTime
. - #eql_without_coercion
- #floor(precision = 0)
-
#formatted_offset(colon = true, alternate_utc_string = nil)
Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC.
-
#in(seconds)
Alias for #since.
-
#midday
Alias for #middle_of_day.
-
#middle_of_day
(also: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day)
Returns a new
Time
representing the middle of the day (12:00). -
#midnight
Alias for #beginning_of_day.
-
#minus_with_coercion(other)
(also: #-)
#- can also be used to determine the number of seconds between two
Time
instances. -
#minus_without_coercion(other)
Alias for #-.
- #minus_without_duration
-
#next_day(days = 1)
Returns a new time the specified number of days in the future.
-
#next_month(months = 1)
Returns a new time the specified number of months in the future.
-
#next_year(years = 1)
Returns a new time the specified number of years in the future.
-
#noon
Alias for #middle_of_day.
- #plus_without_duration
-
#prev_day(days = 1)
Returns a new time the specified number of days ago.
-
#prev_month(months = 1)
Returns a new time the specified number of months ago.
-
#prev_year(years = 1)
Returns a new time the specified number of years ago.
-
#rfc3339
Aliased to
xmlschema
for compatibility with::DateTime
-
#sec_fraction
Returns the fraction of a second as a
Rational
-
#seconds_since_midnight
Returns the number of seconds since 00:00:00.
-
#seconds_until_end_of_day
Returns the number of seconds until 23:59:59.
-
#since(seconds)
(also: #in)
Returns a new
Time
representing the time a number of seconds since the instance time. -
#to_default_s
deprecated
Deprecated.
use to_s instead
-
#to_formatted_s(format = :default)
Alias for #to_fs.
-
#to_fs(format = :default)
(also: #to_formatted_s)
Converts to a formatted string.
-
#to_time
Either return
self
or the time in the local system timezone depending on the setting of ActiveSupport.to_time_preserves_timezone.
::DateAndTime::Calculations
- Included
#after? | Returns true if the date/time falls after |
#all_day | Returns a |
#all_month | Returns a |
#all_quarter | Returns a |
#all_week | Returns a |
#all_year | Returns a |
#at_beginning_of_month | Alias for DateAndTime::Calculations#beginning_of_month. |
#at_beginning_of_quarter | |
#at_beginning_of_week | Alias for DateAndTime::Calculations#beginning_of_week. |
#at_beginning_of_year | Alias for DateAndTime::Calculations#beginning_of_year. |
#at_end_of_month | Alias for DateAndTime::Calculations#end_of_month. |
#at_end_of_quarter | Alias for DateAndTime::Calculations#end_of_quarter. |
#at_end_of_week | Alias for DateAndTime::Calculations#end_of_week. |
#at_end_of_year | Alias for DateAndTime::Calculations#end_of_year. |
#before? | Returns true if the date/time falls before |
#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 | Returns 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 | Short-hand for |
#last_quarter | Alias for DateAndTime::Calculations#prev_quarter. |
#last_week | Alias for DateAndTime::Calculations#prev_week. |
#last_weekday | Alias for DateAndTime::Calculations#prev_weekday. |
#last_year | Short-hand for |
#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_occurring | Returns a new date/time representing the next occurrence of the specified day of week. |
#next_quarter | Short-hand for |
#next_week | Returns a new date/time representing the given day in the next week. |
#next_weekday | Returns a new date/time representing the next weekday. |
#prev_occurring | Returns a new date/time representing the previous occurrence of the specified day of week. |
#prev_quarter | Short-hand for |
#prev_week | Returns a new date/time representing the given day in the previous week. |
#prev_weekday | Returns a new date/time representing the previous weekday. |
#quarter | Returns the quarter for a date/time. |
#sunday | Returns Sunday of this week assuming that week starts on Monday. |
#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. |
::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
.
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 14
def zone ::ActiveSupport::IsolatedExecutionState[: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_action :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 41
def zone=(time_zone) ::ActiveSupport::IsolatedExecutionState[:time_zone] = find_zone!(time_zone) end
.zone_default (rw)
[ GitHub ]# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 10
attr_accessor :zone_default
Class Method Details
.===(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 18
def ===(other) super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone)) end
.at(*args, **kwargs)
Alias for .at_with_coercion.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 60
alias_method :at, :at_with_coercion
.at_with_coercion(*args, **kwargs) 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
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 45
def at_with_coercion(*args, **kwargs) return at_without_coercion(*args, **kwargs) if args.size != 1 || !kwargs.empty? # Time.at can be called with a time or numerical value time_or_number = args.first if time_or_number.is_a?(ActiveSupport::TimeWithZone) at_without_coercion(time_or_number.to_r).getlocal elsif 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 59
alias_method :at_without_coercion, :at
.current
Returns Time.zone.now
when .zone or config.time_zone
are set, otherwise just returns Time.now
.
.days_in_month(month, year = current.year)
Returns 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 24
def days_in_month(month, year = current.year) if month == 2 && ::Date.gregorian_leap?(year) 29 else COMMON_YEAR_DAYS_IN_MONTH[month] end end
.days_in_year(year = current.year)
Returns the number of days in the given year. If no year is specified, it will use the current year.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 34
def days_in_year(year = current.year) days_in_month(2, year) + 337 end
.find_zone(time_zone)
Returns a TimeZone instance matching the time zone provided. Accepts the time zone in any format supported by .zone=. Returns nil
for invalid time zones.
Time.find_zone "America/New_York" # => #<ActiveSupport::TimeZone @name="America/New_York" ...>
Time.find_zone "NOT-A-TIMEZONE" # => nil
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 93
def find_zone(time_zone) find_zone!(time_zone) rescue nil end
.find_zone!(time_zone)
Returns a TimeZone instance matching the time zone provided. Accepts the time zone in any format supported by .zone=. Raises an ArgumentError
for invalid time zones.
Time.find_zone! "America/New_York" # => #<ActiveSupport::TimeZone @name="America/New_York" ...>
Time.find_zone! "EST" # => #<ActiveSupport::TimeZone @name="EST" ...>
Time.find_zone! -5.hours # => #<ActiveSupport::TimeZone @name="Bogota" ...>
Time.find_zone! nil # => nil
Time.find_zone! false # => false
Time.find_zone! "NOT-A-TIMEZONE" # => ArgumentError: Invalid Timezone: NOT-A-TIMEZONE
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 81
def find_zone!(time_zone) return time_zone unless time_zone ActiveSupport::TimeZone[time_zone] || raise(ArgumentError, "Invalid Timezone: #{time_zone}") end
.rfc3339(str)
Creates a Time
instance from an RFC 3339 string.
Time.rfc3339('1999-12-31T14:00:00-10:00') # => 2000-01-01 00:00:00 -1000
If the time or offset components are missing then an ArgumentError
will be raised.
Time.rfc3339('1999-12-31') # => ArgumentError: invalid date
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 69
def rfc3339(str) parts = Date._rfc3339(str) raise ArgumentError, "invalid date" if parts.empty? Time.new( parts.fetch(:year), parts.fetch(:mon), parts.fetch(:mday), parts.fetch(:hour), parts.fetch(:min), parts.fetch(:sec) + parts.fetch(:sec_fraction, 0), parts.fetch(:offset) ) end
.use_zone(time_zone)
Allows override of .zone locally inside supplied block; resets .zone to existing value when done.
class ApplicationController < ActionController::Base
around_action :set_time_zone
private
def set_time_zone
Time.use_zone(current_user.timezone) { yield }
end
end
NOTE: This won’t affect any ::ActiveSupport::TimeWithZone
objects that have already been created, e.g. any model timestamp attributes that have been read before the block will remain in the application’s default timezone.
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 61
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?.
# File 'activesupport/lib/active_support/core_ext/time/acts_like.rb', line 7
def acts_like_time? true end
Instance Method Details
#+(other)
Alias for #plus_with_duration.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 308
alias_method :+, :plus_with_duration
#-(other) Also known as: #minus_without_coercion
Alias for #minus_with_coercion.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 328
alias_method :-, :minus_with_duration
#<=>(other)
Alias for #compare_with_coercion.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 343
alias_method :<=>, :compare_with_coercion
#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
Just like Date#advance, increments are applied in order of time units from largest to smallest. This order can affect the result around the end of a month.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 202
def advance( ) unless [:weeks].nil? [:weeks], partial_weeks = [:weeks].divmod(1) [:days] = .fetch(:days, 0) + 7 * partial_weeks end unless [:days].nil? [:days], partial_days = [:days].divmod(1) [:hours] = .fetch(:hours, 0) + 24 * partial_days end d = to_date.gregorian.advance( ) time_advanced_by_date = change(year: d.year, month: d.month, day: d.day) seconds_to_advance = \ .fetch(:seconds, 0) + .fetch(:minutes, 0) * 60 + .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 228
def ago(seconds) since(-seconds) end
#at_beginning_of_day
Alias for #beginning_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 246
alias :at_beginning_of_day :beginning_of_day
#at_beginning_of_hour
Alias for #beginning_of_hour.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 273
alias :at_beginning_of_hour :beginning_of_hour
#at_beginning_of_minute
Alias for #beginning_of_minute.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 289
alias :at_beginning_of_minute :beginning_of_minute
#at_end_of_day
Alias for #end_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 267
alias :at_end_of_day :end_of_day
#at_end_of_hour
Alias for #end_of_hour.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 283
alias :at_end_of_hour :end_of_hour
#at_end_of_minute
Alias for #end_of_minute.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 298
alias :at_end_of_minute :end_of_minute
#at_midday
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 254
alias :at_midday :middle_of_day
#at_middle_of_day
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 256
alias :at_middle_of_day :middle_of_day
#at_midnight
Alias for #beginning_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 245
alias :at_midnight :beginning_of_day
#at_noon
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 255
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)
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 241
def beginning_of_day 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)
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 270
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)
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 286
def beginning_of_minute change(sec: 0) end
#ceil(precision = 0)
[ GitHub ]# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 121
def ceil(precision = 0) change(nsec: 0) + subsec.ceil(precision) 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
, :offset
. Pass 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)
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 138
def change( ) new_year = .fetch(:year, year) new_month = .fetch(:month, month) new_day = .fetch(:day, day) new_hour = .fetch(:hour, hour) new_min = .fetch(:min, [:hour] ? 0 : min) new_sec = .fetch(:sec, ( [:hour] || [:min]) ? 0 : sec) new_offset = .fetch(:offset, nil) if new_nsec = [:nsec] raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{ .inspect}" if [:usec] new_usec = Rational(new_nsec, 1000) else new_usec = .fetch(:usec, ( [:hour] || [:min] || [:sec]) ? 0 : Rational(nsec, 1000)) end raise ArgumentError, "argument out of range" if new_usec >= 1000000 new_sec += Rational(new_usec, 1000000) if new_offset ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, new_offset) elsif utc? ::Time.utc(new_year, new_month, new_day, new_hour, new_min, new_sec) elsif zone&.respond_to?(:utc_to_local) new_time = ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, zone) # When there are two occurrences of a nominal time due to DST ending, # `Time.new` chooses the first chronological occurrence (the one with a # larger UTC offset). However, for `change`, we want to choose the # occurrence that matches this time's UTC offset. # # If the new time's UTC offset is larger than this time's UTC offset, the # new time might be a first chronological occurrence. So we add the offset # difference to fast-forward the new time, and check if the result has the # desired UTC offset (i.e. is the second chronological occurrence). offset_difference = new_time.utc_offset - utc_offset if offset_difference > 0 && (new_time_2 = new_time + offset_difference).utc_offset == utc_offset new_time_2 else new_time end elsif zone ::Time.local(new_sec, new_min, new_hour, new_day, new_month, new_year, nil, nil, isdst, nil) else ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, 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
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 332
def compare_with_coercion(other) # we're avoiding Time#to_datetime and Time#to_time because they're 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 342
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
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 259
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
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 276
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
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 292
def end_of_minute change( sec: 59, usec: Rational(999999999, 1000) ) end
#eql?(other)
Alias for #eql_with_coercion.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 353
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
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 347
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 352
alias_method :eql_without_coercion, :eql?
#floor(precision = 0)
[ GitHub ]# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 112
def floor(precision = 0) change(nsec: 0) + subsec.floor(precision) end
#formatted_offset(colon = true, alternate_utc_string = nil)
Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC.
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 69
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.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 238
alias :in :since
#midday
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 252
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)
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 249
def middle_of_day change(hour: 12) end
#midnight
Alias for #beginning_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 244
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
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 323
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 #-.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 327
alias_method :minus_without_coercion, :-
#minus_without_duration
[ GitHub ]# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 317
alias_method :minus_without_duration, :-
#next_day(days = 1)
Returns a new time the specified number of days in the future.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 361
def next_day(days = 1) advance(days: days) end
#next_month(months = 1)
Returns a new time the specified number of months in the future.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 371
def next_month(months = 1) advance(months: months) end
#next_year(years = 1)
Returns a new time the specified number of years in the future.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 381
def next_year(years = 1) advance(years: years) end
#noon
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 253
alias :noon :middle_of_day
#plus_without_duration
[ GitHub ]# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 307
alias_method :plus_without_duration, :+
#prev_day(days = 1)
Returns a new time the specified number of days ago.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 356
def prev_day(days = 1) advance(days: -days) end
#prev_month(months = 1)
Returns a new time the specified number of months ago.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 366
def prev_month(months = 1) advance(months: -months) end
#prev_year(years = 1)
Returns a new time the specified number of years ago.
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 376
def prev_year(years = 1) advance(years: -years) end
#rfc3339
Aliased to xmlschema
for compatibility with ::DateTime
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 74
alias_method :rfc3339, :xmlschema
#sec_fraction
Returns the fraction of a second as a Rational
Time.new(2012, 8, 29, 0, 0, 0.5).sec_fraction # => (1/2)
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 107
def sec_fraction subsec end
#seconds_since_midnight
Returns the number of seconds since 00:00:00.
Time.new(2012, 8, 29, 0, 0, 0).seconds_since_midnight # => 0.0
Time.new(2012, 8, 29, 12, 34, 56).seconds_since_midnight # => 45296.0
Time.new(2012, 8, 29, 23, 59, 59).seconds_since_midnight # => 86399.0
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 91
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 100
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
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 233
def since(seconds) self + seconds rescue to_datetime.since(seconds) end
#to_default_s
use to_s instead
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 61
alias_method :to_default_s, :to_s
#to_formatted_s(format = :default)
Alias for #to_fs.
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 60
alias_method :to_formatted_s, :to_fs
#to_fs(format = :default) Also known as: #to_formatted_s
Converts to a formatted string. See DATE_FORMATS for built-in formats.
This method is aliased to #to_formatted_s.
time = Time.now # => 2007-01-18 06:10:17 -06:00
time.to_fs(:time) # => "06:10"
time.to_formatted_s(:time) # => "06:10"
time.to_fs(:db) # => "2007-01-18 06:10:17"
time.to_fs(:number) # => "20070118061017"
time.to_fs(:short) # => "18 Jan 06:10"
time.to_fs(:long) # => "January 18, 2007 06:10"
time.to_fs(:long_ordinal) # => "January 18th, 2007 06:10"
time.to_fs(:rfc822) # => "Thu, 18 Jan 2007 06:10:17 -0600"
time.to_fs(:iso8601) # => "2007-01-18T06:10:17-06:00"
Adding your own time formats to to_fs
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}") }
# File 'activesupport/lib/active_support/core_ext/time/conversions.rb', line 53
def to_fs(format = :default) if formatter = DATE_FORMATS[format] formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter) else to_s end end
#to_time
Either return self
or the time in the local system timezone depending on the setting of ActiveSupport.to_time_preserves_timezone.
# File 'activesupport/lib/active_support/core_ext/time/compatibility.rb', line 13
def to_time preserve_timezone ? self : getlocal end