Class: Hash

Inherits:
Object
  • Object
show all
Defined in:
lib/mixpanel_mail/vendor/active_support/core_ext/hash/keys.rb,
lib/mixpanel_mail/vendor/active_support/core_ext/hash/slice.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: 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



41
42
43
44
45
46
 
# File 'lib/mixpanel_mail/vendor/active_support/core_ext/hash/keys.rb', line 41

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

#extract!(*keys) ⇒ Object

Removes and returns the key/value pairs matching the given keys.

{:a => 1, :b => 2, :c => 3, :d => 4}.extract!(:a, :b) # => {:a => 1, :b => 2}



35
36
37
38
39
 
# File 'lib/mixpanel_mail/vendor/active_support/core_ext/hash/slice.rb', line 35

def extract!(*keys)
  result = {}
  keys.each {|key| result[key] = delete(key) }
  result
end

#slice(*keys) ⇒ Object

Slice a hash to include only the given keys. This is useful for limiting an options hash to valid keys before passing to a method:

def search(criteria = {})
  assert_valid_keys(:mass, :velocity, :time)
end

search(options.slice(:mass, :velocity, :time))

If you have an array of keys you want to limit to, you should splat them:

valid_keys = [:mass, :velocity, :time]
search(options.slice(*valid_keys))



15
16
17
18
19
20
 
# File 'lib/mixpanel_mail/vendor/active_support/core_ext/hash/slice.rb', line 15

def slice(*keys)
  keys = keys.map! { |key| convert_key(key) } if respond_to?(:convert_key)
  hash = self.class.new
  keys.each { |k| hash[k] = self[k] if has_key?(k) }
  hash
end

#slice!(*keys) ⇒ Object

Replaces the hash with only the given keys. Returns a hash contained the removed key/value pairs

{:a => 1, :b => 2, :c => 3, :d => 4}.slice!(:a, :b) # => {:c => 3, :d => 4}



25
26
27
28
29
30
31
 
# File 'lib/mixpanel_mail/vendor/active_support/core_ext/hash/slice.rb', line 25

def slice!(*keys)
  keys = keys.map! { |key| convert_key(key) } if respond_to?(:convert_key)
  omit = slice(*self.keys - keys)
  hash = slice(*keys)
  replace(hash)
  omit
end

#stringify_keys ⇒ Object

Return a new hash with all keys converted to strings.



3
4
5
 
# File 'lib/mixpanel_mail/vendor/active_support/core_ext/hash/keys.rb', line 3

def stringify_keys
  dup.stringify_keys!
end

#stringify_keys! ⇒ Object

Destructively convert all keys to strings.



8
9
10
11
12
13
 
# File 'lib/mixpanel_mail/vendor/active_support/core_ext/hash/keys.rb', line 8

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

#symbolize_keys ⇒ Object Also known as: to_options

Return a new hash with all keys converted to symbols, as long as they respond to to_sym.



17
18
19
 
# File 'lib/mixpanel_mail/vendor/active_support/core_ext/hash/keys.rb', line 17

def symbolize_keys
  dup.symbolize_keys!
end

#symbolize_keys! ⇒ Object Also known as: to_options!

Destructively convert all keys to symbols, as long as they respond to to_sym.



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

def symbolize_keys!
  keys.each do |key|
    self[(key.to_sym rescue key) || key] = delete(key)
  end
  self
end