Class: Mail::IndifferentHash

Inherits:

Hash

• Object
• Hash
• Mail::IndifferentHash

show all

Defined in:

lib/mail/indifferent_hash.rb

Class Method Summary (collapse)

• + (Object) new_from_hash_copying_default(hash)

Instance Method Summary (collapse)

• - (Object) []=(key, value) (also: #store)

  Assigns a new value to the hash:.

• - (Object) default(key = nil)
• - (Object) delete(key)

  Removes a specified key from the hash.

• - (Object) dup

  Returns an exact copy of the hash.

• - (Object) fetch(key, *extras)

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

• - (IndifferentHash) initialize(constructor = {}) constructor

  A new instance of IndifferentHash.

• - (Boolean) key?(key) (also: #include?, #has_key?, #member?)

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

• - (Object) merge(hash)

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

• - (Object) regular_update
• - (Object) regular_writer
• - (Object) reverse_merge(other_hash)

  Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second.

• - (Object) reverse_merge!(other_hash)
• - (Object) stringify_keys
• - (Object) stringify_keys!
• - (Object) symbolize_keys
• - (Object) to_hash
• - (Object) to_options!
• - (Object) update(other_hash) (also: #merge!)

  Updates the instantized hash with values from the second:.

• - (Object) values_at(*indices)

  Returns an array of the values at the specified indices:.

9
10
11
12
13
14
15
16

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

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

26
27
28
29
30

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

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

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

40
41
42

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

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

18
19
20
21
22
23
24

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

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

116
117
118

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

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

95
96
97

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

def dup
  IndifferentHash.new(self)
end

79
80
81

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

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

hash = HashWithIndifferentAccess.new
hash["key"] = "value"
hash.key? :key  # => true
hash.key? "key" # => true

70
71
72

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

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

101
102
103

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

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

33

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

alias_method :regular_update, :update

32

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

alias_method :regular_writer, :[]=

107
108
109

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

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

111
112
113

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

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

121

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

def stringify_keys; dup end

120

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

def stringify_keys!; self end

122

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

def symbolize_keys; to_hash.symbolize_keys end

125
126
127

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

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

123

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

def to_options!; self end

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

56
57
58
59

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

def update(other_hash)
  other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
  self
end

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

90
91
92

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

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