class Mash
This class has dubious semantics and we only have it so that people can write params instead of params.
Public Class Methods
@return [Mash] Convert a Hash into a Mash The input Hash's default value is maintained
# File lib/chef/mash.rb, line 191 def self.from_hash(hash) mash = Mash.new(hash) mash.default = hash.default mash end
@param constructor<Object>
The default value for the mash. Defaults to an empty hash.
@details [Alternatives]
If constructor is a Hash, a new mash will be created based on the keys of the hash and no default value will be set.
# File lib/chef/mash.rb, line 59 def initialize(constructor = {}) if constructor.is_a?(Hash) super() update(constructor) else super(constructor) end end
Public Instance Methods
@param key<Object> The key to set. @param value<Object>
The value to set the key to.
@see #convert_key @see #convert_value
# File lib/chef/mash.rb, line 104 def []=(key, value) regular_writer(convert_key(key), convert_value(value)) end
@param key<Object> The default value for the mash. Defaults to nil.
@details [Alternatives]
If key is a Symbol and it is a key in the mash, then the default value will be set to the value matching the key.
# File lib/chef/mash.rb, line 87 def default(key = nil) if key.is_a?(Symbol) && include?(key = key.to_s) self[key] else super end end
@param key<Object>
The key to delete from the mash.\
# File lib/chef/mash.rb, line 157 def delete(key) super(convert_key(key)) end
@param *rejected<Array[(String, Symbol)] The mash keys to exclude.
@return [Mash] A new mash without the selected keys.
@example
{ :one => 1, :two => 2, :three => 3 }.except(:one) #=> { "two" => 2, "three" => 3 }
# File lib/chef/mash.rb, line 168 def except(*keys) super(*keys.map {|k| convert_key(k)}) end
@param key<Object> The key to fetch. This will be run through convert_key. @param *extras<Array> Default value.
@return [Object] The value at key or the default value.
# File lib/chef/mash.rb, line 136 def fetch(key, *extras) super(convert_key(key), *extras) end
@param key<Object> The key to check for. This will be run through convert_key.
@return [Boolean] True if the key exists in the mash.
# File lib/chef/mash.rb, line 123 def key?(key) super(convert_key(key)) end
@param hash<Hash> The hash to merge with the mash.
@return [Mash] A new mash with the hash values merged in.
# File lib/chef/mash.rb, line 151 def merge(hash) self.dup.update(hash) end
Used to provide the same interface as Hash.
@return [Mash] This mash unchanged.
# File lib/chef/mash.rb, line 175 def stringify_keys!; self end
@return [Hash] The mash as a Hash with symbolized keys.
# File lib/chef/mash.rb, line 178 def symbolize_keys h = Hash.new(default) each { |key, val| h[key.to_sym] = val } h end
@return [Hash] The mash as a Hash with string keys.
# File lib/chef/mash.rb, line 185 def to_hash Hash.new(default).merge(self) end
@param other_hash<Hash>
A hash to update values in the mash with. The keys and the values will be converted to Mash format.
@return [Mash] The updated mash.
# File lib/chef/mash.rb, line 113 def update(other_hash) other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) } self end
@param *indices<Array>
The keys to retrieve values for. These will be run through +convert_key+.
@return [Array] The values at each of the provided keys
# File lib/chef/mash.rb, line 144 def values_at(*indices) indices.collect {|key| self[convert_key(key)]} end
Protected Instance Methods
@param key<Object> The key to convert.
@param [Object]
The converted key. If the key was a symbol, it will be converted to a string.
@api private
# File lib/chef/mash.rb, line 205 def convert_key(key) key.kind_of?(Symbol) ? key.to_s : key end
@param value<Object> The value to convert.
@return [Object]
The converted value. A Hash or an Array of hashes, will be converted to their Mash equivalents.
@api private
# File lib/chef/mash.rb, line 216 def convert_value(value) if value.class == Hash Mash.from_hash(value) elsif value.is_a?(Array) value.collect { |e| convert_value(e) } else value end end