class Hash
Public Instance Methods
Validates 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/simple_helper/hash/keys.rb, line 60 def assert_valid_keys(*valid_keys) valid_keys.flatten! each_key do |k| unless valid_keys.include?(k) raise ArgumentError, "Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}" end 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/simple_helper/hash/keys.rb, line 96 def deep_stringify_keys deep_transform_keys(&:to_s) end
Destructively converts all keys to strings. This includes the keys from the root hash and from all nested hashes and arrays.
# File lib/simple_helper/hash/keys.rb, line 103 def deep_stringify_keys! deep_transform_keys!(&: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/simple_helper/hash/keys.rb, line 115 def deep_symbolize_keys deep_transform_keys do |key| begin key.to_sym rescue StandardError key end end end
Destructively converts 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/simple_helper/hash/keys.rb, line 128 def deep_symbolize_keys! deep_transform_keys! do |key| begin key.to_sym rescue StandardError key end end 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/simple_helper/hash/keys.rb, line 77 def deep_transform_keys(&block) _deep_transform_keys_in_object(self, &block) end
Destructively converts all keys by using the block operation. This includes the keys from the root hash and from all nested hashes and arrays.
# File lib/simple_helper/hash/keys.rb, line 84 def deep_transform_keys!(&block) _deep_transform_keys_in_object!(self, &block) 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/simple_helper/hash/keys.rb, line 10 def stringify_keys transform_keys(&:to_s) end
Destructively converts all keys to strings. Same as stringify_keys
, but modifies self
.
# File lib/simple_helper/hash/keys.rb, line 16 def stringify_keys! transform_keys!(&: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/simple_helper/hash/keys.rb, line 27 def symbolize_keys transform_keys do |key| begin key.to_sym rescue StandardError key end end end
Destructively converts all keys to symbols, as long as they respond to to_sym
. Same as symbolize_keys
, but modifies self
.
# File lib/simple_helper/hash/keys.rb, line 40 def symbolize_keys! transform_keys! do |key| begin key.to_sym rescue StandardError key end end end
Private Instance Methods
Support methods for deep transforming nested hashes and arrays.
# File lib/simple_helper/hash/keys.rb, line 141 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/simple_helper/hash/keys.rb, line 154 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