class Hash

Public Instance Methods

assert_valid_keys(*valid_keys) click to toggle source

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
# File lib/api_recipes/utils.rb, line 71
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_merge(other_hash, &block) click to toggle source

Returns a new hash with self and other_hash merged recursively.

h1 = { a: true, b: { c: [1, 2, 3] } }
h2 = { a: false, b: { x: [3, 4, 5] } }

h1.deep_merge(h2) # => { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }

Like with Hash#merge in the standard library, a block can be provided to merge values:

h1 = { a: 100, b: 200, c: { c1: 100 } }
h2 = { b: 250, c: { c1: 200 } }
h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
# => { a: 100, b: 450, c: { c1: 300 } }
# File lib/api_recipes/utils.rb, line 94
def deep_merge(other_hash, &block)
  dup.deep_merge!(other_hash, &block)
end
deep_merge!(other_hash, &block) click to toggle source

Same as deep_merge, but modifies self.

# File lib/api_recipes/utils.rb, line 99
def deep_merge!(other_hash, &block)
  merge!(other_hash) do |key, this_val, other_val|
    if this_val.is_a?(Hash) && other_val.is_a?(Hash)
      this_val.deep_merge(other_val, &block)
    elsif block_given?
      block.call(key, this_val, other_val)
    else
      other_val
    end
  end
end
deep_stringify_keys() click to toggle source

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"}}
# File lib/api_recipes/utils.rb, line 138
def deep_stringify_keys
  deep_transform_keys{ |key| key.to_s }
end
deep_stringify_keys!() click to toggle source

Destructively convert all keys to strings. This includes the keys from the root hash and from all nested hashes and arrays.

# File lib/api_recipes/utils.rb, line 145
def deep_stringify_keys!
  deep_transform_keys!{ |key| key.to_s }
end
deep_symbolize_keys() click to toggle source

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"}}
# File lib/api_recipes/utils.rb, line 157
def deep_symbolize_keys
  deep_transform_keys{ |key| key.to_sym rescue key }
end
deep_symbolize_keys!() click to toggle source

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.

# File lib/api_recipes/utils.rb, line 164
def deep_symbolize_keys!
  deep_transform_keys!{ |key| key.to_sym rescue key }
end
deep_transform_keys(&block) click to toggle source

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"}}
# File lib/api_recipes/utils.rb, line 119
def deep_transform_keys(&block)
  _deep_transform_keys_in_object(self, &block)
end
deep_transform_keys!(&block) click to toggle source

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

# File lib/api_recipes/utils.rb, line 126
def deep_transform_keys!(&block)
  _deep_transform_keys_in_object!(self, &block)
end
stringify_keys() click to toggle source

Returns a new hash with all keys converted to strings.

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

hash.stringify_keys
# => {"name"=>"Rob", "age"=>"28"}
# File lib/api_recipes/utils.rb, line 33
def stringify_keys
  transform_keys{ |key| key.to_s }
end
stringify_keys!() click to toggle source

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

# File lib/api_recipes/utils.rb, line 39
def stringify_keys!
  transform_keys!{ |key| key.to_s }
end
symbolize_keys() click to toggle source

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"}
# File lib/api_recipes/utils.rb, line 50
def symbolize_keys
  transform_keys{ |key| key.to_sym rescue key }
end
Also aliased as: to_options
symbolize_keys!() click to toggle source

Destructively convert all keys to symbols, as long as they respond to to_sym. Same as symbolize_keys, but modifies self.

# File lib/api_recipes/utils.rb, line 57
def symbolize_keys!
  transform_keys!{ |key| key.to_sym rescue key }
end
Also aliased as: to_options!
to_options()
Alias for: symbolize_keys
to_options!()
Alias for: symbolize_keys!
transform_keys() { |key| ... } click to toggle source

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"}
# File lib/api_recipes/utils.rb, line 8
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!() { |key| ... } click to toggle source

Destructively convert all keys using the block operations. Same as transform_keys but modifies self.

# File lib/api_recipes/utils.rb, line 19
def transform_keys!
  return enum_for(:transform_keys!) unless block_given?
  keys.each do |key|
    self[yield(key)] = delete(key)
  end
  self
end

Private Instance Methods

_deep_transform_keys_in_object(object) { |key| ... } click to toggle source

support methods for deep transforming nested hashes and arrays

# File lib/api_recipes/utils.rb, line 170
def _deep_transform_keys_in_object(object, &block)
  case object
    when Hash
      object.each_with_object({}) do |(key, value), result|
        result[yield(key)] = _deep_transform_keys_in_object(value, &block)
      end
    when Array
      object.map {|e| _deep_transform_keys_in_object(e, &block) }
    else
      object
  end
end
_deep_transform_keys_in_object!(object) { |key| ... } click to toggle source
# File lib/api_recipes/utils.rb, line 183
def _deep_transform_keys_in_object!(object, &block)
  case object
    when Hash
      object.keys.each do |key|
        value = object.delete(key)
        object[yield(key)] = _deep_transform_keys_in_object!(value, &block)
      end
      object
    when Array
      object.map! {|e| _deep_transform_keys_in_object!(e, &block)}
    else
      object
  end
end