Class: ActiveSupport::HashWithIndifferentAccess
- Defined in:
- lib/active_support/hash_with_indifferent_access.rb
Class Method Summary collapse
Instance Method Summary collapse
-
#[]=(key, value) ⇒ Object
(also: #store)
Assigns a new value to the hash:.
- #default(key = nil) ⇒ Object
-
#delete(key) ⇒ Object
Removes a specified key from the hash.
-
#dup ⇒ Object
Returns an exact copy of the hash.
-
#extractable_options? ⇒ Boolean
Always returns true, so that
Array#extract_options!
finds members of this class. -
#fetch(key, *extras) ⇒ Object
Fetches the value for the specified key, same as doing hash.
-
#initialize(constructor = {}) ⇒ HashWithIndifferentAccess
constructor
A new instance of HashWithIndifferentAccess.
-
#key?(key) ⇒ Boolean
(also: #include?, #has_key?, #member?)
Checks the hash for a key matching the argument passed in:.
-
#merge(hash) ⇒ Object
Merges the instantized and the specified hashes together, giving precedence to the values from the second hash.
- #nested_under_indifferent_access ⇒ Object
- #regular_update ⇒ Object
- #regular_writer ⇒ Object
-
#reverse_merge(other_hash) ⇒ Object
Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second.
- #reverse_merge!(other_hash) ⇒ Object
- #stringify_keys ⇒ Object
- #stringify_keys! ⇒ Object
- #symbolize_keys ⇒ Object
-
#to_hash ⇒ Object
Convert to a Hash with String keys.
- #to_options! ⇒ Object
-
#update(other_hash) ⇒ Object
(also: #merge!)
Updates the instantized hash with values from the second:.
-
#values_at(*indices) ⇒ Object
Returns an array of the values at the specified indices:.
- #with_indifferent_access ⇒ Object
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
Returns a new instance of HashWithIndifferentAccess.
23 24 25 26 27 28 29 30 |
# File '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 |
Class Method Details
.new_from_hash_copying_default(hash) ⇒ Object
40 41 42 43 44 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 40 def self.(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"
54 55 56 |
# File '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) ⇒ Object
32 33 34 35 36 37 38 |
# File '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) ⇒ Object
Removes a specified key from the hash.
136 137 138 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 136 def delete(key) super(convert_key(key)) end |
#dup ⇒ Object
Returns an exact copy of the hash.
113 114 115 116 117 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 113 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 'lib/active_support/hash_with_indifferent_access.rb', line 11 def true end |
#fetch(key, *extras) ⇒ Object
Fetches the value for the specified key, same as doing hash
97 98 99 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 97 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
88 89 90 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 88 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.
121 122 123 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 121 def merge(hash) self.dup.update(hash) end |
#nested_under_indifferent_access ⇒ Object
19 20 21 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 19 def nested_under_indifferent_access self end |
#regular_update ⇒ Object
47 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 47 alias_method :regular_update, :update |
#regular_writer ⇒ Object
46 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 46 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
.
127 128 129 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 127 def reverse_merge(other_hash) super self.class.(other_hash) end |
#reverse_merge!(other_hash) ⇒ Object
131 132 133 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 131 def reverse_merge!(other_hash) replace(reverse_merge( other_hash )) end |
#stringify_keys ⇒ Object
141 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 141 def stringify_keys; dup end |
#stringify_keys! ⇒ Object
140 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 140 def stringify_keys!; self end |
#symbolize_keys ⇒ Object
143 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 143 def symbolize_keys; to_hash.symbolize_keys end |
#to_hash ⇒ Object
Convert to a Hash with String keys.
147 148 149 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 147 def to_hash Hash.new(default).merge!(self) end |
#to_options! ⇒ Object
144 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 144 def ; 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!"}
70 71 72 73 74 75 76 77 |
# File '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) ⇒ 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"]
108 109 110 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 108 def values_at(*indices) indices.collect {|key| self[convert_key(key)]} end |
#with_indifferent_access ⇒ Object
15 16 17 |
# File 'lib/active_support/hash_with_indifferent_access.rb', line 15 def with_indifferent_access dup end |