Class: TZInfo::RubyDataSource

Inherits:
DataSource show all
Defined in:
lib/tzinfo/ruby_data_source.rb

Overview

A DataSource that loads data from the set of Ruby modules included in the TZInfo::Data library (tzinfo-data gem).

To have TZInfo use this DataSource, call TZInfo::DataSource.set as follows:

TZInfo::DataSource.set(:ruby)

Constant Summary collapse

@@timezone_index_loaded =

Whether the timezone index has been loaded yet.

false
@@country_index_loaded =

Whether the country index has been loaded yet.

false

Instance Method Summary collapse

Methods inherited from DataSource

get, #inspect, set

Constructor Details

#initialize ⇒ RubyDataSource

Initializes a new RubyDataSource instance.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/tzinfo/ruby_data_source.rb', line 20

def initialize
  tzinfo_data = File.join('tzinfo', 'data')
  begin
    require(tzinfo_data)

    data_file = File.join('', 'tzinfo', 'data.rb')
    path = $".reverse_each.detect {|p| p.end_with?(data_file) }
    if path
      @base_path = File.join(File.dirname(path), 'data').untaint
    else
      @base_path = tzinfo_data
    end
  rescue LoadError
    @base_path = tzinfo_data
  end
end

Instance Method Details

#country_codes ⇒ Object

Returns an array of all the available ISO 3166-1 alpha-2 country codes.



97
98
99
100
 
# File 'lib/tzinfo/ruby_data_source.rb', line 97

def country_codes
  load_country_index
  Data::Indexes::Countries.countries.keys.freeze
end

#data_timezone_identifiers ⇒ Object

Returns an array of all the available timezone identifiers for data timezones (i.e. those that actually contain definitions).



73
74
75
76
 
# File 'lib/tzinfo/ruby_data_source.rb', line 73

def data_timezone_identifiers
  load_timezone_index
  Data::Indexes::Timezones.data_timezones
end

#linked_timezone_identifiers ⇒ Object

Returns an array of all the available timezone identifiers that are links to other timezones.



80
81
82
83
 
# File 'lib/tzinfo/ruby_data_source.rb', line 80

def linked_timezone_identifiers
  load_timezone_index
  Data::Indexes::Timezones.linked_timezones
end

#load_country_info(code) ⇒ Object

Returns a CountryInfo instance for the given ISO 3166-1 alpha-2 country code. Raises InvalidCountryCode if the country could not be found or the code is invalid.

Raises:



88
89
90
91
92
93
 
# File 'lib/tzinfo/ruby_data_source.rb', line 88

def load_country_info(code)
  load_country_index
  info = Data::Indexes::Countries.countries[code]
  raise InvalidCountryCode, 'Invalid country code' unless info
  info
end

#load_timezone_info(identifier) ⇒ Object

Returns a TimezoneInfo instance for a given identifier. Raises InvalidTimezoneIdentifier if the timezone is not found or the identifier is invalid.

Raises:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/tzinfo/ruby_data_source.rb', line 40

def load_timezone_info(identifier)
  raise InvalidTimezoneIdentifier, 'Invalid identifier' if identifier !~ /^[A-Za-z0-9\+\-_]+(\/[A-Za-z0-9\+\-_]+)*$/
  
  identifier = identifier.gsub(/-/, '__m__').gsub(/\+/, '__p__')
  
  # Untaint identifier after it has been reassigned to a new string. We
  # don't want to modify the original identifier. identifier may also be 
  # frozen and therefore cannot be untainted.
  identifier.untaint
  
  identifier = identifier.split('/')
  begin
    require_definition(identifier)
    
    m = Data::Definitions
    identifier.each {|part|
      m = m.const_get(part)
    }
    
    m.get
  rescue LoadError, NameError => e
    raise InvalidTimezoneIdentifier, e.message
  end
end

#timezone_identifiers ⇒ Object

Returns an array of all the available timezone identifiers.



66
67
68
69
 
# File 'lib/tzinfo/ruby_data_source.rb', line 66

def timezone_identifiers
  load_timezone_index
  Data::Indexes::Timezones.timezones
end

#to_s ⇒ Object

Returns the name of this DataSource.



103
104
105
 
# File 'lib/tzinfo/ruby_data_source.rb', line 103

def to_s
  "Ruby DataSource"
end