Class: Rockbox::Plugin

Inherits:

Object

• Object
• Rockbox::Plugin

Defined in:

lib/rockbox/plugin.rb

Overview

Plugin contract — duck-typed. A plugin must respond to:

#name        => String  (unique)
#version     => String
#install(ctx) => any    (called when registered)

Optional:

#description => String
#uninstall   => any     (called on unregister)

Inherit from Plugin or just implement the methods directly.

Instance Method Summary

• #description ⇒ Object
• #install(_context) ⇒ Object
• #name ⇒ Object
• #uninstall ⇒ Object
• #version ⇒ Object

Instance Method Details

#description ⇒ Object

# File 'lib/rockbox/plugin.rb', line 25

def description; nil; end

#install(_context) ⇒ Object

# File 'lib/rockbox/plugin.rb', line 26

def install(_context); end

#name ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/rockbox/plugin.rb', line 23

def name; raise NotImplementedError; end

#uninstall ⇒ Object

# File 'lib/rockbox/plugin.rb', line 27

def uninstall; end

#version ⇒ Object

# File 'lib/rockbox/plugin.rb', line 24

def version; "0.0.0"; end