class ChefUtils::Mash

Public Class Methods

Source

# File lib/chef-utils/mash.rb, line 227
def self.from_hash(hash)
  mash = Mash.new(hash)
  mash.default = hash.default
  mash
end

@return [Mash] Convert a Hash into a Mash The input Hash’s default value is maintained

new (constructor = {})

Source

# File lib/chef-utils/mash.rb, line 61
def initialize(constructor = {})
  if constructor.is_a?(Hash)
    super()
    update(constructor)
  else
    super(constructor)
  end
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.

Calls superclass method

Public Instance Methods

[] (key)

Source

# File lib/chef-utils/mash.rb, line 118
def [](key)
  regular_reader(key)
end

@param key<Object> The key to get.

[]= (key, value)

Source

# File lib/chef-utils/mash.rb, line 128
def []=(key, value)
  regular_writer(convert_key(key), convert_value(value))
end

@param key<Object> The key to set. @param value<Object>

The value to set the key to.

@see Mash#convert_key @see Mash#convert_value

default (key = nil)

Source

# File lib/chef-utils/mash.rb, line 89
def default(key = nil)
  if key.is_a?(Symbol) && include?(key = key.to_s)
    self[key]
  else
    super
  end
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.

Calls superclass method

delete (key)

Source

# File lib/chef-utils/mash.rb, line 193
def delete(key)
  super(convert_key(key))
end

@param key<Object>

The key to delete from the mash.\

Calls superclass method

except (*keys)

Source

# File lib/chef-utils/mash.rb, line 204
def except(*keys)
  super(*keys.map { |k| convert_key(k) })
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 }

Calls superclass method

fetch (key, *extras)

Source

# File lib/chef-utils/mash.rb, line 172
def fetch(key, *extras)
  super(convert_key(key), *extras)
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.

Calls superclass method

has_key? (key)

Alias for: key?

include? (key)

def include? def has_key? def member?

Alias for: key?

initialize_copy (orig)

Source

# File lib/chef-utils/mash.rb, line 73
def initialize_copy(orig)
  super
  # Handle nested values
  each do |k, v|
    if v.is_a?(Mash) || v.is_a?(Array)
      self[k] = v.dup
    end
  end
  self
end

@param orig<Object> Mash being copied

@return [Object] A new copied Mash

Calls superclass method

internal_get (key)

Source

# File lib/chef-utils/mash.rb, line 134
def internal_get(key)
  regular_reader(key)
end

internal API for use by Chef’s deep merge cache @api private

internal_set (key, value)

Source

# File lib/chef-utils/mash.rb, line 140
def internal_set(key, value)
  regular_writer(key, convert_value(value))
end

internal API for use by Chef’s deep merge cache @api private

key? (key)

Source

# File lib/chef-utils/mash.rb, line 159
def key?(key)
  super(convert_key(key))
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.

Calls superclass method

Also aliased as: include?, has_key?, member?

member? (key)

Alias for: key?

merge (hash)

Source

# File lib/chef-utils/mash.rb, line 187
def merge(hash)
  dup.update(hash)
end

@param hash<Hash> The hash to merge with the mash.

@return [Mash] A new mash with the hash values merged in.

merge! (other_hash)

Alias for: update

stringify_keys! ()

Source

# File lib/chef-utils/mash.rb, line 211
def stringify_keys!; self end

Used to provide the same interface as Hash.

@return [Mash] This mash unchanged.

symbolize_keys ()

Source

# File lib/chef-utils/mash.rb, line 214
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 symbolized keys.

to_hash ()

Source

# File lib/chef-utils/mash.rb, line 221
def to_hash
  Hash.new(default).merge(self)
end

@return [Hash] The mash as a Hash with string keys.

update (other_hash)

Source

# File lib/chef-utils/mash.rb, line 149
def update(other_hash)
  other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
  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.

Also aliased as: merge!

values_at (*indices)

Source

# File lib/chef-utils/mash.rb, line 180
def values_at(*indices)
  indices.collect { |key| self[convert_key(key)] }
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

Protected Instance Methods

convert_key (key)

Source

# File lib/chef-utils/mash.rb, line 242
def convert_key(key)
  key.is_a?(Symbol) ? key.to_s : key
end

@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

convert_value (value)

Source

# File lib/chef-utils/mash.rb, line 253
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

@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