Module: Hashie::Extensions::IndifferentAccess

Defined in:
lib/hashie/extensions/indifferent_access.rb

Overview

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.

Examples:

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'

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object


26
27
28
29
30
31
32
33
34
35
36
37
38
39
# 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

.inject(hash) ⇒ Object

Injects indifferent access into a duplicate of the hash provided. See #inject!


51
52
53
# File 'lib/hashie/extensions/indifferent_access.rb', line 51

def self.inject(hash)
  inject!(hash.dup)
end

.inject!(hash) ⇒ Object

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.


44
45
46
47
# File 'lib/hashie/extensions/indifferent_access.rb', line 44

def self.inject!(hash)
  (class << hash; self; end).send :include, IndifferentAccess
  hash.convert!
end

Instance Method Details

#convert!Object

Iterates through the keys and values, reconverting them to their proper indifferent state. Used when IndifferentAccess is injecting itself into member hashes.


62
63
64
65
66
67
# 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

#convert_key(key) ⇒ Object


55
56
57
# File 'lib/hashie/extensions/indifferent_access.rb', line 55

def convert_key(key)
  key.to_s
end

#convert_value(value) ⇒ Object


69
70
71
72
73
74
75
76
77
# 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

#indifferent_access?Boolean


97
# File 'lib/hashie/extensions/indifferent_access.rb', line 97

def indifferent_access?; true end

#indifferent_default(key = nil) ⇒ Object


79
80
81
82
# 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

#indifferent_delete(key) ⇒ Object


93
# File 'lib/hashie/extensions/indifferent_access.rb', line 93

def indifferent_delete(key);         regular_delete convert_key(key)                       end

#indifferent_fetch(key, *args) ⇒ Object


92
# File 'lib/hashie/extensions/indifferent_access.rb', line 92

def indifferent_fetch(key, *args);   regular_fetch  convert_key(key), *args                end

#indifferent_key?(key) ⇒ Boolean


94
# File 'lib/hashie/extensions/indifferent_access.rb', line 94

def indifferent_key?(key);           regular_key?   convert_key(key)                       end

#indifferent_replace(other_hash) ⇒ Object


99
100
101
102
103
# 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

#indifferent_update(other_hash) ⇒ Object


84
85
86
87
88
89
# 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

#indifferent_values_at(*indices) ⇒ Object


95
# File 'lib/hashie/extensions/indifferent_access.rb', line 95

def indifferent_values_at(*indices); indices.map{|i| self[i] }                             end

#indifferent_writer(key, value) ⇒ Object


91
# File 'lib/hashie/extensions/indifferent_access.rb', line 91

def indifferent_writer(key, value);  regular_writer convert_key(key), convert_value(value) end