class Mail::IndifferentHash - mail-2.5.4 Documentation

# class Mail::IndifferentHash

### Public Class Methods

new(constructor = {}) click to toggle source
Calls superclass method

    # File lib/mail/indifferent_hash.rb, line 8
    def initialize(constructor = {})
      if constructor.is_a?(Hash)
        super()
        update(constructor)
      else
        super(constructor)
      end
    end

new_from_hash_copying_default(hash) click to toggle source

    # File lib/mail/indifferent_hash.rb, line 25
    def self.new_from_hash_copying_default(hash)
      IndifferentHash.new(hash).tap do |new_hash|
        new_hash.default = hash.default
      end
    end

### Public Instance Methods

[]=(key, value) click to toggle source

Assigns a new value to the hash:

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

    # File lib/mail/indifferent_hash.rb, line 39
    def []=(key, value)
      regular_writer(convert_key(key), convert_value(value))
    end

Also aliased as: regular_writer, store
default(key = nil) click to toggle source
Calls superclass method

    # File lib/mail/indifferent_hash.rb, line 17
    def default(key = nil)
      if key.is_a?(Symbol) && include?(key = key.to_s)
        self[key]
      else
        super
      end
    end

delete(key) click to toggle source

Removes a specified key from the hash.

Calls superclass method

    # File lib/mail/indifferent_hash.rb, line 115
    def delete(key)
      super(convert_key(key))
    end

dup() click to toggle source

Returns an exact copy of the hash.

    # File lib/mail/indifferent_hash.rb, line 94
    def dup
      IndifferentHash.new(self)
    end

fetch(key, *extras) click to toggle source

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

Calls superclass method

    # File lib/mail/indifferent_hash.rb, line 78
    def fetch(key, *extras)
      super(convert_key(key), *extras)
    end

has_key?(key)
Alias for: key?
include?(key)
Alias for: key?
key?(key) click to toggle source

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

Calls superclass method

    # File lib/mail/indifferent_hash.rb, line 69
    def key?(key)
      super(convert_key(key))
    end

Also aliased as: include?, has_key?, member?
member?(key)
Alias for: key?
merge(hash) click to toggle source

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

    # File lib/mail/indifferent_hash.rb, line 100
    def merge(hash)
      self.dup.update(hash)
    end

merge!(other_hash)
Alias for: update
regular_update(other_hash)
Alias for: update
regular_writer(key, value)
Alias for: []=
reverse_merge(other_hash) click to toggle source

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.

Calls superclass method

    # File lib/mail/indifferent_hash.rb, line 106
    def reverse_merge(other_hash)
      super self.class.new_from_hash_copying_default(other_hash)
    end

reverse_merge!(other_hash) click to toggle source

    # File lib/mail/indifferent_hash.rb, line 110
    def reverse_merge!(other_hash)
      replace(reverse_merge( other_hash ))
    end

store(key, value)
Alias for: []=
stringify_keys() click to toggle source

    # File lib/mail/indifferent_hash.rb, line 120
    def stringify_keys; dup end

stringify_keys!() click to toggle source

    # File lib/mail/indifferent_hash.rb, line 119
    def stringify_keys!; self end

symbolize_keys() click to toggle source

    # File lib/mail/indifferent_hash.rb, line 121
    def symbolize_keys; to_hash.symbolize_keys end

to_hash() click to toggle source

    # File lib/mail/indifferent_hash.rb, line 124
    def to_hash
      Hash.new(default).merge!(self)
    end

to_options!() click to toggle source

    # File lib/mail/indifferent_hash.rb, line 122
    def to_options!; self end

update(other_hash) click to toggle source

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

    # File lib/mail/indifferent_hash.rb, line 55
    def update(other_hash)
      other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
      self
    end

Also aliased as: regular_update, merge!
values_at(*indices) click to toggle source

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"]

    # File lib/mail/indifferent_hash.rb, line 89
    def values_at(*indices)
      indices.collect {|key| self[convert_key(key)]}
    end

### Protected Instance Methods

convert_key(key) click to toggle source

    # File lib/mail/indifferent_hash.rb, line 130
    def convert_key(key)
      key.kind_of?(Symbol) ? key.to_s : key
    end

convert_value(value) click to toggle source

    # File lib/mail/indifferent_hash.rb, line 134
    def convert_value(value)
      if value.class == Hash
        self.class.new_from_hash_copying_default(value)
      elsif value.is_a?(Array)
        value.dup.replace(value.map { |e| convert_value(e) })
      else
        value
      end
    end