insensitive_hash 0.3.0 → 0.3.1

data/CHANGELOG.markdown

@@ -1,3 +1,6 @@
+### 0.3.1
+* Supports custom key encoder
+
 ### 0.3.0
 * "Inherited insensitivity" had been a great source of confusion,
   as it stores transformed version of the given Array of Hash.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Junegunn Choi
+Copyright (c) 2013 Junegunn Choi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -8,10 +8,10 @@ Installation
 gem install insensitive_hash
 ```
 
-Examples
---------
+Instantiation
+-------------
 
-### Instantiation
+### Hash#insensitive
 
 ```ruby
 require 'insensitive_hash'
@@ -24,7 +24,7 @@ ih['ABC']         # 1
 ih[:Hello_World]  # true
 ```
 
-### Instantiation without monkey-patching Hash
+### Without monkey-patching Hash
 
 If you don't like to have Hash#insensitive method, `require 'insensitive_hash/minimal'`
 
@@ -49,7 +49,9 @@ h = ih.sensitive
 h = ih.to_hash
 ```
 
-### Basic usage
+Basic usage
+-----------
+
 ```ruby
 ih = {:abc => 1, 'DEF' => 2}.insensitive
 
@@ -71,7 +73,8 @@ ih.delete :Abc     # 10
 ih.keys            # ['DEF']
 ```
 
-### "Inherited insensitivity"
+Inherited insensitivity
+-----------------------
 
 When InsensitiveHash is built from another Hash,
 descendant Hash values are recursively converted to be insensitive
@@ -86,20 +89,24 @@ ih = {:one => [ [ [ { :a => { :b => { :c => 'd' } } } ] ] ]}.insensitive
 ih['one'].first.first.first['A']['b'][:C]  # 'd'
 ```
 
-Once InsensitiveHash is initialized, you can convert its descendant Hash values by
-building a new InsensitiveHash from it.
+However, once InsensitiveHash is initialized,
+descendant Hashes are not automatically converted.
 
 ```ruby
 ih = {}.insensitive
 ih[:abc] = { :def => true }
 
 ih['ABC']['DEF']     # nil
+```
+
+Simply build a new InsensitiveHash again if you need recursive conversion.
 
+```ruby
 ih2 = ih.insensitive
 ih2['ABC']['DEF']    # true
 ```
 
-### Processing case-insensitive YAML input
+### Example: Processing case-insensitive YAML input
 ```ruby
 db = YAML.load(File.read 'database.yml').insensitive
 
@@ -108,7 +115,41 @@ db['Development']['ADAPTER']
 db[:production][:adapter]
 ```
 
-### Enabling key-clash detection (Safe mode)
+Customizing insensitivity
+-------------------------
+
+You can provide a Proc object as the key encoder which determines the level of insensitivity.
+
+### Default encoder
+
+The default encoder is as follows.
+
+```ruby
+InsensitiveHash::DEFAULT_ENCODER =
+  proc { |key|
+    case key
+    when String, Symbol
+      key.to_s.downcase.gsub(' ', '_')
+    else
+      key
+    end
+  }
+```
+
+### Encoder examples
+
+```ruby
+h1 = {}.insensitive(:encoder => proc { |key| key.to_s })
+h2 = {}.insensitive(:encoder => proc { |key| key.to_s.downcase })
+h3 = {}.insensitive(:encoder => proc { |key| key.to_s.downcase.gsub(/\s+/, '_') })
+
+# Without `insensitive` method
+h4 = InsensitiveHash.new
+h4.encoder = proc { |key| key.to_s }
+```
+
+Enabling key-clash detection (Safe mode)
+----------------------------------------
 ```ruby
 ih = InsensitiveHash.new
 ih.safe = true
@@ -123,7 +164,7 @@ h['Hello World']  # 2
 ```
 
 ## Contributing to insensitive_hash
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -134,6 +175,5 @@ h['Hello World']  # 2
 
 ## Copyright
 
-Copyright (c) 2012 Junegunn Choi. See LICENSE.txt for
-further details.
+Copyright (c) 2013 Junegunn Choi. See LICENSE.txt for further details.
 

data/insensitive_hash.gemspec

@@ -19,7 +19,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
   s.add_development_dependency "test-unit", ">= 2.3.0"
-  # s.add_runtime_dependency "rest-client"
 end

data/lib/insensitive_hash.rb

@@ -2,10 +2,14 @@ require 'insensitive_hash/version'
 require 'insensitive_hash/insensitive_hash'
 
 class Hash
+  # @param [Hash] options Options
+  # @option options [Boolean] :safe Whether to detect key clash on merge
+  # @option options [Proc] :encoder Key encoding Proc
   # @return [InsensitiveHash]
   def insensitive options = {}
     InsensitiveHash[self].tap do |ih|
       ih.safe         = options[:safe] if options.has_key?(:safe)
+      ih.encoder      = options[:encoder] if options.has_key?(:encoder)
       ih.default      = self.default
       ih.default_proc = self.default_proc if self.default_proc
     end

data/lib/insensitive_hash/insensitive_hash.rb

@@ -1,7 +1,21 @@
+# @author Junegunn Choi <junegunn.c@gmail.com>
+# @!attribute [r] encoder
+#   @return [Proc] Key encoding Proc
 class InsensitiveHash < Hash
+  attr_reader :encoder
+
   class KeyClashError < Exception
   end
 
+  DEFAULT_ENCODER = proc { |key|
+    case key
+    when String, Symbol
+      key.to_s.downcase.gsub(' ', '_')
+    else
+      key
+    end
+  }
+
   def initialize default = nil, &block
     if block_given?
       raise ArgumentError.new('wrong number of arguments') unless default.nil?
@@ -10,12 +24,13 @@ class InsensitiveHash < Hash
       super
     end
 
-    @key_map    = {}
-    @safe       = false
+    @key_map = {}
+    @safe    = false
+    @encoder = DEFAULT_ENCODER
   end
 
   # Sets whether to detect key clashes
-  # @param [Boolean] 
+  # @param [Boolean]
   # @return [Boolean]
   def safe= s
     raise ArgumentError.new("Neither true nor false") unless [true, false].include?(s)
@@ -26,7 +41,22 @@ class InsensitiveHash < Hash
   def safe?
     @safe
   end
-  
+
+  # @param [Proc] prc Key encoding Proc
+  # @return [Proc]
+  def encoder= prc
+    raise ArgumentError, "Proc object required" unless prc.is_a?(Proc)
+
+    kvs = to_a
+    clear
+    @encoder = prc
+    kvs.each do |pair|
+      store *pair
+    end
+
+    prc
+  end
+
   # Returns a normal, sensitive Hash
   # @return [Hash]
   def to_hash
@@ -87,6 +117,7 @@ class InsensitiveHash < Hash
     super other
 
     self.safe = other.respond_to?(:safe?) ? other.safe? : safe?
+    self.encoder = other.respond_to?(:encoder) ? other.encoder : DEFAULT_ENCODER
 
     @key_map.clear
     self.each do |k, v|
@@ -151,12 +182,7 @@ private
   end
 
   def encode key
-    case key
-    when String, Symbol
-      key.to_s.downcase.gsub(' ', '_')
-    else
-      key
-    end
+    @encoder.call key
   end
 
   def detect_clash hash

data/lib/insensitive_hash/version.rb

@@ -1,3 +1,3 @@
 class InsensitiveHash < Hash
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/test_insensitive_hash.rb

@@ -528,5 +528,53 @@ class TestInsensitiveHash < Test::Unit::TestCase
 
     assert_equal :value, a[:key]
   end
+
+  def test_encoder
+    # With custom encoder
+    a = {}.insensitive(:encoder => prc = proc { |key| key.to_s.downcase })
+    a['1'] = 'one'
+    assert_equal 'one', a[1]
+    assert_equal prc, a.encoder
+
+    a['hello world'] = true
+    assert_equal true, a['HELLO WORLD']
+    assert_equal nil,  a[:HELLO_WORLD]
+
+    # Update encoder
+    a.encoder = proc { |key| key.to_s.gsub(' ', '_').downcase }
+    assert_equal true, a[:HELLO_WORLD]
+
+    # Update again
+    a.encoder = proc { |key| key.to_s }
+    assert_equal true, a[:"hello world"]
+    assert_equal nil, a['HELLO WORLD']
+    assert_equal nil, a[:hello_world]
+    assert_equal nil, a[:HELLO_WORLD]
+  end
+
+  def test_encoder_invalid_type
+    assert_raise(ArgumentError) {
+      {}.insensitive(:encoder => 1)
+    }
+    assert_raise(ArgumentError) {
+      h = InsensitiveHash.new
+      h.encoder = 1
+    }
+  end
+
+  def test_encoder_replace
+    a = {}.insensitive(:encoder => proc { |key| key })
+    b = {}.insensitive(:encoder => proc { |key| key.to_s })
+    a[:key] = b[:key] = 1
+    assert_equal 1, a[:key]
+    assert_equal 1, b[:key]
+    assert_nil a['key']
+    assert_equal 1, b['key']
+
+    a.replace b
+    assert_equal 1, a['key']
+    a[:key2] = 2
+    assert_equal 2, a['key2']
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: insensitive_hash
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-28 00:00:00.000000000 Z
+date: 2013-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -72,3 +72,4 @@ specification_version: 3
 summary: Case-insensitive Ruby Hash
 test_files:
 - test/test_insensitive_hash.rb
+has_rdoc: