123456789_123456789_123456789_123456789_123456789_

Class: TZInfo::Format2::CountryIndexDefiner Private

Do not use. This class is for internal use only.
Relationships & Source Files
Inherits: Object
Defined in: lib/tzinfo/format2/country_index_definer.rb

Overview

Instances of CountryIndexDefiner are yielded to the format 2 version of TZInfo::Data::Indexes::Countries by CountryIndexDefinition to allow countries and their time zones to be specified.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#countries ⇒ Hash<String, CountryInfo> (readonly)

Returns:

  • (Hash<String, CountryInfo>) —

    a Hash of all the countries that have been defined in the index keyed by their codes.

[ GitHub ] 

  


# File 'lib/tzinfo/format2/country_index_definer.rb', line 13



attr_reader :countries


  







Instance Method Details



  

    #country(code, name) {|definer| ... } 
  



  

    
Defines a country.


  





  
Parameters:


    
  
  • 
    code
    (String)
—    
    The ISO 3166-1 alpha-2 code of the country.
    

    
  
    • 
  
  • 
    name
    (String)
—    
    Then name of the country.
    

    
  
    • 



Yields:


    
  
  • 
    (definer)
—    
    yields (optional) to obtain the time zones for the
country.
    

    
  
    • 



Yield Parameters:





  [ GitHub ]


  

  


# File 'lib/tzinfo/format2/country_index_definer.rb', line 56



def country(code, name)
  timezones = if block_given?
    definer = CountryDefiner.new(@shared_timezones, @identifier_deduper, @description_deduper)
    yield definer
    definer.timezones
  else
    []
  end
  @countries[code.freeze] = DataSources::CountryInfo.new(code, name, timezones)
end


  








  

    #timezone(reference, identifier, latitude_numerator, latitude_denominator, longitude_numerator, longitude_denominator, description = nil)  
  



  

    
Defines a time zone shared by many countries with an reference for
subsequent use in country definitions. The latitude and longitude are
given as the numerator and denominator of a Rational.


  





  
Parameters:


    
  
  • 
    reference
    (Symbol)
—    
    a unique reference for the time zone.
    

    
  
    • 
  
  • 
    identifier
    (String)
—    
    the time zone identifier.
    

    
  
    • 
  
  • 
    latitude_numerator
    (Integer)
—    
    the numerator of the latitude.
    

    
  
    • 
  
  • 
    latitude_denominator
    (Integer)
—    
    the denominator of the latitude.
    

    
  
    • 
  
  • 
    longitude_numerator
    (Integer)
—    
    the numerator of the longitude.
    

    
  
    • 
  
  • 
    longitude_denominator
    (Integer)
—    
    the denominator of the longitude.
    

    
  
    • 
  
  • 
    description
    (String)
    (defaults to: nil)
—    
    an optional description for the time zone.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/tzinfo/format2/country_index_definer.rb', line 39



def timezone(reference, identifier, latitude_numerator, latitude_denominator,
              longitude_numerator, longitude_denominator, description = nil)
  # Dedupe non-frozen literals from format 1 on all Ruby versions and
  # format 2 on Ruby < 2.3 (without frozen_string_literal support).
  @shared_timezones[reference] = CountryTimezone.new(@identifier_deduper.dedupe(identifier),
    Rational(latitude_numerator, latitude_denominator),
    Rational(longitude_numerator, longitude_denominator), description && @description_deduper.dedupe(description))
end