Spec-Zone.ru › Ruby on Rails 7.2

класс ActiveSupport::TimeZone

Родитель:
Объект
Включенные модули:

Активное время по часовым поясам

Класс TimeZone служит оболочкой над объектами TZInfo::Timezone. Он позволяет сделать следующее:

  • Ограничить набор часовых поясов, предоставляемых TZInfo, на осмысленном подмножестве из 134 поясов.

  • Получить и отобразить часовые пояса с более дружественным названием (например, «Восточное Time (США и Канада)» вместо «America/New_York»).

  • Лениво загружать объекты TZInfo::Timezone только тогда, когда они нужны.

  • Создавать объекты ActiveSupport::TimeWithZone с помощью методов local, parse, at, и now класса TimeZone.

Если вы установили 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.

Атрибуты

name[R]
tzinfo[R]

Открытые методы класса

[](arg) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 234
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, если такой часовой пояс неизвестен системе.

all() Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 225
def all
  @zones ||= zones_map.values.sort
end

Возвращает массив всех объектов TimeZone. В многих случаях существует несколько объектов TimeZone на каждый часовой пояс, чтобы пользователям было проще найти свой часовой пояс.

country_zones(country_code) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 262
def country_zones(country_code)
  code = country_code.to_s.upcase
  @country_zones[code] ||= load_country_zones(code)
end

Удобный метод для возврата набора объектов TimeZone часовых поясов для страны, указанной её кодом ISO 3166-1 Alpha2.

create(name, utc_offset = nil, tzinfo = nil) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 302
    

Создаёт новый объект TimeZone с заданным именем и смещением. Смещение — это количество секунд, на которое этот часовой пояс смещён от UTC (GMT). Секунды были выбраны как единица смещения, потому что именно эта единица используется в Ruby для представления смещения часовых поясов (см. Time#utc_offset).

find_tzinfo(name) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 207
def find_tzinfo(name)
  TZInfo::Timezone.get(MAPPING[name] || name)
end
new(name) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 218
def new(name)
  self[name]
end

Возвращает экземпляр TimeZone с заданным именем или nil, если такой экземпляр TimeZone не существует. (Это сделано для поддержки использования этого класса с макросом composed_of.)

seconds_to_utc_offset(seconds, colon = true) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 199
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"
us_zones() Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 256
def us_zones
  country_zones(:us)
end

Удобный метод для возврата набора объектов TimeZone часовых поясов для США.

Методы публичного экземпляра

<=>(zone) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 335
def <=>(zone)
  return unless zone.respond_to? :utc_offset
  result = (utc_offset <=> zone.utc_offset)
  result = (name <=> zone.name) if result == 0
  result
end

Сравнивает данную временную зону с параметром. Сначала сравниваются смещения, а затем — имена.

=~(re) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 344
def =~(re)
  re === name || re === MAPPING[name]
end

Сравнивает name и идентификатор TZInfo с предоставленным регулярным выражением, возвращая true при совпадении.

at(*args) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 381
def at(*args)
  Time.at(*args).utc.in_time_zone(self)
end

Method для создания нового экземпляра 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
formatted_offset(colon = true, alternate_utc_string = nil) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 329
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"
iso8601(str) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 398
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

Method для создания нового экземпляра 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, при получении недопустимой строки даты.

local(*args) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 365
def local(*args)
  time = Time.utc(*args)
  ActiveSupport::TimeWithZone.new(nil, self, time)
end

Method для создания нового экземпляра 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
local_to_utc(time, dst = true) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 553
def local_to_utc(time, dst = true)
  tzinfo.local_to_utc(time, dst)
end

Корректирует заданное время до одновременного времени в UTC. Возвращает экземпляр Time.utc().

match?(re) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 350
def match?(re)
  (re == name) || (re == MAPPING[name]) ||
    ((Regexp === re) && (re.match?(name) || re.match?(MAPPING[name])))
end

Сравнивает name и идентификатор TZInfo с предоставленным регулярным выражением, возвращая true при совпадении.

now() Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 518
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
parse(str, now = now()) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 455
def parse(str, now = now())
  parts_to_time(Date._parse(str, false), now)
end

Method для создания нового экземпляра 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.

period_for_local(time, dst = true) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 565
def period_for_local(time, dst = true)
  tzinfo.period_for_local(time, dst) { |periods| periods.last }
end

Доступно для того, чтобы экземпляры TimeZone реагировали как экземпляры TZInfo::Timezone.

period_for_utc(time) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 559
def period_for_utc(time)
  tzinfo.period_for_utc(time)
end

Доступно для того, чтобы экземпляры TimeZone реагировали как экземпляры TZInfo::Timezone.

rfc3339(str) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 471
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

Method для создания нового экземпляра 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
strptime(str, format, now = now()) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 509
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
to_s() Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 356
def to_s
  "(GMT#{formatted_offset}) #{name}"
end

Возвращает текстовое представление этой временной зоны.

today() Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 523
def today
  tzinfo.now.to_date
end

Возвращает текущую дату в этой временной зоне.

tomorrow() Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 528
def tomorrow
  today + 1
end

Возвращает следующую дату в этой временной зоне.

utc_offset() Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 319
def utc_offset
  @utc_offset || tzinfo&.current_period&.base_utc_offset
end

Возвращает смещение этой временной зоны от UTC в секундах.

utc_to_local(time) Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 544
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 конфигурацию для получения дополнительной информации.

yesterday() Показать исходный код
# File activesupport/lib/active_support/values/time_zone.rb, line 533
def yesterday
  today - 1
end

Возвращает предыдущую дату в этом часовом поясе.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API