Class: ActiveSupport::HashWithIndifferentAccess

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

Overview

Hash With Indifferent Access

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.

Constant Summary collapse

NOT_GIVEN =

:nodoc:

Object.new

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hash

#as_json, #assert_valid_keys, #compact_blank, #compact_blank!, #deep_dup, #deep_merge?, #deep_stringify_keys, #deep_stringify_keys!, #deep_symbolize_keys!, #deep_transform_keys, #deep_transform_keys!, #deep_transform_values, #deep_transform_values!, #except!, #extract!, from_trusted_xml, from_xml, #present?, #stringify_keys, #stringify_keys!, #symbolize_keys!, #to_query, #to_xml

Methods included from DeepMergeable

#deep_merge, #deep_merge!, #deep_merge?

Constructor Details

#initialize(constructor = nil) ⇒ HashWithIndifferentAccess

Returns a new instance of HashWithIndifferentAccess.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 70

def initialize(constructor = nil)
  if constructor.nil?
    super()
  elsif constructor.respond_to?(:to_hash)
    super()
    update(constructor)

    hash = constructor.is_a?(Hash) ? constructor : 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 



85
86
87
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 85

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



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

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

#[]=(key, value) ⇒ Object

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'.

If the value is a Hash or contains one or multiple Hashes, they will be converted to HashWithIndifferentAccess.



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

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

#assoc(key) ⇒ Object

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

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

counters.assoc('foo') # => ["foo", 1]
counters.assoc(:foo)  # => ["foo", 1]
counters.assoc(:zoo)  # => nil



197
198
199
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 197

def assoc(key)
  super(convert_key(key))
end

#compact ⇒ Object 



390
391
392
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 390

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

#deep_symbolize_keys ⇒ Object 



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

def deep_symbolize_keys; to_hash.deep_symbolize_keys! end

#default(key = (no_key = true)) ⇒ Object

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

hash = ActiveSupport::HashWithIndifferentAccess.new(1)
hash.default                   # => 1

hash = ActiveSupport::HashWithIndifferentAccess.new { |hash, key| key }
hash.default                   # => nil
hash.default('foo')            # => 'foo'
hash.default(:foo)             # => 'foo'



239
240
241
242
243
244
245
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 239

def default(key = (no_key = true))
  if no_key
    super()
  else
    super(convert_key(key))
  end
end

#delete(key) ⇒ Object

Removes the specified key from the hash.



317
318
319
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 317

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

#dig(*args) ⇒ Object

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

counters = ActiveSupport::HashWithIndifferentAccess.new
counters[:foo] = { bar: 1 }

counters.dig('foo', 'bar')     # => 1
counters.dig(:foo, :bar)       # => 1
counters.dig(:zoo)             # => nil



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

def dig(*args)
  args[0] = convert_key(args[0]) if args.size > 0
  super(*args)
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] # => "c"
dup[:a][:c]  # => "c"



280
281
282
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 280

def dup
  copy_defaults(self.class.new(self))
end

#except(*keys) ⇒ Object Also known as: without

Returns a hash with indifferent access that includes everything except given keys.

hash = { a: "x", b: "y", c: 10 }.with_indifferent_access
hash.except(:a, "b") # => {c: 10}.with_indifferent_access
hash                 # => { a: "x", b: "y", c: 10 }.with_indifferent_access



325
326
327
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 325

def except(*keys)
  dup.except!(*keys)
end

#extractable_options? ⇒ Boolean

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

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 58

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"



211
212
213
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 211

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

#fetch_values(*indices, &block) ⇒ Object

Returns an array of the values at the specified indices, but also raises an exception when one of the keys can’t be found.

hash = ActiveSupport::HashWithIndifferentAccess.new
hash[:a] = 'x'
hash[:b] = 'y'
hash.fetch_values('a', 'b') # => ["x", "y"]
hash.fetch_values('a', 'c') { |key| 'z' } # => ["x", "z"]
hash.fetch_values('a', 'c') # => KeyError: key not found: "c"



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

def fetch_values(*indices, &block)
  indices.map! { |key| convert_key(key) }
  super
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) 


167
168
169
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 167

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

#merge(*hashes, &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.



287
288
289
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 287

def merge(*hashes, &block)
  dup.update(*hashes, &block)
end

#nested_under_indifferent_access ⇒ Object 



66
67
68
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 66

def nested_under_indifferent_access
  self
end

#regular_update ⇒ Object 



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

alias_method :regular_update, :update

#regular_writer ⇒ Object 



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

alias_method :regular_writer, :[]=

#reject(*args, &block) ⇒ Object 



342
343
344
345
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 342

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}



312
313
314
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 312

def replace(other_hash)
  super(cast(other_hash))
end

#reverse_merge(other_hash) ⇒ Object Also known as: with_defaults

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}



297
298
299
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 297

def reverse_merge(other_hash)
  super(cast(other_hash))
end

#reverse_merge!(other_hash) ⇒ Object Also known as: with_defaults!

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



303
304
305
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 303

def reverse_merge!(other_hash)
  super(cast(other_hash))
end

#select(*args, &block) ⇒ Object 



337
338
339
340
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 337

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

#slice(*keys) ⇒ Object 



380
381
382
383
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 380

def slice(*keys)
  keys.map! { |key| convert_key(key) }
  self.class.new(super)
end

#slice!(*keys) ⇒ Object 



385
386
387
388
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 385

def slice!(*keys)
  keys.map! { |key| convert_key(key) }
  super
end

#store(key, value, convert_value: true) ⇒ Object

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'.

If the value is a Hash or contains one or multiple Hashes, they will be converted to HashWithIndifferentAccess. unless ‘convert_value: false` is set.



115
116
117
118
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 115

def store(key, value, convert_value: true)
  value = convert_value(value, conversion: :assignment) if convert_value
  regular_writer(convert_key(key), value)
end

#symbolize_keys ⇒ Object Also known as: to_options 



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

def symbolize_keys; to_hash.symbolize_keys! end

#to_hash ⇒ Object

Convert to a regular hash with string keys.



395
396
397
398
399
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 395

def to_hash
  copy = Hash[self]
  copy.transform_values! { |v| convert_value_to_hash(v) }
  copy_defaults(copy)
end

#to_options! ⇒ Object 



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

def to_options!; self end

#to_proc ⇒ Object 



401
402
403
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 401

def to_proc
  proc { |key| self[key] }
end

#transform_keys(hash = NOT_GIVEN, &block) ⇒ Object 



354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 354

def transform_keys(hash = NOT_GIVEN, &block)
  if NOT_GIVEN.equal?(hash)
    if block_given?
      self.class.new(super(&block))
    else
      to_enum(:transform_keys)
    end
  else
    self.class.new(super)
  end
end

#transform_keys!(hash = NOT_GIVEN, &block) ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 366

def transform_keys!(hash = NOT_GIVEN, &block)
  if NOT_GIVEN.equal?(hash)
    if block_given?
      replace(copy_defaults(transform_keys(&block)))
    else
      return to_enum(:transform_keys!)
    end
  else
    replace(copy_defaults(transform_keys(hash, &block)))
  end

  self
end

#transform_values(&block) ⇒ Object 



347
348
349
350
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 347

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

#update(*other_hashes, &block) ⇒ Object Also known as: merge!

Updates the receiver in-place, merging in the hashes passed as arguments:

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!"}

hash = ActiveSupport::HashWithIndifferentAccess.new
hash.update({ "a" => 1 }, { "b" => 2 }) # => { "a" => 1, "b" => 2 }

The arguments 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}



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 148

def update(*other_hashes, &block)
  if other_hashes.size == 1
    update_with_single_argument(other_hashes.first, block)
  else
    other_hashes.each do |other_hash|
      update_with_single_argument(other_hash, block)
    end
  end
  self
end

#values_at(*keys) ⇒ 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"]



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

def values_at(*keys)
  keys.map! { |key| convert_key(key) }
  super
end

#with_indifferent_access ⇒ Object 



62
63
64
 
# File 'lib/active_support/hash_with_indifferent_access.rb', line 62

def with_indifferent_access
  dup
end