класс 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

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

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

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 57
def initialize(constructor = {})
  if constructor.is_a?(Hash)
    super()
    update(constructor)
  else
    super(constructor)
  end
end

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 74
def self.new_from_hash_copying_default(hash)
  hash = hash.to_hash
  new(hash).tap do |new_hash|
    new_hash.default = hash.default
  end
end

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

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

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

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

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

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

Также использует алиасы: regular_writer, store

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

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

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

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

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 66
def default(key = nil)
  if key.is_a?(Symbol) && include?(key = key.to_s)
    self[key]
  else
    super
  end
end

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

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

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

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

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

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

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

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

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

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

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

То же, что и 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"

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

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

has_key?(ключ)

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

include?(ключ)

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

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

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

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

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

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

Также использует алиасы: include?, has_key?, member?

member?(ключ)

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

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

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

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

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

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

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

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

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

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 235
def reject(*args, &block)
  dup.tap { |hash| hash.reject!(*args, &block) }
end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 231
def select(*args, &block)
  dup.tap { |hash| hash.select!(*args, &block) }
end

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

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

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

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

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

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

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 240
def to_hash
  _new_hash= {}
  each do |key, value|
    _new_hash[convert_key(key)] = convert_value(value, for: :to_hash)
  end
  Hash.new(default).merge!(_new_hash)
end

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

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

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

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

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 и +“ключ”+, то только одно из значений попадет в получатель, но какое именно — не определено.

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

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

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

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

Также алиасируется как: regular_update, merge!

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

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

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

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

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

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

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

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

# File activesupport/lib/active_support/hash_with_indifferent_access.rb, line 249
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 253
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)
    unless options[:for] == :assignment
      value = value.dup
    end
    value.map! { |e| convert_value(e, options) }
  else
    value
  end
end