hash_symbolizer 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hash_symbolizer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Anjali Shenoy
+
+MIT License
+
+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/README.md

@@ -0,0 +1,44 @@
+# HashSymbolizer
+
+Extends ActiveSupport's symbolize_keys to recursively symbolize all keys in a gem. By default, it is fully backwards compatible with ActiveSupport's symbolize_keys method. If the recursive flag is set to true however and it recursively symbolizes any values which are hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hash_symbolizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_symbolizer
+
+## Usage
+
+gem install hash_symbolizer 
+or
+include it in your Gemfile and then run bundle install.
+
+Examples:
+
+{"a" => {"b" => 1}}.symbolize_keys = {:a => {"b" => 1}}
+
+{"a" => {"b" => 1}}.symbolize_keys(true) = {:a => {:b => 1}}
+
+{"a" => {"b" => 1}}.symbolize_keys! = {:a => {"b" => 1}}
+
+{"a" => {"b" => 1}}.symbolize_keys!(true) = {:a => {:b => 1}}
+
+Works on Ruby 1.9.2-p290, 1.9.3-p125, ActiveSupport version 3.2.2 as of now.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :Test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.warning = true
+  t.verbose = true
+end

data/hash_symbolizer.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hash_symbolizer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Anjali Shenoy"]
+  gem.email         = ["anjshenoy@gmail.com"]
+  gem.description   = %q{Extends ActiveSupport's symbolize_keys to recursively symbolize keys at all levels in a Hash}
+  gem.summary       = %q{Extends ActiveSupport's symbolize_keys to recursively symbolize all keys in a gem. By default, it is fully backwards compatible with ActiveSupport's symbolize_keys method. If the recursive flag is set to true however and it recursively symbolizes any values which are hashes.}
+  gem.homepage      = "http://github.com/anjshenoy/hash_symbolizer"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hash_symbolizer"
+  gem.require_paths = ["lib"]
+  gem.version       = HashSymbolizer::VERSION
+
+  gem.add_dependency "rake"
+  gem.add_dependency "activesupport"
+end

data/lib/hash_symbolizer.rb

@@ -0,0 +1,5 @@
+require "hash_symbolizer/version"
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/indifferent_access'
+require "hash_symbolizer/core_ext/hash"
+require "hash_symbolizer/core_ext/hash_with_indifferent_access"

data/lib/hash_symbolizer/core_ext/hash.rb

@@ -0,0 +1,23 @@
+class Hash
+  # Return a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+.
+  # If recursive is set to true, then keys at all levels will be symbolized.
+#  undef :symbolize_keys
+#  undef :symbolize_keys!
+
+  def symbolize_keys(recursive = false)
+    dup.symbolize_keys!(recursive)
+  end
+
+  # Destructively convert all keys to symbols, as long as they respond
+  # to +to_sym+.
+  # If recursive is set to true, then keys at all levels will be symbolized.
+  def symbolize_keys!(recursive = false)
+    keys.each do |key|
+      value = delete(key)
+      key = key.respond_to?(:to_sym) ? key.to_sym : key
+      self[key] = (recursive && value.is_a?(Hash)) ? value.dup.symbolize_keys!(recursive) : value
+    end
+    self
+  end
+end

data/lib/hash_symbolizer/core_ext/hash_with_indifferent_access.rb

@@ -0,0 +1,8 @@
+class HashWithIndifferentAccess < Hash
+
+  undef :symbolize_keys
+  # If recursive is set to true, keys at all levels will be symbolized
+  def symbolize_keys(recursive = false)
+    to_hash.symbolize_keys(recursive)
+  end
+end

data/lib/hash_symbolizer/version.rb

@@ -0,0 +1,3 @@
+module HashSymbolizer
+  VERSION = "1.0.0"
+end

data/test/lib/hash_symbolizer/hash_ext_test.rb

@@ -0,0 +1,123 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../../lib/hash_symbolizer")
+require 'test/unit'
+
+class HashExtTest < Test::Unit::TestCase
+  def setup
+    @strings = { 'a' => 1, 'b' => 2 }
+    @symbols = { :a  => 1, :b  => 2 }
+    @mixed   = { :a  => 1, 'b' => 2 }
+    @fixnums = {  0  => 1,  1  => 2 }
+    @illegal_symbols = { [] => 3 }
+    @nested_hash = { 'a' => {'b' => 2} }
+    @nested_hash_first_level_symbolized = { :a => { 'b' => 2 } }
+    @nested_hash_all_keys_symbolized = { :a => { :b => 2 } }
+  end
+
+  def test_methods
+    h = {}
+    assert_respond_to h, :symbolize_keys
+    assert_respond_to h, :symbolize_keys!
+    assert_respond_to h, :to_options
+    assert_respond_to h, :to_options!
+  end
+
+  def test_symbolize_keys
+    assert_equal @symbols, @symbols.symbolize_keys
+    assert_equal @symbols, @strings.symbolize_keys
+    assert_equal @symbols, @mixed.symbolize_keys
+    assert_equal @nested_hash_first_level_symbolized, @nested_hash.symbolize_keys
+  end
+
+  def test_symbolize_keys_with_recursive_option
+    assert_equal @symbols, @symbols.symbolize_keys(true)
+    assert_equal @symbols, @strings.symbolize_keys(true)
+    assert_equal @symbols, @mixed.symbolize_keys(true)
+    assert_equal @nested_hash_all_keys_symbolized, @nested_hash.symbolize_keys(true)
+  end
+
+  def test_symbolize_keys!
+    assert_equal @symbols, @symbols.dup.symbolize_keys!
+    assert_equal @symbols, @strings.dup.symbolize_keys!
+    assert_equal @symbols, @mixed.dup.symbolize_keys!
+    assert_equal @nested_hash_first_level_symbolized, @nested_hash.symbolize_keys!
+  end
+
+  def test_symbolize_keys_bang_with_recursive_option
+    assert_equal @symbols, @symbols.dup.symbolize_keys!(true)
+    assert_equal @symbols, @strings.dup.symbolize_keys!(true)
+    assert_equal @symbols, @mixed.dup.symbolize_keys!(true)
+    assert_equal @nested_hash_all_keys_symbolized, @nested_hash.symbolize_keys!(true)
+  end
+
+  def test_symbolize_keys_preserves_keys_that_cant_be_symbolized
+    assert_equal @illegal_symbols, @illegal_symbols.symbolize_keys
+    assert_equal @illegal_symbols, @illegal_symbols.dup.symbolize_keys!
+  end
+
+  def test_symbolize_keys_with_recursive_option_preserves_keys_that_cant_be_symbolized
+    assert_equal @illegal_symbols, @illegal_symbols.symbolize_keys(true)
+    assert_equal @illegal_symbols, @illegal_symbols.dup.symbolize_keys!(true)
+  end
+
+  def test_symbolize_keys_preserves_fixnum_keys
+    assert_equal @fixnums, @fixnums.symbolize_keys
+    assert_equal @fixnums, @fixnums.dup.symbolize_keys!
+  end
+
+  def test_symbolize_keys_with_recursive_option_preserves_fixnum_keys
+    assert_equal @fixnums, @fixnums.symbolize_keys(true)
+    assert_equal @fixnums, @fixnums.dup.symbolize_keys!(true)
+  end
+
+  def test_symbolize_keys_for_hash_with_indifferent_access
+    assert_instance_of Hash, @symbols.with_indifferent_access.symbolize_keys
+    assert_equal @symbols, @symbols.with_indifferent_access.symbolize_keys
+    assert_equal @symbols, @strings.with_indifferent_access.symbolize_keys
+    assert_equal @symbols, @mixed.with_indifferent_access.symbolize_keys
+  end
+
+  def test_symbolize_keys_with_recursive_option_for_hash_with_indifferent_access
+    assert_instance_of Hash, @symbols.with_indifferent_access.symbolize_keys(true)
+    assert_equal @symbols, @symbols.with_indifferent_access.symbolize_keys(true)
+    assert_equal @symbols, @strings.with_indifferent_access.symbolize_keys(true)
+    assert_equal @symbols, @mixed.with_indifferent_access.symbolize_keys(true)
+    assert_equal @nested_hash_all_keys_symbolized, @nested_hash.symbolize_keys(true)
+  end
+
+  def test_symbolize_keys_bang_for_hash_with_indifferent_access
+    assert_raise(NoMethodError) { @symbols.with_indifferent_access.dup.symbolize_keys! }
+    assert_raise(NoMethodError) { @strings.with_indifferent_access.dup.symbolize_keys! }
+    assert_raise(NoMethodError) { @mixed.with_indifferent_access.dup.symbolize_keys! }
+    assert_raise(NoMethodError) { @nested_hash.with_indifferent_access.dup.symbolize_keys! }
+  end
+
+  def test_symbolize_keys_bang_with_recursive_option_for_hash_with_indifferent_access
+    assert_raise(NoMethodError) { @symbols.with_indifferent_access.dup.symbolize_keys!(true) }
+    assert_raise(NoMethodError) { @strings.with_indifferent_access.dup.symbolize_keys!(true)  }
+    assert_raise(NoMethodError) { @mixed.with_indifferent_access.dup.symbolize_keys!(true) }
+    assert_raise(NoMethodError) { @nested_hash.with_indifferent_access.dup.symbolize_keys!(true) }
+  end
+
+  def test_symbolize_keys_preserves_keys_that_cant_be_symbolized_for_hash_with_indifferent_access
+    assert_equal @illegal_symbols, @illegal_symbols.with_indifferent_access.symbolize_keys
+    assert_raise(NoMethodError) { @illegal_symbols.with_indifferent_access.dup.symbolize_keys! }
+  end
+
+  def test_symbolize_keys_with_recursive_option_preserves_keys_that_cant_be_symbolized_for_hash_with_indifferent_access
+    assert_equal @illegal_symbols, @illegal_symbols.with_indifferent_access.symbolize_keys(true)
+    assert_raise(NoMethodError) { @illegal_symbols.with_indifferent_access.dup.symbolize_keys!(true) }
+  end
+
+  def test_symbolize_keys_preserves_fixnum_keys_for_hash_with_indifferent_access
+    assert_equal @fixnums, @fixnums.with_indifferent_access.symbolize_keys
+    assert_raise(NoMethodError) { @fixnums.with_indifferent_access.dup.symbolize_keys! }
+  end
+
+  def test_symbolize_keys_with_recursive_option_preserves_fixnum_keys_for_hash_with_indifferent_access
+    assert_equal @fixnums, @fixnums.with_indifferent_access.symbolize_keys(true)
+    assert_raise(NoMethodError) { @fixnums.with_indifferent_access.dup.symbolize_keys!(true) }
+  end
+
+
+end
+

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: hash_symbolizer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Anjali Shenoy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70148863629780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70148863629780
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70148863629360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70148863629360
+description: Extends ActiveSupport's symbolize_keys to recursively symbolize keys
+  at all levels in a Hash
+email:
+- anjshenoy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hash_symbolizer.gemspec
+- lib/hash_symbolizer.rb
+- lib/hash_symbolizer/core_ext/hash.rb
+- lib/hash_symbolizer/core_ext/hash_with_indifferent_access.rb
+- lib/hash_symbolizer/version.rb
+- test/lib/hash_symbolizer/hash_ext_test.rb
+homepage: http://github.com/anjshenoy/hash_symbolizer
+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.6
+signing_key: 
+specification_version: 3
+summary: Extends ActiveSupport's symbolize_keys to recursively symbolize all keys
+  in a gem. By default, it is fully backwards compatible with ActiveSupport's symbolize_keys
+  method. If the recursive flag is set to true however and it recursively symbolizes
+  any values which are hashes.
+test_files:
+- test/lib/hash_symbolizer/hash_ext_test.rb