класс ActiveSupport::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 80
def self.[](*args)
  new.merge!(Hash[*args])
end

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

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

    hash = constructor.is_a?(Hash) ? constructor : 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

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

Методы экземпляра публичного доступа

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 163
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 93
def []=(key, value)
  regular_writer(convert_key(key), convert_value(value, conversion: :assignment))
end

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

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

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

Также алиасируется как: regular_writer, store

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

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

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

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

counters.assoc('foo') # => ["foo", 1]
counters.assoc(:foo)  # => ["foo", 1]
counters.assoc(:zoo)  # => nil

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

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

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

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

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

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

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 218
def default(*args)
  super(*args.map { |arg| convert_key(arg) })
end

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

hash = ActiveSupport::HashWithIndifferentAccess.new(1)
hash.default                   # => 1

hash = ActiveSupport::HashWithIndifferentAccess.new { |hash, key| key }
hash.default                   # => nil
hash.default('foo')            # => 'foo'
hash.default(:foo)             # => 'foo'

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

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

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 203
def dig(*args)
  args[0] = convert_key(args[0]) if args.size > 0
  super(*args)
end

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

counters = ActiveSupport::HashWithIndifferentAccess.new
counters[:foo] = { bar: 1 }

counters.dig('foo', 'bar')     # => 1
counters.dig(:foo, :bar)       # => 1
counters.dig(:zoo)             # => nil

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 253
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"

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 296
def except(*keys)
  slice(*self.keys - keys.map { |key| convert_key(key) })
end

Также алиасируется как: without

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 190
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"

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

fetch_values(*индексы, &блок) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 241
def fetch_values(*indices, &block)
  super(*indices.map { |key| convert_key(key) }, &block)
end

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

hash = ActiveSupport::HashWithIndifferentAccess.new
hash[:a] = 'x'
hash[:b] = 'y'
hash.fetch_values('a', 'b') # => ["x", "y"]
hash.fetch_values('a', 'c') { |key| 'z' } # => ["x", "z"]
hash.fetch_values('a', 'c') # => KeyError: key not found: "c"

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

has_key?(ключ)

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

include?(ключ)

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 146
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 262
def merge(*hashes, &block)
  dup.update(*hashes, &block)
end

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

merge!(*другие_хэши, &блок)

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

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

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

regular_update(*другие_хэши, &блок)

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 317
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 287
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}

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

END_OF_DOCUMENT_MARKER

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 272
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

Также алиас: with_defaults

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

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

Такая же семантика, что и reverse_merge, но изменяет текущий объект на месте.

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

Также алиас: with_defaults!

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 340
def slice(*keys)
  keys.map! { |key| convert_key(key) }
  self.class.new(super)
end

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 345
def slice!(*keys)
  keys.map! { |key| convert_key(key) }
  super
end

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

store(key, value)

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

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

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

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

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

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

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

Также алиас: to_options

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

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

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

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

to_options()

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

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

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

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

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

transform_keys!() { |key| ... } Показать исходный код

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 127
def update(*other_hashes, &block)
  if other_hashes.size == 1
    update_with_single_argument(other_hashes.first, block)
  else
    other_hashes.each do |other_hash|
      update_with_single_argument(other_hash, block)
    end
  end
  self
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!"}

hash = ActiveSupport::HashWithIndifferentAccess.new
hash.update({ "a" => 1 }, { "b" => 2 }) # => { "a" => 1, "b" => 2 }

Аргументы могут быть либо 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(*keys) Показать исходный код

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 228
def values_at(*keys)
  super(*keys.map { |key| convert_key(key) })
end

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

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

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

with_defaults(other_hash)

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

with_defaults!(other_hash)

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

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

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

without(*keys)

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