siliconsalad-settingslogic 2.0.9

data/CHANGELOG.rdoc

@@ -0,0 +1,27 @@
+== 2.0.2 released 2009-08-22
+
+* Define methods during method_missing instead of during initialization. Allows for modification on the fly.
+
+== 2.0.0 released 2009-08-22
+
+* Less magic, instead of automatically defining a Settings constant, you should define your own constant. See the readme for an example.
+
+== 1.0.3 released 2009-04-23
+
+* Fix Settings initialized with a Hash to work with both symbol and string hash keys.
+
+== 1.0.2 released 2009-04-09
+
+* Call key? off of the self in the class level name method.
+
+== 1.0.1 released 2009-04-02
+
+* Inherit from hash.
+
+== 1.0.0 released 2008-12-05
+
+* Only define methods if we have settings.
+
+== 0.9.0 released 2008-10-30
+
+* Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'rake'
+  gem 'jeweler'
+  gem 'rspec', :require => 'spec'
+  gem 'rcov'
+  if RUBY_VERSION < "1.9"
+    gem 'ruby-debug'
+  else
+    gem 'ruby-debug19'
+  end
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.6)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rake
+  rcov
+  rspec
+  ruby-debug19

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ben Johnson of Binary Logic (binarylogic.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,196 @@
+= Settingslogic
+
+Settingslogic is a simple configuration / settings solution that uses an ERB enabled YAML file. It has been great for
+our apps, maybe you will enjoy it too.  Settingslogic works with Rails, Sinatra, or any Ruby project.
+
+So here is my question to you.....is Settingslogic a great settings solution or the greatest?
+
+== Helpful links
+
+*	<b>Documentation:</b> http://rdoc.info/projects/binarylogic/settingslogic
+*	<b>Repository:</b> http://github.com/binarylogic/settingslogic/tree/master
+* <b>Issues:</b> http://github.com/binarylogic/settingslogic/issues
+
+== Installation
+
+Install from rubyforge/gemcutter:
+
+  sudo gem install siliconsalad-settingslogic
+
+Or as a Rails plugin:
+
+  script/plugin install git://github.com/binarylogic/settingslogic.git
+
+Settingslogic does not have any dependencies on Rails.  Installing as a gem is recommended.
+
+== Usage
+
+=== 1. Define your class
+
+Instead of defining a Settings constant for you, that task is left to you. Simply create a class in your application
+that looks like:
+
+  class Settings < Settingslogic
+    source "#{Rails.root}/config/application.yml"
+    namespace Rails.env
+  end
+
+Name it Settings, name it Config, name it whatever you want. Add as many or as few as you like. A good place to put
+this file in a rails app is app/models/settings.rb
+
+I felt adding a settings file in your app was more straightforward, less tricky, and more flexible.
+
+If multiple files are passed on the source line, comma-separated, they will be loaded in order, with settings in later files overriding any existing keys.  This allows you to, for instance, maintain a global settings file in source control, while allowing each developer to override individual settings as needed.  Files that are specified but which do not exist will simply be ignored.  Thus you can safely do the following without requiring the presence of application_local.yml:
+
+  class Settings < Settingslogic
+    source "#{Rails.root}/config/application.yml", "#{Rails.root}/config/application_local.yml"
+    namespace Rails.env
+  end
+
+=== 2. Create your settings
+
+Notice above we specified an absolute path to our settings file called "application.yml". This is just a typical YAML file.
+Also notice above that we specified a namespace for our environment.  A namespace is just an optional string that corresponds
+to a key in the YAML file.
+
+Using a namespace allows us to change our configuration depending on our environment:
+
+  # config/application.yml
+  defaults: &defaults
+    cool:
+      saweet: nested settings
+    neat_setting: 24
+    awesome_setting: <%= "Did you know 5 + 5 = #{5 + 5}?" %>
+
+  development:
+    <<: *defaults
+    neat_setting: 800
+
+  test:
+    <<: *defaults
+
+  production:
+    <<: *defaults
+
+_Note_: Certain Ruby/Bundler versions include a version of the Psych YAML parser which incorrectly handles merges (the `<<` in the example above.)
+If your default settings seem to be overwriting your environment-specific settings, including the following lines in your config/boot.rb file may solve the problem:
+
+  require 'yaml'
+  YAML::ENGINE.yamler= 'syck'
+
+=== 3. Access your settings
+
+  >> Rails.env
+  => "development"
+
+  >> Settings.cool
+  => "#<Settingslogic::Settings ... >"
+
+  >> Settings.cool.saweet
+  => "nested settings"
+
+  >> Settings.neat_setting
+  => 800
+
+  >> Settings.awesome_setting
+  => "Did you know 5 + 5 = 10?"
+
+You can use these settings anywhere, for example in a model:
+
+  class Post < ActiveRecord::Base
+    self.per_page = Settings.pagination.posts_per_page
+  end
+
+=== 4. Optional / dynamic settings
+
+Often, you will want to handle defaults in your application logic itself, to reduce the number of settings
+you need to put in your YAML file.  You can access an optional setting by using Hash notation:
+
+  >> Settings.messaging.queue_name
+  => Exception: Missing setting 'queue_name' in 'message' section in 'application.yml'
+
+  >> Settings.messaging['queue_name']
+  => nil
+
+  >> Settings.messaging['queue_name'] ||= 'user_mail'
+  => "user_mail"
+
+  >> Settings.messaging.queue_name
+  => "user_mail"
+
+Modifying our model example:
+
+  class Post < ActiveRecord::Base
+    self.per_page = Settings.posts['per_page'] || Settings.pagination.per_page
+  end
+
+This would allow you to specify a custom value for per_page just for posts, or
+to fall back to your default value if not specified.
+
+=== 5. Suppressing Exceptions Conditionally
+
+Raising exceptions for missing settings helps highlight configuration problems.  However, in a
+Rails app it may make sense to suppress this in production and return nil for missing settings.
+While it's useful to stop and highlight an error in development or test environments, this is
+often not the right answer for production.
+
+  class Settings < Settingslogic
+    source "#{Rails.root}/config/application.yml"
+    namespace Rails.env
+    suppress_errors Rails.env.production?
+  end
+
+  >> Settings.non_existent_key
+  => nil
+
+== Note on Sinatra / Capistrano / Vlad
+
+Each of these frameworks uses a +set+ convention for settings, which actually defines methods
+in the global Object namespace:
+
+  set :application, "myapp"  # does "def application" globally
+
+This can cause collisions with Settingslogic, since those methods are global. Luckily, the
+solution is to just add a call to load! in your class:
+
+  class Settings < Settingslogic
+    source "#{Rails.root}/config/application.yml"
+    namespace Rails.env
+    load!
+  end
+
+It's probably always safest to add load! to your class, since this guarantees settings will be
+loaded at that time, rather than lazily later via method_missing.
+
+Finally, you can reload all your settings later as well:
+
+  Settings.reload!
+
+This is useful if you want to support changing your settings YAML without restarting your app.
+
+== [new] Array of source files
+
+This change allows you to set multiple source files. The main purpose behind adding it was to avoid the huge size of
+application.yml. Now you can simply have 'defaults.yml', 'production.yml', 'development.yml' and so on. In your class
+you can have something like:
+
+  class Settings < Settingslogic
+    source ["#{Rails.root}/config/settings/defaults.yml", "#{Rails.root}/config/settings/#{Rails.env}.yml"]
+  end
+
+Sources are merged in the same order as they are positioned in the array; later settings overwrite earlier ones.
+Deep merge is used, so settings will be merged on all levels.
+
+== [new] Adding settings in the runtime
+
+It is possible to add additional settings (hash, path_to_file or array_of_paths) by using Settings.load_source(hash_or_file_or_array, section, options).
+This can be useful for example in case of a lib that needs settings. Lib can be loaded with its own settings which
+can be later extended by part of application ones. It is possible to pass additional options:
+- {:replace => true} to replace existing settings with the new ones
+- {:deep_delete_nil => true} to deeply delete nil settings, ex. {:a=>{:b=>nil}}.deep_delete_nil => {}
+
+
+== Author
+
+Copyright (c) 2008-2010 {Ben Johnson}[http://github.com/binarylogic] of {Binary Logic}[http://www.binarylogic.com],
+released under the MIT license.  Support for optional settings and reloading by {Nate Wiger}[http://nate.wiger.org].

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "siliconsalad-settingslogic"
+    gem.summary = "A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern."
+    gem.email = "bjohnson@binarylogic.com"
+    gem.homepage = "http://github.com/siliconsalad/settingslogic"
+    gem.authors = ["Ben Johnson of Binary Logic"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:major: 2
+:minor: 0
+:patch: 9
+:build:

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/settingslogic.rb

@@ -0,0 +1,225 @@
+require "yaml"
+require "erb"
+require 'open-uri'
+
+class Hash
+  def deep_merge!(other_hash)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge!(v) : v
+    end
+    self
+  end
+
+  def deep_delete_nil
+    delete_if{|k, v| v.nil? or v.instance_of?(Hash) && v.deep_delete_nil.empty?}
+  end
+end
+
+# A simple settings solution using a YAML file. See README for more information.
+class Settingslogic < Hash
+  class MissingSetting < StandardError; end
+  class InvalidSettingsFile < StandardError; end
+
+  class << self
+    def name # :nodoc:
+      self.superclass != Hash && instance.key?("name") ? instance.name : super
+    end
+
+    # Enables Settings.get('nested.key.name') for dynamic access
+    def get(key)
+      parts = key.split('.')
+      curs = self
+      while p = parts.shift
+        curs = curs.send(p)
+      end
+      curs
+    end
+
+    def source(value = nil)
+      #puts "source! #{value.inspect}"
+      if value.nil? || value.empty?
+        @source
+      else
+        @source = value
+      end
+    end
+
+    def namespace(value = nil)
+      if value.nil?
+        @namespace
+      else
+        @namespace = value
+      end
+    end
+
+    def suppress_errors(value = nil)
+      if value.nil?
+        @suppress_errors
+      else
+        @suppress_errors = value
+      end
+    end
+
+    def [](key)
+      instance.fetch(key.to_s, nil)
+    end
+
+    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
+
+    def load!
+      instance
+      true
+    end
+
+    def reload!
+      @instance = nil
+      load!
+    end
+
+    private
+      def instance
+        return @instance if @instance
+        @instance = new
+        create_accessors!
+        @instance
+      end
+
+      def method_missing(name, *args, &block)
+        instance.send(name, *args, &block)
+      end
+
+      # 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
+      def create_accessors!
+        instance.each do |key,val|
+          create_accessor_for(key)
+        end
+      end
+
+      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
+
+  end
+
+  # 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)
+  #   Settings.new(["defaults.yml", "test.yml"]) # will look for defaults.yml and test.yml and merge them
+  #
+  # 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.
+  # If you pass an array, it should have strings that are absolute paths to your settings files.
+  # Then you can pass a hash, and it just allows you to access the hash via methods.
+  #
+  # Options
+  # - deep_delete_nil: remove nil values from hash ex. {:a=>{:b=>nil}}.deep_delete_nil => {}
+  # - replace: if true, replace existing value, by new one, otherwise merge
+  def initialize(hash_or_file_or_array = self.class.source, section = nil, options={})
+    load_source(hash_or_file_or_array, section, {:replace => true}.merge(options))
+  end
+
+  def load_source(hash_or_file_or_array, section = nil, options={})
+    hash = case hash_or_file_or_array
+    when nil
+      raise Errno::ENOENT, "No file specified as Settingslogic source"
+    when Hash
+      hash_or_file_or_array
+    when Array
+      merge_settings_from_files(hash_or_file_or_array, options)
+    else
+      merge_settings_from_files([hash_or_file_or_array], options)
+    end
+    hash.deep_delete_nil if options[:deep_delete_nil]
+    options[:replace] ? self.replace(hash) : self.deep_merge!(hash)
+    @section = section || self.class.source  # so end of error says "in application.yml"
+    create_accessors!
+  end
+
+  # For each array element - if file exists, parse it to hash
+  # if namespace is present take only specified part
+  def merge_settings_from_files(array, options={})
+    hash = array.inject({}) do |sum, file|
+      if File.exists?(file)
+        begin
+          tmp_hash = YAML.load(ERB.new(open(file).read).result).to_hash
+          if self.class.namespace
+            tmp_hash = tmp_hash[self.class.namespace] || {}
+          end
+        rescue
+          tmp_hash = {}
+        # https://github.com/tenderlove/psych/issues/23 (Psych::SyntaxError doesn't inherit from StandardError)
+        rescue Psych::SyntaxError
+          tmp_hash = {}
+        end
+        sum.deep_merge!(tmp_hash)
+      end
+      sum
+    end
+    raise InvalidSettingsFile, "No correct settings in any of files #{array.inspect}" if hash.empty?
+    hash
+  end
+
+  # Called for dynamically-defined keys, and also the first key deferenced at the top-level, if load! is not used.
+  # Otherwise, create_accessors! (called by new) will have created actual methods for each key.
+  def method_missing(name, *args, &block)
+    key = name.to_s
+    return missing_key("Missing setting '#{key}' in #{@section}") unless has_key? key
+    value = fetch(key)
+    create_accessor_for(key)
+    value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in #{@section}") : value
+  end
+
+  def [](key)
+    fetch(key.to_s, nil)
+  end
+
+  def []=(key,val)
+    # Setting[:key][:key2] = 'value' for dynamic settings
+    val = self.class.new(val, @section) if val.is_a? Hash
+    store(key.to_s, val)
+    create_accessor_for(key, val)
+  end
+
+  # This handles naming collisions with Sinatra/Vlad/Capistrano. Since these use a set()
+  # helper that defines methods in Object, ANY method_missing ANYWHERE picks up the Vlad/Sinatra
+  # settings!  So settings.deploy_to title actually calls Object.deploy_to (from set :deploy_to, "host"),
+  # rather than the app_yml['deploy_to'] hash.  Jeezus.
+  def create_accessors!
+    self.each do |key,val|
+      create_accessor_for(key)
+    end
+  end
+
+  # Use instance_eval/class_eval because they're actually more efficient than define_method{}
+  # http://stackoverflow.com/questions/185947/ruby-definemethod-vs-def
+  # http://bmorearty.wordpress.com/2009/01/09/fun-with-rubys-instance_eval-and-class_eval/
+  def create_accessor_for(key, val=nil)
+    return unless key.to_s =~ /^\w+$/  # could have "some-setting:" which blows up eval
+    instance_variable_set("@#{key}", val) if val
+    self.class.class_eval <<-EndEval
+      def #{key}
+        return @#{key} if @#{key}
+        return missing_key("Missing setting '#{key}' in " + @section.to_s) unless has_key? '#{key}'
+        value = fetch('#{key}')
+        @#{key} = value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in "+ @section.to_s) : value
+      end
+    EndEval
+  end
+
+  def missing_key(msg)
+    return nil if self.class.suppress_errors
+
+    raise MissingSetting, msg
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "settingslogic"

data/settingslogic.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "settingslogic"
+  s.version = "2.0.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Johnson of Binary Logic"]
+  s.date = "2012-02-27"
+  s.email = "bjohnson@binarylogic.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG.rdoc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "init.rb",
+    "lib/settingslogic.rb",
+    "rails/init.rb",
+    "settingslogic.gemspec",
+    "spec/settings.rb",
+    "spec/settings.yml",
+    "spec/settings2.yml",
+    "spec/settings3.yml",
+    "spec/settings_invalid.yml",
+    "spec/settingslogic_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/siliconsalad/settingslogic"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+  end
+end
+

data/siliconsalad-settingslogic.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "siliconsalad-settingslogic"
+  s.version = "2.0.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Johnson of Binary Logic"]
+  s.date = "2012-02-27"
+  s.email = "bjohnson@binarylogic.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG.rdoc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "init.rb",
+    "lib/settingslogic.rb",
+    "rails/init.rb",
+    "settingslogic.gemspec",
+    "siliconsalad-settingslogic.gemspec",
+    "spec/settings.rb",
+    "spec/settings.yml",
+    "spec/settings2.yml",
+    "spec/settings3.yml",
+    "spec/settings_invalid.yml",
+    "spec/settingslogic_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/siliconsalad/settingslogic"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+  end
+end
+

data/spec/settings.rb

@@ -0,0 +1,36 @@
+class SettingsInst < Settingslogic
+end
+
+class Settings < Settingslogic
+  source "#{File.dirname(__FILE__)}/settings.yml"
+end
+
+class Settings2 < Settingslogic
+  source "#{File.dirname(__FILE__)}/settings.yml"
+  namespace "setting1"
+end
+
+class Settings3 < Settingslogic
+  source "#{File.dirname(__FILE__)}/settings.yml"
+  load!  # test of load
+end
+
+# settings.yml, settings2.yml and settings3.yml should be merged
+class Settings4 < Settingslogic
+  source ["#{File.dirname(__FILE__)}/settings.yml", "#{File.dirname(__FILE__)}/settings2.yml", "#{File.dirname(__FILE__)}/settings3.yml"]
+end
+
+# settings should be taken only from settings.yml
+class Settings5 < Settingslogic
+  source ["#{File.dirname(__FILE__)}/settings_invalid.yml", "#{File.dirname(__FILE__)}/settings.yml", "#{File.dirname(__FILE__)}/non_exisiting.yml"]
+end
+
+# should raise an error - no valid settings file
+class Settings6 < Settingslogic
+  source ["#{File.dirname(__FILE__)}/settings_invalid.yml", "#{File.dirname(__FILE__)}/non_exisiting.yml"]
+end
+
+class Settings7 < Settingslogic
+  source "#{File.dirname(__FILE__)}/settings.yml"
+  suppress_errors true
+end

data/spec/settings.yml

@@ -0,0 +1,27 @@
+setting1:
+  setting1_child: saweet
+  deep:
+    another: my value
+    child:
+      value: 2
+
+setting2: 5
+
+setting3: <%= 5 * 5 %>
+name: test
+
+level0:
+  level1:
+    is: from_settings
+
+language:
+  haskell:
+    paradigm: functional
+  smalltalk:
+    paradigm: object oriented
+
+collides:
+  does: not
+nested:
+  collides:
+    does: not either

data/spec/settings2.yml

@@ -0,0 +1,5 @@
+setting2: overwritten!
+setting4: from settings2.yml
+level0:
+  level1:
+    is: from_settings2

data/spec/settings3.yml

@@ -0,0 +1 @@
+another_setting: from settings3.yml

data/spec/settings_invalid.yml

@@ -0,0 +1,2 @@
+setting1: invalid_value
+  when: nesting

data/spec/settingslogic_spec.rb

@@ -0,0 +1,208 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe "Settingslogic" do
+  it "should access settings" do
+    Settings.setting2.should == 5
+  end
+
+  it "should access nested settings" do
+    Settings.setting1.setting1_child.should == "saweet"
+  end
+
+  it "should access deep nested settings" do
+    Settings.setting1.deep.another.should == "my value"
+  end
+
+  it "should access extra deep nested settings" do
+    Settings.setting1.deep.child.value.should == 2
+  end
+
+  it "should enable erb" do
+    Settings.setting3.should == 25
+  end
+
+  it "should namespace settings" do
+    Settings2.setting1_child.should == "saweet"
+    Settings2.deep.another.should == "my value"
+  end
+
+  it "should return the namespace" do
+    Settings.namespace.should be_nil
+    Settings2.namespace.should == 'setting1'
+  end
+
+  it "should distinguish nested keys" do
+    Settings.language.haskell.paradigm.should == 'functional'
+    Settings.language.smalltalk.paradigm.should == 'object oriented'
+  end
+
+  it "should not collide with global methods" do
+    Settings3.nested.collides.does.should == 'not either'
+    Settings3[:nested] = 'fooey'
+    Settings3[:nested].should == 'fooey'
+    Settings3.nested.should == 'fooey'
+    Settings3.collides.does.should == 'not'
+  end
+
+# multiple settings sources
+  it "should override previous settings with next in array" do
+    Settings4.setting2.should == "overwritten!"
+  end
+
+  it "should override previous settings with next in array (deep)" do
+    Settings4.level0.level1.is.should == "from_settings2"
+  end
+
+  it "should not raise error when at least one file is present and valid" do
+    Settings5.name.should == "test"
+  end
+
+  it "should raise an error when none of the files is present and valid" do
+    begin
+      Settings6.name
+    rescue => e
+      e.should be_kind_of Settingslogic::InvalidSettingsFile
+    end
+  end
+
+  it "should accept an array of file names as a source argument and load all of them" do
+    Settings4.setting1.setting1_child.should == "saweet"
+    Settings4.setting4.should == "from settings2.yml"
+    Settings4.another_setting.should == "from settings3.yml"
+  end
+
+# loading additional settings in the runtime
+  it "should merge hash into existing settings" do
+    Settings.load_source({"level0" => {"level1" => {"added" => 'this'}}})
+    Settings.level0.level1.is.should == 'from_settings'
+    Settings.level0.level1.added.should == 'this'
+  end
+
+  it "should merge file into existing settings" do
+    Settings.load_source("#{File.dirname(__FILE__)}/settings2.yml")
+    Settings.setting1.setting1_child.should == "saweet"
+    Settings.setting4.should == "from settings2.yml"
+  end
+
+  it "should merge array of files into existing settings" do
+    Settings.load_source(["#{File.dirname(__FILE__)}/settings2.yml", "#{File.dirname(__FILE__)}/settings3.yml"])
+    Settings.setting1.setting1_child.should == "saweet"
+    Settings.another_setting.should == "from settings3.yml"
+  end
+
+  it "should raise a helpful error message" do
+    e = nil
+    begin
+      Settings.missing
+    rescue => e
+      e.should be_kind_of Settingslogic::MissingSetting
+    end
+    e.should_not be_nil
+    e.message.should =~ /Missing setting 'missing' in/
+
+    e = nil
+    begin
+      Settings.language.missing
+    rescue => e
+      e.should be_kind_of Settingslogic::MissingSetting
+    end
+    e.should_not be_nil
+    e.message.should =~ /Missing setting 'missing' in 'language' section/
+  end
+
+  it "should handle optional / dynamic settings" do
+    e = nil
+    begin
+      Settings.language.erlang
+    rescue => e
+      e.should be_kind_of Settingslogic::MissingSetting
+    end
+    e.should_not be_nil
+    e.message.should =~ /Missing setting 'erlang' in 'language' section/
+
+    Settings.language['erlang'].should be_nil
+    Settings.language['erlang'] = 5
+    Settings.language['erlang'].should == 5
+
+    Settings.language['erlang'] = {'paradigm' => 'functional'}
+    Settings.language.erlang.paradigm.should == 'functional'
+    Settings.respond_to?('erlang').should be_false
+
+    Settings.reload!
+    Settings.language['erlang'].should be_nil
+
+    Settings.language[:erlang] ||= 5
+    Settings.language[:erlang].should == 5
+
+    Settings.language[:erlang] = {}
+    Settings.language[:erlang][:paradigm] = 'functional'
+    Settings.language.erlang.paradigm.should == 'functional'
+
+    Settings[:toplevel] = '42'
+    Settings.toplevel.should == '42'
+  end
+
+  it "should raise an error on a nil source argument" do
+    class NoSource < Settingslogic; end
+    e = nil
+    begin
+      NoSource.foo.bar
+    rescue => e
+      e.should be_kind_of Errno::ENOENT
+    end
+    e.should_not be_nil
+  end
+
+  it "should allow suppressing errors" do
+    Settings7.non_existent_key.should be_nil
+  end
+
+  # This one edge case currently does not pass, because it requires very
+  # esoteric code in order to make it pass.  It was judged not worth fixing,
+  # as it introduces significant complexity for minor gain.
+  # it "should handle reloading top-level settings"
+  #   Settings[:inspect] = 'yeah baby'
+  #   Settings.inspect.should == 'yeah baby'
+  #   Settings.reload!
+  #   Settings.inspect.should == 'Settings'
+  # end
+
+  it "should handle oddly-named settings" do
+    Settings.language['some-dash-setting#'] = 'dashtastic'
+    Settings.language['some-dash-setting#'].should == 'dashtastic'
+  end
+
+  it "should support instance usage as well" do
+    settings = SettingsInst.new(Settings.source)
+    settings.setting1.setting1_child.should == "saweet"
+  end
+
+  it "should be able to get() a key with dot.notation" do
+    Settings.get('setting1.setting1_child').should == "saweet"
+    Settings.get('setting1.deep.another').should == "my value"
+    Settings.get('setting1.deep.child.value').should == 2
+  end
+
+  # If .name is not a property, delegate to superclass
+  it "should respond with Module.name" do
+    Settings2.name.should == "Settings2"
+  end
+
+  # If .name is called on Settingslogic itself, handle appropriately
+  # by delegating to Hash
+  it "should have the parent class always respond with Module.name" do
+    Settingslogic.name.should == 'Settingslogic'
+  end
+
+  # If .name is a property, respond with that instead of delegating to superclass
+  it "should allow a name setting to be overriden" do
+    Settings.name.should == 'test'
+  end
+
+  # Put this test last or else call to .instance will load @instance,
+  # masking bugs.
+  it "should be a hash" do
+    Settings.send(:instance).should be_is_a(Hash)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
+require 'settingslogic'
+require 'settings'
+
+# Needed to test Settings3
+Object.send :define_method, 'collides' do
+  'collision'
+end
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: siliconsalad-settingslogic
+version: !ruby/object:Gem::Version
+  version: 2.0.9
+  prerelease: 
+platform: ruby
+authors:
+- Ben Johnson of Binary Logic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70122421875020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70122421875020
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70122422223700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70122422223700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70122422219820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70122422219820
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70122422218780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70122422218780
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70122422217280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70122422217280
+description: 
+email: bjohnson@binarylogic.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- init.rb
+- lib/settingslogic.rb
+- rails/init.rb
+- settingslogic.gemspec
+- siliconsalad-settingslogic.gemspec
+- spec/settings.rb
+- spec/settings.yml
+- spec/settings2.yml
+- spec/settings3.yml
+- spec/settings_invalid.yml
+- spec/settingslogic_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/siliconsalad/settingslogic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A simple and straightforward settings solution that uses an ERB enabled YAML
+  file and a singleton design pattern.
+test_files: []