Class: Hash

Inherits:
Object show all
Defined in:
lib/capistrano_sentinel/initializers/active_support/blank.rb,
lib/capistrano_sentinel/initializers/active_support/hash_keys.rb

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.

{ 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

76
77
78
79
80
81
82
83
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 76

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_keysObject

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

112
113
114
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 112

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.


119
120
121
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 119

def deep_stringify_keys!
  deep_transform_keys!(&:to_s)
end

#deep_symbolize_keysObject

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

131
132
133
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 131

def deep_symbolize_keys
  deep_transform_keys{ |key| key.to_sym rescue key }
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.


138
139
140
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 138

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

93
94
95
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 93

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.


100
101
102
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 100

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

#stringify_keysObject

Returns a new hash with all keys converted to strings.

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

hash.stringify_keys
# => {"name"=>"Rob", "age"=>"28"}

38
39
40
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 38

def stringify_keys
  transform_keys(&:to_s)
end

#stringify_keys!Object

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


44
45
46
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 44

def stringify_keys!
  transform_keys!(&:to_s)
end

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

55
56
57
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 55

def symbolize_keys
  transform_keys{ |key| key.to_sym rescue key }
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.


62
63
64
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 62

def symbolize_keys!
  transform_keys!{ |key| key.to_sym rescue key }
end

#transform_keysObject

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

If you do not provide a block, it will return an Enumerator for chaining with other methods:

hash.transform_keys.with_index { |k, i| [k, i].join } # => {"name0"=>"Rob", "age1"=>"28"}

13
14
15
16
17
18
19
20
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 13

def transform_keys
  return enum_for(:transform_keys) { size } unless block_given?
  result = {}
  each_key do |key|
    result[yield(key)] = self[key]
  end
  result
end

#transform_keys!Object

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


24
25
26
27
28
29
30
# File 'lib/capistrano_sentinel/initializers/active_support/hash_keys.rb', line 24

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