class Configurate::LookupChain
This object builds a chain of configuration providers to try to find the value of a setting.
Public Class Methods
new()
click to toggle source
# File lib/configurate/lookup_chain.rb, line 7 def initialize @provider = [] end
Public Instance Methods
add_provider(provider, ...)
click to toggle source
Adds a provider to the chain. Providers are tried in the order they are added, so the order is important.
@param provider [#lookup] @param … the arguments passed to the providers constructor @raise [ArgumentError] if an invalid provider is given @return [void]
# File lib/configurate/lookup_chain.rb, line 18 def add_provider(provider, ...) unless provider.respond_to?(:instance_methods) && provider.instance_methods.include?(:lookup) raise ArgumentError, "the given provider does not respond to lookup" end @provider << provider.new(...) end
lookup(setting, ...)
click to toggle source
Tries all providers in the order they were added to provide a response for setting.
@param setting [SettingPath,String] nested settings as strings should
be separated by a dot
@param … further args passed to the provider @return [Array,Hash,String,Boolean,nil] whatever the responding
provider provides is casted to a {String}, except for some special values
# File lib/configurate/lookup_chain.rb, line 34 def lookup(setting, ...) setting = SettingPath.new setting if setting.is_a? String @provider.each do |provider| begin return special_value_or_string(provider.lookup(setting.clone, ...)) rescue SettingNotFoundError; end end nil end
Also aliased as: []
Private Instance Methods
special_value_or_string(value)
click to toggle source
# File lib/configurate/lookup_chain.rb, line 48 def special_value_or_string(value) case value when TrueClass, FalseClass, NilClass, Array, Hash value else if value.respond_to?(:to_s) case value.to_s.strip when "true" then true when "false" then false when "", "nil" then nil else value.to_s end else value end end end