Method: Kitchen::Configurable::ClassMethods#default_config

Defined in:
lib/kitchen/configurable.rb

#default_config(attr, value = nil) {|object| ... } ⇒ Object

Sets a sane default value for a configuration attribute. These values can be overridden by provided configuration or in a subclass with another default_config declaration.

Examples:

a nil default value


default_config :i_am_nil

a primitive default value


default_config :use_sudo, true

a block to compute a default value


default_config :box_name do |subject|
  subject.instance.platform.name
end

Parameters:

  • attr (String)

    configuration attribute name

  • value (Object, nil) (defaults to: nil)

    static default value for attribute

Yield Parameters:

  • object (Object)

    a reference to the instantiated object

Yield Returns:

  • (Object, nil)

    dynamically computed value for the attribute



462
463
464
# File 'lib/kitchen/configurable.rb', line 462

def default_config(attr, value = nil, &block)
  defaults[attr] = block_given? ? block : value
end