Class: Time
- Defined in:
- lib/active_support/json/encoding.rb,
lib/active_support/core_ext/time/zones.rb,
lib/active_support/core_ext/time/marshal.rb,
lib/active_support/core_ext/time/marshal.rb,
lib/active_support/core_ext/time/acts_like.rb,
lib/active_support/core_ext/time/conversions.rb,
lib/active_support/core_ext/time/calculations.rb,
lib/active_support/core_ext/time/publicize_conversion_methods.rb
Constant Summary collapse
- DATE_FORMATS =
{ :db => "%Y-%m-%d %H:%M:%S", :number => "%Y%m%d%H%M%S", :time => "%H:%M", :short => "%d %b %H:%M", :long => "%B %d, %Y %H:%M", :long_ordinal => lambda { |time| time.strftime("%B #{ActiveSupport::Inflector.ordinalize(time.day)}, %Y %H:%M") }, :rfc822 => lambda { |time| time.strftime("%a, %d %b %Y %H:%M:%S #{time.formatted_offset(false)}") } }
- COMMON_YEAR_DAYS_IN_MONTH =
[nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
- DAYS_INTO_WEEK =
{ :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6 }
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_utc_flag ⇒ Object
- ._load_without_zone ⇒ Object
-
.current ⇒ Object
Returns
Time.zone.now
whenconfig.time_zone
is set, otherwise just returnsTime.now
. -
.days_in_month(month, year = now.year) ⇒ Object
Return the number of days in the given month.
-
.local_time(*args) ⇒ Object
Wraps class method
time_with_datetime_fallback
withutc_or_local
set to:local
. -
.time_with_datetime_fallback(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0, usec = 0) ⇒ Object
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.
-
.use_zone(time_zone) ⇒ Object
Allows override of
Time.zone
locally inside supplied block; resetsTime.zone
to existing value when done. -
.utc_time(*args) ⇒ Object
Wraps class method
time_with_datetime_fallback
withutc_or_local
set to:utc
. -
.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_utc_flag ⇒ 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.
-
#ago(seconds) ⇒ Object
Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension.
-
#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_month ⇒ Object
(also: #at_beginning_of_month)
Returns a new Time representing the start of the month (1st of the month, 0:00).
-
#beginning_of_quarter ⇒ Object
(also: #at_beginning_of_quarter)
Returns a new Time representing the start of the quarter (1st of january, april, july, october, 0:00).
-
#beginning_of_week ⇒ Object
(also: #monday, #at_beginning_of_week)
Returns a new Time representing the “start” of this week (Monday, 0:00).
-
#beginning_of_year ⇒ Object
(also: #at_beginning_of_year)
Returns a new Time representing the start of the year (1st of january, 0: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
Returns a new Time representing the end of the day, 23:59:59.999999 (.999999999 in ruby1.9).
-
#end_of_month ⇒ Object
(also: #at_end_of_month)
Returns a new Time representing the end of the month (end of the last day of the month).
-
#end_of_quarter ⇒ Object
(also: #at_end_of_quarter)
Returns a new Time representing the end of the quarter (end of the last day of march, june, september, december).
-
#end_of_week ⇒ Object
(also: #at_end_of_week)
Returns a new Time representing the end of this week, (end of Sunday).
-
#end_of_year ⇒ Object
(also: #at_end_of_year)
Returns a new Time representing the end of the year (end of the 31st of december).
-
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
Returns the UTC offset as an +HH:MM formatted string.
-
#future? ⇒ Boolean
Tells whether the Time object’s time lies in the future.
-
#in_time_zone(zone = ::Time.zone) ⇒ Object
Returns the simultaneous time in
Time.zone
. -
#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:.
-
#months_ago(months) ⇒ Object
Returns a new Time representing the time a number of specified months ago.
-
#months_since(months) ⇒ Object
Returns a new Time representing the time a number of specified months in the future.
-
#next_month ⇒ Object
Short-hand for months_since(1).
-
#next_week(day = :monday) ⇒ Object
Returns a new Time representing the start of the given day in next week (default is Monday).
-
#next_year ⇒ Object
Short-hand for years_since(1).
-
#past? ⇒ Boolean
Tells whether the Time object’s time lies in the past.
-
#plus_with_duration(other) ⇒ Object
(also: #+)
:nodoc:.
-
#prev_month ⇒ Object
Short-hand for months_ago(1).
-
#prev_year ⇒ Object
Short-hand for years_ago(1).
-
#seconds_since_midnight ⇒ Object
Seconds since midnight: Time.now.seconds_since_midnight.
-
#since(seconds) ⇒ Object
(also: #in)
Returns a new Time representing the time a number of seconds since the instance time.
-
#to_date ⇒ Object
Converts a Time object to a Date, dropping hour, minute, and second precision.
-
#to_datetime ⇒ Object
Converts a Time instance to a Ruby DateTime instance, preserving UTC offset.
-
#to_formatted_s(format = :default) ⇒ Object
(also: #to_s)
Converts to a formatted string.
-
#to_time ⇒ Object
A method to keep Time, Date and DateTime instances interchangeable on conversions.
-
#today? ⇒ Boolean
Tells whether the Time object’s time is today.
-
#tomorrow ⇒ Object
Convenience method which returns a new Time representing the time 1 day since the instance time.
-
#years_ago(years) ⇒ Object
Returns a new Time representing the time a number of specified years ago.
-
#years_since(years) ⇒ Object
Returns a new Time representing the time a number of specified years in the future.
-
#yesterday ⇒ Object
Convenience method which returns a new Time representing the time 1 day ago.
Class Attribute Details
.zone_default ⇒ Object
Returns the value of attribute zone_default.
5 6 7 |
# File 'lib/active_support/core_ext/time/zones.rb', line 5 def zone_default @zone_default end |
Class Method Details
.===(other) ⇒ Object
Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances
12 13 14 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 12 def ===(other) other.is_a?(::Time) end |
._load(marshaled_time) ⇒ Object
8 9 10 11 12 13 14 15 16 |
# File 'lib/active_support/core_ext/time/marshal.rb', line 8 def _load(marshaled_time) time = _load_without_utc_flag(marshaled_time) time.instance_eval do if defined?(@marshal_with_utc_coercion) val = remove_instance_variable("@marshal_with_utc_coercion") end val ? utc : self end end |
._load_without_utc_flag ⇒ Object
7 |
# File 'lib/active_support/core_ext/time/marshal.rb', line 7 alias_method :_load_without_utc_flag, :_load |
._load_without_zone ⇒ Object
34 35 36 37 38 39 40 41 42 |
# File 'lib/active_support/core_ext/time/marshal.rb', line 34 def _load(marshaled_time) time = _load_without_utc_flag(marshaled_time) time.instance_eval do if defined?(@marshal_with_utc_coercion) val = remove_instance_variable("@marshal_with_utc_coercion") end val ? utc : self end end |
.current ⇒ Object
Returns Time.zone.now
when config.time_zone
is set, otherwise just returns Time.now
.
45 46 47 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 45 def current ::Time.zone_default ? ::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.
18 19 20 21 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 18 def days_in_month(month, year = now.year) return 29 if month == 2 && ::Date.gregorian_leap?(year) COMMON_YEAR_DAYS_IN_MONTH[month] end |
.local_time(*args) ⇒ Object
Wraps class method time_with_datetime_fallback
with utc_or_local
set to :local
.
40 41 42 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 40 def local_time(*args) time_with_datetime_fallback(:local, *args) end |
.time_with_datetime_fallback(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0, usec = 0) ⇒ Object
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
26 27 28 29 30 31 32 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 26 def time_with_datetime_fallback(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0, usec=0) 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. time.year == year ? time : ::DateTime.civil_from_format(utc_or_local, year, month, day, hour, min, sec) rescue ::DateTime.civil_from_format(utc_or_local, year, month, day, hour, min, sec) end |
.use_zone(time_zone) ⇒ Object
Allows override of Time.zone
locally inside supplied block; resets Time.zone
to existing value when done.
37 38 39 40 41 42 |
# File 'lib/active_support/core_ext/time/zones.rb', line 37 def use_zone(time_zone) old_zone, ::Time.zone = ::Time.zone, get_zone(time_zone) yield ensure ::Time.zone = old_zone end |
.utc_time(*args) ⇒ Object
Wraps class method time_with_datetime_fallback
with utc_or_local
set to :utc
.
35 36 37 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 35 def utc_time(*args) time_with_datetime_fallback(:utc, *args) 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
.
9 10 11 |
# File 'lib/active_support/core_ext/time/zones.rb', line 9 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 – current_user.time_zone
just needs to return a string identifying the user’s preferred TimeZone:
class ApplicationController < ActionController::Base
before_filter :set_time_zone
def set_time_zone
Time.zone = current_user.time_zone
end
end
32 33 34 |
# File 'lib/active_support/core_ext/time/zones.rb', line 32 def zone=(time_zone) Thread.current[:time_zone] = get_zone(time_zone) end |
Instance Method Details
#_dump(*args) ⇒ Object
20 21 22 23 24 |
# File 'lib/active_support/core_ext/time/marshal.rb', line 20 def _dump(*args) obj = dup obj.instance_variable_set('@marshal_with_utc_coercion', utc?) obj._dump_without_utc_flag(*args) end |
#_dump_without_utc_flag ⇒ Object
19 |
# File 'lib/active_support/core_ext/time/marshal.rb', line 19 alias_method :_dump_without_utc_flag, :_dump |
#_dump_without_zone ⇒ Object
49 50 51 52 53 |
# File 'lib/active_support/core_ext/time/marshal.rb', line 49 def _dump(*args) obj = dup obj.instance_variable_set('@marshal_with_utc_coercion', utc?) obj._dump_without_utc_flag(*args) end |
#acts_like_time? ⇒ Boolean
Duck-types as a Time-like class. See Object#acts_like?.
5 6 7 |
# File '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. The options
parameter takes a hash with any of these keys: :years
, :months
, :weeks
, :days
, :hours
, :minutes
, :seconds
.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 90 def advance() unless [:weeks].nil? [:weeks], partial_weeks = [:weeks].divmod(1) [:days] = ([:days] || 0) + 7 * partial_weeks end unless [:days].nil? [:days], partial_days = [:days].divmod(1) [:hours] = ([:hours] || 0) + 24 * partial_days end d = to_date.advance() time_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day) seconds_to_advance = ([:seconds] || 0) + ([:minutes] || 0) * 60 + ([:hours] || 0) * 3600 seconds_to_advance == 0 ? time_advanced_by_date : time_advanced_by_date.since(seconds_to_advance) 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
108 109 110 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 108 def ago(seconds) since(-seconds) end |
#as_json(options = nil) ⇒ Object
:nodoc:
214 215 216 217 218 219 220 |
# File 'lib/active_support/json/encoding.rb', line 214 def as_json( = nil) #:nodoc: if ActiveSupport.use_standard_json_time_format xmlschema 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)
181 182 183 184 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 181 def beginning_of_day #(self - seconds_since_midnight).change(:usec => 0) change(:hour => 0, :min => 0, :sec => 0, :usec => 0) end |
#beginning_of_month ⇒ Object Also known as: at_beginning_of_month
Returns a new Time representing the start of the month (1st of the month, 0:00)
195 196 197 198 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 195 def beginning_of_month #self - ((self.mday-1).days + self.seconds_since_midnight) change(:day => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0) end |
#beginning_of_quarter ⇒ Object Also known as: at_beginning_of_quarter
Returns a new Time representing the start of the quarter (1st of january, april, july, october, 0:00)
210 211 212 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 210 def beginning_of_quarter beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= month }) end |
#beginning_of_week ⇒ Object Also known as: monday, at_beginning_of_week
Returns a new Time representing the “start” of this week (Monday, 0:00)
161 162 163 164 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 161 def beginning_of_week days_to_monday = wday!=0 ? wday-1 : 6 (self - days_to_monday.days).midnight end |
#beginning_of_year ⇒ Object Also known as: at_beginning_of_year
Returns a new Time representing the start of the year (1st of january, 0:00)
222 223 224 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 222 def beginning_of_year change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0, :usec => 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, minute, sec, usec) reset cascadingly, so if only the hour is passed, then minute, sec, and usec is set to 0. If the hour and minute is passed, then sec and usec is set to 0.
73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 73 def change() ::Time.send( utc? ? :utc_time : :local_time, [:year] || year, [:month] || month, [:day] || day, [:hour] || hour, [:min] || ([:hour] ? 0 : min), [:sec] || (([:hour] || [:min]) ? 0 : sec), [:usec] || (([:hour] || [:min] || [:sec]) ? 0 : usec) ) 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
275 276 277 278 279 280 281 282 283 284 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 275 def compare_with_coercion(other) # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do <=> comparison other = other.comparable_time if other.respond_to?(:comparable_time) if other.acts_like?(:date) # other is a Date/DateTime, so coerce self #to_datetime and hand off to DateTime#<=> to_datetime.compare_without_coercion(other) else compare_without_coercion(other) end end |
#end_of_day ⇒ Object
Returns a new Time representing the end of the day, 23:59:59.999999 (.999999999 in ruby1.9)
190 191 192 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 190 def end_of_day change(:hour => 23, :min => 59, :sec => 59, :usec => 999999.999) end |
#end_of_month ⇒ Object Also known as: at_end_of_month
Returns a new Time representing the end of the month (end of the last day of the month)
202 203 204 205 206 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 202 def end_of_month #self - ((self.mday-1).days + self.seconds_since_midnight) last_day = ::Time.days_in_month(month, year) change(:day => last_day, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999) end |
#end_of_quarter ⇒ Object Also known as: at_end_of_quarter
Returns a new Time representing the end of the quarter (end of the last day of march, june, september, december)
216 217 218 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 216 def end_of_quarter beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= month }).end_of_month end |
#end_of_week ⇒ Object Also known as: at_end_of_week
Returns a new Time representing the end of this week, (end of Sunday)
169 170 171 172 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 169 def end_of_week days_to_sunday = wday!=0 ? 7-wday : 0 (self + days_to_sunday.days).end_of_day end |
#end_of_year ⇒ Object Also known as: at_end_of_year
Returns a new Time representing the end of the year (end of the 31st of december)
228 229 230 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 228 def end_of_year change(:month => 12, :day => 31, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999) end |
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
54 55 56 |
# File 'lib/active_support/core_ext/time/conversions.rb', line 54 def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon) end |
#future? ⇒ Boolean
Tells whether the Time object’s time lies in the future
61 62 63 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 61 def future? self > ::Time.current end |
#in_time_zone(zone = ::Time.zone) ⇒ Object
Returns the simultaneous time in Time.zone
.
Time.zone = 'Hawaii' # => 'Hawaii'
Time.utc(2000).in_time_zone # => Fri, 31 Dec 1999 14:00:00 HST -10:00
This method is similar to Time#localtime, except that it uses Time.zone
as the local zone instead of the operating system’s time zone.
You can also pass in a TimeZone instance or string that identifies a TimeZone as an argument, and the conversion will be based on that zone instead of Time.zone
.
Time.utc(2000).in_time_zone('Alaska') # => Fri, 31 Dec 1999 15:00:00 AKST -09:00
70 71 72 73 74 |
# File 'lib/active_support/core_ext/time/zones.rb', line 70 def in_time_zone(zone = ::Time.zone) return self unless zone ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.__send__(:get_zone, zone)) 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
266 267 268 269 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 266 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:
253 254 255 256 257 258 259 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 253 def minus_with_duration(other) #:nodoc: if ActiveSupport::Duration === other other.until(self) else minus_without_duration(other) end end |
#months_ago(months) ⇒ Object
Returns a new Time representing the time a number of specified months ago
121 122 123 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 121 def months_ago(months) advance(:months => -months) end |
#months_since(months) ⇒ Object
Returns a new Time representing the time a number of specified months in the future
126 127 128 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 126 def months_since(months) advance(:months => months) end |
#next_month ⇒ Object
Short-hand for months_since(1)
156 157 158 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 156 def next_month months_since(1) end |
#next_week(day = :monday) ⇒ Object
Returns a new Time representing the start of the given day in next week (default is Monday).
176 177 178 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 176 def next_week(day = :monday) since(1.week).beginning_of_week.since(DAYS_INTO_WEEK[day].day).change(:hour => 0) end |
#next_year ⇒ Object
Short-hand for years_since(1)
146 147 148 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 146 def next_year years_since(1) end |
#past? ⇒ Boolean
Tells whether the Time object’s time lies in the past
51 52 53 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 51 def past? self < ::Time.current end |
#plus_with_duration(other) ⇒ Object Also known as: +
:nodoc:
243 244 245 246 247 248 249 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 243 def plus_with_duration(other) #:nodoc: if ActiveSupport::Duration === other other.since(self) else plus_without_duration(other) end end |
#prev_month ⇒ Object
Short-hand for months_ago(1)
151 152 153 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 151 def prev_month months_ago(1) end |
#prev_year ⇒ Object
Short-hand for years_ago(1)
141 142 143 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 141 def prev_year years_ago(1) end |
#seconds_since_midnight ⇒ Object
Seconds since midnight: Time.now.seconds_since_midnight
66 67 68 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 66 def seconds_since_midnight to_i - change(:hour => 0).to_i + (usec / 1.0e+6) end |
#since(seconds) ⇒ Object Also known as: in
Returns a new Time representing the time a number of seconds since the instance time
113 114 115 116 117 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 113 def since(seconds) self + seconds rescue to_datetime.since(seconds) end |
#to_date ⇒ Object
65 66 67 |
# File 'lib/active_support/core_ext/time/conversions.rb', line 65 def to_date ::Date.new(year, month, day) end |
#to_datetime ⇒ Object
Converts a Time instance to a Ruby DateTime instance, preserving UTC offset.
my_time = Time.now # => Mon Nov 12 23:04:21 -0500 2007
my_time.to_datetime # => Mon, 12 Nov 2007 23:04:21 -0500
your_time = Time.parse("1/13/2009 1:13:03 P.M.") # => Tue Jan 13 13:13:03 -0500 2009
your_time.to_datetime # => Tue, 13 Jan 2009 13:13:03 -0500
82 83 84 |
# File 'lib/active_support/core_ext/time/conversions.rb', line 82 def to_datetime ::DateTime.civil(year, month, day, hour, min, sec, Rational(utc_offset, 86400)) 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:17"
time.to_s(:time) # => "06:10:17"
time.to_formatted_s(:db) # => "2007-01-18 06:10:17"
time.to_formatted_s(:number) # => "20070118061017"
time.to_formatted_s(:short) # => "18 Jan 06:10"
time.to_formatted_s(:long) # => "January 18, 2007 06:10"
time.to_formatted_s(:long_ordinal) # => "January 18th, 2007 06:10"
time.to_formatted_s(:rfc822) # => "Thu, 18 Jan 2007 06:10:17 -0600"
Adding your own time formats to to_formatted_s
You can add your own formats to the Time::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a time argument as the value.
# config/initializers/time_formats.rb
Time::DATE_FORMATS[:month_and_year] = "%B %Y"
Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }
40 41 42 43 44 45 46 |
# File 'lib/active_support/core_ext/time/conversions.rb', line 40 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_time ⇒ Object
A method to keep Time, Date and DateTime instances interchangeable on conversions. In this case, it simply returns self
.
71 72 73 |
# File 'lib/active_support/core_ext/time/conversions.rb', line 71 def to_time self end |
#today? ⇒ Boolean
Tells whether the Time object’s time is today
56 57 58 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 56 def today? to_date == ::Date.current end |
#tomorrow ⇒ Object
Convenience method which returns a new Time representing the time 1 day since the instance time
239 240 241 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 239 def tomorrow advance(:days => 1) end |
#years_ago(years) ⇒ Object
Returns a new Time representing the time a number of specified years ago
131 132 133 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 131 def years_ago(years) advance(:years => -years) end |
#years_since(years) ⇒ Object
Returns a new Time representing the time a number of specified years in the future
136 137 138 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 136 def years_since(years) advance(:years => years) end |
#yesterday ⇒ Object
Convenience method which returns a new Time representing the time 1 day ago
234 235 236 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 234 def yesterday advance(:days => -1) end |