класс ActiveSupport::TimeZone
Часовой пояс Active Support
Класс TimeZone служит оболочкой для экземпляров TZInfo::Timezone. Он позволяет выполнять следующие действия:
-
Ограничить набор часовых поясов, предоставляемых TZInfo, значимым подмножеством из 134 часовых поясов.
-
Получать и отображать часовые пояса с более понятными названиями (например, «Восточное время (США и Канада)» вместо «America/New_York»).
-
Загружать экземпляры
TZInfo::Timezoneпо мере необходимости. -
Создавать экземпляры
ActiveSupport::TimeWithZoneс помощью методов TimeZonelocal,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
-
Ключи — это названия часовых поясов Rails
TimeZone, значения — идентификаторы TZInfo.
Атрибуты
Публичные методы класса
# File activesupport/lib/active_support/values/time_zone.rb, line 233
def [](arg)
case arg
when self
arg
when String
begin
@lazy_zones_map[arg] ||= create(arg)
rescue TZInfo::InvalidTimezoneIdentifier
nil
end
when TZInfo::Timezone
@lazy_zones_map[arg.name] ||= create(arg.name, nil, arg)
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 261 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 301
Создаёт новый объект TimeZone с указанным названием и смещением. Смещение — это количество секунд, на которое этот часовой пояс отличается от UTC (GMT). Секунды выбраны в качестве единицы смещения, поскольку именно их Ruby использует для представления смещения часового пояса (см. Time#utc_offset).
# File activesupport/lib/active_support/values/time_zone.rb, line 208 def find_tzinfo(name) TZInfo::Timezone.get(MAPPING[name] || name) end
# File activesupport/lib/active_support/values/time_zone.rb, line 200 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 255 def us_zones country_zones(:us) end
Вспомогательный метод, возвращающий коллекцию объектов TimeZone для часовых поясов США.
Публичные методы экземпляра
# File activesupport/lib/active_support/values/time_zone.rb, line 340 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 349 def =~(re) re === name || re === MAPPING[name] end
Сопоставляет name и идентификатор TZInfo с заданным регулярным выражением и возвращает true при совпадении.
# File activesupport/lib/active_support/values/time_zone.rb, line 386 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 334 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 403
def iso8601(str)
# Historically `Date._iso8601(nil)` returns `{}`, but in the `date` gem versions `3.2.1`, `3.1.2`, `3.0.2`,
# and `2.0.1`, `Date._iso8601(nil)` raises `TypeError` https://github.com/ruby/date/issues/39
# Future `date` releases are expected to revert back to the original behavior.
raise ArgumentError, "invalid date" if str.nil?
parts = Date._iso8601(str)
year = parts.fetch(:year)
if parts.key?(:yday)
ordinal_date = Date.ordinal(year, parts.fetch(:yday))
month = ordinal_date.month
day = ordinal_date.day
else
month = parts.fetch(:mon)
day = parts.fetch(:mday)
end
time = Time.new(
year,
month,
day,
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
rescue Date::Error, KeyError
raise ArgumentError, "invalid date"
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 370 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 558 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 355
def match?(re)
(re == name) || (re == MAPPING[name]) ||
((Regexp === re) && (re.match?(name) || re.match?(MAPPING[name])))
end Сопоставляет name и идентификатор TZInfo с заданным регулярным выражением и возвращает true при совпадении.
# File activesupport/lib/active_support/values/time_zone.rb, line 523 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 460 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
Если в строке отсутствуют старшие компоненты, для них используются значения из TimeZone#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 476
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 319 def standard_name MAPPING[name] || name end
Возвращает стандартное название часового пояса, определённое IANA: www.iana.org/time-zones
# File activesupport/lib/active_support/values/time_zone.rb, line 514 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
Если в строке отсутствуют старшие компоненты, для них используются значения из TimeZone#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 361
def to_s
"(GMT#{formatted_offset}) #{name}"
end Возвращает текстовое представление этого часового пояса.
# File activesupport/lib/active_support/values/time_zone.rb, line 528 def today tzinfo.now.to_date end
Возвращает текущую дату в этом часовом поясе.
# File activesupport/lib/active_support/values/time_zone.rb, line 533 def tomorrow today + 1 end
Возвращает следующую дату в этом часовом поясе.
# File activesupport/lib/active_support/values/time_zone.rb, line 324 def utc_offset @utc_offset || tzinfo&.current_period&.base_utc_offset end
Возвращает смещение этого часового пояса относительно UTC в секундах.
# File activesupport/lib/active_support/values/time_zone.rb, line 549
def utc_to_local(time)
tzinfo.utc_to_local(time).yield_self do |t|
ActiveSupport.utc_to_local_returns_utc_offset_times ?
t : Time.utc(t.year, t.month, t.day, t.hour, t.min, t.sec, t.sec_fraction * 1_000_000)
end
end Преобразует указанное время в соответствующее ему время в часовом поясе, заданном self. Возвращает местное время с соответствующим смещением; если нужен экземпляр ActiveSupport::TimeWithZone, вместо этого используйте Time#in_time_zone().
Начиная с tzinfo 2, utc_to_local возвращает объект Time с ненулевым utc_offset. Дополнительную информацию см. в конфигурации utc_to_local_returns_utc_offset_times.
# File activesupport/lib/active_support/values/time_zone.rb, line 538 def yesterday today - 1 end
Возвращает предыдущую дату в этом часовом поясе.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.