methodize 0.1

data/README.md

@@ -0,0 +1,102 @@
+Methodize
+---------
+
+Is a module to read from and write to the keys of a ruby Hash using methods. As simple as this:
+
+    require 'methodize/hash'
+    hash.methodize!
+
+If you don't want to mess with your Hash class, just do this:
+
+    require 'methodize'
+    hash.extend(Methodize)
+
+The advantage of using Methodize is that you can easily access the values of complex or big Hash objects, such as converted JSONs returned from Web Services, RESTful APIs, etc.
+
+Instead of using:
+
+    hash["article"].last["info"][:category].first
+
+You can use:
+
+    hash.article.last.info.category.first
+
+### Interested? Let's see more examples ###
+
+Let's suppose that we have the following hash object:
+
+    hash = {
+      :article => [
+        {
+          :title  => "Article 1",
+          :author => "John Doe",
+          :url    => "http://a.url.com"
+        },{
+          "title"  => "Article 2",
+          "author" => "Foo Bar",
+          "url"    => "http://another.url.com"
+        },{
+          :title  => "Article 3",
+          :author => "Biff Tannen",
+          :url    => ["http://yet.another.url.com", "http://localhost"],
+          :info => {
+            :published => "2010-05-31",
+            :category  => [:sports, :entertainment]
+          }
+        }
+      ],
+      "type" => :text,
+      :size  => 3,
+      :id    => 123456789
+    }
+
+You can change the **title of the third article** using:
+
+    hash.article[2].title = "New title"
+    hash.article[2].title               # => "New title"
+
+Hash public methods that conflicts with keys will be automatically freed:
+
+    hash.type                           # => :text
+    hash.size                           # => 3
+    hash.id                             # => 123456789
+
+But don't panic, you can still use the Hash methods just as Ruby does for id and send methods by default:
+
+    hash.__type__                       # => Hash
+    hash.__size__                       # => 4 (hash keys count)
+
+### Another examples ###
+
+Writing:
+
+    hash.article.last.title = "Article 3"
+    hash.article[1].info = {
+                              :published => "2010-08-31",
+                              :category  => [:sports, :entertainment]
+                            }
+    hash.article << {
+                       :title  => "A new title",
+                       :author => "Marty Mcfly"
+                     }
+    hash.shift  = 12
+    hash["inspect"] = false
+    hash.size   = 4
+
+Accessing:
+
+    hash.article[2].title               # => "Article 3"
+    hash.article[1].info.published      # => "2010-08-31"
+    hash.article.last.author            # => "Marty Mcfly"
+    hash.shift                          # => 12
+    hash.inspect                        # => false
+    hash.__inspect__.class              # => String
+    hash.size                           # => 4
+    hash.__size__                       # => 6
+
+You can access the Hash as usual using [] or []=.
+
+Check the tests for more examples.
+
+*Created by Luis Cipriani*<br/>
+*http://blog.talleye.com*

data/lib/methodize.rb

@@ -0,0 +1,58 @@
+module Methodize
+  def self.extended(base)
+    # if some of the Hash keys and public methods names conflict
+    # we free the existant method to enable the user to call it
+    base.keys.each do |k|
+      base.__free_method__(k.to_sym) if base.public_methods.include?(k.to_s)
+    end
+  end
+  
+  def [](key)
+    __normalize__(super(key))
+  end
+
+  def []=(key, value)
+    __free_method__(key) if !self.keys.include?(key) && self.public_methods.include?(key.to_s)
+    super(key,value)
+  end
+
+  def method_missing(name, *args)
+    method_name = name.to_s
+    if method_name[-1,1] == '='
+      method_name = method_name.chop
+      self.key?(method_name) ? key = method_name : key = method_name.to_sym
+      self[key] = args[0]
+    else
+      self.key?(method_name) ? key = method_name : key = method_name.to_sym
+      self[key]
+    end
+  end
+
+  # if you have a key that is also a method (such as Array#size)
+  # you can use this to free the method and use the method obj.size
+  # to access the value of key "size".
+  # you still can access the old method with __[method_name]__
+  def __free_method__(sym)
+    self.__metaclass__.send(:alias_method, "__#{sym.to_s}__".to_sym, sym) unless self.respond_to?("__#{sym.to_s}__")
+    self.__metaclass__.send(:define_method, sym) { method_missing(sym.to_s) }
+    self
+  end
+
+  def __metaclass__
+    class << self; self; end
+  end
+  
+private
+
+  def __normalize__(value)
+    case value
+    when Hash
+      value.extend(Methodize)
+    when Array
+      value.map { |v| __normalize__(v) }
+    else
+      value
+    end
+    value
+  end
+end

data/lib/methodize/hash.rb

@@ -0,0 +1,6 @@
+require 'methodize'
+class Hash
+  def methodize!
+    self.extend(Methodize)
+  end
+end

data/test/hash_test.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'methodize/hash'
+
+require 'rubygems'
+require 'ruby-debug'
+
+class MethodizeTest < Test::Unit::TestCase
+
+  def setup
+    @hash = {
+      :article => [
+        {
+          :title  => "Article 1",
+          :author => "John Doe",
+          :url    => "http://a.url.com"
+        },{
+          "title"  => "Article 2",
+          "author" => "Foo Bar",
+          "url"    => "http://another.url.com"
+        },{
+          :title  => "Article 3",
+          :author => "Biff Tannen",
+          :url    => ["http://yet.another.url.com", "http://localhost"],
+          :info => {
+            :published => "2010-05-31",
+            :category  => [:sports, :entertainment]
+          }
+        }
+      ],
+      "type" => :text,
+      :size  => 3,
+      :id    => 123456789
+    }
+
+    @hash.methodize!
+  end
+
+  def test_methodize_should_still_work_as_expected
+    assert_equal @hash[:article].last[:title], "Article 3"
+    assert_equal @hash[:article][1]["author"], "Foo Bar"
+    assert_equal @hash["type"]               , :text
+    assert_equal @hash[:size]                , 3
+    assert_nil   @hash[:wrong_key]
+    
+    assert       @hash.keys.include?(:size)
+    assert_equal @hash.article.size, 3
+  end
+
+  def test_methodize_should_support_read_of_values_as_methods
+    assert_equal @hash.article.last.title              , "Article 3"
+    assert_equal @hash.article[1].author               , "Foo Bar"
+    assert_equal @hash.article.last.info.category.first, :sports
+    assert_nil   @hash.wrong_key
+    
+    assert_equal @hash.size, 3
+    assert_equal @hash.type, :text
+    assert_equal @hash.id  , 123456789
+  end
+
+  def test_double_methodize_call_does_not_affect_anything
+    assert_equal @hash.methodize!.article.last.title, "Article 3"
+  end
+
+end

data/test/methodize_test.rb

@@ -0,0 +1,98 @@
+require 'test/unit'
+require 'methodize'
+
+require 'rubygems'
+require 'ruby-debug'
+
+class MethodizeTest < Test::Unit::TestCase
+
+  def setup
+    @hash = {
+      :article => [
+        {
+          :title  => "Article 1",
+          :author => "John Doe",
+          :url    => "http://a.url.com"
+        },{
+          "title"  => "Article 2",
+          "author" => "Foo Bar",
+          "url"    => "http://another.url.com"
+        },{
+          :title  => "Article 3",
+          :author => "Biff Tannen",
+          :url    => ["http://yet.another.url.com", "http://localhost"],
+          :info => {
+            :published => "2010-05-31",
+            :category  => [:sports, :entertainment]
+          }
+        }
+      ],
+      "type" => :text,
+      :size  => 3,
+      :id    => 123456789
+    }
+
+    @hash.extend(Methodize)
+  end
+
+  def test_hash_should_still_work_as_expected
+    assert_equal @hash[:article].last[:title], "Article 3"
+    assert_equal @hash[:article][1]["author"], "Foo Bar"
+    assert_equal @hash["type"]               , :text
+    assert_equal @hash[:size]                , 3
+    assert_nil   @hash[:wrong_key]
+    
+    assert       @hash.keys.include?(:size)
+    assert_equal @hash.article.size, 3
+  end
+
+  def test_hash_should_support_read_of_values_as_methods
+    assert_equal @hash.article.last.title              , "Article 3"
+    assert_equal @hash.article[1].author               , "Foo Bar"
+    assert_equal @hash.article.last.info.category.first, :sports
+    assert_nil   @hash.wrong_key
+  end
+
+  def test_should_free_existant_methods_by_default
+    assert_equal @hash.size, 3
+    assert_equal @hash.type, :text
+    assert_equal @hash.id  , 123456789
+  end
+
+  def test_should_be_able_to_call_previously_freed_methods
+    assert_equal     @hash.__size__, 4
+    begin #avoid showing deprecate Object#type warning on test log
+      $stderr = StringIO.new
+      assert_equal     @hash.__type__, Hash
+      $stderr.rewind
+    ensure
+      $stderr = STDERR
+    end
+    assert_not_equal @hash.__id__  , 123456789
+  end
+  
+  def test_should_enable_write_operations
+    @hash.article.last.title = "Article 3"
+    @hash.article[1].info = {
+                              :published => "2010-08-31",
+                              :category  => [:sports, :entertainment]
+                            }
+    @hash.article << {
+                       :title  => "A new title",
+                       :author => "Marty Mcfly"
+                     }
+    @hash.shift  = 12
+    @hash["inspect"] = false
+    @hash.size   = 4
+    
+    assert_equal @hash.article[2].title         , "Article 3"
+    assert_equal @hash.article[1].info.published, "2010-08-31"
+    assert_equal @hash.article.last.author      , "Marty Mcfly"
+    assert_equal @hash.shift                    , 12
+    assert_equal @hash.inspect                  , false
+    assert_equal @hash.__inspect__.class        , String
+    assert_equal @hash.size                     , 4
+    assert_equal @hash.__size__                 , 6
+  end
+end
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: methodize
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Luis Cipriani
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-01 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: lfcipriani@talleye.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/methodize.rb
+- lib/methodize/hash.rb
+- test/methodize_test.rb
+- test/hash_test.rb
+has_rdoc: true
+homepage: http://blog.talleye.com
+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: Module to read from and write to the keys of a ruby Hash using methods
+test_files: []
+