class TZInfo::TimezoneProxy

A proxy class representing a timezone with a given identifier. TimezoneProxy inherits from Timezone and can be treated like any Timezone loaded with Timezone.get.

The first time an attempt is made to access the data for the timezone, the real Timezone is loaded. If the proxy's identifier was not valid, then an exception will be raised at this point.

Public Class Methods

_load(data) click to toggle source

Loads a marshalled TimezoneProxy.

# File lib/tzinfo/timezone_proxy.rb, line 81
def self._load(data)
  TimezoneProxy.new(data)
end
new(identifier) click to toggle source

Construct a new TimezoneProxy for the given identifier. The identifier is not checked when constructing the proxy. It will be validated on the when the real Timezone is loaded.

Calls superclass method TZInfo::Timezone::new
# File lib/tzinfo/timezone_proxy.rb, line 14
def self.new(identifier)
  # Need to override new to undo the behaviour introduced in Timezone#new.
  tzp = super()
  tzp.send(:setup, identifier)
  tzp
end

Public Instance Methods

_dump(limit) click to toggle source

Dumps this TimezoneProxy for marshalling.

# File lib/tzinfo/timezone_proxy.rb, line 76
def _dump(limit)
  identifier
end
canonical_zone() click to toggle source

Returns the canonical zone for this Timezone.

# File lib/tzinfo/timezone_proxy.rb, line 71
def canonical_zone
  real_timezone.canonical_zone
end
identifier() click to toggle source

The identifier of the timezone, e.g. “Europe/Paris”.

# File lib/tzinfo/timezone_proxy.rb, line 22
def identifier
  @real_timezone ? @real_timezone.identifier : @identifier
end
period_for_utc(utc) click to toggle source

Returns the TimezonePeriod for the given UTC time. utc can either be a DateTime, Time or integer timestamp (Time.to_i). Any timezone information in utc is ignored (it is treated as a UTC time).

# File lib/tzinfo/timezone_proxy.rb, line 29
def period_for_utc(utc)            
  real_timezone.period_for_utc(utc)            
end
periods_for_local(local) click to toggle source

Returns the set of TimezonePeriod instances that are valid for the given local time as an array. If you just want a single period, use period_for_local instead and specify how abiguities should be resolved. Returns an empty array if no periods are found for the given time.

# File lib/tzinfo/timezone_proxy.rb, line 37
def periods_for_local(local)
  real_timezone.periods_for_local(local)
end
transitions_up_to(to, from = nil) click to toggle source

Returns an Array of TimezoneTransition instances representing the times where the UTC offset of the timezone changes.

Transitions are returned up to a given date and time up to a given date and time (to).

A from date and time may also be supplied using the from parameter. If from is not nil, only transitions from that date and time onwards will be returned.

Comparisons with to are exclusive. Comparisons with from are inclusive. If a transition falls precisely on to, it will be excluded. If a transition falls on from, it will be included.

Transitions returned are ordered by when they occur, from earliest to latest.

to and from can be specified using either a Time, DateTime, Time or Timestamp.

If from is specified and to is not greater than from, then an ArgumentError exception is raised.

ArgumentError is raised if to is nil or of either to or from are Timestamps with unspecified offsets.

# File lib/tzinfo/timezone_proxy.rb, line 66
def transitions_up_to(to, from = nil)
  real_timezone.transitions_up_to(to, from)
end

Private Instance Methods

real_timezone() click to toggle source
# File lib/tzinfo/timezone_proxy.rb, line 91
def real_timezone
  # Thread-safety: It is possible that the value of @real_timezone may be
  # calculated multiple times in concurrently executing threads. It is not
  # worth the overhead of locking to ensure that @real_timezone is only
  # calculated once.
  unless @real_timezone
    result = Timezone.get(@identifier)
    return result if frozen?
    @real_timezone = result
  end

  @real_timezone
end
setup(identifier) click to toggle source
# File lib/tzinfo/timezone_proxy.rb, line 86
def setup(identifier)
  @identifier = identifier
  @real_timezone = nil
end