class Lolcommits::Plugin

Attributes

default[RW]
name[RW]
options[RW]
runner[RW]

Public Class Methods

new(runner) click to toggle source
# File lib/lolcommits/plugin.rb, line 12
def initialize(runner)
  self.runner = runner
  self.options = ['enabled']

  plugdebug "Initializing"
end

Public Instance Methods

configuration() click to toggle source
# File lib/lolcommits/plugin.rb, line 6
def configuration
  config = runner.config.user_configuration
  return Hash.new if config.nil?
  config[self.name] || Hash.new
end
execute() click to toggle source
# File lib/lolcommits/plugin.rb, line 26
def execute
  if is_enabled?
    plugdebug "I am enabled, about to run"
    run
  else
    plugdebug "Disabled, doing nothing for execution"
  end
end
is_enabled?() click to toggle source
# File lib/lolcommits/plugin.rb, line 19
def is_enabled?
  enabled_config = configuration['enabled']
  return self.default if enabled_config.nil? || enabled_config == ''
  return enabled_config
end
plugdebug(msg) click to toggle source

uniform debug logging output for plugins

# File lib/lolcommits/plugin.rb, line 36
def plugdebug(msg)
  debug("Plugin: #{self.class.to_s}: " + msg)
end