hash_with_struct_access 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p0

data/Gemfile

@@ -0,0 +1,3 @@
+source("http://rubygems.org")
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kostiantyn Kahanskyi
+
+MIT License
+
+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,19 @@
+Hash object with struct access.
+Main purpose is to be a configuration object.
+
+*Warning*: It can't be modified after initialization.
+
+```ruby
+# Simple example
+hash = HashWithStructAccess.new(:foo => {:bar => 42})
+hash.foo #=> {:bar => 42}
+hash.foo.bar #=> 42
+
+# More complex example
+hash = HashWithStructAccess.new(:foo => {(o = Object.new) => {"bar" => {1 => :baz}}})
+hash.foo #=> {o => {"bar" => {1 => :baz}}}
+hash.foo[o] #=> {"bar" => {1 => :baz}}
+hash.foo[o].bar #=> {1 => :baz}
+hash.foo[o].bar[1] #=> :baz
+```
+

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/*.rb"]
+  t.verbose = true
+end
+
+task(:default => :test)

data/hash_with_struct_access.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/hash_with_struct_access", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "hash_with_struct_access"
+  gem.version = HashWithStructAccess::VERSION
+  gem.description = %q{Hash object with struct access}
+  gem.summary = %q{Hash object with struct access. Main purpose is to be a configuration object.}
+  gem.homepage = "https://github.com/kostia/hash_with_struct_access"
+  gem.authors = ["Kostiantyn Kahanskyi"]
+  gem.email = %w(kostiantyn.kahanskyi@googlemail.com)
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = %w(lib)
+  gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.add_development_dependency("rake")
+end

data/lib/hash_with_struct_access.rb

@@ -0,0 +1,14 @@
+class HashWithStructAccess < Hash
+  VERSION = "0.0.1"
+
+  def initialize(hash = {})
+    hash.each_pair do |key, value|
+      self[key] = value.kind_of?(Hash) ? self.class.new(value) : value
+    end
+    self.freeze
+  end
+
+  def method_missing(method_name)
+    self[method_name] || self[method_name.to_s] || super
+  end
+end

data/test/fixtures/hash_like.rb

@@ -0,0 +1,5 @@
+class HashLike < Hash
+  def self.call_me_with_options(options)
+    options
+  end
+end

data/test/hash_with_struct_access_test.rb

@@ -0,0 +1,75 @@
+require "./test/test_helper"
+
+
+class HashWithStructAccessTest < Test::Unit::TestCase
+  def test_should_be_kind_of_hash
+    assert(HashWithStructAccess.new(:foo => :bar).kind_of?(Hash))
+  end
+
+  def test_should_be_initializable_by_hash_object
+    hash = HashWithStructAccess.new({:foo => {:bar => :baz}})
+    assert_equal(hash.to_hash, {:foo => {:bar => :baz}})
+  end
+
+  def test_should_be_initializable_by_options
+    hash = HashWithStructAccess.new(:foo => {:bar => :baz})
+    assert_equal(hash.to_hash, {:foo => {:bar => :baz}})
+  end
+
+  def test_should_be_initializable_with_hash_like_objects
+    hash_like = HashLike.new
+    hash_like[:foo] = {:bar => :baz}
+    hash = HashWithStructAccess.new(hash_like)
+    assert_equal(hash.to_hash, {:foo => {:bar => :baz}})
+  end
+
+  def test_should_be_initializable_with_nothing_given
+    hash = HashWithStructAccess.new
+    assert_equal(hash.keys, [])
+    assert_equal(hash.values, [])
+  end
+
+  def test_should_convert_to_hash_properly
+    o = Object.new
+    hash = {:foo => {1 => {o => "bar"}}}
+    assert_equal(HashWithStructAccess.new(hash).to_hash, hash)
+  end
+
+  def test_should_be_able_to_handle_numerical_keys
+    hash = HashWithStructAccess.new(:foo => {1 => {:bar => :baz}})
+    assert_equal(hash.foo[1].bar, :baz)
+  end
+
+  def test_should_be_able_to_hadle_object_keys
+    o1, o2 = Object.new, Object.new
+    hash = HashWithStructAccess.new(o1 => {:foo => {o2 => {:bar => :baz}}})
+    assert_equal(hash[o1].foo[o2].bar, :baz)
+  end
+
+  def test_should_behave_like_deep_struct
+    hash = HashWithStructAccess.new(:foo => {"bar" => {:baz => 42}})
+    assert_equal(hash.foo.bar.baz, 42)
+  end
+
+  def test_should_convert_subhashes_to_hashes_with_struct_access
+    hash = HashWithStructAccess.new(:foo => {"bar" => {:baz => 42}})
+    assert(hash.foo.kind_of?(HashWithStructAccess))
+    assert(hash.foo.bar.kind_of?(HashWithStructAccess))
+  end
+
+  # The main purpose of HashWithStructAccess is to be a configuration object,
+  # so it would be not such a good idea to modify a configuration object at the runtime.
+  def test_should_not_allow_modifications_after_initialization
+    hash = HashWithStructAccess.new(:foo => :bar)
+    begin
+      hash[:foo] = :baz
+    rescue RuntimeError => e
+      assert_equal(e.message, "can't modify frozen HashWithStructAccess")
+    end
+  end
+
+  def test_should_be_able_to_act_as_method_options
+    assert_equal(HashLike.call_me_with_options(HashWithStructAccess.new(:foo => {:bar => :baz})),
+        HashLike.call_me_with_options(:foo => {:bar => :baz}))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "test/unit"
+
+
+FileList["lib/*"].each { |f| load f }
+FileList["test/fixtures/*"].each { |f| load f }

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: hash_with_struct_access
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kostiantyn Kahanskyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70247841423260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70247841423260
+description: Hash object with struct access
+email:
+- kostiantyn.kahanskyi@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hash_with_struct_access.gemspec
+- lib/hash_with_struct_access.rb
+- test/fixtures/hash_like.rb
+- test/hash_with_struct_access_test.rb
+- test/test_helper.rb
+homepage: https://github.com/kostia/hash_with_struct_access
+licenses: []
+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.11
+signing_key: 
+specification_version: 3
+summary: Hash object with struct access. Main purpose is to be a configuration object.
+test_files:
+- test/fixtures/hash_like.rb
+- test/hash_with_struct_access_test.rb
+- test/test_helper.rb