Class: ActiveSupport::HashWithIndifferentAccess
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::Hash
|
|
Instance Chain:
self,
::Hash
|
|
Inherits: | Hash |
Defined in: | activesupport/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
::Hash
- Inherited
.from_trusted_xml | Builds a |
.from_xml | Returns a |
Instance Attribute Summary
-
#extractable_options? ⇒ Boolean
readonly
Returns
true
so that Array#extract_options! finds members of this class.
::Hash
- Inherited
#extractable_options? | By default, only instances of |
Instance Method Summary
-
#[](key)
Same as
Hash#[]
where the key passed as argument can be either a string or a symbol: -
#[]=(key, value)
(also: #store)
Assigns a new value to the hash:
-
#assoc(key)
Same as
Hash#assoc
where the key passed as argument can be either a string or a symbol: - #compact
- #deep_stringify_keys
- #deep_stringify_keys!
- #deep_symbolize_keys
-
#default(*args)
Same as
Hash#default
where the key passed as argument can be either a string or a symbol: -
#delete(key)
Removes the specified key from the hash.
-
#dig(*args)
Same as
Hash#dig
where the key passed as argument can be either a string or a symbol: -
#dup
Returns a shallow copy of the hash.
-
#fetch(key, *extras)
Same as
Hash#fetch
where the key passed as argument can be either a string or a symbol: -
#fetch_values(*indices, &block)
Returns an array of the values at the specified indices, but also raises an exception when one of the keys can’t be found.
-
#has_key?(key)
Alias for #key?.
-
#include?(key)
Alias for #key?.
-
#key?(key) ⇒ Boolean
(also: #include?, #has_key?, #member?)
Checks the hash for a key matching the argument passed in:
-
#member?(key)
Alias for #key?.
-
#merge(hash, &block)
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.
-
#merge!(other_hash)
Alias for #update.
- #nested_under_indifferent_access
- #regular_update
- #regular_writer
- #reject(*args, &block)
-
#replace(other_hash)
Replaces the contents of this hash with other_hash.
-
#reverse_merge(other_hash)
(also: #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:
-
#reverse_merge!(other_hash)
(also: #with_defaults!)
Same semantics as #reverse_merge but modifies the receiver in-place.
- #select(*args, &block)
- #slice(*keys)
- #slice!(*keys)
-
#store(key, value)
Alias for #[]=.
- #stringify_keys
- #stringify_keys!
- #symbolize_keys (also: #to_options)
-
#to_hash
Convert to a regular hash with string keys.
-
#to_options
Alias for #symbolize_keys.
- #to_options!
- #transform_keys(*args, &block)
- #transform_keys!
- #transform_values(*args, &block)
-
#update(other_hash)
(also: #merge!)
Updates the receiver in-place, merging in the hash passed as argument:
-
#values_at(*indices)
Returns an array of the values at the specified indices:
-
#with_defaults(other_hash)
Alias for #reverse_merge.
-
#with_defaults!(other_hash)
Alias for #reverse_merge!.
- #with_indifferent_access
- #convert_key(key) private
- #convert_value(value, options = {}) private
- #set_defaults(target) private
::Hash
- Inherited
#assert_valid_keys | Validates all keys in a hash match |
#blank? | A hash is blank if it’s empty: |
#compact | Returns a hash with non |
#compact! | Replaces current hash with non |
#deep_dup | Returns a deep copy of hash. |
#deep_merge | Returns a new hash with |
#deep_merge! | Same as |
#deep_stringify_keys | Returns a new hash with all keys converted to strings. |
#deep_stringify_keys! | Destructively converts all keys to strings. |
#deep_symbolize_keys | Returns a new hash with all keys converted to symbols, as long as they respond to |
#deep_symbolize_keys! | Destructively converts all keys to symbols, as long as they respond to |
#deep_transform_keys | Returns a new hash with all keys converted by the block operation. |
#deep_transform_keys! | Destructively converts all keys by using the block operation. |
#except | Returns a hash that includes everything except given keys. |
#except! | Removes the given keys from hash and returns it. |
#extract! | Removes and returns the key/value pairs matching the given keys. |
#nested_under_indifferent_access | Alias for Hash#with_indifferent_access. |
#reverse_merge | Merges the caller into |
#reverse_merge! | Destructive #reverse_merge. |
#reverse_update | Alias for Hash#reverse_merge!. |
#slice | Slices a hash to include only the given keys. |
#slice! | Replaces the hash with only the given keys. |
#stringify_keys | Returns a new hash with all keys converted to strings. |
#stringify_keys! | Destructively converts all keys to strings. |
#symbolize_keys | Returns a new hash with all keys converted to symbols, as long as they respond to |
#symbolize_keys! | Destructively converts all keys to symbols, as long as they respond to |
#to_options | Alias for Hash#symbolize_keys. |
#to_options! | Alias for Hash#symbolize_keys!. |
#to_param | Alias for Hash#to_query. |
#to_query | Returns a string representation of the receiver suitable for use as a URL query string: |
#to_xml | Returns a string containing an XML representation of its receiver: |
#transform_keys | Returns a new hash with all keys converted using the |
#transform_keys! | Destructively converts all keys using the |
#transform_values | Returns a new hash with the results of running |
#transform_values! | Destructively converts all values using the |
#with_defaults | Alias for Hash#reverse_merge. |
#with_defaults! | Alias for Hash#reverse_merge!. |
#with_indifferent_access | Returns an |
Constructor Details
.new(constructor = {}) ⇒ HashWithIndifferentAccess
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 66
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)
[ GitHub ]Instance Attribute Details
#extractable_options? ⇒ Boolean
(readonly)
Returns true
so that Array#extract_options! finds members of this class.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 54
def true end
Instance Method Details
#[](key)
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
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 162
def [](key) super(convert_key(key)) end
#[]=(key, value) 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'
.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 92
def []=(key, value) regular_writer(convert_key(key), convert_value(value, for: :assignment)) end
#assoc(key)
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
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 175
def assoc(key) super(convert_key(key)) end
#compact
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 346
def compact dup.tap(&:compact!) end
#convert_key(key) (private)
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 362
def convert_key(key) # :doc: key.kind_of?(Symbol) ? key.to_s : key end
#convert_value(value, options = {}) (private)
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 366
def convert_value(value, = {}) # :doc: if value.is_a? Hash if [:for] == :to_hash value.to_hash else value.nested_under_indifferent_access end elsif value.is_a?(Array) if [:for] != :assignment || value.frozen? value = value.dup end value.map! { |e| convert_value(e, ) } else value end end
#deep_stringify_keys
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 300
def deep_stringify_keys; dup end
#deep_stringify_keys!
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 298
def deep_stringify_keys!; self end
#deep_symbolize_keys
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 305
def deep_symbolize_keys; to_hash.deep_symbolize_keys! end
#default(*args)
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'
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 219
def default(*args) super(*args.map { |arg| convert_key(arg) }) end
#delete(key)
Removes the specified key from the hash.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 293
def delete(key) super(convert_key(key)) end
#dig(*args)
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, : ) # => 1
counters.dig(:zoo) # => nil
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 203
def dig(*args) args[0] = convert_key(args[0]) if args.size > 0 super(*args) end
#dup
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"
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 254
def dup self.class.new(self).tap do |new_hash| set_defaults(new_hash) end end
#fetch(key, *extras)
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(:, 0) # => 0
counters.fetch(: ) { |key| 0 } # => 0
counters.fetch(:zoo) # => KeyError: key not found: "zoo"
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 189
def fetch(key, *extras) super(convert_key(key), *extras) end
#fetch_values(*indices, &block)
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"
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 242
def fetch_values(*indices, &block) indices.collect { |key| fetch(key, &block) } end
#has_key?(key)
Alias for #key?.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 150
alias_method :has_key?, :key?
#include?(key)
Alias for #key?.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 149
alias_method :include?, :key?
#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
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 145
def key?(key) super(convert_key(key)) end
#member?(key)
Alias for #key?.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 151
alias_method :member?, :key?
#merge(hash, &block)
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.
#merge!(other_hash)
Alias for #update.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 137
alias_method :merge!, :update
#nested_under_indifferent_access
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 62
def nested_under_indifferent_access self end
#regular_update
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 84
alias_method :regular_update, :update unless method_defined?(:regular_update)
#regular_writer
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 83
alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
#reject(*args, &block)
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 313
def reject(*args, &block) return to_enum(:reject) unless block_given? dup.tap { |hash| hash.reject!(*args, &block) } end
#replace(other_hash)
Replaces the contents of this hash with other_hash.
h = { "a" => 100, "b" => 200 }
h.replace({ "c" => 300, "d" => 400 }) # => {"c"=>300, "d"=>400}
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 288
def replace(other_hash) super(self.class.new(other_hash)) end
#reverse_merge(other_hash) 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}
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 273
def reverse_merge(other_hash) super(self.class.new(other_hash)) end
#reverse_merge!(other_hash) Also known as: #with_defaults!
Same semantics as #reverse_merge but modifies the receiver in-place.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 279
def reverse_merge!(other_hash) super(self.class.new(other_hash)) end
#select(*args, &block)
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 308
def select(*args, &block) return to_enum(:select) unless block_given? dup.tap { |hash| hash.select!(*args, &block) } end
#set_defaults(target) (private)
[ GitHub ]#slice(*keys)
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 336
def slice(*keys) keys.map! { |key| convert_key(key) } self.class.new(super) end
#slice!(*keys)
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 341
def slice!(*keys) keys.map! { |key| convert_key(key) } super end
#store(key, value)
Alias for #[]=.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 96
alias_method :store, :[]=
#stringify_keys
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 299
def stringify_keys; dup end
#stringify_keys!
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 297
def stringify_keys!; self end
#symbolize_keys Also known as: #to_options
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 303
def symbolize_keys; to_hash.symbolize_keys! end
#to_hash
Convert to a regular hash with string keys.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 351
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
Alias for #symbolize_keys.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 304
alias_method :, :symbolize_keys
#to_options!
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 306
def ; self end
#transform_keys(*args, &block)
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 323
def transform_keys(*args, &block) return to_enum(:transform_keys) unless block_given? dup.tap { |hash| hash.transform_keys!(*args, &block) } end
#transform_keys!
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 328
def transform_keys! return enum_for(:transform_keys!) { size } unless block_given? keys.each do |key| self[yield(key)] = delete(key) end self end
#transform_values(*args, &block)
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 318
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) 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 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}
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 123
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)
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"]
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 229
def values_at(*indices) indices.collect { |key| self[convert_key(key)] } end
#with_defaults(other_hash)
Alias for #reverse_merge.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 276
alias_method :with_defaults, :reverse_merge
#with_defaults!(other_hash)
Alias for #reverse_merge!.
# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 282
alias_method :with_defaults!, :reverse_merge!
#with_indifferent_access
[ GitHub ]# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 58
def with_indifferent_access dup end