123456789_123456789_123456789_123456789_123456789_

Class: ActiveSupport::TimeWithZone

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, Comparable, ::DateAndTime::Compatibility
Inherits: Object
Defined in: activesupport/lib/active_support/time_with_zone.rb

Overview

A Time-like class that can represent a time in any time zone. Necessary because standard Ruby Time instances are limited to UTC and the system's ENV['TZ'] zone.

You shouldn't ever need to create a TimeWithZone instance directly via .new. Instead use methods local, parse, at and now on TimeZone instances, and #in_time_zone on ::Time and ::DateTime instances.

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

See Time and TimeZone for further documentation of these methods.

TimeWithZone instances implement the same API as Ruby Time instances, so that ::Time and TimeWithZone instances are interchangeable.

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

Class Method Summary

Instance Attribute Summary

::DateAndTime::Compatibility - Included

#preserve_timezone

Instance Method Summary

Constructor Details

.new(utc_time, time_zone, local_time = nil, period = nil) ⇒ TimeWithZone

[ GitHub ] 

  


# 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


  







Dynamic Method Handling

  

    This class handles dynamic methods through the method_missing method




  

    #method_missing(sym, *args, &block)  
  



  

    

Send the missing method to #time instance, and wrap result in a new TimeWithZone with the existing #time_zone.


  



  [ GitHub ]


  

  


# 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


  







Class Method Details



  

    .name  
  



  

    

Report class name as 'Time' to thwart type checking.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 40



def self.name
  'Time'
end


  







Instance Attribute Details



  

    #acts_like_time?  ⇒ Boolean  (readonly)
  



  

    

So that self acts_like?(:time).


  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 341



def acts_like_time?
  true
end


  








  

    #dst?  ⇒ Boolean  (readonly)
    Also known as: #isdst
  



  

    

Returns true if the current time is within Daylight Savings ::Time for the specified time zone.



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


  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 90



def dst?
  period.dst?
end


  








  

    #future?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the current object's time is in the future.


  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 239



def future?
  utc.future?
end


  








  

    #gmt?   (readonly)
  



  

    

Alias for #utc?.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 104



alias_method :gmt?, :utc?


  








  

    #isdst   (readonly)
  



  

    

Alias for #dst?.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 93



alias_method :isdst, :dst?


  








  

    #past?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the current object's time is in the past.


  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 228



def past?
  utc.past?
end


  








  

    #time_zone   (readonly)
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 45



attr_reader :time_zone


  








  

    #today?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the current object's time falls within the current day.


  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 234



def today?
  time.today?
end


  








  

    #utc   (readonly)
    Also known as: #comparable_time, #getgm, #getutc, #gmtime
  



  

    

Returns a ::Time instance of the simultaneous time in the UTC timezone.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 59



def utc
  @utc ||= period.to_utc(@time)
end


  








  

    #utc?  ⇒ Boolean  (readonly)
    Also known as: #gmt?
  



  

    

Returns true if the current time zone is set to 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


  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 101



def utc?
  time_zone.name == 'UTC'
end


  







Instance Method Details



  

    #+(other)  
  

  [ GitHub ]


  

  


# 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)  
  

  [ GitHub ]


  

  


# 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)  
  



  

    

Use the time in UTC for comparisons.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 217



def <=>(other)
  utc <=> other
end


  








  

    #advance(options)  
  

  [ GitHub ]


  

  


# 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)  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 286



def ago(other)
  since(-other)
end


  








  

    #as_json(options = nil)  
  



  

    

Coerces time to a string for JSON encoding. The default format is ISO 8601. You can get %Y/%m/%d %H:%M:%S +offset style by setting JSON::Encoding.use_standard_json_time_format to 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"


  



  [ GitHub ]


  

  


# 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
    %(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end


  








  

    #between?(min, max)  ⇒ Boolean 
  



  

    

Returns true if the current object's time is within the specified min and max time.


  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 223



def between?(min, max)
  utc.between?(min, max)
end


  








  

    #comparable_time  
  



  

    

Alias for #utc.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 62



alias_method :comparable_time, :utc


  








  

    #eql?(other)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# 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)  
  



  

    

Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already 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"


  



  [ GitHub ]


  

  


# 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


  








  

    #freeze  
  

  [ GitHub ]


  

  


# 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


  








  

    #getgm  
  



  

    

Alias for #utc.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 63



alias_method :getgm, :utc


  








  

    #getlocal(utc_offset = nil)  
  



  

    

Alias for #localtime.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 82



alias_method :getlocal, :localtime


  








  

    #getutc  
  



  

    

Alias for #utc.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 64



alias_method :getutc, :utc


  








  

    #gmt_offset  
  



  

    

Alias for #utc_offset.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 110



alias_method :gmt_offset, :utc_offset


  








  

    #gmtime  
  



  

    

Alias for #utc.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 65



alias_method :gmtime, :utc


  








  

    #gmtoff  
  



  

    

Alias for #utc_offset.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 111



alias_method :gmtoff, :utc_offset


  








  

    #hash  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 247



def hash
  utc.hash
end


  








  

    #httpdate  
  



  

    

Returns a string of the object's date and time in the format used by HTTP requests.



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


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 180



def httpdate
  utc.httpdate
end


  








  

    #in(other)  
  



  

    

Alias for #since.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 284



alias_method :in, :since


  








  

    #in_time_zone(new_zone = ::Time.zone)  
  



  

    

Returns the simultaneous time in Time.zone, or the specified zone.


  



  [ GitHub ]


  

  


# 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


  








  

    #inspect  
  

  [ GitHub ]


  

  


# 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)  ⇒ Boolean 
    Also known as: #kind_of?
  



  

    

Say we're a ::Time to thwart type checking.


  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 346



def is_a?(klass)
  klass == ::Time || super
end


  








  

    #iso8601(fraction_digits = 0)  
  



  

    

Alias for #xmlschema.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 142



alias_method :iso8601, :xmlschema


  








  

    #kind_of?(klass)  
  



  

    

Alias for #is_a?.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 349



alias_method :kind_of?, :is_a?


  








  

    #localtime(utc_offset = nil)  
    Also known as: #getlocal
  



  

    

Returns a ::Time instance of the simultaneous time in the system timezone.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 79



def localtime(utc_offset = nil)
  utc.getlocal(utc_offset)
end


  








  

    #marshal_dump  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 357



def marshal_dump
  [utc, time_zone.name, time]
end


  








  

    #marshal_load(variables)  
  

  [ GitHub ]


  

  


# 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


  








  

    #period  
  



  

    

Returns the underlying TZInfo::TimezonePeriod.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 68



def period
  @period ||= time_zone.period_for_utc(@utc)
end


  








  

    #respond_to?(sym, include_priv = false)  ⇒ Boolean 
  



  

    

respond_to_missing? is not called in some cases, such as when type conversion is performed with Kernel.String


  





  


  [ GitHub ]


  

  


# 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?(sym, include_priv)  ⇒ Boolean 
  



  

    

Ensure proxy class responds to all methods that underlying time instance responds to.


  





  


  [ GitHub ]


  

  


# 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  
    Also known as: #rfc822
  



  

    

Returns a string of the object's date and time in the RFC 2822 standard format.



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


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 188



def rfc2822
  to_s(:rfc822)
end


  








  

    #rfc822  
  



  

    

Alias for #rfc2822.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 191



alias_method :rfc822, :rfc2822


  








  

    #since(other)  
    Also known as: #in
  

  [ GitHub ]


  

  


# 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


  








  

    #strftime(format)  
  



  

    

Replaces %Z directive with +zone before passing to Time#strftime, so that zone information is correct.


  



  [ GitHub ]


  

  


# 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


  








  

    #time  
  



  

    

Returns a ::Time instance that represents the time in #time_zone.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 54



def time
  @time ||= period.to_local(@utc)
end


  








  

    #to_a  
  

  [ GitHub ]


  

  


# 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  
  

  [ GitHub ]


  

  


# 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  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 312



def to_f
  utc.to_f
end


  








  

    #to_formatted_s(format = :default)  
  



  

    

Alias for #to_s.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 207



alias_method :to_formatted_s, :to_s


  








  

    #to_i  
    Also known as: #tv_sec
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 316



def to_i
  utc.to_i
end


  








  

    #to_r  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 321



def to_r
  utc.to_r
end


  








  

    #to_s(format = :default)  
    Also known as: #to_formatted_s
  



  

    

Returns a string of the object's date and time. Accepts an optional format:



  



  [ GitHub ]


  

  


# 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


  








  

    #to_time  
  



  

    

Returns an instance of ::Time, either with the same UTC offset as self or in the local system timezone depending on the setting of ActiveSupport.to_time_preserves_timezone.


  



  [ GitHub ]


  

  


# 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


  








  

    #tv_sec  
  



  

    

Alias for #to_i.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 319



alias_method :tv_sec, :to_i


  








  

    #utc_offset  
    Also known as: #gmt_offset, #gmtoff
  



  

    

Returns the offset from current time to UTC time in seconds.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 107



def utc_offset
  period.utc_total_offset
end


  








  

    #xmlschema(fraction_digits = 0)  
    Also known as: #iso8601
  

  [ GitHub ]


  

  


# 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


  








  

    #zone  
  



  

    

::Time uses zone to display the time zone abbreviation, so we're duck-typing it.


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/time_with_zone.rb', line 127



def zone
  period.zone_identifier.to_s
end