settings 0.0.3

data/LICENSE

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,83 @@
+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

@@ -0,0 +1,35 @@
+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.rb

@@ -0,0 +1,9 @@
+# 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)

data/lib/settings_hash.rb

@@ -0,0 +1,60 @@
+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

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

data/test/fixtures/no_namespace.yml

@@ -0,0 +1 @@
+baz: bang

data/test/fixtures/settings.yml

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

data/test/settings_test.rb

@@ -0,0 +1,80 @@
+require 'test/unit'
+require 'rubygems'
+require 'contest'
+require File.dirname(__FILE__) + "/../lib/settings_hash"
+
+def fixture_path
+  File.join(File.dirname(__FILE__), 'fixtures')
+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
+    end
+  end
+  
+  context "settings file doesnt exist" do
+    should "raise" do
+      assert_raise RuntimeError do
+        SettingsHash.new(File.join(fixture_path, 'missing.yml'))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: settings
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/settings.rb
+- lib/settings_hash.rb
+- README.markdown
+- LICENSE
+- Rakefile
+- rails/init.rb
+- test/fixtures/empty.yml
+- test/fixtures/no_namespace.yml
+- test/fixtures/settings.yml
+- test/settings_test.rb
+has_rdoc: true
+homepage: http://labs.citrusbyte.com/projects/settings
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+requirements: []
+
+rubyforge_project: settings
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: A special hash for application-wide settings
+test_files: []
+