Class: Time
- Includes:
- DateAndTime::Calculations, DateAndTime::Zones
- Defined in:
- activesupport/lib/active_support/core_ext/time/zones.rb,
activesupport/lib/active_support/core_ext/object/json.rb,
activesupport/lib/active_support/core_ext/time/marshal.rb,
activesupport/lib/active_support/core_ext/time/acts_like.rb,
activesupport/lib/active_support/core_ext/time/conversions.rb,
activesupport/lib/active_support/core_ext/time/calculations.rb
Constant Summary collapse
- 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}") }, :iso8601 => lambda { |time| time.iso8601 } }
- COMMON_YEAR_DAYS_IN_MONTH =
[nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
Constants included from DateAndTime::Calculations
DateAndTime::Calculations::DAYS_INTO_WEEK
Class Attribute Summary collapse
-
.zone_default ⇒ Object
Returns the value of attribute zone_default.
Class Method Summary collapse
-
.===(other) ⇒ Object
Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances.
- ._load(marshaled_time) ⇒ Object
- ._load_without_zone ⇒ Object
-
.at_with_coercion(*args) ⇒ Object
(also: at)
Layers additional behavior on Time.at so that ActiveSupport::TimeWithZone and DateTime instances can be used when called with a single argument.
-
.current ⇒ Object
Returns
Time.zone.now
whenTime.zone
orconfig.time_zone
are set, otherwise just returnsTime.now
. -
.days_in_month(month, year = now.year) ⇒ Object
Return the number of days in the given month.
- .find_zone(time_zone) ⇒ Object
-
.find_zone!(time_zone) ⇒ Object
Returns a TimeZone instance or nil, or raises an ArgumentError for invalid timezones.
-
.use_zone(time_zone) ⇒ Object
Allows override of
Time.zone
locally inside supplied block; resetsTime.zone
to existing value when done. -
.zone ⇒ Object
Returns the TimeZone for the current request, if this has been set (via Time.zone=).
-
.zone=(time_zone) ⇒ Object
Sets
Time.zone
to a TimeZone object for the current request/thread.
Instance Method Summary collapse
- #_dump(*args) ⇒ Object
- #_dump_without_zone ⇒ Object
-
#acts_like_time? ⇒ Boolean
Duck-types as a Time-like class.
-
#advance(options) ⇒ Object
Uses Date to provide precise Time calculations for years, months, and days according to the proleptic Gregorian calendar.
-
#ago(seconds) ⇒ Object
Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension.
-
#all_day ⇒ Object
Returns a Range representing the whole day of the current time.
-
#as_json(options = nil) ⇒ Object
:nodoc:.
-
#beginning_of_day ⇒ Object
(also: #midnight, #at_midnight, #at_beginning_of_day)
Returns a new Time representing the start of the day (0:00).
-
#beginning_of_hour ⇒ Object
(also: #at_beginning_of_hour)
Returns a new Time representing the start of the hour (x:00).
-
#beginning_of_minute ⇒ Object
(also: #at_beginning_of_minute)
Returns a new Time representing the start of the minute (x:xx:00).
-
#change(options) ⇒ Object
Returns a new Time where one or more of the elements have been changed according to the
options
parameter. -
#compare_with_coercion(other) ⇒ Object
(also: #<=>)
Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared with a Time.
-
#end_of_day ⇒ Object
(also: #at_end_of_day)
Returns a new Time representing the end of the day, 23:59:59.999999 (.999999999 in ruby1.9).
-
#end_of_hour ⇒ Object
(also: #at_end_of_hour)
Returns a new Time representing the end of the hour, x:59:59.999999 (.999999999 in ruby1.9).
-
#end_of_minute ⇒ Object
(also: #at_end_of_minute)
Returns a new Time representing the end of the minute, x:xx:59.999999 (.999999999 in ruby1.9).
-
#eql_with_coercion(other) ⇒ Object
(also: #eql?)
Layers additional behavior on Time#eql? so that ActiveSupport::TimeWithZone instances can be eql? to an equivalent Time.
-
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
Returns the UTC offset as an +HH:MM formatted string.
-
#middle_of_day ⇒ Object
(also: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day)
Returns a new Time representing the middle of the day (12:00).
-
#minus_with_coercion(other) ⇒ Object
(also: #-)
Time#- can also be used to determine the number of seconds between two Time instances.
-
#minus_with_duration(other) ⇒ Object
:nodoc:.
-
#plus_with_duration(other) ⇒ Object
(also: #+)
:nodoc:.
-
#seconds_since_midnight ⇒ Object
Seconds since midnight: Time.now.seconds_since_midnight.
-
#seconds_until_end_of_day ⇒ Object
Returns the number of seconds until 23:59:59.
-
#since(seconds) ⇒ Object
(also: #in)
Returns a new Time representing the time a number of seconds since the instance time.
-
#to_formatted_s(format = :default) ⇒ Object
(also: #to_s)
Converts to a formatted string.
Methods included from DateAndTime::Calculations
#all_month, #all_quarter, #all_week, #all_year, #beginning_of_month, #beginning_of_quarter, #beginning_of_week, #beginning_of_year, #days_ago, #days_since, #days_to_week_start, #end_of_month, #end_of_quarter, #end_of_week, #end_of_year, #future?, #monday, #months_ago, #months_since, #next_month, #next_quarter, #next_week, #next_year, #past?, #prev_month, #prev_quarter, #prev_week, #prev_year, #sunday, #today?, #tomorrow, #weeks_ago, #weeks_since, #years_ago, #years_since, #yesterday
Methods included from DateAndTime::Zones
Class Attribute Details
.zone_default ⇒ Object
Returns the value of attribute zone_default
7 8 9 |
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 7 def zone_default @zone_default end |
Class Method Details
.===(other) ⇒ Object
Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances
14 15 16 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 14 def ===(other) super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone)) end |
._load(marshaled_time) ⇒ Object
8 9 10 11 12 13 14 15 16 17 18 19 20 |
# 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 ⇒ Object
7 |
# File 'activesupport/lib/active_support/core_ext/time/marshal.rb', line 7 alias_method :_load_without_zone, :_load |
.at_with_coercion(*args) ⇒ Object Also known as: at
Layers additional behavior on Time.at so that ActiveSupport::TimeWithZone and DateTime instances can be used when called with a single argument
35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 35 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 |
.current ⇒ Object
Returns Time.zone.now
when Time.zone
or config.time_zone
are set, otherwise just returns Time.now
.
29 30 31 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 29 def current ::Time.zone ? ::Time.zone.now : ::Time.now end |
.days_in_month(month, year = now.year) ⇒ Object
Return the number of days in the given month. If no year is specified, it will use the current year.
20 21 22 23 24 25 26 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 20 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) ⇒ Object
74 75 76 |
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 74 def find_zone(time_zone) find_zone!(time_zone) rescue nil end |
.find_zone!(time_zone) ⇒ Object
Returns a TimeZone instance or nil, or raises an ArgumentError for invalid timezones.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 54 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) ⇒ Object
Allows override of Time.zone
locally inside supplied block; resets Time.zone
to existing value when done.
43 44 45 46 47 48 49 50 51 |
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 43 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 |
.zone ⇒ Object
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
.
11 12 13 |
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 11 def zone Thread.current[:time_zone] || zone_default end |
.zone=(time_zone) ⇒ Object
Sets Time.zone
to a TimeZone object for the current request/thread.
This method accepts any of the following:
-
A Rails TimeZone object.
-
An identifier for a Rails TimeZone object (e.g., “Eastern Time (US & Canada)”,
-5.hours
). -
A TZInfo::Timezone object.
-
An identifier for a TZInfo::Timezone object (e.g., “America/New_York”).
Here’s an example of how you might set Time.zone
on a per request basis and reset it when the request is done. current_user.time_zone
just needs to return a string identifying the user’s preferred time zone:
class ApplicationController < ActionController::Base
around_filter :set_time_zone
def set_time_zone
if logged_in?
Time.use_zone(current_user.time_zone) { yield }
else
yield
end
end
end
38 39 40 |
# File 'activesupport/lib/active_support/core_ext/time/zones.rb', line 38 def zone=(time_zone) Thread.current[:time_zone] = find_zone!(time_zone) end |
Instance Method Details
#_dump(*args) ⇒ Object
24 25 26 27 28 |
# 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 ⇒ Object
23 |
# File 'activesupport/lib/active_support/core_ext/time/marshal.rb', line 23 alias_method :_dump_without_zone, :_dump |
#acts_like_time? ⇒ Boolean
Duck-types as a Time-like class. See Object#acts_like?.
5 6 7 |
# File 'activesupport/lib/active_support/core_ext/time/acts_like.rb', line 5 def acts_like_time? true end |
#advance(options) ⇒ Object
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
.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 99 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.advance() d = d.gregorian if d.julian? 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) ⇒ Object
Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension
126 127 128 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 126 def ago(seconds) since(-seconds) end |
#all_day ⇒ Object
Returns a Range representing the whole day of the current time.
200 201 202 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 200 def all_day beginning_of_day..end_of_day end |
#as_json(options = nil) ⇒ Object
:nodoc:
164 165 166 167 168 169 170 |
# File 'activesupport/lib/active_support/core_ext/object/json.rb', line 164 def as_json( = nil) #:nodoc: if ActiveSupport::JSON::Encoding.use_standard_json_time_format xmlschema(ActiveSupport::JSON::Encoding.time_precision) else %(#{strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)}) end end |
#beginning_of_day ⇒ Object Also known as: midnight, at_midnight, at_beginning_of_day
Returns a new Time representing the start of the day (0:00)
139 140 141 142 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 139 def beginning_of_day #(self - seconds_since_midnight).change(usec: 0) change(:hour => 0) end |
#beginning_of_hour ⇒ Object Also known as: at_beginning_of_hour
Returns a new Time representing the start of the hour (x:00)
169 170 171 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 169 def beginning_of_hour change(:min => 0) end |
#beginning_of_minute ⇒ Object Also known as: at_beginning_of_minute
Returns a new Time representing the start of the minute (x:xx:00)
185 186 187 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 185 def beginning_of_minute change(:sec => 0) end |
#change(options) ⇒ Object
Returns a new Time where one or more of the elements have been changed according to the options
parameter. The time options (:hour
, :min
, :sec
, :usec
) reset cascadingly, so if only the hour is passed, then minute, sec, and usec is set to 0. If the hour and minute is passed, then sec and usec is set to 0. The options
parameter 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)
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 76 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_usec = .fetch(:usec, ([:hour] || [:min] || [: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) ⇒ Object Also known as: <=>
Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared with a Time
236 237 238 239 240 241 242 243 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 236 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 |
#end_of_day ⇒ Object 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)
158 159 160 161 162 163 164 165 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 158 def end_of_day change( :hour => 23, :min => 59, :sec => 59, :usec => Rational(999999999, 1000) ) end |
#end_of_hour ⇒ Object 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)
175 176 177 178 179 180 181 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 175 def end_of_hour change( :min => 59, :sec => 59, :usec => Rational(999999999, 1000) ) end |
#end_of_minute ⇒ Object 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)
191 192 193 194 195 196 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 191 def end_of_minute change( :sec => 59, :usec => Rational(999999999, 1000) ) end |
#eql_with_coercion(other) ⇒ Object Also known as: eql?
Layers additional behavior on Time#eql? so that ActiveSupport::TimeWithZone instances can be eql? to an equivalent Time
249 250 251 252 253 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 249 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 |
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
62 63 64 |
# 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 |
#middle_of_day ⇒ Object 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)
148 149 150 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 148 def middle_of_day change(:hour => 12) end |
#minus_with_coercion(other) ⇒ Object Also known as: -
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
227 228 229 230 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 227 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_with_duration(other) ⇒ Object
:nodoc:
214 215 216 217 218 219 220 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 214 def minus_with_duration(other) #:nodoc: if ActiveSupport::Duration === other other.until(self) else minus_without_duration(other) end end |
#plus_with_duration(other) ⇒ Object Also known as: +
:nodoc:
204 205 206 207 208 209 210 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 204 def plus_with_duration(other) #:nodoc: if ActiveSupport::Duration === other other.since(self) else plus_without_duration(other) end end |
#seconds_since_midnight ⇒ Object
Seconds since midnight: Time.now.seconds_since_midnight
52 53 54 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 52 def seconds_since_midnight to_i - change(:hour => 0).to_i + (usec / 1.0e+6) end |
#seconds_until_end_of_day ⇒ Object
61 62 63 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 61 def seconds_until_end_of_day end_of_day.to_i - to_i end |
#since(seconds) ⇒ Object Also known as: in
Returns a new Time representing the time a number of seconds since the instance time
131 132 133 134 135 |
# File 'activesupport/lib/active_support/core_ext/time/calculations.rb', line 131 def since(seconds) self + seconds rescue to_datetime.since(seconds) end |
#to_formatted_s(format = :default) ⇒ Object Also known as: to_s
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"
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 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}") }
48 49 50 51 52 53 54 |
# 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 |