Class: Mash

Inherits:
Hash show all
Defined in:
lib/extlib/mash.rb

Overview

This class has dubious semantics and we only have it so that people can write params instead of params.

Instance Method Summary collapse

Methods inherited from Hash

#add_html_class!, #environmentize_keys!, #except, from_xml, #only, #protect_keys!, #to_mash, #to_params, #to_xml_attributes, #unprotect_keys!

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.



11
12
13
14
15
16
17
18
 
# File 'lib/extlib/mash.rb', line 11

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


42
43
44
 
# File 'lib/extlib/mash.rb', line 42

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.



25
26
27
28
29
30
31
 
# File 'lib/extlib/mash.rb', line 25

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.\



100
101
102
 
# File 'lib/extlib/mash.rb', line 100

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

#dup ⇒ Mash

Returns A duplicate of this mash.

Returns:

  • (Mash) —

    A duplicate of this mash.



87
88
89
 
# File 'lib/extlib/mash.rb', line 87

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.



74
75
76
 
# File 'lib/extlib/mash.rb', line 74

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:



61
62
63
 
# File 'lib/extlib/mash.rb', line 61

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.



94
95
96
 
# File 'lib/extlib/mash.rb', line 94

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

#regular_update ⇒ Object 



34
 
# File 'lib/extlib/mash.rb', line 34

alias_method :regular_update, :update

#regular_writer ⇒ Object 



33
 
# File 'lib/extlib/mash.rb', line 33

alias_method :regular_writer, :[]=

#stringify_keys! ⇒ Mash

Used to provide the same interface as Hash.

Returns:

  • (Mash) —

    This mash unchanged.



107
 
# File 'lib/extlib/mash.rb', line 107

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.



110
111
112
 
# File 'lib/extlib/mash.rb', line 110

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.



51
52
53
54
 
# File 'lib/extlib/mash.rb', line 51

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



82
83
84
 
# File 'lib/extlib/mash.rb', line 82

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