Class: ActiveSupport::TimeWithZone

### Home Classes Methods

### In Files

- lib/active_support/time_with_zone.rb

### Parent

Object

### Methods

- ::name
- ::new
- #+
- #-
- #<=>
- #acts_like_time?
- #advance
- #ago
- #as_json
- #between?
- #comparable_time
- #dst?
- #encode_with
- #eql?
- #formatted_offset
- #freeze
- #future?
- #getgm
- #getlocal
- #getutc
- #gmt?
- #gmt_offset
- #gmtime
- #gmtoff
- #hash
- #httpdate
- #in_time_zone
- #inspect
- #is_a?
- #isdst
- #iso8601
- #kind_of?
- #localtime
- #marshal_dump
- #marshal_load
- #method_missing
- #past?
- #period
- #respond_to?
- #rfc2822
- #rfc822
- #since
- #strftime
- #time
- #to_a
- #to_datetime
- #to_f
- #to_formatted_s
- #to_i
- #to_s
- #to_time
- #to_yaml
- #today?
- #tv_sec
- #usec
- #utc
- #utc?
- #utc_offset
- #xmlschema
- #zone

### Included Modules

- Comparable

### Class/Module Index

Quicksearch

- ActiveSupport
- ActiveSupport::Autoload
- ActiveSupport::BacktraceCleaner
- ActiveSupport::Base64
- ActiveSupport::BasicObject
- ActiveSupport::Benchmarkable
- ActiveSupport::BufferedLogger
- ActiveSupport::BufferedLogger::Severity
- ActiveSupport::Cache
- ActiveSupport::Cache::Entry
- ActiveSupport::Cache::FileStore
- ActiveSupport::Cache::MemCacheStore
- ActiveSupport::Cache::MemoryStore
- ActiveSupport::Cache::NullStore
- ActiveSupport::Cache::Store
- ActiveSupport::Cache::Strategy
- ActiveSupport::Cache::Strategy::LocalCache
- ActiveSupport::Cache::Strategy::LocalCache::LocalStore
- ActiveSupport::Callbacks
- ActiveSupport::Callbacks::ClassMethods
- ActiveSupport::Concern
- ActiveSupport::Configurable
- ActiveSupport::Configurable::ClassMethods
- ActiveSupport::Configurable::Configuration
- ActiveSupport::Dependencies
- ActiveSupport::Dependencies::ClassCache
- ActiveSupport::Dependencies::WatchStack
- ActiveSupport::Deprecation
- ActiveSupport::DescendantsTracker
- ActiveSupport::Duration
- ActiveSupport::FileUpdateChecker
- ActiveSupport::FileWatcher
- ActiveSupport::FileWatcher::Backend
- ActiveSupport::Gzip
- ActiveSupport::Gzip::Stream
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::Inflector
- ActiveSupport::Inflector::Inflections
- ActiveSupport::InheritableOptions
- ActiveSupport::JSON
- ActiveSupport::JSON::Encoding
- ActiveSupport::JSON::Encoding::CircularReferenceError
- ActiveSupport::JSON::Encoding::Encoder
- ActiveSupport::JSON::Variable
- ActiveSupport::LogSubscriber
- ActiveSupport::LogSubscriber::TestHelper
- ActiveSupport::LogSubscriber::TestHelper::MockLogger
- ActiveSupport::Memoizable
- ActiveSupport::Memoizable::InstanceMethods
- ActiveSupport::MessageEncryptor
- ActiveSupport::MessageEncryptor::InvalidMessage
- ActiveSupport::MessageVerifier
- ActiveSupport::MessageVerifier::InvalidSignature
- ActiveSupport::Multibyte
- ActiveSupport::Multibyte::Chars
- ActiveSupport::Multibyte::EncodingError
- ActiveSupport::Multibyte::Unicode
- ActiveSupport::Multibyte::Unicode::Codepoint
- ActiveSupport::Multibyte::Unicode::UnicodeDatabase
- ActiveSupport::Notifications
- ActiveSupport::Notifications::Event
- ActiveSupport::Notifications::Fanout
- ActiveSupport::Notifications::Instrumenter
- ActiveSupport::OrderedHash
- ActiveSupport::OrderedOptions
- ActiveSupport::Railtie
- ActiveSupport::Rescuable
- ActiveSupport::Rescuable::ClassMethods
- ActiveSupport::SafeBuffer
- ActiveSupport::SafeBuffer::SafeConcatError
- ActiveSupport::StringInquirer
- ActiveSupport::TaggedLogging
- ActiveSupport::TestCase
- ActiveSupport::Testing
- ActiveSupport::Testing::Assertions
- ActiveSupport::Testing::Declarative
- ActiveSupport::Testing::Isolation
- ActiveSupport::Testing::Isolation::Forking
- ActiveSupport::Testing::Isolation::MiniTest
- ActiveSupport::Testing::Isolation::Subprocess
- ActiveSupport::Testing::Isolation::TestUnit
- ActiveSupport::Testing::Pending
- ActiveSupport::Testing::Performance
- ActiveSupport::Testing::Performance::Benchmarker
- ActiveSupport::Testing::Performance::ForClassicTestUnit
- ActiveSupport::Testing::Performance::ForMiniTest
- ActiveSupport::Testing::Performance::Metrics
- ActiveSupport::Testing::Performance::Metrics::Amount
- ActiveSupport::Testing::Performance::Metrics::Base
- ActiveSupport::Testing::Performance::Metrics::CpuTime
- ActiveSupport::Testing::Performance::Metrics::DigitalInformationUnit
- ActiveSupport::Testing::Performance::Metrics::GcRuns
- ActiveSupport::Testing::Performance::Metrics::GcTime
- ActiveSupport::Testing::Performance::Metrics::Memory
- ActiveSupport::Testing::Performance::Metrics::Objects
- ActiveSupport::Testing::Performance::Metrics::ProcessTime
- ActiveSupport::Testing::Performance::Metrics::Time
- ActiveSupport::Testing::Performance::Metrics::UserTime
- ActiveSupport::Testing::Performance::Metrics::WallTime
- ActiveSupport::Testing::Performance::Performer
- ActiveSupport::Testing::Performance::Profiler
- ActiveSupport::Testing::ProxyTestResult
- ActiveSupport::Testing::RemoteError
- ActiveSupport::Testing::SetupAndTeardown
- ActiveSupport::Testing::SetupAndTeardown::ClassMethods
- ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
- ActiveSupport::Testing::SetupAndTeardown::ForMiniTest
- ActiveSupport::TimeWithZone
- ActiveSupport::TimeZone
- ActiveSupport::XmlMini
- ActiveSupport::XmlMini_LibXMLSAX
- ActiveSupport::XmlMini_LibXMLSAX::HashBuilder
- ActiveSupport::XmlMini_NokogiriSAX
- ActiveSupport::XmlMini_NokogiriSAX::HashBuilder
- Test
- Test::Unit
- Test::Unit::Collector
- Test::Unit::Collector::ObjectSpace
- Object
- Object::HashWithIndifferentAccess
- Object::MissingSourceFile
- ERB
- ERB::Util
- I18n
- I18n::Railtie
- LoadError
- LoadError
- Logger
- Logger::SimpleFormatter
- Array
- Base64
- Benchmark
- BigDecimal
- Class
- Date
- DateTime
- Enumerable
- FalseClass
- File
- Float
- Hash
- Integer
- Kernel
- Module
- NameError
- NilClass
- Numeric
- Process
- QualifiedConstUtils
- Range
- Regexp
- String
- Symbol
- Time
- TrueClass
- URI

No matching classes.

# ActiveSupport::TimeWithZone

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. Examples:

    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. Examples:

    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

### Attributes

time_zone[R]

### Public Class Methods

name() click to toggle source

    # File lib/active_support/time_with_zone.rb, line 38
    def self.name
      'Time' # Report class name as 'Time' to thwart type checking
    end

new(utc_time, time_zone, local_time = nil, period = nil) click to toggle source

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

### Public Instance Methods

+(other) click to toggle source

    # File lib/active_support/time_with_zone.rb, line 217
    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) click to toggle source

    # File lib/active_support/time_with_zone.rb, line 228
    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) click to toggle source

Use the time in UTC for comparisons.

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

acts_like_time?() click to toggle source

So that `self` `acts_like?(:time)`.

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

advance(options) click to toggle source

    # File lib/active_support/time_with_zone.rb, line 255
    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) click to toggle source

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

as_json(options = nil) click to toggle source

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 `ActiveSupport::JSON::Encoding.use_standard_json_time_format` to false.

#### Examples

    # With ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
    Time.utc(2005,2,1,15,15,10).in_time_zone.to_json
    # => "2005-02-01T15:15:10Z"

    # With ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
    Time.utc(2005,2,1,15,15,10).in_time_zone.to_json
    # => "2005/02/01 15:15:10 +0000"

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

between?(min, max) click to toggle source

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

comparable_time() click to toggle source
Alias for: utc
dst?() click to toggle source

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

Also aliased as: isdst
encode_with(coder) click to toggle source

    # File lib/active_support/time_with_zone.rb, line 141
    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) click to toggle source

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

formatted_offset(colon = true, alternate_utc_string = nil) click to toggle source

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

freeze() click to toggle source

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

future?() click to toggle source

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

getgm() click to toggle source
Alias for: utc
getlocal() click to toggle source
Alias for: localtime
getutc() click to toggle source
Alias for: utc
gmt?() click to toggle source
Alias for: utc?
gmt_offset() click to toggle source
Alias for: utc_offset
gmtime() click to toggle source
Alias for: utc
gmtoff() click to toggle source
Alias for: utc_offset
hash() click to toggle source

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

httpdate() click to toggle source

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

in_time_zone(new_zone = ::Time.zone) click to toggle source

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

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

inspect() click to toggle source

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

is_a?(klass) click to toggle source

Say we’re a Time to thwart type checking.

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

Also aliased as: kind_of?
isdst() click to toggle source
Alias for: dst?
iso8601(fraction_digits = 0) click to toggle source
Alias for: xmlschema
kind_of?(klass) click to toggle source
Alias for: is_a?
localtime() click to toggle source

Returns a `Time.local()` instance of the simultaneous time in your system’s `ENV['TZ']` zone

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

Also aliased as: getlocal
marshal_dump() click to toggle source

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

marshal_load(variables) click to toggle source

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

method_missing(sym, *args, &block) click to toggle source

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

    # File lib/active_support/time_with_zone.rb, line 331
    def method_missing(sym, *args, &block)
      wrap_with_time_zone time.__send__(sym, *args, &block)
    end

past?() click to toggle source

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

period() click to toggle source

Returns the underlying TZInfo::TimezonePeriod.

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

respond_to?(sym, include_priv = false) click to toggle source

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

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

rfc2822() click to toggle source

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

Also aliased as: rfc822
rfc822() click to toggle source
Alias for: rfc2822
since(other) click to toggle source

    # File lib/active_support/time_with_zone.rb, line 241
    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) click to toggle source

Replaces `%Z` and `%z` directives with `zone` and `formatted_offset`, respectively, before passing to Time#strftime, so that zone information is correct

    # File lib/active_support/time_with_zone.rb, line 179
    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() click to toggle source

Returns a Time or DateTime instance that represents the time in `time_zone`.

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

to_a() click to toggle source

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

to_datetime() click to toggle source

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

to_f() click to toggle source

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

to_formatted_s(format = :default) click to toggle source
Alias for: to_s
to_i() click to toggle source

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

Also aliased as: tv_sec
to_s(format = :default) click to toggle source

`:db` format outputs time in UTC; all others output time in local. Uses TimeWithZone's `strftime`, so `%Z` and `%z` work correctly.

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

Also aliased as: to_formatted_s
to_time() click to toggle source

A TimeWithZone acts like a Time, so just return `self`.

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

to_yaml(options = {}) click to toggle source

    # File lib/active_support/time_with_zone.rb, line 149
    def to_yaml(options = {})
      return super if defined?(YAML::ENGINE) && !YAML::ENGINE.syck?

      utc.to_yaml(options)
    end

today?() click to toggle source

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

tv_sec() click to toggle source
Alias for: to_i
usec() click to toggle source

    # File lib/active_support/time_with_zone.rb, line 273
    def usec
      time.respond_to?(:usec) ? time.usec : 0
    end

utc() click to toggle source

Returns a Time or DateTime instance that represents the time in UTC.

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

Also aliased as: comparable_time, getgm, getutc, gmtime
utc?() click to toggle source

    # File lib/active_support/time_with_zone.rb, line 86
    def utc?
      time_zone.name == 'UTC'
    end

Also aliased as: gmt?
utc_offset() click to toggle source

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

Also aliased as: gmt_offset, gmtoff
xmlschema(fraction_digits = 0) click to toggle source

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

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

Also aliased as: iso8601
zone() click to toggle source

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.