- #
- A
- B
- C
- D
- E
- F
- I
- L
- M
- N
- P
- S
- T
- U
- W
- Y
- Z
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 } |
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)}") } } |
[RW] | zone_default |
Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances
# File activesupport/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
Returns Time.zone.now
when Time.zone
or
config.time_zone
are set, otherwise just returns
Time.now
.
Return the number of days in the given month. If no year is specified, it will use the current year.
Returns a TimeZone instance or nil, or raises an ArgumentError for invalid timezones.
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 53 def find_zone!(time_zone) return time_zone if time_zone.nil? || time_zone.is_a?(ActiveSupport::TimeZone) # 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 time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone.create(time_zone.name, nil, time_zone) rescue TZInfo::InvalidTimezoneIdentifier raise ArgumentError, "Invalid Timezone: #{time_zone}" end
Wraps class method time_with_datetime_fallback
with
utc_or_local
set to :local
.
Returns a new Time if requested year can be accommodated by Ruby’s Time class (i.e., if year is within either 1970..2038 or 1902..2038, depending on system architecture); otherwise returns a DateTime.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 24 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
Allows override of Time.zone
locally inside supplied block;
resets Time.zone
to existing value when done.
Wraps class method time_with_datetime_fallback
with
utc_or_local
set to :utc
.
Returns the TimeZone for the current request, if this has been set (via ::zone=). If Time.zone
has not been set for the current request, returns the TimeZone specified in
config.time_zone
.
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 old_time_zone = Time.zone Time.zone = current_user.time_zone if logged_in? yield ensure Time.zone = old_time_zone end end
Duck-types as a Time-like class. See Object#acts_like?.
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
.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 88 def advance(options) unless options[:weeks].nil? options[:weeks], partial_weeks = options[:weeks].divmod(1) options[:days] = (options[:days] || 0) + 7 * partial_weeks end unless options[:days].nil? options[:days], partial_days = options[:days].divmod(1) options[:hours] = (options[:hours] || 0) + 24 * partial_days end d = to_date.advance(options) time_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day) seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600 seconds_to_advance == 0 ? time_advanced_by_date : time_advanced_by_date.since(seconds_to_advance) end
Returns a Range representing the whole day of the current time.
Returns a Range representing the whole month of the current time.
Returns a Range representing the whole quarter of the current time.
Returns a Range representing the whole week of the current time. Week starts on start_day (default is :monday, i.e. end of Sunday).
Returns a Range representing the whole year of the current time.
Returns a new Time representing the start of the day (0:00)
Returns a new Time representing the start of the hour (x:00)
Returns a new Time representing the start of the month (1st of the month, 0:00)
Returns a new Time representing the start of the quarter (1st of january, april, july, october, 0:00)
Returns a new Time representing the “start” of this week, week starts on start_day (default is :monday, i.e. Monday, 0:00).
Returns a new Time representing the start of the year (1st of january, 0:00)
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.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 71 def change(options) ::Time.send( utc? ? :utc_time : :local_time, options[:year] || year, options[:month] || month, options[:day] || day, options[:hour] || hour, options[:min] || (options[:hour] ? 0 : min), options[:sec] || ((options[:hour] || options[:min]) ? 0 : sec), options[:usec] || ((options[:hour] || options[:min] || options[:sec]) ? 0 : usec) ) end
Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared with a Time
Returns number of days to start of this week, week starts on start_day (default is :monday).
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 164 def days_to_week_start(start_day = :monday) start_day_number = DAYS_INTO_WEEK[start_day] current_day_number = wday != 0 ? wday - 1 : 6 days_span = current_day_number - start_day_number days_span >= 0 ? days_span : 7 + days_span end
Returns a new Time representing the end of the day, 23:59:59.999999 (.999999999 in ruby1.9)
Returns a new Time representing the end of the hour, x:59:59.999999 (.999999999 in ruby1.9)
Returns a new Time representing the end of the month (end of the last day of the month)
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 244 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
Returns a new Time representing the end of the quarter (end of the last day of march, june, september, december)
Returns a new Time representing the end of this week, week starts on start_day (default is :monday, i.e. end of Sunday).
Returns a new Time representing the end of the year (end of the 31st of december)
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 351 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
Returns the UTC offset as an +HH:MM formatted string.
Time.local(2000).formatted_offset # => "-06:00" Time.local(2000).formatted_offset(false) # => "-0600"
Tells whether the Time object’s time lies in the future
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
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
Returns a new Date
/DateTime
representing the
start of this week. Week is assumed to start on a Monday.
DateTime
objects have their time set to 0:00.
Returns a new Time representing the time a number of specified months ago
Returns a new Time representing the time a number of specified months in the future
Short-hand for #months_since(1)
Returns a new Time representing the start of the given day in next week (default is :monday).
Short-hand for #years_since(1)
Tells whether the Time object’s time lies in the past
Short-hand for #months_ago(1)
Returns a new Time representing the start of the given day in the previous week (default is :monday).
Short-hand for #years_ago(1)
Seconds since midnight: Time.now.#seconds_since_midnight
Returns a new Time representing the time a number of seconds since the instance time
Returns a new Date
/DateTime
representing the end
of this week. Week is assumed to start on a Monday. DateTime
objects have their time set to 23:59:59.
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
Converts to a formatted string. See DATE_FORMATS for builtin formats.
This method is aliased to to_s
.
time = Time.now # => Thu Jan 18 06:10:17 CST 2007 time.to_formatted_s(:time) # => "06:10" time.to_s(:time) # => "06:10" time.to_formatted_s(:db) # => "2007-01-18 06:10:17" time.to_formatted_s(:number) # => "20070118061017" time.to_formatted_s(:short) # => "18 Jan 06:10" time.to_formatted_s(:long) # => "January 18, 2007 06:10" time.to_formatted_s(:long_ordinal) # => "January 18th, 2007 06:10" time.to_formatted_s(:rfc822) # => "Thu, 18 Jan 2007 06:10:17 -0600"
Adding your own time formats to to_formatted_s
You can add your own formats to the Time::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a time argument as the value.
# config/initializers/time_formats.rb Time::DATE_FORMATS[:month_and_year] = "%B %Y" Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }
Tells whether the Time object’s time is today
Convenience method which returns a new Time representing the time 1 day since the instance time
Returns a new Time representing the time a number of specified weeks ago.
Returns a new Time representing the time a number of specified years ago
Returns a new Time representing the time a number of specified years in the future