Class: TZInfo::DataSource Abstract

# File 'lib/tzinfo/data_source.rb', line 42

def get
  # If a DataSource hasn't been manually set when the first request is
  # made to obtain a DataSource, then a default data source is created.
  #
  # This is done at the first request rather than when TZInfo is loaded to
  # avoid unnecessary attempts to find a suitable DataSource.
  #
  # A `Mutex` is used to ensure that only a single default instance is
  # created (this avoiding the possibility of retaining two copies of the
  # same data in memory).

  unless @@instance
    @@default_mutex.synchronize do
      set(create_default_data_source) unless @@instance
    end
  end

  @@instance
end

# File 'lib/tzinfo/data_source.rb', line 127

def set(data_source_or_type, *args)
  if data_source_or_type.kind_of?(DataSource)
    @@instance = data_source_or_type
  elsif data_source_or_type == :ruby
    @@instance = DataSources::RubyDataSource.new
  elsif data_source_or_type == :zoneinfo
    @@instance = DataSources::ZoneinfoDataSource.new(*args)
  else
    raise ArgumentError, 'data_source_or_type must be a DataSource instance or a data source type (:ruby or :zoneinfo)'
  end
end

# File 'lib/tzinfo/data_source.rb', line 246

def country_codes
  raise_invalid_data_source('country_codes')
end

# File 'lib/tzinfo/data_source.rb', line 218

def data_timezone_identifiers
  raise_invalid_data_source('data_timezone_identifiers')
end

# File 'lib/tzinfo/data_source.rb', line 255

def eager_load!
  timezone_identifiers.each {|identifier| load_timezone_info(identifier) }
  country_codes.each {|code| load_country_info(code) }
  nil
end

# File 'lib/tzinfo/data_source.rb', line 398

def find_timezone_identifier(identifier)

  result = timezone_identifiers.bsearch {|i| i >= identifier }
  result == identifier ? result : nil
end

# File 'lib/tzinfo/data_source.rb', line 237

def get_country_info(code)
  load_country_info(code)
end

# File 'lib/tzinfo/data_source.rb', line 184

def get_timezone_info(identifier)
  result = @timezones[identifier]

  unless result
    # Thread-safety: It is possible that multiple equivalent TimezoneInfo
    # instances could be created here in concurrently executing threads. The
    # consequences of this are that the data may be loaded more than once
    # (depending on the data source). The performance benefit of ensuring
    # that only a single instance is created is unlikely to be worth the
    # overhead of only allowing one TimezoneInfo to be loaded at a time.

    result = load_timezone_info(identifier)
    @timezones[result.identifier] = result
  end

  result
end

# File 'lib/tzinfo/data_source.rb', line 268

def inspect
  "#<#{self.class}>"
end

# File 'lib/tzinfo/data_source.rb', line 228

def linked_timezone_identifiers
  raise_invalid_data_source('linked_timezone_identifiers')
end

# File 'lib/tzinfo/data_source.rb', line 294

def load_country_info(code)
  raise_invalid_data_source('load_country_info')
end

# File 'lib/tzinfo/data_source.rb', line 285

def load_timezone_info(identifier)
  raise_invalid_data_source('load_timezone_info')
end

# File 'lib/tzinfo/data_source.rb', line 337

def lookup_country_info(hash, code, encoding = Encoding::UTF_8)
  raise InvalidCountryCode, "Invalid country code: #{code.nil? ? 'nil' : code}" unless code.kind_of?(String)

  info = try_with_encoding(code, encoding) {|c| hash[c] }
  return info if info

  raise InvalidCountryCode, "Invalid country code: #{code.encode(Encoding::UTF_8)}"
end

# File 'lib/tzinfo/data_source.rb', line 352

def raise_invalid_data_source(method_name)
  raise InvalidDataSource, "#{method_name} not defined"
end

# File 'lib/tzinfo/data_source.rb', line 300

def timezone_identifier_encoding
  Encoding::UTF_8
end

# File 'lib/tzinfo/data_source.rb', line 204

def timezone_identifiers
  # Thread-safety: It is possible that the value of @timezone_identifiers
  # may be calculated multiple times in concurrently executing threads. It
  # is not worth the overhead of locking to ensure that
  # @timezone_identifiers is only calculated once.
  @timezone_identifiers ||= build_timezone_identifiers
end

# File 'lib/tzinfo/data_source.rb', line 262

def to_s
  "Default DataSource"
end

# File 'lib/tzinfo/data_source.rb', line 436

def try_with_encoding(string, encoding)
  result = yield string
  return result if result

  unless encoding == string.encoding
    string = string.encode(encoding)
    yield string
  end
end

# File 'lib/tzinfo/data_source.rb', line 315

def validate_timezone_identifier(identifier)
  raise InvalidTimezoneIdentifier, "Invalid identifier: #{identifier.nil? ? 'nil' : identifier}" unless identifier.kind_of?(String)

  valid_identifier = try_with_encoding(identifier, timezone_identifier_encoding) {|id| find_timezone_identifier(id) }
  return valid_identifier if valid_identifier

  raise InvalidTimezoneIdentifier, "Invalid identifier: #{identifier.encode(Encoding::UTF_8)}"
end