Class: Hash

Inherits:
Object
  • Object
show all
Defined in:
lib/specimen/extensions/ruby/hash.rb

Instance Method Summary collapse

Instance Method Details

#assert_valid_keys(*valid_keys) ⇒ Object

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



48
49
50
51
52
53
54
55
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 48

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

#deep_stringify_keys ⇒ Object

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



84
85
86
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 84

def deep_stringify_keys
  deep_transform_keys(&:to_s)
end

#deep_stringify_keys! ⇒ Object

Destructively converts all keys to strings. This includes the keys from the root hash and from all nested hashes and arrays.



91
92
93
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 91

def deep_stringify_keys!
  deep_transform_keys!(&:to_s)
end

#deep_symbolize_keys ⇒ Object

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



103
104
105
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 103

def deep_symbolize_keys
  deep_transform_keys { |key| key.to_sym rescue key }
end

#deep_symbolize_keys! ⇒ Object

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.



110
111
112
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 110

def deep_symbolize_keys!
  deep_transform_keys! { |key| key.to_sym rescue key }
end

#deep_transform_keys(&block) ⇒ Object

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



65
66
67
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 65

def deep_transform_keys(&block)
  _deep_transform_keys_in_object(self, &block)
end

#deep_transform_keys!(&block) ⇒ Object

Destructively converts all keys by using the block operation. This includes the keys from the root hash and from all nested hashes and arrays.



72
73
74
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 72

def deep_transform_keys!(&block)
  _deep_transform_keys_in_object!(self, &block)
end

#stringify_keys ⇒ Object

Returns a new hash with all keys converted to strings.

hash = { name: 'Rob', age: '28' }

hash.stringify_keys
# => {"name"=>"Rob", "age"=>"28"}



10
11
12
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 10

def stringify_keys
  transform_keys(&:to_s)
end

#stringify_keys! ⇒ Object

Destructively converts all keys to strings. Same as stringify_keys, but modifies self.



16
17
18
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 16

def stringify_keys!
  transform_keys!(&:to_s)
end

#symbolize_keys ⇒ Object Also known as: to_options

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



27
28
29
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 27

def symbolize_keys
  transform_keys { |key| key.to_sym rescue key }
end

#symbolize_keys! ⇒ Object Also known as: to_options!

Destructively converts all keys to symbols, as long as they respond to to_sym. Same as symbolize_keys, but modifies self.



34
35
36
 
# File 'lib/specimen/extensions/ruby/hash.rb', line 34

def symbolize_keys!
  transform_keys! { |key| key.to_sym rescue key }
end