класс Hash

# File activesupport/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

Проверяет, соответствуют ли все ключи в хеше *valid_keys, вызывая ArgumentError при несоответствии.

Обратите внимание, что ключи обрабатываются иначе, чем HashWithIndifferentAccess, а это значит, что строковые и символьные ключи не будут совпадать.

{ 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 activesupport/lib/active_support/core_ext/enumerable.rb, line 208
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

Удаляет все пустые значения из Hash на месте и возвращает self. Использует Object#blank? для определения того, является ли значение пустым.

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

# File activesupport/lib/active_support/core_ext/object/deep_dup.rb, line 43
def deep_dup
  hash = dup
  each_pair do |key, value|
    if (::String === key && key.frozen?) || ::Symbol === key
      hash[key] = value.deep_dup
    else
      hash.delete(key)
      hash[key.deep_dup] = value.deep_dup
    end
  end
  hash
end

Возвращает глубокую копию хеша.

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

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

# File activesupport/lib/active_support/core_ext/hash/deep_merge.rb, line 18
def deep_merge(other_hash, &block)
  dup.deep_merge!(other_hash, &block)
end

Возвращает новый хеш со self и other_hash рекурсивно объединенными.

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

Как и в случае с Hash#merge в стандартной библиотеке, для объединения значений можно использовать блок:

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 activesupport/lib/active_support/core_ext/hash/deep_merge.rb, line 23
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_merge, но изменяет self.

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 84
def deep_stringify_keys
  deep_transform_keys(&:to_s)
end

Возвращает новый хеш со всеми ключами, преобразованными в строки. Это включает ключи из корневого хеша и из всех вложенных хешей и массивов.

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

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

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 91
def deep_stringify_keys!
  deep_transform_keys!(&:to_s)
end

Деструктивно преобразует все ключи в строки. Это включает ключи из корневого хеша и из всех вложенных хешей и массивов.

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 103
def deep_symbolize_keys
  deep_transform_keys { |key| key.to_sym rescue key }
end

Возвращает новый хеш со всеми ключами, преобразованными в символы, если они реагируют на to_sym. Это включает ключи из корневого хеша и из всех вложенных хешей и массивов.

hash = { 'person' => { 'name' => 'Rob', 'age' => '28' } }

hash.deep_symbolize_keys
# => {:person=>{:name=>"Rob", :age=>"28"}}

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 110
def deep_symbolize_keys!
  deep_transform_keys! { |key| key.to_sym rescue key }
end

Деструктивно преобразует все ключи в символы, если они реагируют на to_sym. Это включает ключи из корневого хеша и из всех вложенных хешей и массивов.

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 65
def deep_transform_keys(&block)
  _deep_transform_keys_in_object(self, &block)
end

Возвращает новый хеш со всеми ключами, преобразованными операцией блока. Это включает ключи из корневого хеша и из всех вложенных хешей и массивов.

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

hash.deep_transform_keys{ |key| key.to_s.upcase }
# => {"PERSON"=>{"NAME"=>"Rob", "AGE"=>"28"}}

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 72
def deep_transform_keys!(&block)
  _deep_transform_keys_in_object!(self, &block)
end

Деструктивно преобразует все ключи, используя операцию блока. Это включает ключи из корневого хеша и из всех вложенных хешей и массивов.

# File activesupport/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

Возвращает новый хеш со всеми значениями, преобразованными операцией блока. Это включает значения из корневого хеша и из всех вложенных хешей и массивов.

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

hash.deep_transform_values{ |value| value.to_s.upcase }
# => {person: {name: "ROB", age: "28"}}

# File activesupport/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

Деструктивно преобразует все значения, используя операцию блока. Это включает значения из корневого хеша и из всех вложенных хешей и массивов.

# File activesupport/lib/active_support/core_ext/hash/except.rb, line 12
def except(*keys)
  slice(*self.keys - keys)
end

Возвращает хеш, который включает все, кроме заданных ключей.

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 }

Это полезно для ограничения набора параметров всем, кроме нескольких известных переключателей:

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

# File activesupport/lib/active_support/core_ext/hash/except.rb, line 20
def except!(*keys)
  keys.each { |key| delete(key) }
  self
end

Удаляет заданные ключи из хеша и возвращает его.

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

# File activesupport/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

Удаляет и возвращает пары ключ/значение, соответствующие заданным ключам.

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

# File activesupport/lib/active_support/core_ext/array/extract_options.rb, line 9
def extractable_options?
  instance_of?(Hash)
end

По умолчанию, только экземпляры Hash сами по себе являются извлекаемыми. Подклассы Hash могут реализовать этот метод и вернуть true, чтобы объявить себя извлекаемыми. Если Hash извлекаем, Array#extract_options! извлекает его из Array, когда он является последним элементом Array.

# File activesupport/lib/active_support/core_ext/hash/reverse_merge.rb, line 14
def reverse_merge(other_hash)
  other_hash.merge(self)
end

Объединяет вызывающего в other_hash. Например,

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

эквивалентно

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

Это особенно полезно для инициализации хеша параметров значениями по умолчанию.

# File activesupport/lib/active_support/core_ext/hash/reverse_merge.rb, line 20
def reverse_merge!(other_hash)
  replace(reverse_merge(other_hash))
end

Деструктивное reverse_merge.

# File activesupport/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

Заменяет хэш только заданными ключами. Возвращает хэш, содержащий удалённые пары ключ/значение.

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

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 10
def stringify_keys
  transform_keys(&:to_s)
end

Возвращает новый хэш со всеми ключами, преобразованными в строки.

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

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

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 16
def stringify_keys!
  transform_keys!(&:to_s)
end

Деструктивно преобразует все ключи в строки. То же, что и stringify_keys, но изменяет self.

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 27
def symbolize_keys
  transform_keys { |key| key.to_sym rescue key }
end

Возвращает новый хэш со всеми ключами, преобразованными в символы, если они отвечают to_sym.

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

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

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 34
def symbolize_keys!
  transform_keys! { |key| key.to_sym rescue key }
end

Деструктивно преобразует все ключи в символы, если они отвечают to_sym. То же, что и symbolize_keys, но изменяет self.

# File activesupport/lib/active_support/core_ext/object/to_query.rb, line 77
def to_query(namespace = nil)
  query = collect do |key, value|
    unless (value.is_a?(Hash) || value.is_a?(Array)) && value.empty?
      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
    end
  end.compact

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

Возвращает строковое представление получателя, подходящее для использования в качестве строки запроса URL:

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

Можно передать необязательный параметр namespace для включения имён ключей:

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

Строки пар «ключ=значение», составляющие строку запроса, сортируются лексикографически по возрастанию.

Этот метод также алиасирован как to_param.

# File activesupport/lib/active_support/core_ext/hash/conversions.rb, line 75
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

Возвращает строку, содержащую XML-представление получателя:

{ 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>

Для этого метод перебирает пары и строит узлы, зависящие от значений. Учитывая пару key, value:

• Если value является хэшем, происходит рекурсивный вызов с key в качестве :root.

• Если value является массивом, происходит рекурсивный вызов с key в качестве :root, и key в виде единственного объекта как :children.

• Если value является вызываемым объектом, он должен принимать один или два аргумента. В зависимости от арности, вызываемый объект вызывается с хэшем options в качестве первого аргумента и key как :root, а key в единственном числе как второй аргумент. Вызываемый объект может добавлять узлы, используя options[:builder].

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

• Если value отвечает на to_xml, вызывается метод с key как :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>
  

• В противном случае создаётся узел с key в качестве тега со строковым представлением value как текстового узла. Если value является nil, добавляется атрибут «nil» со значением «true». Если опция :skip_types существует и имеет значение true, добавляется также атрибут «type» в соответствии со следующей схемой:

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

По умолчанию корневой узел — «hash», но это настраивается через опцию :root.

По умолчанию XML-строитель — новый экземпляр Builder::XmlMarkup. Можно настроить собственный строитель с помощью опции :builder. Метод также принимает опции, такие как :dasherize и аналогичные, которые передаются в строитель.

# File activesupport/lib/active_support/core_ext/hash/indifferent_access.rb, line 9
def with_indifferent_access
  ActiveSupport::HashWithIndifferentAccess.new(self)
end

Возвращает ActiveSupport::HashWithIndifferentAccess из своего получателя:

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