Class: Indifference::HashWithIndifferentAccess

Inherits:
Hash
  • Object
show all
Defined in:
lib/indifference/hash_with_indifferent_access.rb

Overview

Implements a hash where keys :foo and "foo" are considered to be the same.

rgb = Indifference::HashWithIndifferentAccess.new

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

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

Internally symbols are mapped to strings when used as keys in the entire writing interface (calling []=, merge, etc). This mapping belongs to the public interface. For example, given:

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

You are guaranteed that the key is returned as a string:

hash.keys # => ["a"]

Technically other types of keys are accepted:

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

but this class is intended for use cases where strings or symbols are the expected keys and it is convenient to understand both as the same. For example the params hash in Ruby on Rails.

Note that core extensions define Hash#with_indifferent_access:

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

which may be handy.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hash

#assert_valid_keys, #deep_symbolize_keys!, #deep_transform_keys, #deep_transform_keys!, #symbolize_keys!, #transform_keys, #transform_keys!

Constructor Details

#initialize(constructor = {}) ⇒ HashWithIndifferentAccess

Returns a new instance of HashWithIndifferentAccess.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 58

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

Class Method Details

.[](*args) ⇒ Object 



85
86
87
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 85

def self.[](*args)
  new.merge!(Hash[*args])
end

.new_from_hash_copying_default(hash) ⇒ Object 



81
82
83
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 81

def self.new_from_hash_copying_default(hash)
  new(hash)
end

Instance Method Details

#[](key) ⇒ Object

Same as Hash#[] where the key passed as argument can be either a string or a symbol:

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

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



169
170
171
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 169

def [](key)
  super(convert_key(key))
end

#[]=(key, value) ⇒ Object Also known as: store

Assigns a new value to the hash:

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

This value can be later fetched using either :key or 'key'.



98
99
100
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 98

def []=(key, value)
  regular_writer(convert_key(key), convert_value(value, for: :assignment))
end

#deep_stringify_keys ⇒ Object 



249
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 249

def deep_stringify_keys; dup end

#deep_stringify_keys! ⇒ Object 



247
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 247

def deep_stringify_keys!; self end

#deep_symbolize_keys ⇒ Object 



253
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 253

def deep_symbolize_keys; to_hash.deep_symbolize_keys! end

#default(*args) ⇒ Object 



71
72
73
74
75
76
77
78
79
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 71

def default(*args)
  arg_key = args.first

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

#delete(key) ⇒ Object

Removes the specified key from the hash.



242
243
244
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 242

def delete(key)
  super(convert_key(key))
end

#dup ⇒ Object

Returns a shallow copy of the hash.

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

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



205
206
207
208
209
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 205

def dup
  self.class.new(self).tap do |new_hash|
    set_defaults(new_hash)
  end
end

#extractable_options? ⇒ Boolean

Returns true so that Array#extract_options! finds members of this class.

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 46

def extractable_options?
  true
end

#fetch(key, *extras) ⇒ Object

Same as Hash#fetch where the key passed as argument can be either a string or a symbol:

counters = Indifference::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"



183
184
185
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 183

def fetch(key, *extras)
  super(convert_key(key), *extras)
end

#key?(key) ⇒ Boolean Also known as: include?, has_key?, member?

Checks the hash for a key matching the argument passed in:

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

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 151

def key?(key)
  super(convert_key(key))
end

#merge(hash, &block) ⇒ Object

This method has the same semantics of update, except it does not modify the receiver but rather returns a new hash with indifferent access with the result of the merge.



214
215
216
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 214

def merge(hash, &block)
  self.dup.update(hash, &block)
end

#nested_under_indifferent_access ⇒ Object 



54
55
56
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 54

def nested_under_indifferent_access
  self
end

#regular_update ⇒ Object 



90
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 90

alias_method :regular_update, :update

#regular_writer ⇒ Object 



89
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 89

alias_method :regular_writer, :[]=

#reject(*args, &block) ⇒ Object 



261
262
263
264
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 261

def reject(*args, &block)
  return to_enum(:reject) unless block_given?
  dup.tap { |hash| hash.reject!(*args, &block) }
end

#replace(other_hash) ⇒ Object

Replaces the contents of this hash with other_hash.

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



237
238
239
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 237

def replace(other_hash)
  super(self.class.new(other_hash))
end

#reverse_merge(other_hash) ⇒ Object

Like merge but the other way around: Merges the receiver into the argument and returns a new hash with indifferent access as result:

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



224
225
226
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 224

def reverse_merge(other_hash)
  super(self.class.new(other_hash))
end

#reverse_merge!(other_hash) ⇒ Object

Same semantics as reverse_merge but modifies the receiver in-place.



229
230
231
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 229

def reverse_merge!(other_hash)
  replace(reverse_merge( other_hash ))
end

#select(*args, &block) ⇒ Object 



256
257
258
259
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 256

def select(*args, &block)
  return to_enum(:select) unless block_given?
  dup.tap { |hash| hash.select!(*args, &block) }
end

#stringify_keys ⇒ Object 



248
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 248

def stringify_keys; dup end

#stringify_keys! ⇒ Object 



246
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 246

def stringify_keys!; self end

#symbolize_keys ⇒ Object 



252
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 252

def symbolize_keys; to_hash.symbolize_keys! end

#to_hash ⇒ Object

Convert to a regular hash with string keys.



267
268
269
270
271
272
273
274
275
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 267

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! ⇒ Object 



254
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 254

def to_options!; self end

#update(other_hash) ⇒ Object Also known as: merge!

Updates the receiver in-place, merging in the hash passed as argument:

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

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

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

The argument can be either an Indifference::HashWithIndifferentAccess or a regular Hash. In either case the merge respects the semantics of indifferent access.

If the argument is a regular hash with keys :key and “key” only one of the values end up in the receiver, but which one is unspecified.

When given a block, the value for duplicated keys will be determined by the result of invoking the block with the duplicated key, the value in the receiver, and the value in other_hash. The rules for duplicated keys follow the semantics of indifferent access:

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



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 129

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

#values_at(*indices) ⇒ Object

Returns an array of the values at the specified indices:

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



193
194
195
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 193

def values_at(*indices)
  indices.collect { |key| self[convert_key(key)] }
end

#with_indifferent_access ⇒ Object 



50
51
52
 
# File 'lib/indifference/hash_with_indifferent_access.rb', line 50

def with_indifferent_access
  dup
end