karottenreibe-ohash 0.0.3 → 1.0.0

data/HISTORY.markdown

@@ -1,3 +1,10 @@
+1.0.0
+=====
+
+*   changed whole functionality
+*   now works as wrapper to hash
+*   added _..., ...! and ...? methods
+
 0.0.3
 =====
 

data/README.markdown

@@ -8,6 +8,8 @@ Description
 
 OpenHash (short: ohash) is a simple, enhanced hash structure with the direct
 member access of OpenStruct, but without all the restrictions.
+It also features some niceties as found in Mash
+(http://www.intridea.com/2008/4/12/mash-mocking-hash-for-total-poser-objects?blog=company).
 
 Synopsis
 --------
@@ -16,15 +18,32 @@ Synopsis
     require 'ohash'
 
     o = OpenHash.new({:foo => 12})
-    o.foo  #=> 12
-
-    o[:foo] #=> 12
-
-    o.bar = 42
-    o.bar  #=> 42
-
-    o.merge!({:goo => 23})
-    o.goo  #=> 23
+    o = OpenHash.new
+ 
+* Access to hash methods
+ 
+    o._merge!({:foo => 12, :bar => 22})
+    o._keys         #=> [:foo, :bar]
+ 
+* Member access
+ 
+    o.foo == 12     #=> true
+    o.foo = 33
+    o[:foo] == 12   #=> false
+ 
+* Membership test
+ 
+    o.foo?          #=> true
+    o.bar?          #=> true
+    o.bla?          #=> false
+ 
+* Quick population with sub hashes
+ 
+    o.bla!.goo = 23
+    o.bla!.yadda!.rofl = 42
+    o.bla?          #=> true
+    o.bla?.goo?     #=> true
+ 
 
 Installing
 ----------

data/Rakefile

@@ -25,3 +25,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+task :test do
+    sh 'bacon -Ilib test/test_*.rb'
+end
+

data/VERSION

@@ -1 +1 @@
-0.0.3
+1.0.0

data/lib/ohash.rb

@@ -1,20 +1,119 @@
+require 'delegate'
 
 #
 # Since I personally hate OpenStructs, this is a
 # Hash with the same features, but it's mergeable etc...
 #
-class OpenHash < Hash
+# Inspired by Mash:
+# http://www.intridea.com/2008/4/12/mash-mocking-hash-for-total-poser-objects?blog=company
+#
+#   o = OpenHash.new
+#
+# * Access to hash methods
+#
+#   o._merge!({:foo => 12, :bar => 22})
+#   o._keys         #=> [:foo, :bar]
+#
+# * Member access
+#
+#   o.foo == 12     #=> true
+#   o.foo = 33
+#   o[:foo] == 12   #=> false
+#
+# * Membership test
+#
+#   o.foo?          #=> true
+#   o.bar?          #=> true
+#   o.bla?          #=> false
+#
+# * Quick population with sub hashes
+#
+#   o.bla!.goo = 23
+#   o.bla!.yadda!.rofl = 42
+#   o.bla?          #=> true
+#   o.bla?.goo?     #=> true
+#
+class OpenHash
+
+    class << self
+
+        def []( *args )
+            o = OpenHash.new
+            o.instance_variable_set(:@hash, Hash[*args])
+            o
+        end
+
+    end
 
-    def method_missing meth, *args
+    #
+    # Same as for Hash.
+    #
+    def initialize( *args )
+        @hash = Hash.new(*args)
+    end
+
+    def to_hash
+        @hash.dup
+    end
+
+    alias_method :to_h, :to_hash
+
+    #
+    # Returns this OpenHash as a simple hash.
+    # Modifying the returned hash will modify
+    # the original OpenHash as well.
+    #
+    def as_hash
+        @hash
+    end
+
+    def to_s
+        @hash.to_s
+    end
+
+    def inspect
+        @hash.inspect
+    end
+
+    protected
+
+    #
+    # Emulates [...], ...=, ...!, ...?, _... and
+    # direct member access methods.
+    #
+    def method_missing( meth, *args, &block )
         method = meth.to_s
 
-        if method =~ %r{.+=$}
+        case method
+        when *%w{[] []=}
+            @hash.send(meth, *args, &block)
+        when %r{^_}
+            ret = @hash.send(method[1..-1], *args, &block)
+
+            if ret.respond_to?(:to_ohash) and meth != :_default
+                ret.to_ohash
+            else
+                ret
+            end
+        when %r{.=$}
             super unless args.length == 1
-            self[method[0...-1].to_sym] = args.first
+            @hash[method[0...-1].to_sym] = args.first
+        when %r{.!$}
+            super unless args.empty?
+            @hash[method[0...-1].to_sym] ||= OpenHash.new
+        when %r{.\?$}
+            super unless args.empty?
+            @hash.keys.include?(method[0...-1].to_sym)
         else
-            self[meth]
+            @hash[meth]
         end
     end
 
 end
 
+class Hash
+    def to_ohash
+        OpenHash[self]
+    end
+end
+

data/ohash.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ohash}
-  s.version = "0.0.3"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Fabian Streitel"]
-  s.date = %q{2009-08-05}
+  s.date = %q{2009-08-24}
   s.description = %q{A simple, enhanced hash structure with the direct member access of OpenStruct, but without all the restrictions.}
   s.email = %q{karottenreibe@gmail.com}
   s.extra_rdoc_files = [
@@ -24,7 +24,8 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/ohash.rb",
-     "ohash.gemspec"
+     "ohash.gemspec",
+     "test/test_ohash.rb"
   ]
   s.homepage = %q{http://github.com/karottenreibe/vim-syntax}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -32,6 +33,9 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{ohash}
   s.rubygems_version = %q{1.3.4}
   s.summary = %q{A simple, enhanced hash structure with the direct member access of OpenStruct, but without all the restrictions.}
+  s.test_files = [
+    "test/test_ohash.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/test/test_ohash.rb

@@ -0,0 +1,67 @@
+require 'ohash'
+require 'bacon'
+
+describe 'An OpenHash' do
+
+    before do
+        @o = OpenHash.new
+        @the_family = {:mister => :apple, :misses => :plum}
+    end
+
+    it 'should have the same creation methods as hash' do
+        seed = {:grandgrandpa => :grape, :grandgrandma => :strawberry}
+        klass_seeded = OpenHash[seed]
+        new_seeded = OpenHash.new(seed)
+
+        klass_seeded.class.should.be == OpenHash
+        klass_seeded.to_hash.should.be == seed
+
+        new_seeded.class.should.be == OpenHash
+        new_seeded.to_hash.should.be.empty
+        new_seeded._default.should.be == seed
+    end
+
+    it 'should call hash functions' do
+        @o._merge!(@the_family)
+
+        @o.to_hash.should.be == @the_family
+        @o._keys.should.be == [:mister, :misses]
+    end
+
+    it 'should ensure that hash functions return an ohash whenever possible' do
+        # only an excerpt
+        @o._merge(@the_family).class.should.be == OpenHash
+        @o._invert.class.should.be == OpenHash
+        @o._reject { false }.class.should.be == OpenHash
+        @o._delete_if { false }.class.should.be == OpenHash
+        @o._replace(@the_family).class.should.be == OpenHash
+    end
+
+    it 'should grant direct member access' do
+        @o._merge!(@the_family)
+        @o.mister.should.be == :apple
+
+        @o.son = :pineapple
+        @o.son.should.be == :pineapple
+    end
+
+    it 'should perform the membership test' do
+        @o._merge!(@the_family)
+        @o.mister?.should.be.true
+        @o.misses?.should.be.true
+        @o.uncle_leo?.should.be.false
+    end
+
+    it 'should populate quickly' do
+        @o._merge!(@the_family)
+        @o.grandparents!.apple_side!.grandma = :dade
+        @o.grandparents?.should.be.true
+        @o.grandparents.class.should.be == OpenHash
+        @o.grandparents.apple_side?.should.be.true
+        @o.grandparents.apple_side.class.should.be == OpenHash
+        @o.grandparents.apple_side.grandma?.should.be.true
+        @o.grandparents.apple_side.grandma.should.be == :dade
+    end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: karottenreibe-ohash
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors: 
 - Fabian Streitel
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-05 00:00:00 -07:00
+date: 2009-08-24 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +31,7 @@ files:
 - VERSION
 - lib/ohash.rb
 - ohash.gemspec
+- test/test_ohash.rb
 has_rdoc: false
 homepage: http://github.com/karottenreibe/vim-syntax
 licenses: 
@@ -58,5 +59,5 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A simple, enhanced hash structure with the direct member access of OpenStruct, but without all the restrictions.
-test_files: []
-
+test_files: 
+- test/test_ohash.rb