Class: ActiveSupport::HashWithIndifferentAccess

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hash

#as_json, #assert_valid_keys, #deep_dup, #deep_merge, #deep_merge!, #diff, #encode_json, #except, #except!, #extract!, from_xml, #slice, #slice!, #symbolize_keys!, #to_param, #to_xml

Constructor Details

#initialize(constructor = {}) ⇒ HashWithIndifferentAccess


19
20
21
22
23
24
25
26
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 19

def initialize(constructor = {})
  if constructor.is_a?(Hash)
    super()
    update(constructor)
  else
    super(constructor)
  end
end

Class Method Details

.new_from_hash_copying_default(hash) ⇒ Object


36
37
38
39
40
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 36

def self.new_from_hash_copying_default(hash)
  new(hash).tap do |new_hash|
    new_hash.default = hash.default
  end
end

Instance Method Details

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

Assigns a new value to the hash:

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

50
51
52
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 50

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

#default(key = nil) ⇒ Object


28
29
30
31
32
33
34
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 28

def default(key = nil)
  if key.is_a?(Symbol) && include?(key = key.to_s)
    self[key]
  else
    super
  end
end

#delete(key) ⇒ Object

Removes a specified key from the hash.


132
133
134
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 132

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

#dupObject

Returns an exact copy of the hash.


109
110
111
112
113
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 109

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

#extractable_options?Boolean

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


11
12
13
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 11

def extractable_options?
  true
end

#fetch(key, *extras) ⇒ Object

Fetches the value for the specified key, same as doing hash


93
94
95
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 93

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 = HashWithIndifferentAccess.new
hash["key"] = "value"
hash.key? :key  # => true
hash.key? "key" # => true

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

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

#merge(hash) ⇒ Object

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


117
118
119
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 117

def merge(hash)
  self.dup.update(hash)
end

#regular_updateObject


43
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 43

alias_method :regular_update, :update

#regular_writerObject


42
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 42

alias_method :regular_writer, :[]=

#reverse_merge(other_hash) ⇒ Object

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.


123
124
125
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 123

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

#reverse_merge!(other_hash) ⇒ Object


127
128
129
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 127

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

#stringify_keysObject


137
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 137

def stringify_keys; dup end

#stringify_keys!Object


136
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 136

def stringify_keys!; self end

#symbolize_keysObject


139
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 139

def symbolize_keys; to_hash.symbolize_keys end

#to_hashObject

Convert to a Hash with String keys.


143
144
145
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 143

def to_hash
  Hash.new(default).merge!(self)
end

#to_options!Object


140
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 140

def to_options!; self end

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

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

66
67
68
69
70
71
72
73
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 66

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) ⇒ Object

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"]

104
105
106
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 104

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

#with_indifferent_accessObject


15
16
17
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 15

def with_indifferent_access
  dup
end