class TZInfo::Country

An ISO 3166 country. Can be used to get a list of Timezones for a country. For example:

us = Country.get('US')
us.zone_identifiers
us.zones
us.zone_info

Public Class Methods

_load (data)

Source

# File lib/tzinfo/country.rb, line 157
def self._load(data)
  Country.get(data)
end

Loads a marshalled Country.

all ()

Source

# File lib/tzinfo/country.rb, line 79
def self.all
  load_index
  Indexes::Countries.countries.keys.collect {|code| get(code)}
end

Returns an Array of all the defined Countries.

all_codes ()

Source

# File lib/tzinfo/country.rb, line 73
def self.all_codes
  load_index
  Indexes::Countries.countries.keys
end

Returns an Array of all the valid country codes.

get (identifier)

Source

# File lib/tzinfo/country.rb, line 46
def self.get(identifier)
  instance = @@countries[identifier]
  
  unless instance
    load_index
    info = Indexes::Countries.countries[identifier]        
    raise InvalidCountryCode.new, 'Invalid identifier' unless info
    instance = Country.new(info)
    @@countries[identifier] = instance
  end      
  
  instance        
end

Gets a Country by its ISO 3166 code. Raises an InvalidCountryCode exception if it couldn’t be found.

load_index ()

Source

# File lib/tzinfo/country.rb, line 163
def self.load_index
  unless @@index_loaded
    require 'tzinfo/indexes/countries'
    @@index_loaded = true
  end        
end

Loads in the index of countries if it hasn’t already been loaded.

new (identifier)

Source

# File lib/tzinfo/country.rb, line 62
def self.new(identifier)      
  if identifier.kind_of?(CountryInfo)
    instance = super()
    instance.send :setup, identifier
    instance
  else
    get(identifier)
  end
end

If identifier is a CountryInfo object, initializes the Country instance, otherwise calls get(identifier).

Calls superclass method

Public Instance Methods

<=> (c)

Source

# File lib/tzinfo/country.rb, line 136
def <=>(c)
  code <=> c.code
end

Compare two Countries based on their code. Returns -1 if c is less than self, 0 if c is equal to self and +1 if c is greater than self.

_dump (limit)

Source

# File lib/tzinfo/country.rb, line 152
def _dump(limit)
  code
end

Dumps this Country for marshalling.

code ()

Source

# File lib/tzinfo/country.rb, line 85
def code
  @info.code
end

The ISO 3166 country code.

eql? (c)

Source

# File lib/tzinfo/country.rb, line 142
def eql?(c)
  self == c
end

Returns true if and only if the code of c is equal to the code of this Country.

hash ()

Source

# File lib/tzinfo/country.rb, line 147
def hash
  code.hash
end

Returns a hash value for this Country.

inspect ()

Source

# File lib/tzinfo/country.rb, line 100
def inspect
  "#<#{self.class}: #{@info.code}>"
end

Returns internal object state as a programmer-readable string.

name ()

Source

# File lib/tzinfo/country.rb, line 90
def name
  @info.name
end

The name of the country.

to_s ()

Source

# File lib/tzinfo/country.rb, line 95
def to_s
  name
end

Alias for name.

zone_identifiers ()

Source

# File lib/tzinfo/country.rb, line 108
def zone_identifiers
  @info.zone_identifiers
end

Returns a frozen array of all the zone identifiers for the country. These are in an order that

(1) makes some geographical sense, and
(2) puts the most populous zones first, where that does not contradict (1).

Also aliased as: zone_names

zone_info ()

Source

# File lib/tzinfo/country.rb, line 130
def zone_info
  @info.zones
end

Returns a frozen array of all the timezones for the for the country as CountryTimezone instances (containing extra information about each zone). These are in an order that

(1) makes some geographical sense, and
(2) puts the most populous zones first, where that does not contradict (1).

zone_names ()

Alias for: zone_identifiers

zones ()

Source

# File lib/tzinfo/country.rb, line 119
def zones
  zone_identifiers.collect {|id|
    Timezone.get_proxy(id)        
  }
end

An array of all the Timezones for this country. Returns TimezoneProxy objects to avoid the overhead of loading Timezone definitions until a conversion is actually required. The Timezones are returned in an order that

(1) makes some geographical sense, and
(2) puts the most populous zones first, where that does not contradict (1).