Class: Cyclid::API::Plugins::Action

Inherits:

Base

• Object
• Base
• Cyclid::API::Plugins::Action

Defined in:

app/cyclid/plugins/action.rb

Overview

Base class for Action plugins

Direct Known Subclasses

Cobertura, Command, Email, Log, Script, Simplecov, Slack

Class Method Summary

• .human_name ⇒ Object

  Return the ‘human’ name for the plugin type.

Instance Method Summary

• #initialize(args = {}) ⇒ Action constructor

  A new instance of Action.

• #perform(log) ⇒ Object

  Run the Action.

• #prepare(args = {}) ⇒ Object

  Provide any additional run-time data, such as the transport & context, that the plugin will require for perform() but didn’t get during initialize.

Methods inherited from Base

config?, config_schema, default_config, get_config, register_plugin, set_config, update_config

Constructor Details

#initialize(args = {}) ⇒ Action

Returns a new instance of Action.

# File 'app/cyclid/plugins/action.rb', line 24

def initialize(args = {})
end

Class Method Details

.human_name ⇒ Object

Return the ‘human’ name for the plugin type

# File 'app/cyclid/plugins/action.rb', line 28

def self.human_name
  'action'
end

Instance Method Details

#perform(log) ⇒ Object

Run the Action.

# File 'app/cyclid/plugins/action.rb', line 41

def perform(log)
end

#prepare(args = {}) ⇒ Object

Provide any additional run-time data, such as the transport & context, that the plugin will require for perform() but didn’t get during initialize.

# File 'app/cyclid/plugins/action.rb', line 35

def prepare(args = {})
  @transport = args[:transport]
  @ctx = args[:ctx]
end