Class: Hash

Inherits:
Object show all
Defined in:
lib/larva/hash_with_indifferent_access.rb

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



67
68
69
70
71
72
73
74
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 67

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.

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

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



111
112
113
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 111

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.



118
119
120
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 118

def deep_stringify_keys!
  deep_transform_keys!{ |key| key.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.

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

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



130
131
132
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 130

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.



137
138
139
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 137

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.

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

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



84
85
86
87
88
89
90
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 84

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.



95
96
97
98
99
100
101
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 95

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_keys ⇒ Object

Returns a new hash with all keys converted to strings.

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

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



31
32
33
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 31

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.



37
38
39
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 37

def stringify_keys!
  transform_keys!{ |key| key.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" }



48
49
50
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 48

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.



55
56
57
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 55

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

#transform_keys ⇒ Object

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



8
9
10
11
12
13
14
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 8

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.



18
19
20
21
22
23
 
# File 'lib/larva/hash_with_indifferent_access.rb', line 18

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