class Plugin

Ruby on Rails 2.3.18

Since v2.2.3 Last seen in v3.2.22.5

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5

The Plugin class should be an object which provides the following methods:

  • name - Used during initialisation to order the plugin (based on name and

    the contents of <tt>config.plugins</tt>).
  • valid? - Returns true if this plugin can be loaded.

  • load_paths - Each path within the returned array will be added to the $LOAD_PATH.

  • load - Finally ‘load’ the plugin.

These methods are expected by the Rails::Plugin::Locator and Rails::Plugin::Loader classes. The default implementation returns the lib directory as its load_paths, and evaluates init.rb when load is called.

You can also inspect the about.yml data programmatically:

plugin = Rails::Plugin.new(path_to_my_plugin)
plugin.about["author"] # => "James Adam"
plugin.about["url"] # => "http://interblah.net"

Inherits from

Object

Namespace

Classes

Includes

Attributes

Methods (defined here)

Private methods

(11) Implementation detail — not part of the public API.

Used by

Subclasses (1)

Methods (inherited)

From Object (37)
From Benchmark (2)

Type at least 2 characters to search.

↑↓ navigate · open · esc close