Class: ActiveSupport::HashWithIndifferentAccess

Inherits:
Hash
  • Object
show all
Defined in:
lib/active_support/hash_with_indifferent_access.rb

Overview

Implements a hash where keys :foo and "foo" are considered to be the same.

rgb = ActiveSupport::HashWithIndifferentAccess.new

rgb[:black] = '#000000'
rgb[:black]  # => '#000000'
rgb['black'] # => '#000000'

rgb['white'] = '#FFFFFF'
rgb[:white]  # => '#FFFFFF'
rgb['white'] # => '#FFFFFF'

Internally symbols are mapped to strings when used as keys in the entire writing interface (calling []=, merge, etc). This mapping belongs to the public interface. For example, given:

hash = ActiveSupport::HashWithIndifferentAccess.new(a: 1)

You are guaranteed that the key is returned as a string:

hash.keys # => ["a"]

Technically other types of keys are accepted:

hash = ActiveSupport::HashWithIndifferentAccess.new(a: 1)
hash[0] = 0
hash # => {"a"=>1, 0=>0}

but this class is intended for use cases where strings or symbols are the expected keys and it is convenient to understand both as the same. For example the params hash in Ruby on Rails.

Note that core extensions define Hash#with_indifferent_access:

rgb = { black: '#000000', white: '#FFFFFF' }.with_indifferent_access

which may be handy.

To access this class outside of Rails, require the core extension with:

require "active_support/core_ext/hash/indifferent_access"

which will, in turn, require this file.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hash

#as_json, #assert_valid_keys, #compact!, #deep_dup, #deep_merge, #deep_merge!, #deep_symbolize_keys!, #deep_transform_keys, #deep_transform_keys!, #except, #except!, #extract!, from_trusted_xml, from_xml, #slice, #slice!, #symbolize_keys!, #to_query, #to_xml, #transform_keys, #transform_keys!, #transform_values!

Constructor Details

#initialize(constructor = {}) ⇒ HashWithIndifferentAccess

Returns a new instance of HashWithIndifferentAccess.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 64

def initialize(constructor = {})
  if constructor.respond_to?(:to_hash)
    super()
    update(constructor)

    hash = constructor.to_hash
    self.default = hash.default if hash.default
    self.default_proc = hash.default_proc if hash.default_proc
  else
    super(constructor)
  end
end

Class Method Details

.[](*args) ⇒ Object 



87
88
89
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 87

def self.[](*args)
  new.merge!(Hash[*args])
end

Instance Method Details

#[](key) ⇒ Object

Same as Hash#[] where the key passed as argument can be either a string or a symbol:

counters = ActiveSupport::HashWithIndifferentAccess.new
counters[:foo] = 1

counters['foo'] # => 1
counters[:foo]  # => 1
counters[:zoo]  # => nil



170
171
172
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 170

def [](key)
  super(convert_key(key))
end

#[]=(key, value) ⇒ Object Also known as: store

Assigns a new value to the hash:

hash = ActiveSupport::HashWithIndifferentAccess.new
hash[:key] = 'value'

This value can be later fetched using either :key or 'key'.



100
101
102
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 100

def []=(key, value)
  regular_writer(convert_key(key), convert_value(value, for: :assignment))
end

#compact ⇒ Object 



272
273
274
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 272

def compact
  dup.tap(&:compact!)
end

#deep_stringify_keys ⇒ Object 



250
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 250

def deep_stringify_keys; dup end

#deep_stringify_keys! ⇒ Object 



248
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 248

def deep_stringify_keys!; self end

#deep_symbolize_keys ⇒ Object 



254
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 254

def deep_symbolize_keys; to_hash.deep_symbolize_keys! end

#default(*args) ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 77

def default(*args)
  arg_key = args.first

  if include?(key = convert_key(arg_key))
    self[key]
  else
    super
  end
end

#delete(key) ⇒ Object

Removes the specified key from the hash.



243
244
245
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 243

def delete(key)
  super(convert_key(key))
end

#dup ⇒ Object

Returns a shallow copy of the hash.

hash = ActiveSupport::HashWithIndifferentAccess.new({ a: { b: 'b' } })
dup  = hash.dup
dup[:a][:c] = 'c'

hash[:a][:c] # => nil
dup[:a][:c]  # => "c"



206
207
208
209
210
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 206

def dup
  self.class.new(self).tap do |new_hash|
    set_defaults(new_hash)
  end
end

#extractable_options? ⇒ Boolean

Returns true so that Array#extract_options! finds members of this class.

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 52

def extractable_options?
  true
end

#fetch(key, *extras) ⇒ Object

Same as Hash#fetch where the key passed as argument can be either a string or a symbol:

counters = ActiveSupport::HashWithIndifferentAccess.new
counters[:foo] = 1

counters.fetch('foo')          # => 1
counters.fetch(:bar, 0)        # => 0
counters.fetch(:bar) { |key| 0 } # => 0
counters.fetch(:zoo)           # => KeyError: key not found: "zoo"



184
185
186
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 184

def fetch(key, *extras)
  super(convert_key(key), *extras)
end

#key?(key) ⇒ Boolean Also known as: include?, has_key?, member?

Checks the hash for a key matching the argument passed in:

hash = ActiveSupport::HashWithIndifferentAccess.new
hash['key'] = 'value'
hash.key?(:key)  # => true
hash.key?('key') # => true

Returns:

  • (Boolean) 


153
154
155
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 153

def key?(key)
  super(convert_key(key))
end

#merge(hash, &block) ⇒ Object

This method has the same semantics of update, except it does not modify the receiver but rather returns a new hash with indifferent access with the result of the merge.



215
216
217
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 215

def merge(hash, &block)
  dup.update(hash, &block)
end

#nested_under_indifferent_access ⇒ Object 



60
61
62
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 60

def nested_under_indifferent_access
  self
end

#regular_update ⇒ Object 



92
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 92

alias_method :regular_update, :update

#regular_writer ⇒ Object 



91
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 91

alias_method :regular_writer, :[]=

#reject(*args, &block) ⇒ Object 



262
263
264
265
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 262

def reject(*args, &block)
  return to_enum(:reject) unless block_given?
  dup.tap { |hash| hash.reject!(*args, &block) }
end

#replace(other_hash) ⇒ Object

Replaces the contents of this hash with other_hash.

h = { "a" => 100, "b" => 200 }
h.replace({ "c" => 300, "d" => 400 }) # => {"c"=>300, "d"=>400}



238
239
240
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 238

def replace(other_hash)
  super(self.class.new(other_hash))
end

#reverse_merge(other_hash) ⇒ Object

Like merge but the other way around: Merges the receiver into the argument and returns a new hash with indifferent access as result:

hash = ActiveSupport::HashWithIndifferentAccess.new
hash['a'] = nil
hash.reverse_merge(a: 0, b: 1) # => {"a"=>nil, "b"=>1}



225
226
227
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 225

def reverse_merge(other_hash)
  super(self.class.new(other_hash))
end

#reverse_merge!(other_hash) ⇒ Object

Same semantics as reverse_merge but modifies the receiver in-place.



230
231
232
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 230

def reverse_merge!(other_hash)
  replace(reverse_merge(other_hash))
end

#select(*args, &block) ⇒ Object 



257
258
259
260
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 257

def select(*args, &block)
  return to_enum(:select) unless block_given?
  dup.tap { |hash| hash.select!(*args, &block) }
end

#stringify_keys ⇒ Object 



249
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 249

def stringify_keys; dup end

#stringify_keys! ⇒ Object 



247
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 247

def stringify_keys!; self end

#symbolize_keys ⇒ Object 



253
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 253

def symbolize_keys; to_hash.symbolize_keys! end

#to_hash ⇒ Object

Convert to a regular hash with string keys.



277
278
279
280
281
282
283
284
285
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 277

def to_hash
  _new_hash = Hash.new
  set_defaults(_new_hash)

  each do |key, value|
    _new_hash[key] = convert_value(value, for: :to_hash)
  end
  _new_hash
end

#to_options! ⇒ Object 



255
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 255

def to_options!; self end

#transform_values(*args, &block) ⇒ Object 



267
268
269
270
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 267

def transform_values(*args, &block)
  return to_enum(:transform_values) unless block_given?
  dup.tap { |hash| hash.transform_values!(*args, &block) }
end

#update(other_hash) ⇒ Object Also known as: merge!

Updates the receiver in-place, merging in the hash passed as argument:

hash_1 = ActiveSupport::HashWithIndifferentAccess.new
hash_1[:key] = 'value'

hash_2 = ActiveSupport::HashWithIndifferentAccess.new
hash_2[:key] = 'New Value!'

hash_1.update(hash_2) # => {"key"=>"New Value!"}

The argument can be either an ActiveSupport::HashWithIndifferentAccess or a regular Hash. In either case the merge respects the semantics of indifferent access.

If the argument is a regular hash with keys :key and “key” only one of the values end up in the receiver, but which one is unspecified.

When given a block, the value for duplicated keys will be determined by the result of invoking the block with the duplicated key, the value in the receiver, and the value in other_hash. The rules for duplicated keys follow the semantics of indifferent access:

hash_1[:key] = 10
hash_2['key'] = 12
hash_1.update(hash_2) { |key, old, new| old + new } # => {"key"=>22}



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 131

def update(other_hash)
  if other_hash.is_a? HashWithIndifferentAccess
    super(other_hash)
  else
    other_hash.to_hash.each_pair do |key, value|
      if block_given? && key?(key)
        value = yield(convert_key(key), self[key], value)
      end
      regular_writer(convert_key(key), convert_value(value))
    end
    self
  end
end

#values_at(*indices) ⇒ Object

Returns an array of the values at the specified indices:

hash = ActiveSupport::HashWithIndifferentAccess.new
hash[:a] = 'x'
hash[:b] = 'y'
hash.values_at('a', 'b') # => ["x", "y"]



194
195
196
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 194

def values_at(*indices)
  indices.collect { |key| self[convert_key(key)] }
end

#with_indifferent_access ⇒ Object 



56
57
58
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 56

def with_indifferent_access
  dup
end