class Settingslogic

A simple settings solution using a YAML file. See README for more information.

Public Class Methods

new(hash_or_file = self.class.source, section = nil) click to toggle source

Initializes a new settings object. You can initialize an object in any of the following ways:

Settings.new(:application) # will look for config/application.yml
Settings.new("application.yaml") # will look for application.yaml
Settings.new("/var/configs/application.yml") # will look for /var/configs/application.yml
Settings.new(:config1 => 1, :config2 => 2)

Basically if you pass a symbol it will look for that file in the configs directory of your rails app, if you are using this in rails. If you pass a string it should be an absolute path to your settings file. Then you can pass a hash, and it just allows you to access the hash via methods.

# File lib/settingslogic.rb, line 94
def initialize(hash_or_file = self.class.source, section = nil)
  #puts "new! #{hash_or_file}"
  case hash_or_file
  when nil
    raise Errno::ENOENT, "No file specified as Settingslogic source"
  when Hash
    self.replace hash_or_file
  else
    file_contents = open(hash_or_file).read
    hash = file_contents.empty? ? {} : YAML.load(ERB.new(file_contents).result).to_hash
    if self.class.namespace
      hash = hash[self.class.namespace] or return missing_key("Missing setting '#{self.class.namespace}' in #{hash_or_file}")
    end
    self.replace hash
  end
  @section = section || self.class.source  # so end of error says "in application.yml"
  create_accessors!
end

Public Instance Methods

[](key) click to toggle source

# File lib/settingslogic.rb, line 36
def [](key)
  instance.fetch(key.to_s, nil)
end

[]=(key, val) click to toggle source

# File lib/settingslogic.rb, line 40
def []=(key, val)
  # Setting[:key][:key2] = 'value' for dynamic settings
  val = new(val, source) if val.is_a? Hash
  instance.store(key.to_s, val)
  instance.create_accessor_for(key, val)
end

get(key) click to toggle source

Enables Settings.get('nested.key.name') for dynamic access

# File lib/settingslogic.rb, line 15
def get(key)
  parts = key.split('.')
  curs = self
  while p = parts.shift
    curs = curs.send(p)
  end
  curs
end

load!() click to toggle source

# File lib/settingslogic.rb, line 47
def load!
  instance
  true
end

missing_key(msg) click to toggle source

# File lib/settingslogic.rb, line 186
def missing_key(msg)
  return nil if self.class.suppress_errors

  raise MissingSetting, msg
end

namespace(value = nil) click to toggle source

# File lib/settingslogic.rb, line 28
def namespace(value = nil)
  @namespace ||= value
end

reload!() click to toggle source

# File lib/settingslogic.rb, line 52
def reload!
  @instance = nil
  load!
end

source(value = nil) click to toggle source

# File lib/settingslogic.rb, line 24
def source(value = nil)
  @source ||= value
end

suppress_errors(value = nil) click to toggle source

# File lib/settingslogic.rb, line 32
def suppress_errors(value = nil)
  @suppress_errors ||= value
end

symbolize_keys() click to toggle source

# File lib/settingslogic.rb, line 171
def symbolize_keys
  
  inject({}) do |memo, tuple|
    
    k = (tuple.first.to_sym rescue tuple.first) || tuple.first
          
    v = k.is_a?(Symbol) ? send(k) : tuple.last # make sure the value is accessed the same way Settings.foo.bar works
    
    memo[k] = v && v.respond_to?(:symbolize_keys) ? v.symbolize_keys : v #recurse for nested hashes
    
    memo
  end
  
end

to_hash() click to toggle source

Returns an instance of a Hash object

# File lib/settingslogic.rb, line 135
def to_hash
  Hash[self]
end

Private Instance Methods

create_accessor_for(key) click to toggle source

# File lib/settingslogic.rb, line 77
def create_accessor_for(key)
  return unless key.to_s =~ /^\w+$/  # could have "some-setting:" which blows up eval
  instance_eval "def #{key}; instance.send(:#{key}); end"
end

create_accessors!() click to toggle source

It would be great to DRY this up somehow, someday, but it's difficult because of the singleton pattern. Basically this proxies Setting.foo to Setting.instance.foo

# File lib/settingslogic.rb, line 71
def create_accessors!
  instance.each do |key,val|
    create_accessor_for(key)
  end
end

instance() click to toggle source

# File lib/settingslogic.rb, line 58
def instance
  return @instance if @instance
  @instance = new
  create_accessors!
  @instance
end

method_missing(name, *args, &block) click to toggle source

# File lib/settingslogic.rb, line 65
def method_missing(name, *args, &block)
  instance.send(name, *args, &block)
end