класс Object::HashWithIndifferentAccess

Родитель:: Hash

Реализует хэш, где ключи :foo и "foo" считаются одинаковыми.

rgb = ActiveSupport::HashWithIndifferentAccess.new

rgb[:black] = '#000000'
rgb[:black]  # => '#000000'
rgb['black'] # => '#000000'

rgb['white'] = '#FFFFFF'
rgb[:white]  # => '#FFFFFF'
rgb['white'] # => '#FFFFFF'

Внутренне символы отображаются в строки при использовании в качестве ключей во всем интерфейсе записи (вызов []=, merge, и т. д.). Это отображение относится к публичному интерфейсу. Например, при:

hash = ActiveSupport::HashWithIndifferentAccess.new(a: 1)

Вам гарантируется, что ключ будет возвращен как строка:

hash.keys # => ["a"]

Технически допускаются и другие типы ключей:

hash = ActiveSupport::HashWithIndifferentAccess.new(a: 1)
hash[0] = 0
hash # => {"a"=>1, 0=>0}

но этот класс предназначен для случаев, когда ожидаются ключи-строки или символы, и удобно воспринимать их как одинаковые. Например, хэш params в Ruby on Rails.

Обратите внимание, что расширения ядра определяют Hash#with_indifferent_access:

rgb = { black: '#000000', white: '#FFFFFF' }.with_indifferent_access

что может быть полезным.

Чтобы получить доступ к этому классу вне Rails, необходимо подключить расширение ядра с помощью:

require "active_support/core_ext/hash/indifferent_access"

что, в свою очередь, подключит этот файл.

Публичные методы класса

[](*args) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 96
def self.[](*args)
  new.merge!(Hash[*args])
end

new(constructor = {}) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 64
def initialize(constructor = {})
  if constructor.respond_to?(:to_hash)
    super()
    update(constructor)

    hash = constructor.to_hash
    self.default = hash.default if hash.default
    self.default_proc = hash.default_proc if hash.default_proc
  else
    super(constructor)
  end
end

Вызывает метод суперкласса

new_from_hash_copying_default(hash) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 87
    def self.new_from_hash_copying_default(hash)
      ActiveSupport::Deprecation.warn("        `ActiveSupport::HashWithIndifferentAccess.new_from_hash_copying_default`
        has been deprecated, and will be removed in Rails 5.1. The behavior of
        this method is now identical to the behavior of `.new`.
".squish)
      new(hash)
    end

Общедоступные методы экземпляров

[](ключ) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 180
def [](key)
  super(convert_key(key))
end

Аналогично Hash#[], где ключ, переданный в качестве аргумента, может быть строкой или символом:

counters = ActiveSupport::HashWithIndifferentAccess.new
counters[:foo] = 1

counters['foo'] # => 1
counters[:foo]  # => 1
counters[:zoo]  # => nil

Вызывает метод суперкласса

[]=(ключ, значение) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 109
def []=(key, value)
  regular_writer(convert_key(key), convert_value(value, for: :assignment))
end

Присваивает новое значение хэшу:

hash = ActiveSupport::HashWithIndifferentAccess.new
hash[:key] = 'value'

Это значение можно позже получить, используя :key или 'key'.

Также алиасирован как: regular_writer, store

compact() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 282
def compact
  dup.tap(&:compact!)
end

deep_stringify_keys() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 260
def deep_stringify_keys; dup end

deep_stringify_keys!() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 258
def deep_stringify_keys!; self end

deep_symbolize_keys() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 264
def deep_symbolize_keys; to_hash.deep_symbolize_keys! end

default(аргументы *args) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 77
def default(*args)
  arg_key = args.first

  if include?(key = convert_key(arg_key))
    self[key]
  else
    super
  end
end

Вызывает метод суперкласса

delete(ключ) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 253
def delete(key)
  super(convert_key(key))
end

Удаляет указанный ключ из хэша.

Вызывает метод суперкласса

dup() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 216
def dup
  self.class.new(self).tap do |new_hash|
    set_defaults(new_hash)
  end
end

Возвращает поверхностную копию хэша.

hash = ActiveSupport::HashWithIndifferentAccess.new({ a: { b: 'b' } })
dup  = hash.dup
dup[:a][:c] = 'c'

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

extractable_options?() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 52
def extractable_options?
  true
end

Возвращает true, чтобы Array#extract_options! находил члены этого класса.

fetch(ключ, *дополнительные) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 194
def fetch(key, *extras)
  super(convert_key(key), *extras)
end

Аналогично Hash#fetch, где ключ, переданный в качестве аргумента, может быть строкой или символом:

counters = ActiveSupport::HashWithIndifferentAccess.new
counters[:foo] = 1

counters.fetch('foo')          # => 1
counters.fetch(:bar, 0)        # => 0
counters.fetch(:bar) { |key| 0 } # => 0
counters.fetch(:zoo)           # => KeyError: key not found: "zoo"

Вызывает метод суперкласса

has_key?(ключ)

Псевдоним для: key?

include?(ключ)

Псевдоним для: key?

key?(ключ) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 162
def key?(key)
  super(convert_key(key))
end

Проверяет хэш на наличие ключа, соответствующего переданному аргументу:

hash = ActiveSupport::HashWithIndifferentAccess.new
hash['key'] = 'value'
hash.key?(:key)  # => true
hash.key?('key') # => true

Вызывает метод суперкласса

Также алиасирован как: include?, has_key?, member?

member?(ключ)

Псевдоним для: key?

merge(хэш, █) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 225
def merge(hash, &block)
  self.dup.update(hash, &block)
end

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

merge!(другой_хэш)

Псевдоним для: update

nested_under_indifferent_access() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 60
def nested_under_indifferent_access
  self
end

regular_update(другой_хэш)

Псевдоним для: update

regular_writer(ключ, значение)

Псевдоним для: []=

reject(аргументы *args, &блок) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 272
def reject(*args, &block)
  return to_enum(:reject) unless block_given?
  dup.tap { |hash| hash.reject!(*args, &block) }
end

replace(другой_хэш) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 248
def replace(other_hash)
  super(self.class.new(other_hash))
end

Заменяет содержимое этого хэша на другой_хэш.

h = { "a" => 100, "b" => 200 }
h.replace({ "c" => 300, "d" => 400 }) # => {"c"=>300, "d"=>400}

Вызывает метод суперкласса

reverse_merge(другой_хэш) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 235
def reverse_merge(other_hash)
  super(self.class.new(other_hash))
end

Подобно merge, но в обратном порядке: Сливает получателя в аргумент и возвращает новый хэш с неопределённым доступом в качестве результата:

hash = ActiveSupport::HashWithIndifferentAccess.new
hash['a'] = nil
hash.reverse_merge(a: 0, b: 1) # => {"a"=>nil, "b"=>1}

Вызывает метод суперкласса Hash#reverse_merge

reverse_merge!(другой_хэш) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 240
def reverse_merge!(other_hash)
  replace(reverse_merge( other_hash ))
end

Такая же семантика, как у reverse_merge, но изменяет получателя на месте.

select(аргументы *args, &блок) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 267
def select(*args, &block)
  return to_enum(:select) unless block_given?
  dup.tap { |hash| hash.select!(*args, &block) }
end

store(ключ, значение)

Псевдоним для: []=

stringify_keys() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 259
def stringify_keys; dup end

END_OF_DOCUMENT_MARKER

stringify_keys!() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 257
def stringify_keys!; self end

symbolize_keys() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 263
def symbolize_keys; to_hash.symbolize_keys! end

to_hash() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 287
def to_hash
  _new_hash = Hash.new
  set_defaults(_new_hash)

  each do |key, value|
    _new_hash[key] = convert_value(value, for: :to_hash)
  end
  _new_hash
end

Преобразовать в обычный хеш со строковыми ключами.

to_options!() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 265
def to_options!; self end

transform_values(*args, &block) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 277
def transform_values(*args, &block)
  return to_enum(:transform_values) unless block_given?
  dup.tap { |hash| hash.transform_values!(*args, &block) }
end

update(other_hash) { |convert_key(key), self, value| ... } Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 140
def update(other_hash)
  if other_hash.is_a? HashWithIndifferentAccess
    super(other_hash)
  else
    other_hash.to_hash.each_pair do |key, value|
      if block_given? && key?(key)
        value = yield(convert_key(key), self[key], value)
      end
      regular_writer(convert_key(key), convert_value(value))
    end
    self
  end
end

Обновляет получателя на месте, объединяя переданный в качестве аргумента хеш:

hash_1 = ActiveSupport::HashWithIndifferentAccess.new
hash_1[:key] = 'value'

hash_2 = ActiveSupport::HashWithIndifferentAccess.new
hash_2[:key] = 'New Value!'

hash_1.update(hash_2) # => {"key"=>"New Value!"}

Аргумент может быть как ActiveSupport::HashWithIndifferentAccess или обычным Hash. В любом случае объединение учитывает семантику доступа без различия типов ключей.

Если аргумент — это обычный хеш с ключами :key и +“key”+, только одно из значений попадет в получатель, но какое именно — не определено.

При использовании блока значение для дублирующихся ключей определяется результатом вызова блока с дублирующим ключом, значением в получателе и значением в other_hash. Правила для дублирующихся ключей следуют семантике доступа без различия типов ключей:

hash_1[:key] = 10
hash_2['key'] = 12
hash_1.update(hash_2) { |key, old, new| old + new } # => {"key"=>22}

Вызов метода суперкласса

Также алиасирован как: regular_update, merge!

values_at(*indices) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 204
def values_at(*indices)
  indices.collect { |key| self[convert_key(key)] }
end

Возвращает массив значений по указанным индексам:

hash = ActiveSupport::HashWithIndifferentAccess.new
hash[:a] = 'x'
hash[:b] = 'y'
hash.values_at('a', 'b') # => ["x", "y"]

with_indifferent_access() Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 56
def with_indifferent_access
  dup
end

Защищённые методы экземпляра

convert_key(key) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 298
def convert_key(key)
  key.kind_of?(Symbol) ? key.to_s : key
end

convert_value(value, options = {}) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 302
def convert_value(value, options = {})
  if value.is_a? Hash
    if options[:for] == :to_hash
      value.to_hash
    else
      value.nested_under_indifferent_access
    end
  elsif value.is_a?(Array)
    if options[:for] != :assignment || value.frozen?
      value = value.dup
    end
    value.map! { |e| convert_value(e, options) }
  else
    value
  end
end

set_defaults(target) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 319
def set_defaults(target)
  if default_proc
    target.default_proc = default_proc.dup
  else
    target.default = default
  end
end