класс ActiveSupport::TimeWithZone

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

Класс, похожий на 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(1170361845)                        # => 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

Атрибуты

time_zone[R]

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

name() Показать исходный код

Возвращает имя класса как 'Time', чтобы обойти проверку типов.

# File activesupport/lib/active_support/time_with_zone.rb, line 39
def self.name
  'Time'
end

new(utc_time, time_zone, local_time = nil, period = nil) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 46
def initialize(utc_time, time_zone, local_time = nil, period = nil)
  @utc, @time_zone, @time = utc_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 247
def +(other)
  # If we're adding a Duration of variable length (i.e., years, months, days), move forward from #time,
  # otherwise move forward from #utc, for accuracy when moving across DST boundaries
  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

-(other) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 258
def -(other)
  # If we're subtracting a Duration of variable length (i.e., years, months, days), move backwards from #time,
  # otherwise move backwards #utc, for accuracy when moving across DST boundaries
  if other.acts_like?(:time)
    utc.to_f - other.to_f
  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

<=>(other) Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 213
def <=>(other)
  utc <=> other
end

acts_like_time?() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 330
def acts_like_time?
  true
end

advance(options) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 285
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

ago(other) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 281
def ago(other)
  since(-other)
end

as_json(options = nil) Показать исходный код

Преобразует время в строку для кодирования 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"

# File activesupport/lib/active_support/time_with_zone.rb, line 155
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

between?(min, max) Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 219
def between?(min, max)
  utc.between?(min, max)
end

comparable_time()

Псевдоним для: utc

dst?() Показать исходный код

Возвращает true, если текущее время находится в летнем времени (DST) для указанной временной зоны.

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 89
def dst?
  period.dst?
end

Также алиас: isdst

encode_with(coder) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 163
def encode_with(coder)
  if coder.respond_to?(:represent_object)
    coder.represent_object(nil, utc)
  else
    coder.represent_scalar(nil, utc.strftime("%Y-%m-%d %H:%M:%S.%9NZ"))
  end
end

eql?(other) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 239
def eql?(other)
  utc.eql?(other)
end

formatted_offset(colon = true, alternate_utc_string = nil) Показать исходный код

Возвращает отформатированную строку смещения от 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 120
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

freeze() Показать исходный код

Вызывает метод суперкласса

# File activesupport/lib/active_support/time_with_zone.rb, line 340
def freeze
  period; utc; time # preload instance variables before freezing
  super
end

future?() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 235
def future?
  utc.future?
end

getgm()

Псевдоним для: utc

getlocal()

Псевдоним для: 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 243
def hash
  utc.hash
end

httpdate() Показать исходный код

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

Time.zone.now.httpdate  # => "Tue, 01 Jan 2013 04:39:43 GMT"

# File activesupport/lib/active_support/time_with_zone.rb, line 175
def httpdate
  utc.httpdate
end

in_time_zone(new_zone = ::Time.zone) Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 71
def in_time_zone(new_zone = ::Time.zone)
  return self if time_zone == new_zone
  utc.in_time_zone(new_zone)
end

inspect() Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 130
def inspect
  "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}"
end

is_a?(klass) Показать исходный код

Предположим, что мы — Time для предотвращения проверки типов.

Вызывает метод суперкласса

# File activesupport/lib/active_support/time_with_zone.rb, line 335
def is_a?(klass)
  klass == ::Time || super
end

Также алиас: kind_of?

isdst()

Псевдоним для: dst?

iso8601(fraction_digits = 0)

Псевдоним для: xmlschema

kind_of?(klass)

Псевдоним для: is_a?

localtime() Показать исходный код

Возвращает экземпляр Time.local() одновременного времени в вашей ENV['TZ'] зоне.

# File activesupport/lib/active_support/time_with_zone.rb, line 78
def localtime
  utc.respond_to?(:getlocal) ? utc.getlocal : utc.to_time.getlocal
end

Также алиас: getlocal

marshal_dump() Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 345
def marshal_dump
  [utc, time_zone.name, time]
end

marshal_load(variables) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 349
def marshal_load(variables)
  initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc)
end

method_missing(sym, *args, &block) Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 363
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, self.inspect), e.backtrace
end

past?() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 224
def past?
  utc.past?
end

period() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 66
def period
  @period ||= time_zone.period_for_utc(@utc)
end

respond_to_missing?(sym, include_priv) Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 355
def respond_to_missing?(sym, include_priv)
  # consistently respond false to acts_like?(:date), regardless of whether #time is a Time or DateTime
  return false if sym.to_sym == :acts_like_date?
  time.respond_to?(sym, include_priv)
end

rfc2822() Показать исходный код

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

Time.zone.now.rfc2822  # => "Tue, 01 Jan 2013 04:51:39 +0000"

# File activesupport/lib/active_support/time_with_zone.rb, line 183
def rfc2822
  to_s(:rfc822)
end

Также алиасировано как: rfc822

rfc822()

Псевдоним для: rfc2822

since(other) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 271
def since(other)
  # If we're adding a Duration of variable length (i.e., years, months, days), move forward from #time,
  # otherwise move forward from #utc, for accuracy when moving across DST boundaries
  if duration_of_variable_length?(other)
    method_missing(:since, other)
  else
    utc.since(other).in_time_zone(time_zone)
  end
end

strftime(format) Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 204
def strftime(format)
  format = format.gsub('%Z', zone)
                 .gsub('%z',   formatted_offset(false))
                 .gsub('%:z',  formatted_offset(true))
                 .gsub('%::z', formatted_offset(true) + ":00")
  time.strftime(format)
end

time() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 52
def time
  @time ||= period.to_local(@utc)
end

to_a() Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 303
def to_a
  [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone]
end

to_datetime() Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 325
def to_datetime
  utc.to_datetime.new_offset(Rational(utc_offset, 86_400))
end

to_f() Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 307
def to_f
  utc.to_f
end

to_formatted_s(format = :default)

Псевдоним для: to_s

to_i() Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 311
def to_i
  utc.to_i
end

Также алиасировано как: tv_sec

to_r() Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 316
def to_r
  utc.to_r
end

to_s(format = :default) Показать исходный код

Формат :db выводит время в UTC; все остальные — в локальном времени. Использует strftime TimeWithZone, поэтому %Z и %z работают корректно.

# File activesupport/lib/active_support/time_with_zone.rb, line 190
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 1.9 Time#to_s format
  end
end

Также алиасировано как: to_formatted_s

to_time() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 321
def to_time
  utc.to_time
end

today?() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 230
def today?
  time.today?
end

tv_sec()

Псевдоним для: to_i

utc() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 57
def utc
  @utc ||= period.to_utc(@time)
end

Также алиасировано как: comparable_time, getgm, getutc, gmtime

utc?() Показать исходный код

Возвращает 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 100
def utc?
  time_zone.name == 'UTC'
end

Также алиасировано как: gmt?

utc_offset() Показать исходный код

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

# File activesupport/lib/active_support/time_with_zone.rb, line 106
def utc_offset
  period.utc_total_offset
end

Также алиасировано как: gmt_offset, gmtoff

xmlschema(fraction_digits = 0) Показать исходный код

# File activesupport/lib/active_support/time_with_zone.rb, line 134
def xmlschema(fraction_digits = 0)
  fraction = if fraction_digits.to_i > 0
    (".%06i" % time.usec)[0, fraction_digits.to_i + 1]
  end

  "#{time.strftime("%Y-%m-%dT%H:%M:%S")}#{fraction}#{formatted_offset(true, 'Z')}"
end

Также алиасировано как: iso8601

zone() Показать исходный код

Time использует zone для отображения аббревиатуры часового пояса, поэтому мы используем duck-typing.

# File activesupport/lib/active_support/time_with_zone.rb, line 126
def zone
  period.zone_identifier.to_s
end