@@ -1,6 +1,9 @@ -=== 1.0.0 / 2008-04-11 +=== 0.0.2 / 2008-04-12 -* 1 major enhancement +* Added bang(!) method support +* No longer automatically multi-level assigning +* Hash conversion now calls methods instead of []= to allow for overrides - * Birthday! +=== 0.0.1 / 2008-04-12 +* Initial release \ No newline at end of file History.txt @@ -10,13 +10,19 @@ be used in RESTful API libraries to provide easy object-like access to JSON and XML parsed hashes. == SYNOPSIS: - + mash = Mash.new mash.name? # => false + mash.name # => nil mash.name = "My Mash" mash.name # => "My Mash" mash.name? # => true mash.inspect # => <Mash name="My Mash"> + + mash = Mash.new + # use bang methods for multi-level assignment + mash.author!.name = "Michael Bleigh" + mash.author # => <Mash name="Michael Bleigh"> == INSTALL: README.txt @@ -4,6 +4,14 @@ # without the overhead of actually doing so. Think of it as OpenStruct # with some additional goodies. # +# A Mash will look at the methods you pass it and perform operations +# based on the following rules: +# +# * No punctuation: Returns the value of the hash for that key, or nil if none exists. +# * Assignment (<tt>=</tt>): Sets the attribute of the given method name. +# * Existence (<tt>?</tt>): Returns true or false depending on whether that key has been set. +# * Bang (<tt>!</tt>): Forces the existence of this key, used for deep Mashes. Think of it as "touch" for mashes. +# # == Basic Example # # mash = Mash.new @@ -21,8 +29,18 @@ # mash.f.first.g # => 44 # mash.f.last # => 12 # +# == Bang Example +# +# mash = Mash.new +# mash.author # => nil +# mash.author! # => <Mash> +# +# mash = Mash.new +# mash.author!.name = "Michael Bleigh" +# mash.author # => <Mash name="Michael Bleigh"> +# class Mash < Hash - VERSION = '0.0.1' + VERSION = '0.0.2' # If you pass in an existing hash, it will # convert it to a Mash including recursively @@ -66,16 +84,19 @@ class Mash < Hash self[match[1]] = args.first elsif (match = method_name.to_s.match(/(.*)\?$/)) && args.size == 0 key?(match[1]) + elsif (match = method_name.to_s.match(/(.*)!$/)) && args.size == 0 + return self[match[1]] if key?(match[1]) + self[match[1]] = Mash.new elsif keys.include?(method_name.to_s) self[method_name] elsif match = method_name.to_s.match(/^([a-z][a-z0-9A-Z_]+)$/) - Mash.new + nil else super end end - private + protected def mash_a_hash(hash) #:nodoc: hash.each do |k,v| @@ -86,7 +107,10 @@ class Mash < Hash v = collect_mashed_hashes_in(v) if v.is_a?(Array) end - self[k] = v + # we use the method call instead of []= here so that + # it can be easily overridden for custom behavior in + # inheriting objects + self.send "#{k.to_s}=", v end end lib/mash.rb @@ -37,6 +37,26 @@ describe Mash do @mash.to_s.should == @mash.inspect end + it "should return nil instead of raising an error for attribute-esque method calls" do + @mash.abc.should be_nil + end + + it "should return a Mash when passed a bang method to a non-existenct key" do + @mash.abc!.is_a?(Mash).should be_true + end + + it "should return the existing value when passed a bang method for an existing key" do + @mash.name = "Bob" + @mash.name!.should == "Bob" + end + + it "should allow for multi-level assignment through bang methods" do + @mash.author!.name = "Michael Bleigh" + @mash.author.should == Mash.new(:name => "Michael Bleigh") + @mash.author!.website!.url = "http://www.mbleigh.com/" + @mash.author.website.should == Mash.new(:url => "http://www.mbleigh.com/") + end + context "#initialize" do it "should convert an existing hash to a Mash" do converted = Mash.new({:abc => 123, :name => "Bob"}) spec/mash_spec.rb 3f8b5ad2667f92193c141cfbc191ff07732127a2 Michael Bleigh michael@intridea.com http://github.com/mbleigh/mash/commit/8d5f386193c70298b8372fd26ac8799065871a1c 8d5f386193c70298b8372fd26ac8799065871a1c 2008-04-12T12:42:39-07:00 2008-04-12T12:42:39-07:00 Adding bang method support for multi-level assignment. Hash conversion now calls methods instead of []= for overridability. 1053e62be5c14c8f205b4cf2daddf1fb5d5f8107 Michael Bleigh michael@intridea.com