Plugin

 Plugins have to include this module.

 IMPORTANT: Use extend for this module.

 See CodeRay::PluginHost for examples.
Methods
Attributes
[R] plugin_id
Public Instance methods
aliases()

→ show source

# File lib/coderay/helpers/plugin.rb, line 274
    def aliases
      plugin_host.load_plugin_map
      plugin_host.plugin_hash.inject [] do |aliases, (key, _)|
        aliases << key if plugin_host[key] == self
        aliases
      end
    end
plugin_host(host = nil)

The PluginHost for this Plugin class.

→ show source

# File lib/coderay/helpers/plugin.rb, line 267
    def plugin_host host = nil
      if host.is_a? PluginHost
        const_set :PLUGIN_HOST, host
      end
      self::PLUGIN_HOST
    end
register_for(id)

Register this class for the given id.

Example: 

  class MyPlugin < PluginHost::BaseClass
    register_for :my_id
    ...
  end

See PluginHost.register.

→ show source

# File lib/coderay/helpers/plugin.rb, line 251
    def register_for id
      @plugin_id = id
      plugin_host.register self, id
    end
title(title = nil)

Returns the title of the plugin, or sets it to the optional argument title.

→ show source

# File lib/coderay/helpers/plugin.rb, line 258
    def title title = nil
      if title
        @title = title.to_s
      else
        @title ||= name[/([^:]+)$/, 1]
      end
    end