Module: Buff::Extensions::Hash::KeyTransforms

Included in:
Hash
Defined in:
lib/buff/extensions/hash/key_transforms.rb

Overview

Instance Method Summary collapse

Instance Method Details

#assert_valid_keys(*valid_keys) ⇒ Object

Validate all keys in a hash match *valid_keys, raising ArgumentError on a mismatch. Note that keys are NOT treated indifferently, meaning if you use strings for keys but assert symbols as keys, this will fail.

{ name: 'Rob', years: '28' }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: years"
{ name: 'Rob', age: '28' }.assert_valid_keys('name', 'age') # => raises "ArgumentError: Unknown key: name"
{ name: 'Rob', age: '28' }.assert_valid_keys(:name, :age)   # => passes, raises nothing

71
72
73
74
75
76
# File 'lib/buff/extensions/hash/key_transforms.rb', line 71

def assert_valid_keys(*valid_keys)
  valid_keys.flatten!
  each_key do |k|
    raise ArgumentError.new("Unknown key: #{k}") unless valid_keys.include?(k)
  end
end

#deep_stringify_keysObject

Return a new hash with all keys converted to strings. This includes the keys from the root hash and from all nested hashes.

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

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

113
114
115
# File 'lib/buff/extensions/hash/key_transforms.rb', line 113

def deep_stringify_keys
  deep_transform_keys { |key| key.to_s }
end

#deep_stringify_keys!Object

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


120
121
122
# File 'lib/buff/extensions/hash/key_transforms.rb', line 120

def deep_stringify_keys!
  deep_transform_keys! { |key| key.to_s }
end

#deep_symbolize_keysObject

Return 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.

hash = { 'person' => { 'name' => 'Rob', 'age' => '28' } }

hash.deep_symbolize_keys
# => { person: { name: "Rob", age: "28" } }

132
133
134
# File 'lib/buff/extensions/hash/key_transforms.rb', line 132

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

#deep_symbolize_keys!Object

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.


139
140
141
# File 'lib/buff/extensions/hash/key_transforms.rb', line 139

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

#deep_transform_keys(&block) ⇒ Object

Return a new hash with all keys converted by the block operation. This includes the keys from the root hash and from all nested hashes.

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

hash.deep_transform_keys{ |key| key.to_s.upcase }
# => { "PERSON" => { "NAME" => "Rob", "AGE" => "28" } }

86
87
88
89
90
91
92
# File 'lib/buff/extensions/hash/key_transforms.rb', line 86

def deep_transform_keys(&block)
  result = {}
  each do |key, value|
    result[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys(&block) : value
  end
  result
end

#deep_transform_keys!(&block) ⇒ Object

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


97
98
99
100
101
102
103
# File 'lib/buff/extensions/hash/key_transforms.rb', line 97

def deep_transform_keys!(&block)
  keys.each do |key|
    value = delete(key)
    self[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys!(&block) : value
  end
  self
end

#stringify_keysObject

Return a new hash with all keys converted to strings.

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

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

35
36
37
# File 'lib/buff/extensions/hash/key_transforms.rb', line 35

def stringify_keys
  transform_keys { |key| key.to_s }
end

#stringify_keys!Object

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


41
42
43
# File 'lib/buff/extensions/hash/key_transforms.rb', line 41

def stringify_keys!
  transform_keys! { |key| key.to_s }
end

#symbolize_keysObject Also known as: to_options

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

52
53
54
# File 'lib/buff/extensions/hash/key_transforms.rb', line 52

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

#symbolize_keys!Object Also known as: to_options!

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


59
60
61
# File 'lib/buff/extensions/hash/key_transforms.rb', line 59

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

#transform_keysObject

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

12
13
14
15
16
17
18
# File 'lib/buff/extensions/hash/key_transforms.rb', line 12

def transform_keys
  result = {}
  each_key do |key|
    result[yield(key)] = self[key]
  end
  result
end

#transform_keys!Object

Destructively convert all keys using the block operations. Same as transform_keys but modifies self.


22
23
24
25
26
27
# File 'lib/buff/extensions/hash/key_transforms.rb', line 22

def transform_keys!
  keys.each do |key|
    self[yield(key)] = delete(key)
  end
  self
end