Active Support Time With Zone¶ ↑

# File activesupport/lib/active_support/time_with_zone.rb, line 51
def initialize(utc_time, time_zone, local_time = nil, period = nil)
  @time_zone, @time = time_zone, local_time
  if utc_time
    @utc = transfer_time_values_to_utc_constructor(utc_time)
    @period = period
  else
    @utc = nil
    @period = get_period_and_ensure_valid_local_time(period)
  end
  @is_utc = zone == "UTC" || zone == "UCT"
end

# File activesupport/lib/active_support/time_with_zone.rb, line 310
def +(other)
  if duration_of_variable_length?(other)
    method_missing(:+, other)
  else
    result = utc + other

    result.in_time_zone(time_zone)
  end
end

# File activesupport/lib/active_support/time_with_zone.rb, line 345
def -(other)
  if other.acts_like?(:time)
    getutc - other.getutc
  elsif duration_of_variable_length?(other)
    method_missing(:-, other)
  else
    result = utc - other
    result.in_time_zone(time_zone)
  end
end

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

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

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

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

# File activesupport/lib/active_support/time_with_zone.rb, line 178
def as_json(options = nil)
  if ActiveSupport::JSON::Encoding.use_standard_json_time_format
    xmlschema(ActiveSupport::JSON::Encoding.time_precision)
  else
    %(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end

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

# File activesupport/lib/active_support/time_with_zone.rb, line 513
def blank?
  false
end

# File activesupport/lib/active_support/time_with_zone.rb, line 394
def change(options)
  if options[:zone] && options[:offset]
    raise ArgumentError, "Can't change both :offset and :zone at the same time: #{options.inspect}"
  end

  new_time = time.change(options)

  if options[:zone]
    new_zone = ::Time.find_zone(options[:zone])
  elsif options[:offset]
    new_zone = ::Time.find_zone(new_time.utc_offset)
  end

  new_zone ||= time_zone
  periods = new_zone.periods_for_local(new_time)

  self.class.new(nil, new_zone, new_time, periods.include?(period) ? period : nil)
end

# File activesupport/lib/active_support/time_with_zone.rb, line 100
def dst?
  period.dst?
end

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

# File activesupport/lib/active_support/time_with_zone.rb, line 131
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

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

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

# File activesupport/lib/active_support/time_with_zone.rb, line 290
def hash
  utc.hash
end

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

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

# File activesupport/lib/active_support/time_with_zone.rb, line 146
def inspect
  "#{time.strftime('%F %H:%M:%S.%9N')} #{zone} #{formatted_offset}"
end

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

# File activesupport/lib/active_support/time_with_zone.rb, line 89
def localtime(utc_offset = nil)
  utc.getlocal(utc_offset)
end

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

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

# File activesupport/lib/active_support/time_with_zone.rb, line 551
def method_missing(...)
  wrap_with_time_zone time.__send__(...)
rescue NoMethodError => e
  raise e, e.message.sub(time.inspect, inspect).sub("Time", "ActiveSupport::TimeWithZone"), e.backtrace
end

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

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

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

# File activesupport/lib/active_support/time_with_zone.rb, line 545
def respond_to_missing?(sym, include_priv)
  time.respond_to?(sym, include_priv)
end

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

# File activesupport/lib/active_support/time_with_zone.rb, line 237
def strftime(format)
  format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}")
  getlocal(utc_offset).strftime(format)
end

# File activesupport/lib/active_support/time_with_zone.rb, line 64
def time
  @time ||= incorporate_utc_offset(@utc, utc_offset)
end

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

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

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

# File activesupport/lib/active_support/time_with_zone.rb, line 224
def to_fs(format = :default)
  if format == :db
    utc.to_fs(format)
  elsif formatter = ::Time::DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_s
  end
end

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

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

# File activesupport/lib/active_support/time_with_zone.rb, line 212
def to_s
  "#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" # mimicking Ruby Time#to_s format
end

# File activesupport/lib/active_support/time_with_zone.rb, line 497
def to_time
  @to_time_with_timezone ||= getlocal(time_zone)
end

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

# File activesupport/lib/active_support/time_with_zone.rb, line 268
def tomorrow?
  time.tomorrow?
end

# File activesupport/lib/active_support/time_with_zone.rb, line 69
def utc
  @utc ||= incorporate_utc_offset(@time, -utc_offset)
end

# File activesupport/lib/active_support/time_with_zone.rb, line 111
def utc?
  @is_utc
end

# File activesupport/lib/active_support/time_with_zone.rb, line 117
def utc_offset
  period.observed_utc_offset
end

# File activesupport/lib/active_support/time_with_zone.rb, line 154
def xmlschema(fraction_digits = 0)
  if @is_utc
    utc.iso8601(fraction_digits || 0)
  else
    str = time.iso8601(fraction_digits || 0)
    str[-1] = formatted_offset(true, "Z")
    str
  end
end

# File activesupport/lib/active_support/time_with_zone.rb, line 275
def yesterday?
  time.yesterday?
end

# File activesupport/lib/active_support/time_with_zone.rb, line 139
def zone
  period.abbreviation
end