Class: Hash

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

Overview

:nocov:

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



95
96
97
98
99
100
101
102
 
# File 'lib/fancybox2/core_ext/hash.rb', line 95

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



131
132
133
 
# File 'lib/fancybox2/core_ext/hash.rb', line 131

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



138
139
140
 
# File 'lib/fancybox2/core_ext/hash.rb', line 138

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

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

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



150
151
152
 
# File 'lib/fancybox2/core_ext/hash.rb', line 150

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



157
158
159
 
# File 'lib/fancybox2/core_ext/hash.rb', line 157

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



112
113
114
 
# File 'lib/fancybox2/core_ext/hash.rb', line 112

def deep_transform_keys(&block)
  _deep_transform_keys_in_object(self, &block)
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 and arrays.



119
120
121
 
# File 'lib/fancybox2/core_ext/hash.rb', line 119

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

#deep_transform_values(&block) ⇒ Object

Returns a new hash with all values converted by the block operation. This includes the values from the root hash and from all nested hashes and arrays.

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

hash.deep_transform_values{ |value| value.to_s.upcase }
# => {person: {name: "ROB", age: "28"}}



13
14
15
 
# File 'lib/fancybox2/core_ext/hash.rb', line 13

def deep_transform_values(&block)
  _deep_transform_values_in_object(self, &block)
end

#deep_transform_values!(&block) ⇒ Object

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



20
21
22
 
# File 'lib/fancybox2/core_ext/hash.rb', line 20

def deep_transform_values!(&block)
  _deep_transform_values_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"}



55
56
57
 
# File 'lib/fancybox2/core_ext/hash.rb', line 55

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.



61
62
63
 
# File 'lib/fancybox2/core_ext/hash.rb', line 61

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



72
73
74
 
# File 'lib/fancybox2/core_ext/hash.rb', line 72

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.



80
81
82
 
# File 'lib/fancybox2/core_ext/hash.rb', line 80

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



30
31
32
33
34
35
36
37
 
# File 'lib/fancybox2/core_ext/hash.rb', line 30

def transform_keys
  return enum_for(:transform_keys) unless block_given?
  result = self.class.new
  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.



41
42
43
44
45
46
47
 
# File 'lib/fancybox2/core_ext/hash.rb', line 41

def transform_keys!
  return enum_for(:transform_keys!) unless block_given?
  keys.each do |key|
    self[yield(key)] = delete(key)
  end
  self
end