Methods
#
C
D
E
F
H
I
K
M
N
R
S
T
U
V
W
Class Public methods
new(constructor = {})
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 23
def initialize(constructor = {})
  if constructor.is_a?(Hash)
    super()
    update(constructor)
  else
    super(constructor)
  end
end
new_from_hash_copying_default(hash)
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 40
def self.new_from_hash_copying_default(hash)
  new(hash).tap do |new_hash|
    new_hash.default = hash.default
  end
end
Instance Public methods
[]=(key, value)

Assigns a new value to the hash:

hash = HashWithIndifferentAccess.new
hash[:key] = "value"
Also aliased as: regular_writer, store
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 54
def []=(key, value)
  regular_writer(convert_key(key), convert_value(value))
end
default(key = nil)
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 32
def default(key = nil)
  if key.is_a?(Symbol) && include?(key = key.to_s)
    self[key]
  else
    super
  end
end
delete(key)

Removes a specified key from the hash.

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 146
def delete(key)
  super(convert_key(key))
end
dup()

Returns an exact copy of the hash.

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 123
def dup
  self.class.new(self).tap do |new_hash|
    new_hash.default = default
  end
end
extractable_options?()

Always returns true, so that Array#extract_options!finds members of this class.

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 11
def extractable_options?
  true
end
fetch(key, *extras)

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

counters = 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"
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 107
def fetch(key, *extras)
  super(convert_key(key), *extras)
end
has_key?(key)
Alias for: key?
include?(key)
Alias for: key?
key?(key)

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

hash = HashWithIndifferentAccess.new
hash["key"] = "value"
hash.key? :key  # => true
hash.key? "key" # => true
Also aliased as: include?, has_key?, member?
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 88
def key?(key)
  super(convert_key(key))
end
member?(key)
Alias for: key?
merge(hash)

Merges the instantized and the specified hashes together, giving precedence to the values from the second hash. Does not overwrite the existing hash.

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 131
def merge(hash)
  self.dup.update(hash)
end
merge!(other_hash)
Alias for: update
nested_under_indifferent_access()
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 19
def nested_under_indifferent_access
  self
end
regular_update(other_hash)
Alias for: update
regular_writer(key, value)
Alias for: []=
reverse_merge(other_hash)

Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second. This overloaded definition prevents returning a regular hash, if #reverse_merge is called on a HashWithDifferentAccess.

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 137
def reverse_merge(other_hash)
  super self.class.new_from_hash_copying_default(other_hash)
end
reverse_merge!(other_hash)
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 141
def reverse_merge!(other_hash)
  replace(reverse_merge( other_hash ))
end
store(key, value)
Alias for: []=
stringify_keys()
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 151
def stringify_keys; dup end
stringify_keys!()
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 150
def stringify_keys!; self end
symbolize_keys()
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 153
def symbolize_keys; to_hash.symbolize_keys end
to_hash()

Convert to a Hash with String keys.

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 157
def to_hash
  Hash.new(default).merge!(self)
end
to_options!()
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 154
def to_options!; self end
update(other_hash)

Updates the instantized hash with values from the second:

hash_1 = HashWithIndifferentAccess.new
hash_1[:key] = "value"

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

hash_1.update(hash_2) # => {"key"=>"New Value!"}
Also aliased as: regular_update, merge!
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 70
def update(other_hash)
  if other_hash.is_a? HashWithIndifferentAccess
    super(other_hash)
  else
    other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
    self
  end
end
values_at(*indices)

Returns an array of the values at the specified indices:

hash = HashWithIndifferentAccess.new
hash[:a] = "x"
hash[:b] = "y"
hash.values_at("a", "b") # => ["x", "y"]
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 118
def values_at(*indices)
  indices.collect {|key| self[convert_key(key)]}
end
with_indifferent_access()
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 15
def with_indifferent_access
  dup
end
Instance Protected methods
convert_key(key)
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 162
def convert_key(key)
  key.kind_of?(Symbol) ? key.to_s : key
end
convert_value(value)
# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 166
def convert_value(value)
  if value.is_a? Hash
    value.nested_under_indifferent_access
  elsif value.is_a?(Array)
    value.dup.replace(value.map { |e| convert_value(e) })
  else
    value
  end
end