IndifferentAccess gives you the ability to not care whether your hash has string or symbol keys. Made famous in Rails for accessing query and POST parameters, this is a handy tool for making sure your hash has maximum utility.
One unique feature of this mixin is that it will recursively inject itself into sub-hash instances without modifying the actual class of the sub-hash.
@example
class MyHash < Hash include Hashie::Extensions::MergeInitializer include Hashie::Extensions::IndifferentAccess end h = MyHash.new(:foo => 'bar', 'baz' => 'blip') h['foo'] # => 'bar' h[:foo] # => 'bar' h[:baz] # => 'blip' h['baz'] # => 'blip'
# File lib/hashie/extensions/indifferent_access.rb, line 26 def self.included(base) base.class_eval do alias_method :regular_writer, :[]= alias_method :[]=, :indifferent_writer %w(default update replace fetch delete key? values_at).each do |m| alias_method "regular_#{m}", m alias_method m, "indifferent_#{m}" end %w(include? member? has_key?).each do |key_alias| alias_method key_alias, :indifferent_key? end end end
Injects indifferent access into a duplicate of the hash provided. See inject!
# File lib/hashie/extensions/indifferent_access.rb, line 51 def self.inject(hash) inject!(hash.dup) end
This will inject indifferent access into an instance of a hash without modifying the actual class. This is what allows IndifferentAccess to spread to sub-hashes.
# File lib/hashie/extensions/indifferent_access.rb, line 44 def self.inject!(hash) (class << hash; self; end).send :include, IndifferentAccess hash.convert! end
Iterates through the keys and values, reconverting them to their proper indifferent state. Used when IndifferentAccess is injecting itself into member hashes.
# File lib/hashie/extensions/indifferent_access.rb, line 62 def convert! keys.each do |k| regular_writer convert_key(k), convert_value(self.regular_delete(k)) end self end
# File lib/hashie/extensions/indifferent_access.rb, line 55 def convert_key(key) key.to_s end
# File lib/hashie/extensions/indifferent_access.rb, line 69 def convert_value(value) if hash_lacking_indifference?(value) IndifferentAccess.inject(value.dup) elsif value.is_a?(::Array) value.dup.replace(value.map { |e| convert_value(e) }) else value end end
# File lib/hashie/extensions/indifferent_access.rb, line 97 def indifferent_access?; true end
# File lib/hashie/extensions/indifferent_access.rb, line 79 def indifferent_default(key = nil) return self[convert_key(key)] if key?(key) regular_default(key) end
# File lib/hashie/extensions/indifferent_access.rb, line 93 def indifferent_delete(key); regular_delete convert_key(key) end
# File lib/hashie/extensions/indifferent_access.rb, line 92 def indifferent_fetch(key, *args); regular_fetch convert_key(key), *args end
# File lib/hashie/extensions/indifferent_access.rb, line 94 def indifferent_key?(key); regular_key? convert_key(key) end
# File lib/hashie/extensions/indifferent_access.rb, line 99 def indifferent_replace(other_hash) (keys - other_hash.keys).each { |key| delete(key) } other_hash.each { |key, value| self[key] = value } self end
# File lib/hashie/extensions/indifferent_access.rb, line 84 def indifferent_update(other_hash) return regular_update(other_hash) if hash_with_indifference?(other_hash) other_hash.each_pair do |k,v| self[k] = v end end
# File lib/hashie/extensions/indifferent_access.rb, line 95 def indifferent_values_at(*indices); indices.map{|i| self[i] } end
# File lib/hashie/extensions/indifferent_access.rb, line 91 def indifferent_writer(key, value); regular_writer convert_key(key), convert_value(value) end
# File lib/hashie/extensions/indifferent_access.rb, line 107 def hash_lacking_indifference?(other) other.is_a?(::Hash) && !(other.respond_to?(:indifferent_access?) && other.indifferent_access?) end
# File lib/hashie/extensions/indifferent_access.rb, line 113 def hash_with_indifference?(other) other.is_a?(::Hash) && other.respond_to?(:indifferent_access?) && other.indifferent_access? end