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
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/hashie/extensions/indifferent_access.rb', line 26

def self.included(base)
  Hashie::Extensions::Dash::IndifferentAccess.maybe_extend(base)

  base.class_eval do
    alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
    alias_method :[]=, :indifferent_writer
    alias_method :store, :indifferent_writer
    %w[default update replace fetch delete key? values_at].each do |m|
      alias_method "regular_#{m}", m unless method_defined?("regular_#{m}")
      alias_method m, "indifferent_#{m}"
    end

    %w[include? member? has_key?].each do |key_alias|
      alias_method key_alias, :indifferent_key?
    end

    class << self
      def [](*)
        super.convert!
      end

      def try_convert(*)
        (hash = super) && self[hash]
      end
    end
  end
end

.inject(hash) ⇒ Object

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


64
65
66
# File 'lib/hashie/extensions/indifferent_access.rb', line 64

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.


57
58
59
60
# File 'lib/hashie/extensions/indifferent_access.rb', line 57

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.


75
76
77
78
79
80
# File 'lib/hashie/extensions/indifferent_access.rb', line 75

def convert!
  keys.each do |k| # rubocop:disable Performance/HashEachMethods
    indifferent_writer k, regular_delete(k)
  end
  self
end

#convert_key(key) ⇒ Object


68
69
70
# File 'lib/hashie/extensions/indifferent_access.rb', line 68

def convert_key(key)
  key.to_s
end

#indifferent_access?Boolean

Returns:

  • (Boolean)

124
125
126
# File 'lib/hashie/extensions/indifferent_access.rb', line 124

def indifferent_access?
  true
end

#indifferent_default(key = nil) ⇒ Object


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

def indifferent_default(key = nil)
  return self[convert_key(key)] if key?(key)
  regular_default(key)
end

#indifferent_delete(key) ⇒ Object


112
113
114
# File 'lib/hashie/extensions/indifferent_access.rb', line 112

def indifferent_delete(key)
  regular_delete convert_key(key)
end

#indifferent_fetch(key, *args, &block) ⇒ Object


108
109
110
# File 'lib/hashie/extensions/indifferent_access.rb', line 108

def indifferent_fetch(key, *args, &block)
  regular_fetch convert_key(key), *args, &block
end

#indifferent_key?(key) ⇒ Boolean

Returns:

  • (Boolean)

116
117
118
# File 'lib/hashie/extensions/indifferent_access.rb', line 116

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

#indifferent_replace(other_hash) ⇒ Object


128
129
130
131
132
# File 'lib/hashie/extensions/indifferent_access.rb', line 128

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


97
98
99
100
101
102
# File 'lib/hashie/extensions/indifferent_access.rb', line 97

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_value(value) ⇒ Object


82
83
84
85
86
87
88
89
90
# File 'lib/hashie/extensions/indifferent_access.rb', line 82

def indifferent_value(value)
  if hash_lacking_indifference?(value)
    IndifferentAccess.inject!(value)
  elsif value.is_a?(::Array)
    value.replace(value.map { |e| indifferent_value(e) })
  else
    value
  end
end

#indifferent_values_at(*indices) ⇒ Object


120
121
122
# File 'lib/hashie/extensions/indifferent_access.rb', line 120

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

#indifferent_writer(key, value) ⇒ Object


104
105
106
# File 'lib/hashie/extensions/indifferent_access.rb', line 104

def indifferent_writer(key, value)
  regular_writer convert_key(key), indifferent_value(value)
end

#merge(*args) ⇒ Object


134
135
136
137
138
# File 'lib/hashie/extensions/indifferent_access.rb', line 134

def merge(*args)
  result = super
  return IndifferentAccess.inject!(result) if hash_lacking_indifference?(result)
  result.convert!
end

#merge!Object


140
141
142
# File 'lib/hashie/extensions/indifferent_access.rb', line 140

def merge!(*)
  super.convert!
end