class

Rails::Plugin

v2.1.0 - Show latest stable - Superclass: Object

The <a href="/rails/Plugin">Plugin</a> 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"

Included modules

  • Comparable

Attributes

[R]directory
[R]name

Files

  • railties/lib/rails/plugin.rb
  • railties/lib/rails/plugin/loader.rb
  • railties/lib/rails/plugin/locator.rb

Nested classes and modules