hashr 0.0.4 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hashr (0.0.3)
+    hashr (0.0.4)
 
 GEM
   remote: http://rubygems.org/

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+MIT LICENSE
+
+Copyright (c) 2011 Sven Fuchs <svenfuchs@artweb-design.de>
+
+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.md

@@ -0,0 +1,100 @@
+# Hashr
+
+Hashr is a very simple and tiny class derived from Ruby's core Hash class which makes using nested hashes for configuration (and other purposes) easier and less repetive and error prone.
+
+It supports the following features:
+
+* method read and write access
+* automatic predicate (boolean, i.e. ?) methods
+* easy defaults
+* easy inclusion of modules into nested hashes
+* automatic symbolized keys
+
+## Usage
+
+Directly use Hashr instances like this:
+
+    config = Hashr.new('foo' => { 'bar' => 'bar' })
+
+    config.foo?     # => true
+    config.foo      # => { :bar => 'bar' }
+
+    config.foo.bar? # => true
+    config.foo.bar  # => 'bar'
+
+    config.foo.bar = 'BAR'
+    config.foo.bar # => 'BAR'
+
+    config.foo.baz = 'baz'
+    config.foo.baz # => 'baz'
+
+Be aware that by default missing keys won't raise a method missing error but instead behave like Hash access:
+
+    config = Hashr.new
+    config.foo? # => false
+    config.foo  # => nil
+
+You can make Hashr to raise an IndexError though like this:
+
+    Hashr.raise_missing_keys = true
+    config = Hashr.new
+    config.foo? # => false
+    config.foo  # => raises an IndexError "Key :foo is not defined."
+
+Derive a custom class to define defaults like this:
+
+    class Config < Hashr
+      define :foo => { :bar => 'bar' }
+    end
+
+    config = Config.new
+    config.foo.bar # => 'bar'
+
+Include modules to nested hashes like this:
+
+    class Config < Hashr
+      module Boxes
+        def count
+          self['count'] # overwrites a Hash method to return the Hash's content here
+        end
+
+        def names
+          @names ||= (1..count).map { |num| "box-#{num}" }
+        end
+      end
+
+      define :boxes => { :count => 3, :_include => Boxes }
+    end
+
+    config = Config.new
+    config.boxes       # => { :count => 3 }
+    config.boxes.count # => 3
+    config.boxes.names # => ["box-1", "box-2", "box-3"]
+
+## Environment defaults
+
+Hashr includes a simple module that makes it easy to overwrite configuration defaults from environment variables:
+
+    class Config < Hashr
+      extend Hashr::EnvDefaults
+
+      self.env_namespace = 'foo'
+
+      define :boxes => { :memory => '1024' }
+    end
+
+Now when an environment variable is defined then it will overwrite the default:
+
+    ENV['FOO_BOXES_MEMORY'] = '2048'
+    config = Config.new
+    config.boxes.memory # => '2048'
+
+## Running the tests
+
+You can run the tests as follows:
+
+    # going through bundler
+    bundle exec rake
+
+    # using just ruby
+    ruby -rubygems -Ilib:test test/hashr_test.rb

data/lib/hashr.rb

@@ -4,6 +4,8 @@ class Hashr < Hash
   TEMPLATE = new
 
   class << self
+    attr_accessor :raise_missing_keys
+
     def define(definition)
       @definition = definition
     end
@@ -33,12 +35,17 @@ class Hashr < Hash
     when '='
       self[name.to_s[0..-2].to_sym] = args.first
     else
-      self[name]
+      read(name)
     end
   end
 
   protected
 
+    def read(key)
+      raise(IndexError.new("Key #{key.inspect} is not defined.")) if !key?(key) && self.class.raise_missing_keys
+      self[key]
+    end
+
     def include_modules(modules)
       Array(modules).each { |mod| meta_class.send(:include, mod) } if modules
     end

data/lib/hashr/version.rb

@@ -1,3 +1,3 @@
 class Hashr < Hash
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/hashr_test.rb

@@ -2,25 +2,37 @@ require 'test_helper'
 
 class HashrTest < Test::Unit::TestCase
   def teardown
-    ENV.keys.select { |key| key =~ /^WORKER_/ }.each { |key| ENV.delete(key) }
+    Hashr.raise_missing_keys = false
   end
 
   test 'method access on an existing key returns the value' do
     assert_equal 'foo', Hashr.new({ :foo => 'foo' }).foo
   end
 
-  test 'method access on a non-existing key returns nil' do
+  test 'method access on a non-existing key returns nil when raise_missing_keys is false' do
+    Hashr.raise_missing_keys = false
     assert_nil Hashr.new({ :foo => 'foo' }).bar
   end
 
+  test 'method access on a non-existing key raises an IndexError when raise_missing_keys is true' do
+    Hashr.raise_missing_keys = true
+    assert_raises(IndexError) { Hashr.new({ :foo => 'foo' }).bar }
+  end
+
   test 'method access on an existing nested key returns the value' do
     assert_equal 'bar', Hashr.new({ :foo => { :bar => 'bar' } }).foo.bar
   end
 
-  test 'method access on a non-existing nested key returns nil' do
+  test 'method access on a non-existing nested key returns nil when raise_missing_keys is false' do
+    Hashr.raise_missing_keys = false
     assert_nil Hashr.new({ :foo => { :bar => 'bar' } }).foo.baz
   end
 
+  test 'method access on a non-existing nested key raises an IndexError when raise_missing_keys is true' do
+    Hashr.raise_missing_keys = true
+    assert_raises(IndexError) { Hashr.new({ :foo => { :bar => 'bar' } }).foo.baz }
+  end
+
   test 'method access with a question mark returns true if the key has a value' do
     assert_equal true, Hashr.new({ :foo => { :bar => 'bar' } }).foo.bar?
   end
@@ -62,15 +74,23 @@ class HashrTest < Test::Unit::TestCase
   test 'defaults to env vars' do
     klass = Class.new(Hashr) do
       extend Hashr::EnvDefaults
-      self.env_namespace = 'worker'
+      self.env_namespace = 'hashr'
       define :foo => 'foo', :bar => { :baz => 'baz' }
     end
 
-    ENV['WORKER_FOO'] = 'env foo'
-    ENV['WORKER_BAR_BAZ'] = 'env bar baz'
+    ENV['HASHR_FOO'] = 'env foo'
+    ENV['HASHR_BAR_BAZ'] = 'env bar baz'
+
+    hashr = klass.new
+    assert_equal 'env foo', hashr.foo
+    assert_equal 'env bar baz', hashr.bar.baz
+
+    # ENV.delete('HASHR_FOO')
+    # ENV.delete('HASHR_BAR_BAZ')
 
-    assert_equal 'env foo', klass.new.foo
-    assert_equal 'env bar baz', klass.new.bar.baz
+    # hashr = klass.new
+    # assert_equal 'foo', hashr.foo
+    # assert_equal 'bar baz', hashr.bar.baz
   end
 
   test 'a key :_include includes the given modules' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hashr
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Sven Fuchs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-23 00:00:00 +02:00
+date: 2011-07-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,8 +64,9 @@ files:
 - test/test_helper.rb
 - Gemfile
 - Gemfile.lock
+- MIT-LICENSE
 - Rakefile
-- README
+- README.md
 has_rdoc: true
 homepage: http://github.com/svenfuchs/hashr
 licenses: []