purple_hash 1.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    purple_hash (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  purple_hash!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 James Logsdon
+
+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,50 @@
+Purple Hash is a configuration library for ruby that builds upon Ruby's core
+Hash. At it's core Purple allows you to access keys that do not exist yet by
+defining a default value proc which provides you with a new instance of a
+Purple Hash. Keys are also normalized to symbols, similar to how Rail's
+`HashWithIndifferentAccess` works.
+
+```ruby
+require 'purple_hash'
+
+config = PurpleHash.new
+config[:db]['user'] = 'root'
+config # => {:db => {:user => 'root'}}
+
+config = PurpleHash.new(:db => {'user' => 'root'})
+config # => {:db => {:user => 'root'}}
+```
+
+Because a `PurpleHash` is simply a sub-class of `Hash` you can do anything you
+would normally be able to without any hacks or tricks. Though not provided by
+this library, you could extend `Hash` to provide a `#to_purple_hash` like so:
+
+```ruby
+class Hash
+  def to_purple_hash
+    PurpleHash.new(self)
+  end
+end
+```
+
+**Note:** If you try to change the default value on a `PurpleHash` a `RuntimeError`
+will be raised informing you that this is not allowed.
+
+## API
+
+PurpleHash provides a very basic API on top of what Hash already provides.
+
+### `#configure_from_hash(hash)`
+
+Takes a raw `Hash` and converts itself and any nested hashes to a `PurpleHash`.
+Used internally by `#initialize`
+
+### `#freeze!`
+
+Locks the hash from any futher modifications. A `PurpleHash::HashFrozen` will be
+raised if the hash is frozen and you attempt to modify it. Keys that are not
+already defined will return `nil` instead of a new `PurpleHash`.
+
+### `#frozen?`
+
+Find out if the hash is frozen.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+desc 'Run Gesch unit tests.'
+task default: :spec
+
+desc 'Run Gesch unit tests.'
+RSpec::Core::RakeTask.new

data/lib/purple_hash.rb

@@ -0,0 +1,56 @@
+class PurpleHash < ::Hash
+  class HashFrozen < RuntimeError
+    def initialize
+      super('this PurpleHash is frozen')
+    end
+  end
+
+  def initialize(hash={})
+    configure_from_hash(hash)
+    @__frozen = false
+  end
+
+  def freeze!
+    self.each do |k, h|
+      h.freeze! if h.respond_to?(:freeze!)
+    end
+    @__frozen = true
+  end
+
+  def frozen?
+    @__frozen === true
+  end
+
+  def configure_from_hash(hash)
+    hash.each do |key, value|
+      if value.is_a?(Hash)
+        self[key].configure_from_hash(value)
+      else
+        self[key] = value
+      end
+    end
+  end
+
+  def [](key)
+    super(key.to_sym)
+  end
+
+  def []=(key, value)
+    raise HashFrozen if frozen?
+
+    if value.is_a?(Hash) && !value.is_a?(self.class)
+      self[key].configure_from_hash(value)
+    else
+      super(key.to_sym, value)
+    end
+  end
+
+  def default(key)
+    return nil if frozen?
+    self[key] = PurpleHash.new
+  end
+
+  def default=(*args)
+    raise RuntimeError, "#{self.class} does not allow changing the default hash value"
+  end
+end

data/spec/purple_hash_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe PurpleHash do
+  subject { described_class.new(foo: {bar: :baz}) }
+
+  it { should be_a(Hash) }
+
+  describe '#[]' do
+    it 'creates keys on the fly' do
+      subject[:foo]
+      subject.should have_key(:foo)
+    end
+
+    it 'uses our Configuration class when creating keys' do
+      subject[:foo].should be_a(described_class)
+    end
+
+    it 'normalizes keys to symbols' do
+      subject['foo']
+      subject.should have_key(:foo)
+      subject.should_not have_key('foo')
+    end
+  end
+
+  describe '#[]=' do
+    it 'normalizes keys to symbols' do
+      subject['foo'] = :bar
+      subject.should have_key(:foo)
+      subject.should_not have_key('foo')
+    end
+
+    context 'when a hash is passed as the value' do
+      it 'should be converted to a Configuration hash' do
+        subject[:foo] = {bar: :baz}
+        subject[:foo].should be_a(described_class)
+      end
+    end
+  end
+
+  describe '#default=' do
+    it 'raises an error' do
+      expect { subject.default = proc { } }.to raise_error
+    end
+  end
+
+  describe '#freeze!' do
+    before(:each) do
+      subject.freeze!
+    end
+
+    it 'blocks setting of new values' do
+      expect { subject[:foo] = :bar }.to raise_error
+    end
+
+    it 'does not create keys on the fly' do
+      subject[:bar]
+      subject.should_not have_key(:bar)
+    end
+
+    it 'blocks the setting of new values on nested hashes' do
+      expect { subject[:foo][:bar] = :break }.to raise_error(PurpleHash::HashFrozen)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'purple_hash'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: purple_hash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- James Logsdon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dwarf@girsbrain.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- lib/purple_hash.rb
+- LICENSE
+- Rakefile
+- README.md
+- spec/purple_hash_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jlogsdon/purple_hash
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: A lightweight Configuration gem built with Hashes
+test_files:
+- spec/purple_hash_spec.rb
+- spec/spec_helper.rb
+has_rdoc: