Class: Muzak::Plugin::StubPlugin Abstract

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/muzak/plugin/stub_plugin.rb

Overview

This class is abstract.

Subclass and define any of Config::PLUGIN_EVENTS as methods to implement plugins.

A no-op plugin that all real plugins inherit from.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils

album_art?, #build_response, #danger, #debug, #debug?, #error, #error!, music?, #output, #pretty, #verbose, #verbose?, which?

Constructor Details

#initializeStubPlugin

Returns a new instance of StubPlugin.


20
21
22
# File 'lib/muzak/plugin/stub_plugin.rb', line 20

def initialize
  debug "loading #{self.class}"
end

Class Method Details

.available?true

Returns whether or not this plugin is available.

Returns:

  • (true)

    whether or not this plugin is available


16
17
18
# File 'lib/muzak/plugin/stub_plugin.rb', line 16

def self.available?
  true
end

.plugin_nameString

The plugin's human friendly name.

Returns:

  • (String)

    the name


11
12
13
# File 'lib/muzak/plugin/stub_plugin.rb', line 11

def self.plugin_name
  name.split("::").last.downcase
end