Class: Mail::IndifferentHash

Inherits:
Hash
  • Object
show all
Defined in:
lib/mail/indifferent_hash.rb

Direct Known Subclasses

ParameterHash

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(constructor = {}) ⇒ IndifferentHash

Returns a new instance of IndifferentHash



10
11
12
13
14
15
16
17
# File 'lib/mail/indifferent_hash.rb', line 10

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



27
28
29
30
31
# File 'lib/mail/indifferent_hash.rb', line 27

def self.new_from_hash_copying_default(hash)
  IndifferentHash.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"


41
42
43
# File 'lib/mail/indifferent_hash.rb', line 41

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

#default(key = nil) ⇒ Object



19
20
21
22
23
24
25
# File 'lib/mail/indifferent_hash.rb', line 19

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

#delete(key) ⇒ Object

Removes a specified key from the hash.



117
118
119
# File 'lib/mail/indifferent_hash.rb', line 117

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

#dupObject

Returns an exact copy of the hash.



96
97
98
# File 'lib/mail/indifferent_hash.rb', line 96

def dup
  IndifferentHash.new(self)
end

#fetch(key, *extras) ⇒ Object

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



80
81
82
# File 'lib/mail/indifferent_hash.rb', line 80

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:

  • (Boolean)


71
72
73
# File 'lib/mail/indifferent_hash.rb', line 71

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.



102
103
104
# File 'lib/mail/indifferent_hash.rb', line 102

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

#regular_updateObject



34
# File 'lib/mail/indifferent_hash.rb', line 34

alias_method :regular_update, :update

#regular_writerObject



33
# File 'lib/mail/indifferent_hash.rb', line 33

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.



108
109
110
# File 'lib/mail/indifferent_hash.rb', line 108

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

#reverse_merge!(other_hash) ⇒ Object



112
113
114
# File 'lib/mail/indifferent_hash.rb', line 112

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

#stringify_keysObject



122
# File 'lib/mail/indifferent_hash.rb', line 122

def stringify_keys; dup end

#stringify_keys!Object



121
# File 'lib/mail/indifferent_hash.rb', line 121

def stringify_keys!; self end

#symbolize_keysObject



123
# File 'lib/mail/indifferent_hash.rb', line 123

def symbolize_keys; to_hash.symbolize_keys end

#to_hashObject



126
127
128
# File 'lib/mail/indifferent_hash.rb', line 126

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

#to_options!Object



124
# File 'lib/mail/indifferent_hash.rb', line 124

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!"}


57
58
59
60
# File 'lib/mail/indifferent_hash.rb', line 57

def update(other_hash)
  other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
  self
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"]


91
92
93
# File 'lib/mail/indifferent_hash.rb', line 91

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