2008-10-27 07:47:01 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en" xml:lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / >
< title > The Basics of Creating Rails Plugins< / title >
<!-- [if lt IE 8]>
< script src = "http://ie7-js.googlecode.com/svn/version/2.0(beta3)/IE8.js" type = "text/javascript" > < / script >
<![endif]-->
< link href = "stylesheets/base.css" media = "screen" rel = "Stylesheet" type = "text/css" / >
< link href = "stylesheets/forms.css" media = "screen" rel = "Stylesheet" type = "text/css" / >
< link href = "stylesheets/more.css" media = "screen" rel = "Stylesheet" type = "text/css" / >
< style type = "text/css" >
div#container {
max-width: 900px;
padding-bottom: 3em;
}
div#content {
margin-left: 200px;
}
div#container.notoc {
max-width: 600px;
}
.notoc div#content {
margin-left: 0;
}
pre {
line-height: 1.4em;
}
#content p tt {
background: #eeeeee;
border: solid 1px #cccccc;
padding: 3px;
}
dt {
font-weight: bold;
}
#content dt tt {
font-size: 10pt;
}
dd {
margin-left: 3em;
}
#content dt tt, #content pre tt {
background: none;
padding: 0;
border: 0;
}
#content .olist ol {
margin-left: 2em;
}
#header {
position: relative;
max-width: 840px;
margin-left: auto;
margin-right: auto;
}
#header.notoc {
max-width: 580px;
}
#logo {
position: absolute;
left: 10px;
top: 10px;
width: 110px;
height: 140px;
}
div#header h1#site_title {
background: url('images/ruby_on_rails_by_mike_rundle2.gif') top left no-repeat;
position: absolute;
width: 392px;
height: 55px;
left: 145px;
top: 20px;
margin: 0;
padding: 0;
}
#site_title span {
display: none;
}
#site_title_tagline {
display: none;
}
ul#navMain {
position: absolute;
margin: 0;
padding: 0;
top: 97px;
left: 145px;
}
.left-floaty, .right-floaty {
padding: 15px;
}
.admonitionblock,
.tableblock {
margin-left: 1em;
margin-right: 1em;
margin-top: 0.25em;
margin-bottom: 1em;
}
.admonitionblock .icon {
padding-right: 8px;
}
.admonitionblock .content {
border: solid 1px #ffda78;
background: #fffebd;
padding: 10px;
padding-top: 8px;
padding-bottom: 8px;
}
.admonitionblock .title {
font-size: 140%;
margin-bottom: 0.5em;
}
.tableblock table {
border: solid 1px #aaaaff;
background: #f0f0ff;
}
.tableblock th {
background: #e0e0e0;
}
.tableblock th,
.tableblock td {
padding: 3px;
padding-left: 5px;
padding-right: 5px;
}
.sidebarblock {
margin-top: 0.25em;
margin: 1em;
border: solid 1px #ccccbb;
padding: 8px;
background: #ffffe0;
}
.sidebarblock .sidebar-title {
font-size: 140%;
font-weight: 600;
margin-bottom: 0.3em;
}
.sidebarblock .sidebar-content > .para:last-child > p {
margin-bottom: 0;
}
.sidebarblock .sidebar-title a {
text-decoration: none;
}
.sidebarblock .sidebar-title a:hover {
text-decoration: underline;
}
< / style >
< / head >
< body >
< div id = "header" >
< div id = "logo" >
< a href = "index.html" title = "Ruby on Rails" > < img src = "images/rails_logo_remix.gif" alt = "Rails" height = "140" width = "110" / > < / a >
< / div >
< h1 id = "site_title" > < span > Ruby on Rails< / span > < / h1 >
< h2 id = "site_title_tagline" > Sustainable productivity for web-application development< / h2 >
< ul id = "navMain" >
< li class = "first-child" > < a href = "http://www.rubyonrails.org/" title = "Ruby on Rails" class = "ruby_on_rails" > Ruby on Rails< / a > < / li >
< li > < a class = "manuals" href = "index.html" title = "Manuals Index" > Guides Index< / a > < / li >
< / ul >
< / div >
< div id = "container" >
< div id = "sidebar" >
< h2 > Chapters< / h2 >
< ol >
< li >
< a href = "#_preparation" > Preparation< / a >
< ul >
< li > < a href = "#_create_the_basic_app" > Create the basic app< / a > < / li >
2008-11-24 22:53:39 +01:00
< li > < a href = "#_generate_the_plugin_skeleton" > Generate the plugin skeleton< / a > < / li >
2008-10-27 07:47:01 +01:00
< li > < a href = "#_setup_the_plugin_for_testing" > Setup the plugin for testing< / a > < / li >
2008-11-24 22:53:39 +01:00
< li > < a href = "#_run_the_plugin_tests" > Run the plugin tests< / a > < / li >
< / ul >
< / li >
< li >
< a href = "#_extending_core_classes" > Extending core classes< / a >
< ul >
< li > < a href = "#_creating_the_test" > Creating the test< / a > < / li >
< li > < a href = "#_organize_your_files" > Organize your files< / a > < / li >
< li > < a href = "#_working_with_init_rb" > Working with init.rb< / a > < / li >
< / ul >
< / li >
< li >
< a href = "#_add_an_tt_acts_as_yaffle_tt_method_to_active_record" > Add an < tt > acts_as_yaffle< / tt > method to Active Record< / a >
< ul >
< li > < a href = "#_add_a_class_method" > Add a class method< / a > < / li >
< li > < a href = "#_add_an_instance_method" > Add an instance method< / a > < / li >
2008-10-27 07:47:01 +01:00
< / ul >
< / li >
< li >
2008-11-24 22:53:39 +01:00
< a href = "#_create_a_generator" > Create a generator< / a >
< ul >
< li > < a href = "#_testing_generators" > Testing generators< / a > < / li >
< li > < a href = "#_adding_to_the_manifest" > Adding to the manifest< / a > < / li >
< li > < a href = "#_manually_test_the_generator" > Manually test the generator< / a > < / li >
< li > < a href = "#_the_usage_file" > The USAGE file< / a > < / li >
< / ul >
2008-10-27 07:47:01 +01:00
< / li >
< li >
2008-11-24 22:53:39 +01:00
< a href = "#_add_a_custom_generator_command" > Add a custom generator command< / a >
2008-10-27 07:47:01 +01:00
< / li >
< li >
2008-11-24 22:53:39 +01:00
< a href = "#_add_a_model" > Add a model< / a >
2008-10-27 07:47:01 +01:00
< / li >
< li >
2008-11-24 22:53:39 +01:00
< a href = "#_add_a_controller" > Add a controller< / a >
2008-10-27 07:47:01 +01:00
< / li >
< li >
2008-11-24 22:53:39 +01:00
< a href = "#_add_a_helper" > Add a helper< / a >
2008-10-27 07:47:01 +01:00
< / li >
< li >
< a href = "#_add_a_custom_route" > Add a Custom Route< / a >
< / li >
< li >
< a href = "#_odds_and_ends" > Odds and ends< / a >
< ul >
< li > < a href = "#_generate_rdoc_documentation" > Generate RDoc Documentation< / a > < / li >
< li > < a href = "#_write_custom_rake_tasks_in_your_plugin" > Write custom Rake tasks in your plugin< / a > < / li >
< li > < a href = "#_store_plugins_in_alternate_locations" > Store plugins in alternate locations< / a > < / li >
< li > < a href = "#_create_your_own_plugin_loaders_and_plugin_locators" > Create your own Plugin Loaders and Plugin Locators< / a > < / li >
< li > < a href = "#_use_custom_plugin_generators" > Use Custom Plugin Generators< / a > < / li >
< / ul >
< / li >
< li >
< a href = "#_appendix" > Appendix< / a >
< ul >
< li > < a href = "#_references" > References< / a > < / li >
< li > < a href = "#_final_plugin_directory_structure" > Final plugin directory structure< / a > < / li >
< / ul >
< / li >
< / ol >
< / div >
< div id = "content" >
< h1 > The Basics of Creating Rails Plugins< / h1 >
< div id = "preamble" >
< div class = "sectionbody" >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > A Rails plugin is either an extension or a modification of the core framework. Plugins provide:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "ilist" > < ul >
< li >
< p >
2008-11-24 22:53:39 +01:00
a way for developers to share bleeding-edge ideas without hurting the stable code base
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
a segmented architecture so that units of code can be fixed or updated on their own release schedule
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
an outlet for the core developers so that they don’
2008-10-27 07:47:01 +01:00
< / p >
< / li >
2008-11-24 22:53:39 +01:00
< / ul > < / div >
< div class = "para" > < p > After reading this guide you should be familiar with:< / p > < / div >
< div class = "ilist" > < ul >
2008-10-27 07:47:01 +01:00
< li >
< p >
2008-11-24 22:53:39 +01:00
Creating a plugin from scratch
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
Writing and running tests for the plugin
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
Storing models, views, controllers, helpers and even other plugins in your plugins
< / p >
< / li >
< li >
< p >
Writing generators
< / p >
< / li >
< li >
< p >
Writing custom Rake tasks in your plugin
< / p >
< / li >
< li >
< p >
Generating RDoc documentation for your plugin
< / p >
< / li >
< li >
< p >
Avoiding common pitfalls with < em > init.rb< / em >
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< / ul > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > This guide describes how to build a test-driven plugin that will:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "ilist" > < ul >
< li >
< p >
2008-11-24 22:53:39 +01:00
Extend core ruby classes like Hash and String
< / p >
< / li >
< li >
< p >
Add methods to ActiveRecord::Base in the tradition of the < em > acts_as< / em > plugins
< / p >
< / li >
< li >
< p >
Add a view helper that can be used in erb templates
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
Add a new generator that will generate a migration
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
Add a custom generator command
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
A custom route method that can be used in routes.rb
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< / ul > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > 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.< / p > < / div >
2008-10-27 07:47:01 +01:00
< / div >
< / div >
< h2 id = "_preparation" > 1. Preparation< / h2 >
< div class = "sectionbody" >
< h3 id = "_create_the_basic_app" > 1.1. Create the basic app< / h3 >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > The examples in this guide require that you have a working rails application. To create a simple rails app execute:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" >
2008-11-24 22:53:39 +01:00
< pre > < tt > gem install rails
rails yaffle_guide
cd yaffle_guide
2008-10-27 07:47:01 +01:00
script/generate scaffold bird name:string
rake db:migrate
script/server< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > Then navigate to < a href = "http://localhost:3000/birds" > http://localhost:3000/birds< / a > . Make sure you have a functioning rails app before continuing.< / p > < / div >
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< img src = "./images/icons/note.png" alt = "Note" / >
< / td >
2008-11-24 22:53:39 +01:00
< td class = "content" >
< div class = "title" > Editor's note:< / div > 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.< / td >
2008-10-27 07:47:01 +01:00
< / tr > < / table >
< / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_generate_the_plugin_skeleton" > 1.2. Generate the plugin skeleton< / h3 >
< div class = "para" > < p > Rails ships with a plugin generator which creates a basic plugin skeleton. Pass the plugin name, either < em > CamelCased< / em > or < em > under_scored< / em > , as an argument. Pass < tt > --with-generator< / tt > to add an example generator also.< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "para" > < p > This creates a plugin in < em > vendor/plugins< / em > including an < em > init.rb< / em > and < em > README< / em > as well as standard < em > lib< / em > , < em > task< / em > , and < em > test< / em > directories.< / p > < / div >
< div class = "para" > < p > Examples:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
2008-11-24 22:53:39 +01:00
< pre > < tt > ./script/generate plugin yaffle
./script/generate plugin yaffle --with-generator< / tt > < / pre >
2008-10-27 07:47:01 +01:00
< / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > To get more detailed help on the plugin generator, type < tt > ./script/generate plugin< / tt > .< / p > < / div >
< div class = "para" > < p > Later on this guide will describe how to work with generators, so go ahead and generate your plugin with the < tt > --with-generator< / tt > option now:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" >
2008-11-24 22:53:39 +01:00
< pre > < tt > ./script/generate plugin yaffle --with-generator< / tt > < / pre >
2008-10-27 07:47:01 +01:00
< / div > < / div >
< div class = "para" > < p > You should see the following output:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > create vendor/plugins/yaffle/lib
create vendor/plugins/yaffle/tasks
create vendor/plugins/yaffle/test
create vendor/plugins/yaffle/README
create vendor/plugins/yaffle/MIT-LICENSE
create vendor/plugins/yaffle/Rakefile
create vendor/plugins/yaffle/init.rb
create vendor/plugins/yaffle/install.rb
create vendor/plugins/yaffle/uninstall.rb
create vendor/plugins/yaffle/lib/yaffle.rb
create vendor/plugins/yaffle/tasks/yaffle_tasks.rake
create vendor/plugins/yaffle/test/core_ext_test.rb
create vendor/plugins/yaffle/generators
create vendor/plugins/yaffle/generators/yaffle
create vendor/plugins/yaffle/generators/yaffle/templates
create vendor/plugins/yaffle/generators/yaffle/yaffle_generator.rb
create vendor/plugins/yaffle/generators/yaffle/USAGE< / tt > < / pre >
< / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > To begin just change one thing - move < em > init.rb< / em > to < em > rails/init.rb< / em > .< / p > < / div >
2008-10-27 07:47:01 +01:00
< h3 id = "_setup_the_plugin_for_testing" > 1.3. Setup the plugin for testing< / h3 >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > If your plugin interacts with a database, you'll need to setup a database connection. In this guide you will learn how to test your plugin against multiple different database adapters using Active Record. This guide will not cover how to use fixtures in plugin tests.< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "para" > < p > To setup your plugin to allow for easy testing you'll need to add 3 files:< / p > < / div >
< div class = "ilist" > < ul >
< li >
< p >
2008-11-24 22:53:39 +01:00
A < em > database.yml< / em > file with all of your connection strings
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
A < em > schema.rb< / em > file with your table definitions
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
A test helper method that sets up the database
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< / ul > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/database.yml:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > sqlite:
:adapter: sqlite
2008-11-24 22:53:39 +01:00
:dbfile: vendor/plugins/yaffle/test/yaffle_plugin.sqlite.db
2008-10-27 07:47:01 +01:00
sqlite3:
:adapter: sqlite3
2008-11-24 22:53:39 +01:00
:dbfile: vendor/plugins/yaffle/test/yaffle_plugin.sqlite3.db
2008-10-27 07:47:01 +01:00
postgresql:
:adapter: postgresql
:username: postgres
:password: postgres
:database: yaffle_plugin_test
:min_messages: ERROR
mysql:
:adapter: mysql
:host: localhost
2008-11-24 22:53:39 +01:00
:username: root
:password: password
2008-10-27 07:47:01 +01:00
:database: yaffle_plugin_test< / tt > < / pre >
< / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > For this guide you'll need 2 tables/models, Hickwalls and Wickwalls, so add the following:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/schema.rb:< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > ActiveRecord< span style = "color: #990000" > ::< / span > Schema< span style = "color: #990000" > .< / span > define< span style = "color: #990000" > (:< / span > version < span style = "color: #990000" > => < / span > < span style = "color: #993399" > 0< / span > < span style = "color: #990000" > )< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span >
create_table < span style = "color: #990000" > :< / span > hickwalls< span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > force < span style = "color: #990000" > => < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > true< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > t< span style = "color: #990000" > |< / span >
t< span style = "color: #990000" > .< / span > string < span style = "color: #990000" > :< / span > name
t< span style = "color: #990000" > .< / span > string < span style = "color: #990000" > :< / span > last_squawk
t< span style = "color: #990000" > .< / span > datetime < span style = "color: #990000" > :< / span > last_squawked_at
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
create_table < span style = "color: #990000" > :< / span > wickwalls< span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > force < span style = "color: #990000" > => < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > true< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > t< span style = "color: #990000" > |< / span >
t< span style = "color: #990000" > .< / span > string < span style = "color: #990000" > :< / span > name
t< span style = "color: #990000" > .< / span > string < span style = "color: #990000" > :< / span > last_tweet
t< span style = "color: #990000" > .< / span > datetime < span style = "color: #990000" > :< / span > last_tweeted_at
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
create_table < span style = "color: #990000" > :< / span > woodpeckers< span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > force < span style = "color: #990000" > => < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > true< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > t< span style = "color: #990000" > |< / span >
t< span style = "color: #990000" > .< / span > string < span style = "color: #990000" > :< / span > name
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/test_helper.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > ENV< span style = "color: #990000" > [< / span > < span style = "color: #FF0000" > 'RAILS_ENV'< / span > < span style = "color: #990000" > ]< / span > < span style = "color: #990000" > =< / span > < span style = "color: #FF0000" > 'test'< / span >
2008-10-27 07:47:01 +01:00
ENV< span style = "color: #990000" > [< / span > < span style = "color: #FF0000" > 'RAILS_ROOT'< / span > < span style = "color: #990000" > ]< / span > < span style = "color: #990000" > ||=< / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/../../../..'< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'test/unit'< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > expand_path< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > join< span style = "color: #990000" > (< / span > ENV< span style = "color: #990000" > [< / span > < span style = "color: #FF0000" > 'RAILS_ROOT'< / span > < span style = "color: #990000" > ],< / span > < span style = "color: #FF0000" > 'config/environment.rb'< / span > < span style = "color: #990000" > ))< / span >
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > load_schema
config < span style = "color: #990000" > =< / span > YAML< span style = "color: #990000" > ::< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > load< / span > < / span > < span style = "color: #990000" > (< / span > IO< span style = "color: #990000" > .< / span > read< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/database.yml'< / span > < span style = "color: #990000" > ))< / span >
ActiveRecord< span style = "color: #990000" > ::< / span > Base< span style = "color: #990000" > .< / span > logger < span style = "color: #990000" > =< / span > Logger< span style = "color: #990000" > .< / span > new< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > "/debug.log"< / span > < span style = "color: #990000" > )< / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
db_adapter < span style = "color: #990000" > =< / span > ENV< span style = "color: #990000" > [< / span > < span style = "color: #FF0000" > 'DB'< / span > < span style = "color: #990000" > ]< / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-style: italic" > < span style = "color: #9A1900" > # no db passed, try one of these fine config-free DBs before bombing.< / span > < / span >
db_adapter < span style = "color: #990000" > ||=< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > begin< / span > < / span >
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'rubygems'< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'sqlite'< / span >
< span style = "color: #FF0000" > 'sqlite'< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > rescue< / span > < / span > MissingSourceFile
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > begin< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'sqlite3'< / span >
< span style = "color: #FF0000" > 'sqlite3'< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > rescue< / span > < / span > MissingSourceFile
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > if< / span > < / span > db_adapter< span style = "color: #990000" > .< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > nil< / span > < / span > < span style = "color: #990000" > ?< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > raise< / span > < / span > < span style = "color: #FF0000" > "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
ActiveRecord< span style = "color: #990000" > ::< / span > Base< span style = "color: #990000" > .< / span > establish_connection< span style = "color: #990000" > (< / span > config< span style = "color: #990000" > [< / span > db_adapter< span style = "color: #990000" > ])< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > load< / span > < / span > < span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > "/schema.rb"< / span > < span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/../rails/init.rb'< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > Now whenever you write a test that requires the database, you can call < em > load_schema< / em > .< / p > < / div >
< h3 id = "_run_the_plugin_tests" > 1.4. Run the plugin tests< / h3 >
< div class = "para" > < p > 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 < em > vendor/plugins/yaffle/test/yaffle_test.rb< / em > with a sample test. Replace the contents of that file with:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/yaffle_test.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > YaffleTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
load_schema
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > Hickwall < span style = "color: #990000" > < < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Base
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > Wickwall < span style = "color: #990000" > < < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Base
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_schema_has_loaded_correctly
assert_equal < span style = "color: #990000" > [],< / span > Hickwall< span style = "color: #990000" > .< / span > all
assert_equal < span style = "color: #990000" > [],< / span > Wickwall< span style = "color: #990000" > .< / span > all
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > To run this, go to the plugin directory and run < tt > rake< / tt > :< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > cd vendor/plugins/yaffle
rake< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > You should see output like:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > /opt/local/bin/ruby -Ilib:lib "/opt/local/lib/ruby/gems/1.8/gems/rake-0.8.3/lib/rake/rake_test_loader.rb" "test/yaffle_test.rb"
-- create_table(:hickwalls, {:force=> true})
-> 0.0220s
-- create_table(:wickwalls, {:force=> true})
-> 0.0077s
-- initialize_schema_migrations_table()
-> 0.0007s
-- assume_migrated_upto_version(0)
-> 0.0007s
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< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > 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:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > rake DB=sqlite
rake DB=sqlite3
rake DB=mysql
rake DB=postgresql< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > Now you are ready to test-drive your plugin!< / p > < / div >
2008-10-27 07:47:01 +01:00
< / div >
2008-11-24 22:53:39 +01:00
< h2 id = "_extending_core_classes" > 2. Extending core classes< / h2 >
2008-10-27 07:47:01 +01:00
< div class = "sectionbody" >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > This section will explain how to add a method to String that will be available anywhere in your rails app by:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "ilist" > < ul >
< li >
< p >
2008-11-24 22:53:39 +01:00
Writing tests for the desired behavior
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
Creating and requiring the correct files
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< / ul > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_creating_the_test" > 2.1. Creating the test< / h3 >
< div class = "para" > < p > In this example you will add a method to String named < tt > to_squawk< / tt > . To begin, create a new test file with a few assertions:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/core_ext_test.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > CoreExtTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_to_squawk_prepends_the_word_squawk
assert_equal < span style = "color: #FF0000" > "squawk! Hello World"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "Hello World"< / span > < span style = "color: #990000" > .< / span > to_squawk
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > Navigate to your plugin directory and run < tt > rake test< / tt > :< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > cd vendor/plugins/yaffle
rake test< / tt > < / pre >
< / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > The test above should fail with the message:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > 1) Error:
test_to_squawk_prepends_the_word_squawk(CoreExtTest):
NoMethodError: undefined method `to_squawk' for "Hello World":String
./test/core_ext_test.rb:5:in `test_to_squawk_prepends_the_word_squawk'< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > Great - now you are ready to start development.< / p > < / div >
< h3 id = "_organize_your_files" > 2.2. Organize your files< / h3 >
< div class = "para" > < p > A common pattern in rails plugins is to set up the file structure like this:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" >
2008-11-24 22:53:39 +01:00
< pre > < tt > |-- lib
| |-- yaffle
| | `-- core_ext.rb
| `-- yaffle.rb< / tt > < / pre >
2008-10-27 07:47:01 +01:00
< / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > The first thing we need to to is to require our < em > lib/yaffle.rb< / em > file from < em > rails/init.rb< / em > :< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/rails/init.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'yaffle'< / span >
2008-10-27 07:47:01 +01:00
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > Then in < em > lib/yaffle.rb< / em > require < em > lib/core_ext.rb< / em > :< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > "yaffle/core_ext"< / span >
2008-10-27 07:47:01 +01:00
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > Finally, create the < em > core_ext.rb< / em > file and add the < em > to_squawk< / em > method:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle/core_ext.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > String< span style = "color: #990000" > .< / span > class_eval < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > to_squawk
< span style = "color: #FF0000" > "squawk! #{self}"< / span > < span style = "color: #990000" > .< / span > strip
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > To test that your method does what it says it does, run the unit tests with < tt > rake< / tt > from your plugin directory. To see this in action, fire up a console and start squawking:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > $ ./script/console
> > "Hello World".to_squawk
=> "squawk! Hello World"< / tt > < / pre >
< / div > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_working_with_init_rb" > 2.3. Working with init.rb< / h3 >
< div class = "para" > < p > When rails loads plugins it looks for the file named init.rb. However, when the plugin is initialized, < em > init.rb< / em > is invoked via < tt > eval< / tt > (not < tt > require< / tt > ) so it has slightly different behavior.< / p > < / div >
< div class = "para" > < p > Under certain circumstances if you reopen classes or modules in < em > init.rb< / em > 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 < tt > init.rb< / tt > , as shown above.< / p > < / div >
< div class = "para" > < p > If you must reopen a class in < tt > init.rb< / tt > you can use < tt > module_eval< / tt > or < tt > class_eval< / tt > to avoid any issues:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/init.rb< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > Hash< span style = "color: #990000" > .< / span > class_eval < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > is_a_special_hash?
< span style = "font-weight: bold" > < span style = "color: #0000FF" > true< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > Another way is to explicitly define the top-level module space for all modules and classes, like < tt > ::Hash< / tt > :< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/init.rb< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > < span style = "color: #990000" > ::< / span > Hash
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > is_a_special_hash?
< span style = "font-weight: bold" > < span style = "color: #0000FF" > true< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-10-27 07:47:01 +01:00
< / div >
2008-11-24 22:53:39 +01:00
< h2 id = "_add_an_tt_acts_as_yaffle_tt_method_to_active_record" > 3. Add an < tt > acts_as_yaffle< / tt > method to Active Record< / h2 >
2008-10-27 07:47:01 +01:00
< div class = "sectionbody" >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > A common pattern in plugins is to add a method called < em > acts_as_something< / em > to models. In this case, you want to write a method called < em > acts_as_yaffle< / em > that adds a < em > squawk< / em > method to your models.< / p > < / div >
< div class = "para" > < p > To begin, set up your files so that you have:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/acts_as_yaffle_test.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > ActsAsYaffleTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'yaffle/acts_as_yaffle'< / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle/acts_as_yaffle.rb< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Yaffle
< span style = "font-style: italic" > < span style = "color: #9A1900" > # your code will go here< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > Note that after requiring < em > acts_as_yaffle< / em > you also have to include it into ActiveRecord::Base so that your plugin methods will be available to the rails models.< / p > < / div >
< div class = "para" > < p > One of the most common plugin patterns for < em > acts_as_yaffle< / em > plugins is to structure your file like so:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle/acts_as_yaffle.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Yaffle
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > self< / span > < / span > < span style = "color: #990000" > .< / span > included< span style = "color: #990000" > (< / span > base< span style = "color: #990000" > )< / span >
base< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > extend< span style = "color: #990000" > ,< / span > ClassMethods
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > ClassMethods
< span style = "font-style: italic" > < span style = "color: #9A1900" > # any method placed here will apply to classes, like Hickwall< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > acts_as_something
send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > InstanceMethods
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > InstanceMethods
< span style = "font-style: italic" > < span style = "color: #9A1900" > # any method placed here will apply to instaces, like @hickwall< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > With structure you can easily separate the methods that will be used for the class (like < tt > Hickwall.some_method< / tt > ) and the instance (like < tt > @hickwell.some_method< / tt > ).< / p > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_add_a_class_method" > 3.1. Add a class method< / h3 >
< div class = "para" > < p > This plugin will expect that you've added a method to your model named < em > last_squawk< / em > . However, the plugin users might have already defined a method on their model named < em > last_squawk< / em > that they use for something else. This plugin will allow the name to be changed by adding a class method called < em > yaffle_text_field< / em > .< / p > < / div >
< div class = "para" > < p > To start out, write a failing test that shows the behavior you'd like:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/acts_as_yaffle_test.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > Hickwall < span style = "color: #990000" > < < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Base
acts_as_yaffle
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > Wickwall < span style = "color: #990000" > < < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Base
acts_as_yaffle < span style = "color: #990000" > :< / span > yaffle_text_field < span style = "color: #990000" > => < / span > < span style = "color: #990000" > :< / span > last_tweet
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > ActsAsYaffleTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
2008-11-24 22:53:39 +01:00
load_schema
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_a_hickwalls_yaffle_text_field_should_be_last_squawk
assert_equal < span style = "color: #FF0000" > "last_squawk"< / span > < span style = "color: #990000" > ,< / span > Hickwall< span style = "color: #990000" > .< / span > yaffle_text_field
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_a_wickwalls_yaffle_text_field_should_be_last_tweet
assert_equal < span style = "color: #FF0000" > "last_tweet"< / span > < span style = "color: #990000" > ,< / span > Wickwall< span style = "color: #990000" > .< / span > yaffle_text_field
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > To make these tests pass, you could modify your < tt > acts_as_yaffle< / tt > file like so:< / p > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle/acts_as_yaffle.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Yaffle
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > self< / span > < / span > < span style = "color: #990000" > .< / span > included< span style = "color: #990000" > (< / span > base< span style = "color: #990000" > )< / span >
base< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > extend< span style = "color: #990000" > ,< / span > ClassMethods
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > ClassMethods
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > acts_as_yaffle< span style = "color: #990000" > (< / span > options < span style = "color: #990000" > =< / span > < span style = "color: #FF0000" > {}< / span > < span style = "color: #990000" > )< / span >
2008-11-24 22:53:39 +01:00
cattr_accessor < span style = "color: #990000" > :< / span > yaffle_text_field
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > self< / span > < / span > < span style = "color: #990000" > .< / span > yaffle_text_field < span style = "color: #990000" > =< / span > < span style = "color: #990000" > (< / span > options< span style = "color: #990000" > [:< / span > yaffle_text_field< span style = "color: #990000" > ]< / span > < span style = "color: #990000" > ||< / span > < span style = "color: #990000" > :< / span > last_squawk< span style = "color: #990000" > ).< / span > to_s
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
ActiveRecord< span style = "color: #990000" > ::< / span > Base< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > Yaffle
2008-10-27 07:47:01 +01:00
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_add_an_instance_method" > 3.2. Add an instance method< / h3 >
< div class = "para" > < p > This plugin will add a method named < em > squawk< / em > to any Active Record objects that call < em > acts_as_yaffle< / em > . The < em > squawk< / em > method will simply set the value of one of the fields in the database.< / p > < / div >
< div class = "para" > < p > To start out, write a failing test that shows the behavior you'd like:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/acts_as_yaffle_test.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > Hickwall < span style = "color: #990000" > < < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Base
acts_as_yaffle
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > Wickwall < span style = "color: #990000" > < < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Base
acts_as_yaffle < span style = "color: #990000" > :< / span > yaffle_text_field < span style = "color: #990000" > => < / span > < span style = "color: #990000" > :< / span > last_tweet
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > ActsAsYaffleTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
2008-11-24 22:53:39 +01:00
load_schema
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_a_hickwalls_yaffle_text_field_should_be_last_squawk
assert_equal < span style = "color: #FF0000" > "last_squawk"< / span > < span style = "color: #990000" > ,< / span > Hickwall< span style = "color: #990000" > .< / span > yaffle_text_field
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_a_wickwalls_yaffle_text_field_should_be_last_tweet
2008-10-27 07:47:01 +01:00
assert_equal < span style = "color: #FF0000" > "last_tweet"< / span > < span style = "color: #990000" > ,< / span > Wickwall< span style = "color: #990000" > .< / span > yaffle_text_field
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_hickwalls_squawk_should_populate_last_squawk
hickwall < span style = "color: #990000" > =< / span > Hickwall< span style = "color: #990000" > .< / span > new
hickwall< span style = "color: #990000" > .< / span > squawk< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "Hello World"< / span > < span style = "color: #990000" > )< / span >
assert_equal < span style = "color: #FF0000" > "squawk! Hello World"< / span > < span style = "color: #990000" > ,< / span > hickwall< span style = "color: #990000" > .< / span > last_squawk
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_wickwalls_squawk_should_populate_last_tweeted_at
wickwall < span style = "color: #990000" > =< / span > Wickwall< span style = "color: #990000" > .< / span > new
wickwall< span style = "color: #990000" > .< / span > squawk< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "Hello World"< / span > < span style = "color: #990000" > )< / span >
2008-11-24 22:53:39 +01:00
assert_equal < span style = "color: #FF0000" > "squawk! Hello World"< / span > < span style = "color: #990000" > ,< / span > wickwall< span style = "color: #990000" > .< / span > last_tweet
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > Run this test to make sure the last two tests fail, then update < em > acts_as_yaffle.rb< / em > to look like this:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle/acts_as_yaffle.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Yaffle
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > self< / span > < / span > < span style = "color: #990000" > .< / span > included< span style = "color: #990000" > (< / span > base< span style = "color: #990000" > )< / span >
base< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > extend< span style = "color: #990000" > ,< / span > ClassMethods
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > ClassMethods
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > acts_as_yaffle< span style = "color: #990000" > (< / span > options < span style = "color: #990000" > =< / span > < span style = "color: #FF0000" > {}< / span > < span style = "color: #990000" > )< / span >
2008-11-24 22:53:39 +01:00
cattr_accessor < span style = "color: #990000" > :< / span > yaffle_text_field
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > self< / span > < / span > < span style = "color: #990000" > .< / span > yaffle_text_field < span style = "color: #990000" > =< / span > < span style = "color: #990000" > (< / span > options< span style = "color: #990000" > [:< / span > yaffle_text_field< span style = "color: #990000" > ]< / span > < span style = "color: #990000" > ||< / span > < span style = "color: #990000" > :< / span > last_squawk< span style = "color: #990000" > ).< / span > to_s
send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > InstanceMethods
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > InstanceMethods
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > squawk< span style = "color: #990000" > (< / span > string< span style = "color: #990000" > )< / span >
write_attribute< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > self< / span > < / span > < span style = "color: #990000" > .< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > < span style = "color: #990000" > .< / span > yaffle_text_field< span style = "color: #990000" > ,< / span > string< span style = "color: #990000" > .< / span > to_squawk< span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
ActiveRecord< span style = "color: #990000" > ::< / span > Base< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > Yaffle
2008-10-27 07:47:01 +01:00
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< img src = "./images/icons/note.png" alt = "Note" / >
< / td >
< td class = "content" >
< div class = "title" > Editor's note:< / div > The use of < tt > write_attribute< / tt > 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 < tt > send("#{self.class.yaffle_text_field}=", string.to_squawk)< / tt > .< / td >
< / tr > < / table >
< / div >
< / div >
< h2 id = "_create_a_generator" > 4. Create a generator< / h2 >
< div class = "sectionbody" >
< div class = "para" > < p > 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 < em > vendor/plugins/yaffle/generators/yaffle< / em > .< / p > < / div >
< div class = "para" > < p > Building generators is a complex topic unto itself and this section will cover one small aspect of generators: creating a generator that adds a time-stamped migration.< / p > < / div >
< div class = "para" > < p > To create a generator you must:< / p > < / div >
< div class = "ilist" > < ul >
< li >
< p >
Add your instructions to the < em > manifest< / em > method of the generator
< / p >
< / li >
< li >
< p >
Add any necessary template files to the templates directory
< / p >
< / li >
< li >
< p >
Test the generator manually by running various combinations of < tt > script/generate< / tt > and < tt > script/destroy< / tt >
< / p >
< / li >
< li >
< p >
Update the USAGE file to add helpful documentation for your generator
< / p >
< / li >
< / ul > < / div >
< h3 id = "_testing_generators" > 4.1. Testing generators< / h3 >
< div class = "para" > < p > Many rails plugin authors do not test their generators, however testing generators is quite simple. A typical generator test does the following:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "ilist" > < ul >
< li >
< p >
2008-11-24 22:53:39 +01:00
Creates a new fake rails root directory that will serve as destination
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
Runs the generator forward and backward, making whatever assertions are necessary
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< li >
< p >
2008-11-24 22:53:39 +01:00
Removes the fake rails root
2008-10-27 07:47:01 +01:00
< / p >
< / li >
< / ul > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > For the generator in this section, the test could look something like this:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/yaffle_generator_test.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'rails_generator'< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'rails_generator/scripts/generate'< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'rails_generator/scripts/destroy'< / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > GeneratorTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > fake_rails_root
File< span style = "color: #990000" > .< / span > join< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > ),< / span > < span style = "color: #FF0000" > 'rails_root'< / span > < span style = "color: #990000" > )< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > file_list
Dir< span style = "color: #990000" > .< / span > glob< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > join< span style = "color: #990000" > (< / span > fake_rails_root< span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "db"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "migrate"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "*"< / span > < span style = "color: #990000" > ))< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > setup
FileUtils< span style = "color: #990000" > .< / span > mkdir_p< span style = "color: #990000" > (< / span > fake_rails_root< span style = "color: #990000" > )< / span >
< span style = "color: #009900" > @original_files< / span > < span style = "color: #990000" > =< / span > file_list
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > teardown
FileUtils< span style = "color: #990000" > .< / span > rm_r< span style = "color: #990000" > (< / span > fake_rails_root< span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_generates_correct_file_name
Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Scripts< span style = "color: #990000" > ::< / span > Generate< span style = "color: #990000" > .< / span > new< span style = "color: #990000" > .< / span > run< span style = "color: #990000" > ([< / span > < span style = "color: #FF0000" > "yaffle"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "bird"< / span > < span style = "color: #990000" > ],< / span > < span style = "color: #990000" > :< / span > destination < span style = "color: #990000" > => < / span > fake_rails_root< span style = "color: #990000" > )< / span >
new_file < span style = "color: #990000" > =< / span > < span style = "color: #990000" > (< / span > file_list < span style = "color: #990000" > -< / span > < span style = "color: #009900" > @original_files< / span > < span style = "color: #990000" > ).< / span > first
assert_match < span style = "color: #FF6600" > /add_yaffle_fields_to_bird/< / span > < span style = "color: #990000" > ,< / span > new_file
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > You can run < em > rake< / em > 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.< / p > < / div >
< h3 id = "_adding_to_the_manifest" > 4.2. Adding to the manifest< / h3 >
< div class = "para" > < p > This example will demonstrate how to use one of the built-in generator methods named < em > migration_template< / em > to create a migration file. To start, update your generator file to look like this:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/generators/yaffle/yaffle_generator.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > YaffleGenerator < span style = "color: #990000" > < < / span > Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > NamedBase
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > manifest
record < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > m< span style = "color: #990000" > |< / span >
m< span style = "color: #990000" > .< / span > migration_template < span style = "color: #FF0000" > 'migration:migration.rb'< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "db/migrate"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > {< / span > < span style = "color: #990000" > :< / span > assigns < span style = "color: #990000" > => < / span > yaffle_local_assigns< span style = "color: #990000" > ,< / span >
< span style = "color: #990000" > :< / span > migration_file_name < span style = "color: #990000" > => < / span > < span style = "color: #FF0000" > "add_yaffle_fields_to_#{custom_file_name}"< / span >
2008-11-24 22:53:39 +01:00
< span style = "color: #FF0000" > }< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
private
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > custom_file_name
custom_name < span style = "color: #990000" > =< / span > class_name< span style = "color: #990000" > .< / span > underscore< span style = "color: #990000" > .< / span > downcase
custom_name < span style = "color: #990000" > =< / span > custom_name< span style = "color: #990000" > .< / span > pluralize < span style = "font-weight: bold" > < span style = "color: #0000FF" > if< / span > < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Base< span style = "color: #990000" > .< / span > pluralize_table_names
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > yaffle_local_assigns
returning< span style = "color: #990000" > (< / span > assigns < span style = "color: #990000" > =< / span > < span style = "color: #FF0000" > {}< / span > < span style = "color: #990000" > )< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span >
assigns< span style = "color: #990000" > [:< / span > migration_action< span style = "color: #990000" > ]< / span > < span style = "color: #990000" > =< / span > < span style = "color: #FF0000" > "add"< / span >
assigns< span style = "color: #990000" > [:< / span > class_name< span style = "color: #990000" > ]< / span > < span style = "color: #990000" > =< / span > < span style = "color: #FF0000" > "add_yaffle_fields_to_#{custom_file_name}"< / span >
assigns< span style = "color: #990000" > [:< / span > table_name< span style = "color: #990000" > ]< / span > < span style = "color: #990000" > =< / span > custom_file_name
assigns< span style = "color: #990000" > [:< / span > attributes< span style = "color: #990000" > ]< / span > < span style = "color: #990000" > =< / span > < span style = "color: #990000" > [< / span > Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > GeneratedAttribute< span style = "color: #990000" > .< / span > new< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "last_squawk"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "string"< / span > < span style = "color: #990000" > )]< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > The generator creates a new file in < em > db/migrate< / em > with a timestamp and an < em > add_column< / em > statement. It reuses the built in rails < tt > migration_template< / tt > method, and reuses the built-in rails migration template.< / p > < / div >
< div class = "para" > < p > 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.< / p > < / div >
< h3 id = "_manually_test_the_generator" > 4.3. Manually test the generator< / h3 >
< div class = "para" > < p > To run the generator, type the following at the command line:< / p > < / div >
< div class = "listingblock" >
2008-10-27 07:47:01 +01:00
< div class = "content" >
2008-11-24 22:53:39 +01:00
< pre > < tt > ./script/generate yaffle bird< / tt > < / pre >
2008-10-27 07:47:01 +01:00
< / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > and you will see a new file:< / p > < / div >
< div class = "para" > < p > < strong > db/migrate/20080529225649_add_yaffle_fields_to_birds.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > AddYaffleFieldsToBirds < span style = "color: #990000" > < < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Migration
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > self< / span > < / span > < span style = "color: #990000" > .< / span > up
add_column < span style = "color: #990000" > :< / span > birds< span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > last_squawk< span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > string
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > self< / span > < / span > < span style = "color: #990000" > .< / span > down
remove_column < span style = "color: #990000" > :< / span > birds< span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > last_squawk
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_the_usage_file" > 4.4. The USAGE file< / h3 >
< div class = "para" > < p > 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:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > script/generate< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > You should see something like this:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > Installed Generators
Plugins (vendor/plugins): yaffle
Builtin: controller, integration_test, mailer, migration, model, observer, plugin, resource, scaffold, session_migration< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > When you run < tt > script/generate yaffle< / tt > you should see the contents of your < em > vendor/plugins/yaffle/generators/yaffle/USAGE< / em > file.< / p > < / div >
< div class = "para" > < p > For this plugin, update the USAGE file looks like this:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > Description:
Creates a migration that adds yaffle squawk fields to the given model
Example:
./script/generate yaffle hickwall
This will create:
db/migrate/TIMESTAMP_add_yaffle_fields_to_hickwall< / tt > < / pre >
< / div > < / div >
2008-10-27 07:47:01 +01:00
< / div >
2008-11-24 22:53:39 +01:00
< h2 id = "_add_a_custom_generator_command" > 5. Add a custom generator command< / h2 >
2008-10-27 07:47:01 +01:00
< div class = "sectionbody" >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > You may have noticed above that you can used one of the built-in rails migration commands < tt > migration_template< / tt > . If your plugin needs to add and remove lines of text from existing files you will need to write your own generator methods.< / p > < / div >
< div class = "para" > < p > This section describes how you you can create your own commands to add and remove a line of text from < em > routes.rb< / em > . This example creates a very simple method that adds or removes a text file.< / p > < / div >
< div class = "para" > < p > To start, add the following test method:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/generator_test.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_generates_definition
Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Scripts< span style = "color: #990000" > ::< / span > Generate< span style = "color: #990000" > .< / span > new< span style = "color: #990000" > .< / span > run< span style = "color: #990000" > ([< / span > < span style = "color: #FF0000" > "yaffle"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "bird"< / span > < span style = "color: #990000" > ],< / span > < span style = "color: #990000" > :< / span > destination < span style = "color: #990000" > => < / span > fake_rails_root< span style = "color: #990000" > )< / span >
definition < span style = "color: #990000" > =< / span > File< span style = "color: #990000" > .< / span > read< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > join< span style = "color: #990000" > (< / span > fake_rails_root< span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > ))< / span >
assert_match < span style = "color: #FF6600" > /Yaffle\:/< / span > < span style = "color: #990000" > ,< / span > definition
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > Run < tt > rake< / tt > to watch the test fail, then make the test pass add the following:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/generators/yaffle/templates/definition.txt< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > Yaffle: A bird< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > "yaffle/commands"< / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/commands.rb< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'rails_generator'< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'rails_generator/commands'< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Yaffle < span style = "font-style: italic" > < span style = "color: #9A1900" > #:nodoc:< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Generator < span style = "font-style: italic" > < span style = "color: #9A1900" > #:nodoc:< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Commands < span style = "font-style: italic" > < span style = "color: #9A1900" > #:nodoc:< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Create
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > yaffle_definition
file< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Destroy
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > yaffle_definition
file< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > List
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > yaffle_definition
file< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Update
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > yaffle_definition
file< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "definition.txt"< / span > < span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-11-24 22:53:39 +01:00
Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Commands< span style = "color: #990000" > ::< / span > Create< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > Yaffle< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Commands< span style = "color: #990000" > ::< / span > Create
Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Commands< span style = "color: #990000" > ::< / span > Destroy< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > Yaffle< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Commands< span style = "color: #990000" > ::< / span > Destroy
Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Commands< span style = "color: #990000" > ::< / span > List< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > Yaffle< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Commands< span style = "color: #990000" > ::< / span > List
Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Commands< span style = "color: #990000" > ::< / span > Update< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > Yaffle< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > Commands< span style = "color: #990000" > ::< / span > Update
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > Finally, call your new method in the manifest:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/generators/yaffle/yaffle_generator.rb< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > YaffleGenerator < span style = "color: #990000" > < < / span > Rails< span style = "color: #990000" > ::< / span > Generator< span style = "color: #990000" > ::< / span > NamedBase
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > manifest
m< span style = "color: #990000" > .< / span > yaffle_definition
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
2008-10-27 07:47:01 +01:00
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< / div >
< h2 id = "_add_a_model" > 6. Add a model< / h2 >
< div class = "sectionbody" >
< div class = "para" > < p > This section describes how to add a model named < em > Woodpecker< / em > 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:< / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" >
2008-11-24 22:53:39 +01:00
< pre > < tt > vendor/plugins/yaffle/
|-- lib
| |-- app
| | |-- controllers
| | |-- helpers
| | |-- models
| | | `-- woodpecker.rb
| | `-- views
| |-- yaffle
| | |-- acts_as_yaffle.rb
| | |-- commands.rb
| | `-- core_ext.rb
| `-- yaffle.rb< / tt > < / pre >
2008-10-27 07:47:01 +01:00
< / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > As always, start with a test:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/yaffle/woodpecker_test.rb:< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > WoodpeckerTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
load_schema
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_woodpecker
assert_kind_of Woodpecker< span style = "color: #990000" > ,< / span > Woodpecker< span style = "color: #990000" > .< / span > new
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > This is just a simple test to make sure the class is being loaded correctly. After watching it fail with < tt > rake< / tt > , you can make it pass like so:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "color: #990000" > %< / span > w< span style = "color: #FF0000" > {< / span > models < span style = "color: #FF0000" > }< / span > < span style = "color: #990000" > .< / span > each < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > dir< span style = "color: #990000" > |< / span >
path < span style = "color: #990000" > =< / span > File< span style = "color: #990000" > .< / span > join< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > ),< / span > < span style = "color: #FF0000" > 'app'< / span > < span style = "color: #990000" > ,< / span > dir< span style = "color: #990000" > )< / span >
< span style = "color: #009900" > $LOAD_PATH< / span > < span style = "color: #990000" > < < < / span > path
ActiveSupport< span style = "color: #990000" > ::< / span > Dependencies< span style = "color: #990000" > .< / span > load_paths < span style = "color: #990000" > < < < / span > path
ActiveSupport< span style = "color: #990000" > ::< / span > Dependencies< span style = "color: #990000" > .< / span > load_once_paths< span style = "color: #990000" > .< / span > delete< span style = "color: #990000" > (< / span > path< span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > 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 < em > load_once_paths< / em > 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.< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/app/models/woodpecker.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > Woodpecker < span style = "color: #990000" > < < / span > ActiveRecord< span style = "color: #990000" > ::< / span > Base
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > Finally, add the following to your plugin's < em > schema.rb< / em > :< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/schema.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > ActiveRecord< span style = "color: #990000" > ::< / span > Schema< span style = "color: #990000" > .< / span > define< span style = "color: #990000" > (:< / span > version < span style = "color: #990000" > => < / span > < span style = "color: #993399" > 0< / span > < span style = "color: #990000" > )< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span >
create_table < span style = "color: #990000" > :< / span > woodpeckers< span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > force < span style = "color: #990000" > => < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > true< / span > < / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > t< span style = "color: #990000" > |< / span >
t< span style = "color: #990000" > .< / span > string < span style = "color: #990000" > :< / span > name
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > 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.< / p > < / div >
2008-10-27 07:47:01 +01:00
< / div >
2008-11-24 22:53:39 +01:00
< h2 id = "_add_a_controller" > 7. Add a controller< / h2 >
2008-10-27 07:47:01 +01:00
< div class = "sectionbody" >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > This section describes how to add a controller named < em > woodpeckers< / em > to your plugin that will behave the same as a controller in your main app. This is very similar to adding a model.< / p > < / div >
< div class = "para" > < p > You can test your plugin's controller as you would test any other controller:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/yaffle/woodpeckers_controller_test.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'woodpeckers_controller'< / span >
< span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > 'action_controller/test_process'< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > WoodpeckersController< span style = "color: #990000" > ;< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > rescue_action< span style = "color: #990000" > (< / span > e< span style = "color: #990000" > )< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > raise< / span > < / span > e < span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span > < span style = "color: #990000" > ;< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > WoodpeckersControllerTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > setup
< span style = "color: #009900" > @controller< / span > < span style = "color: #990000" > =< / span > WoodpeckersController< span style = "color: #990000" > .< / span > new
< span style = "color: #009900" > @request< / span > < span style = "color: #990000" > =< / span > ActionController< span style = "color: #990000" > ::< / span > TestRequest< span style = "color: #990000" > .< / span > new
< span style = "color: #009900" > @response< / span > < span style = "color: #990000" > =< / span > ActionController< span style = "color: #990000" > ::< / span > TestResponse< span style = "color: #990000" > .< / span > new
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_index
get < span style = "color: #990000" > :< / span > index
assert_response < span style = "color: #990000" > :< / span > success
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > This is just a simple test to make sure the controller is being loaded correctly. After watching it fail with < tt > rake< / tt > , you can make it pass like so:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "color: #990000" > %< / span > w< span style = "color: #FF0000" > {< / span > models controllers < span style = "color: #FF0000" > }< / span > < span style = "color: #990000" > .< / span > each < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > dir< span style = "color: #990000" > |< / span >
path < span style = "color: #990000" > =< / span > File< span style = "color: #990000" > .< / span > join< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > ),< / span > < span style = "color: #FF0000" > 'app'< / span > < span style = "color: #990000" > ,< / span > dir< span style = "color: #990000" > )< / span >
< span style = "color: #009900" > $LOAD_PATH< / span > < span style = "color: #990000" > < < < / span > path
ActiveSupport< span style = "color: #990000" > ::< / span > Dependencies< span style = "color: #990000" > .< / span > load_paths < span style = "color: #990000" > < < < / span > path
ActiveSupport< span style = "color: #990000" > ::< / span > Dependencies< span style = "color: #990000" > .< / span > load_once_paths< span style = "color: #990000" > .< / span > delete< span style = "color: #990000" > (< / span > path< span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/app/controllers/woodpeckers_controller.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > WoodpeckersController < span style = "color: #990000" > < < / span > ActionController< span style = "color: #990000" > ::< / span > Base
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > index
render < span style = "color: #990000" > :< / span > text < span style = "color: #990000" > => < / span > < span style = "color: #FF0000" > "Squawk!"< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > 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 < a href = "http://localhost:3000/woodpeckers" > http://localhost:3000/woodpeckers< / a > to see your controller in action.< / p > < / div >
< / div >
< h2 id = "_add_a_helper" > 8. Add a helper< / h2 >
< div class = "sectionbody" >
< div class = "para" > < p > This section describes how to add a helper named < em > WoodpeckersHelper< / em > 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.< / p > < / div >
< div class = "para" > < p > You can test your plugin's helper as you would test any other helper:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/woodpeckers_helper_test.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > )< / span > < span style = "color: #990000" > +< / span > < span style = "color: #FF0000" > '/test_helper.rb'< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > WoodpeckersHelper
2008-10-27 07:47:01 +01:00
2008-11-24 22:53:39 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > WoodpeckersHelperTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_tweet
assert_equal < span style = "color: #FF0000" > "Tweet! Hello"< / span > < span style = "color: #990000" > ,< / span > tweet< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "Hello"< / span > < span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > This is just a simple test to make sure the helper is being loaded correctly. After watching it fail with < tt > rake< / tt > , you can make it pass like so:< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/yaffle.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "color: #990000" > %< / span > w< span style = "color: #FF0000" > {< / span > models controllers helpers < span style = "color: #FF0000" > }< / span > < span style = "color: #990000" > .< / span > each < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > dir< span style = "color: #990000" > |< / span >
path < span style = "color: #990000" > =< / span > File< span style = "color: #990000" > .< / span > join< span style = "color: #990000" > (< / span > File< span style = "color: #990000" > .< / span > dirname< span style = "color: #990000" > (< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > __FILE__< / span > < / span > < span style = "color: #990000" > ),< / span > < span style = "color: #FF0000" > 'app'< / span > < span style = "color: #990000" > ,< / span > dir< span style = "color: #990000" > )< / span >
< span style = "color: #009900" > $LOAD_PATH< / span > < span style = "color: #990000" > < < < / span > path
ActiveSupport< span style = "color: #990000" > ::< / span > Dependencies< span style = "color: #990000" > .< / span > load_paths < span style = "color: #990000" > < < < / span > path
ActiveSupport< span style = "color: #990000" > ::< / span > Dependencies< span style = "color: #990000" > .< / span > load_once_paths< span style = "color: #990000" > .< / span > delete< span style = "color: #990000" > (< / span > path< span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
ActionView< span style = "color: #990000" > ::< / span > Base< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > WoodpeckersHelper
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/app/helpers/woodpeckers_helper.rb:< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > WoodpeckersHelper
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > tweet< span style = "color: #990000" > (< / span > text< span style = "color: #990000" > )< / span >
< span style = "color: #FF0000" > "Tweet! #{text}"< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > Now your test should be passing, and you should be able to use the Woodpeckers helper in your app.< / p > < / div >
< / div >
< h2 id = "_add_a_custom_route" > 9. Add a Custom Route< / h2 >
< div class = "sectionbody" >
< div class = "para" > < p > Testing routes in plugins can be complex, especially if the controllers are also in the plugin itself. Jamis Buck showed a great example of this in < a href = "http://weblog.jamisbuck.org/2006/10/26/monkey-patching-rails-extending-routes-2" > http://weblog.jamisbuck.org/2006/10/26/monkey-patching-rails-extending-routes-2< / a > .< / p > < / div >
< div class = "para" > < p > < strong > vendor/plugins/yaffle/test/routing_test.rb< / strong > < / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > "#{File.dirname(__FILE__)}/test_helper"< / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > class< / span > < / span > RoutingTest < span style = "color: #990000" > < < / span > Test< span style = "color: #990000" > ::< / span > Unit< span style = "color: #990000" > ::< / span > TestCase
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > setup
ActionController< span style = "color: #990000" > ::< / span > Routing< span style = "color: #990000" > ::< / span > Routes< span style = "color: #990000" > .< / span > draw < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > map< span style = "color: #990000" > |< / span >
map< span style = "color: #990000" > .< / span > yaffles
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > test_yaffles_route
assert_recognition < span style = "color: #990000" > :< / span > get< span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "/yaffles"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > controller < span style = "color: #990000" > => < / span > < span style = "color: #FF0000" > "yaffles_controller"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > action < span style = "color: #990000" > => < / span > < span style = "color: #FF0000" > "index"< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
private
< span style = "font-style: italic" > < span style = "color: #9A1900" > # yes, I know about assert_recognizes, but it has proven problematic to< / span > < / span >
< span style = "font-style: italic" > < span style = "color: #9A1900" > # use in these tests, since it uses RouteSet#recognize (which actually< / span > < / span >
< span style = "font-style: italic" > < span style = "color: #9A1900" > # tries to instantiate the controller) and because it uses an awkward< / span > < / span >
< span style = "font-style: italic" > < span style = "color: #9A1900" > # parameter order.< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > assert_recognition< span style = "color: #990000" > (< / span > method< span style = "color: #990000" > ,< / span > path< span style = "color: #990000" > ,< / span > options< span style = "color: #990000" > )< / span >
result < span style = "color: #990000" > =< / span > ActionController< span style = "color: #990000" > ::< / span > Routing< span style = "color: #990000" > ::< / span > Routes< span style = "color: #990000" > .< / span > recognize_path< span style = "color: #990000" > (< / span > path< span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > method < span style = "color: #990000" > => < / span > method< span style = "color: #990000" > )< / span >
assert_equal options< span style = "color: #990000" > ,< / span > result
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > < strong > vendor/plugins/yaffle/init.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #000080" > require< / span > < / span > < span style = "color: #FF0000" > "routing"< / span >
2008-10-27 07:47:01 +01:00
ActionController< span style = "color: #990000" > ::< / span > Routing< span style = "color: #990000" > ::< / span > RouteSet< span style = "color: #990000" > ::< / span > Mapper< span style = "color: #990000" > .< / span > send < span style = "color: #990000" > :< / span > < span style = "font-weight: bold" > < span style = "color: #0000FF" > include< / span > < / span > < span style = "color: #990000" > ,< / span > Yaffle< span style = "color: #990000" > ::< / span > Routing< span style = "color: #990000" > ::< / span > MapperExtensions
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > < strong > vendor/plugins/yaffle/lib/routing.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > < span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Yaffle < span style = "font-style: italic" > < span style = "color: #9A1900" > #:nodoc:< / span > < / span >
2008-10-27 07:47:01 +01:00
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > Routing < span style = "font-style: italic" > < span style = "color: #9A1900" > #:nodoc:< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > module< / span > < / span > MapperExtensions
< span style = "font-weight: bold" > < span style = "color: #0000FF" > def< / span > < / span > yaffles
< span style = "color: #009900" > @set< / span > < span style = "color: #990000" > .< / span > add_route< span style = "color: #990000" > (< / span > < span style = "color: #FF0000" > "/yaffles"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > {< / span > < span style = "color: #990000" > :< / span > controller < span style = "color: #990000" > => < / span > < span style = "color: #FF0000" > "yaffles_controller"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #990000" > :< / span > action < span style = "color: #990000" > => < / span > < span style = "color: #FF0000" > "index"< / span > < span style = "color: #FF0000" > }< / span > < span style = "color: #990000" > )< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > < strong > config/routes.rb< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > ActionController< span style = "color: #990000" > ::< / span > Routing< span style = "color: #990000" > ::< / span > Routes< span style = "color: #990000" > .< / span > draw < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span > < span style = "color: #990000" > |< / span > map< span style = "color: #990000" > |< / span >
2008-10-27 07:47:01 +01:00
< span style = "color: #990000" > ...< / span >
map< span style = "color: #990000" > .< / span > yaffles
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > You can also see if your routes work by running < tt > rake routes< / tt > from your app directory.< / p > < / div >
< / div >
2008-11-24 22:53:39 +01:00
< h2 id = "_odds_and_ends" > 10. Odds and ends< / h2 >
2008-10-27 07:47:01 +01:00
< div class = "sectionbody" >
2008-11-24 22:53:39 +01:00
< h3 id = "_generate_rdoc_documentation" > 10.1. Generate RDoc Documentation< / h3 >
2008-10-27 07:47:01 +01:00
< div class = "para" > < p > Once your plugin is stable, the tests pass on all database and you are ready to deploy do everyone else a favor and document it! Luckily, writing documentation for your plugin is easy.< / p > < / div >
< div class = "para" > < p > 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:< / p > < / div >
< div class = "ilist" > < ul >
< li >
< p >
Your name.
< / p >
< / li >
< li >
< p >
How to install.
< / p >
< / li >
< li >
< p >
How to add the functionality to the app (several examples of common use cases).
< / p >
< / li >
< li >
< p >
Warning, gotchas or tips that might help save users time.
< / p >
< / li >
< / ul > < / div >
< div class = "para" > < p > Once your README is solid, go through and add rdoc comments to all of the methods that developers will use.< / p > < / div >
< div class = "para" > < p > Before you generate your documentation, be sure to go through and add nodoc comments to those modules and methods that are not important to your users.< / p > < / div >
< div class = "para" > < p > Once your comments are good to go, navigate to your plugin directory and run:< / p > < / div >
< div class = "literalblock" >
< div class = "content" >
< pre > < tt > rake rdoc< / tt > < / pre >
< / div > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_write_custom_rake_tasks_in_your_plugin" > 10.2. Write custom Rake tasks in your plugin< / h3 >
2008-10-27 07:47:01 +01:00
< div class = "para" > < p > When you created the plugin with the built-in rails generator, it generated a rake file for you in < em > vendor/plugins/yaffle/tasks/yaffle.rake< / em > . Any rake task you add here will be available to the app.< / p > < / div >
< div class = "para" > < p > Many plugin authors put all of their rake tasks into a common namespace that is the same as the plugin, like so:< / p > < / div >
2008-11-24 22:53:39 +01:00
< div class = "para" > < p > < strong > vendor/plugins/yaffle/tasks/yaffle.rake< / strong > < / p > < / div >
2008-10-27 07:47:01 +01:00
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
2008-11-24 22:53:39 +01:00
< pre > < tt > namespace < span style = "color: #990000" > :< / span > yaffle < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span >
2008-10-27 07:47:01 +01:00
desc < span style = "color: #FF0000" > "Prints out the word 'Yaffle'"< / span >
task < span style = "color: #990000" > :< / span > squawk < span style = "color: #990000" > => < / span > < span style = "color: #990000" > :< / span > environment < span style = "font-weight: bold" > < span style = "color: #0000FF" > do< / span > < / span >
puts < span style = "color: #FF0000" > "squawk!"< / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< span style = "font-weight: bold" > < span style = "color: #0000FF" > end< / span > < / span >
< / tt > < / pre > < / div > < / div >
< div class = "para" > < p > When you run < tt > rake -T< / tt > from your plugin you will see:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > yaffle:squawk # Prints out the word 'Yaffle'< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > You can add as many files as you want in the tasks directory, and if they end in .rake Rails will pick them up.< / p > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_store_plugins_in_alternate_locations" > 10.3. Store plugins in alternate locations< / h3 >
2008-10-27 07:47:01 +01:00
< div class = "para" > < p > You can store plugins wherever you want - you just have to add those plugins to the plugins path in < em > environment.rb< / em > .< / p > < / div >
< div class = "para" > < p > Since the plugin is only loaded after the plugin paths are defined, you can't redefine this in your plugins - but it may be good to now.< / p > < / div >
< div class = "para" > < p > You can even store plugins inside of other plugins for complete plugin madness!< / p > < / div >
< div class = "listingblock" >
< div class = "content" > <!-- Generator: GNU source - highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
< pre > < tt > config< span style = "color: #990000" > .< / span > plugin_paths < span style = "color: #990000" > < < < / span > File< span style = "color: #990000" > .< / span > join< span style = "color: #990000" > (< / span > RAILS_ROOT< span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "vendor"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "plugins"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "yaffle"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "lib"< / span > < span style = "color: #990000" > ,< / span > < span style = "color: #FF0000" > "plugins"< / span > < span style = "color: #990000" > )< / span >
< / tt > < / pre > < / div > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_create_your_own_plugin_loaders_and_plugin_locators" > 10.4. Create your own Plugin Loaders and Plugin Locators< / h3 >
2008-10-27 07:47:01 +01:00
< div class = "para" > < p > If the built-in plugin behavior is inadequate, you can change almost every aspect of the location and loading process. You can write your own plugin locators and plugin loaders, but that's beyond the scope of this tutorial.< / p > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_use_custom_plugin_generators" > 10.5. Use Custom Plugin Generators< / h3 >
2008-10-27 07:47:01 +01:00
< div class = "para" > < p > If you are an RSpec fan, you can install the < tt > rspec_plugin_generator< / tt > gem, which will generate the spec folder and database for you. See < a href = "http://github.com/pat-maddox/rspec-plugin-generator/tree/master" > http://github.com/pat-maddox/rspec-plugin-generator/tree/master< / a > .< / p > < / div >
< / div >
2008-11-24 22:53:39 +01:00
< h2 id = "_appendix" > 11. Appendix< / h2 >
2008-10-27 07:47:01 +01:00
< div class = "sectionbody" >
2008-11-24 22:53:39 +01:00
< h3 id = "_references" > 11.1. References< / h3 >
2008-10-27 07:47:01 +01:00
< div class = "ilist" > < ul >
< li >
< p >
< a href = "http://nubyonrails.com/articles/the-complete-guide-to-rails-plugins-part-i" > http://nubyonrails.com/articles/the-complete-guide-to-rails-plugins-part-i< / a >
< / p >
< / li >
< li >
< p >
< a href = "http://nubyonrails.com/articles/2006/05/09/the-complete-guide-to-rails-plugins-part-ii" > http://nubyonrails.com/articles/2006/05/09/the-complete-guide-to-rails-plugins-part-ii< / a >
< / p >
< / li >
< li >
< p >
< a href = "http://github.com/technoweenie/attachment_fu/tree/master" > http://github.com/technoweenie/attachment_fu/tree/master< / a >
< / p >
< / li >
< li >
< p >
< a href = "http://daddy.platte.name/2007/05/rails-plugins-keep-initrb-thin.html" > http://daddy.platte.name/2007/05/rails-plugins-keep-initrb-thin.html< / a >
< / p >
< / li >
< / ul > < / div >
2008-11-24 22:53:39 +01:00
< h3 id = "_final_plugin_directory_structure" > 11.2. Final plugin directory structure< / h3 >
2008-10-27 07:47:01 +01:00
< div class = "para" > < p > The final plugin should have a directory structure that looks something like this:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > |-- MIT-LICENSE
|-- README
|-- Rakefile
|-- generators
| `-- yaffle
| |-- USAGE
| |-- templates
| | `-- definition.txt
| `-- yaffle_generator.rb
|-- init.rb
|-- install.rb
|-- lib
| |-- acts_as_yaffle.rb
| |-- commands.rb
| |-- core_ext.rb
| |-- routing.rb
| `-- view_helpers.rb
|-- tasks
| `-- yaffle_tasks.rake
|-- test
| |-- acts_as_yaffle_test.rb
| |-- core_ext_test.rb
| |-- database.yml
| |-- debug.log
| |-- routing_test.rb
| |-- schema.rb
| |-- test_helper.rb
| `-- view_helpers_test.rb
|-- uninstall.rb
`-- yaffle_plugin.sqlite3.db< / tt > < / pre >
< / div > < / div >
< / div >
< / div >
< / div >
< / body >
< / html >
