Spec-Zone.ru › Ruby on Rails 5.1

класс ActiveSupport::TimeWithZone

Родитель:
Object
Включенные модули:
DateAndTime::Compatibility

Класс, похожий на 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 EST -05:00
Time.zone.parse('2007-02-10 15:30:45')          # => Sat, 10 Feb 2007 15:30:45 EST -05:00
Time.zone.at(1171139445)                        # => Sat, 10 Feb 2007 15:30:45 EST -05:00
Time.zone.now                                   # => Sun, 18 May 2008 13:07:55 EDT -04:00
Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone  # => Sat, 10 Feb 2007 15:30:45 EST -05:00

См. Time и TimeZone для более подробной документации по этим методам.

Экземпляры TimeWithZone реализуют тот же API, что и экземпляры Ruby Time, так что экземпляры Time и TimeWithZone взаимозаменяемы.

t = Time.zone.now                     # => Sun, 18 May 2008 13:27:25 EDT -04:00
t.hour                                # => 13
t.dst?                                # => true
t.utc_offset                          # => -14400
t.zone                                # => "EDT"
t.to_s(:rfc822)                       # => "Sun, 18 May 2008 13:27:25 -0400"
t + 1.day                             # => Mon, 19 May 2008 13:27:25 EDT -04:00
t.beginning_of_year                   # => Tue, 01 Jan 2008 00:00:00 EST -05:00
t > Time.utc(1999)                    # => true
t.is_a?(Time)                         # => true
t.is_a?(ActiveSupport::TimeWithZone)  # => true

Константы

PRECISIONS

Атрибуты

time_zone[R]

Публичные методы класса

name() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 40
def self.name
  "Time"
end

Отчёт о имени класса как 'Time', чтобы обойти проверку типа.

new(utc_time, time_zone, local_time = nil, period = nil) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 50
def initialize(utc_time, time_zone, local_time = nil, period = nil)
  @utc = utc_time ? transfer_time_values_to_utc_constructor(utc_time) : nil
  @time_zone, @time = time_zone, local_time
  @period = @utc ? period : get_period_and_ensure_valid_local_time(period)
end

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

+(other) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 274
def +(other)
  if duration_of_variable_length?(other)
    method_missing(:+, other)
  else
    result = utc.acts_like?(:date) ? utc.since(other) : utc + other rescue utc.since(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 EDT -04:00
now + 1000          # => Sun, 02 Nov 2014 01:43:08 EDT -04:00

Если мы добавляем Duration переменной длины (т. е. годы, месяцы, дни), перемещаемся вперёд от time, в противном случае перемещаемся вперёд от utc для точности при пересечении границ DST.

Например, время + 24.hours продвинет время ровно на 24 часа, а время + 1.day продвинет время на 23-25 часов, в зависимости от дня.

now + 24.hours      # => Mon, 03 Nov 2014 00:26:28 EST -05:00
now + 1.day         # => Mon, 03 Nov 2014 01:26:28 EST -05:00
Также алиасировано как: since, in
-(other) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 301
def -(other)
  if other.acts_like?(:time)
    to_time - other.to_time
  elsif duration_of_variable_length?(other)
    method_missing(:-, other)
  else
    result = utc.acts_like?(:date) ? utc.ago(other) : utc - other rescue utc.ago(other)
    result.in_time_zone(time_zone)
  end
end

Возвращает новый объект TimeWithZone, представляющий разницу между текущим временем объекта и временем other.

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28 EST -05:00
now - 1000          # => Mon, 03 Nov 2014 00:09:48 EST -05:00

Если вычитается Duration переменной длины (например, годы, месяцы, дни), перемещайтесь назад от time, в противном случае перемещайтесь назад от utc для точности при пересечении границ DST.

Например, время - 24.hours вычтет ровно 24 часа, а время - 1.day вычтет 23-25 часов, в зависимости от дня.

now - 24.hours      # => Sun, 02 Nov 2014 01:26:28 EDT -04:00
now - 1.day         # => Sun, 02 Nov 2014 00:26:28 EDT -04:00
<=>(other) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 223
def <=>(other)
  utc <=> other
end

Используйте время в формате UTC для сравнений.

acts_like_time?() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 426
def acts_like_time?
  true
end

Для того, чтобы self acts_like?(:time).

advance(options) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 354
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 для точности при пересечении границ DST.

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28 EDT -04:00
now.advance(seconds: 1) # => Sun, 02 Nov 2014 01:26:29 EDT -04:00
now.advance(minutes: 1) # => Sun, 02 Nov 2014 01:27:28 EDT -04:00
now.advance(hours: 1)   # => Sun, 02 Nov 2014 01:26:28 EST -05:00
now.advance(days: 1)    # => Mon, 03 Nov 2014 01:26:28 EST -05:00
now.advance(weeks: 1)   # => Sun, 09 Nov 2014 01:26:28 EST -05:00
now.advance(months: 1)  # => Tue, 02 Dec 2014 01:26:28 EST -05:00
now.advance(years: 1)   # => Mon, 02 Nov 2015 01:26:28 EST -05:00
ago(other) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 329
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 EST -05:00
now.ago(1000)       # => Mon, 03 Nov 2014 00:09:48 EST -05:00

Если мы вычитаем Duration переменной длины (например, годы, месяцы, дни), перемещаемся назад от time, в противном случае перемещаемся назад от utc для точности при пересечении границ DST.

Например, time.ago(24.hours) продвинет время ровно на 24 часа назад, а time.ago(1.day) продвинет время на 23-25 часов назад, в зависимости от дня.

now.ago(24.hours)   # => Sun, 02 Nov 2014 01:26:28 EDT -04:00
now.ago(1.day)      # => Sun, 02 Nov 2014 00:26:28 EDT -04:00
as_json(options = nil) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 165
def as_json(options = nil)
  if ActiveSupport::JSON::Encoding.use_standard_json_time_format
    xmlschema(ActiveSupport::JSON::Encoding.time_precision)
  else
    %Q(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end

Преобразует время в строку для кодирования в JSON. По умолчанию используется формат ISO 8601. Вы можете получить формат %Y/%m/%d %H:%M:%S +смещение, установив 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").to_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").to_json
# => "2005/02/01 05:15:10 -1000"
between?(min, max) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 229
def between?(min, max)
  utc.between?(min, max)
end

Возвращает true, если текущее время объекта находится в указанном интервале времени min и max.

blank?() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 437
def blank?
  false
end

Экземпляр ActiveSupport::TimeWithZone никогда не пуст

comparable_time()
Псевдоним для: utc
dst?() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 93
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
Также алиасировано как: isdst
eql?(other) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 250
def eql?(other)
  other.eql?(utc)
end

Возвращает true если other равно текущему объекту.

formatted_offset(colon = true, alternate_utc_string = nil) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 124
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"
freeze() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 441
def freeze
  # preload instance variables before freezing
  period; utc; time; to_datetime; to_time
  super
end
Вызывает метод суперкласса
future?() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 245
def future?
  utc.future?
end

Возвращает true, если текущее время объекта находится в будущем.

getgm()
Псевдоним для: utc
getlocal(utc_offset = nil)
Псевдоним для: localtime
getutc()
Псевдоним для: utc
gmt?()
Псевдоним для: utc?
gmt_offset()
Псевдоним для: utc_offset
gmtime()
Псевдоним для: utc
gmtoff()
Псевдоним для: utc_offset
hash() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 254
def hash
  utc.hash
end
httpdate() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 186
def httpdate
  utc.httpdate
end

Возвращает строку с датой и временем объекта в формате, используемом в HTTP-запросах.

Time.zone.now.httpdate  # => "Tue, 01 Jan 2013 04:39:43 GMT"
in(other)
Псевдоним для: +
in_time_zone(new_zone = ::Time.zone) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 76
def in_time_zone(new_zone = ::Time.zone)
  return self if time_zone == new_zone
  utc.in_time_zone(new_zone)
end

Возвращает одновременное время в Time.zone, или в указанной зоне.

inspect() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 139
def inspect
  "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}"
end

Возвращает строку с датой, временем, зоной и смещением от UTC объекта.

Time.zone.now.inspect # => "Thu, 04 Dec 2014 11:00:25 EST -05:00"
is_a?(klass) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 431
def is_a?(klass)
  klass == ::Time || super
end

Предположим, мы — Time, чтобы обойти проверку типов.

Вызывает метод суперкласса
Также псевдоним для: kind_of?
isdst()
Псевдоним для: dst?
iso8601(fraction_digits = 0)
Псевдоним для: xmlschema
kind_of?(klass)
Псевдоним для: is_a?
localtime(utc_offset = nil) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 82
def localtime(utc_offset = nil)
  utc.getlocal(utc_offset)
end

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

Также псевдоним для: getlocal
marshal_dump() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 447
def marshal_dump
  [utc, time_zone.name, time]
end
marshal_load(variables) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 451
def marshal_load(variables)
  initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc)
end
method_missing(sym, *args, &block) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 472
def method_missing(sym, *args, &block)
  wrap_with_time_zone time.__send__(sym, *args, &block)
rescue NoMethodError => e
  raise e, e.message.sub(time.inspect, inspect), e.backtrace
end

Пересылает отсутствующий метод экземпляру time, и оборачивает результат в новый TimeWithZone с существующим time_zone.

past?() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 234
def past?
  utc.past?
end

Возвращает true, если текущее время объекта находится в прошлом.

period() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 71
def period
  @period ||= time_zone.period_for_utc(@utc)
end

Возвращает базовый TZInfo::TimezonePeriod.

respond_to?(sym, include_priv = false) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 457
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

Вызывает метод суперкласса
respond_to_missing?(sym, include_priv) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 465
def respond_to_missing?(sym, include_priv)
  return false if sym.to_sym == :acts_like_date?
  time.respond_to?(sym, include_priv)
end

Обеспечивает, что прокси-класс отвечает на все методы, которым отвечает базовый экземпляр времени.

rfc2822() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 194
def rfc2822
  to_s(:rfc822)
end

Возвращает строку с датой и временем объекта в формате стандарта RFC 2822.

Time.zone.now.rfc2822  # => "Tue, 01 Jan 2013 04:51:39 +0000"
Также псевдоним для: rfc822
rfc3339(fraction_digits = 0)
Псевдоним для: xmlschema
rfc822()
Псевдоним для: rfc2822
since(other)
Псевдоним для: +
strftime(format) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 217
def strftime(format)
  format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}")
  getlocal(utc_offset).strftime(format)
end

Заменяет директиву %Z на +zone перед передачей в Time#strftime, чтобы информация о часовом поясе была корректной.

time() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 57
def time
  @time ||= period.to_local(@utc)
end

Возвращает экземпляр Time, представляющий время в time_zone.

to_a() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 377
def to_a
  [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone]
end

Возвращает Массив частей Time в последовательности [секунды, минуты, часы, день, месяц, год, день недели, день года, dst?, зона].

now = Time.zone.now     # => Tue, 18 Aug 2015 02:29:27 UTC +00:00
now.to_a                # => [27, 29, 2, 18, 8, 2015, 2, 230, false, "UTC"]
to_datetime() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 410
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
to_f() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 385
def to_f
  utc.to_f
end

Возвращает дату и время объекта как число с плавающей точкой в секундах с момента эпохи (1 января 1970 года 00:00 UTC).

Time.zone.now.to_f # => 1417709320.285418
to_formatted_s(format = :default)
Псевдоним для: to_s
to_i() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 393
def to_i
  utc.to_i
end

Возвращает дату и время объекта как целое число в секундах с момента эпохи (1 января 1970 года 00:00 UTC).

Time.zone.now.to_i # => 1417709320
Также псевдоним для: tv_sec
END_OF_DOCUMENT_MARKER
to_r() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 402
def to_r
  utc.to_r
end

Возвращает дату и время объекта в виде рационального числа секунд, прошедших с эпохи (1 января 1970 года 00:00 UTC).

Time.zone.now.to_r # => (708854548642709/500000)
to_s(format = :default) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 204
def to_s(format = :default)
  if format == :db
    utc.to_s(format)
  elsif formatter = ::Time::DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    "#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" # mimicking Ruby Time#to_s format
  end
end

Возвращает строку даты и времени объекта. Принимает необязательный параметр format:

  • :default - значение по умолчанию, имитирует формат Ruby Time#to_s.

  • :db - формат вывода времени в UTC в формате базы данных. См. Time#to_formatted_s(:db).

  • Любой ключ из Time::DATE_FORMATS может быть использован. См. active_support/core_ext/time/conversions.rb.

Также алиас для: to_formatted_s
to_time() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 417
def to_time
  if preserve_timezone
    @to_time_with_instance_offset ||= getlocal(utc_offset)
  else
    @to_time_with_system_offset ||= getlocal
  end
end

Возвращает экземпляр Time, либо с тем же смещением UTC, что и self, либо в часовом поясе локальной системы, в зависимости от настроек ActiveSupport.to_time_preserves_timezone.

today?() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 240
def today?
  time.today?
end

Возвращает true, если текущее время объекта попадает в текущий день.

tv_sec()
Псевдоним для: to_i
utc() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 62
def utc
  @utc ||= period.to_utc(@time)
end

Возвращает экземпляр Time с одновременным временем в часовом поясе UTC.

Также алиас для: comparable_time, getgm, getutc, gmtime
utc?() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 104
def utc?
  period.offset.abbreviation == :UTC || period.offset.abbreviation == :UCT
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
Также алиас для: gmt?
utc_offset() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 110
def utc_offset
  period.utc_total_offset
end

Возвращает смещение текущего времени относительно UTC в секундах.

Также алиас для: gmt_offset, gmtoff
xmlschema(fraction_digits = 0) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 147
def xmlschema(fraction_digits = 0)
  "#{time.strftime(PRECISIONS[fraction_digits.to_i])}#{formatted_offset(true, 'Z'.freeze)}"
end

Возвращает строку даты и времени объекта в формате ISO 8601.

Time.zone.now.xmlschema  # => "2014-12-04T11:02:37-05:00"
Также алиас для: iso8601, rfc3339
zone() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 132
def zone
  period.zone_identifier.to_s
end

Возвращает сокращение часового пояса.

Time.zone = 'Eastern Time (US & Canada)'   # => "Eastern Time (US & Canada)"
Time.zone.now.zone # => "EST"

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

Spec-Zone.ru

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