settings 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,133 @@
+Settings
+========
+
+A special hash for application-wide settings.
+
+Description
+-----------
+
+Small and simple specialized Hash which is helpful for storing immutable,
+required key/value pairs to be loaded from a YAML file.
+
+New instances of `Settings::Hash` are readonly -- any attempt to write to the
+Hash after initialization will fail with a `TypeError`. This way you can avoid
+inadvertently altering the expected value of a setting at runtime.
+
+Any attempt to read a key which is not set will raise a 
+`Settings::Hash::SettingNotFound` error. This way expected values will raise when
+expected, making them easier to track down than if they had silently returned
+`nil`.
+
+`Settings::Hash` supports an optional namespace which can be used to define
+multiple groups of settings within a single .yml file. Commonly this can be
+used to define per-environment settings, i.e. "test" and "development".
+
+Finally, there is a small module which you can use in your Rack applications to
+provide some sensible defaults for loading a settings file.
+
+Usage
+-----
+
+`config/settings.yml`
+    
+    test:
+      :foo: 123456
+    development:
+      :foo: "abcdef"
+
+Settings::Hash:
+
+    settings = Settings::Hash.new("config/settings.yml")
+    settings["test"][:foo] #=> 123456
+    settings["development"][:foo] #=> "abcdef"
+    
+    settings = Settings::Hash.new("config/settings.yml", "test")
+    settings[:foo] #=> 123456
+    
+    ENV["RACK_ENV"] = "development"
+    settings = Settings::Hash.new("config/settings.yml", ENV["RACK_ENV"])
+    settings[:foo] #=> "abcdef"
+
+Cuba:
+
+    Cuba.send :extend, Settings
+    
+    Cuba.define do
+      on "/" do
+        res.write Cuba.setting(:foo) #=> "abcdef"
+      end
+    end
+
+Sinatra:
+  
+    class MyApplication < Sinatra::Base
+      extend Settings
+      
+      get "/" do
+        MyApplication.setting(:foo) #=> "abcdef"
+      end
+    end
+
+Rails:
+    
+    gem "settings", "0.0.4" # (in `Gemfile`)
+    
+    Rails.send :extend, Settings # (in `config/initializers/settings.rb`)
+    
+    class WidgetController < ActionController::Base
+      def index
+        Rails.setting("foo") #=> "abcdef"
+      end
+    end
+
+Installation
+------------
+
+    $ sudo gem install settings
+
+Test
+----
+
+    $ rake
+
+Changelog
+---------
+
+### 0.0.4
+
+Settings no longer symbolizes keys. If you want to use symbols for keys, define
+your keys as symbols in your `.yml` file, i.e.:
+
+    :test:
+      :alphabet: "abcdef"
+
+instead of:
+
+    test:
+      alphabet: "abcdef"
+
+Settings no longer explicitly supports Rails -- instead it comes with some
+defaults for Rack applications which could be used with Rails.
+
+License
+-------
+
+Copyright (c) 2009-2011 Ben Alavi for Citrusbyte
+
+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/lib/settings.rb

@@ -1,9 +1,50 @@
-# Rails-specific initialization, only here because if you try to set a global
-# constant in init.rb it gets removed, but if you require a file that sets a
-# global constant it seems to work -- not sure why?
-# 
-# Also, Rails gem-dependencies expect a file with the name of the gem in lib
-# that defines a constant with the same name -- hence we have to file called
-# settings.rb which defines Settings for Rails to be happy =)
-require 'settings_hash'
-Settings = SettingsHash.new(File.join(Rails.root, 'config', 'settings.yml'), Rails.env)
+require "yaml"
+
+module Settings
+  VERSION = "0.0.4"
+  
+  def self.extended(base)
+    base.instance_variable_set "@_settings", Hash.new(File.join(Dir.pwd, "config", "settings.yml"), ENV["RACK_ENV"])
+  end
+  
+  def setting(key)
+    @_settings[key]
+  end
+
+  class Hash < ::Hash
+    # Raised when attempting to access a key which has not been set.
+    class SettingNotFound < StandardError;end;
+
+    # Creates a new Settings::Hash from a YAML file located at the given path.
+    # 
+    # Optionally loads only the settings within the given namespace (if a
+    # namespace is given)
+    # 
+    #     Settings::Hash.new('/path/to/settings.yml')       => { 'foo' => { :bar => 'baz' }, :bam => 'bang' }
+    #     Settings::Hash.new('/path/to/settings.yml, 'foo') => { :bar => 'baz' }
+    # 
+    def initialize(path, namespace=nil)
+      begin
+        settings = YAML.load_file(path)
+      rescue Errno::ENOENT => e
+        e.message << " (attempting to load settings file)"
+        raise e
+      end
+
+      if namespace
+        raise "No settings defined for #{namespace} in settings file: #{path}" unless settings[namespace]
+        settings = settings[namespace]
+      end
+
+      update settings
+      freeze
+    end
+
+    # Access the value at the given key, raises Settings::Hash::SettingNotFound
+    # if the key is not set.
+    def [](key)
+      raise SettingNotFound.new("No setting found for #{key.inspect}") unless has_key?(key)
+      super
+    end
+  end
+end

data/rakefile

@@ -0,0 +1,7 @@
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+task :default => [:test]

data/settings.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path("lib/settings", File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name = "settings"
+  s.version = Settings::VERSION
+  s.summary = "A special hash for application-wide settings"
+  s.description = "Small and simple specialized Hash which is helpful for storing immutable, required key/value pairs to be loaded from a YAML file."
+  s.date = "2011-10-25"
+  s.authors = ["Ben Alavi"]
+  s.email = ["ben.alavi@citrusbyte.com"]
+  s.homepage = "http://github.com/citrusbyte/settings"
+
+  s.files = Dir[
+    "README.md",
+    "rakefile",
+    "settings.gemspec",
+    "lib/**/*.rb",
+    "test/**/*.rb",
+    "test/fixtures/*.yml"
+  ]
+
+  s.add_development_dependency "contest"
+end

data/test/fixtures/no_namespace.yml

@@ -1 +1 @@
-baz: bang
+:foo: "bar"

data/test/fixtures/settings.yml

@@ -1,4 +1,4 @@
 test:
-  foo: bar
+  :foo: bar
   abc:
     def: 123

data/test/settings_test.rb

@@ -1,80 +1,79 @@
-require 'test/unit'
-require 'rubygems'
-require 'contest'
-require File.dirname(__FILE__) + "/../lib/settings_hash"
+$: << File.expand_path("../lib", File.dirname(__FILE__))
+
+require "rubygems"
+require "test/unit"
+require "contest"
+require "settings"
 
 def fixture_path
-  File.join(File.dirname(__FILE__), 'fixtures')
+  File.join(File.dirname(__FILE__), "fixtures")
+end
+
+class Application
+end
+
+class Widget
 end
 
 class SettingsTest < Test::Unit::TestCase
-  context "settings file exists" do
-    context "and has values" do
-      context "in test namespace" do
-        context "and namespace exists" do
-          setup do
-            @settings = SettingsHash.new(File.join(fixture_path, 'settings.yml'), 'test')
-          end
-      
-          should "return hash of settings" do
-            assert @settings.is_a?(SettingsHash)
-          end
-          
-          should "symbolize keys" do
-            assert @settings.has_key?(:foo)
-          end
-          
-          should "symbolize nested keys" do
-            assert @settings[:abc].has_key?(:def)
-          end
-          
-          should "set nested values" do
-            assert_equal 123, @settings[:abc][:def]
-          end
-          
-          should "have bar for :foo" do
-            assert_equal 'bar', @settings[:foo]
-          end
-          
-          should "freeze settings" do
-            assert_raise TypeError do
-              @settings[:foo] = 'baz'
-            end
-          end
-          
-          should "return value for key if set" do
-            assert_equal 'bar', @settings[:foo]
-          end
-      
-          should "raise if key is not set" do
-            assert_raise SettingsHash::SettingNotFound do
-              @settings[:bar]
-            end
-          end
-        end
-        
-        context "and namespace doesnt exist" do
-          should "raise" do
-            assert_raise RuntimeError do
-              SettingsHash.new(File.join(fixture_path, 'settings.yml'), 'foo')
-            end
-          end
-        end
-      end
-      
-      context "outside of test namespace" do
-        should "return hash of settings" do
-          assert_equal({ :baz => 'bang' }, SettingsHash.new(File.join(fixture_path, 'no_namespace.yml')))
-        end
-      end
+  should "return hash of all settings when no namespace is present" do
+    assert_equal({ :foo => "bar" }, Settings::Hash.new(File.join(fixture_path, "no_namespace.yml")))
+  end
+
+  should "load all settings" do
+    settings = Settings::Hash.new File.join(fixture_path, "settings.yml")
+    assert_equal({ "test" => { :foo => "bar", "abc" => { "def" => 123 } } }, settings)
+  end
+
+  should "only load settings in given namespace" do
+    settings = Settings::Hash.new(File.join(fixture_path, "settings.yml"), "test")
+    assert_equal({ :foo => "bar", "abc" => { "def" => 123 } }, settings)
+  end
+  
+  should "raise when attempting to change a setting" do
+    settings = Settings::Hash.new File.join(fixture_path, "settings.yml")
+    assert_raise TypeError do
+      settings[:foo] = "baz"
     end
   end
   
-  context "settings file doesnt exist" do
-    should "raise" do
-      assert_raise RuntimeError do
-        SettingsHash.new(File.join(fixture_path, 'missing.yml'))
-      end
+  should "raise when attempting to add a setting" do
+    settings = Settings::Hash.new File.join(fixture_path, "settings.yml")
+    assert_raise TypeError do
+      settings[:bar] = "bam"
     end
   end
+  
+  should "raise if key is not set" do
+    settings = Settings::Hash.new File.join(fixture_path, "settings.yml")
+    assert_raise Settings::Hash::SettingNotFound do
+      settings[:bar]
+    end
+  end
+
+  should "raise when settings file does not exist" do
+    assert_raise Errno::ENOENT do
+      Settings::Hash.new(File.join(fixture_path, "missing.yml"))
+    end
+  end
+
+  should "raise when namespace doesn't exit" do
+    assert_raise RuntimeError do
+      Settings::Hash.new(File.join(fixture_path, 'settings.yml'), "foo")
+    end
+  end
+  
+  should "load settings from config/settings.yml when extended" do
+    ENV["RACK_ENV"] = "test"
+    
+    FileUtils.rm "config/settings.yml"
+    FileUtils.rmdir "config"
+    FileUtils.mkdir "config"
+    FileUtils.cp "test/fixtures/settings.yml", "config/settings.yml"
+    
+    assert !Application.respond_to?(:setting)
+    
+    Application.send :extend, Settings
+    assert_equal "bar", Application.setting(:foo)
+  end
 end

metadata

@@ -1,64 +1,64 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: settings
-version: !ruby/object:Gem::Version 
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ben Alavi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-04-25 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
-description: Small and simple specialized Hash which is helpful for storing immutable, required key/value pairs to be loaded from a YAML file.
-email: ben.alavi@citrusbyte.com
+date: 2011-10-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contest
+  requirement: &70237296076480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70237296076480
+description: Small and simple specialized Hash which is helpful for storing immutable,
+  required key/value pairs to be loaded from a YAML file.
+email:
+- ben.alavi@citrusbyte.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- README.md
+- rakefile
+- settings.gemspec
 - lib/settings.rb
-- lib/settings_hash.rb
-- README.markdown
-- LICENSE
-- Rakefile
-- rails/init.rb
-- test/fixtures/empty.yml
+- test/settings_test.rb
 - test/fixtures/no_namespace.yml
 - test/fixtures/settings.yml
-- test/settings_test.rb
-has_rdoc: true
-homepage: http://labs.citrusbyte.com/projects/settings
+homepage: http://github.com/citrusbyte/settings
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+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: settings
-rubygems_version: 1.3.4
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A special hash for application-wide settings
 test_files: []
-

data/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2009 Ben Alavi for Citrusbyte
-
-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.markdown

@@ -1,83 +0,0 @@
-Settings
-========
-
-A special hash for application-wide settings.
-
-Description
------------
-
-Small and simple specialized Hash which is helpful for storing immutable,
-required key/value pairs to be loaded from a YAML file.
-
-New instances of `SettingsHash` are readonly -- any attempt to write to the
-Hash after initialization will fail with a `TypeError`.
-
-Any attempt to read a key which is not set will raise a 
-`SettingsHash::SettingNotFound` error.
-
-`SettingsHash` supports an optional namespace which can be used to define
-multiple groups of settings within a single .yml file. For example, "test" and
-"development" might be different namespaces for different running environments.
-
-Usage
------
-
-### General
-
-    settings = SettingsHash.new('path/to/settings.yml')
-    settings = SettingsHash.new('path/to/settings.yml', 'foo') => loads settings under the 'foo' namespace
-    
-### Rails
-
-Put your environment-specific `settings.yml` in `config/settings.yml`. It may
-look something like this:
-
-    development:
-      memcached: true
-    test:
-      memcached: false
-      
-This file will automatically be loaded into a `Settings` global which can be
-accessed like a normal Hash:
-
-    Settings[:memcached] => true (development environment)
-    Settings[:memcached] => false (test environment)
-    
-Installation
-------------
-
-    $ gem sources -a http://gems.github.com (you only have to do this once)
-    $ sudo gem install citrusbyte-settings
-
-Testing
--------
-    
-Tests require Contest gem:
-
-    http://github.com/citrusbyte/contest
-
-License
--------
-
-Copyright (c) 2009 Ben Alavi for Citrusbyte
-
-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/Rakefile

@@ -1,35 +0,0 @@
-require 'rake'
-require 'rake/gempackagetask'
-require 'rake/testtask'
-require 'rake/clean'
-
-gem_spec_file = 'settings.gemspec'
-
-gem_spec = eval(File.read(gem_spec_file)) rescue nil
-
-task :default => :test
-
-Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-Rake::GemPackageTask.new(gem_spec) do |pkg|
-  pkg.need_zip = false
-  pkg.need_tar = false
-  rm_f FileList['pkg/**/*.*']
-end if gem_spec
-
-desc "Generate the gemspec file."
-task :gemspec do
-  require 'erb'
-
-  File.open(gem_spec_file, 'w') do |f|
-    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
-  end
-end
-
-desc "Builds and installs the gem."
-task :install => :repackage do
-  `sudo gem install pkg/#{gem_spec.name}-#{gem_spec.version}.gem`
-end

data/lib/settings_hash.rb

@@ -1,60 +0,0 @@
-require 'yaml'
-
-class Hash
-  # From ActiveSupport lib/active_support/core_ext/hash/keys.rb line 22-27
-  # Altered to recursively symbolize all keys in nested hashes
-  def symbolize_keys
-    inject({}) do |options, (key, value)|
-      options[(key.to_sym rescue key) || key] = (value.is_a?(Hash) ? value.symbolize_keys : value)
-      options
-    end
-  end
-end
-
-# A very simple "readonly" hash implementation. Freezes itselfs on
-# initialization so that any attempts to change will result in a TypeError
-class ReadonlyHash < Hash  
-  class << self
-    def [](*args)
-      new(super(*args))
-    end
-  end
-  
-  def initialize(hash)
-    update hash
-    freeze
-  end
-end
-
-class SettingsHash < ReadonlyHash
-  # Raised when attempting to access a key which has not been set.
-  class SettingNotFound < StandardError;end;
-  
-  # Creates a new SettingsHash from a YAML file located at the given path.
-  # 
-  # Optionally loads only the settings within the given namespace (if a
-  # namespace is given)
-  # 
-  #     SettingsHash.new('/path/to/settings.yml')       => { :foo => { :bar => 'baz' }, :bam => 'bang' }
-  #     SettingsHash.new('/path/to/settings.yml, 'foo') => { :bar => 'baz' }
-  # 
-  # Note that hash keys are symbolized (as seen in example above)
-  def initialize(path, namespace=nil)
-    raise "No settings file found: #{path}" unless File.exists?(path)
-    settings = YAML.load_file(path)
-    
-    if namespace
-      raise "No settings defined for #{namespace} in settings file: #{path}" unless settings[namespace]
-      settings = settings[namespace]
-    end
-    
-    super(settings.symbolize_keys)
-  end
-  
-  # Access the value at the given key, raises SettingsHash::SettingNotFound if
-  # the key is not set.
-  def [](key)
-    raise SettingNotFound.new("No setting found for #{key}") unless has_key?(key)
-    super
-  end
-end

data/rails/init.rb

@@ -1 +0,0 @@
-require 'settings'