Spec-Zone.ru › Ruby on Rails 4.2

класс ActiveSupport::TimeWithZone

Родитель:
Объект
Включенные модули:
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(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() Показать исходный код
# 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 47
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

Методы экземпляра Public

+(other) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 251
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 262
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)
    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
<=>(other) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 217
def <=>(other)
  utc <=> other
end

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

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

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

advance(options) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 290
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 286
def ago(other)
  since(-other)
end
as_json(options = nil) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 156
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 223
def between?(min, max)
  utc.between?(min, max)
end

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

comparable_time()
Псевдоним для: utc
dst?() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 90
def dst?
  period.dst?
end

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

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 243
def eql?(other)
  other.eql?(utc)
end
formatted_offset(colon = true, alternate_utc_string = nil) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 121
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 351
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 239
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 247
def hash
  utc.hash
end
httpdate() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 180
def httpdate
  utc.httpdate
end

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

Time.zone.now.httpdate  # => "Tue, 01 Jan 2013 04:39:43 GMT"
in(other)
Псевдоним для: since
in_time_zone(new_zone = ::Time.zone) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 73
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 131
def inspect
  "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}"
end
is_a?(klass) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 346
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 79
def localtime(utc_offset = nil)
  utc.getlocal(utc_offset)
end

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

Также алиас для: getlocal
marshal_dump() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 357
def marshal_dump
  [utc, time_zone.name, time]
end
marshal_load(variables) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 361
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 382
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

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

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

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

period() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 68
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 367
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 375
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 188
def rfc2822
  to_s(:rfc822)
end

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

Time.zone.now.rfc2822  # => "Tue, 01 Jan 2013 04:51:39 +0000"
Также псевдоним: rfc822
rfc822()
Псевдоним для: rfc2822
since(other) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 275
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
Также псевдоним: in
strftime(format) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 211
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 54
def time
  @time ||= period.to_local(@utc)
end

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

to_a() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 308
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
  @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 312
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 316
def to_i
  utc.to_i
end
Также псевдоним: tv_sec
to_r() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 321
def to_r
  utc.to_r
end
to_s(format = :default) Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 198
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

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

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

  • :db - формат выводит время в UTC в формате :db. См. 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 332
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 234
def today?
  time.today?
end

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

tv_sec()
Псевдоним для: to_i
utc() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 59
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 101
def utc?
  time_zone.name == 'UTC'
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 107
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 135
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() Показать исходный код
# File activesupport/lib/active_support/time_with_zone.rb, line 127
def zone
  period.zone_identifier.to_s
end

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

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

Spec-Zone.ru

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