класс ActiveSupport::TimeZone
Класс TimeZone служит оболочкой вокруг экземпляров TZInfo::Timezone. Он позволяет нам:
-
Ограничить набор зон, предоставляемых TZInfo, до разумного подмножества из 134 зон.
-
Получать и отображать зоны с более дружественным названием (например, «Восточное время (США и Канада)» вместо «America/New_York»).
-
Лениво загружать экземпляры TZInfo::Timezone только при необходимости.
-
Создавать экземпляры ActiveSupport::TimeWithZone с помощью методов TimeZone:
local,parse,atиnow.
Если вы установите config.time_zone в приложении Rails, вы можете получить доступ к этому объекту TimeZone через Time.zone:
# application.rb: class Application < Rails::Application config.time_zone = 'Eastern Time (US & Canada)' end Time.zone # => #<ActiveSupport::TimeZone:0x514834...> Time.zone.name # => "Eastern Time (US & Canada)" Time.zone.now # => Sun, 18 May 2008 14:30:44 EDT -04:00
Константы
- MAPPING
-
Ключи — имена зон TimeZone в Rails, значения — идентификаторы TZInfo.
Атрибуты
Публичные методы класса
# File activesupport/lib/active_support/values/time_zone.rb, line 230
def [](arg)
case arg
when String
begin
@lazy_zones_map[arg] ||= create(arg)
rescue TZInfo::InvalidTimezoneIdentifier
nil
end
when Numeric, ActiveSupport::Duration
arg *= 3600 if arg.abs <= 13
all.find { |z| z.utc_offset == arg.to_i }
else
raise ArgumentError, "invalid argument to TimeZone[]: #{arg.inspect}"
end
end Найти объект конкретной временной зоны. Если аргумент — строка, она интерпретируется как имя временной зоны для поиска. Если это числовое значение, это либо смещение по часам, либо смещение по секундам временной зоны для поиска. (Будет возвращена первая зона с этим смещением). Возвращает nil, если такая временная зона неизвестна системе.
# File activesupport/lib/active_support/values/time_zone.rb, line 254 def country_zones(country_code) code = country_code.to_s.upcase @country_zones[code] ||= load_country_zones(code) end
Удобный метод для возвращения набора объектов TimeZone для временных зон в стране, указанной её кодом ISO 3166-1 Alpha2.
# File activesupport/lib/active_support/values/time_zone.rb, line 205 def find_tzinfo(name) TZInfo::Timezone.new(MAPPING[name] || name) end
# File activesupport/lib/active_support/values/time_zone.rb, line 214 def new(name) self[name] end
Возвращает экземпляр TimeZone с заданным именем или nil, если такой экземпляр TimeZone не существует. (Это необходимо для поддержки использования этого класса с макросом composed_of).
# File activesupport/lib/active_support/values/time_zone.rb, line 297 def initialize(name, utc_offset = nil, tzinfo = nil) @name = name @utc_offset = utc_offset @tzinfo = tzinfo || TimeZone.find_tzinfo(name) end
Создаёт новый объект TimeZone с заданным именем и смещением. Смещение — количество секунд, на которое эта временная зона смещена от UTC (GMT). Секунды выбраны в качестве единицы смещения, потому что Руби использует их для представления смещений временных зон (см. Time#utc_offset).
# File activesupport/lib/active_support/values/time_zone.rb, line 197 def seconds_to_utc_offset(seconds, colon = true) format = colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON sign = (seconds < 0 ? "-" : "+") hours = seconds.abs / 3600 minutes = (seconds.abs % 3600) / 60 format % [sign, hours, minutes] end
Предполагает, что self представляет смещение от UTC в секундах (как возвращается из Time#utc_offset) и преобразует это в строку формата +HH:MM.
ActiveSupport::TimeZone.seconds_to_utc_offset(-21_600) # => "-06:00"
# File activesupport/lib/active_support/values/time_zone.rb, line 248 def us_zones country_zones(:us) end
Удобный метод для возвращения набора объектов TimeZone для временных зон в США.
Общедоступные методы экземпляра
# File activesupport/lib/active_support/values/time_zone.rb, line 324 def <=>(zone) return unless zone.respond_to? :utc_offset result = (utc_offset <=> zone.utc_offset) result = (name <=> zone.name) if result == 0 result end
Сравнить часовой пояс с параметром. Сначала сравниваются смещения, а затем — имена.
# File activesupport/lib/active_support/values/time_zone.rb, line 333 def =~(re) re === name || re === MAPPING[name] end
Сравнить имя и идентификатор TZInfo с предоставленным регулярным выражением, возвращая true в случае совпадения.
# File activesupport/lib/active_support/values/time_zone.rb, line 363 def at(*args) Time.at(*args).utc.in_time_zone(self) end
Метод для создания нового экземпляра ActiveSupport::TimeWithZone в часовом поясе self по числу секунд с начала эпохи Unix.
Time.zone = 'Hawaii' # => "Hawaii" Time.utc(2000).to_f # => 946684800.0 Time.zone.at(946684800.0) # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Можно указать второй аргумент для задания точности до долей секунды.
Time.zone = 'Hawaii' # => "Hawaii" Time.at(946684800, 123456.789).nsec # => 123456789
# File activesupport/lib/active_support/values/time_zone.rb, line 318 def formatted_offset(colon = true, alternate_utc_string = nil) utc_offset == 0 && alternate_utc_string || self.class.seconds_to_utc_offset(utc_offset, colon) end
Возвращает отформатированную строку смещения от UTC или альтернативную строку, если часовой пояс уже UTC.
zone = ActiveSupport::TimeZone['Central Time (US & Canada)'] zone.formatted_offset # => "-06:00" zone.formatted_offset(false) # => "-0600"
# File activesupport/lib/active_support/values/time_zone.rb, line 380
def iso8601(str)
parts = Date._iso8601(str)
raise ArgumentError, "invalid date" if parts.empty?
time = Time.new(
parts.fetch(:year),
parts.fetch(:mon),
parts.fetch(:mday),
parts.fetch(:hour, 0),
parts.fetch(:min, 0),
parts.fetch(:sec, 0) + parts.fetch(:sec_fraction, 0),
parts.fetch(:offset, 0)
)
if parts[:offset]
TimeWithZone.new(time.utc, self)
else
TimeWithZone.new(nil, self, time)
end
end Метод для создания нового экземпляра ActiveSupport::TimeWithZone в часовом поясе self из строки ISO 8601.
Time.zone = 'Hawaii' # => "Hawaii"
Time.zone.iso8601('1999-12-31T14:00:00') # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Если отсутствуют компоненты времени, они будут установлены в ноль.
Time.zone = 'Hawaii' # => "Hawaii"
Time.zone.iso8601('1999-12-31') # => Fri, 31 Dec 1999 00:00:00 HST -10:00
Если строка некорректна, будет поднято исключение ArgumentError, в отличие от parse, которое обычно возвращает nil, когда получает некорректную строку даты.
# File activesupport/lib/active_support/values/time_zone.rb, line 347 def local(*args) time = Time.utc(*args) ActiveSupport::TimeWithZone.new(nil, self, time) end
Метод для создания нового экземпляра ActiveSupport::TimeWithZone в часовом поясе self из заданных значений.
Time.zone = 'Hawaii' # => "Hawaii" Time.zone.local(2007, 2, 1, 15, 30, 45) # => Thu, 01 Feb 2007 15:30:45 HST -10:00
# File activesupport/lib/active_support/values/time_zone.rb, line 511 def local_to_utc(time, dst = true) tzinfo.local_to_utc(time, dst) end
Корректирует заданное время для одновременного времени в UTC. Возвращает экземпляр Time.utc().
# File activesupport/lib/active_support/values/time_zone.rb, line 483 def now time_now.utc.in_time_zone(self) end
Возвращает экземпляр ActiveSupport::TimeWithZone, представляющий текущее время в часовом поясе, представленном self.
Time.zone = 'Hawaii' # => "Hawaii" Time.zone.now # => Wed, 23 Jan 2008 20:24:27 HST -10:00
# File activesupport/lib/active_support/values/time_zone.rb, line 420 def parse(str, now = now()) parts_to_time(Date._parse(str, false), now) end
Метод для создания нового экземпляра ActiveSupport::TimeWithZone в часовом поясе self из разобранной строки.
Time.zone = 'Hawaii' # => "Hawaii"
Time.zone.parse('1999-12-31 14:00:00') # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Если отсутствуют верхние компоненты строки, они берутся из #now:
Time.zone.now # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Time.zone.parse('22:30:00') # => Fri, 31 Dec 1999 22:30:00 HST -10:00
Однако, если компонент даты не указан, но указаны другие верхние компоненты, день месяца по умолчанию будет 1:
Time.zone.parse('Mar 2000') # => Wed, 01 Mar 2000 00:00:00 HST -10:00
Если строка некорректна, может быть поднято исключение ArgumentError.
# File activesupport/lib/active_support/values/time_zone.rb, line 523
def period_for_local(time, dst = true)
tzinfo.period_for_local(time, dst) { |periods| periods.last }
end Доступно для того, чтобы экземпляры TimeZone отвечали как экземпляры TZInfo::Timezone.
# File activesupport/lib/active_support/values/time_zone.rb, line 517 def period_for_utc(time) tzinfo.period_for_utc(time) end
Доступно для того, чтобы экземпляры TimeZone отвечали как экземпляры TZInfo::Timezone.
# File activesupport/lib/active_support/values/time_zone.rb, line 436
def rfc3339(str)
parts = Date._rfc3339(str)
raise ArgumentError, "invalid date" if parts.empty?
time = 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)
)
TimeWithZone.new(time.utc, self)
end Метод для создания нового экземпляра ActiveSupport::TimeWithZone в часовом поясе self из строки RFC 3339.
Time.zone = 'Hawaii' # => "Hawaii"
Time.zone.rfc3339('2000-01-01T00:00:00Z') # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Если отсутствуют компоненты времени или часового пояса, будет поднято исключение ArgumentError. Это намного строже, чем parse или iso8601, которые допускают пропуски компонентов.
Time.zone = 'Hawaii' # => "Hawaii"
Time.zone.rfc3339('1999-12-31') # => ArgumentError: invalid date
# File activesupport/lib/active_support/values/time_zone.rb, line 474 def strptime(str, format, now = now()) parts_to_time(DateTime._strptime(str, format), now) end
Разбирает str в соответствии с format и возвращает ActiveSupport::TimeWithZone.
Предполагается, что str — это время в часовом поясе self, если в format явно не указан часовой пояс. (Это поведение совпадает с parse.) В любом случае, возвращаемый TimeWithZone имеет часовой пояс self.
Time.zone = 'Hawaii' # => "Hawaii"
Time.zone.strptime('1999-12-31 14:00:00', '%Y-%m-%d %H:%M:%S') # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Если отсутствуют верхние компоненты строки, они берутся из #now:
Time.zone.now # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Time.zone.strptime('22:30:00', '%H:%M:%S') # => Fri, 31 Dec 1999 22:30:00 HST -10:00
Однако, если компонент даты не указан, но указаны другие верхние компоненты, день месяца по умолчанию будет 1:
Time.zone.strptime('Mar 2000', '%b %Y') # => Wed, 01 Mar 2000 00:00:00 HST -10:00
# File activesupport/lib/active_support/values/time_zone.rb, line 338
def to_s
"(GMT#{formatted_offset}) #{name}"
end Возвращает текстовое представление этого часового пояса.
# File activesupport/lib/active_support/values/time_zone.rb, line 488 def today tzinfo.now.to_date end
Возвращает текущую дату в этом часовом поясе.
# File activesupport/lib/active_support/values/time_zone.rb, line 493 def tomorrow today + 1 end
Возвращает следующую дату в этом часовом поясе.
# File activesupport/lib/active_support/values/time_zone.rb, line 304
def utc_offset
if @utc_offset
@utc_offset
else
tzinfo.current_period.utc_offset if tzinfo && tzinfo.current_period
end
end Возвращает смещение этого часового пояса от UTC в секундах.
# File activesupport/lib/active_support/values/time_zone.rb, line 505 def utc_to_local(time) tzinfo.utc_to_local(time) end
Корректирует заданное время для одновременного времени в часовом поясе, представленном self. Возвращает экземпляр Time.utc() — если нужен экземпляр ActiveSupport::TimeWithZone, используйте DateAndTime::Zones#in_time_zone вместо этого.
# File activesupport/lib/active_support/values/time_zone.rb, line 498 def yesterday today - 1 end
Возвращает предыдущую дату в этом часовом поясе.
© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.