class

Rails::Plugin

v2.3.8 - Show latest stable - 0 notes - Superclass: Object

1.0.0
1.1.6
1.2.6
2.0.3 (0)
2.1.0 (10)
2.2.1 (0)
2.3.8 (0)
3.0.0 (-2)
3.0.9 (-1)
3.1.0 (0)
3.2.1 (0)
3.2.8 (0)
3.2.13 (0)
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
7.1.3.4
What's this?

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"

Show files where this class is defined (3 files)

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

Rails::Plugin

Related