hash-ninja 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea
+doc

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'activesupport'
+gem 'rspec'
+
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hashninja.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hash_ninja/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hash-ninja"
+  s.version     = HashNinja::VERSION
+  s.authors     = ["Kazuhiro Sera"]
+  s.email       = ["seratch@gmail.com"]
+  s.homepage    = "https://github.com/seratch/hash-ninja"
+  s.summary     = %q{Hash toolkit for Ruby ninja}
+  s.description = %q{Hash toolkit for Ruby ninja}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activesupport"
+
+end

data/lib/hash_ninja.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+require "hash_ninja/active_hash"
+require "hash_ninja/core_ext"
+require "hash_ninja/hash_attr_reader"
+require "hash_ninja/version"
+
+# HashNinja is a useful utility library for Ruby Hash
+module HashNinja
+end

data/lib/hash_ninja/active_hash.rb

@@ -0,0 +1,127 @@
+# -*- encoding: utf-8 -*-
+
+require "hash_ninja"
+require "active_support/core_ext/hash/keys"
+
+module HashNinja
+
+  # Hash with extended ActiveSupport
+  #
+  # See also {active_support/core_ext/hash/keys}[http://as.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Keys.html]
+  module ActiveHash
+
+    # Applies ActiveSupport::Inflector.underscore to all the Hash#keys destructively.
+    # Keys should be either Symbol or String.
+    #
+    # ==== Examples
+    #   hash = {:rubyOnRails => 'http://rubyonrails.org/'}
+    #   has.activate!.underscore_keys!  # => {:ruby_on_rails => 'http://rubyonrails.org/'}
+    def underscore_keys!
+      self.keys.each do |key|
+        value = delete(key)
+        if key.is_a? String
+          self[key.underscore] = value
+        elsif key.is_a? Symbol
+          self[key.to_s.underscore.to_sym] = value
+        end
+      end
+      self
+    end
+
+    # Applies ActiveSupport::Inflector#classify to all the Hash#keys destructively.
+    # Keys should be either Symbol or String.
+    #
+    # ==== Examples
+    #   hash = {:ruby_on_rails => 'http://rubyonrails.org/'}
+    #   has.activate!.classify_keys!  # => {:RubyOnRails => 'http://rubyonrails.org/'}
+    def classify_keys!
+      self.keys.each do |key|
+        value = delete(key)
+        if key.is_a? String
+          self[key.classify] = value
+        elsif key.is_a? Symbol
+          self[key.to_s.classify.to_sym] = value
+        end
+      end
+    end
+
+    # Applies ActiveSupport::Inflector#camelize to all the Hash#keys destructively.
+    # Keys should be either Symbol or String.
+    #
+    # ==== Examples
+    #   hash = {:ruby_on_rails => 'http://rubyonrails.org/'}
+    #   has.activate!.camelize_keys!  # => {:RubyOnRails => 'http://rubyonrails.org/'}
+    def camelize_keys!
+      self.keys.each do |key|
+        value = delete(key)
+        if key.is_a? String
+          self[key.camelize] = value
+        elsif key.is_a? Symbol
+          self[key.to_s.camelize.to_sym] = value
+        end
+      end
+    end
+
+    #
+    # Applies ActiveSupport::Inflector#camelize(:lower) to all the Hash#keys destructively.
+    # Keys should be either Symbol or String.
+    #
+    # ==== Examples
+    #   hash = {:ruby_on_rails => 'http://rubyonrails.org/'}
+    #   has.activate!.camelize_lower_keys!  # => {:rubyOnRails => 'http://rubyonrails.org/'}
+    def camelize_lower_keys!
+      self.keys.each do |key|
+        value = delete(key)
+        if key.is_a? String
+          self[key.camelize(:lower)] = value
+        elsif key.is_a? Symbol
+          self[key.to_s.camelize(:lower).to_sym] = value
+        end
+      end
+    end
+
+    # Provides the following recursive methods.
+    #
+    # ====
+    # * recursively_camelize_keys!
+    # * recursively_camelize_lower_keys!
+    # * recursively_classify_keys!
+    # * recursively_underscore_keys!
+    def method_missing(name, *args, &block)
+      # provides 'recursively_xxx' methods
+      if name.match(/recursively_/)
+        method_name = name.to_s.sub(/^recursively_/, '')
+        self.public_send(method_name, *args, &block)
+        self.values.each do |value|
+          if value.is_a? Hash
+            value.extend HashNinja::ActiveHash
+            value.public_send(name, *args, &block)
+          elsif value.is_a? Array
+            value.public_send(name, *args, &block)
+          end
+        end
+        self
+      end
+    end
+
+  end
+end
+
+class Array
+  def method_missing(name, *args, &block)
+    # for ActiveHash#recursively_xxx
+    if name.match(/recursively_/)
+      method_name = name.to_s.sub(/^recursively_/, '')
+      self.each do |value|
+        if value.is_a? Hash
+          value.extend HashNinja::ActiveHash
+          value.public_send(name, *args, &block)
+        elsif value.is_a? Array
+          value.public_send(name, *args, &block)
+        end
+      end
+      self
+    end
+  end
+end
+

data/lib/hash_ninja/core_ext.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+require "hash_ninja"
+require "active_support/core_ext/string/inflections"
+
+module HashNinja
+  module CoreExt
+  end
+end
+
+class Hash
+
+  # Updates itself as HashNinja::ActiveHash destructively. 'active_support' will be also applied.
+  def activate!
+    self.extend HashNinja::ActiveHash
+    self
+  end
+
+  # Provides HashNinja::HashAccessor object
+  def to_attr_reader
+    HashNinja::HashAttrReader.new(self)
+  end
+
+  # Creates Hash object which contains the readable instance variables of 'obj'.
+  # It's possible to customize the key convention by 'key_strategy'.
+  def self.from_attr(obj, key_strategy = :underscore)
+    hash = {}
+    obj.instance_variables.each do |attr|
+      original_key = attr.to_s.delete('@')
+      case key_strategy
+        when :underscore
+          key = original_key.underscore
+        when :camelize
+          key = original_key.camelize
+        when :camelize_lower
+          key = original_key.camelize(:lower)
+        when :classify
+          key = original_key.classify
+        else
+          key = original_key
+      end
+      begin
+        hash[key.to_sym] = obj.send(original_key.to_sym)
+      rescue NoMethodError => e
+      end
+    end
+    hash
+  end
+
+end

data/lib/hash_ninja/hash_attr_reader.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+module HashNinja
+
+  # Provides attr_reader Hash data
+  # ==== Examples
+  #   member = {'name'=>'Andy', 'type' => { 'id' => 999, 'name' => 'Guest' }}.to_attr_reader
+  #   member.name # => 'Andy'
+  #   member.type.id # => 999
+  class HashAttrReader
+    # target Hash object
+    attr_reader :hash
+
+    # The 'hash' should be a Hash object.
+    def initialize(hash)
+      raise "hash should be a Hash object #{hash.to_s}" unless hash.is_a? Hash
+      @hash = hash
+    end
+
+    def method_missing(name, *args, &block)
+      found = @hash[name] || @hash[name.to_s]
+      if found
+        if found.is_a? Hash
+          found.to_attr_reader
+        else
+          found
+        end
+      end
+    end
+
+    # Returns the Hash object held internally
+    def to_hash
+      @hash
+    end
+
+  end
+end

data/lib/hash_ninja/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+
+module HashNinja
+  VERSION = "0.1.0"
+end

data/spec/hash_ninja/active_hash_spec.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require 'active_support'
+require 'hash_ninja'
+
+describe HashNinja::ActiveHash do
+
+  it 'should have #underscore_keys!' do
+    hash = {:rubyOnRails => 'xxx', 'ProgrammingRuby' => {'RubyGems' => 'yyy'}}
+    hash.activate!.underscore_keys!
+
+    hash[:ruby_on_rails].should eq('xxx')
+    hash['programming_ruby'].should eq({'RubyGems' => 'yyy'})
+  end
+
+  it 'should have #recursively_underscore_keys!' do
+    hash = {:rubyOnRails => 'aaa', 'ProgrammingRuby' => {:RubyGems => 'bbb', 'rubyMine' => 'ccc'}}
+    hash.activate!.recursively_underscore_keys!
+
+    hash[:ruby_on_rails].should eq('aaa')
+    hash['programming_ruby'].should eq({:ruby_gems => 'bbb', 'ruby_mine' => 'ccc'})
+    hash['programming_ruby'][:ruby_gems].should eq('bbb')
+    hash['programming_ruby']['ruby_mine'].should eq('ccc')
+  end
+
+end

data/spec/hash_ninja/core_ext_spec.rb

@@ -0,0 +1,86 @@
+# -*- encoding: utf-8 -*-
+
+require 'hash_ninja'
+
+describe Hash do
+
+  it 'should have #activate!' do
+    activated = {:first => 'aaa', 'second' => 'bbb'}.activate!
+    activated.is_a?(HashNinja::ActiveHash).should eq(true)
+  end
+
+  class Member
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :age
+
+    def initialize(id, name, age)
+      @id = id
+      @name = name
+      @age = age
+    end
+  end
+
+  class Member2Underscore
+    attr_accessor :firstName
+    attr_accessor :lastName
+
+    def initialize(firstName, lastName)
+      @firstName = firstName
+      @lastName = lastName
+    end
+  end
+
+  class Member2Camelize
+    attr_accessor :first_name
+    attr_accessor :last_name
+
+    def initialize(first_name, last_name)
+      @first_name = first_name
+      @last_name = last_name
+    end
+  end
+
+  it 'shoud have from_attr' do
+    andy = Member.new(123, 'Andy', 20)
+    andy_hash = Hash.from_attr(andy)
+    andy_hash[:id].should eq(123)
+    andy_hash[:name].should eq('Andy')
+    andy_hash[:age].should eq(20)
+
+    brian = Member.new(123, 'Brian', nil)
+    brian_hash = Hash.from_attr(brian)
+    brian_hash[:id].should eq(123)
+    brian_hash[:name].should eq('Brian')
+    brian_hash[:age].should eq(nil)
+  end
+
+  it 'should have from_attr (underscore)' do
+    m = Member2Underscore.new('Linus', 'Torvalds')
+    hash = Hash.from_attr(m, :underscore)
+    hash[:first_name].should eq('Linus')
+    hash[:last_name].should eq('Torvalds')
+  end
+
+  it 'should have from_attr (camelize)' do
+    m = Member2Camelize.new('Linus', 'Torvalds')
+    hash = Hash.from_attr(m, :camelize)
+    hash[:FirstName].should eq('Linus')
+    hash[:LastName].should eq('Torvalds')
+  end
+
+  it 'should have from_attr (camelize_lower)' do
+    m = Member2Camelize.new('Linus', 'Torvalds')
+    hash = Hash.from_attr(m, :camelize_lower)
+    hash[:firstName].should eq('Linus')
+    hash[:lastName].should eq('Torvalds')
+  end
+
+  it 'should have from_attr (classify)' do
+    m = Member2Camelize.new('Linus', 'Torvalds')
+    hash = Hash.from_attr(m, :classify)
+    hash[:FirstName].should eq('Linus')
+    hash[:LastName].should eq('Torvalds')
+  end
+
+end

data/spec/hash_ninja/hash_attr_reader_spec.rb

@@ -0,0 +1,66 @@
+# -*- encoding: utf-8 -*-
+
+require "hash_ninja"
+
+describe HashNinja::HashAttrReader do
+
+  it 'should work with string keys' do
+    hash = {:something => 'like that', :name => 'hash_ninja'}
+    hash_attr = hash.to_attr_reader
+
+    hash_attr.something.should eq('like that')
+    hash_attr.name.should eq('hash_ninja')
+  end
+
+  it 'should work with symbol keys' do
+    hash = {:something => 'like that', :name => 'hash_ninja'}
+    hash_attr = hash.to_attr_reader
+
+    hash_attr.something.should eq('like that')
+    hash_attr.name.should eq('hash_ninja')
+  end
+
+  it 'should work with nested hash' do
+    hash = {
+        :something => 'like that',
+        :nested => {
+            :name => 'hash_ninja',
+            :since => 2012
+        }
+    }
+    hash_attr = hash.to_attr_reader
+
+    hash_attr.something.should eq('like that')
+    hash_attr.nested.name.should eq('hash_ninja')
+    hash_attr.nested.since.should eq(2012)
+  end
+
+  it 'should work with keys which contains whitespace' do
+    hash = {'contains whitespace' => 'like that'}
+    hash_attr = hash.to_attr_reader
+
+    hash_attr.contains_whitespace.should eq(nil)
+  end
+
+  it 'should work with string keys' do
+    hash = {'something' => 'like that', 'name' => 'hash_ninja'}
+    hash_attr = hash.to_attr_reader
+
+    hash_attr.something.should eq('like that')
+    hash_attr.name.should eq('hash_ninja')
+  end
+
+  it 'should work with array' do
+    hash = {
+        'str_array' => ['a', 'b', 'c'],
+        'hash_array' => [{:a => 1}, {:aa => 1, :bb => 2}],
+        'nested' => {'array' => [1, 2, 3]}
+    }
+    hash_attr = hash.to_attr_reader
+
+    hash_attr.str_array.should eq(['a', 'b', 'c'])
+    hash_attr.hash_array.should eq([{:a => 1}, {:aa => 1, :bb => 2}])
+    hash_attr.nested.array.should eq([1, 2, 3])
+  end
+
+end

data/spec/hash_ninja/usage_spec.rb

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+require 'active_support'
+require 'hash_ninja'
+
+describe HashNinja do
+
+  it 'should work with the Google+ API example data' do
+    google_plus_api_example = <<JSON
+{
+  "kind": "plus#person",
+  "id": "118051310819094153327",
+  "displayName": "Chirag Shah",
+  "url": "https://plus.google.com/118051310819094153327",
+  "image": {
+    "url": "https://lh5.googleusercontent.com/-XnZDEoiF09Y/AAAAAAAAAAI/AAAAAAAAYCI/7fow4a2UTMU/photo.jpg"
+  }
+}
+JSON
+
+    hash = ActiveSupport::JSON.decode(google_plus_api_example)
+    hash.activate!
+
+    hash.recursively_underscore_keys!
+    hash['kind'].should eq('plus#person')
+    hash['id'].should eq('118051310819094153327')
+    hash['display_name'].should eq('Chirag Shah')
+    hash['url'].should eq('https://plus.google.com/118051310819094153327')
+    hash['image']['url'].should eq('https://lh5.googleusercontent.com/-XnZDEoiF09Y/AAAAAAAAAAI/AAAAAAAAYCI/7fow4a2UTMU/photo.jpg')
+
+    hash.recursively_symbolize_keys!
+    hash[:kind].should eq('plus#person')
+    hash[:id].should eq('118051310819094153327')
+    hash[:display_name].should eq('Chirag Shah')
+    hash[:url].should eq('https://plus.google.com/118051310819094153327')
+    hash[:image][:url].should eq('https://lh5.googleusercontent.com/-XnZDEoiF09Y/AAAAAAAAAAI/AAAAAAAAYCI/7fow4a2UTMU/photo.jpg')
+
+    hash_attr = hash.to_attr_reader
+    hash_attr.kind.should eq('plus#person')
+    hash_attr.id.should eq('118051310819094153327')
+    hash_attr.display_name.should eq('Chirag Shah')
+    hash_attr.url.should eq('https://plus.google.com/118051310819094153327')
+    hash_attr.image.url.should eq('https://lh5.googleusercontent.com/-XnZDEoiF09Y/AAAAAAAAAAI/AAAAAAAAYCI/7fow4a2UTMU/photo.jpg')
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: hash-ninja
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Kazuhiro Sera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hash toolkit for Ruby ninja
+email:
+- seratch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- hashninja.gemspec
+- lib/hash_ninja.rb
+- lib/hash_ninja/active_hash.rb
+- lib/hash_ninja/core_ext.rb
+- lib/hash_ninja/hash_attr_reader.rb
+- lib/hash_ninja/version.rb
+- spec/hash_ninja/active_hash_spec.rb
+- spec/hash_ninja/core_ext_spec.rb
+- spec/hash_ninja/hash_attr_reader_spec.rb
+- spec/hash_ninja/usage_spec.rb
+homepage: https://github.com/seratch/hash-ninja
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Hash toolkit for Ruby ninja
+test_files:
+- spec/hash_ninja/active_hash_spec.rb
+- spec/hash_ninja/core_ext_spec.rb
+- spec/hash_ninja/hash_attr_reader_spec.rb
+- spec/hash_ninja/usage_spec.rb