Class: Gorillib::HashWithIndifferentAccess

Inherits:
Hash show all
Defined in:
lib/gorillib/hash/indifferent_access.rb

Direct Known Subclasses

HashWithIndifferentSymbolKeys

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hash

#tree_diff, zip

Methods included from Gorillib::Hashlike::DeepCompact

#deep_compact!

Methods included from Gorillib::Hashlike::TreeMerge

#tree_merge!

Methods included from Gorillib::Hashlike::DeepMerge

#deep_merge, #deep_merge!

Methods included from Gorillib::Hashlike::Serialization

#to_wire

Methods included from Gorillib::Hashlike::DeepDup

#deep_dup

Methods included from Gorillib::Hashlike::Compact

#compact, #compact!, #compact_blank, #compact_blank!

Methods included from Gorillib::Hashlike::Slice

#slice, #slice!

Methods included from Gorillib::Hashlike::Keys

#assert_valid_keys, #symbolize_keys!

Constructor Details

#initialize(constructor = {}) ⇒ HashWithIndifferentAccess

Returns a new instance of HashWithIndifferentAccess.



17
18
19
20
21
22
23
24
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 17

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

Class Method Details

.new_from_hash_copying_default(hash) ⇒ Object 



34
35
36
37
38
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 34

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 = HashWithIndifferentAccess.new
hash[:key] = "value"



48
49
50
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 48

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

#assoc(key) ⇒ Object 



146
147
148
149
150
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 146

def assoc key
  key = convert_key(key)
  return unless has_key?(key)
  [key, self[key]]
end

#default(key = nil) ⇒ Object 



26
27
28
29
30
31
32
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 26

def default(key = nil)
  if include?(converted = convert_key(key))
    self[converted]
  else
    super
  end
end

#delete(key) ⇒ Object

Removes a specified key from the hash.



131
132
133
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 131

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

#dup ⇒ Object

Returns an exact copy of the hash.



108
109
110
111
112
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 108

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

#extractable_options? ⇒ Boolean

Returns:



9
10
11
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 9

def extractable_options?
  true
end

#fetch(key, *extras) ⇒ Object

Fetches the value for the specified key, same as doing hash



92
93
94
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 92

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

Returns:



83
84
85
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 83

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

#merge(hash) ⇒ Object

Merges the instantized and the specified hashes together, giving precedence to the values from the second hash Does not overwrite the existing hash.



116
117
118
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 116

def merge(hash)
  self.dup.update(hash)
end

#rassoc(val) ⇒ Object 



152
153
154
155
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 152

def rassoc val
  key = key(val) or return
  [key, self[key]]
end

#regular_update ⇒ Object 



41
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 41

alias_method :regular_update, :update

#regular_writer ⇒ Object 



40
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 40

alias_method(:regular_writer, :[]=)

#reverse_merge(other_hash) ⇒ Object

Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second. This overloaded definition prevents returning a regular hash, if reverse_merge is called on a HashWithDifferentAccess.



122
123
124
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 122

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

#reverse_merge!(other_hash) ⇒ Object 



126
127
128
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 126

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

#stringify_keys ⇒ Object 



136
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 136

def stringify_keys; dup end

#stringify_keys! ⇒ Object 



135
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 135

def stringify_keys!; self end

#symbolize_keys ⇒ Object 



138
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 138

def symbolize_keys; to_hash.symbolize_keys end

#to_hash ⇒ Object

Convert to a Hash with String keys.



142
143
144
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 142

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

#to_options! ⇒ Object 



139
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 139

def to_options!; self end

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

Updates the instantized hash with values from the second:

hash_1 = HashWithIndifferentAccess.new
hash_1[:key] = "value"

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

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

Raises:

  • (TypeError) 


64
65
66
67
68
69
70
71
72
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 64

def update(other_hash)
  raise TypeError, "can't convert #{other_hash.nil? ? 'nil' : other_hash.class} into Hash" unless other_hash.respond_to?(:each_pair)
  if other_hash.is_a? HashWithIndifferentAccess
    super(other_hash)
  else
    other_hash.each_pair{|key, value| regular_writer(convert_key(key), convert_value(value)) }
    self
  end
end

#values_at(*indices) ⇒ Object

Returns an array of the values at the specified indices:

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



103
104
105
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 103

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

#with_indifferent_access ⇒ Object 



13
14
15
 
# File 'lib/gorillib/hash/indifferent_access.rb', line 13

def with_indifferent_access
  dup
end