класс ActiveSupport::TimeWithZone
Время с часовым поясом Active Support
Класс, подобный Time, который может представлять время в любом часовом поясе. Он необходим, поскольку стандартные экземпляры Ruby Time ограничены часовым поясом UTC и системным часовым поясом ENV['TZ'].
Вам никогда не понадобится создавать экземпляр TimeWithZone напрямую с помощью new. Вместо этого используйте методы local, parse, at и now для экземпляров TimeZone, а также in_time_zone для экземпляров Time и DateTime.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
Time.zone.local(2007, 2, 10, 15, 30, 45) # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.parse('2007-02-10 15:30:45') # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.at(1171139445) # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.now # => Sun, 18 May 2008 13:07:55.754107581 EDT -04:00
Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Дополнительную документацию по этим методам см. в разделах Time и TimeZone.
Экземпляры TimeWithZone реализуют тот же API, что и экземпляры Ruby Time, поэтому экземпляры Time и TimeWithZone взаимозаменяемы.
t = Time.zone.now # => Sun, 18 May 2008 13:27:25.031505668 EDT -04:00 t.hour # => 13 t.dst? # => true t.utc_offset # => -14400 t.zone # => "EDT" t.to_fs(:rfc822) # => "Sun, 18 May 2008 13:27:25 -0400" t + 1.day # => Mon, 19 May 2008 13:27:25.031505668 EDT -04:00 t.beginning_of_year # => Tue, 01 Jan 2008 00:00:00.000000000 EST -05:00 t > Time.utc(1999) # => true t.is_a?(Time) # => true t.is_a?(ActiveSupport::TimeWithZone) # => true
Константы
- PRECISIONS
- SECONDS_PER_DAY
Атрибуты
Общедоступные методы класса
# File activesupport/lib/active_support/time_with_zone.rb, line 51
def initialize(utc_time, time_zone, local_time = nil, period = nil)
@time_zone, @time = time_zone, local_time
if utc_time
@utc = transfer_time_values_to_utc_constructor(utc_time)
@period = period
else
@utc = nil
@period = get_period_and_ensure_valid_local_time(period)
end
@is_utc = zone == "UTC" || zone == "UCT"
end Открытые методы экземпляра
# File activesupport/lib/active_support/time_with_zone.rb, line 314
def +(other)
if duration_of_variable_length?(other)
method_missing(:+, other)
else
result = utc + other
result.in_time_zone(time_zone)
end
end Добавляет временной интервал ко времени текущего объекта и возвращает это значение как новый объект TimeWithZone.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)' now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00 now + 1000 # => Sun, 02 Nov 2014 01:43:08.725182881 EDT -04:00
Если мы добавляем Duration переменной длины (например, годы, месяцы, дни), отсчёт ведётся вперёд от time, иначе — от utc, чтобы обеспечить точность при переходе через границы летнего времени.
Например, прибавление к времени 24.hours сдвинет его ровно на 24 часа, а прибавление 1.day — на 23–25 часов в зависимости от дня.
now + 24.hours # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00 now + 1.day # => Mon, 03 Nov 2014 01:26:28.725182881 EST -05:00
# File activesupport/lib/active_support/time_with_zone.rb, line 349
def -(other)
if other.acts_like?(:time)
getutc - other.getutc
elsif duration_of_variable_length?(other)
method_missing(:-, other)
else
result = utc - other
result.in_time_zone(time_zone)
end
end Вычитает временной интервал и возвращает новый объект TimeWithZone, если только другое значение acts_like? время. В этом случае из текущего времени вычитается другое время, а разница в секундах возвращается как Float.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)' now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00 now - 1000 # => Mon, 03 Nov 2014 00:09:48.725182881 EST -05:00
При вычитании Duration переменной длины (например, годы, месяцы, дни) отсчёт ведётся назад от time, иначе — от utc, чтобы обеспечить точность при переходе через границы летнего времени.
Например, вычитание из времени 24.hours уменьшит его ровно на 24 часа, а вычитание 1.day — на 23–25 часов в зависимости от дня.
now - 24.hours # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00 now - 1.day # => Sun, 02 Nov 2014 00:26:28.725182881 EDT -04:00
Если и объект TimeWithZone, и другое значение ведут себя как Time, будет возвращён Float.
Time.zone.now - 1.day.ago # => 86399.999967
# File activesupport/lib/active_support/time_with_zone.rb, line 247 def <=>(other) utc <=> other end
Для сравнения используется время в UTC.
# File activesupport/lib/active_support/time_with_zone.rb, line 506 def acts_like_time? true end
Чтобы self acts_like?(:time).
# File activesupport/lib/active_support/time_with_zone.rb, line 438
def advance(options)
# If we're advancing a value of variable length (i.e., years, weeks, months, days), advance from #time,
# otherwise advance from #utc, for accuracy when moving across DST boundaries
if options.values_at(:years, :weeks, :months, :days).any?
method_missing(:advance, options)
else
utc.advance(options).in_time_zone(time_zone)
end
end Использует Date для точных вычислений Time для лет, месяцев и дней в соответствии с пролептическим григорианским календарём. Результат возвращается как новый объект TimeWithZone.
Параметр options принимает хеш с любыми из следующих ключей: :years, :months, :weeks, :days, :hours, :minutes, :seconds.
При сдвиге на значение переменной длины (например, годы, недели, месяцы, дни) отсчёт ведётся вперёд от time, иначе — от utc, чтобы обеспечить точность при переходе через границы летнего времени.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)' now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28.558049687 EDT -04:00 now.advance(seconds: 1) # => Sun, 02 Nov 2014 01:26:29.558049687 EDT -04:00 now.advance(minutes: 1) # => Sun, 02 Nov 2014 01:27:28.558049687 EDT -04:00 now.advance(hours: 1) # => Sun, 02 Nov 2014 01:26:28.558049687 EST -05:00 now.advance(days: 1) # => Mon, 03 Nov 2014 01:26:28.558049687 EST -05:00 now.advance(weeks: 1) # => Sun, 09 Nov 2014 01:26:28.558049687 EST -05:00 now.advance(months: 1) # => Tue, 02 Dec 2014 01:26:28.558049687 EST -05:00 now.advance(years: 1) # => Mon, 02 Nov 2015 01:26:28.558049687 EST -05:00
# File activesupport/lib/active_support/time_with_zone.rb, line 377 def ago(other) since(-other) end
Вычитает временной интервал из времени текущего объекта и возвращает результат как новый объект TimeWithZone.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)' now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00 now.ago(1000) # => Mon, 03 Nov 2014 00:09:48.725182881 EST -05:00
Если мы вычитаем Duration переменной длины (например, годы, месяцы, дни), отсчёт ведётся назад от time, иначе — от utc, чтобы обеспечить точность при переходе через границы летнего времени.
Например, time.ago(24.hours) сдвинет время назад ровно на 24 часа, а time.ago(1.day) — на 23–25 часов в зависимости от дня.
now.ago(24.hours) # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00 now.ago(1.day) # => Sun, 02 Nov 2014 00:26:28.725182881 EDT -04:00
# File activesupport/lib/active_support/time_with_zone.rb, line 182
def as_json(options = nil)
if ActiveSupport::JSON::Encoding.use_standard_json_time_format
xmlschema(ActiveSupport::JSON::Encoding.time_precision).force_encoding(Encoding::UTF_8)
else
%(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
end
end Преобразует время в строку для кодирования в формате JSON. По умолчанию используется формат ISO 8601. Формат %Y/%m/%d %H:%M:%S +offset можно получить, установив ActiveSupport::JSON::Encoding.use_standard_json_time_format в false.
# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").as_json
# => "2005-02-01T05:15:10.000-10:00"
# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").as_json
# => "2005/02/01 05:15:10 -1000"
# File activesupport/lib/active_support/time_with_zone.rb, line 255 def between?(min, max) utc.between?(min, max) end
Возвращает true, если время текущего объекта находится в указанном интервале между временем min и max.
# File activesupport/lib/active_support/time_with_zone.rb, line 517 def blank? false end
Экземпляр ActiveSupport::TimeWithZone никогда не бывает пустым.
# File activesupport/lib/active_support/time_with_zone.rb, line 398
def change(options)
if options[:zone] && options[:offset]
raise ArgumentError, "Can't change both :offset and :zone at the same time: #{options.inspect}"
end
new_time = time.change(options)
if options[:zone]
new_zone = ::Time.find_zone(options[:zone])
elsif options[:offset]
new_zone = ::Time.find_zone(new_time.utc_offset)
end
new_zone ||= time_zone
periods = new_zone.periods_for_local(new_time)
self.class.new(nil, new_zone, new_time, periods.include?(period) ? period : nil)
end Возвращает новый объект ActiveSupport::TimeWithZone, в котором один или несколько компонентов изменены в соответствии с параметром options. Параметры времени (:hour, :min, :sec, :usec, :nsec) сбрасываются каскадно: если передан только час, то минута, секунда, микросекунда и наносекунда устанавливаются в 0. Если переданы час и минута, то секунда, микросекунда и наносекунда устанавливаются в 0. Параметр options принимает хеш с любыми из следующих ключей: :year, :month, :day, :hour, :min, :sec, :usec, :nsec, :offset, :zone. Передавайте либо :usec, либо :nsec, но не оба значения одновременно. Аналогично, передавайте либо :zone, либо :offset, но не оба значения одновременно.
t = Time.zone.now # => Fri, 14 Apr 2017 11:45:15.116992711 EST -05:00 t.change(year: 2020) # => Tue, 14 Apr 2020 11:45:15.116992711 EST -05:00 t.change(hour: 12) # => Fri, 14 Apr 2017 12:00:00.000000000 EST -05:00 t.change(min: 30) # => Fri, 14 Apr 2017 11:30:00.000000000 EST -05:00 t.change(offset: "-10:00") # => Fri, 14 Apr 2017 11:45:15.116992711 HST -10:00 t.change(zone: "Hawaii") # => Fri, 14 Apr 2017 11:45:15.116992711 HST -10:00
# File activesupport/lib/active_support/time_with_zone.rb, line 100 def dst? period.dst? end
Возвращает true, если текущее время приходится на период летнего времени в указанном часовом поясе.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
Time.zone.parse("2012-5-30").dst? # => true
Time.zone.parse("2012-11-30").dst? # => false
# File activesupport/lib/active_support/time_with_zone.rb, line 290 def eql?(other) other.eql?(utc) end
Возвращает true, если other равен текущему объекту.
# File activesupport/lib/active_support/time_with_zone.rb, line 131 def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon) end
Возвращает строку со смещением относительно UTC в заданном формате либо альтернативную строку, если часовой пояс уже является UTC.
Time.zone = 'Eastern Time (US & Canada)' # => "Eastern Time (US & Canada)" Time.zone.now.formatted_offset(true) # => "-05:00" Time.zone.now.formatted_offset(false) # => "-0500" Time.zone = 'UTC' # => "UTC" Time.zone.now.formatted_offset(true, "0") # => "0"
# File activesupport/lib/active_support/time_with_zone.rb, line 525 def freeze # preload instance variables before freezing period; utc; time; to_datetime; to_time super end
# File activesupport/lib/active_support/time_with_zone.rb, line 285 def future? utc.future? end
Возвращает true, если время текущего объекта находится в будущем.
# File activesupport/lib/active_support/time_with_zone.rb, line 294 def hash utc.hash end
# File activesupport/lib/active_support/time_with_zone.rb, line 202 def httpdate utc.httpdate end
Возвращает строку с датой и временем объекта в формате, используемом в HTTP-запросах.
Time.zone.now.httpdate # => "Tue, 01 Jan 2013 04:39:43 GMT"
# File activesupport/lib/active_support/time_with_zone.rb, line 83 def in_time_zone(new_zone = ::Time.zone) return self if time_zone == new_zone utc.in_time_zone(new_zone) end
Возвращает соответствующее время в Time.zone или в указанном часовом поясе.
# File activesupport/lib/active_support/time_with_zone.rb, line 146
def inspect
"#{time.strftime('%F %H:%M:%S.%9N')} #{zone} #{formatted_offset}"
end Возвращает строку с датой, временем, часовым поясом и смещением объекта относительно UTC.
Time.zone.now.inspect # => "2024-11-13 07:00:10.528054960 UTC +00:00"
# File activesupport/lib/active_support/time_with_zone.rb, line 511 def is_a?(klass) klass == ::Time || super end
Представляем себя как Time, чтобы затруднить проверку типа.
# File activesupport/lib/active_support/time_with_zone.rb, line 89 def localtime(utc_offset = nil) utc.getlocal(utc_offset) end
Возвращает экземпляр Time, представляющий соответствующее время в системном часовом поясе.
# File activesupport/lib/active_support/time_with_zone.rb, line 531 def marshal_dump [utc, time_zone.name, time] end
# File activesupport/lib/active_support/time_with_zone.rb, line 535 def marshal_load(variables) initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc) end
# File activesupport/lib/active_support/time_with_zone.rb, line 555
def method_missing(...)
wrap_with_time_zone time.__send__(...)
rescue NoMethodError => e
raise e, e.message.sub(time.inspect, inspect).sub("Time", "ActiveSupport::TimeWithZone"), e.backtrace
end Передаёт отсутствующий метод экземпляру time и оборачивает результат в новый объект TimeWithZone с существующим time_zone.
# File activesupport/lib/active_support/time_with_zone.rb, line 260 def past? utc.past? end
Возвращает true, если время текущего объекта находится в прошлом.
# File activesupport/lib/active_support/time_with_zone.rb, line 78 def period @period ||= time_zone.period_for_utc(@utc) end
Возвращает базовый TZInfo::TimezonePeriod.
# File activesupport/lib/active_support/time_with_zone.rb, line 541 def respond_to?(sym, include_priv = false) # ensure that we're not going to throw and rescue from NoMethodError in method_missing which is slow return false if sym.to_sym == :to_str super end
В некоторых случаях respond_to_missing? не вызывается, например при преобразовании типа с помощью Kernel#String
# File activesupport/lib/active_support/time_with_zone.rb, line 549 def respond_to_missing?(sym, include_priv) time.respond_to?(sym, include_priv) end
Гарантирует, что прокси-класс отвечает на все методы, доступные базовому экземпляру времени.
# File activesupport/lib/active_support/time_with_zone.rb, line 210 def rfc2822 to_fs(:rfc822) end
Возвращает строку с датой и временем объекта в стандартном формате RFC 2822.
Time.zone.now.rfc2822 # => "Tue, 01 Jan 2013 04:51:39 +0000"
# File activesupport/lib/active_support/time_with_zone.rb, line 241
def strftime(format)
format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}")
getlocal(utc_offset).strftime(format)
end Перед передачей в Time#strftime заменяет директиву %Z на +zone, чтобы информация о часовом поясе была корректной.
# File activesupport/lib/active_support/time_with_zone.rb, line 461 def to_a [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone] end
Возвращает Array компонентов Time в следующем порядке: [seconds, minutes, hours, day, month, year, weekday, yearday, dst?, zone].
now = Time.zone.now # => Tue, 18 Aug 2015 02:29:27.485278555 UTC +00:00 now.to_a # => [27, 29, 2, 18, 8, 2015, 2, 230, false, "UTC"]
# File activesupport/lib/active_support/time_with_zone.rb, line 494 def to_datetime @to_datetime ||= utc.to_datetime.new_offset(Rational(utc_offset, 86_400)) end
Возвращает экземпляр DateTime со смещением часового пояса относительно UTC
Time.zone.now.to_datetime # => Tue, 18 Aug 2015 02:32:20 +0000
Time.current.in_time_zone('Hawaii').to_datetime # => Mon, 17 Aug 2015 16:32:20 -1000
# File activesupport/lib/active_support/time_with_zone.rb, line 469 def to_f utc.to_f end
Возвращает дату и время объекта в виде числа с плавающей точкой — количества секунд, прошедших с начала эпохи (1 января 1970 г. 00:00 UTC).
Time.zone.now.to_f # => 1417709320.285418
# File activesupport/lib/active_support/time_with_zone.rb, line 228
def to_fs(format = :default)
if format == :db
utc.to_fs(format)
elsif formatter = ::Time::DATE_FORMATS[format]
formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
else
to_s
end
end Возвращает строку с датой и временем объекта.
Этот метод является псевдонимом для to_formatted_s.
Принимает необязательный format:
-
:default— значение по умолчанию, имитирует формат Ruby Time#to_s. -
:db— формат выводит время в формате времени UTC :db. См.Time#to_fs(:db). -
Можно использовать любой ключ из
Time::DATE_FORMATS. См. active_support/core_ext/time/conversions.rb.
# File activesupport/lib/active_support/time_with_zone.rb, line 477 def to_i utc.to_i end
Возвращает дату и время объекта в виде целого числа секунд, прошедших с начала эпохи (1 января 1970 г., 00:00 UTC).
Time.zone.now.to_i # => 1417709320
# File activesupport/lib/active_support/time_with_zone.rb, line 486 def to_r utc.to_r end
Возвращает дату и время объекта в виде рационального числа секунд, прошедших с начала эпохи (1 января 1970 г., 00:00 UTC).
Time.zone.now.to_r # => (708854548642709/500000)
# File activesupport/lib/active_support/time_with_zone.rb, line 216
def to_s
"#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" # mimicking Ruby Time#to_s format
end Возвращает строку с датой и временем объекта.
# File activesupport/lib/active_support/time_with_zone.rb, line 501 def to_time @to_time_with_timezone ||= getlocal(time_zone) end
Возвращает экземпляр Time — либо с тем же часовым поясом, что и у self, с тем же смещением относительно UTC, что и у self, либо в часовом поясе локальной системы, в зависимости от значения настройки ActiveSupport.to_time_preserves_timezone.
# File activesupport/lib/active_support/time_with_zone.rb, line 266 def today? time.today? end
Возвращает true, если время текущего объекта приходится на текущий день.
# File activesupport/lib/active_support/time_with_zone.rb, line 272 def tomorrow? time.tomorrow? end
Возвращает true, если время текущего объекта приходится на следующий день (завтра).
# File activesupport/lib/active_support/time_with_zone.rb, line 69 def utc @utc ||= incorporate_utc_offset(@time, -utc_offset) end
Возвращает экземпляр Time, представляющий то же самое время в часовом поясе UTC.
# File activesupport/lib/active_support/time_with_zone.rb, line 111 def utc? @is_utc end
Возвращает true, если текущий часовой пояс — UTC.
Time.zone = 'UTC' # => 'UTC' Time.zone.now.utc? # => true Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)' Time.zone.now.utc? # => false
# File activesupport/lib/active_support/time_with_zone.rb, line 117 def utc_offset period.observed_utc_offset end
Возвращает смещение текущего времени относительно времени UTC в секундах.
# File activesupport/lib/active_support/time_with_zone.rb, line 154
def xmlschema(fraction_digits = 0)
precision = fraction_digits || 0
if @is_utc
utc.iso8601(precision)
else
str = time.iso8601(precision)
offset = formatted_offset(true, "Z")
str.sub!(/(Z|[+-]\d{2}:\d{2})\z/, offset)
str
end
end Возвращает строку с датой и временем объекта в стандартном формате ISO 8601.
Time.zone.now.xmlschema # => "2014-12-04T11:02:37-05:00"
# File activesupport/lib/active_support/time_with_zone.rb, line 279 def yesterday? time.yesterday? end
Возвращает true, если время текущего объекта приходится на предыдущий день (вчера).
# File activesupport/lib/active_support/time_with_zone.rb, line 139 def zone period.abbreviation end
Возвращает аббревиатуру часового пояса.
Time.zone = 'Eastern Time (US & Canada)' # => "Eastern Time (US & Canada)" Time.zone.now.zone # => "EST"
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.