Module: ActiveSupport::CoreExtensions::Hash::Keys

Included in:
Hash
Defined in:
lib/active_support/core_ext/hash/keys.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.

Examples:

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

Raises:

  • (ArgumentError)

45
46
47
48
# File 'lib/active_support/core_ext/hash/keys.rb', line 45

def assert_valid_keys(*valid_keys)
  unknown_keys = keys - [valid_keys].flatten
  raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
end

#stringify_keysObject

Return a new hash with all keys converted to strings.


6
7
8
9
10
11
# File 'lib/active_support/core_ext/hash/keys.rb', line 6

def stringify_keys
  inject({}) do |options, (key, value)|
    options[key.to_s] = value
    options
  end
end

#stringify_keys!Object

Destructively convert all keys to strings.


14
15
16
17
18
19
# File 'lib/active_support/core_ext/hash/keys.rb', line 14

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

#symbolize_keysObject Also known as: to_options

Return a new hash with all keys converted to symbols.


22
23
24
25
26
27
# File 'lib/active_support/core_ext/hash/keys.rb', line 22

def symbolize_keys
  inject({}) do |options, (key, value)|
    options[(key.to_sym rescue key) || key] = value
    options
  end
end

#symbolize_keys!Object Also known as: to_options!

Destructively convert all keys to symbols.


30
31
32
# File 'lib/active_support/core_ext/hash/keys.rb', line 30

def symbolize_keys!
  self.replace(self.symbolize_keys)
end