класс Hash

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 75
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/hash/compact.rb, line 9
def compact
  self.select { |_, value| !value.nil? }
end

Возвращает хеш без nil значений.

hash = { a: true, b: false, c: nil}
hash.compact # => { a: true, b: false}
hash # => { a: true, b: false, c: nil}
{ c: nil }.compact # => {}

# File activesupport/lib/active_support/core_ext/hash/compact.rb, line 20
def compact!
  self.reject! { |_, value| value.nil? }
end

Заменяет текущий хеш на хеш без nil значений.

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

# File activesupport/lib/active_support/core_ext/object/deep_dup.rb, line 41
def deep_dup
  hash = dup
  each_pair do |key, value|
    if key.frozen? && ::String === 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 16
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 21
def deep_merge!(other_hash, &block)
  other_hash.each_pair do |current_key, other_value|
    this_value = self[current_key]

    self[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
      this_value.deep_merge(other_value, &block)
    else
      if block_given? && key?(current_key)
        block.call(current_key, this_value, other_value)
      else
        other_value
      end
    end
  end

  self
end

То же самое, что и deep_merge, но изменяет self.

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 111
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 118
def deep_stringify_keys!
  deep_transform_keys!(&:to_s)
end

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

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 130
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 137
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 92
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 99
def deep_transform_keys!(&block)
  _deep_transform_keys_in_object!(self, &block)
end

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

# File activesupport/lib/active_support/core_ext/hash/except.rb, line 10
def except(*keys)
  dup.except!(*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 18
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 45
def extract!(*keys)
  keys.each_with_object(self.class.new) { |key, result| result[key] = delete(key) if has_key?(key) }
end

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

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

# File activesupport/lib/active_support/core_ext/array/extract_options.rb, line 7
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 12
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 17
def reverse_merge!(other_hash)
  # right wins if there is no left
  merge!( other_hash ){|key,left,right| left }
end

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

# File activesupport/lib/active_support/core_ext/hash/slice.rb, line 21
def slice(*keys)
  keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
  keys.each_with_object(self.class.new) { |k, hash| hash[k] = self[k] if has_key?(k) }
end

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

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

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

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

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

Если у вас есть массив ключей, которые вы хотите ограничить, вы должны использовать splat:

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

# File activesupport/lib/active_support/core_ext/hash/slice.rb, line 31
def slice!(*keys)
  keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
  omit = slice(*self.keys - keys)
  hash = slice(*keys)
  hash.default      = default
  hash.default_proc = default_proc if default_proc
  replace(hash)
  omit
end

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

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

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 37
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 43
def stringify_keys!
  transform_keys!(&:to_s)
end

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

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 54
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 61
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 75
def to_query(namespace = nil)
  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.sort! * '&'
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 73
def to_xml(options = {})
  require 'active_support/builder' unless defined?(Builder)

  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.

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

Метод также принимает такие опции, как :dasherize и другие, они передаются билдеру.

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

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

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

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

Если вы не предоставите block, он вернёт перечислитель для цепочки с другими методами:

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

# File activesupport/lib/active_support/core_ext/hash/keys.rb, line 23
def transform_keys!
  return enum_for(:transform_keys!) { size } unless block_given?
  keys.each do |key|
    self[yield(key)] = delete(key)
  end
  self
end

Деструктивно преобразует все ключи, используя операции block.

Аналогично transform_keys, но изменяет self.

# File activesupport/lib/active_support/core_ext/hash/transform_values.rb, line 11
def transform_values
  return enum_for(:transform_values) { size } unless block_given?
  return {} if empty?
  result = self.class.new
  each do |key, value|
    result[key] = yield(value)
  end
  result
end

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

{ a: 1, b: 2, c: 3 }.transform_values { |x| x * 2 } # => { a: 2, b: 4, c: 6 }

Если вы не предоставите block, он вернёт перечислитель для цепочки с другими методами:

{ a: 1, b: 2 }.transform_values.with_index { |v, i| [v, i].join.to_i } # => { a: 10, b: 21 }

# File activesupport/lib/active_support/core_ext/hash/transform_values.rb, line 23
def transform_values!
  return enum_for(:transform_values!) { size } unless block_given?
  each do |key, value|
    self[key] = yield(value)
  end
end

Деструктивно преобразует все значения, используя операции block.

Аналогично transform_values, но изменяет self.

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

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

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