Class: Hash

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

Overview

Hash monkey patches from ActiveSupport

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.



64
65
66
67
68
69
70
71
 
# File 'lib/hash.rb', line 64

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

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



100
101
102
 
# File 'lib/hash.rb', line 100

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.



107
108
109
 
# File 'lib/hash.rb', line 107

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



119
120
121
122
123
124
125
 
# File 'lib/hash.rb', line 119

def deep_symbolize_keys
  deep_transform_keys do |key|
    key.to_sym
  rescue StandardError
    key
  end
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.



130
131
132
133
134
135
136
 
# File 'lib/hash.rb', line 130

def deep_symbolize_keys!
  deep_transform_keys! do |key|
    key.to_sym
  rescue StandardError
    key
  end
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"}}



81
82
83
 
# File 'lib/hash.rb', line 81

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.



88
89
90
 
# File 'lib/hash.rb', line 88

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



22
23
24
 
# File 'lib/hash.rb', line 22

def stringify_keys
  transform_keys(&:to_s)
end

#stringify_keys! ⇒ Object

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



28
29
30
 
# File 'lib/hash.rb', line 28

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



39
40
41
42
43
44
45
 
# File 'lib/hash.rb', line 39

def symbolize_keys
  transform_keys do |key|
    key.to_sym
  rescue StandardError
    key
  end
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.



50
51
52
53
54
55
56
 
# File 'lib/hash.rb', line 50

def symbolize_keys!
  transform_keys! do |key|
    key.to_sym
  rescue StandardError
    key
  end
end