класс Time
Константы
- COMMON_YEAR_DAYS_IN_MONTH
- DATE_FORMATS
Атрибуты
Публичные методы класса
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 17 def ===(other) super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone)) end
Переопределён метод сравнения на равенство, чтобы он возвращал true для экземпляров ActiveSupport::TimeWithZone
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 44
def at_with_coercion(*args)
return at_without_coercion(*args) if args.size != 1
# Time.at can be called with a time or numerical value
time_or_number = args.first
if time_or_number.is_a?(ActiveSupport::TimeWithZone) || time_or_number.is_a?(DateTime)
at_without_coercion(time_or_number.to_f).getlocal
else
at_without_coercion(time_or_number)
end
end Добавляет дополнительное поведение к ::at, чтобы можно было использовать экземпляры ActiveSupport::TimeWithZone и DateTime, если вызывается с одним аргументом
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 38 def current ::Time.zone ? ::Time.zone.now : ::Time.now end
Возвращает Time.zone.now, когда Time.zone или config.time_zone установлены, в противном случае возвращает Time.now.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 23
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 Возвращает количество дней в указанном месяце. Если год не указан, используется текущий год.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 33 def days_in_year(year = current.year) days_in_month(2, year) + 337 end
Возвращает количество дней в указанном году. Если год не указан, используется текущий год.
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 109 def find_zone(time_zone) find_zone!(time_zone) rescue nil end
Возвращает экземпляр TimeZone, соответствующий указанной временной зоне. Принимает временную зону в любом формате, поддерживаемом Time.zone=. Возвращает nil для неверных временных зон.
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 82
def find_zone!(time_zone)
if !time_zone || time_zone.is_a?(ActiveSupport::TimeZone)
time_zone
else
# Look up the timezone based on the 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 Возвращает экземпляр TimeZone, соответствующий указанной временной зоне. Принимает временную зону в любом формате, поддерживаемом Time.zone=. Вызывает исключение ArgumentError для неверных временных зон.
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/calculations.rb, line 66
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 Создаёт экземпляр Time из строки в формате RFC 3339.
Time.rfc3339('1999-12-31T14:00:00-10:00') # => 2000-01-01 00:00:00 -1000
Если компоненты времени или смещения отсутствуют, будет вызвано исключение ArgumentError.
Time.rfc3339('1999-12-31') # => ArgumentError: invalid date
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 62
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 Позволяет локально переопределить Time.zone внутри предоставленного блока; восстанавливает Time.zone до исходного значения после выполнения блока.
class ApplicationController < ActionController::Base
around_action :set_time_zone
private
def set_time_zone
Time.use_zone(current_user.timezone) { yield }
end
end
ПРИМЕЧАНИЕ: Это не повлияет на любые объекты ActiveSupport::TimeWithZone , которые уже были созданы, например, любые атрибуты времени модели, которые были прочитаны до блока, останутся в по умолчанию временной зоне приложения.
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 14 def zone Thread.current[:time_zone] || zone_default end
Возвращает TimeZone для текущего запроса, если он был установлен (через ::zone=). Если Time.zone не был установлен для текущего запроса, возвращает TimeZone, указанный в config.time_zone.
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 41 def zone=(time_zone) Thread.current[:time_zone] = find_zone!(time_zone) end
Устанавливает Time.zone на объект TimeZone для текущего запроса/потока.
Этот метод принимает любое из следующего:
-
Объект Rails TimeZone.
-
Идентификатор объекта Rails TimeZone (например, «Eastern Время (США и Канада)»,
-5.hours). -
Объект TZInfo::Timezone.
-
Идентификатор объекта TZInfo::Timezone (например, «America/New_York»).
Вот пример того, как вы можете установить Time.zone для каждого запроса и сбросить его после завершения запроса. current_user.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/acts_like.rb, line 7 def acts_like_time? true end
Имеет тип «похожий на Time». См. Object#acts_like?.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 162
def advance(options)
unless options[:weeks].nil?
options[:weeks], partial_weeks = options[:weeks].divmod(1)
options[:days] = options.fetch(:days, 0) + 7 * partial_weeks
end
unless options[:days].nil?
options[:days], partial_days = options[:days].divmod(1)
options[:hours] = options.fetch(:hours, 0) + 24 * partial_days
end
d = to_date.gregorian.advance(options)
time_advanced_by_date = change(year: d.year, month: d.month, day: d.day)
seconds_to_advance = \
options.fetch(:seconds, 0) +
options.fetch(:minutes, 0) * 60 +
options.fetch(:hours, 0) * 3600
if seconds_to_advance.zero?
time_advanced_by_date
else
time_advanced_by_date.since(seconds_to_advance)
end
end Использует Date для предоставления точных вычислений Time для лет, месяцев и дней в соответствии с пролептическим григорианским календарем. Параметр options принимает хэш с любыми из этих ключей: :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
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 201 def beginning_of_day change(hour: 0) end
Возвращает новый Time, представляющий начало дня (0:00)
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 230 def beginning_of_hour change(min: 0) end
Возвращает новый Time, представляющий начало часа (x:00)
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 246 def beginning_of_minute change(sec: 0) end
Возвращает новый Time, представляющий начало минуты (x:xx:00)
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 120
def change(options)
new_year = options.fetch(:year, year)
new_month = options.fetch(:month, month)
new_day = options.fetch(:day, day)
new_hour = options.fetch(:hour, hour)
new_min = options.fetch(:min, options[:hour] ? 0 : min)
new_sec = options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec)
new_offset = options.fetch(:offset, nil)
if new_nsec = options[:nsec]
raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec]
new_usec = Rational(new_nsec, 1000)
else
new_usec = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))
end
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
::Time.local(new_year, new_month, new_day, new_hour, new_min, new_sec)
else
::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, utc_offset)
end
end Возвращает новый Time, где один или несколько элементов были изменены в соответствии с параметром options. Время опций (:hour, :min, :sec, :usec, :nsec) сбрасываются каскадно, поэтому если передан только час, то минута, секунда, мкс и нс устанавливаются в 0. Если передан час и минута, то секунда, мкс и нс устанавливаются в 0. Параметр options принимает хэш с любыми из этих ключей: :year, :month, :day, :hour, :min, :sec, :usec, :nsec, :offset. Передайте либо :usec или :nsec, а не оба.
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 292
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 Добавляет дополнительное поведение к Time#<=>, чтобы экземпляры DateTime и ActiveSupport::TimeWithZone можно было сравнивать по времени с Time
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 219
def end_of_day
change(
hour: 23,
min: 59,
sec: 59,
usec: Rational(999999999, 1000)
)
end Возвращает новый Time, представляющий конец дня, 23:59:59.999999
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 236
def end_of_hour
change(
min: 59,
sec: 59,
usec: Rational(999999999, 1000)
)
end Возвращает новый Time, представляющий конец часа, x:59:59.999999
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 252
def end_of_minute
change(
sec: 59,
usec: Rational(999999999, 1000)
)
end Возвращает новый Time, представляющий конец минуты, x:xx:59.999999
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 307 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?, чтобы экземпляры ActiveSupport::TimeWithZone могли быть eql? с эквивалентными экземплярами Time.
# File activesupport/lib/active_support/core_ext/time/conversions.rb, line 66 def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon) end
Возвращает отформатированную строку смещения от UTC или альтернативную строку, если часовой пояс уже UTC.
Time.local(2000).formatted_offset # => "-06:00" Time.local(2000).formatted_offset(false) # => "-0600"
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 209 def middle_of_day change(hour: 12) end
Возвращает новый объект Time, представляющий полдень (12:00).
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 283 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
Оператор Time#- также может использоваться для определения количества секунд между двумя объектами Time. Мы добавляем дополнительное поведение, чтобы экземпляры ActiveSupport::TimeWithZone были приведены к формату, распознаваемому оператором Time#-
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 321 def next_day(days = 1) advance(days: days) end
Возвращает новый объект времени через указанное количество дней.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 331 def next_month(months = 1) advance(months: months) end
Возвращает новый объект времени через указанное количество месяцев.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 341 def next_year(years = 1) advance(years: years) end
Возвращает новый объект времени через указанное количество лет.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 316 def prev_day(days = 1) advance(days: -days) end
Возвращает новый объект времени, соответствующий указанному количеству дней назад.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 326 def prev_month(months = 1) advance(months: -months) end
Возвращает новый объект времени, соответствующий указанному количеству месяцев назад.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 336 def prev_year(years = 1) advance(years: -years) end
Возвращает новый объект времени, соответствующий указанному количеству лет назад.
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 104 def sec_fraction subsec end
Возвращает дробную часть секунды как 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 88 def seconds_since_midnight to_i - change(hour: 0).to_i + (usec / 1.0e+6) end
Возвращает количество секунд с момента полуночи.
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 97 def seconds_until_end_of_day end_of_day.to_i - to_i end
Возвращает количество секунд до 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 193 def since(seconds) self + seconds rescue to_datetime.since(seconds) end
Возвращает новый объект Time, представляющий время, прошедшее с момента времени экземпляра, через указанное количество секунд.
# File activesupport/lib/active_support/core_ext/time/conversions.rb, line 51
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 Преобразует в отформатированную строку. См. DATE_FORMATS для встроенных форматов.
Этот метод алиасирован к to_s.
time = Time.now # => 2007-01-18 06:10:17 -06:00 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"
Добавление собственных форматов времени к to_formatted_s
Вы можете добавить собственные форматы в хеш Time::DATE_FORMATS. Используйте имя формата в качестве ключа хеша и либо строку strftime, либо экземпляр Proc, принимающий аргумент времени, в качестве значения.
# 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/compatibility.rb, line 13 def to_time preserve_timezone ? self : getlocal end
Возвращает self или время в локальном часовом поясе системы в зависимости от настройки ActiveSupport.to_time_preserves_timezone.
© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.