class Plugin

Ruby on Rails 2.2.3

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

Compare with:

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

Comparable

Attributes

Methods (defined here)

# <=>
# about
# load
# loaded?
# load_paths
# valid?
self. new

Private methods

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

Used by

Subclasses (1)

Rails::GemPlugin

Methods (inherited)

From Object (32)

From ActionController::Caching (3)

From ActionController::Cookies (2)

# cookies
self. included

From ActionController::Flash (1)

self. included

From ActionController::HttpAuthentication::Basic::ControllerMethods (3)

From ActionController::RecordIdentifier (5)

From ActionController::RequestForgeryProtection (8)

From ActionController::Rescue (7)

From ActionController::Streaming (2)

# send_data
# send_file

From ActionController::Translation (4)

# l
# localize
# t
# translate

From ActiveRecord::Callbacks (14)

From ActiveRecord::Dirty (4)

From ActiveRecord::Locking::Pessimistic (1)

# lock!

From ActiveRecord::NamedScope (1)

self. included

From ActiveRecord::Serialization (5)

From ActiveRecord::Transactions (4)

From ActiveRecord::Validations (7)

From Benchmark (1)

self. realtime

From ActionController::Components::InstanceMethods (2)

From ActiveRecord::Locking::Optimistic::ClassMethods (7)

From ActiveRecord::NamedScope::ClassMethods (2)

# named_scope
# scopes

From ActiveRecord::Serialization::ClassMethods (1)

# json_class_name

From ActiveRecord::Validations::ClassMethods (13)

From ActiveSupport::Memoizable (1)

# memoize