Class: Grendel::Mash

Inherits:
Hash
  • Object
show all
Defined in:
lib/grendel/mash.rb

Instance Method Summary collapse

Constructor Details

#initialize(constructor = {}) ⇒ Mash

Returns a new instance of Mash.

Parameters:

  • constructor (Object) (defaults to: {}) —

    The default value for the mash. Defaults to an empty hash.



15
16
17
18
19
20
21
22
 
# File 'lib/grendel/mash.rb', line 15

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

Instance Method Details

#[]=(key, value) ⇒ Object

Parameters:

  • key (Object) —

    The key to set.

  • value (Object) —

    The value to set the key to.

See Also:

  • #convert_key
  • #convert_value


46
47
48
 
# File 'lib/grendel/mash.rb', line 46

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

#default(key = nil) ⇒ Object

Parameters:

  • key (Object) (defaults to: nil) —

    The default value for the mash. Defaults to nil.



29
30
31
32
33
34
35
 
# File 'lib/grendel/mash.rb', line 29

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

#delete(key) ⇒ Object

Parameters:

  • key (Object) —

    The key to delete from the mash.\



104
105
106
 
# File 'lib/grendel/mash.rb', line 104

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

#dup ⇒ Mash

Returns A duplicate of this mash.

Returns:

  • (Mash) —

    A duplicate of this mash.



91
92
93
 
# File 'lib/grendel/mash.rb', line 91

def dup
  Mash.new(self)
end

#fetch(key, *extras) ⇒ Object

Returns The value at key or the default value.

Parameters:

  • key (Object) —

    The key to fetch. This will be run through convert_key.

  • *extras (Array) —

    Default value.

Returns:

  • (Object) —

    The value at key or the default value.



78
79
80
 
# File 'lib/grendel/mash.rb', line 78

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

#key?(key) ⇒ TrueClass, FalseClass Also known as: include?, has_key?, member?

Returns True if the key exists in the mash.

Parameters:

  • key (Object) —

    The key to check for. This will be run through convert_key.

Returns:

  • (TrueClass, FalseClass) —

    True if the key exists in the mash.



65
66
67
 
# File 'lib/grendel/mash.rb', line 65

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

#merge(hash) ⇒ Mash

Returns A new mash with the hash values merged in.

Parameters:

  • hash (Hash) —

    The hash to merge with the mash.

Returns:

  • (Mash) —

    A new mash with the hash values merged in.



98
99
100
 
# File 'lib/grendel/mash.rb', line 98

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

#regular_update ⇒ Object 



38
 
# File 'lib/grendel/mash.rb', line 38

alias_method :regular_update, :update

#regular_writer ⇒ Object 



37
 
# File 'lib/grendel/mash.rb', line 37

alias_method :regular_writer, :[]=

#stringify_keys! ⇒ Mash

Used to provide the same interface as Hash.

Returns:

  • (Mash) —

    This mash unchanged.



111
 
# File 'lib/grendel/mash.rb', line 111

def stringify_keys!; self end

#to_hash ⇒ Hash

Returns The mash as a Hash with string keys.

Returns:

  • (Hash) —

    The mash as a Hash with string keys.



114
115
116
 
# File 'lib/grendel/mash.rb', line 114

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

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

Returns The updated mash.

Parameters:

  • other_hash (Hash) —

    A hash to update values in the mash with. The keys and the values will be converted to Mash format.

Returns:

  • (Mash) —

    The updated mash.



55
56
57
58
 
# File 'lib/grendel/mash.rb', line 55

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

#values_at(*indices) ⇒ Array

Returns The values at each of the provided keys.

Parameters:

  • *indices (Array) —

    The keys to retrieve values for. These will be run through convert_key.

Returns:

  • (Array) —

    The values at each of the provided keys



86
87
88
 
# File 'lib/grendel/mash.rb', line 86

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