Module: Kitchen::Configurable::ClassMethods
- Defined in:
- lib/kitchen/configurable.rb
Overview
Class methods which will be mixed in on inclusion of Configurable module.
Instance Method Summary collapse
-
#default_config(attr, value = nil) {|object| ... } ⇒ Object
Sets a sane default value for a configuration attribute.
-
#defaults ⇒ Hash
private
A hash of attribute keys and default values which has been merged with any superclass defaults.
-
#diagnose ⇒ Hash
Returns a Hash of configuration and other useful diagnostic information.
-
#expand_path_for(attr, value = true) {|object| ... } ⇒ Object
Ensures that an attribute which is a path will be fully expanded at the right time.
-
#expanded_paths ⇒ Hash
private
A hash of attribute keys and truthy/falsey values to determine if said attribute needs to be fully file path expanded, which has been merged with any superclass expanded paths.
-
#plugin_version(version) ⇒ Object
Sets the loaded version of this plugin, usually corresponding to the RubyGems version of the plugin's library.
-
#required_config(attr) {|attr, value, object| ... } ⇒ Object
Ensures that an attribute must have a non-nil, non-empty String value.
-
#super_defaults ⇒ Hash
private
A hash of defaults from the included class' superclass if defined in the superclass, or an empty hash otherwise.
-
#super_expanded_paths ⇒ Hash
private
A hash of expanded paths from the included class' superclass if defined in the superclass, or an empty hash otherwise.
-
#super_validations ⇒ Hash
private
A hash of validations from the included class' superclass if defined in the superclass, or an empty hash otherwise.
-
#validations ⇒ Hash
private
A hash of attribute keys and valudation callable blocks which has been merged with any superclass valudations.
Instance Method Details
#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.
375 376 377 |
# File 'lib/kitchen/configurable.rb', line 375 def default_config(attr, value = nil, &block) defaults[attr] = block_given? ? block : value end |
#defaults ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a hash of attribute keys and default values which has been merged with any superclass defaults.
444 445 446 |
# File 'lib/kitchen/configurable.rb', line 444 def defaults @defaults ||= Hash.new.merge(super_defaults) end |
#diagnose ⇒ Hash
Returns a Hash of configuration and other useful diagnostic information.
345 346 347 348 349 350 351 |
# File 'lib/kitchen/configurable.rb', line 345 def diagnose { :class => name, :version => @plugin_version, :api_version => @api_version } end |
#expand_path_for(attr, value = true) {|object| ... } ⇒ Object
Ensures that an attribute which is a path will be fully expanded at the right time. This helps make the configuration unambiguous and much easier to debug and diagnose.
Note that the file path expansion is only intended for paths on the local workstation invking the Test Kitchen code.
405 406 407 |
# File 'lib/kitchen/configurable.rb', line 405 def (attr, value = true, &block) [attr] = block_given? ? block : value end |
#expanded_paths ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a hash of attribute keys and truthy/falsey values to determine if said attribute needs to be fully file path expanded, which has been merged with any superclass expanded paths.
463 464 465 |
# File 'lib/kitchen/configurable.rb', line 463 def @expanded_paths ||= Hash.new.merge() end |
#plugin_version(version) ⇒ Object
Sets the loaded version of this plugin, usually corresponding to the
RubyGems version of the plugin's library. If the plugin does not set
this value, then nil
will be used and reported.
337 338 339 |
# File 'lib/kitchen/configurable.rb', line 337 def plugin_version(version) # rubocop:disable Style/TrivialAccessors @plugin_version = version end |
#required_config(attr) {|attr, value, object| ... } ⇒ Object
Ensures that an attribute must have a non-nil, non-empty String value. The default behavior will be to raise a user error and thereby halting further configuration processing. Good use cases for require_config might be cloud provider credential keys and other similar data.
428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/kitchen/configurable.rb', line 428 def required_config(attr, &block) if !block_given? klass = self block = lambda do |_, value, thing| if value.nil? || value.to_s.empty? attribute = "#{klass}#{thing.instance.to_str}#config[:#{attr}]" raise UserError, "#{attribute} cannot be blank" end end end validations[attr] = block end |
#super_defaults ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a hash of defaults from the included class' superclass if defined in the superclass, or an empty hash otherwise.
451 452 453 454 455 456 457 |
# File 'lib/kitchen/configurable.rb', line 451 def super_defaults if superclass.respond_to?(:defaults) superclass.defaults else Hash.new end end |
#super_expanded_paths ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a hash of expanded paths from the included class' superclass if defined in the superclass, or an empty hash otherwise.
470 471 472 473 474 475 476 |
# File 'lib/kitchen/configurable.rb', line 470 def if superclass.respond_to?(:expanded_paths) superclass. else Hash.new end end |
#super_validations ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a hash of validations from the included class' superclass if defined in the superclass, or an empty hash otherwise.
488 489 490 491 492 493 494 |
# File 'lib/kitchen/configurable.rb', line 488 def super_validations if superclass.respond_to?(:validations) superclass.validations else Hash.new end end |
#validations ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a hash of attribute keys and valudation callable blocks which has been merged with any superclass valudations.
481 482 483 |
# File 'lib/kitchen/configurable.rb', line 481 def validations @validations ||= Hash.new.merge(super_validations) end |