Ruby on Rails
Plugins

Introduction

A Rails plugin is either an extension or a modification of the core framework. Plugins provide:

a way for developers to share bleeding-edge ideas without hurting the stable code base
a segmented architecture so that units of code can be fixed or updated on their own release schedule
an outlet for the core developers so that they don’t have to include every cool new feature under the sun

Examples of plugin usage include an ‘acts_as_taggable’ mixin for ActiveRecord objects (makes tagging trivial), ‘file_column’ for ActiveRecord (makes file uploading and image resizing easy), and ‘globalize’ (adds multilingual and internationalization support to Rails).

To Install

You can add known plugin repositories by typing



script/plugin discover

Or for windows



ruby script\plugin discover

You can add a known plugin repository by url with



script/plugin source URL

Or for windows



ruby script\plugin source URL

Remove your repositories by typing



script/plugin unsource URL

Or for windows



ruby script\plugin unsource URL

To install a given plugin, from the root of your Rails application type



script/plugin install [name of plugin, or the url to the desired plugin]

You can also install a plugin using Piston so you can track/update changes easily, and you don’t depend on the original plugin repository. First install Piston:

sudo gem install piston

Then install the plugin as svn:externals and convert it:



script/plugin install -x [name of plugin, or the url to the desired plugin]

piston convert

If you’re developing on windows, navigate to the root of your application and type



ruby script\plugin install [url, or name of plugin]

Make sure you have SVN installed

If the install fails returning a definition of the svn “export” command:

Make sure that the directory path to your rails application does not contain any spaces, otherwise plugin will not work (bug)

See HowtoUseRailsWithSubversion on how to add plugins into your project’s Subversion repository.

Newly installed plugins won’t be available until you restart your webserver.

Installation Alternative

Use rapt , the Rails Plugin Tool. Install via gems:



sudo gem install rapt

Then search for a plugin:



rapt search “search words here”

Then install via the SVN method mentioned above:



rapt install results

Where ‘results’ are: http://the.url/listed/from/the/search/results

Plugin Documentation

To find out how to use a newly installed plugin navigate to your project directory and issue the following command:

rake doc:plugins

this will generate complete documentation for your project, including the installed plugins it uses. You can then view the html version of this documentation by pointing your browser at yourApp/doc/plugins.

Plugin Directory

A searchable plugin database
and RailsLodge plugin directory is also available.

Plugins By Category

Model Extensions

View Extensions

Controller Extensions

Searching and Query Plugins

Asset Plugins

Internationalization Plugins

Testing Plugins

Performance Plugins

Statistics and Logs

Authentication and Security Plugins

Other Plugins

Due to size restrictions on this page, plugin descriptions have been categorized above.
Bug: The ‘script/plugin’ script included in Rails 1.0 will scrape this page for subversion repositories and automatically include these plugins in its list of available plugins.
(Bug: ‘script/plugin discover’ only finds repository names in this page that contains the term ‘plugins’ )

So for a plugin repositiory to appear to ‘script/plugin discover’ it’s url must be listed below, and it’s url must contain a directory named ‘plugins’.

for a more complete plugin repository visit http://www.agilewebdevelopment.com/plugins/ or http://www.railslodge.com .