hashi 1.0

data/README.textile

@@ -0,0 +1,123 @@
+h1. Hash and Objects
+
+It's a common task to simulate objects from hashes, but one has to remember using hash access format in order to access it. Hashi helps you by allowing direct access to its content:
+
+<pre>
+	hash = { :team => {:players => [{:name=>"guilherme silveira"},{:name=>"jose donizetti"}]}}
+	object = Hashi.to_object(hash)
+	puts object.team.players[0].name
+</pre>
+
+h1. Why would I use Hashi?
+
+<img src="http://robotomi.files.wordpress.com/2007/06/hashi.jpg" />
+
+h2. The reality without Hashi
+
+<pre>
+	hash = { :team => {:players => [{:name=>"guilherme silveira"},{:name=>"jose donizetti"}]}}
+	puts hash[:team][:players][0][:name] # his name
+</pre>
+
+Although the Ruby language provides an easy way to access hashes, it becomes easier if you use Rails and
+has created an ActiveRecord for your representation:
+
+h2. The reality without Hashi, within Rails
+
+<pre>
+	class Team < ActiveRecord::Base
+		has_many :players
+	end
+	class Player < ActiveRecord::Base
+		# create a migration with field name:string
+	end
+	hash = { :team => {:players => [{:name=>"guilherme silveira"},{:name=>"jose donizetti"}]}}
+	puts hash[:player][0][:name] # his name
+</pre>
+
+h2. How does it compare to Hashie?
+
+Hashi actually does not create your attributes, instead it deals with *method_missing* invocations to
+simulate those properties, never creating a copy of your hash.
+
+h2. More info
+
+You can access the original hash (updated if you have made any changes) by one of those two ways:
+
+<pre>
+	hash = { :team => {:players => [{:name=>"guilherme silveira"},{:name=>"jose donizetti"}]}}
+	object = Hashi.to_object(hash)
+	object.team.players[0].name = 'jose donizetti'
+	
+	# the original hash was modified!
+	puts hash
+	
+	# you can extract the original hash if you wish
+	puts object.hash
+	
+</pre>
+
+h1. Installing
+
+h2. Ruby
+
+gem install gemcutter
+gem tumble
+gem install hashi
+
+h2. Rails
+
+Just add in your environment.rb the following line:
+
+<pre>
+config.gem "hashi", :source => "http://gemcutter.org"
+</pre>
+
+And then execute:
+<pre>rake gems:install</pre>
+
+or, if you prefer to install it as a plugin:
+
+<pre>script/plugin install git://github.com/caelum/hashi.git</pre>
+
+
+h2. Help
+
+If you are looking for or want to help, let us know at the mailing list:
+
+"http://groups.google.com/group/hashi-ruby":http://groups.google.com/group/hashi-ruby
+
+h2. Team
+
+Hashi was created and is maintained within Caelum:http://www.caelum.com.br by
+
+Projetct Founder
+* "Guilherme Silveira":mailto:guilherme.silveira@caelum.com.br - twitter:http://www.twitter.com/guilhermecaelum "http://guilhermesilveira.wordpress.com":http://guilhermesilveira.wordpress.com
+
+Active Commiters
+* Guilherme Silveira
+* Jose Donizetti
+
+h3. Sources
+
+You can see its source code at: "github":http://github.com/caelum/hashi
+
+h2. License
+
+/***
+ * Copyright (c) 2009 Caelum - www.caelum.com.br/opensource
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * 	http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+GEM = "hashi"
+GEM_VERSION = "1.0"
+SUMMARY = "Hash to object helper methods."
+AUTHOR = "Guilherme Silveira, Jose Donizetti"
+EMAIL = "guilherme.silveira@caelum.com.br"
+HOMEPAGE = "http://github.com/caelum/hashi"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = SUMMARY
+  s.require_paths = ['lib']
+  s.files = FileList['lib/**/*.rb', '[A-Z]*'].to_a
+
+  # s.add_dependency(%q<rubigen>, [">= 1.3.4"])
+
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs -fh:doc/specs.html --color)
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc "Builds the project"
+task :build => :spec
+
+desc "Default build will run specs"
+task :default => :spec

data/lib/hashi.rb

@@ -0,0 +1,31 @@
+module Hashi
+  class CustomHash
+    
+    attr_reader :hash
+
+    def initialize(h)
+      @hash = h
+    end
+    def method_missing(name, *args)
+      name = name.to_s if name.kind_of? Symbol
+      if name[-1,1] == "="
+        name = name.chop
+        @hash[name] = args[0]
+      else
+        transform(@hash[name])
+      end
+    end
+    def [](x)
+      transform(@hash[x])
+    end
+    private
+    def transform(value)
+      return CustomHash.new(value) if value.kind_of?(Hash) || value.kind_of?(Array)
+      value
+    end
+    
+  end
+  def self.to_object(h)
+    CustomHash.new(h)
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: hashi
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Guilherme Silveira, Jose Donizetti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-26 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: guilherme.silveira@caelum.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/hashi.rb
+- Rakefile
+- README.textile
+has_rdoc: true
+homepage: http://github.com/caelum/hashi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Hash to object helper methods.
+test_files: []
+