citrusbyte-settings 0.0.2 → 0.0.3

data/lib/{rails.rb → settings.rb}

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

@@ -1,9 +1,44 @@
-require 'readonly_hash'
 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)
@@ -16,19 +51,10 @@ class SettingsHash < ReadonlyHash
     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
-
-class Hash
-  # from ActiveSupport
-  # lib/active_support/core_ext/hash/keys.rb line 22-27
-  def symbolize_keys
-    inject({}) do |options, (key, value)|
-      options[(key.to_sym rescue key) || key] = value
-      options
-    end
-  end
-end

data/rails/init.rb

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

data/test/settings_test.rb

@@ -16,21 +16,37 @@ class SettingsTest < Test::Unit::TestCase
             @settings = SettingsHash.new(File.join(fixture_path, 'settings.yml'), 'test')
           end
       
-          test "should return hash of settings" do
-            assert_equal({ :foo => 'bar', :abc => { 'def' => 123 } }, @settings)
+          should "return hash of settings" do
+            assert @settings.is_a?(SettingsHash)
           end
           
-          test "should freeze settings" do
+          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
           
-          test "should return value for key if set" do
+          should "return value for key if set" do
             assert_equal 'bar', @settings[:foo]
           end
       
-          test "should raise if key is not set" do
+          should "raise if key is not set" do
             assert_raise SettingsHash::SettingNotFound do
               @settings[:bar]
             end
@@ -38,16 +54,16 @@ class SettingsTest < Test::Unit::TestCase
         end
         
         context "and namespace doesnt exist" do
-          test "should raise" 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
-        test "should return hash of settings" do
+        should "return hash of settings" do
           assert_equal({ :baz => 'bang' }, SettingsHash.new(File.join(fixture_path, 'no_namespace.yml')))
         end
       end
@@ -55,7 +71,7 @@ class SettingsTest < Test::Unit::TestCase
   end
   
   context "settings file doesnt exist" do
-    test "should raise" do
+    should "raise" do
       assert_raise RuntimeError do
         SettingsHash.new(File.join(fixture_path, 'missing.yml'))
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: citrusbyte-settings
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ben Alavi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-17 00:00:00 -07:00
+date: 2009-04-25 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,19 +22,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- init.rb
+- lib/settings.rb
+- lib/settings_hash.rb
 - README.markdown
 - LICENSE
 - Rakefile
-- lib/rails.rb
-- lib/settings_hash.rb
-- lib/readonly_hash.rb
-- test/settings_test.rb
+- rails/init.rb
 - test/fixtures/empty.yml
 - test/fixtures/no_namespace.yml
 - test/fixtures/settings.yml
+- test/settings_test.rb
 has_rdoc: false
-homepage: http://github.com/citrusbyte/settings
+homepage: http://labs.citrusbyte.com/projects/settings
 post_install_message: 
 rdoc_options: []
 

data/init.rb

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

data/lib/readonly_hash.rb

@@ -1,12 +0,0 @@
-class ReadonlyHash < Hash  
-  class << self
-    def [](*args)
-      new(super(*args))
-    end
-  end
-  
-  def initialize(hash)
-    update hash
-    freeze
-  end
-end