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.
433 434 435 |
# File 'lib/kitchen/configurable.rb', line 433 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.
502 503 504 |
# File 'lib/kitchen/configurable.rb', line 502 def defaults @defaults ||= {}.merge(super_defaults) end |
#diagnose ⇒ Hash
Returns a Hash of configuration and other useful diagnostic information.
403 404 405 406 407 408 409 |
# File 'lib/kitchen/configurable.rb', line 403 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.
463 464 465 |
# File 'lib/kitchen/configurable.rb', line 463 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.
521 522 523 |
# File 'lib/kitchen/configurable.rb', line 521 def @expanded_paths ||= {}.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.
395 396 397 |
# File 'lib/kitchen/configurable.rb', line 395 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.
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'lib/kitchen/configurable.rb', line 486 def required_config(attr, &block) unless 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.
509 510 511 512 513 514 515 |
# File 'lib/kitchen/configurable.rb', line 509 def super_defaults if superclass.respond_to?(:defaults) superclass.defaults else {} 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.
528 529 530 531 532 533 534 |
# File 'lib/kitchen/configurable.rb', line 528 def if superclass.respond_to?(:expanded_paths) superclass. else {} 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.
546 547 548 549 550 551 552 |
# File 'lib/kitchen/configurable.rb', line 546 def super_validations if superclass.respond_to?(:validations) superclass.validations else {} 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.
539 540 541 |
# File 'lib/kitchen/configurable.rb', line 539 def validations @validations ||= {}.merge(super_validations) end |