Class: Hash

Inherits:
Object show all
Includes:
ActiveSupport::DeepMergeable
Defined in:
lib/active_support/core_ext/hash/keys.rb,
lib/active_support/core_ext/enumerable.rb,
lib/active_support/core_ext/hash/slice.rb,
lib/active_support/core_ext/hash/except.rb,
lib/active_support/core_ext/object/json.rb,
lib/active_support/core_ext/object/blank.rb,
lib/active_support/core_ext/hash/deep_merge.rb,
lib/active_support/core_ext/object/deep_dup.rb,
lib/active_support/core_ext/object/to_query.rb,
lib/active_support/core_ext/hash/conversions.rb,
lib/active_support/core_ext/hash/reverse_merge.rb,
lib/active_support/core_ext/array/extract_options.rb,
lib/active_support/core_ext/hash/indifferent_access.rb,
lib/active_support/core_ext/hash/deep_transform_values.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ActiveSupport::DeepMergeable

#deep_merge, #deep_merge!

Class Method Details

.from_trusted_xml(xml) ⇒ Object

Builds a Hash from XML just like Hash.from_xml, but also allows Symbol and YAML.



133
134
135
 
# File 'lib/active_support/core_ext/hash/conversions.rb', line 133

def from_trusted_xml(xml)
  from_xml xml, []
end

.from_xml(xml, disallowed_types = nil) ⇒ Object

Returns a Hash containing a collection of pairs when the key is the node name and the value is its content

xml = <<-XML
  <?xml version="1.0" encoding="UTF-8"?>
    <hash>
      <foo type="integer">1</foo>
      <bar type="integer">2</bar>
    </hash>
XML

hash = Hash.from_xml(xml)
# => {"hash"=>{"foo"=>1, "bar"=>2}}

DisallowedType is raised if the XML contains attributes with type="yaml" or type="symbol". Use Hash.from_trusted_xml to parse this XML.

Custom disallowed_types can also be passed in the form of an array.

xml = <<-XML
  <?xml version="1.0" encoding="UTF-8"?>
    <hash>
      <foo type="integer">1</foo>
      <bar type="string">"David"</bar>
    </hash>
XML

hash = Hash.from_xml(xml, ['integer'])
# => ActiveSupport::XMLConverter::DisallowedType: Disallowed type attribute: "integer"

Note that passing custom disallowed types will override the default types, which are Symbol and YAML.



128
129
130
 
# File 'lib/active_support/core_ext/hash/conversions.rb', line 128

def from_xml(xml, disallowed_types = nil)
  ActiveSupport::XMLConverter.new(xml, disallowed_types).to_h
end

Instance Method Details

#as_json(options = nil) ⇒ Object

:nodoc:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/active_support/core_ext/object/json.rb', line 172

def as_json(options = nil) # :nodoc:
  # create a subset of the hash by applying :only or :except
  subset = if options
    if attrs = options[:only]
      slice(*Array(attrs))
    elsif attrs = options[:except]
      except(*Array(attrs))
    else
      self
    end
  else
    self
  end

  result = {}
  subset.each do |k, v|
    result[k.to_s] = options ? v.as_json(options.dup) : v.as_json
  end
  result
end

#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



48
49
50
51
52
53
54
55
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 48

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

#compact_blank ⇒ Object

Hash#reject has its own definition, so this needs one too.



217
218
219
 
# File 'lib/active_support/core_ext/enumerable.rb', line 217

def compact_blank # :nodoc:
  reject { |_k, v| v.blank? }
end

#compact_blank! ⇒ Object

Removes all blank values from the Hash in place and returns self. Uses Object#blank? for determining if a value is blank.

h = { a: "", b: 1, c: nil, d: [], e: false, f: true }
h.compact_blank!
# => { b: 1, f: true }



227
228
229
230
 
# File 'lib/active_support/core_ext/enumerable.rb', line 227

def compact_blank!
  # use delete_if rather than reject! because it always returns self even if nothing changed
  delete_if { |_k, v| v.blank? }
end

#deep_dup ⇒ Object

Returns a deep copy of hash.

hash = { a: { b: 'b' } }
dup  = hash.deep_dup
dup[:a][:c] = 'c'

hash[:a][:c] # => nil
dup[:a][:c]  # => "c"



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/active_support/core_ext/object/deep_dup.rb', line 43

def deep_dup
  hash = dup
  each_pair do |key, value|
    if ::String === key || ::Symbol === key
      hash[key] = value.deep_dup
    else
      hash.delete(key)
      hash[key.deep_dup] = value.deep_dup
    end
  end
  hash
end

#deep_merge?(other) ⇒ Boolean

:method: deep_merge! :call-seq: deep_merge!(other_hash, &block)

Same as #deep_merge, but modifies self.

– Implemented by ActiveSupport::DeepMergeable#deep_merge!.

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/active_support/core_ext/hash/deep_merge.rb', line 39

def deep_merge?(other) # :nodoc:
  other.is_a?(Hash)
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"}}



84
85
86
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 84

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.



91
92
93
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 91

def deep_stringify_keys!
  deep_transform_keys!(&: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"}}



103
104
105
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 103

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.



110
111
112
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 110

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



65
66
67
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 65

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.



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

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



12
13
14
 
# File 'lib/active_support/core_ext/hash/deep_transform_values.rb', line 12

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.



19
20
21
 
# File 'lib/active_support/core_ext/hash/deep_transform_values.rb', line 19

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

#except(*keys) ⇒ Object

Returns a hash that includes everything except given keys.

hash = { a: true, b: false, c: nil }
hash.except(:c)     # => { a: true, b: false }
hash.except(:a, :b) # => { c: nil }
hash                # => { a: true, b: false, c: nil }

This is useful for limiting a set of parameters to everything but a few known toggles:

@person.update(params[:person].except(:admin))



12
13
14
 
# File 'lib/active_support/core_ext/hash/except.rb', line 12

def except(*keys)
  slice(*self.keys - keys)
end

#except!(*keys) ⇒ Object

Removes the given keys from hash and returns it.

hash = { a: true, b: false, c: nil }
hash.except!(:c) # => { a: true, b: false }
hash             # => { a: true, b: false }



20
21
22
23
 
# File 'lib/active_support/core_ext/hash/except.rb', line 20

def except!(*keys)
  keys.each { |key| delete(key) }
  self
end

#extract!(*keys) ⇒ Object

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

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



24
25
26
 
# File 'lib/active_support/core_ext/hash/slice.rb', line 24

def extract!(*keys)
  keys.each_with_object(self.class.new) { |key, result| result[key] = delete(key) if has_key?(key) }
end

#extractable_options? ⇒ Boolean

By default, only instances of Hash itself are extractable. Subclasses of Hash may implement this method and return true to declare themselves as extractable. If a Hash is extractable, Array#extract_options! pops it from the Array when it is the last element of the Array.

Returns:

  • (Boolean) 


9
10
11
 
# File 'lib/active_support/core_ext/array/extract_options.rb', line 9

def extractable_options?
  instance_of?(Hash)
end

#reverse_merge(other_hash) ⇒ Object Also known as: with_defaults

Merges the caller into other_hash. For example,

options = options.reverse_merge(size: 25, velocity: 10)

is equivalent to

options = { size: 25, velocity: 10 }.merge(options)

This is particularly useful for initializing an options hash with default values.



14
15
16
 
# File 'lib/active_support/core_ext/hash/reverse_merge.rb', line 14

def reverse_merge(other_hash)
  other_hash.merge(self)
end

#reverse_merge!(other_hash) ⇒ Object Also known as: reverse_update, with_defaults!

Destructive reverse_merge.



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

def reverse_merge!(other_hash)
  replace(reverse_merge(other_hash))
end

#slice!(*keys) ⇒ Object

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

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



10
11
12
13
14
15
16
17
 
# File 'lib/active_support/core_ext/hash/slice.rb', line 10

def slice!(*keys)
  omit = slice(*self.keys - keys)
  hash = slice(*keys)
  hash.default      = default
  hash.default_proc = default_proc if default_proc
  replace(hash)
  omit
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"}



10
11
12
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 10

def stringify_keys
  transform_keys(&:to_s)
end

#stringify_keys! ⇒ Object

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



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

def stringify_keys!
  transform_keys!(&: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"}



27
28
29
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 27

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.



34
35
36
 
# File 'lib/active_support/core_ext/hash/keys.rb', line 34

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

#to_query(namespace = nil) ⇒ Object Also known as: to_param

Returns a string representation of the receiver suitable for use as a URL query string:

{name: 'David', nationality: 'Danish'}.to_query
# => "name=David&nationality=Danish"

An optional namespace can be passed to enclose key names:

{name: 'David', nationality: 'Danish'}.to_query('user')
# => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"

The string pairs “key=value” that conform the query string are sorted lexicographically in ascending order.



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/active_support/core_ext/object/to_query.rb', line 75

def to_query(namespace = nil)
  query = filter_map do |key, value|
    unless (value.is_a?(Hash) || value.is_a?(Array)) && value.empty?
      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
    end
  end

  query.sort! unless namespace.to_s.include?("[]")
  query.join("&")
end

#to_xml(options = {}) ⇒ Object

Returns a string containing an XML representation of its receiver:

{ foo: 1, bar: 2 }.to_xml
# =>
# <?xml version="1.0" encoding="UTF-8"?>
# <hash>
#   <foo type="integer">1</foo>
#   <bar type="integer">2</bar>
# </hash>

To do so, the method loops over the pairs and builds nodes that depend on the values. Given a pair key, value:

  • If value is a hash there’s a recursive call with key as :root.

  • If value is an array there’s a recursive call with key as :root, and key singularized as :children.

  • If value is a callable object it must expect one or two arguments. Depending on the arity, the callable is invoked with the options hash as first argument with key as :root, and key singularized as second argument. The callable can add nodes by using options[:builder].

    {foo: lambda { |options, key| options[:builder].b(key) }}.to_xml
# => "<b>foo</b>"

  • If value responds to to_xml the method is invoked with key as :root.

    class Foo
  def to_xml(options)
    options[:builder].bar 'fooing!'
  end
end

{ foo: Foo.new }.to_xml(skip_instruct: true)
# =>
# <hash>
#   <bar>fooing!</bar>
# </hash>

  • Otherwise, a node with key as tag is created with a string representation of value as text node. If value is nil an attribute “nil” set to “true” is added. Unless the option :skip_types exists and is true, an attribute “type” is added as well according to the following mapping:

    XML_TYPE_NAMES = {
  "Symbol"     => "symbol",
  "Integer"    => "integer",
  "BigDecimal" => "decimal",
  "Float"      => "float",
  "TrueClass"  => "boolean",
  "FalseClass" => "boolean",
  "Date"       => "date",
  "DateTime"   => "dateTime",
  "Time"       => "dateTime"
}

By default the root node is “hash”, but that’s configurable via the :root option.

The default XML builder is a fresh instance of Builder::XmlMarkup. You can configure your own builder with the :builder option. The method also accepts options like :dasherize and friends, they are forwarded to the builder.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/active_support/core_ext/hash/conversions.rb', line 74

def to_xml(options = {})
  require "active_support/builder" unless defined?(Builder::XmlMarkup)

  options = options.dup
  options[:indent]  ||= 2
  options[:root]    ||= "hash"
  options[:builder] ||= Builder::XmlMarkup.new(indent: options[:indent])

  builder = options[:builder]
  builder.instruct! unless options.delete(:skip_instruct)

  root = ActiveSupport::XmlMini.rename_key(options[:root].to_s, options)

  builder.tag!(root) do
    each { |key, value| ActiveSupport::XmlMini.to_tag(key, value, options) }
    yield builder if block_given?
  end
end

#with_indifferent_access ⇒ Object Also known as: nested_under_indifferent_access

Returns an ActiveSupport::HashWithIndifferentAccess out of its receiver:

{ a: 1 }.with_indifferent_access['a'] # => 1



9
10
11
 
# File 'lib/active_support/core_ext/hash/indifferent_access.rb', line 9

def with_indifferent_access
  ActiveSupport::HashWithIndifferentAccess.new(self)
end