class Hash
Public Instance Methods
Validate all keys in a hash match *valid_keys
, raising ArgumentError on a mismatch.
Note that keys are treated differently than HashWithIndifferentAccess, meaning that string and symbol keys will not match.
{ name: 'Rob', years: '28' }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: :years. Valid keys are: :name, :age" { name: 'Rob', age: '28' }.assert_valid_keys('name', 'age') # => raises "ArgumentError: Unknown key: :name. Valid keys are: 'name', 'age'" { name: 'Rob', age: '28' }.assert_valid_keys(:name, :age) # => passes, raises nothing
# File lib/symbolized/core_ext/hash/keys.rb, line 71 def assert_valid_keys(*valid_keys) valid_keys.flatten! each_key do |k| unless valid_keys.include?(k) raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}") end end end
Returns a deep copy of hash.
hash = { a: { b: 'b' } } dup = hash.deep_dup dup[:a][:c] = 'c' hash[:a][:c] # => nil dup[:a][:c] # => "c"
# File lib/symbolized/core_ext/object/deep_dup.rb, line 42 def deep_dup each_with_object(dup) do |(key, value), hash| hash[key.deep_dup] = value.deep_dup end end
Returns a new hash with all keys converted to strings. This includes the keys from the root hash and from all nested hashes and arrays.
hash = { person: { name: 'Rob', age: '28' } } hash.deep_stringify_keys # => {"person"=>{"name"=>"Rob", "age"=>"28"}}
# File lib/symbolized/core_ext/hash/keys.rb, line 107 def deep_stringify_keys deep_transform_keys{ |key| key.to_s } end
Destructively convert all keys to strings. This includes the keys from the root hash and from all nested hashes and arrays.
# File lib/symbolized/core_ext/hash/keys.rb, line 114 def deep_stringify_keys! deep_transform_keys!{ |key| key.to_s } end
Returns a new hash with all keys converted to symbols, as long as they respond to to_sym
. This includes the keys from the root hash and from all nested hashes and arrays.
hash = { 'person' => { 'name' => 'Rob', 'age' => '28' } } hash.deep_symbolize_keys # => {:person=>{:name=>"Rob", :age=>"28"}}
# File lib/symbolized/core_ext/hash/keys.rb, line 126 def deep_symbolize_keys deep_transform_keys{ |key| key.to_sym rescue key } end
Destructively convert all keys to symbols, as long as they respond to to_sym
. This includes the keys from the root hash and from all nested hashes and arrays.
# File lib/symbolized/core_ext/hash/keys.rb, line 133 def deep_symbolize_keys! deep_transform_keys!{ |key| key.to_sym rescue key } end
Returns a new hash with all keys converted by the block operation. This includes the keys from the root hash and from all nested hashes and arrays.
hash = { person: { name: 'Rob', age: '28' } } hash.deep_transform_keys{ |key| key.to_s.upcase } # => {"PERSON"=>{"NAME"=>"Rob", "AGE"=>"28"}}
# File lib/symbolized/core_ext/hash/keys.rb, line 88 def deep_transform_keys(&block) _deep_transform_keys_in_object(self, &block) end
Destructively convert all keys by using the block operation. This includes the keys from the root hash and from all nested hashes and arrays.
# File lib/symbolized/core_ext/hash/keys.rb, line 95 def deep_transform_keys!(&block) _deep_transform_keys_in_object!(self, &block) end
Called when object is nested under an object that receives to_symbolized_hash
. This method will be called on the current object by the enclosing object and is aliased to to_symbolized_hash
by default. Subclasses of Hash
may overwrite this method to return self
if converting to a Symbolized::SymbolizedHash
would not be desirable.
b = { 'b' => 1 } { a: b }.with_indifferent_access['a'] # calls b.nested_under_indifferent_access # => { :b => 1 }
Merges the caller into other_hash
. For example,
options = options.reverse_merge(size: 25, velocity: 10)
is equivalent to
options = { size: 25, velocity: 10 }.merge(options)
This is particularly useful for initializing an options hash with default values.
# File lib/symbolized/core_ext/hash/reverse_merge.rb, line 12 def reverse_merge(other_hash) other_hash.merge(self) end
Destructive reverse_merge
.
# File lib/symbolized/core_ext/hash/reverse_merge.rb, line 17 def reverse_merge!(other_hash) # right wins if there is no left merge!( other_hash ){|key,left,right| left } end
Returns a new hash with all keys converted to strings.
hash = { name: 'Rob', age: '28' } hash.stringify_keys # => {"name"=>"Rob", "age"=>"28"}
# File lib/symbolized/core_ext/hash/keys.rb, line 33 def stringify_keys transform_keys{ |key| key.to_s } end
Destructively convert all keys to strings. Same as stringify_keys
, but modifies self
.
# File lib/symbolized/core_ext/hash/keys.rb, line 39 def stringify_keys! transform_keys!{ |key| key.to_s } end
Returns a new hash with all keys converted to symbols, as long as they respond to to_sym
.
hash = { 'name' => 'Rob', 'age' => '28' } hash.symbolize_keys # => {:name=>"Rob", :age=>"28"}
# File lib/symbolized/core_ext/hash/keys.rb, line 50 def symbolize_keys transform_keys{ |key| key.to_sym rescue key } end
Destructively convert all keys to symbols, as long as they respond to to_sym
. Same as symbolize_keys
, but modifies self
.
# File lib/symbolized/core_ext/hash/keys.rb, line 57 def symbolize_keys! transform_keys!{ |key| key.to_sym rescue key } end
Returns a Symbolized::SymbolizedHash
out of its receiver:
{ 'a' => 1 }.to_symbolized_hash[:a] # => 1
# File lib/symbolized/core_ext/hash/symbolized_hash.rb, line 7 def to_symbolized_hash Symbolized::SymbolizedHash.new_from_hash_copying_default(self) end
Returns a new hash with all keys converted using the block operation.
hash = { name: 'Rob', age: '28' } hash.transform_keys{ |key| key.to_s.upcase } # => {"NAME"=>"Rob", "AGE"=>"28"}
# File lib/symbolized/core_ext/hash/keys.rb, line 8 def transform_keys return enum_for(:transform_keys) unless block_given? result = self.class.new each_key do |key| result[yield(key)] = self[key] end result end
Destructively convert all keys using the block operations. Same as transform_keys
but modifies self
.
# File lib/symbolized/core_ext/hash/keys.rb, line 19 def transform_keys! return enum_for(:transform_keys!) unless block_given? keys.each do |key| self[yield(key)] = delete(key) end self end
Private Instance Methods
support methods for deep transforming nested hashes and arrays
# File lib/symbolized/core_ext/hash/keys.rb, line 139 def _deep_transform_keys_in_object(object, &block) case object when Hash object.each_with_object({}) do |(key, value), result| result[yield(key)] = _deep_transform_keys_in_object(value, &block) end when Array object.map {|e| _deep_transform_keys_in_object(e, &block) } else object end end
# File lib/symbolized/core_ext/hash/keys.rb, line 152 def _deep_transform_keys_in_object!(object, &block) case object when Hash object.keys.each do |key| value = object.delete(key) object[yield(key)] = _deep_transform_keys_in_object!(value, &block) end object when Array object.map! {|e| _deep_transform_keys_in_object!(e, &block)} else object end end