advanced_hash_keys 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7946b652b528ba73093fe49bb542cc51c432df8
+  data.tar.gz: 66bf4356ecb9ecd1439004e09605902e81496696
+SHA512:
+  metadata.gz: 9a73129e04f45ac5d417bcbf2effa063fe33da919621f24c22d5cd8413fcf161220551276f5d635864fd2bfd8ded9e39abc09a07edc8c67b7838b5fddfd3522f
+  data.tar.gz: c9644b15501cb035e5dc31298fda2e36a409e67f0e94cf8113763ba7a295d8fbac505aa10e17d544c92cff95f247ffea144b66c6617ea8a78291c7695343ba82

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# bundler
+vendor/
+

data/.rubocop.yml

@@ -0,0 +1,87 @@
+# This file overrides https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+AllCops:
+  Include:
+    - Rakefile
+    - advanced_hash_keys.gemspec
+  Exclude:
+    - vendor/**
+
+# Limit lines to 80 characters.
+LineLength:
+  Enabled: false
+
+# Avoid methods longer than 10 lines of code
+MethodLength:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+# Favor modifier if/unless usage when you have a single-line body.
+IfUnlessModifier:
+  Enabled: false
+
+# Favor modifier while/until usage when you have a single-line body.
+WhileUntilModifier:
+  Enabled: false
+
+# Preferred collection methods.
+CollectionMethods:
+  Enabled: false
+
+# Don't interpolate global, instance and class variables directly in strings.
+VariableInterpolation:
+  Enabled: false
+
+# Use only ascii symbols in comments.
+AsciiComments:
+  Enabled: false
+
+CaseEquality:
+  Description: 'Avoid explicit use of the case equality operator(===).'
+  Enabled: false
+
+SignalException:
+  Description: 'Checks for proper usage of fail and raise.'
+  Enabled: false
+
+SymbolArray:
+  Description: 'Use %i or %I for arrays of symbols.'
+  Enabled: true
+
+CyclomaticComplexity:
+  Max: 10
+
+Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+AccessModifierIndentation:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+SingleLineBlockParams:
+  Description: 'Enforces the names of some block params.'
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+HashSyntax:
+  Description: >-
+                 Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
+                 { :a => 1, :b => 2 }.
+  Enabled: false
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    advanced_hash_keys (2.0.0)
+      activesupport
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    ast (2.0.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.3)
+    parser (2.1.9)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rake (10.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rubocop (0.20.1)
+      json (>= 1.7.7, < 2)
+      parser (~> 2.1.7)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.4.2)
+    slop (3.5.0)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  advanced_hash_keys!
+  rspec
+  rubocop

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,61 @@
+# AdvancedHashKeys
+
+Extends ActiveSupport's symbolize_keys/stringify_keys to recursively convert all keys in a gem. By default, it is fully backwards compatible with ActiveSupport's symbolize_keys/stringify_keys method. If the recursive flag is set to true however and it recursively converts any values which are hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'advanced_hash_keys'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install advanced_hash_keys
+
+## Usage
+
+gem install advanced_hash_keys
+or
+include it in your Gemfile and then run bundle install.
+
+Works on Ruby 2.1.1p76, ActiveSupport version 4.1.0 as of now.
+
+### symbolize_keys 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}}
+
+### stringify_keys Examples:
+
+{:a => {:b => 1}}.stringify_keys = {'a' => {:b => 1}}
+
+{:a => {:b => 1}}.stringify_keys(true) = {'a' => {'b' => 1}}
+
+{:a => {:b => 1}}.stringify_keys! = {'a' => {:b => 1}}
+
+{:a => {:b => 1}}.stringify_keys!(true) = {'a' => {'b' => 1}}
+
+
+## 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. Check rspec(`bundle exec rake spec`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+
+## Special Thanks
+
+* hash_symoblizer (https://github.com/anjshenoy/hash_symbolizer)
+** symbolize_keys(true)'s original repository. 

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/advanded_hash_keys_spec.rb'
+end

data/advanced_hash_keys.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/advanced_hash_keys/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Yuichi UEMURA']
+  gem.email         = ['yuichi.u@gmail.com']
+  gem.description   = %q(Extends ActiveSupport's symbolize_keys / stringifier_keys to recursively symbolize keys at all levels in a Hash / Array)
+  gem.summary       = %q(Extends ActiveSupport's symbolize_keys to recursively symbolize / stringifier all keys in a gem. By default, it is fully backwards compatible with ActiveSupport's symbolize_keys/stringfier_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/u-ichi/advanced_hash_keys'
+
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'advanced_hash_keys'
+  gem.require_paths = ['lib']
+  gem.version       = AdvancedHashKeys::VERSION
+
+  gem.add_dependency 'rake'
+  gem.add_dependency 'activesupport'
+  gem.add_development_dependency('rubocop')
+  gem.add_development_dependency('rspec')
+end

data/lib/advanced_hash_keys.rb

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

data/lib/advanced_hash_keys/core_ext/hash.rb

@@ -0,0 +1,49 @@
+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.
+  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
+      if value.is_a?(Array)
+        value = value.map do |sub_value|
+          (recursive && sub_value.is_a?(Hash)) ? sub_value.dup.symbolize_keys!(recursive) : sub_value
+        end
+      end
+      self[key] = (recursive && value.is_a?(Hash)) ? value.dup.symbolize_keys!(recursive) : value
+    end
+    self
+  end
+
+  # Return a new hash with all keys converted to symbols, as long as
+  # they respond to +to_s+.
+  # If recursive is set to true, then keys at all levels will be stringified.
+  def stringify_keys(recursive = false)
+    dup.stringify_keys!(recursive)
+  end
+
+  # Destructively convert all keys to strings, as long as they respond
+  # to +to_sym+.
+  # If recursive is set to true, then keys at all levels will be stringified.
+  def stringify_keys!(recursive = false)
+    keys.each do |key|
+      value = delete(key)
+      key = key.respond_to?(:to_s) ? key.to_s : key
+      if value.is_a?(Array)
+        value = value.map do |sub_value|
+          (recursive && sub_value.is_a?(Hash)) ? sub_value.dup.stringify_keys!(recursive) : sub_value
+        end
+      end
+      self[key] = (recursive && value.is_a?(Hash)) ? value.dup.stringify_keys!(recursive) : value
+    end
+    self
+  end
+end

data/lib/advanced_hash_keys/core_ext/hash_with_indifferent_access.rb

@@ -0,0 +1,13 @@
+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
+
+  undef :stringify_keys
+  # If recursive is set to true, keys at all levels will be symbolized
+  def stringify_keys(recursive = false)
+    to_hash.stringify_keys(recursive)
+  end
+end

data/lib/advanced_hash_keys/version.rb

@@ -0,0 +1,3 @@
+module AdvancedHashKeys
+  VERSION = '1.0.0'
+end

data/spec/advanded_hash_keys_spec.rb

@@ -0,0 +1,173 @@
+require 'rspec'
+
+RSpec.configure do |c|
+  c.color     = true
+  c.tty       = true
+end
+
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/advanced_hash_keys")
+
+describe Hash do
+  before do
+    @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 }, 'c' => [{ 'd' => 3 }] }
+    @nested_hash_first_level_symbolized = { :a => { 'b' => 2 }, :c => [{ 'd' => 3 }] }
+    @nested_hash_all_keys_symbolized = { :a => { :b => 2 }, :c => [{ :d => 3 }] }
+    @nested_hash_first_level_stringfied = { 'a' => { 'b' => 2 }, 'c' => [{ 'd' => 3 }] }
+    @nested_hash_all_keys_stringfied = { 'a' => { 'b' => 2 }, 'c' => [{ 'd' => 3 }] }
+  end
+
+  describe 'symolize_keys' do
+    subject { base_param.symbolize_keys(input_param) }
+    context 'input_param is true' do
+      let(:input_param) { true }
+      context 'base_param is string key' do
+        let(:base_param)  { @strings }
+
+        it 'agrees with symbols' do
+          expect(subject).to eq @symbols
+        end
+      end
+
+      context 'base_param is mixed key' do
+        let(:base_param)  { @mixed }
+
+        it 'agrees with symbols' do
+          expect(subject).to eq @symbols
+        end
+      end
+
+      context 'base_param is nested_hash' do
+        let(:base_param)  { @nested_hash }
+
+        it 'agrees with nested hash all keys symbolized' do
+          expect(subject).to eq @nested_hash_all_keys_symbolized
+        end
+      end
+
+      context 'base_param is illegal_symbol' do
+        let(:base_param) { @illegal_symbol }
+
+        it 'raise NoMethodError' do
+          expect { subject }.to raise_error NoMethodError
+        end
+      end
+    end
+
+    context 'input_param is false' do
+      let(:input_param) { false }
+
+      context 'base_param is string key' do
+        let(:base_param)  { @strings }
+
+        it 'agrees with symbols' do
+          expect(subject).to eq @symbols
+        end
+      end
+
+      context 'base_param is mixed key' do
+        let(:base_param)  { @mixed }
+
+        it 'agrees with symbols' do
+          expect(subject).to eq @symbols
+        end
+      end
+
+      context 'base_param is nested_hash' do
+        let(:base_param)  { @nested_hash }
+
+        it 'agrees with nested hash first level symbolized' do
+          expect(subject).to eq @nested_hash_first_level_symbolized
+        end
+      end
+
+      context 'base_param is illegal_symbol' do
+        let(:base_param) { @illegal_symbol }
+
+        it 'raise NoMethodError' do
+          expect { subject }.to raise_error NoMethodError
+        end
+      end
+    end
+  end
+
+  describe 'stringify_keys' do
+    subject { base_param.stringify_keys(input_param) }
+
+    context 'input_param is true' do
+      let(:input_param) { true }
+
+      context 'base_param is symolized key' do
+        let(:base_param)  { @symbols }
+
+        it 'agrees with string' do
+          expect(subject).to eq @strings
+        end
+      end
+
+      context 'base_param is mixed key' do
+        let(:base_param)  { @mixed }
+
+        it 'agrees with symbols' do
+          expect(subject).to eq @strings
+        end
+      end
+
+      context 'base_param is nested_hash' do
+        let(:base_param)  { @nested_hash }
+
+        it 'agrees with nested hash all keys stringified' do
+          expect(subject).to eq @nested_hash_all_keys_stringfied
+        end
+      end
+
+      context 'base_param is illegal_symbol' do
+        let(:base_param) { @illegal_symbol }
+
+        it 'raise NoMethodError' do
+          expect { subject }.to raise_error NoMethodError
+        end
+      end
+    end
+
+    context 'input_param is false' do
+      let(:input_param) { false }
+
+      context 'base_param is symolized key' do
+        let(:base_param)  { @symbols }
+
+        it 'agrees with string' do
+          expect(subject).to eq @strings
+        end
+      end
+
+      context 'base_param is mixed key' do
+        let(:base_param)  { @mixed }
+
+        it 'agrees with symbols' do
+          expect(subject).to eq @strings
+        end
+      end
+
+      context 'base_param is nested_hash' do
+        let(:base_param)  { @nested_hash }
+
+        it 'agrees with nested hash first level stringified' do
+          expect(subject).to eq @nested_hash_first_level_stringfied
+        end
+      end
+
+      context 'base_param is illegal_symbol' do
+        let(:base_param) { @illegal_symbol }
+
+        it 'raise NoMethodError' do
+          expect { subject }.to raise_error NoMethodError
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: advanced_hash_keys
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yuichi UEMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends ActiveSupport's symbolize_keys / stringifier_keys to recursively
+  symbolize keys at all levels in a Hash / Array
+email:
+- yuichi.u@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- advanced_hash_keys.gemspec
+- lib/advanced_hash_keys.rb
+- lib/advanced_hash_keys/core_ext/hash.rb
+- lib/advanced_hash_keys/core_ext/hash_with_indifferent_access.rb
+- lib/advanced_hash_keys/version.rb
+- spec/advanded_hash_keys_spec.rb
+homepage: http://github.com/u-ichi/advanced_hash_keys
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Extends ActiveSupport's symbolize_keys to recursively symbolize / stringifier
+  all keys in a gem. By default, it is fully backwards compatible with ActiveSupport's
+  symbolize_keys/stringfier_keys method. If the recursive flag is set to true however
+  and it recursively symbolizes any values which are hashes.
+test_files:
+- spec/advanded_hash_keys_spec.rb