Class: MotionSupport::HashWithIndifferentAccess

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

Overview

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

rgb = MotionSupport::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 = MotionSupport::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 = MotionSupport::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

#as_json, #assert_valid_keys, #deep_delete_if, #deep_dup, #deep_merge, #deep_merge!, #deep_symbolize_keys!, #deep_transform_keys, #deep_transform_keys!, #except, #except!, #extract!, #slice, #slice!, #symbolize_keys!, #to_json, #to_param, #transform_keys, #transform_keys!

Constructor Details

#initialize(constructor = {}) ⇒ HashWithIndifferentAccess

Returns a new instance of HashWithIndifferentAccess.



55
56
57
58
59
60
61
62
 
# File 'motion/hash_with_indifferent_access.rb', line 55

def initialize(constructor = {})
  if constructor.is_a?(Hash)
    super()
    update(constructor)
  else
    super(constructor)
  end
end

Class Method Details

.[](*args) ⇒ Object 



78
79
80
 
# File 'motion/hash_with_indifferent_access.rb', line 78

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

.new_from_hash_copying_default(hash) ⇒ Object 



72
73
74
75
76
 
# File 'motion/hash_with_indifferent_access.rb', line 72

def self.new_from_hash_copying_default(hash)
  new(hash).tap do |new_hash|
    new_hash.default = hash.default
  end
end

Instance Method Details

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

Assigns a new value to the hash:

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

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



91
92
93
 
# File 'motion/hash_with_indifferent_access.rb', line 91

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

#deep_stringify_keys ⇒ Object 



221
 
# File 'motion/hash_with_indifferent_access.rb', line 221

def deep_stringify_keys; dup end

#deep_stringify_keys! ⇒ Object 



219
 
# File 'motion/hash_with_indifferent_access.rb', line 219

def deep_stringify_keys!; self end

#deep_symbolize_keys ⇒ Object 



225
 
# File 'motion/hash_with_indifferent_access.rb', line 225

def deep_symbolize_keys; to_hash.deep_symbolize_keys end

#default(key = nil) ⇒ Object 



64
65
66
67
68
69
70
 
# File 'motion/hash_with_indifferent_access.rb', line 64

def default(key = nil)
  if key.is_a?(Symbol) && include?(key = key.to_s)
    self[key]
  else
    super
  end
end

#delete(key) ⇒ Object

Removes the specified key from the hash.



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

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

#dup ⇒ Object

Returns an exact copy of the hash.



177
178
179
180
181
 
# File 'motion/hash_with_indifferent_access.rb', line 177

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

#extractable_options? ⇒ Boolean

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

Returns:

  • (Boolean) 


43
44
45
 
# File 'motion/hash_with_indifferent_access.rb', line 43

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 = MotionSupport::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"



162
163
164
 
# File 'motion/hash_with_indifferent_access.rb', line 162

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 = MotionSupport::HashWithIndifferentAccess.new
hash['key'] = 'value'
hash.key?(:key)  # => true
hash.key?('key') # => true

Returns:

  • (Boolean) 


144
145
146
 
# File 'motion/hash_with_indifferent_access.rb', line 144

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.



186
187
188
 
# File 'motion/hash_with_indifferent_access.rb', line 186

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

#nested_under_indifferent_access ⇒ Object 



51
52
53
 
# File 'motion/hash_with_indifferent_access.rb', line 51

def nested_under_indifferent_access
  self
end

#regular_update ⇒ Object 



83
 
# File 'motion/hash_with_indifferent_access.rb', line 83

alias_method :regular_update, :update

#regular_writer ⇒ Object 



82
 
# File 'motion/hash_with_indifferent_access.rb', line 82

alias_method :regular_writer, :[]=

#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}



209
210
211
 
# File 'motion/hash_with_indifferent_access.rb', line 209

def replace(other_hash)
  super(self.class.new_from_hash_copying_default(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 = MotionSupport::HashWithIndifferentAccess.new
hash['a'] = nil
hash.reverse_merge(a: 0, b: 1) # => {"a"=>nil, "b"=>1}



196
197
198
 
# File 'motion/hash_with_indifferent_access.rb', line 196

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

#reverse_merge!(other_hash) ⇒ Object

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



201
202
203
 
# File 'motion/hash_with_indifferent_access.rb', line 201

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

#stringify_keys ⇒ Object 



220
 
# File 'motion/hash_with_indifferent_access.rb', line 220

def stringify_keys; dup end

#stringify_keys! ⇒ Object 



218
 
# File 'motion/hash_with_indifferent_access.rb', line 218

def stringify_keys!; self end

#symbolize_keys ⇒ Object 



224
 
# File 'motion/hash_with_indifferent_access.rb', line 224

def symbolize_keys; to_hash.symbolize_keys end

#to_hash ⇒ Object

Convert to a regular hash with string keys.



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

def to_hash
  Hash.new(default).merge!(self)
end

#to_options! ⇒ Object 



226
 
# File 'motion/hash_with_indifferent_access.rb', line 226

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 = MotionSupport::HashWithIndifferentAccess.new
hash_1[:key] = 'value'

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

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

The argument can be either an MotionSupport::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}



122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'motion/hash_with_indifferent_access.rb', line 122

def update(other_hash)
  if other_hash.is_a? HashWithIndifferentAccess
    super(other_hash)
  else
    other_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 = MotionSupport::HashWithIndifferentAccess.new
hash[:a] = 'x'
hash[:b] = 'y'
hash.values_at('a', 'b') # => ["x", "y"]



172
173
174
 
# File 'motion/hash_with_indifferent_access.rb', line 172

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

#with_indifferent_access ⇒ Object 



47
48
49
 
# File 'motion/hash_with_indifferent_access.rb', line 47

def with_indifferent_access
  dup
end