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
After reading this guide you should be familiar with:
* Creating a plugin from scratch
* Writing and running tests for the plugin
* Storing models, views, controllers, helpers and even other plugins in your plugins
* Writing generators
* Writing custom Rake tasks in your plugin
* Generating RDoc documentation for your plugin
* Avoiding common pitfalls with 'init.rb'
This guide describes how to build a test-driven plugin that will:
* Extend core ruby classes like Hash and String
* Add methods to ActiveRecord::Base in the tradition of the 'acts_as' plugins
* Add a view helper that can be used in erb templates
* Add a new generator that will generate a migration
* Add a custom generator command
* A custom route method that can be used in routes.rb
For the purpose of this guide pretend for a moment that you are an avid bird watcher. Your favorite bird is the Yaffle, and you want to create a plugin that allows other developers to share in the Yaffle goodness. First, you need to get setup for development.
endprologue.
h3. Setup
h4. Create the basic app
The examples in this guide require that you have a working rails application. To create a simple rails app execute:
<pre>
gem install rails
rails yaffle_guide
cd yaffle_guide
script/generate scaffold bird name:string
rake db:migrate
script/server
</pre>
Then navigate to http://localhost:3000/birds. Make sure you have a functioning rails app before continuing.
NOTE: The aforementioned instructions will work for sqlite3. For more detailed instructions on how to create a rails app for other databases see the API docs.
Rails ships with a plugin generator which creates a basic plugin skeleton. Pass the plugin name, either 'CamelCased' or 'under_scored', as an argument. Pass +--with-generator+ to add an example generator also.
To make it easy to organize your files and to make the plugin more compatible with GemPlugins, start out by altering your file system to look like this:
<pre>
|-- lib
| |-- yaffle
| `-- yaffle.rb
`-- rails
|
`-- init.rb
</pre>
*vendor/plugins/yaffle/rails/init.rb*
<ruby>
require 'yaffle'
</ruby>
Now you can add any 'require' statements to 'lib/yaffle.rb' and keep 'init.rb' clean.
h3. Tests
In this guide you will learn how to test your plugin against multiple different database adapters using Active Record. To setup your plugin to allow for easy testing you'll need to add 3 files:
* A 'database.yml' file with all of your connection strings
Now whenever you write a test that requires the database, you can call 'load_schema'.
h4. Run the plugin tests
Once you have these files in place, you can write your first test to ensure that your plugin-testing setup is correct. By default rails generates a file in 'vendor/plugins/yaffle/test/yaffle_test.rb' with a sample test. Replace the contents of that file with:
Loaded suite /opt/local/lib/ruby/gems/1.8/gems/rake-0.8.3/lib/rake/rake_test_loader
Started
.
Finished in 0.002236 seconds.
1 test, 1 assertion, 0 failures, 0 errors
</shell>
By default the setup above runs your tests with sqlite or sqlite3. To run tests with one of the other connection strings specified in database.yml, pass the DB environment variable to rake:
<shell>
rake DB=sqlite
rake DB=sqlite3
rake DB=mysql
rake DB=postgresql
</shell>
Now you are ready to test-drive your plugin!
h3. Extending core classes
This section will explain how to add a method to String that will be available anywhere in your rails app.
In this example you will add a method to String named +to_squawk+. To begin, create a new test file with a few assertions:
Then in 'lib/yaffle.rb' require 'lib/core_ext.rb':
* *vendor/plugins/yaffle/lib/yaffle.rb*
<ruby>
require "yaffle/core_ext"
</ruby>
Finally, create the 'core_ext.rb' file and add the 'to_squawk' method:
* *vendor/plugins/yaffle/lib/yaffle/core_ext.rb*
<ruby>
String.class_eval do
def to_squawk
"squawk! #{self}".strip
end
end
</ruby>
To test that your method does what it says it does, run the unit tests with +rake+ from your plugin directory. To see this in action, fire up a console and start squawking:
<shell>
$ ./script/console
>> "Hello World".to_squawk
=> "squawk! Hello World"
</shell>
h4. Working with init.rb
When rails loads plugins it looks for the file named 'init.rb' or 'rails/init.rb'. However, when the plugin is initialized, 'init.rb' is invoked via +eval+ (not +require+) so it has slightly different behavior.
Under certain circumstances if you reopen classes or modules in 'init.rb' you may inadvertently create a new class, rather than reopening an existing class. A better alternative is to reopen the class in a different file, and require that file from +init.rb+, as shown above.
If you must reopen a class in +init.rb+ you can use +module_eval+ or +class_eval+ to avoid any issues:
* *vendor/plugins/yaffle/rails/init.rb*
<ruby>
Hash.class_eval do
def is_a_special_hash?
true
end
end
</ruby>
Another way is to explicitly define the top-level module space for all modules and classes, like +::Hash+:
* *vendor/plugins/yaffle/rails/init.rb*
<ruby>
class ::Hash
def is_a_special_hash?
true
end
end
</ruby>
h3. Add an 'acts_as' method to Active Record
A common pattern in plugins is to add a method called 'acts_as_something' to models. In this case, you want to write a method called 'acts_as_yaffle' that adds a 'squawk' method to your models.
Note that after requiring 'acts_as_yaffle' you also have to include it into ActiveRecord::Base so that your plugin methods will be available to the rails models.
One of the most common plugin patterns for 'acts_as_yaffle' plugins is to structure your file like so:
# any method placed here will apply to classes, like Hickwall
def acts_as_something
send :include, InstanceMethods
end
end
module InstanceMethods
# any method placed here will apply to instaces, like @hickwall
end
end
</ruby>
With structure you can easily separate the methods that will be used for the class (like +Hickwall.some_method+) and the instance (like +@hickwell.some_method+).
h4. Add a class method
This plugin will expect that you've added a method to your model named 'last_squawk'. However, the plugin users might have already defined a method on their model named 'last_squawk' that they use for something else. This plugin will allow the name to be changed by adding a class method called 'yaffle_text_field'.
To start out, write a failing test that shows the behavior you'd like:
This plugin will add a method named 'squawk' to any Active Record objects that call 'acts_as_yaffle'. The 'squawk' method will simply set the value of one of the fields in the database.
To start out, write a failing test that shows the behavior you'd like:
NOTE: The use of +write_attribute+ to write to the field in model is just one example of how a plugin can interact with the model, and will not always be the right method to use. For example, you could also use +send("#{self.class.yaffle_text_field}=", string.to_squawk)+.
h3. Models
This section describes how to add a model named 'Woodpecker' to your plugin that will behave the same as a model in your main app. When storing models, controllers, views and helpers in your plugin, it's customary to keep them in directories that match the rails directories. For this example, create a file structure like this:
Adding directories to the load path makes them appear just like files in the the main app directory - except that they are only loaded once, so you have to restart the web server to see the changes in the browser. Removing directories from the 'load_once_paths' allow those changes to picked up as soon as you save the file - without having to restart the web server. This is particularly useful as you develop the plugin.
Finally, add the following to your plugin's 'schema.rb':
* *vendor/plugins/yaffle/test/schema.rb:*
<ruby>
create_table :woodpeckers, :force => true do |t|
t.string :name
end
</ruby>
Now your test should be passing, and you should be able to use the Woodpecker model from within your rails app, and any changes made to it are reflected immediately when running in development mode.
h3. Controllers
This section describes how to add a controller named 'woodpeckers' to your plugin that will behave the same as a controller in your main app. This is very similar to adding a model.
You can test your plugin's controller as you would test any other controller:
class WoodpeckersController < ActionController::Base
def index
render :text => "Squawk!"
end
end
</ruby>
Now your test should be passing, and you should be able to use the Woodpeckers controller in your app. If you add a route for the woodpeckers controller you can start up your server and go to http://localhost:3000/woodpeckers to see your controller in action.
h3. Helpers
This section describes how to add a helper named 'WoodpeckersHelper' to your plugin that will behave the same as a helper in your main app. This is very similar to adding a model and a controller.
You can test your plugin's helper as you would test any other helper:
Now your test should be passing, and you should be able to use the Woodpeckers helper in your app.
h3. Routes
In a standard 'routes.rb' file you use routes like 'map.connect' or 'map.resources'. You can add your own custom routes from a plugin. This section will describe how to add a custom method called that can be called with 'map.yaffles'.
Testing routes from plugins is slightly different from testing routes in a standard rails app. To begin, add a test like this:
Many plugins ship with generators. When you created the plugin above, you specified the +--with-generator+ option, so you already have the generator stubs in 'vendor/plugins/yaffle/generators/yaffle'.
Building generators is a complex topic unto itself and this section will cover one small aspect of generators: generating a simple text file.
h4. Testing generators
Many rails plugin authors do not test their generators, however testing generators is quite simple. A typical generator test does the following:
* Creates a new fake rails root directory that will serve as destination
* Runs the generator
* Asserts that the correct files were generated
* Removes the fake rails root
This section will describe how to create a simple generator that adds a file. For the generator in this section, the test could look something like this:
You can run 'rake' from the plugin directory to see this fail. Unless you are doing more advanced generator commands it typically suffices to just test the Generate script, and trust that rails will handle the Destroy and Update commands for you.
class YaffleDefinitionGenerator < Rails::Generator::Base
def manifest
record do |m|
m.file "definition.txt", "definition.txt"
end
end
end
</ruby>
h4. The USAGE file
If you plan to distribute your plugin, developers will expect at least a minimum of documentation. You can add simple documentation to the generator by updating the USAGE file.
Rails ships with several built-in generators. You can see all of the generators available to you by typing the following at the command line:
When you run +script/generate yaffle_definition -h+ you should see the contents of your 'vendor/plugins/yaffle/generators/yaffle_definition/USAGE'.
For this plugin, update the USAGE file could look like this:
<shell>
Description:
Adds a file with the definition of a Yaffle to the app's main directory
</shell>
h3. Add a custom generator command
You may have noticed above that you can used one of the built-in rails migration commands +migration_template+. If your plugin needs to add and remove lines of text from existing files you will need to write your own generator methods.
This section describes how you you can create your own commands to add and remove a line of text from 'routes.rb'. This example creates a very simple method that adds or removes a text file.
class YaffleGenerator < Rails::Generator::NamedBase
def manifest
m.yaffle_definition
end
end
</ruby>
h3. Generator Commands
You may have noticed above that you can used one of the built-in rails migration commands +migration_template+. If your plugin needs to add and remove lines of text from existing files you will need to write your own generator methods.
This section describes how you you can create your own commands to add and remove a line of text from 'config/routes.rb'.
class YaffleRouteGenerator < Rails::Generator::Base
def manifest
record do |m|
m.yaffle_route
end
end
end
</ruby>
To see this work, type:
<shell>
./script/generate yaffle_route
./script/destroy yaffle_route
</shell>
NOTE: If you haven't set up the custom route from above, 'script/destroy' will fail and you'll have to remove it manually.
h3. Migrations
If your plugin requires changes to the app's database you will likely want to somehow add migrations. Rails does not include any built-in support for calling migrations from plugins, but you can still make it easy for developers to call migrations from plugins.
If you have a very simple needs, like creating a table that will always have the same name and columns, then you can use a more simple solution, like creating a custom rake task or method. If your migration needs user input to supply table names or other options, you probably want to opt for generating a migration.
Let's say you have the following migration in your plugin:
NOTE: several plugin frameworks such as Desert and Engines provide more advanced plugin functionality.
h4. Generate migrations
Generating migrations has several advantages over other methods. Namely, you can allow other developers to more easily customize the migration. The flow looks like this:
* call your script/generate script and pass in whatever options they need
* examine the generated migration, adding/removing columns or other options as necessary
This example will demonstrate how to use one of the built-in generator methods named 'migration_template' to create a migration file. Extending the rails migration generator requires a somewhat intimate knowledge of the migration generator internals, so it's best to write a test first:
NOTE: the migration generator checks to see if a migation already exists, and it's hard-coded to check the 'db/migrate' directory. As a result, if your test tries to generate a migration that already exists in the app, it will fail. The easy workaround is to make sure that the name you generate in your test is very unlikely to actually appear in the app.
After running the test with 'rake' you can make it pass with:
The generator creates a new file in 'db/migrate' with a timestamp and an 'add_column' statement. It reuses the built in rails +migration_template+ method, and reuses the built-in rails migration template.
It's courteous to check to see if table names are being pluralized whenever you create a generator that needs to be aware of table names. This way people using your generator won't have to manually change the generated files if they've turned pluralization off.
To run the generator, type the following at the command line:
class AddYaffleFieldsToBirds < ActiveRecord::Migration
def self.up
add_column :birds, :last_squawk, :string
end
def self.down
remove_column :birds, :last_squawk
end
end
</ruby>
h3. Rake tasks
When you created the plugin with the built-in rails generator, it generated a rake file for you in 'vendor/plugins/yaffle/tasks/yaffle_tasks.rake'. Any rake task you add here will be available to the app.
Many plugin authors put all of their rake tasks into a common namespace that is the same as the plugin, like so:
* *vendor/plugins/yaffle/tasks/yaffle_tasks.rake*
<ruby>
namespace :yaffle do
desc "Prints out the word 'Yaffle'"
task :squawk => :environment do
puts "squawk!"
end
end
</ruby>
When you run +rake -T+ from your plugin you will see:
<shell>
yaffle:squawk # Prints out the word 'Yaffle'
</shell>
You can add as many files as you want in the tasks directory, and if they end in .rake Rails will pick them up.
Note that tasks from 'vendor/plugins/yaffle/Rakefile' are not available to the main app.
h3. PluginGems
Turning your rails plugin into a gem is a simple and straightforward task. This section will cover how to turn your plugin into a gem. It will not cover how to distribute that gem.
Historically rails plugins loaded the plugin's 'init.rb' file. In fact some plugins contain all of their code in that one file. To be compatible with plugins, 'init.rb' was moved to 'rails/init.rb'.
It's common practice to put any developer-centric rake tasks (such as tests, rdoc and gem package tasks) in 'Rakefile'. A rake task that packages the gem might look like this:
* *vendor/plugins/yaffle/Rakefile:*
<ruby>
PKG_FILES = FileList[
'[a-zA-Z]*',
'generators/**/*',
'lib/**/*',
'rails/**/*',
'tasks/**/*',
'test/**/*'
]
spec = Gem::Specification.new do |s|
s.name = "yaffle"
s.version = "0.0.1"
s.author = "Gleeful Yaffler"
s.email = "yaffle@example.com"
s.homepage = "http://yafflers.example.com/"
s.platform = Gem::Platform::RUBY
s.summary = "Sharing Yaffle Goodness"
s.files = PKG_FILES.to_a
s.require_path = "lib"
s.has_rdoc = false
s.extra_rdoc_files = ["README"]
end
desc 'Turn this plugin into a gem.'
Rake::GemPackageTask.new(spec) do |pkg|
pkg.gem_spec = spec
end
</ruby>
To build and install the gem locally, run the following commands:
<shell>
cd vendor/plugins/yaffle
rake gem
sudo gem install pkg/yaffle-0.0.1.gem
</shell>
To test this, create a new rails app, add 'config.gem "yaffle"' to environment.rb and all of your plugin's functionality will be available to you.
h3. RDoc Documentation
Once your plugin is stable and you are ready to deploy do everyone else a favor and document it! Luckily, writing documentation for your plugin is easy.
The first step is to update the README file with detailed information about how to use your plugin. A few key things to include are:
* Your name
* How to install
* How to add the functionality to the app (several examples of common use cases)
* Warning, gotchas or tips that might help save users time
Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add '#:nodoc:' comments to those parts of the code that are not part of the public api.
Once your comments are good to go, navigate to your plugin directory and run:
<shell>
rake rdoc
</shell>
h3. Appendix
If you prefer to use RSpec instead of Test::Unit, you may be interested in the "RSpec Plugin Generator":http://github.com/pat-maddox/rspec-plugin-generator/tree/master.
