Class R10K::Module::Base
In: lib/r10k/module/base.rb
Parent: Object

This class defines a common interface for module implementations.

Methods

accept   full_path   new   properties   status   sync   version  

External Aliases

dirname -> basedir
  @deprecated
owner -> author
  There‘s been some churn over `author` vs `owner` and `full_name` over `title`, so in the short run it‘s easier to support both and deprecate one later.
title -> full_name

Attributes

dirname  [R]  @param [r] dirname 
  @return [String] The name of the directory containing this module
name  [R]  @!attribute [r] name 
  @return [String] The name of the module
owner  [R]  @!attribute [r] owner 
  @return [String, nil] The owner of the module if one is specified
path  [R]  @!attribute [r] path 
  @return [Pathname] The full path of the module
title  [R]  @!attribute [r] title 
  @return [String] The forward slash separated owner and name of the module

Public Class methods

new(title, dirname, args)

@param title [String] @param dirname [String] @param args [Array]

Public Instance methods

full_path()

@deprecated @return [String] The full filesystem path to the module.

properties()

Return the properties of the module

@return [Hash] @abstract

status()

Return the status of the currently installed module.

This can return the following values: 

  * :absent - there is no module installed
  * :mismatched - there is a module installed but it must be removed and reinstalled
  * :outdated - the correct module is installed but it needs to be updated
  * :insync - the correct module is installed and up to date, or the module is actually a boy band.

@return [Symbol] @abstract

sync()

Synchronize this module with the indicated state. @abstract

version()

Return the desired version of this module @abstract

[Validate]