mash 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-04-11
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/mash.rb
+spec/mash_spec.rb
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,51 @@
+= Mash (Mocking Hash)
+
+http://github.com/mbleigh/mash
+
+== DESCRIPTION:
+
+Mash is an extended Hash that gives simple pseudo-object functionality
+that can be built from hashes and easily extended. It is designed to
+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 = "My Mash"
+  mash.name # => "My Mash"
+  mash.name? # => true
+  mash.inspect # => <Mash name="My Mash">
+
+== INSTALL:
+
+RubyGem:
+
+  sudo gem install mash
+  
+Git:
+  git clone git://github.com/mbleigh/mash
+
+== LICENSE:
+
+Copyright (c) 2008 Michael Bleigh
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/mash.rb'
+require 'spec/rake/spectask'
+
+Hoe.new('mash', Mash::VERSION) do |p|
+  p.rubyforge_name = 'mash-hash' # if different than lowercase project name
+  p.developer('Michael Bleigh', 'michael@intridea.com')
+  p.remote_rdoc_dir = ''
+end
+
+desc "Run specs."
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = "spec/*_spec.rb"
+end
+# vim: syntax=Ruby

data/lib/mash.rb

@@ -0,0 +1,105 @@
+# Mash allows you to create pseudo-objects that have method-like
+# accessors for hash keys. This is useful for such implementations
+# as an API-accessing library that wants to fake robust objects
+# without the overhead of actually doing so. Think of it as OpenStruct
+# with some additional goodies.
+#
+# == Basic Example
+#    
+#   mash = Mash.new
+#   mash.name? # => false
+#   mash.name = "Bob"
+#   mash.name # => "Bob"
+#   mash.name? # => true
+#
+# == Hash Conversion  Example
+#   
+#   hash = {:a => {:b => 23, :d => {:e => "abc"}}, :f => [{:g => 44, :h => 29}, 12]}
+#   mash = Mash.new(hash)
+#   mash.a.b # => 23
+#   mash.a.d.e # => "abc"
+#   mash.f.first.g # => 44
+#   mash.f.last # => 12
+#
+class Mash < Hash
+  VERSION = '0.0.1'
+  
+  # If you pass in an existing hash, it will
+  # convert it to a Mash including recursively
+  # descending into arrays and hashes, converting
+  # them as well.
+  def initialize(source_hash = nil)
+    mash_a_hash(source_hash) if source_hash
+    super(nil)
+  end
+  
+  def id #:nodoc:
+    self["id"] ? self["id"] : super
+  end
+  
+  def [](key) #:nodoc:
+    key = key.to_s
+    return Mash.new unless key?(key)    
+    super
+  end
+  
+  def []=(key,value) #:nodoc:
+    key = key.to_s
+    super
+  end
+  
+  # Prints out a pretty object-like string of the
+  # defined attributes.
+  def inspect
+    ret = "<#{self.class.to_s}"
+    keys.sort.each do |key|
+      ret << " #{key}=#{self[key].inspect}"
+    end
+    ret << ">"
+    ret
+  end
+  
+  alias :to_s :inspect
+  
+  def method_missing(method_name, *args) #:nodoc:
+    if (match = method_name.to_s.match(/(.*)=$/)) && args.size == 1
+      self[match[1]] = args.first
+    elsif (match = method_name.to_s.match(/(.*)\?$/)) && args.size == 0
+      key?(match[1])
+    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
+    else
+      super
+    end
+  end
+  
+  private
+  
+  def mash_a_hash(hash) #:nodoc:
+    hash.each do |k,v|
+      case v
+        when Hash
+          v = Mash.new(v) if v.is_a?(Hash)
+        when Array
+          v = collect_mashed_hashes_in(v) if v.is_a?(Array)
+      end
+      
+      self[k] = v
+    end
+  end
+  
+  def collect_mashed_hashes_in(array) #:nodoc:
+    array.collect do |value|
+      case value
+        when Hash
+          Mash.new(value)
+        when Array
+          collect_mashed_hashes_in(value)
+        else
+          value
+      end
+    end
+  end
+end

data/spec/mash_spec.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__),"..","lib","mash")
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+describe Mash do
+  before(:each) do
+    @mash = Mash.new
+  end
+  
+  it "should inherit from hash" do
+    @mash.is_a?(Hash).should be_true
+  end
+  
+  it "should be able to set hash values through method= calls" do
+    @mash.test = "abc"
+    @mash["test"].should == "abc"
+  end
+  
+  it "should be able to retrieve set values through method calls" do
+    @mash["test"] = "abc"
+    @mash.test.should == "abc"
+  end
+  
+  it "should test for already set values when passed a ? method" do
+    @mash.test?.should be_false
+    @mash.test = "abc"
+    @mash.test?.should be_true
+  end
+  
+  it "should make all [] and []= into strings for consistency" do
+    @mash["abc"] = 123
+    @mash.key?('abc').should be_true
+    @mash["abc"].should == 123
+  end
+  
+  it "should have a to_s that is identical to its inspect" do
+    @mash.abc = 123
+    @mash.to_s.should == @mash.inspect
+  end
+  
+  context "#initialize" do
+    it "should convert an existing hash to a Mash" do
+      converted = Mash.new({:abc => 123, :name => "Bob"})
+      converted.abc.should == 123
+      converted.name.should == "Bob"
+    end
+  
+    it "should convert hashes recursively into mashes" do
+      converted = Mash.new({:a => {:b => 1, :c => {:d => 23}}})
+      converted.a.is_a?(Mash).should be_true
+      converted.a.b.should == 1
+      converted.a.c.d.should == 23
+    end
+  
+    it "should convert hashes in arrays into mashes" do
+      converted = Mash.new({:a => [{:b => 12}, 23]})
+      converted.a.first.b.should == 12
+      converted.a.last.should == 23
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__),"..","lib","mash")

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: mash
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: Mash is an extended Hash that gives simple pseudo-object functionality that can be built from hashes and easily extended. It is designed to be used in RESTful API libraries to provide easy object-like access  to JSON and XML parsed hashes.
+email: 
+- michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/mash.rb
+- spec/mash_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mbleigh/mash
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: mash-hash
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: Mash is an extended Hash that gives simple pseudo-object functionality that can be built from hashes and easily extended
+test_files: []
+