Merge branch 'master' of git@github.com:lifo/docrails

14 files changed, 3559 insertions, 964 deletions

diff --git a/railties/doc/guides/html/2_2_release_notes.html b/railties/doc/guides/html/2_2_release_notes.html
index e79f7ec511..778144b688 100644
--- a/railties/doc/guides/html/2_2_release_notes.html
+++ b/railties/doc/guides/html/2_2_release_notes.html
@@ -789,7 +789,7 @@ You can now easily <a href="http://m.onkey.org/2008/7/20/rescue-from-dispatching
 </li>

 <li>

 <p>

-The HTTP Accept header is disabled by default now. You should prefer the use of formatted URLs (such as <tt>/customers/1.xml</tt>) to indicate the format that you want. If you need the Accept headers, you can turn them back on with <tt>config.action_controller.user_accept_header = true</tt>.

+The HTTP Accept header is disabled by default now. You should prefer the use of formatted URLs (such as <tt>/customers/1.xml</tt>) to indicate the format that you want. If you need the Accept headers, you can turn them back on with <tt>config.action_controller.use_accept_header = true</tt>.

 </p>

 </li>

 <li>

@@ -812,6 +812,16 @@ Rails now supports HTTP-only cookies (and uses them for sessions), which help mi
 <tt>render</tt> now supports a <tt>:js</tt> option to render plain vanilla javascript with the right mime type.

 </p>

 </li>

+<li>

+<p>

+Request forgery protection has been tightened up to apply to HTML-formatted content requests only.

+</p>

+</li>

+<li>

+<p>

+Polymorphic URLs behave more sensibly if a passed parameter is nil. For example, calling <tt>polymorphic_path([@project, @date, @area])</tt> with a nil date will give you <tt>project_area_path</tt>.

+</p>

+</li>

 </ul></div>

 </div>

 <h2 id="_action_view">7. Action View</h2>

@@ -856,6 +866,7 @@ More information:
 </ul></div>

 </li>

 </ul></div>

+<div class="para"><p>Action Mailer now offers built-in support for GMail's SMTP servers, by turning on STARTTLS automatically. This requires Ruby 1.8.7 to be installed.</p></div>

 </div>

 <h2 id="_active_support">9. Active Support</h2>

 <div class="sectionbody">

@@ -963,7 +974,7 @@ The addition of <tt>ActiveSupport::Rescuable</tt> allows any class to mix in the
 </li>

 <li>

 <p>

-<tt>Array#second</tt> through <tt>Array#tenth</tt> as aliases for <tt>Array#[1]</tt> through <tt>Array#[9]</tt>

+<tt>Array#second</tt> through <tt>Array#fifth</tt> as aliases for <tt>Array#[1]</tt> through <tt>Array#[4]</tt>

 </p>

 </li>

 <li>

@@ -983,7 +994,7 @@ The addition of <tt>ActiveSupport::Rescuable</tt> allows any class to mix in the
 </li>

 <li>

 <p>

-The included TzInfo library has been upgraded to version 0.3.11.

+The included TzInfo library has been upgraded to version 0.3.12.

 </p>

 </li>

 <li>

@@ -1006,7 +1017,7 @@ The included TzInfo library has been upgraded to version 0.3.11.
 </li>

 <li>

 <p>

-<tt>rake gems</tt> to list all configured gems, as well as whether they (and their dependencies) are installed or frozen

+<tt>rake gems</tt> to list all configured gems, as well as whether they (and their dependencies) are installed, frozen, or framework (framework gems are those loaded by Rails before the gem dependency code is executed; such gems cannot be frozen)

 </p>

 </li>

 <li>

@@ -1057,6 +1068,11 @@ More information:
 <a href="http://afreshcup.com/2008/10/25/rails-212-and-22rc1-update-your-rubygems/">Rails 2.1.2 and 2.2RC1: Update Your RubyGems</a>

 </p>

 </li>

+<li>

+<p>

+<a href="http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/1128">Detailed discussion on Lighthouse</a>

+</p>

+</li>

 </ul></div>

 </li>

 </ul></div>

@@ -1094,7 +1110,7 @@ Wrapped <tt>Rails.env</tt> in <tt>StringInquirer</tt> so you can do <tt>Rails.en
 </li>

 <li>

 <p>

-<tt>script/generate</tt> works without deprecation warnings when RubyGems 1.3.0 is present

+To eliminate deprecation warnings and properly handle gem dependencies, Rails now requires rubygems 1.3.1 or higher.

 </p>

 </li>

 </ul></div>

diff --git a/railties/doc/guides/html/actioncontroller_basics.html b/railties/doc/guides/html/actioncontroller_basics.html
index 66563bf1a3..4af157d4f7 100644
--- a/railties/doc/guides/html/actioncontroller_basics.html
+++ b/railties/doc/guides/html/actioncontroller_basics.html
@@ -723,7 +723,7 @@ http://www.gnu.org/software/src-highlite -->
 

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-<div class="para"><p>Note that while for session values, you set the key to <tt>nil</tt>, to delete a cookie value, you should use <tt>cookies.delete(:key)</tt>.</p></div>

+<div class="para"><p>Note that while for session values you set the key to <tt>nil</tt>, to delete a cookie value you should use <tt>cookies.delete(:key)</tt>.</p></div>

 </div>

 <h2 id="_filters">6. Filters</h2>

 <div class="sectionbody">

@@ -767,7 +767,7 @@ http://www.gnu.org/software/src-highlite -->
 

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-<div class="para"><p>In this example, the filter is added to ApplicationController and thus all controllers in the application. This will make everything in the application require the user to be logged in in order to use it. For obvious reasons (the user wouldn't be able to log in in the first place!), not all controllers or actions should require this. You can prevent this filter from running before particular actions with <tt>skip_before_filter</tt> :</p></div>

+<div class="para"><p>In this example, the filter is added to ApplicationController and thus all controllers in the application. This will make everything in the application require the user to be logged in in order to use it. For obvious reasons (the user wouldn't be able to log in in the first place!), not all controllers or actions should require this. You can prevent this filter from running before particular actions with <tt>skip_before_filter</tt>:</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -779,7 +779,7 @@ http://www.gnu.org/software/src-highlite -->
 

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-<div class="para"><p>Now, the <tt>LoginsController</tt>'s "new" and "create" actions will work as before without requiring the user to be logged in. The <tt>:only</tt> option is used to only skip this filter for these actions, and there is also an <tt>:except</tt> option which works the other way. These options can be used when adding filters too, so you can add a filter which only runs for selected actions in the first place.</p></div>

+<div class="para"><p>Now, the LoginsController's <tt>new</tt> and <tt>create</tt> actions will work as before without requiring the user to be logged in. The <tt>:only</tt> option is used to only skip this filter for these actions, and there is also an <tt>:except</tt> option which works the other way. These options can be used when adding filters too, so you can add a filter which only runs for selected actions in the first place.</p></div>

 <h3 id="_after_filters_and_around_filters">6.1. After Filters and Around Filters</h3>

 <div class="para"><p>In addition to the before filters, you can run filters after an action has run or both before and after. The after filter is similar to the before filter, but because the action has already been run it has access to the response data that's about to be sent to the client. Obviously, after filters can not stop the action from running. Around filters are responsible for running the action, but they can choose not to, which is the around filter's way of stopping it.</p></div>

 <div class="listingblock">

@@ -872,7 +872,7 @@ http://www.gnu.org/software/src-highlite -->
 

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-<div class="para"><p>Now the <tt>create</tt> action won't run unless the "username" and "password" parameters are present, and if they're not, an error message will be added to the flash and the "new" action will be rendered. But there's something rather important missing from the verification above: It will be used for <strong>every</strong> action in LoginsController, which is not what we want. You can limit which actions it will be used for with the <tt>:only</tt> and <tt>:except</tt> options just like a filter:</p></div>

+<div class="para"><p>Now the <tt>create</tt> action won't run unless the "username" and "password" parameters are present, and if they're not, an error message will be added to the flash and the <tt>new</tt> action will be rendered. But there's something rather important missing from the verification above: It will be used for <strong>every</strong> action in LoginsController, which is not what we want. You can limit which actions it will be used for with the <tt>:only</tt> and <tt>:except</tt> options just like a filter:</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -934,7 +934,7 @@ host - The hostname used for this request.
 </li>

 <li>

 <p>

-domain - The hostname without the first segment (usually "www").

+domain(n=2) - The hostname's first <tt>n</tt> segments, starting from the right (the TLD)

 </p>

 </li>

 <li>

@@ -949,7 +949,7 @@ method - The HTTP method used for the request.
 </li>

 <li>

 <p>

-get?, post?, put?, delete?, head? - Returns true if the HTTP method is get/post/put/delete/head.

+get?, post?, put?, delete?, head? - Returns true if the HTTP method is GET/POST/PUT/DELETE/HEAD.

 </p>

 </li>

 <li>

@@ -964,7 +964,7 @@ port - The port number (integer) used for the request.
 </li>

 <li>

 <p>

-protocol - The protocol used for the request.

+protocol - Returns a string containing the prototol used plus "://", for example "http://"

 </p>

 </li>

 <li>

@@ -1118,7 +1118,7 @@ http://www.gnu.org/software/src-highlite -->
 <td class="icon">

 <img src="./images/icons/tip.png" alt="Tip" />

 </td>

-<td class="content">It is not recommended that you stream static files through Rails if you can instead keep them in a public folder on your web server. It is much more efficient to let the user download the file directly using Apache or another web server, keeping the request from unnecessarily going through the whole Rails stack.</td>

+<td class="content">It is not recommended that you stream static files through Rails if you can instead keep them in a public folder on your web server. It is much more efficient to let the user download the file directly using Apache or another web server, keeping the request from unnecessarily going through the whole Rails stack. Although if you do need the request to go through Rails for some reason, you can set the <tt>:x_sendfile</tt> option to true, and Rails will let the web server handle sending the file to the user, freeing up the Rails process to do other things. Note that your web server needs to support the <tt>X-Sendfile</tt> header for this to work, and you still have to be careful not to use user input in a way that lets someone retrieve arbitrary files.</td>

 </tr></table>

 </div>

 <h3 id="_restful_downloads">11.2. RESTful Downloads</h3>

@@ -1166,7 +1166,7 @@ http://www.gnu.org/software/src-highlite -->
 </div>

 <h2 id="_parameter_filtering">12. Parameter Filtering</h2>

 <div class="sectionbody">

-<div class="para"><p>Rails keeps a log file for each environment (development, test and production) in the "log" folder. These are extremely useful when debugging what's actually going on in your application, but in a live application you may not want every bit of information to be stored in the log file. The <tt>filter_parameter_logging</tt> method can be used to filter out sensitive information from the log. It works by replacing certain values in the <tt>params</tt> hash with "[FILTERED]" as they are written to the log. As an example, let's see how to filter all parameters with keys that include "password":</p></div>

+<div class="para"><p>Rails keeps a log file for each environment (development, test and production) in the <tt>log</tt> folder. These are extremely useful when debugging what's actually going on in your application, but in a live application you may not want every bit of information to be stored in the log file. The <tt>filter_parameter_logging</tt> method can be used to filter out sensitive information from the log. It works by replacing certain values in the <tt>params</tt> hash with "[FILTERED]" as they are written to the log. As an example, let's see how to filter all parameters with keys that include "password":</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -1178,7 +1178,7 @@ http://www.gnu.org/software/src-highlite -->
 

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-<div class="para"><p>The method works recursively through all levels of the params hash and takes an optional second parameter which is used as the replacement string if present. It can also take a block which receives each key in return and replaces those for which the block returns true.</p></div>

+<div class="para"><p>The method works recursively through all levels of the params hash and takes an optional second parameter which is used as the replacement string if present. It can also take a block which receives each key in turn and replaces those for which the block returns true.</p></div>

 </div>

 <h2 id="_rescue">13. Rescue</h2>

 <div class="sectionbody">

diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html
index 45eec6ffa1..097ad76d1e 100644
--- a/railties/doc/guides/html/activerecord_validations_callbacks.html
+++ b/railties/doc/guides/html/activerecord_validations_callbacks.html
@@ -267,6 +267,43 @@ ul#navMain {
 					<a href="#_writing_your_own_validation_methods">Writing your own validation methods</a>
 					</li>
 					<li>
+					<a href="#_using_the_tt_errors_tt_collection">Using the <tt>errors</tt> collection</a>
+					</li>
+					<li>
+					<a href="#_callbacks">Callbacks</a>
+						<ul>
+						
+							<li><a href="#_callbacks_registration">Callbacks registration</a></li>
+						
+							<li><a href="#_registering_callbacks_by_overriding_the_callback_methods">Registering callbacks by overriding the callback methods</a></li>
+						
+							<li><a href="#_registering_callbacks_by_using_macro_style_class_methods">Registering callbacks by using macro-style class methods</a></li>
+						
+						</ul>
+					</li>
+					<li>
+					<a href="#_available_callbacks">Available callbacks</a>
+						<ul>
+						
+							<li><a href="#_callbacks_called_both_when_creating_or_updating_a_record">Callbacks called both when creating or updating a record.</a></li>
+						
+							<li><a href="#_callbacks_called_only_when_creating_a_new_record">Callbacks called only when creating a new record.</a></li>
+						
+							<li><a href="#_callbacks_called_only_when_updating_an_existing_record">Callbacks called only when updating an existing record.</a></li>
+						
+							<li><a href="#_callbacks_called_when_removing_a_record_from_the_database">Callbacks called when removing a record from the database.</a></li>
+						
+							<li><a href="#_the_tt_after_initialize_tt_and_tt_after_find_tt_callbacks">The <tt>after_initialize</tt> and <tt>after_find</tt> callbacks</a></li>
+						
+						</ul>
+					</li>
+					<li>
+					<a href="#_halting_execution">Halting Execution</a>
+					</li>
+					<li>
+					<a href="#_callback_classes">Callback classes</a>
+					</li>
+					<li>
 					<a href="#_changelog">Changelog</a>
 					</li>
 			</ol>
@@ -358,7 +395,15 @@ http://www.gnu.org/software/src-highlite -->
 &gt;&gt; p.new_record?

 =&gt; false</tt></pre>

 </div></div>

-<div class="para"><p>Saving new records means sending an SQL insert operation to the database, while saving existing records (by calling either <tt>save</tt>, <tt>update_attribute</tt> or <tt>update_attributes</tt>) will result in a SQL update operation. Active Record will use this facts to perform validations upon your objects, avoiding then to be recorded to the database if their inner state is invalid in some way. You can specify validations that will be beformed every time a object is saved, just when you're creating a new record or when you're updating an existing one.</p></div>

+<div class="para"><p>Saving new records means sending an SQL insert operation to the database, while saving existing records (by calling either <tt>save</tt> or <tt>update_attributes</tt>) will result in a SQL update operation. Active Record will use this facts to perform validations upon your objects, avoiding then to be recorded to the database if their inner state is invalid in some way. You can specify validations that will be beformed every time a object is saved, just when you're creating a new record or when you're updating an existing one.</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/caution.png" alt="Caution" />

+</td>

+<td class="content">There are four methods that when called will trigger validation: <tt>save</tt>, <tt>save!</tt>, <tt>update_attributes</tt> and <tt>update_attributes!</tt>. There is one method left, which is <tt>update_attribute</tt>. This method will update the value of an attribute without triggering any validation, so be careful when using <tt>update_attribute</tt>, since it can let you save your objects in an invalid state.</td>

+</tr></table>

+</div>

 <h3 id="_the_meaning_of_em_valid_em">2.2. The meaning of <em>valid</em></h3>

 <div class="para"><p>For verifying if an object is valid, Active Record uses the <tt>valid?</tt> method, which basically looks inside the object to see if it has any validation errors. These errors live in a collection that can be accessed through the <tt>errors</tt> instance method. The proccess is really simple: If the <tt>errors</tt> method returns an empty collection, the object is valid and can be saved. Each time a validation fails, an error message is added to the <tt>errors</tt> collection.</p></div>

 </div>

@@ -719,14 +764,14 @@ http://www.gnu.org/software/src-highlite -->
   <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>If your validation rules are too complicated and you want to break it in small methods, you can implement all of them and call one of <tt>validate</tt>, <tt>validate_on_create</tt> or <tt>validate_on_update</tt> methods, passing it the symbols for the methods' names.</p></div>

+<div class="para"><p>If your validation rules are too complicated and you want to break them in small methods, you can implement all of them and call one of <tt>validate</tt>, <tt>validate_on_create</tt> or <tt>validate_on_update</tt> methods, passing it the symbols for the methods' names.</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> Invoice <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

-  validate <span style="color: #990000">:</span>expiration_date_cannot_be_in_the_past<span style="color: #990000">,</span> <span style="color: #990000">:</span>discount_cannot_be_be_more_than_total_value

+  validate <span style="color: #990000">:</span>expiration_date_cannot_be_in_the_past<span style="color: #990000">,</span> <span style="color: #990000">:</span>discount_cannot_be_more_than_total_value

 

   <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> expiration_date_cannot_be_in_the_past

     errors<span style="color: #990000">.</span>add<span style="color: #990000">(:</span>expiration_date<span style="color: #990000">,</span> <span style="color: #FF0000">"can't be in the past"</span><span style="color: #990000">)</span> <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="color: #990000">!</span>expiration_date<span style="color: #990000">.</span>blank? <span style="font-weight: bold"><span style="color: #0000FF">and</span></span> expiration_date <span style="color: #990000">&lt;</span> Date<span style="color: #990000">.</span>today

@@ -738,7 +783,359 @@ http://www.gnu.org/software/src-highlite -->
 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

 </div>

-<h2 id="_changelog">7. Changelog</h2>

+<h2 id="_using_the_tt_errors_tt_collection">7. Using the <tt>errors</tt> collection</h2>

+<div class="sectionbody">

+<div class="para"><p>You can do more than just call <tt>valid?</tt> upon your objects based on the existance of the <tt>errors</tt> collection. Here is a list of the other available methods that you can use to manipulate errors or ask for an object's state.</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+<tt>add_to_base</tt> lets you add errors messages that are related to the object's state as a whole, instead of being related to a specific attribute. You can use this method when you want to say that the object is invalid, no matter the values of it's attributes. <tt>add_to_base</tt> receives a string with the message.

+</p>

+</li>

+</ul></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> Person <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> a_method_used_for_validation_purposes

+    errors<span style="color: #990000">.</span>add_to_base<span style="color: #990000">(</span><span style="color: #FF0000">"This person is invalid because ..."</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="ilist"><ul>

+<li>

+<p>

+<tt>add</tt> lets you manually add messages that are related to particular attributes. When writing those messages, keep in mind that Rails will prepend them with the name of the attribute that holds the error, so write it in a way that makes sense. <tt>add</tt> receives a symbol with the name of the attribute that you want to add the message to and the message itself.

+</p>

+</li>

+</ul></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> Person <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> a_method_used_for_validation_purposes

+    errors<span style="color: #990000">.</span>add<span style="color: #990000">(:</span>name<span style="color: #990000">,</span> <span style="color: #FF0000">"can't have the characters !@#$%*()_-+="</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="ilist"><ul>

+<li>

+<p>

+<tt>invalid?</tt> is used when you want to check if a particular attribute is invalid. It receives a symbol with the name of the attribute that you want to check.

+</p>

+</li>

+</ul></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> Person <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  validates_presence_of <span style="color: #990000">:</span>name<span style="color: #990000">,</span> <span style="color: #990000">:</span>email

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+person <span style="color: #990000">=</span> Person<span style="color: #990000">.</span>new<span style="color: #990000">(:</span>name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"John Doe"</span><span style="color: #990000">)</span>

+person<span style="color: #990000">.</span>invalid?<span style="color: #990000">(:</span>email<span style="color: #990000">)</span> <span style="font-style: italic"><span style="color: #9A1900"># =&gt; true</span></span>

+</tt></pre></div></div>

+<div class="ilist"><ul>

+<li>

+<p>

+<tt>on</tt> is used when you want to check the error messages for a specific attribute. It will return different kinds of objects depending on the state of the <tt>errors</tt> collection for the given attribute. If there are no errors related to the attribute, <tt>on</tt> will return <tt>nil</tt>. If there is just one errors message for this attribute, <tt>on</tt> will return a string with the message. When <tt>errors</tt> holds two or more error messages for the attribute, <tt>on</tt> will return an array of strings, each one with one error message.

+</p>

+</li>

+</ul></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> Person <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  validates_presence_of <span style="color: #990000">:</span>name

+  validates_length_of <span style="color: #990000">:</span>name<span style="color: #990000">,</span> <span style="color: #990000">:</span>minimum <span style="color: #990000">=&gt;</span> <span style="color: #993399">3</span>

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+person <span style="color: #990000">=</span> Person<span style="color: #990000">.</span>new<span style="color: #990000">(:</span>name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"John Doe"</span><span style="color: #990000">)</span>

+person<span style="color: #990000">.</span>valid? <span style="font-style: italic"><span style="color: #9A1900"># =&gt; true</span></span>

+person<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>on<span style="color: #990000">(:</span>name<span style="color: #990000">)</span> <span style="font-style: italic"><span style="color: #9A1900"># =&gt; nil</span></span>

+

+person <span style="color: #990000">=</span> Person<span style="color: #990000">.</span>new<span style="color: #990000">(:</span>name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"JD"</span><span style="color: #990000">)</span>

+person<span style="color: #990000">.</span>valid? <span style="font-style: italic"><span style="color: #9A1900"># =&gt; false</span></span>

+person<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>on<span style="color: #990000">(:</span>name<span style="color: #990000">)</span> <span style="font-style: italic"><span style="color: #9A1900"># =&gt; "is too short (minimum is 3 characters)"</span></span>

+

+person <span style="color: #990000">=</span> Person<span style="color: #990000">.</span>new

+person<span style="color: #990000">.</span>valid? <span style="font-style: italic"><span style="color: #9A1900"># =&gt; false</span></span>

+person<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>on<span style="color: #990000">(:</span>name<span style="color: #990000">)</span> <span style="font-style: italic"><span style="color: #9A1900"># =&gt; ["can't be blank", "is too short (minimum is 3 characters)"]</span></span>

+</tt></pre></div></div>

+<div class="ilist"><ul>

+<li>

+<p>

+<tt>clear</tt> is used when you intentionally wants to clear all the messages in the <tt>errors</tt> collection.

+</p>

+</li>

+</ul></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> Person <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  validates_presence_of <span style="color: #990000">:</span>name

+  validates_length_of <span style="color: #990000">:</span>name<span style="color: #990000">,</span> <span style="color: #990000">:</span>minimum <span style="color: #990000">=&gt;</span> <span style="color: #993399">3</span>

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+person <span style="color: #990000">=</span> Person<span style="color: #990000">.</span>new

+puts person<span style="color: #990000">.</span>valid? <span style="font-style: italic"><span style="color: #9A1900"># =&gt; false</span></span>

+person<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>on<span style="color: #990000">(:</span>name<span style="color: #990000">)</span> <span style="font-style: italic"><span style="color: #9A1900"># =&gt; ["can't be blank", "is too short (minimum is 3 characters)"]</span></span>

+person<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>clear

+person<span style="color: #990000">.</span>errors <span style="font-style: italic"><span style="color: #9A1900"># =&gt; nil</span></span>

+</tt></pre></div></div>

+</div>

+<h2 id="_callbacks">8. Callbacks</h2>

+<div class="sectionbody">

+<div class="para"><p>Callbacks are methods that get called at certain moments of an object's lifecycle. With callbacks it's possible to write code that will run whenever an Active Record object is created, saved, updated, deleted or loaded from the database.</p></div>

+<h3 id="_callbacks_registration">8.1. Callbacks registration</h3>

+<div class="para"><p>In order to use the available callbacks, you need to registrate them. There are two ways of doing that.</p></div>

+<h3 id="_registering_callbacks_by_overriding_the_callback_methods">8.2. Registering callbacks by overriding the callback methods</h3>

+<div class="para"><p>You can specify the callback method direcly, by overriding it. Let's see how it works using the <tt>before_validation</tt> callback, which will surprisingly run right before any validation is done.</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> User <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  validates_presence_of <span style="color: #990000">:</span>login<span style="color: #990000">,</span> <span style="color: #990000">:</span>email

+

+  protected

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> before_validation

+    <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="font-weight: bold"><span style="color: #0000FF">self</span></span><span style="color: #990000">.</span>login<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">self</span></span><span style="color: #990000">.</span>login <span style="color: #990000">=</span> email <span style="font-weight: bold"><span style="color: #0000FF">unless</span></span> email<span style="color: #990000">.</span>blank?

+    <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>

+<h3 id="_registering_callbacks_by_using_macro_style_class_methods">8.3. Registering callbacks by using macro-style class methods</h3>

+<div class="para"><p>The other way you can register a callback method is by implementing it as an ordinary method, and then using a macro-style class method to register it as a callback. The last example could be written like that:</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> User <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  validates_presence_of <span style="color: #990000">:</span>login<span style="color: #990000">,</span> <span style="color: #990000">:</span>email

+

+  before_validation <span style="color: #990000">:</span>ensure_login_has_a_value

+

+  protected

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> ensure_login_has_a_value

+    <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="font-weight: bold"><span style="color: #0000FF">self</span></span><span style="color: #990000">.</span>login<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">self</span></span><span style="color: #990000">.</span>login <span style="color: #990000">=</span> email <span style="font-weight: bold"><span style="color: #0000FF">unless</span></span> email<span style="color: #990000">.</span>blank?

+    <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>

+<div class="para"><p>The macro-style class methods can also receive a block. Rails best practices say that you should only use this style of registration if the code inside your block is so short that it fits in just one line.</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> User <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  validates_presence_of <span style="color: #990000">:</span>login<span style="color: #990000">,</span> <span style="color: #990000">:</span>email

+

+  before_create <span style="color: #FF0000">{</span><span style="color: #990000">|</span>user<span style="color: #990000">|</span> user<span style="color: #990000">.</span>name <span style="color: #990000">=</span> user<span style="color: #990000">.</span>login<span style="color: #990000">.</span>capitalize <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> user<span style="color: #990000">.</span>name<span style="color: #990000">.</span>blank?<span style="color: #FF0000">}</span>

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+</tt></pre></div></div>

+<div class="para"><p>In Rails, the preferred way of registering callbacks is by using macro-style class methods. The main advantages of using macro-style class methods are:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+You can add more than one method for each type of callback. Those methods will be queued for execution at the same order they were registered.

+</p>

+</li>

+<li>

+<p>

+Readability, since your callback declarations will live at the beggining of your models' files.

+</p>

+</li>

+</ul></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/caution.png" alt="Caution" />

+</td>

+<td class="content">Remember to always declare the callback methods as being protected or private. These methods should never be public, otherwise it will be possible to call them from code outside the model, violating object encapsulation and exposing implementation details.</td>

+</tr></table>

+</div>

+</div>

+<h2 id="_available_callbacks">9. Available callbacks</h2>

+<div class="sectionbody">

+<div class="para"><p>Here is a list with all the available Active Record callbacks, listed in the same order in which they will get called during the respective operations.</p></div>

+<h3 id="_callbacks_called_both_when_creating_or_updating_a_record">9.1. Callbacks called both when creating or updating a record.</h3>

+<div class="ilist"><ul>

+<li>

+<p>

+<tt>before_validation</tt>

+</p>

+</li>

+<li>

+<p>

+<tt>after_validation</tt>

+</p>

+</li>

+<li>

+<p>

+<tt>before_save</tt>

+</p>

+</li>

+<li>

+<p>

+<strong>INSERT OR UPDATE OPERATION</strong>

+</p>

+</li>

+<li>

+<p>

+<tt>after_save</tt>

+</p>

+</li>

+</ul></div>

+<h3 id="_callbacks_called_only_when_creating_a_new_record">9.2. Callbacks called only when creating a new record.</h3>

+<div class="ilist"><ul>

+<li>

+<p>

+<tt>before_validation_on_create</tt>

+</p>

+</li>

+<li>

+<p>

+<tt>after_validation_on_create</tt>

+</p>

+</li>

+<li>

+<p>

+<tt>before_create</tt>

+</p>

+</li>

+<li>

+<p>

+<strong>INSERT OPERATION</strong>

+</p>

+</li>

+<li>

+<p>

+<tt>after_create</tt>

+</p>

+</li>

+</ul></div>

+<h3 id="_callbacks_called_only_when_updating_an_existing_record">9.3. Callbacks called only when updating an existing record.</h3>

+<div class="ilist"><ul>

+<li>

+<p>

+<tt>before_validation_on_update</tt>

+</p>

+</li>

+<li>

+<p>

+<tt>after_validation_on_update</tt>

+</p>

+</li>

+<li>

+<p>

+<tt>before_update</tt>

+</p>

+</li>

+<li>

+<p>

+<strong>UPDATE OPERATION</strong>

+</p>

+</li>

+<li>

+<p>

+<tt>after_update</tt>

+</p>

+</li>

+</ul></div>

+<h3 id="_callbacks_called_when_removing_a_record_from_the_database">9.4. Callbacks called when removing a record from the database.</h3>

+<div class="ilist"><ul>

+<li>

+<p>

+<tt>before_destroy</tt>

+</p>

+</li>

+<li>

+<p>

+<strong>DELETE OPERATION</strong>

+</p>

+</li>

+<li>

+<p>

+<tt>after_destroy</tt>

+</p>

+</li>

+</ul></div>

+<div class="para"><p>The <tt>before_destroy</tt> and <tt>after_destroy</tt> callbacks will only be called if you delete the model using either the <tt>destroy</tt> instance method or one of the <tt>destroy</tt> or <tt>destroy_all</tt> class methods of your Active Record class. If you use <tt>delete</tt> or <tt>delete_all</tt> no callback operations will run, since Active Record will not instantiate any objects, accessing the records to be deleted directly in the database.</p></div>

+<h3 id="_the_tt_after_initialize_tt_and_tt_after_find_tt_callbacks">9.5. The <tt>after_initialize</tt> and <tt>after_find</tt> callbacks</h3>

+<div class="para"><p>The <tt>after_initialize</tt> callback will be called whenever an Active Record object is instantiated, either by direcly using <tt>new</tt> or when a record is loaded from the database. It can be useful to avoid the need to directly override your Active Record <tt>initialize</tt> method.</p></div>

+<div class="para"><p>The <tt>after_find</tt> callback will be called whenever Active Record loads a record from the database. When used together with <tt>after_initialize</tt> it will run first, since Active Record will first read the record from the database and them create the model object that will hold it.</p></div>

+<div class="para"><p>The <tt>after_initialize</tt> and <tt>after_find</tt> callbacks are a bit different from the others, since the only way to register those callbacks is by defining them as methods. If you try to register <tt>after_initialize</tt> or <tt>after_find</tt> using macro-style class methods, they will just be ignored. This behaviour is due to performance reasons, since <tt>after_initialize</tt> and <tt>after_find</tt> will both be called for each record found in the database, significantly slowing down the queries.</p></div>

+</div>

+<h2 id="_halting_execution">10. Halting Execution</h2>

+<div class="sectionbody">

+<div class="para"><p>As you start registering new callbacks for your models, they will be queued for execution. This queue will include all your model's validations, the registered callbacks and the database operation to be executed. However, if at any moment one of the callback methods returns a boolean <tt>false</tt> (not <tt>nil</tt>) value, this execution chain will be halted and the desired operation will not complete: your model will not get persisted in the database, or your records will not get deleted and so on.</p></div>

+</div>

+<h2 id="_callback_classes">11. Callback classes</h2>

+<div class="sectionbody">

+<div class="para"><p>Sometimes the callback methods that you'll write will be useful enough to be reused at other models. Active Record makes it possible to create classes that encapsulate the callback methods, so it becomes very easy to reuse them.</p></div>

+<div class="para"><p>Here's an example where we create a class with a after_destroy callback for a PictureFile model.</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> PictureFileCallbacks

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> after_destroy<span style="color: #990000">(</span>picture_file<span style="color: #990000">)</span>

+    File<span style="color: #990000">.</span>delete<span style="color: #990000">(</span>picture_file<span style="color: #990000">.</span>filepath<span style="color: #990000">)</span> <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> File<span style="color: #990000">.</span>exists?<span style="color: #990000">(</span>picture_file<span style="color: #990000">.</span>filepath<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>When declared inside a class the callback method will receive the model object as a parameter. We can now use it this way:</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> PictureFile <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  after_destroy PictureFileCallbacks<span style="color: #990000">.</span>new

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+</tt></pre></div></div>

+<div class="para"><p>Note that we needed to instantiate a new PictureFileCallbacks object, since we declared our callback as an instance method. Sometimes it will make more sense to have it as a class method.</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> PictureFileCallbacks

+  <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>after_destroy<span style="color: #990000">(</span>picture_file<span style="color: #990000">)</span>

+    File<span style="color: #990000">.</span>delete<span style="color: #990000">(</span>picture_file<span style="color: #990000">.</span>filepath<span style="color: #990000">)</span> <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> File<span style="color: #990000">.</span>exists?<span style="color: #990000">(</span>picture_file<span style="color: #990000">.</span>filepath<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>If the callback method is declared this way, it won't be necessary to instantiate a PictureFileCallbacks object.</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> PictureFile <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  after_destroy PictureFileCallbacks

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+</tt></pre></div></div>

+<div class="para"><p>You can declare as many callbacks as you want inside your callback classes.</p></div>

+</div>

+<h2 id="_changelog">12. Changelog</h2>

 <div class="sectionbody">

 <div class="para"><p><a href="http://rails.lighthouseapp.com/projects/16213/tickets/26-active-record-validations-and-callbacks">http://rails.lighthouseapp.com/projects/16213/tickets/26-active-record-validations-and-callbacks</a></p></div>

 </div>

diff --git a/railties/doc/guides/html/association_basics.html b/railties/doc/guides/html/association_basics.html
index 9159eaab2a..3eea8b421f 100644
--- a/railties/doc/guides/html/association_basics.html
+++ b/railties/doc/guides/html/association_basics.html
@@ -687,8 +687,8 @@ 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> Employee <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

-  has_many <span style="color: #990000">:</span>subordinates<span style="color: #990000">,</span> <span style="color: #990000">:</span>class_name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"User"</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>foreign_key <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"manager_id"</span>

-  belongs_to <span style="color: #990000">:</span>manager<span style="color: #990000">,</span> <span style="color: #990000">:</span>class_name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"User"</span>

+  has_many <span style="color: #990000">:</span>subordinates<span style="color: #990000">,</span> <span style="color: #990000">:</span>class_name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"Employee"</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>foreign_key <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"manager_id"</span>

+  belongs_to <span style="color: #990000">:</span>manager<span style="color: #990000">,</span> <span style="color: #990000">:</span>class_name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"Employee"</span>

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

 <div class="para"><p>With this setup, you can retrieve <tt>@employee.subordinates</tt> and <tt>@employee.manager</tt>.</p></div>

@@ -742,7 +742,9 @@ customer<span style="color: #990000">.</span>orders<span style="color: #990000">
 <h3 id="_avoiding_name_collisions">3.2. Avoiding Name Collisions</h3>

 <div class="para"><p>You are not free to use just any name for your associations. Because creating an association adds a method with that name to the model, it is a bad idea to give an association a name that is already used for an instance method of <tt>ActiveRecord::Base</tt>. The association method would override the base method and break things. For instance, <tt>attributes</tt> or <tt>connection</tt> are bad names for associations.</p></div>

 <h3 id="_updating_the_schema">3.3. Updating the Schema</h3>

-<div class="para"><p>Associations are extremely useful, but they are not magic. You are responsible for maintaining your database schema to match your associations. In practice, this means two things. First, you need to create foreign keys as appropriate:</p></div>

+<div class="para"><p>Associations are extremely useful, but they are not magic. You are responsible for maintaining your database schema to match your associations. In practice, this means two things, depending on what sort of associations you are creating. For <tt>belongs_to</tt> associations you need to create foreign keys, and for <tt>has_and_belongs_to_many</tt> associations you need to create the appropriate join table.</p></div>

+<h4 id="_creating_foreign_keys_for_tt_belongs_to_tt_associations">3.3.1. Creating Foreign Keys for <tt>belongs_to</tt> Associations</h4>

+<div class="para"><p>When you declare a <tt>belongs_to</tt> association, you need to create foreign keys as appropriate. For example, consider this model:</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -773,7 +775,8 @@ http://www.gnu.org/software/src-highlite -->
 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

 <div class="para"><p>If you create an association some time after you build the underlying model, you need to remember to create an <tt>add_column</tt> migration to provide the necessary foreign key.</p></div>

-<div class="para"><p>Second, if you create a <tt>has_and_belongs_to_many</tt> association, you need to explicitly create the joining table. Unless the name of the join table is explicitly specified by using the <tt>:join_table</tt> option, Active Record create the name by using the lexical order of the class names. So a join between customer and order models will give the default join table name of "customers_orders" because "c" outranks "o" in lexical ordering.</p></div>

+<h4 id="_creating_join_tables_for_tt_has_and_belongs_to_many_tt_associations">3.3.2. Creating Join Tables for <tt>has_and_belongs_to_many</tt> Associations</h4>

+<div class="para"><p>If you create a <tt>has_and_belongs_to_many</tt> association, you need to explicitly create the joining table. Unless the name of the join table is explicitly specified by using the <tt>:join_table</tt> option, Active Record create the name by using the lexical order of the class names. So a join between customer and order models will give the default join table name of "customers_orders" because "c" outranks "o" in lexical ordering.</p></div>

 <div class="admonitionblock">

 <table><tr>

 <td class="icon">

@@ -1938,7 +1941,7 @@ http://www.gnu.org/software/src-highlite -->
 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

 <h5 id="_tt_offset_tt"><tt>:offset</tt></h5>

-<div class="para"><p>The <tt>:offset</tt> option lets you specify the starting offset for fetching objects via an association. For example, if you set <tt>:offset &#8658; 11</tt>, it will skip the first 10 records.</p></div>

+<div class="para"><p>The <tt>:offset</tt> option lets you specify the starting offset for fetching objects via an association. For example, if you set <tt>:offset &#8658; 11</tt>, it will skip the first 11 records.</p></div>

 <h5 id="_tt_order_tt_2"><tt>:order</tt></h5>

 <div class="para"><p>The <tt>:order</tt> option dictates the order in which associated objects will be received (in the syntax used by a SQL <tt>ORDER BY</tt> clause).</p></div>

 <div class="listingblock">

@@ -2409,7 +2412,7 @@ http://www.gnu.org/software/src-highlite -->
 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

 <h5 id="_tt_offset_tt_2"><tt>:offset</tt></h5>

-<div class="para"><p>The <tt>:offset</tt> option lets you specify the starting offset for fetching objects via an association. For example, if you set <tt>:offset &#8658; 11</tt>, it will skip the first 10 records.</p></div>

+<div class="para"><p>The <tt>:offset</tt> option lets you specify the starting offset for fetching objects via an association. For example, if you set <tt>:offset &#8658; 11</tt>, it will skip the first 11 records.</p></div>

 <h5 id="_tt_order_tt_3"><tt>:order</tt></h5>

 <div class="para"><p>The <tt>:order</tt> option dictates the order in which associated objects will be received (in the syntax used by a SQL <tt>ORDER BY</tt> clause).</p></div>

 <div class="listingblock">

diff --git a/railties/doc/guides/html/authors.html b/railties/doc/guides/html/authors.html
index a54135b14d..6fd556d2cd 100644
--- a/railties/doc/guides/html/authors.html
+++ b/railties/doc/guides/html/authors.html
@@ -231,6 +231,11 @@ Heiko has rarely looked back.</p></div>
 <div class="para"><p>Tore Darell is an independent developer based in Menton, France who specialises in cruft-free web applications using Ruby, Rails

 and unobtrusive JavaScript. His home on the internet is his blog <a href="http://tore.darell.no/">Sneaky Abstractions</a>.</p></div>

 </div></div>

+<div class="sidebarblock" id="zilkey">

+<div class="sidebar-content">

+<div class="sidebar-title">Jeff Dean</div>

+<div class="para"><p>Jeff Dean is a software engineer with <a href="http://pivotallabs.com/">Pivotal Labs</a>.</p></div>

+</div></div>

 </div>

 </div>

 
diff --git a/railties/doc/guides/html/command_line.html b/railties/doc/guides/html/command_line.html
new file mode 100644
index 0000000000..2add20446e
--- /dev/null
+++ b/railties/doc/guides/html/command_line.html
@@ -0,0 +1,434 @@
+<!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>A Guide to The Rails Command Line</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="#_command_line_basics">Command Line Basics</a>
+						<ul>
+						
+							<li><a href="#_rails">rails</a></li>
+						
+							<li><a href="#_server">server</a></li>
+						
+							<li><a href="#_generate">generate</a></li>
+						
+						</ul>
+					</li>
+			</ol>
+		</div>
+		
+		<div id="content">
+				<h1>A Guide to The Rails Command Line</h1>
+			<div id="preamble">

+<div class="sectionbody">

+<div class="para"><p>Rails comes with every command line tool you'll need to</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+Create a Rails application

+</p>

+</li>

+<li>

+<p>

+Generate models, controllers, database migrations, and unit tests

+</p>

+</li>

+<li>

+<p>

+Start a development server

+</p>

+</li>

+<li>

+<p>

+Mess with objects through an interactive shell

+</p>

+</li>

+<li>

+<p>

+Profile and benchmark your new creation

+</p>

+</li>

+</ul></div>

+<div class="para"><p>&#8230; and much, much more! (Buy now!)</p></div>

+<div class="para"><p>This tutorial assumes you have basic Rails knowledge from reading the Getting Started with Rails Guide.</p></div>

+</div>

+</div>

+<h2 id="_command_line_basics">1. Command Line Basics</h2>

+<div class="sectionbody">

+<div class="para"><p>There are a few commands that are absolutely critical to your everyday usage of Rails. In the order of how much you'll probably use them are:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+console

+</p>

+</li>

+<li>

+<p>

+server

+</p>

+</li>

+<li>

+<p>

+rake

+</p>

+</li>

+<li>

+<p>

+generate

+</p>

+</li>

+<li>

+<p>

+rails

+</p>

+</li>

+</ul></div>

+<div class="para"><p>Let's create a simple Rails application to step through each of these commands in context.</p></div>

+<h3 id="_rails">1.1. rails</h3>

+<div class="para"><p>The first thing we'll want to do is create a new Rails application by running the <tt>rails</tt> command after installing Rails.</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content">You know you need the rails gem installed by typing <tt>gem install rails</tt> first, right? Okay, okay, just making sure.</td>

+</tr></table>

+</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>$ rails commandsapp

+

+     create

+     create  app/controllers

+     create  app/helpers

+     create  app/models

+     <span style="color: #990000">...</span>

+     <span style="color: #990000">...</span>

+     create  log/production<span style="color: #990000">.</span>log

+     create  log/development<span style="color: #990000">.</span>log

+     create  log/test<span style="color: #990000">.</span>log

+</tt></pre></div></div>

+<div class="para"><p>Rails will set you up with what seems like a huge amount of stuff for such a tiny command! You've got the entire Rails directory structure now with all the code you need to run our simple application right out of the box.</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content">This output will seem very familiar when we get to the <tt>generate</tt> command. Creepy foreshadowing!</td>

+</tr></table>

+</div>

+<h3 id="_server">1.2. server</h3>

+<div class="para"><p>Let's try it! The <tt>server</tt> command launches a small web server written in Ruby named WEBrick which was also installed when you installed Rails. You'll use this any time you want to view your work through a web browser.</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content">WEBrick isn't your only option for serving Rails. We'll get to that in a later section. [XXX: which section]</td>

+</tr></table>

+</div>

+<div class="para"><p>Here we'll flex our <tt>server</tt> command, which without any prodding of any kind will run our new shiny Rails app:</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>$ cd commandsapp

+$ <span style="color: #990000">.</span>/script/server

+<span style="color: #990000">=&gt;</span> Booting WEBrick<span style="color: #990000">...</span>

+<span style="color: #990000">=&gt;</span> Rails <span style="color: #993399">2.2</span><span style="color: #990000">.</span><span style="color: #993399">0</span> application started on http<span style="color: #990000">://</span><span style="color: #993399">0.0</span><span style="color: #990000">.</span><span style="color: #993399">0.0</span><span style="color: #990000">:</span><span style="color: #993399">3000</span>

+<span style="color: #990000">=&gt;</span> Ctrl-C to shutdown server<span style="color: #990000">;</span> call with --help <span style="font-weight: bold"><span style="color: #0000FF">for</span></span> options

+<span style="color: #990000">[</span><span style="color: #993399">2008</span>-<span style="color: #993399">11</span>-<span style="color: #993399">04</span> <span style="color: #993399">10</span><span style="color: #990000">:</span><span style="color: #993399">11</span><span style="color: #990000">:</span><span style="color: #993399">38</span><span style="color: #990000">]</span> INFO  WEBrick <span style="color: #993399">1.3</span><span style="color: #990000">.</span><span style="color: #993399">1</span>

+<span style="color: #990000">[</span><span style="color: #993399">2008</span>-<span style="color: #993399">11</span>-<span style="color: #993399">04</span> <span style="color: #993399">10</span><span style="color: #990000">:</span><span style="color: #993399">11</span><span style="color: #990000">:</span><span style="color: #993399">38</span><span style="color: #990000">]</span> INFO  ruby <span style="color: #993399">1.8</span><span style="color: #990000">.</span><span style="color: #993399">5</span> <span style="color: #990000">(</span><span style="color: #993399">2006</span>-<span style="color: #993399">12</span>-<span style="color: #993399">04</span><span style="color: #990000">)</span> <span style="color: #990000">[</span>i486-linux<span style="color: #990000">]</span>

+<span style="color: #990000">[</span><span style="color: #993399">2008</span>-<span style="color: #993399">11</span>-<span style="color: #993399">04</span> <span style="color: #993399">10</span><span style="color: #990000">:</span><span style="color: #993399">11</span><span style="color: #990000">:</span><span style="color: #993399">38</span><span style="color: #990000">]</span> INFO  WEBrick<span style="color: #990000">::</span>HTTPServer<span style="font-style: italic"><span style="color: #9A1900">#start: pid=18994 port=3000</span></span>

+</tt></pre></div></div>

+<div class="para"><p>WHOA. With just three commands we whipped up a Rails server listening on port 3000. Go! Go right now to your browser and go to <a href="http://localhost:3000">http://localhost:3000</a>. I'll wait.</p></div>

+<div class="para"><p>See? Cool! It doesn't do much yet, but we'll change that.</p></div>

+<h3 id="_generate">1.3. generate</h3>

+<div class="para"><p>The <tt>generate</tt> command uses templates to create a whole lot of things. You can always find out what's available by running <tt>generate</tt> by itself. Let's do that:</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>/script/generate

+Usage<span style="color: #990000">:</span> <span style="color: #990000">.</span>/script/generate generator <span style="color: #990000">[</span>options<span style="color: #990000">]</span> <span style="color: #990000">[</span>args<span style="color: #990000">]</span>

+

+<span style="color: #990000">...</span>

+<span style="color: #990000">...</span>

+

+Installed Generators

+  Builtin<span style="color: #990000">:</span> controller<span style="color: #990000">,</span> integration_test<span style="color: #990000">,</span> mailer<span style="color: #990000">,</span> migration<span style="color: #990000">,</span> model<span style="color: #990000">,</span> observer<span style="color: #990000">,</span> performance_test<span style="color: #990000">,</span> plugin<span style="color: #990000">,</span> resource<span style="color: #990000">,</span> scaffold<span style="color: #990000">,</span> session_migration

+

+<span style="color: #990000">...</span>

+<span style="color: #990000">...</span>

+</tt></pre></div></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content">You can install more generators through generator gems, portions of plugins you'll undoubtedly install, and you can even create your own!</td>

+</tr></table>

+</div>

+<div class="para"><p>Using generators will save you a large amount of time by writing <strong>boilerplate code</strong> for you &#8212; necessary for the darn thing to work, but not necessary for you to spend time writing. That's what we have computers for, right?</p></div>

+<div class="para"><p>Let's make our own controller with the controller generator. But what command should we use? Let's ask the generator:</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content">All Rails console utilities have help text. For commands that require a lot of input to run correctly, you can just try the command without any parameters (like <tt>rails</tt> or <tt>./script/generate</tt>). For others, you can try adding <tt>&#8212;help</tt> or <tt>-h</tt> to the end, as in <tt>./script/server &#8212;help</tt>.</td>

+</tr></table>

+</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>/script/generate controller

+Usage<span style="color: #990000">:</span> <span style="color: #990000">.</span>/script/generate controller ControllerName <span style="color: #990000">[</span>options<span style="color: #990000">]</span>

+

+<span style="color: #990000">...</span>

+<span style="color: #990000">...</span>

+

+Example<span style="color: #990000">:</span>

+    `<span style="color: #990000">.</span>/script/generate controller CreditCard open debit credit close`

+

+    Credit card controller with URLs like /credit_card/debit<span style="color: #990000">.</span>

+        Controller<span style="color: #990000">:</span> app/controllers/credit_card_controller<span style="color: #990000">.</span>rb

+        Views<span style="color: #990000">:</span>      app/views/credit_card/debit<span style="color: #990000">.</span>html<span style="color: #990000">.</span>erb <span style="color: #990000">[...]</span>

+        Helper<span style="color: #990000">:</span>     app/helpers/credit_card_helper<span style="color: #990000">.</span>rb

+        Test<span style="color: #990000">:</span>       test/functional/credit_card_controller_test<span style="color: #990000">.</span>rb

+

+Modules Example<span style="color: #990000">:</span>

+    `<span style="color: #990000">.</span>/script/generate controller <span style="color: #FF0000">'admin/credit_card'</span> <span style="font-weight: bold"><span style="color: #0000FF">suspend</span></span> late_fee`

+

+    Credit card admin controller with URLs /admin/credit_card/suspend<span style="color: #990000">.</span>

+        Controller<span style="color: #990000">:</span> app/controllers/admin/credit_card_controller<span style="color: #990000">.</span>rb

+        Views<span style="color: #990000">:</span>      app/views/admin/credit_card/debit<span style="color: #990000">.</span>html<span style="color: #990000">.</span>erb <span style="color: #990000">[...]</span>

+        Helper<span style="color: #990000">:</span>     app/helpers/admin/credit_card_helper<span style="color: #990000">.</span>rb

+        Test<span style="color: #990000">:</span>       test/functional/admin/credit_card_controller_test<span style="color: #990000">.</span>rb

+</tt></pre></div></div>

+<div class="para"><p>Ah, the controller generator is expecting parameters in the form of <tt>generate controller ControllerName action1 action2</tt>. Let's make a <tt>Greetings</tt> controller with an action of <strong>hello</strong>, which will say something nice to us.</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>/script/generate controller Greeting hello

+     exists  app/controllers<span style="color: #990000">/</span>

+     exists  app/helpers<span style="color: #990000">/</span>

+     create  app/views/greeting

+     exists  test/functional<span style="color: #990000">/</span>

+     create  app/controllers/greetings_controller<span style="color: #990000">.</span>rb

+     create  test/functional/greetings_controller_test<span style="color: #990000">.</span>rb

+     create  app/helpers/greetings_helper<span style="color: #990000">.</span>rb

+     create  app/views/greetings/hello<span style="color: #990000">.</span>html<span style="color: #990000">.</span>erb

+</tt></pre></div></div>

+<div class="para"><p>Look there! Now what all did this generate? It looks like it made sure a bunch of directories were in our application, and created a controller file, a functional test file, a helper for the view, and a view file. All from one command!</p></div>

+</div>

+
+		</div>
+	</div>
+</body>
+</html>
diff --git a/railties/doc/guides/html/configuring.html b/railties/doc/guides/html/configuring.html
index 4aa3a0f545..adc827c89a 100644
--- a/railties/doc/guides/html/configuring.html
+++ b/railties/doc/guides/html/configuring.html
@@ -205,6 +205,9 @@ ul#navMain {
 					<a href="#_using_a_preinitializer">Using a Preinitializer</a>
 					</li>
 					<li>
+					<a href="#_initialization_process_settings">Initialization Process Settings</a>
+					</li>
+					<li>
 					<a href="#_configuring_rails_components">Configuring Rails Components</a>
 						<ul>
 						
@@ -220,6 +223,8 @@ ul#navMain {
 						
 							<li><a href="#_configuring_active_support">Configuring Active Support</a></li>
 						
+							<li><a href="#_configuring_active_model">Configuring Active Model</a></li>
+						
 						</ul>
 					</li>
 					<li>
@@ -229,6 +234,9 @@ ul#navMain {
 					<a href="#_using_an_after_initializer">Using an After-Initializer</a>
 					</li>
 					<li>
+					<a href="#_rails_environment_settings">Rails Environment Settings</a>
+					</li>
+					<li>
 					<a href="#_changelog">Changelog</a>
 					</li>
 			</ol>
@@ -264,26 +272,156 @@ after-initializer</p></div>
 <h2 id="_using_a_preinitializer">2. Using a Preinitializer</h2>

 <div class="sectionbody">

 </div>

-<h2 id="_configuring_rails_components">3. Configuring Rails Components</h2>

+<h2 id="_initialization_process_settings">3. Initialization Process Settings</h2>

 <div class="sectionbody">

-<h3 id="_configuring_active_record">3.1. Configuring Active Record</h3>

-<h3 id="_configuring_action_controller">3.2. Configuring Action Controller</h3>

-<h3 id="_configuring_action_view">3.3. Configuring Action View</h3>

-<h3 id="_configuring_action_mailer">3.4. Configuring Action Mailer</h3>

-<h3 id="_configuring_active_resource">3.5. Configuring Active Resource</h3>

-<h3 id="_configuring_active_support">3.6. Configuring Active Support</h3>

 </div>

-<h2 id="_using_initializers">4. Using Initializers</h2>

+<h2 id="_configuring_rails_components">4. Configuring Rails Components</h2>

+<div class="sectionbody">

+<h3 id="_configuring_active_record">4.1. Configuring Active Record</h3>

+<div class="para"><p><tt>ActiveRecord::Base</tt> includej a variety of configuration options:</p></div>

+<div class="para"><p><tt>logger</tt> accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then passed on to any new database connections made. You can retrieve this logger by calling <tt>logger</tt> on either an ActiveRecord model class or an ActiveRecord model instance. Set to nil to disable logging.</p></div>

+<div class="para"><p><tt>primary_key_prefix_type</tt> lets you adjust the naming for primary key columns. By default, Rails assumes that primary key columns are named <tt>id</tt> (and this configuration option doesn't need to be set.) There are two other choices:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+<tt>:table_name</tt> would make the primary key for the Customer class <tt>customerid</tt>

+</p>

+</li>

+<li>

+<p>

+<tt>:table_name_with_underscore</tt> would make the primary key for the Customer class <tt>customer_id</tt>

+</p>

+</li>

+</ul></div>

+<div class="para"><p><tt>table_name_prefix</tt> lets you set a global string to be prepended to table names. If you set this to <tt>northwest_</tt>, then the Customer class will look for <tt>northwest_customers</tt> as its table. The default is an empty string.</p></div>

+<div class="para"><p><tt>table_name_suffix</tt> lets you set a global string to be appended to table names. If you set this to <tt>_northwest</tt>, then the Customer class will look for <tt>customers_northwest</tt> as its table. The default is an empty string.</p></div>

+<div class="para"><p><tt>pluralize_table_names</tt> specifies whether Rails will look for singular or plural table names in the database. If set to <tt>true</tt> (the default), then the Customer class will use the <tt>customers</tt> table. If set to <tt>false</tt>, then the Customers class will use the <tt>customer</tt> table.</p></div>

+<div class="para"><p><tt>colorize_logging</tt> (true by default) specifies whether or not to use ANSI color codes when logging information from ActiveRecord.</p></div>

+<div class="para"><p><tt>default_timezone</tt> determines whether to use <tt>Time.local</tt> (if set to <tt>:local</tt>) or <tt>Time.utc</tt> (if set to <tt>:utc</tt>) when pulling dates and times from the database. The default is <tt>:local</tt>.</p></div>

+<div class="para"><p><tt>schema_format</tt> controls the format for dumping the database schema to a file. The options are <tt>:ruby</tt> (the default) for a database-independent version that depends on migrations, or <tt>:sql</tt> for a set of (potentially database-dependent) SQL statements.</p></div>

+<div class="para"><p><tt>timestamped_migrations</tt> controls whether migrations are numbered with serial integers or with timestamps. The default is <tt>true</tt>, to use timestamps, which are preferred if there are multiple developers working on the same application.</p></div>

+<div class="para"><p><tt>lock_optimistically</tt> controls whether ActiveRecord will use optimistic locking. By default this is <tt>true</tt>.</p></div>

+<div class="para"><p>The MySQL adapter adds one additional configuration option:</p></div>

+<div class="para"><p><tt>ActiveRecord::ConnectionAdapters::MysqlAdapter.emulate_booleans</tt> controls whether ActiveRecord will consider all <tt>tinyint(1)</tt> columns in a MySQL database to be booleans. By default this is <tt>true</tt>.</p></div>

+<div class="para"><p>The schema dumper adds one additional configuration option:</p></div>

+<div class="para"><p><tt>ActiveRecord::SchemaDumper.ignore_tables</tt> accepts an array of tables that should <em>not</em> be included in any generated schema file. This setting is ignored unless <tt>ActiveRecord::Base.schema_format == :ruby</tt>.</p></div>

+<h3 id="_configuring_action_controller">4.2. Configuring Action Controller</h3>

+<div class="para"><p>ActionController::Base includes a number of configuration settings:</p></div>

+<div class="para"><p><tt>asset_host</tt> provides a string that is prepended to all of the URL-generating helpers in <tt>AssetHelper</tt>. This is designed to allow moving all javascript, CSS, and image files to a separate asset host.</p></div>

+<div class="para"><p><tt>consider_all_requests_local</tt> is generally set to <tt>true</tt> during development and <tt>false</tt> during production; if it is set to <tt>true</tt>, then any error will cause detailed debugging information to be dumped in the HTTP response. For finer-grained control, set this to <tt>false</tt> and implement <tt>local_request?</tt> to specify which requests should provide debugging information on errors.</p></div>

+<div class="para"><p><tt>allow_concurrency</tt> should be set to <tt>true</tt> to allow concurrent (threadsafe) action processing. Set to <tt>false</tt> by default.</p></div>

+<div class="para"><p><tt>param_parsers</tt> provides an array of handlers that can extract information from incoming HTTP requests and add it to the <tt>params</tt> hash. By default, parsers for multipart forms, URL-encoded forms, XML, and JSON are active.</p></div>

+<div class="para"><p><tt>default_charset</tt> specifies the default character set for all renders. The default is "utf-8".</p></div>

+<div class="para"><p><tt>logger</tt> accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then used to log information from Action Controller. Set to nil to disable logging.</p></div>

+<div class="para"><p><tt>resource_action_separator</tt> gives the token to be used between resources and actions when building or interpreting RESTful URLs. By default, this is "/".</p></div>

+<div class="para"><p><tt>resource_path_names</tt> is a hash of default names for several RESTful actions. By default, the new action is named <tt>new</tt> and the edit action is named <tt>edit</tt>.</p></div>

+<div class="para"><p><tt>request_forgery_protection_token</tt> sets the token parameter name for RequestForgery. Calling <tt>protect_from_forgery</tt> sets it to <tt>:authenticity_token</tt> by default.</p></div>

+<div class="para"><p><tt>optimise_named_routes</tt> turns on some optimizations in generating the routing table. It is set to <tt>true</tt> by default.</p></div>

+<div class="para"><p><tt>use_accept_header</tt> sets the rules for determining the response format. If this is set to <tt>true</tt> (the default) then <tt>respond_to</tt> and <tt>Request#format</tt> will take the Accept header into account. If it is set to false then the request format will be determined solely by examining <tt>params[:format]</tt>. If there is no <tt>format</tt> parameter, then the response format will be either HTML or Javascript depending on whether the request is an AJAX request.</p></div>

+<div class="para"><p><tt>allow_forgery_protection</tt> enables or disables CSRF protection. By default this is <tt>false</tt> in test mode and <tt>true</tt> in all other modes.</p></div>

+<div class="para"><p><tt>relative_url_root</tt> can be used to tell Rails that you are deploying to a subdirectory. The default is <tt>ENV[<em>RAILS_RELATIVE_URL_ROOT</em>]</tt>.</p></div>

+<div class="para"><p>The caching code adds two additional settings:</p></div>

+<div class="para"><p><tt>ActionController::Caching::Pages.page_cache_directory</tt> sets the directory where Rails will create cached pages for your web server. The default is <tt>Rails.public_path</tt> (which is usually set to <tt>RAILS_ROOT </tt> "/public"+).</p></div>

+<div class="para"><p><tt>ActionController::Caching::Pages.page_cache_extension</tt> sets the extension to be used when generating pages for the cache (this is ignored if the incoming request already has an extension). The default is <tt>.html</tt>.</p></div>

+<div class="para"><p>The dispatcher includes one setting:</p></div>

+<div class="para"><p><tt>ActionController::Dispatcher.error_file_path</tt> gives the path where Rails will look for error files such as <tt>404.html</tt>. The default is <tt>Rails.public_path</tt>.</p></div>

+<div class="para"><p>The Active Record session store can also be configured:</p></div>

+<div class="para"><p><tt>CGI::Session::ActiveRecordStore::Session.data_column_name</tt> sets the name of the column to use to store session data. By default it is <em>data</em></p></div>

+<h3 id="_configuring_action_view">4.3. Configuring Action View</h3>

+<div class="para"><p>There are only a few configuration options for Action View, starting with four on <tt>ActionView::Base</tt>:</p></div>

+<div class="para"><p><tt>debug_rjs</tt> specifies whether RJS responses should be wrapped in a try/catch block that alert()s the caught exception (and then re-raises it). The default is <tt>false</tt>.</p></div>

+<div class="para"><p><tt>warn_cache_misses</tt> tells Rails to display a warning whenever an action results in a cache miss on your view paths. The default is <tt>false</tt>.</p></div>

+<div class="para"><p></p></div>

+<div class="para"><p><tt>default_form_builder</tt> tells Rails which form builder to use by default. The default is <tt>ActionView::Helpers::FormBuilder</tt>.</p></div>

+<div class="para"><p>The ERB template handler supplies one additional option:</p></div>

+<div class="para"><p><tt>ActionView::TemplateHandlers::ERB.erb_trim_mode</tt> gives the trim mode to be used by ERB. It defaults to <tt><em>-</em></tt>. See the <a href="http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/">ERB documentation</a> for more information.</p></div>

+<h3 id="_configuring_action_mailer">4.4. Configuring Action Mailer</h3>

+<div class="para"><p>There are a number of settings available on <tt>ActionMailer::Base</tt>:</p></div>

+<div class="para"><p><tt>template_root</tt> gives the root folder for Action Mailer templates.</p></div>

+<div class="para"><p><tt>logger</tt> accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then used to log information from Action Mailer. Set to nil to disable logging.</p></div>

+<div class="para"><p><tt>smtp_settings</tt> allows detailed configuration for the <tt>:smtp</tt> delivery method. It accepts a hash of options, which can include any of these options:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+&lt;tt&gt;:address&lt;/tt&gt; - Allows you to use a remote mail server. Just change it from its default "localhost" setting.

+</p>

+</li>

+<li>

+<p>

+&lt;tt&gt;:port&lt;/tt&gt; - On the off chance that your mail server doesn't run on port 25, you can change it.

+</p>

+</li>

+<li>

+<p>

+&lt;tt&gt;:domain&lt;/tt&gt; - If you need to specify a HELO domain, you can do it here.

+</p>

+</li>

+<li>

+<p>

+&lt;tt&gt;:user_name&lt;/tt&gt; - If your mail server requires authentication, set the username in this setting.

+</p>

+</li>

+<li>

+<p>

+&lt;tt&gt;:password&lt;/tt&gt; - If your mail server requires authentication, set the password in this setting.

+</p>

+</li>

+<li>

+<p>

+&lt;tt&gt;:authentication&lt;/tt&gt; - If your mail server requires authentication, you need to specify the authentication type here. This is a symbol and one of &lt;tt&gt;:plain&lt;/tt&gt;, &lt;tt&gt;:login&lt;/tt&gt;, &lt;tt&gt;:cram_md5&lt;/tt&gt;.

+</p>

+</li>

+</ul></div>

+<div class="para"><p><tt>sendmail_settings</tt> allows detailed configuration for the <tt>sendmail</tt> delivery method. It accepts a hash of options, which can include any of these options:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+&lt;tt&gt;:location&lt;/tt&gt; - The location of the sendmail executable. Defaults to &lt;tt&gt;/usr/sbin/sendmail&lt;/tt&gt;.

+</p>

+</li>

+<li>

+<p>

+&lt;tt&gt;:arguments&lt;/tt&gt; - The command line arguments. Defaults to &lt;tt&gt;-i -t&lt;/tt&gt;.

+</p>

+</li>

+</ul></div>

+<div class="para"><p><tt>raise_delivery_errors</tt> specifies whether to raise an error if email delivery cannot be completed. It defaults to <tt>true</tt>.</p></div>

+<div class="para"><p><tt>delivery_method</tt> defines the delivery method. The allowed values are &lt;tt&gt;:smtp&lt;/tt&gt; (default), &lt;tt&gt;:sendmail&lt;/tt&gt;, and &lt;tt&gt;:test&lt;/tt&gt;.</p></div>

+<div class="para"><p><tt>perform_deliveries</tt> specifies whether mail will actually be delivered. By default this is <tt>true</tt>; it can be convenient to set it to <tt>false</tt> for testing.</p></div>

+<div class="para"><p><tt>default_charset</tt> tells Action Mailer which character set to use for the body and for encoding the subject. It defaults to <tt>utf-8</tt>.</p></div>

+<div class="para"><p><tt>default_content_type</tt> specifies the default content type used for the main part of the message. It defaults to "text/plain"</p></div>

+<div class="para"><p><tt>default_mime_version</tt> is the default MIME version for the message. It defaults to <tt>1.0</tt>.</p></div>

+<div class="para"><p><tt>default_implicit_parts_order</tt> - When a message is built implicitly (i.e. multiple parts are assembled from templates

+which specify the content type in their filenames) this variable controls how the parts are ordered. Defaults to

+&lt;tt&gt;["text/html", "text/enriched", "text/plain"]&lt;/tt&gt;. Items that appear first in the array have higher priority in the mail client

+and appear last in the mime encoded message.</p></div>

+<h3 id="_configuring_active_resource">4.5. Configuring Active Resource</h3>

+<div class="para"><p>There is a single configuration setting available on <tt>ActiveResource::Base</tt>:</p></div>

+<div class="para"><p><tt>logger</tt> accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then used to log information from Active Resource. Set to nil to disable logging.</p></div>

+<h3 id="_configuring_active_support">4.6. Configuring Active Support</h3>

+<div class="para"><p>There are a few configuration options available in Active Support:</p></div>

+<div class="para"><p><tt>ActiveSupport::BufferedLogger.silencer</tt> is set to <tt>false</tt> to disable the ability to silence logging in a block. The default is <tt>true</tt>.</p></div>

+<div class="para"><p><tt>ActiveSupport::Cache::Store.logger</tt> specifies the logger to use within cache store operations.</p></div>

+<div class="para"><p><tt>ActiveSupport::Logger.silencer</tt> is set to <tt>false</tt> to disable the ability to silence logging in a block. The default is <tt>true</tt>.</p></div>

+<h3 id="_configuring_active_model">4.7. Configuring Active Model</h3>

+<div class="para"><p>Active Model currently has a single configuration setting:</p></div>

+<div class="para"><p>+ActiveModel::Errors.default_error_messages is an array containing all of the validation error messages.</p></div>

+</div>

+<h2 id="_using_initializers">5. Using Initializers</h2>

 <div class="sectionbody">

 <div class="literalblock">

 <div class="content">

 <pre><tt>organization, controlling load order</tt></pre>

 </div></div>

 </div>

-<h2 id="_using_an_after_initializer">5. Using an After-Initializer</h2>

+<h2 id="_using_an_after_initializer">6. Using an After-Initializer</h2>

 <div class="sectionbody">

 </div>

-<h2 id="_changelog">6. Changelog</h2>

+<h2 id="_rails_environment_settings">7. Rails Environment Settings</h2>

+<div class="sectionbody">

+<div class="para"><p>ENV</p></div>

+</div>

+<h2 id="_changelog">8. Changelog</h2>

 <div class="sectionbody">

 <div class="para"><p><a href="http://rails.lighthouseapp.com/projects/16213-rails-guides/tickets/28">Lighthouse ticket</a></p></div>

 <div class="ilist"><ul>

@@ -291,145 +429,15 @@ after-initializer</p></div>
 <p>

 November 5, 2008: Rough outline by <a href="../authors.html#mgunderloy">Mike Gunderloy</a>

 </p>

+<div class="qlist"><ol>

+<li>

+<p><em>

+need to look for def self. ?

+</em></p>

+</li>

+</ol></div>

 </li>

 </ul></div>

-<div class="para"><p>actionmailer/lib/action_mailer/base.rb

-257:    cattr_accessor :logger

-267:    cattr_accessor :smtp_settings

-273:    cattr_accessor :sendmail_settings

-276:    cattr_accessor :raise_delivery_errors

-282:    cattr_accessor :perform_deliveries

-285:    cattr_accessor :deliveries

-288:    cattr_accessor :default_charset

-291:    cattr_accessor :default_content_type

-294:    cattr_accessor :default_mime_version

-297:    cattr_accessor :default_implicit_parts_order

-299:    cattr_reader :protected_instance_variables</p></div>

-<div class="para"><p>actionmailer/Rakefile

-36:  rdoc.options &lt;&lt; <em>&#8212;line-numbers</em> &lt;&lt; <em>&#8212;inline-source</em> &lt;&lt; <em>-A cattr_accessor=object</em></p></div>

-<div class="para"><p>actionpack/lib/action_controller/base.rb

-263:    cattr_reader :protected_instance_variables

-273:    cattr_accessor :asset_host

-279:    cattr_accessor :consider_all_requests_local

-285:    cattr_accessor :allow_concurrency

-317:    cattr_accessor :param_parsers

-321:    cattr_accessor :default_charset

-325:    cattr_accessor :logger

-329:    cattr_accessor :resource_action_separator

-333:    cattr_accessor :resources_path_names

-337:    cattr_accessor :request_forgery_protection_token

-341:    cattr_accessor :optimise_named_routes

-351:    cattr_accessor :use_accept_header

-361:    cattr_accessor :relative_url_root</p></div>

-<div class="para"><p>actionpack/lib/action_controller/caching/pages.rb

-55:          cattr_accessor :page_cache_directory

-58:          cattr_accessor :page_cache_extension</p></div>

-<div class="para"><p>actionpack/lib/action_controller/caching.rb

-37:        cattr_reader :cache_store

-48:        cattr_accessor :perform_caching</p></div>

-<div class="para"><p>actionpack/lib/action_controller/dispatcher.rb

-98:    cattr_accessor :error_file_path</p></div>

-<div class="para"><p>actionpack/lib/action_controller/mime_type.rb

-24:    cattr_reader :html_types, :unverifiable_types</p></div>

-<div class="para"><p>actionpack/lib/action_controller/rescue.rb

-36:      base.cattr_accessor :rescue_responses

-40:      base.cattr_accessor :rescue_templates</p></div>

-<div class="para"><p>actionpack/lib/action_controller/session/active_record_store.rb

-60:        cattr_accessor :data_column_name

-170:        cattr_accessor :connection

-173:        cattr_accessor :table_name

-177:        cattr_accessor :session_id_column

-181:        cattr_accessor :data_column

-282:      cattr_accessor :session_class</p></div>

-<div class="para"><p>actionpack/lib/action_controller/vendor/html-scanner/html/sanitizer.rb

-44:    cattr_accessor :included_tags, :instance_writer &#8658; false</p></div>

-<div class="para"><p>actionpack/lib/action_view/base.rb

-189:    cattr_accessor :debug_rjs

-193:    cattr_accessor :warn_cache_misses</p></div>

-<div class="para"><p>actionpack/lib/action_view/helpers/active_record_helper.rb

-7:    cattr_accessor :field_error_proc</p></div>

-<div class="para"><p>actionpack/lib/action_view/helpers/form_helper.rb

-805:    cattr_accessor :default_form_builder</p></div>

-<div class="para"><p>actionpack/lib/action_view/template_handlers/erb.rb

-47:      cattr_accessor :erb_trim_mode</p></div>

-<div class="para"><p>actionpack/test/active_record_unit.rb

-5:  cattr_accessor :able_to_connect

-6:  cattr_accessor :connected</p></div>

-<div class="para"><p>actionpack/test/controller/filters_test.rb

-286:    cattr_accessor :execution_log</p></div>

-<div class="para"><p>actionpack/test/template/form_options_helper_test.rb

-3:TZInfo::Timezone.cattr_reader :loaded_zones</p></div>

-<div class="para"><p>activemodel/lib/active_model/errors.rb

-28:    cattr_accessor :default_error_messages</p></div>

-<div class="para"><p>activemodel/Rakefile

-19:  rdoc.options &lt;&lt; <em>&#8212;line-numbers</em> &lt;&lt; <em>&#8212;inline-source</em> &lt;&lt; <em>-A cattr_accessor=object</em></p></div>

-<div class="para"><p>activerecord/lib/active_record/attribute_methods.rb

-9:      base.cattr_accessor :attribute_types_cached_by_default, :instance_writer &#8658; false

-11:      base.cattr_accessor :time_zone_aware_attributes, :instance_writer &#8658; false</p></div>

-<div class="para"><p>activerecord/lib/active_record/base.rb

-394:    cattr_accessor :logger, :instance_writer &#8658; false

-443:    cattr_accessor :configurations, :instance_writer &#8658; false

-450:    cattr_accessor :primary_key_prefix_type, :instance_writer &#8658; false

-456:    cattr_accessor :table_name_prefix, :instance_writer &#8658; false

-461:    cattr_accessor :table_name_suffix, :instance_writer &#8658; false

-467:    cattr_accessor :pluralize_table_names, :instance_writer &#8658; false

-473:    cattr_accessor :colorize_logging, :instance_writer &#8658; false

-478:    cattr_accessor :default_timezone, :instance_writer &#8658; false

-487:    cattr_accessor :schema_format , :instance_writer &#8658; false

-491:    cattr_accessor :timestamped_migrations , :instance_writer &#8658; false</p></div>

-<div class="para"><p>activerecord/lib/active_record/connection_adapters/abstract/connection_specification.rb

-11:    cattr_accessor :connection_handler, :instance_writer &#8658; false</p></div>

-<div class="para"><p>activerecord/lib/active_record/connection_adapters/mysql_adapter.rb

-166:      cattr_accessor :emulate_booleans</p></div>

-<div class="para"><p>activerecord/lib/active_record/fixtures.rb

-498:  cattr_accessor :all_loaded_fixtures</p></div>

-<div class="para"><p>activerecord/lib/active_record/locking/optimistic.rb

-38:        base.cattr_accessor :lock_optimistically, :instance_writer &#8658; false</p></div>

-<div class="para"><p>activerecord/lib/active_record/migration.rb

-259:    cattr_accessor :verbose</p></div>

-<div class="para"><p>activerecord/lib/active_record/schema_dumper.rb

-13:    cattr_accessor :ignore_tables</p></div>

-<div class="para"><p>activerecord/lib/active_record/serializers/json_serializer.rb

-4:      base.cattr_accessor :include_root_in_json, :instance_writer &#8658; false</p></div>

-<div class="para"><p>activerecord/Rakefile

-142:  rdoc.options &lt;&lt; <em>&#8212;line-numbers</em> &lt;&lt; <em>&#8212;inline-source</em> &lt;&lt; <em>-A cattr_accessor=object</em></p></div>

-<div class="para"><p>activerecord/test/cases/lifecycle_test.rb

-61:  cattr_reader :last_inherited</p></div>

-<div class="para"><p>activerecord/test/cases/mixin_test.rb

-9:  cattr_accessor :forced_now_time</p></div>

-<div class="para"><p>activeresource/lib/active_resource/base.rb

-206:    cattr_accessor :logger</p></div>

-<div class="para"><p>activeresource/Rakefile

-43:  rdoc.options &lt;&lt; <em>&#8212;line-numbers</em> &lt;&lt; <em>&#8212;inline-source</em> &lt;&lt; <em>-A cattr_accessor=object</em></p></div>

-<div class="para"><p>activesupport/lib/active_support/buffered_logger.rb

-17:    cattr_accessor :silencer</p></div>

-<div class="para"><p>activesupport/lib/active_support/cache.rb

-81:      cattr_accessor :logger</p></div>

-<div class="para"><p>activesupport/lib/active_support/core_ext/class/attribute_accessors.rb

-5:#    cattr_accessor :hair_colors

-10:  def cattr_reader(*syms)

-29:  def cattr_writer(*syms)

-50:  def cattr_accessor(*syms)

-51:    cattr_reader(*syms)

-52:    cattr_writer(*syms)</p></div>

-<div class="para"><p>activesupport/lib/active_support/core_ext/logger.rb

-34:  cattr_accessor :silencer</p></div>

-<div class="para"><p>activesupport/test/core_ext/class/attribute_accessor_test.rb

-6:      cattr_accessor :foo

-7:      cattr_accessor :bar, :instance_writer &#8658; false</p></div>

-<div class="para"><p>activesupport/test/core_ext/module/synchronization_test.rb

-6:    @target.cattr_accessor :mutex, :instance_writer &#8658; false</p></div>

-<div class="para"><p>railties/doc/guides/html/creating_plugins.html

-786:      cattr_accessor &lt;span style="color: #990000"&gt;:&lt;/span&gt;yaffle_text_field&lt;span style="color: #990000"&gt;,&lt;/span&gt; &lt;span style="color: #990000"&gt;:&lt;/span&gt;yaffle_date_field

-860:      cattr_accessor &lt;span style="color: #990000"&gt;:&lt;/span&gt;yaffle_text_field&lt;span style="color: #990000"&gt;,&lt;/span&gt; &lt;span style="color: #990000"&gt;:&lt;/span&gt;yaffle_date_field</p></div>

-<div class="para"><p>railties/lib/rails_generator/base.rb

-93:      cattr_accessor :logger</p></div>

-<div class="para"><p>railties/Rakefile

-265:  rdoc.options &lt;&lt; <em>&#8212;line-numbers</em> &lt;&lt; <em>&#8212;inline-source</em> &lt;&lt; <em>&#8212;accessor</em> &lt;&lt; <em>cattr_accessor=object</em></p></div>

-<div class="para"><p>railties/test/rails_info_controller_test.rb

-12:    cattr_accessor :local_request</p></div>

-<div class="para"><p>Rakefile

-32:  rdoc.options &lt;&lt; <em>-A cattr_accessor=object</em></p></div>

 </div>

 
 		</div>
diff --git a/railties/doc/guides/html/creating_plugins.html b/railties/doc/guides/html/creating_plugins.html
index 48d5f03687..850822c8ed 100644
--- a/railties/doc/guides/html/creating_plugins.html
+++ b/railties/doc/guides/html/creating_plugins.html
@@ -199,61 +199,99 @@ ul#navMain {
 			<h2>Chapters</h2>
 			<ol>
 					<li>
-					<a href="#_preparation">Preparation</a>
+					<a href="#_setup">Setup</a>
 						<ul>
 						
 							<li><a href="#_create_the_basic_app">Create the basic app</a></li>
 						
-							<li><a href="#_create_the_plugin">Create the plugin</a></li>
+							<li><a href="#_generate_the_plugin_skeleton">Generate the plugin skeleton</a></li>
 						
-							<li><a href="#_setup_the_plugin_for_testing">Setup the plugin for testing</a></li>
+							<li><a href="#_organize_your_files">Organize your files</a></li>
 						
 						</ul>
 					</li>
 					<li>
-					<a href="#_add_a_tt_to_squawk_tt_method_to_string">Add a <tt>to_squawk</tt> method to String</a>
+					<a href="#_tests">Tests</a>
+						<ul>
+						
+							<li><a href="#_test_setup">Test Setup</a></li>
+						
+							<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="#_working_with_init_rb">Working with init.rb</a></li>
+						
+						</ul>
 					</li>
 					<li>
-					<a href="#_add_an_tt_acts_as_yaffle_tt_method_to_activerecord">Add an <tt>acts_as_yaffle</tt> method to ActiveRecord</a>
+					<a href="#_add_an_em_acts_as_em_method_to_active_record">Add an <em>acts_as</em> 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>
+						
+						</ul>
 					</li>
 					<li>
-					<a href="#_create_a_tt_squawk_info_for_tt_view_helper">Create a <tt>squawk_info_for</tt> view helper</a>
+					<a href="#_models">Models</a>
 					</li>
 					<li>
-					<a href="#_create_a_migration_generator">Create a migration generator</a>
+					<a href="#_controllers">Controllers</a>
 					</li>
 					<li>
-					<a href="#_add_a_custom_generator_command">Add a custom generator command</a>
+					<a href="#_helpers">Helpers</a>
 					</li>
 					<li>
-					<a href="#_add_a_custom_route">Add a Custom Route</a>
+					<a href="#_routes">Routes</a>
 					</li>
 					<li>
-					<a href="#_odds_and_ends">Odds and ends</a>
+					<a href="#_generators">Generators</a>
 						<ul>
 						
-							<li><a href="#_work_with_init_rb">Work with init.rb</a></li>
-						
-							<li><a href="#_generate_rdoc_documentation">Generate RDoc Documentation</a></li>
+							<li><a href="#_testing_generators">Testing generators</a></li>
 						
-							<li><a href="#_store_models_views_helpers_and_controllers_in_your_plugins">Store models, views, helpers, and controllers in your plugins</a></li>
+							<li><a href="#_the_usage_file">The USAGE file</a></li>
 						
-							<li><a href="#_write_custom_rake_tasks_in_your_plugin">Write custom Rake tasks in your plugin</a></li>
+						</ul>
+					</li>
+					<li>
+					<a href="#_generator_commands">Generator Commands</a>
+					</li>
+					<li>
+					<a href="#_migrations">Migrations</a>
+						<ul>
 						
-							<li><a href="#_store_plugins_in_alternate_locations">Store plugins in alternate locations</a></li>
+							<li><a href="#_create_a_custom_rake_task">Create a custom rake task</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="#_call_migrations_directly">Call migrations directly</a></li>
 						
-							<li><a href="#_use_custom_plugin_generators">Use Custom Plugin Generators</a></li>
+							<li><a href="#_generate_migrations">Generate migrations</a></li>
 						
 						</ul>
 					</li>
 					<li>
+					<a href="#_rake_tasks">Rake tasks</a>
+					</li>
+					<li>
+					<a href="#_plugingems">PluginGems</a>
+					</li>
+					<li>
+					<a href="#_rdoc_documentation">RDoc Documentation</a>
+					</li>
+					<li>
 					<a href="#_appendix">Appendix</a>
 						<ul>
 						
 							<li><a href="#_references">References</a></li>
 						
+							<li><a href="#_contents_of_em_lib_yaffle_rb_em">Contents of <em>lib/yaffle.rb</em></a></li>
+						
 							<li><a href="#_final_plugin_directory_structure">Final plugin directory structure</a></li>
 						
 						</ul>
@@ -265,123 +303,107 @@ ul#navMain {
 				<h1>The Basics of Creating Rails Plugins</h1>
 			<div id="preamble">

 <div class="sectionbody">

-<div class="para"><p>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.</p></div>

-<div class="para"><p>In this tutorial you will learn how to create a plugin that includes:</p></div>

+<div class="para"><p>A Rails plugin is either an extension or a modification of the core framework. Plugins provide:</p></div>

 <div class="ilist"><ul>

 <li>

 <p>

-Core Extensions - extending String with a <tt>to_squawk</tt> method:

+a way for developers to share bleeding-edge ideas without hurting the stable code base

 </p>

-<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-style: italic"><span style="color: #9A1900"># Anywhere</span></span>

-<span style="color: #FF0000">"hello!"</span><span style="color: #990000">.</span>to_squawk <span style="font-style: italic"><span style="color: #9A1900"># =&gt; "squawk! hello!"</span></span>

-</tt></pre></div></div>

 </li>

 <li>

 <p>

-An <tt>acts_as_yaffle</tt> method for ActiveRecord models that adds a <tt>squawk</tt> method:

+a segmented architecture so that units of code can be fixed or updated on their own release schedule

 </p>

-<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> Hickwall <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

-  acts_as_yaffle <span style="color: #990000">:</span>yaffle_text_field <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>last_sang_at

-<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

-

-Hickwall<span style="color: #990000">.</span>new<span style="color: #990000">.</span>squawk<span style="color: #990000">(</span><span style="color: #FF0000">"Hello World"</span><span style="color: #990000">)</span>

-</tt></pre></div></div>

 </li>

 <li>

 <p>

-A view helper that will print out squawking info:

+an outlet for the core developers so that they don’t have to include every cool new feature under the sun

 </p>

-<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>squawk_info_for<span style="color: #990000">(</span><span style="color: #009900">@hickwall</span><span style="color: #990000">)</span>

-</tt></pre></div></div>

 </li>

+</ul></div>

+<div class="para"><p>After reading this guide you should be familiar with:</p></div>

+<div class="ilist"><ul>

 <li>

 <p>

-A generator that creates a migration to add squawk columns to a model:

+Creating a plugin from scratch

 </p>

-<div class="listingblock">

-<div class="content">

-<pre><tt>script/generate yaffle hickwall</tt></pre>

-</div></div>

 </li>

 <li>

 <p>

-A custom generator command:

+Writing and running tests for the plugin

 </p>

-<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">&lt;</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>

-</tt></pre></div></div>

 </li>

 <li>

 <p>

-A custom route method:

+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>

 </p>

-<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>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>

-</tt></pre></div></div>

 </li>

 </ul></div>

-<div class="para"><p>In addition you'll learn how to:</p></div>

+<div class="para"><p>This guide describes how to build a test-driven plugin that will:</p></div>

 <div class="ilist"><ul>

 <li>

 <p>

-test your plugins.

+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>

-work with <em>init.rb</em>, how to store model, views, controllers, helpers and even other plugins in your plugins.

+Add a view helper that can be used in erb templates

 </p>

 </li>

 <li>

 <p>

-create documentation for your plugin.

+Add a new generator that will generate a migration

 </p>

 </li>

 <li>

 <p>

-write custom Rake tasks in your plugin.

+Add a custom generator command

+</p>

+</li>

+<li>

+<p>

+A custom route method that can be used in routes.rb

 </p>

 </li>

 </ul></div>

+<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>

 </div>

 </div>

-<h2 id="_preparation">1. Preparation</h2>

+<h2 id="_setup">1. Setup</h2>

 <div class="sectionbody">

 <h3 id="_create_the_basic_app">1.1. Create the basic app</h3>

-<div class="para"><p>In this tutorial we will create a basic rails application with 1 resource: bird.  Start out by building the basic rails app:</p></div>

+<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>

 <div class="listingblock">

 <div class="content">

-<pre><tt>rails plugin_demo

-cd plugin_demo

+<pre><tt>gem install rails

+rails yaffle_guide

+cd yaffle_guide

 script/generate scaffold bird name:string

 rake db:migrate

 script/server</tt></pre>

@@ -392,22 +414,24 @@ script/server</tt></pre>
 <td class="icon">

 <img src="./images/icons/note.png" alt="Note" />

 </td>

-<td class="content">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>

+<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>

 </tr></table>

 </div>

-<h3 id="_create_the_plugin">1.2. Create the plugin</h3>

-<div class="para"><p>The built-in Rails plugin generator stubs out a new plugin. 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>

+<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>

 <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">

-<pre><tt>./script/generate plugin BrowserFilters

-./script/generate plugin BrowserFilters --with-generator</tt></pre>

+<pre><tt>./script/generate plugin yaffle

+./script/generate plugin yaffle --with-generator</tt></pre>

 </div></div>

-<div class="para"><p>Later in the plugin we will create a generator, so go ahead and add the <tt>--with-generator</tt> option now:</p></div>

+<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>

 <div class="listingblock">

 <div class="content">

-<pre><tt>script/generate plugin yaffle --with-generator</tt></pre>

+<pre><tt>./script/generate plugin yaffle --with-generator</tt></pre>

 </div></div>

 <div class="para"><p>You should see the following output:</p></div>

 <div class="listingblock">

@@ -430,51 +454,58 @@ 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>

-<div class="para"><p>For this plugin you won't need the file <em>vendor/plugins/yaffle/lib/yaffle.rb</em> so you can delete that.</p></div>

+<h3 id="_organize_your_files">1.3. Organize your files</h3>

+<div class="para"><p>To make it easy to organize your files and to make the plugin more compatible with GemPlugins, start out by altering your file system to look like this:</p></div>

 <div class="listingblock">

 <div class="content">

-<pre><tt>rm vendor/plugins/yaffle/lib/yaffle.rb</tt></pre>

+<pre><tt>|-- lib

+|   |-- yaffle

+|   `-- yaffle.rb

+`-- rails

+    |

+    `-- init.rb</tt></pre>

 </div></div>

-<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>Many plugin authors prefer to keep this file, and add all of the require statements in it.  That way, they only line in init.rb would be <tt>require "yaffle"</tt>. If you are developing a plugin that has a lot of files in the lib directory, you may want to create a subdirectory like lib/yaffle and store your files in there.  That way your init.rb file stays clean</td>

-</tr></table>

+<div class="para"><p><strong>vendor/plugins/yaffle/rails/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: #000080">require</span></span> <span style="color: #FF0000">'yaffle'</span>

+</tt></pre></div></div>

+<div class="para"><p>Now you can add any <em>require</em> statements to <em>lib/yaffle.rb</em> and keep <em>init.rb</em> clean.</p></div>

 </div>

-<h3 id="_setup_the_plugin_for_testing">1.3. Setup the plugin for testing</h3>

-<div class="para"><p>Testing plugins that use the entire Rails stack can be complex, and the generator doesn't offer any help.  In this tutorial you will learn how to test your plugin against multiple different adapters using ActiveRecord.  This tutorial will not cover how to use fixtures in plugin tests.</p></div>

-<div class="para"><p>To setup your plugin to allow for easy testing you'll need to add 3 files:</p></div>

+<h2 id="_tests">2. Tests</h2>

+<div class="sectionbody">

+<div class="para"><p>In this guide you will learn how to test your plugin against multiple different database adapters using Active Record.  To setup your plugin to allow for easy testing you'll need to add 3 files:</p></div>

 <div class="ilist"><ul>

 <li>

 <p>

-A <em>database.yml</em> file with all of your connection strings.

+A <em>database.yml</em> file with all of your connection strings

 </p>

 </li>

 <li>

 <p>

-A <em>schema.rb</em> file with your table definitions.

+A <em>schema.rb</em> file with your table definitions

 </p>

 </li>

 <li>

 <p>

-A test helper that sets up the database before your tests.

+A test helper method that sets up the database

 </p>

 </li>

 </ul></div>

-<div class="para"><p>For this plugin you'll need 2 tables/models, Hickwalls and Wickwalls, so add the following files:</p></div>

+<h3 id="_test_setup">2.1. Test Setup</h3>

 <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

-  :dbfile: yaffle_plugin.sqlite.db

+  :dbfile: vendor/plugins/yaffle/test/yaffle_plugin.sqlite.db

 

 sqlite3:

   :adapter: sqlite3

-  :dbfile: yaffle_plugin.sqlite3.db

+  :dbfile: vendor/plugins/yaffle/test/yaffle_plugin.sqlite3.db

 

 postgresql:

   :adapter: postgresql

@@ -486,11 +517,12 @@ postgresql:
 mysql:

   :adapter: mysql

   :host: localhost

-  :username: rails

-  :password:

+  :username: root

+  :password: password

   :database: yaffle_plugin_test</tt></pre>

 </div></div>

-<div class="para"><p><strong>vendor/plugins/yaffle/test/test_helper.rb:</strong></p></div>

+<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>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -507,203 +539,242 @@ http://www.gnu.org/software/src-highlite -->
     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>

+  create_table <span style="color: #990000">:</span>woodpeckers<span style="color: #990000">,</span> <span style="color: #990000">:</span>force <span style="color: #990000">=&gt;</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>

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

-

-<span style="font-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/test/test_helper.rb</span></span>

-

-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>

+</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>

 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>

 

-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>

+<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>

 

-db_adapter <span style="color: #990000">=</span> ENV<span style="color: #990000">[</span><span style="color: #FF0000">'DB'</span><span style="color: #990000">]</span>

+  db_adapter <span style="color: #990000">=</span> ENV<span style="color: #990000">[</span><span style="color: #FF0000">'DB'</span><span style="color: #990000">]</span>

 

-<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>

-  <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">'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>

-  <span style="font-weight: bold"><span style="color: #0000FF">rescue</span></span> MissingSourceFile

+  <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>

     <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: #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>

     <span style="font-weight: bold"><span style="color: #0000FF">rescue</span></span> MissingSourceFile

+      <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>

     <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">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>

-<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 

-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">'/../init.rb'</span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> Hickwall <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

-  acts_as_yaffle

-<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+  <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>

+  <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> Wickwall <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

-  acts_as_yaffle <span style="color: #990000">:</span>yaffle_text_field <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>last_tweet<span style="color: #990000">,</span> <span style="color: #990000">:</span>yaffle_date_field <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>last_tweeted_at

+  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>

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-</div>

-<h2 id="_add_a_tt_to_squawk_tt_method_to_string">2. Add a <tt>to_squawk</tt> method to String</h2>

-<div class="sectionbody">

-<div class="para"><p>To update a core class you will have to:</p></div>

-<div class="ilist"><ul>

-<li>

-<p>

-Write tests for the desired functionality.

-</p>

-</li>

-<li>

-<p>

-Create a file for the code you wish to use.

-</p>

-</li>

-<li>

-<p>

-Require that file from your <em>init.rb</em>.

-</p>

-</li>

-</ul></div>

-<div class="para"><p>Most plugins store their code classes in the plugin's lib directory.  When you add a file to the lib directory, you must also require that file from <em>init.rb</em>.  The file you are going to add for this tutorial is <em>lib/core_ext.rb</em>.</p></div>

-<div class="para"><p>First, you need to write the tests.  Testing plugins is very similar to testing rails apps.  The generated test file should look something like this:</p></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">2.2. 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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/test/core_ext_test.rb</span></span>

+<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">'test/unit'</span>

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> YaffleTest <span style="color: #990000">&lt;</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">class</span></span> CoreExtTest <span style="color: #990000">&lt;</span> Test<span style="color: #990000">::</span>Unit<span style="color: #990000">::</span>TestCase

-  <span style="font-style: italic"><span style="color: #9A1900"># Replace this with your real tests.</span></span>

-  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> test_this_plugin

-    flunk

+  <span style="font-weight: bold"><span style="color: #0000FF">class</span></span> Hickwall <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

   <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>Start off by removing the default test, and adding a require statement for your test helper.</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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/test/core_ext_test.rb</span></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>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> Wickwall <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  <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_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>

 

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> CoreExtTest <span style="color: #990000">&lt;</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>

-<div class="para"><p>Navigate to your plugin directory and run <tt>rake test</tt>:</p></div>

+<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 test</tt></pre>

+rake</tt></pre>

 </div></div>

-<div class="para"><p>Your test should fail with <tt>no such file to load &#8212; ./test/../lib/core_ext.rb (LoadError)</tt> because we haven't created any file yet.  Create the file <em>lib/core_ext.rb</em> and re-run the tests.  You should see a different error message:</p></div>

+<div class="para"><p>You should see output like:</p></div>

 <div class="listingblock">

 <div class="content">

-<pre><tt>1.) Failure ...

-No tests were specified</tt></pre>

+<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=&gt;true})

+   -&gt; 0.0220s

+-- create_table(:wickwalls, {:force=&gt;true})

+   -&gt; 0.0077s

+-- initialize_schema_migrations_table()

+   -&gt; 0.0007s

+-- assume_migrated_upto_version(0)

+   -&gt; 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>Great - now you are ready to start development.  The first thing we'll do is to add a method to String called <tt>to_squawk</tt> which will prefix the string with the word &#8220;squawk!&#8221;.  The test will look something like this:</p></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>

+</div>

+<h2 id="_extending_core_classes">3. Extending core classes</h2>

+<div class="sectionbody">

+<div class="para"><p>This section will explain how to add a method to String that will be available anywhere in your rails app.</p></div>

+<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>

 <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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/init.rb</span></span>

+<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> CoreExtTest <span style="color: #990000">&lt;</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_string_should_respond_to_squawk

-    assert_equal <span style="font-weight: bold"><span style="color: #0000FF">true</span></span><span style="color: #990000">,</span> <span style="color: #FF0000">""</span><span style="color: #990000">.</span>respond_to?<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">def</span></span> test_string_prepend_empty_strings_with_the_word_squawk

-    assert_equal <span style="color: #FF0000">"squawk!"</span><span style="color: #990000">,</span> <span style="color: #FF0000">""</span><span style="color: #990000">.</span>to_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_string_prepend_non_empty_strings_with_the_word_squawk

+  <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

   <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>

+<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>

+<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>

 <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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/init.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"core_ext"</span>

+<pre><tt><span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"yaffle/core_ext"</span>

 </tt></pre></div></div>

+<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>

 <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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/lib/core_ext.rb</span></span>

-

-String<span style="color: #990000">.</span>class_eval <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

+<pre><tt>String<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> 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>

-<div class="para"><p>When monkey-patching existing classes it's often better to use <tt>class_eval</tt> instead of opening the class directly.</p></div>

-<div class="para"><p>To test that your method does what it says it does, run the unit tests.  To test this manually, fire up a console and start squawking:</p></div>

+<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>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ ./script/console

 &gt;&gt; "Hello World".to_squawk

 =&gt; "squawk! Hello World"</tt></pre>

 </div></div>

-<div class="para"><p>If that worked, congratulations!  You just created your first test-driven plugin that extends a core ruby class.</p></div>

+<h3 id="_working_with_init_rb">3.1. Working with init.rb</h3>

+<div class="para"><p>When rails loads plugins it looks for the file named <em>init.rb</em> or <em>rails/init.rb</em>.  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/rails/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/rails/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>

 </div>

-<h2 id="_add_an_tt_acts_as_yaffle_tt_method_to_activerecord">3. Add an <tt>acts_as_yaffle</tt> method to ActiveRecord</h2>

+<h2 id="_add_an_em_acts_as_em_method_to_active_record">4. Add an <em>acts_as</em> method to Active Record</h2>

 <div class="sectionbody">

-<div class="para"><p>A common pattern in plugins is to add a method called <tt>acts_as_something</tt> to models.  In this case, you want to write a method called <tt>acts_as_yaffle</tt> that adds a <tt>squawk</tt> method to your models.</p></div>

-<div class="para"><p>To keep things clean, create a new test file called <em>acts_as_yaffle_test.rb</em> in your plugin's test directory and require your test helper.</p></div>

+<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>

 <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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/test/acts_as_yaffle_test.rb</span></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">'/test_helper.rb'</span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> Hickwall <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

-  acts_as_yaffle

-<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+<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> ActsAsYaffleTest <span style="color: #990000">&lt;</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>

+<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="font-style: italic"><span style="color: #9A1900"># File: vendor/plugins/lib/acts_as_yaffle.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">module</span></span> Yaffle

+<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>

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-<div class="para"><p>One of the most common plugin patterns for <tt>acts_as_yaffle</tt> plugins is to structure your file like so:</p></div>

+<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>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -727,139 +798,118 @@ http://www.gnu.org/software/src-highlite -->
 <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>

-<div class="para"><p>Let's add class method named <tt>acts_as_yaffle</tt> - testing it out first.  You already defined the ActiveRecord models in your test helper, so if you run tests now they will fail.</p></div>

-<div class="para"><p>Back in your <tt>acts_as_yaffle</tt> file, update ClassMethods like so:</p></div>

+<h3 id="_add_a_class_method">4.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>

 <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> 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>

-    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>

+<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">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  acts_as_yaffle

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

-</tt></pre></div></div>

-<div class="para"><p>Now that test should pass.  Since your plugin is going to work with field names, you need to allow people to define the field names, in case there is a naming conflict.  You can write a few simple tests for this:</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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/test/acts_as_yaffle_test.rb</span></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">'/test_helper.rb'</span>

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> Wickwall <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  acts_as_yaffle <span style="color: #990000">:</span>yaffle_text_field <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>last_tweet

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 

 <span style="font-weight: bold"><span style="color: #0000FF">class</span></span> ActsAsYaffleTest <span style="color: #990000">&lt;</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_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_hickwalls_yaffle_date_field_should_be_last_squawked_at

-    assert_equal <span style="color: #FF0000">"last_squawked_at"</span><span style="color: #990000">,</span> Hickwall<span style="color: #990000">.</span>yaffle_date_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">def</span></span> test_a_wickwalls_yaffle_date_field_should_be_last_tweeted_at

-    assert_equal <span style="color: #FF0000">"last_tweeted_at"</span><span style="color: #990000">,</span> Wickwall<span style="color: #990000">.</span>yaffle_date_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>

+<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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/lib/acts_as_yaffle.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">module</span></span> Yaffle

+<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-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>

-      cattr_accessor <span style="color: #990000">:</span>yaffle_text_field<span style="color: #990000">,</span> <span style="color: #990000">:</span>yaffle_date_field

+      cattr_accessor <span style="color: #990000">:</span>yaffle_text_field

       <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">self</span></span><span style="color: #990000">.</span>yaffle_date_field <span style="color: #990000">=</span> <span style="color: #990000">(</span>options<span style="color: #990000">[:</span>yaffle_date_field<span style="color: #990000">]</span> <span style="color: #990000">||</span> <span style="color: #990000">:</span>last_squawked_at<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">end</span></span>

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+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

 </tt></pre></div></div>

-<div class="para"><p>Now you can add tests for the instance methods, and the instance method itself:</p></div>

+<h3 id="_add_an_instance_method">4.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>

 <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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/test/acts_as_yaffle_test.rb</span></span>

+<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> 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">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  acts_as_yaffle

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> Wickwall <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  acts_as_yaffle <span style="color: #990000">:</span>yaffle_text_field <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>last_tweet

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 

 <span style="font-weight: bold"><span style="color: #0000FF">class</span></span> ActsAsYaffleTest <span style="color: #990000">&lt;</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_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_hickwalls_yaffle_date_field_should_be_last_squawked_at

-    assert_equal <span style="color: #FF0000">"last_squawked_at"</span><span style="color: #990000">,</span> Hickwall<span style="color: #990000">.</span>yaffle_date_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_squawk

+  <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">def</span></span> test_a_wickwalls_yaffle_date_field_should_be_last_squawked_at

-    assert_equal <span style="color: #FF0000">"last_tweeted_at"</span><span style="color: #990000">,</span> Wickwall<span style="color: #990000">.</span>yaffle_date_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_hickwalls_squawk_should_populate_last_squawked_at

-    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 Date<span style="color: #990000">.</span>today<span style="color: #990000">,</span> hickwall<span style="color: #990000">.</span>last_squawked_at

-  <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_tweet

-    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>

-    assert_equal <span style="color: #FF0000">"squawk! Hello World"</span><span style="color: #990000">,</span> wickwall<span style="color: #990000">.</span>last_tweet

-  <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>

-    assert_equal Date<span style="color: #990000">.</span>today<span style="color: #990000">,</span> wickwall<span style="color: #990000">.</span>last_tweeted_at

+    assert_equal <span style="color: #FF0000">"squawk! Hello World"</span><span style="color: #990000">,</span> wickwall<span style="color: #990000">.</span>last_tweet

   <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>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>

 <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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/lib/acts_as_yaffle.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">module</span></span> Yaffle

+<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-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>

-      cattr_accessor <span style="color: #990000">:</span>yaffle_text_field<span style="color: #990000">,</span> <span style="color: #990000">:</span>yaffle_date_field

+      cattr_accessor <span style="color: #990000">:</span>yaffle_text_field

       <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">self</span></span><span style="color: #990000">.</span>yaffle_date_field <span style="color: #990000">=</span> <span style="color: #990000">(</span>options<span style="color: #990000">[:</span>yaffle_date_field<span style="color: #990000">]</span> <span style="color: #990000">||</span> <span style="color: #990000">:</span>last_squawked_at<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>

@@ -867,445 +917,774 @@ http://www.gnu.org/software/src-highlite -->
   <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>

-      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_date_field<span style="color: #990000">,</span> Date<span style="color: #990000">.</span>today<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>

+

+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

 </tt></pre></div></div>

-<div class="para"><p>Note the use of <tt>write_attribute</tt> to write to the field in model.</p></div>

+<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_tt_squawk_info_for_tt_view_helper">4. Create a <tt>squawk_info_for</tt> view helper</h2>

+<h2 id="_models">5. Models</h2>

 <div class="sectionbody">

-<div class="para"><p>Creating a view helper is a 3-step process:</p></div>

-<div class="ilist"><ul>

-<li>

-<p>

-Add an appropriately named file to the <em>lib</em> directory.

-</p>

-</li>

-<li>

-<p>

-Require the file and hooks in <em>init.rb</em>.

-</p>

-</li>

-<li>

-<p>

-Write the tests.

-</p>

-</li>

-</ul></div>

-<div class="para"><p>First, create the test to define the functionality you want:</p></div>

+<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>

+<div class="listingblock">

+<div class="content">

+<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>

+</div></div>

+<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>

 <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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/test/view_helpers_test.rb</span></span>

+<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> 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> YaffleViewHelper

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> WoodpeckerTest <span style="color: #990000">&lt;</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">class</span></span> ViewHelpersTest <span style="color: #990000">&lt;</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_squawk_info_for_should_return_the_text_and_date

-    time <span style="color: #990000">=</span> Time<span style="color: #990000">.</span>now

-    hickwall <span style="color: #990000">=</span> Hickwall<span style="color: #990000">.</span>new

-    hickwall<span style="color: #990000">.</span>last_squawk <span style="color: #990000">=</span> <span style="color: #FF0000">"Hello World"</span>

-    hickwall<span style="color: #990000">.</span>last_squawked_at <span style="color: #990000">=</span> time

-    assert_equal <span style="color: #FF0000">"Hello World, #{time.to_s}"</span><span style="color: #990000">,</span> squawk_info_for<span style="color: #990000">(</span>hickwall<span style="color: #990000">)</span>

+  <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>Then add the following statements to init.rb:</p></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="font-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/init.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"view_helpers"</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> YaffleViewHelper

+<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">&lt;&lt;</span> path

+  ActiveSupport<span style="color: #990000">::</span>Dependencies<span style="color: #990000">.</span>load_paths <span style="color: #990000">&lt;&lt;</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">&lt;</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>Then add the view helpers file and</p></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><span style="font-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/lib/view_helpers.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">module</span></span> YaffleViewHelper

-  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> squawk_info_for<span style="color: #990000">(</span>yaffle<span style="color: #990000">)</span>

-    returning <span style="color: #FF0000">""</span> <span style="font-weight: bold"><span style="color: #0000FF">do</span></span> <span style="color: #990000">|</span>result<span style="color: #990000">|</span>

-      result <span style="color: #990000">&lt;&lt;</span> yaffle<span style="color: #990000">.</span>read_attribute<span style="color: #990000">(</span>yaffle<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>

-      result <span style="color: #990000">&lt;&lt;</span> <span style="color: #FF0000">", "</span>

-      result <span style="color: #990000">&lt;&lt;</span> yaffle<span style="color: #990000">.</span>read_attribute<span style="color: #990000">(</span>yaffle<span style="color: #990000">.</span><span style="font-weight: bold"><span style="color: #0000FF">class</span></span><span style="color: #990000">.</span>yaffle_date_field<span style="color: #990000">).</span>to_s

+<pre><tt>create_table <span style="color: #990000">:</span>woodpeckers<span style="color: #990000">,</span> <span style="color: #990000">:</span>force <span style="color: #990000">=&gt;</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>

+</tt></pre></div></div>

+<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>

+</div>

+<h2 id="_controllers">6. Controllers</h2>

+<div class="sectionbody">

+<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/test/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">&lt;</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

+

+    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>resources <span style="color: #990000">:</span>woodpeckers

     <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_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>You can also test this in script/console by using the <tt>helper</tt> method:</p></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">

-<pre><tt>$ ./script/console

-&gt;&gt; helper.squawk_info_for(@some_yaffle_instance)</tt></pre>

-</div></div>

+<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">&lt;&lt;</span> path

+  ActiveSupport<span style="color: #990000">::</span>Dependencies<span style="color: #990000">.</span>load_paths <span style="color: #990000">&lt;&lt;</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">&lt;</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">=&gt;</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="_create_a_migration_generator">5. Create a migration generator</h2>

+<h2 id="_helpers">7. Helpers</h2>

 <div class="sectionbody">

-<div class="para"><p>When you created the plugin above, you specified the &#8212;with-generator option, so you already have the generator stubs in your plugin.</p></div>

-<div class="para"><p>We'll be relying on the built-in rails generate template for this tutorial.  Going into the details of generators is beyond the scope of this tutorial.</p></div>

-<div class="para"><p>Type:</p></div>

-<div class="literalblock">

-<div class="content">

-<pre><tt>script/generate</tt></pre>

-</div></div>

-<div class="para"><p>You should see the line:</p></div>

-<div class="literalblock">

-<div class="content">

-<pre><tt>Plugins (vendor/plugins): yaffle</tt></pre>

-</div></div>

-<div class="para"><p>When you run <tt>script/generate yaffle</tt> you should see the contents of your USAGE file.  For this plugin, the USAGE file looks like this:</p></div>

+<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>

 <div class="listingblock">

-<div class="content">

-<pre><tt>Description:

-    Creates a migration that adds yaffle squawk fields to the given model

+<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: #0000FF">include</span></span> WoodpeckersHelper

 

-Example:

-    ./script/generate yaffle hickwall

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> WoodpeckersHelperTest <span style="color: #990000">&lt;</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">&lt;&lt;</span> path

+  ActiveSupport<span style="color: #990000">::</span>Dependencies<span style="color: #990000">.</span>load_paths <span style="color: #990000">&lt;&lt;</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/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

 

-    This will create:

-        db/migrate/TIMESTAMP_add_yaffle_fields_to_hickwall</tt></pre>

-</div></div>

-<div class="para"><p>Now you can add code to your generator:</p></div>

+  <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="_routes">8. Routes</h2>

+<div class="sectionbody">

+<div class="para"><p>In a standard <em>routes.rb</em> file you use routes like <em>map.connect</em> or <em>map.resources</em>.  You can add your own custom routes from a plugin.  This section will describe how to add a custom method called that can be called with <em>map.yaffles</em>.</p></div>

+<div class="para"><p>Testing routes from plugins is slightly different from testing routes in a standard rails app.  To begin, add a test like this:</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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/generators/yaffle/yaffle_generator.rb</span></span>

+<pre><tt><span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"#{File.dirname(__FILE__)}/test_helper"</span>

 

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> YaffleGenerator <span style="color: #990000">&lt;</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

-    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">=&gt;</span> yaffle_local_assigns<span style="color: #990000">,</span>

-        <span style="color: #990000">:</span>migration_file_name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"add_yaffle_fields_to_#{custom_file_name}"</span>

-       <span style="color: #FF0000">}</span>

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> RoutingTest <span style="color: #990000">&lt;</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">=&gt;</span> <span style="color: #FF0000">"yaffles_controller"</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>action <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"index"</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>

-        assigns<span style="color: #990000">[:</span>attributes<span style="color: #990000">]</span> <span style="color: #990000">&lt;&lt;</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_squawked_at"</span><span style="color: #990000">,</span> <span style="color: #FF0000">"datetime"</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">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">=&gt;</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>

-<div class="para"><p>Note that you need to be aware of whether or not table names are pluralized.</p></div>

-<div class="para"><p>This does a few things:</p></div>

-<div class="ilist"><ul>

-<li>

-<p>

-Reuses the built in rails <tt>migration_template</tt> method.

-</p>

-</li>

-<li>

-<p>

-Reuses the built-in rails migration template.

-</p>

-</li>

-</ul></div>

-<div class="para"><p>When you run the generator like</p></div>

-<div class="literalblock">

-<div class="content">

-<pre><tt>script/generate yaffle bird</tt></pre>

-</div></div>

-<div class="para"><p>You will see a new file:</p></div>

+<div class="para"><p>Once you see the tests fail by running <em>rake</em>, you can make them pass with:</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="font-style: italic"><span style="color: #9A1900"># File: db/migrate/20080529225649_add_yaffle_fields_to_birds.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> AddYaffleFieldsToBirds <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Migration

-  <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

-    add_column <span style="color: #990000">:</span>birds<span style="color: #990000">,</span> <span style="color: #990000">:</span>last_squawked_at<span style="color: #990000">,</span> <span style="color: #990000">:</span>datetime

+<pre><tt><span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"yaffle/routing"</span>

+</tt></pre></div></div>

+<div class="para"><p><strong>vendor/plugins/yaffle/lib/yaffle/routing.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">#:nodoc:</span></span>

+  <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">=&gt;</span> <span style="color: #FF0000">"yaffles_controller"</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>action <span style="color: #990000">=&gt;</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>

 

-  <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_squawked_at

-    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>

+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>

+<div class="para"><p><strong>config/routes.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>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>

 </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>

-<h2 id="_add_a_custom_generator_command">6. Add a custom generator command</h2>

+<h2 id="_generators">9. Generators</h2>

 <div class="sectionbody">

-<div class="para"><p>You may have noticed above that you can used one of the built-in rails migration commands <tt>m.migration_template</tt>.  You can create your own commands for these, using the following steps:</p></div>

-<div class="olist"><ol>

+<div class="para"><p>Many plugins ship with generators.  When you created the plugin above, you specified the &#8212;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: generating a simple text file.</p></div>

+<h3 id="_testing_generators">9.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>

+<div class="ilist"><ul>

+<li>

+<p>

+Creates a new fake rails root directory that will serve as destination

+</p>

+</li>

 <li>

 <p>

-Add the require and hook statements to init.rb.

+Runs the generator

 </p>

 </li>

 <li>

 <p>

-Create the commands - creating 3 sets, Create, Destroy, List.

+Asserts that the correct files were generated

 </p>

 </li>

 <li>

 <p>

-Add the method to your generator.

+Removes the fake rails root

 </p>

 </li>

-</ol></div>

-<div class="para"><p>Working with the internals of generators is beyond the scope of this tutorial, but here is a basic example:</p></div>

+</ul></div>

+<div class="para"><p>This section will describe how to create a simple generator that adds a file.  For the generator in this section, the test could look something like this:</p></div>

+<div class="para"><p><strong>vendor/plugins/yaffle/test/definition_generator_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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/init.rb</span></span>

-<span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"commands"</span>

-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

+<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: #0000FF">class</span></span> DefinitionGeneratorTest <span style="color: #990000">&lt;</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

+    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>

+

+  <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_definition"</span><span style="color: #990000">],</span> <span style="color: #990000">:</span>destination <span style="color: #990000">=&gt;</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_equal <span style="color: #FF0000">"definition.txt"</span><span style="color: #990000">,</span> File<span style="color: #990000">.</span>basename<span style="color: #990000">(</span>new_file<span style="color: #990000">)</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> 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>

+    <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+    <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">"*"</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>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>

+<div class="para"><p>To make it pass, create the generator:</p></div>

+<div class="para"><p><strong>vendor/plugins/yaffle/generators/yaffle_definition/yaffle_definition_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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/lib/commands.rb</span></span>

-

+<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">class</span></span> YaffleDefinitionGenerator <span style="color: #990000">&lt;</span> Rails<span style="color: #990000">::</span>Generator<span style="color: #990000">::</span>Base

+  <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>file <span style="color: #FF0000">"definition.txt"</span><span style="color: #990000">,</span> <span style="color: #FF0000">"definition.txt"</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>

+<h3 id="_the_usage_file">9.2. The USAGE file</h3>

+<div class="para"><p>If you plan to distribute your plugin, developers will expect at least a minimum of documentation.  You can add simple documentation to the generator by updating the USAGE file.</p></div>

+<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_definition

+  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_definition -h</tt> you should see the contents of your <em>vendor/plugins/yaffle/generators/yaffle_definition/USAGE</em>.</p></div>

+<div class="para"><p>For this plugin, update the USAGE file could look like this:</p></div>

+<div class="listingblock">

+<div class="content">

+<pre><tt>Description:

+    Adds a file with the definition of a Yaffle to the app's main directory</tt></pre>

+</div></div>

+</div>

+<h2 id="_generator_commands">10. Generator Commands</h2>

+<div class="sectionbody">

+<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>config/routes.rb</em>.</p></div>

+<div class="para"><p>To start, add the following test method:</p></div>

+<div class="para"><p><strong>vendor/plugins/yaffle/test/route_generator_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">'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>

+

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> RouteGeneratorTest <span style="color: #990000">&lt;</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

+    FileUtils<span style="color: #990000">.</span>mkdir_p<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">"config"</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">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_route

+    content <span style="color: #990000">=</span> <span style="color: #990000">&lt;&lt;-</span><span style="font-weight: bold"><span style="color: #0000FF">END</span></span>

+      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>connect <span style="color: #FF0000">':controller/:action/:id'</span>

+        map<span style="color: #990000">.</span>connect <span style="color: #FF0000">':controller/:action/:id.:format'</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>

+    File<span style="color: #990000">.</span>open<span style="color: #990000">(</span>routes_path<span style="color: #990000">,</span> <span style="color: #FF0000">'wb'</span><span style="color: #990000">)</span> <span style="color: #FF0000">{</span><span style="color: #990000">|</span>f<span style="color: #990000">|</span> f<span style="color: #990000">.</span>write<span style="color: #990000">(</span>content<span style="color: #990000">)</span> <span style="color: #FF0000">}</span>

+

+    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_route"</span><span style="color: #990000">],</span> <span style="color: #990000">:</span>destination <span style="color: #990000">=&gt;</span> fake_rails_root<span style="color: #990000">)</span>

+    assert_match <span style="color: #FF6600">/map\.yaffles/</span><span style="color: #990000">,</span> File<span style="color: #990000">.</span>read<span style="color: #990000">(</span>routes_path<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_destroys_route

+    content <span style="color: #990000">=</span> <span style="color: #990000">&lt;&lt;-</span><span style="font-weight: bold"><span style="color: #0000FF">END</span></span>

+      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

+        map<span style="color: #990000">.</span>connect <span style="color: #FF0000">':controller/:action/:id'</span>

+        map<span style="color: #990000">.</span>connect <span style="color: #FF0000">':controller/:action/:id.:format'</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>

+    File<span style="color: #990000">.</span>open<span style="color: #990000">(</span>routes_path<span style="color: #990000">,</span> <span style="color: #FF0000">'wb'</span><span style="color: #990000">)</span> <span style="color: #FF0000">{</span><span style="color: #990000">|</span>f<span style="color: #990000">|</span> f<span style="color: #990000">.</span>write<span style="color: #990000">(</span>content<span style="color: #990000">)</span> <span style="color: #FF0000">}</span>

+

+    Rails<span style="color: #990000">::</span>Generator<span style="color: #990000">::</span>Scripts<span style="color: #990000">::</span>Destroy<span style="color: #990000">.</span>new<span style="color: #990000">.</span>run<span style="color: #990000">([</span><span style="color: #FF0000">"yaffle_route"</span><span style="color: #990000">],</span> <span style="color: #990000">:</span>destination <span style="color: #990000">=&gt;</span> fake_rails_root<span style="color: #990000">)</span>

+    assert_no_match <span style="color: #FF6600">/map\.yaffles/</span><span style="color: #990000">,</span> File<span style="color: #990000">.</span>read<span style="color: #990000">(</span>routes_path<span style="color: #990000">)</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> 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>

+    <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+    <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> routes_path

+      File<span style="color: #990000">.</span>join<span style="color: #990000">(</span>fake_rails_root<span style="color: #990000">,</span> <span style="color: #FF0000">"config"</span><span style="color: #990000">,</span> <span style="color: #FF0000">"routes.rb"</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>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/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="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/yaffle/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>

 <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">def</span></span> yaffle_route

+          logger<span style="color: #990000">.</span>route <span style="color: #FF0000">"map.yaffle"</span>

+          look_for <span style="color: #990000">=</span> <span style="color: #FF0000">'ActionController::Routing::Routes.draw do |map|'</span>

+          <span style="font-weight: bold"><span style="color: #0000FF">unless</span></span> options<span style="color: #990000">[:</span>pretend<span style="color: #990000">]</span>

+            gsub_file<span style="color: #990000">(</span><span style="color: #FF0000">'config/routes.rb'</span><span style="color: #990000">,</span> <span style="color: #FF6600">/(#{Regexp.escape(look_for)})/</span>mi<span style="color: #990000">)</span><span style="color: #FF0000">{</span><span style="color: #990000">|</span>match<span style="color: #990000">|</span> <span style="color: #FF0000">"#{match}\n  map.yaffles\n"</span><span style="color: #FF0000">}</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">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">def</span></span> yaffle_route

+          logger<span style="color: #990000">.</span>route <span style="color: #FF0000">"map.yaffle"</span>

+          gsub_file <span style="color: #FF0000">'config/routes.rb'</span><span style="color: #990000">,</span> <span style="color: #FF6600">/\n.+?map\.yaffles/</span>mi<span style="color: #990000">,</span> <span style="color: #FF0000">''</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">def</span></span> yaffle_route

+        <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> Update

+        <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> yaffle_route

         <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>

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

-</tt></pre></div></div>

-<div class="listingblock">

-<div class="content">

-<pre><tt># File: vendor/plugins/yaffle/generators/yaffle/templates/definition.txt

 

-Yaffle is a bird</tt></pre>

-</div></div>

+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><strong>vendor/plugins/yaffle/generators/yaffle/yaffle_route_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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/generators/yaffle/yaffle_generator.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> YaffleGenerator <span style="color: #990000">&lt;</span> Rails<span style="color: #990000">::</span>Generator<span style="color: #990000">::</span>NamedBase

+<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">class</span></span> YaffleRouteGenerator <span style="color: #990000">&lt;</span> Rails<span style="color: #990000">::</span>Generator<span style="color: #990000">::</span>Base

   <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> manifest

-    m<span style="color: #990000">.</span>yaffle_definition

+    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>yaffle_route

+    <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>

-<div class="para"><p>This example just uses the built-in "file" method, but you could do anything that Ruby allows.</p></div>

+<div class="para"><p>To see this work, type:</p></div>

+<div class="listingblock">

+<div class="content">

+<pre><tt>./script/generate yaffle_route

+./script/destroy yaffle_route</tt></pre>

+</div></div>

+<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>If you haven't set up the custom route from above, <em>script/destroy</em> will fail and you'll have to remove it manually.</td>

+</tr></table>

+</div>

 </div>

-<h2 id="_add_a_custom_route">7. Add a Custom Route</h2>

+<h2 id="_migrations">11. Migrations</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>If your plugin requires changes to the app's database you will likely want to somehow add migrations.  Rails does not include any built-in support for calling migrations from plugins, but you can still make it easy for developers to call migrations from plugins.</p></div>

+<div class="para"><p>If you have a very simple needs, like creating a table that will always have the same name and columns, then you can use a more simple solution, like creating a custom rake task or method.  If your migration needs user input to supply table names or other options, you probably want to opt for generating a migration.</p></div>

+<div class="para"><p>Let's say you have the following migration in your plugin:</p></div>

+<div class="para"><p><strong>vendor/plugins/yaffle/lib/db/migrate/20081116181115_create_birdhouses.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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/test/routing_test.rb</span></span>

-

-<span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"#{File.dirname(__FILE__)}/test_helper"</span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> RoutingTest <span style="color: #990000">&lt;</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

+<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">class</span></span> CreateBirdhouses <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Migration

+  <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

+    create_table <span style="color: #990000">:</span>birdhouses<span style="color: #990000">,</span> <span style="color: #990000">:</span>force <span style="color: #990000">=&gt;</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>timestamps

     <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">=&gt;</span> <span style="color: #FF0000">"yaffles_controller"</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>action <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"index"</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

+    drop_table <span style="color: #990000">:</span>birdhouses

   <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">=&gt;</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>

+<div class="para"><p>Here are a few possibilities for how to allow developers to use your plugin migrations:</p></div>

+<h3 id="_create_a_custom_rake_task">11.1. Create a custom rake task</h3>

+<div class="para"><p><strong>vendor/plugins/yaffle/lib/db/migrate/20081116181115_create_birdhouses.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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/init.rb</span></span>

+<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">class</span></span> CreateBirdhouses <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Migration

+  <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

+    create_table <span style="color: #990000">:</span>birdhouses<span style="color: #990000">,</span> <span style="color: #990000">:</span>force <span style="color: #990000">=&gt;</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>timestamps

+    <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: #000080">require</span></span> <span style="color: #FF0000">"routing"</span>

-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

+  <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

+    drop_table <span style="color: #990000">:</span>birdhouses

+  <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><strong>vendor/plugins/yaffle/tasks/yaffle.rake:</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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/lib/routing.rb</span></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> 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">=&gt;</span> <span style="color: #FF0000">"yaffles_controller"</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>action <span style="color: #990000">=&gt;</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>

+<pre><tt>namespace <span style="color: #990000">:</span>db <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

+  namespace <span style="color: #990000">:</span>migrate <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

+    desc <span style="color: #FF0000">"Migrate the database through scripts in vendor/plugins/yaffle/lib/db/migrate and update db/schema.rb by invoking db:schema:dump. Target specific version with VERSION=x. Turn off output with VERBOSE=false."</span>

+    task <span style="color: #990000">:</span>yaffle <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>environment <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

+      ActiveRecord<span style="color: #990000">::</span>Migration<span style="color: #990000">.</span>verbose <span style="color: #990000">=</span> ENV<span style="color: #990000">[</span><span style="color: #FF0000">"VERBOSE"</span><span style="color: #990000">]</span> <span style="color: #990000">?</span> ENV<span style="color: #990000">[</span><span style="color: #FF0000">"VERBOSE"</span><span style="color: #990000">]</span> <span style="color: #990000">==</span> <span style="color: #FF0000">"true"</span> <span style="color: #990000">:</span> <span style="font-weight: bold"><span style="color: #0000FF">true</span></span>

+      ActiveRecord<span style="color: #990000">::</span>Migrator<span style="color: #990000">.</span>migrate<span style="color: #990000">(</span><span style="color: #FF0000">"vendor/plugins/yaffle/lib/db/migrate/"</span><span style="color: #990000">,</span> ENV<span style="color: #990000">[</span><span style="color: #FF0000">"VERSION"</span><span style="color: #990000">]</span> <span style="color: #990000">?</span> ENV<span style="color: #990000">[</span><span style="color: #FF0000">"VERSION"</span><span style="color: #990000">].</span>to_i <span style="color: #990000">:</span> <span style="font-weight: bold"><span style="color: #0000FF">nil</span></span><span style="color: #990000">)</span>

+      Rake<span style="color: #990000">::</span>Task<span style="color: #990000">[</span><span style="color: #FF0000">"db:schema:dump"</span><span style="color: #990000">].</span>invoke <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> ActiveRecord<span style="color: #990000">::</span>Base<span style="color: #990000">.</span>schema_format <span style="color: #990000">==</span> <span style="color: #990000">:</span>ruby

     <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>

+<h3 id="_call_migrations_directly">11.2. Call migrations directly</h3>

+<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="font-style: italic"><span style="color: #9A1900"># File: config/routes.rb</span></span>

-

-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>

-  <span style="color: #990000">...</span>

-  map<span style="color: #990000">.</span>yaffles

+<pre><tt>Dir<span style="color: #990000">.</span>glob<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">"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>each <span style="font-weight: bold"><span style="color: #0000FF">do</span></span> <span style="color: #990000">|</span>file<span style="color: #990000">|</span>

+  <span style="font-weight: bold"><span style="color: #000080">require</span></span> file

 <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>

-<h2 id="_odds_and_ends">8. Odds and ends</h2>

-<div class="sectionbody">

-<h3 id="_work_with_init_rb">8.1. Work with init.rb</h3>

-<div class="para"><p>The plugin initializer script <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>If you reopen any classes in init.rb itself your changes will potentially be made to the wrong module.  There are 2 ways around this:</p></div>

-<div class="para"><p>The first 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>db/migrate/20081116181115_create_birdhouses.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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/init.rb</span></span>

+<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">class</span></span> CreateBirdhouses <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Migration

+  <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

+    Yaffle<span style="color: #990000">::</span>CreateBirdhouses<span style="color: #990000">.</span>up

+  <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 

-<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">def</span></span> <span style="font-weight: bold"><span style="color: #0000FF">self</span></span><span style="color: #990000">.</span>down

+    Yaffle<span style="color: #990000">::</span>CreateBirdhouses<span style="color: #990000">.</span>down

   <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>OR you can use <tt>module_eval</tt> or <tt>class_eval</tt>:</p></div>

-<div class="listingblock">

-<div class="content">

-<pre><tt># File: vendor/plugins/yaffle/init.rb

-

-Hash.class_eval do

-  def is_a_special_hash?

-    true

-  end

-end</tt></pre>

-</div></div>

-<h3 id="_generate_rdoc_documentation">8.2. Generate RDoc Documentation</h3>

-<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="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>several plugin frameworks such as Desert and Engines provide more advanced plugin functionality.</td>

+</tr></table>

+</div>

+<h3 id="_generate_migrations">11.3. Generate migrations</h3>

+<div class="para"><p>Generating migrations has several advantages over other methods.  Namely, you can allow other developers to more easily customize the migration.  The flow looks like this:</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).

+call your script/generate script and pass in whatever options they need

 </p>

 </li>

 <li>

 <p>

-Warning, gotchas or tips that might help save users time.

+examine the generated migration, adding/removing columns or other options as necessary

 </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="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.  Extending the rails migration generator requires a somewhat intimate knowledge of the migration generator internals, so it's best to write a test first:</p></div>

+<div class="para"><p><strong>vendor/plugins/yaffle/test/yaffle_migration_generator_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">'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: #0000FF">class</span></span> MigrationGeneratorTest <span style="color: #990000">&lt;</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

+    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>

+

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> teardown

+    ActiveRecord<span style="color: #990000">::</span>Base<span style="color: #990000">.</span>pluralize_table_names <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #0000FF">true</span></span>

+    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_migration"</span><span style="color: #990000">,</span> <span style="color: #FF0000">"some_name_nobody_is_likely_to_ever_use_in_a_real_migration"</span><span style="color: #990000">],</span> <span style="color: #990000">:</span>destination <span style="color: #990000">=&gt;</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_some_name_nobody_is_likely_to_ever_use_in_a_real_migrations/</span><span style="color: #990000">,</span> new_file

+    assert_match <span style="color: #FF6600">/add_column :some_name_nobody_is_likely_to_ever_use_in_a_real_migrations do |t|/</span><span style="color: #990000">,</span> File<span style="color: #990000">.</span>read<span style="color: #990000">(</span>new_file<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_pluralizes_properly

+    ActiveRecord<span style="color: #990000">::</span>Base<span style="color: #990000">.</span>pluralize_table_names <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #0000FF">false</span></span>

+    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_migration"</span><span style="color: #990000">,</span> <span style="color: #FF0000">"some_name_nobody_is_likely_to_ever_use_in_a_real_migration"</span><span style="color: #990000">],</span> <span style="color: #990000">:</span>destination <span style="color: #990000">=&gt;</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_some_name_nobody_is_likely_to_ever_use_in_a_real_migration/</span><span style="color: #990000">,</span> new_file

+    assert_match <span style="color: #FF6600">/add_column :some_name_nobody_is_likely_to_ever_use_in_a_real_migration do |t|/</span><span style="color: #990000">,</span> File<span style="color: #990000">.</span>read<span style="color: #990000">(</span>new_file<span style="color: #990000">)</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> 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>

+    <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+    <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>

+    <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="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 migration generator checks to see if a migation already exists, and it's hard-coded to check the <em>db/migrate</em> directory.  As a result, if your test tries to generate a migration that already exists in the app, it will fail.  The easy workaround is to make sure that the name you generate in your test is very unlikely to actually appear in the app.</td>

+</tr></table>

+</div>

+<div class="para"><p>After running the test with <em>rake</em> you can make it pass with:</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> YaffleMigrationGenerator <span style="color: #990000">&lt;</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

+    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">=&gt;</span> yaffle_local_assigns<span style="color: #990000">,</span>

+        <span style="color: #990000">:</span>migration_file_name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"add_yaffle_fields_to_#{custom_file_name}"</span>

+      <span style="color: #FF0000">}</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>

+

+  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

+      custom_name

+    <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>

+<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>

+<div class="para"><p>To run the generator, type the following at the command line:</p></div>

+<div class="listingblock">

 <div class="content">

-<pre><tt>rake rdoc</tt></pre>

+<pre><tt>./script/generate yaffle_migration bird</tt></pre>

 </div></div>

-<h3 id="_store_models_views_helpers_and_controllers_in_your_plugins">8.3. Store models, views, helpers, and controllers in your plugins</h3>

-<div class="para"><p>You can easily store models, views, helpers and controllers in plugins.  Just create a folder for each in the lib folder, add them to the load path and remove them from the load once path:</p></div>

+<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>

 <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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/init.rb</span></span>

+<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">class</span></span> AddYaffleFieldsToBirds <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Migration

+  <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="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>directory<span style="color: #990000">,</span> <span style="color: #FF0000">'lib'</span><span style="color: #990000">,</span> dir<span style="color: #990000">)</span>

-  <span style="color: #009900">$LOAD_PATH</span> <span style="color: #990000">&lt;&lt;</span> path

-  Dependencies<span style="color: #990000">.</span>load_paths <span style="color: #990000">&lt;&lt;</span> path

-  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">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>

-<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.</p></div>

-<div class="para"><p>Adding directories to the load once paths allow those changes to picked up as soon as you save the file - without having to restart the web server.</p></div>

-<h3 id="_write_custom_rake_tasks_in_your_plugin">8.4. Write custom Rake tasks in your plugin</h3>

+</div>

+<h2 id="_rake_tasks">12. Rake tasks</h2>

+<div class="sectionbody">

 <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>

+<div class="para"><p><strong>vendor/plugins/yaffle/tasks/yaffle.rake</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-style: italic"><span style="color: #9A1900"># File: vendor/plugins/yaffle/tasks/yaffle.rake</span></span>

-

-namespace <span style="color: #990000">:</span>yaffle <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

+<pre><tt>namespace <span style="color: #990000">:</span>yaffle <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

   desc <span style="color: #FF0000">"Prints out the word 'Yaffle'"</span>

   task <span style="color: #990000">:</span>squawk <span style="color: #990000">=&gt;</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>

@@ -1318,25 +1697,93 @@ namespace <span style="color: #990000">:</span>yaffle <span style="font-weight:
 <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>

-<h3 id="_store_plugins_in_alternate_locations">8.5. Store plugins in alternate locations</h3>

-<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="para"><p>Note that tasks from <em>vendor/plugins/yaffle/Rakefile</em> are not available to the main app.</p></div>

+</div>

+<h2 id="_plugingems">13. PluginGems</h2>

+<div class="sectionbody">

+<div class="para"><p>Turning your rails plugin into a gem is a simple and straightforward task.  This section will cover how to turn your plugin into a gem.  It will not cover how to distribute that gem.</p></div>

+<div class="para"><p>Historically rails plugins loaded the plugin's <em>init.rb</em> file.  In fact some plugins contain all of their code in that one file.  To be compatible with plugins, <em>init.rb</em> was moved to <em>rails/init.rb</em>.</p></div>

+<div class="para"><p>It's common practice to put any developer-centric rake tasks (such as tests, rdoc and gem package tasks) in <em>Rakefile</em>.  A rake task that packages the gem might look like this:</p></div>

+<div class="para"><p><strong>vendor/plugins/yaffle/Rakefile:</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>config<span style="color: #990000">.</span>plugin_paths <span style="color: #990000">&lt;&lt;</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>

+<pre><tt>PKG_FILES <span style="color: #990000">=</span> FileList<span style="color: #990000">[</span>

+  <span style="color: #FF0000">'[a-zA-Z]*'</span><span style="color: #990000">,</span>

+  <span style="color: #FF0000">'generators/**/*'</span><span style="color: #990000">,</span>

+  <span style="color: #FF0000">'lib/**/*'</span><span style="color: #990000">,</span>

+  <span style="color: #FF0000">'rails/**/*'</span><span style="color: #990000">,</span>

+  <span style="color: #FF0000">'tasks/**/*'</span><span style="color: #990000">,</span>

+  <span style="color: #FF0000">'test/**/*'</span>

+<span style="color: #990000">]</span>

+

+spec <span style="color: #990000">=</span> Gem<span style="color: #990000">::</span>Specification<span style="color: #990000">.</span>new <span style="font-weight: bold"><span style="color: #0000FF">do</span></span> <span style="color: #990000">|</span>s<span style="color: #990000">|</span>

+  s<span style="color: #990000">.</span>name <span style="color: #990000">=</span> <span style="color: #FF0000">"yaffle"</span>

+  s<span style="color: #990000">.</span>version <span style="color: #990000">=</span> <span style="color: #FF0000">"0.0.1"</span>

+  s<span style="color: #990000">.</span>author <span style="color: #990000">=</span> <span style="color: #FF0000">"Gleeful Yaffler"</span>

+  s<span style="color: #990000">.</span>email <span style="color: #990000">=</span> <span style="color: #FF0000">"yaffle@example.com"</span>

+  s<span style="color: #990000">.</span>homepage <span style="color: #990000">=</span> <span style="color: #FF0000">"http://yafflers.example.com/"</span>

+  s<span style="color: #990000">.</span>platform <span style="color: #990000">=</span> Gem<span style="color: #990000">::</span>Platform<span style="color: #990000">::</span>RUBY

+  s<span style="color: #990000">.</span>summary <span style="color: #990000">=</span> <span style="color: #FF0000">"Sharing Yaffle Goodness"</span>

+  s<span style="color: #990000">.</span>files <span style="color: #990000">=</span> PKG_FILES<span style="color: #990000">.</span>to_a

+  s<span style="color: #990000">.</span>require_path <span style="color: #990000">=</span> <span style="color: #FF0000">"lib"</span>

+  s<span style="color: #990000">.</span>has_rdoc <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #0000FF">false</span></span>

+  s<span style="color: #990000">.</span>extra_rdoc_files <span style="color: #990000">=</span> <span style="color: #990000">[</span><span style="color: #FF0000">"README"</span><span style="color: #990000">]</span>

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+desc <span style="color: #FF0000">'Turn this plugin into a gem.'</span>

+Rake<span style="color: #990000">::</span>GemPackageTask<span style="color: #990000">.</span>new<span style="color: #990000">(</span>spec<span style="color: #990000">)</span> <span style="font-weight: bold"><span style="color: #0000FF">do</span></span> <span style="color: #990000">|</span>pkg<span style="color: #990000">|</span>

+  pkg<span style="color: #990000">.</span>gem_spec <span style="color: #990000">=</span> spec

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-<h3 id="_create_your_own_plugin_loaders_and_plugin_locators">8.6. Create your own Plugin Loaders and Plugin Locators</h3>

-<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>

-<h3 id="_use_custom_plugin_generators">8.7. Use Custom Plugin Generators</h3>

-<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 class="para"><p>To build and install the gem locally, run the following commands:</p></div>

+<div class="listingblock">

+<div class="content">

+<pre><tt>cd vendor/plugins/yaffle

+rake gem

+sudo gem install pkg/yaffle-0.0.1.gem</tt></pre>

+</div></div>

+<div class="para"><p>To test this, create a new rails app, add <em>config.gem "yaffle"</em> to environment.rb and all of your plugin's functionality will be available to you.</p></div>

 </div>

-<h2 id="_appendix">9. Appendix</h2>

+<h2 id="_rdoc_documentation">14. RDoc Documentation</h2>

 <div class="sectionbody">

-<h3 id="_references">9.1. References</h3>

+<div class="para"><p>Once your plugin is stable and you are ready to deploy do everyone else a favor and document it!  Luckily, writing documentation for your plugin is easy.</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.  It's also customary to add <em>#:nodoc:</em> comments to those parts of the code that are not part of the public api.</p></div>

+<div class="para"><p>Once your comments are good to go, navigate to your plugin directory and run:</p></div>

+<div class="listingblock">

+<div class="content">

+<pre><tt>rake rdoc</tt></pre>

+</div></div>

+</div>

+<h2 id="_appendix">15. Appendix</h2>

+<div class="sectionbody">

+<div class="para"><p>If you prefer to use RSpec instead of Test::Unit, you may be interested in the <a href="http://github.com/pat-maddox/rspec-plugin-generator/tree/master">RSpec Plugin Generator</a>.</p></div>

+<h3 id="_references">15.1. References</h3>

 <div class="ilist"><ul>

 <li>

 <p>

@@ -1358,41 +1805,104 @@ http://www.gnu.org/software/src-highlite -->
 <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>

+<li>

+<p>

+<a href="http://www.mbleigh.com/2008/6/11/gemplugins-a-brief-introduction-to-the-future-of-rails-plugins">http://www.mbleigh.com/2008/6/11/gemplugins-a-brief-introduction-to-the-future-of-rails-plugins</a>

+</p>

+</li>

+<li>

+<p>

+<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>

+</li>

 </ul></div>

-<h3 id="_final_plugin_directory_structure">9.2. Final plugin directory structure</h3>

+<h3 id="_contents_of_em_lib_yaffle_rb_em">15.2. Contents of <em>lib/yaffle.rb</em></h3>

+<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="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"yaffle/core_ext"</span>

+<span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"yaffle/acts_as_yaffle"</span>

+<span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"yaffle/commands"</span>

+<span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">"yaffle/routing"</span>

+

+<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">&lt;&lt;</span> path

+  ActiveSupport<span style="color: #990000">::</span>Dependencies<span style="color: #990000">.</span>load_paths <span style="color: #990000">&lt;&lt;</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>

+

+<span style="font-style: italic"><span style="color: #9A1900"># optionally:</span></span>

+<span style="font-style: italic"><span style="color: #9A1900"># Dir.glob(File.join(File.dirname(__FILE__), "db", "migrate", "*")).each do |file|</span></span>

+<span style="font-style: italic"><span style="color: #9A1900">#   require file</span></span>

+<span style="font-style: italic"><span style="color: #9A1900"># end</span></span>

+

+</tt></pre></div></div>

+<h3 id="_final_plugin_directory_structure">15.3. Final plugin directory structure</h3>

 <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>

+<pre><tt>|-- MIT-LICENSE

+|-- README

+|-- Rakefile

+|-- generators

+|   |-- yaffle_definition

+|   |   |-- USAGE

+|   |   |-- templates

+|   |   |   `-- definition.txt

+|   |   `-- yaffle_definition_generator.rb

+|   |-- yaffle_migration

+|   |   |-- USAGE

+|   |   |-- templates

+|   |   `-- yaffle_migration_generator.rb

+|   `-- yaffle_route

+|       |-- USAGE

+|       |-- templates

+|       `-- yaffle_route_generator.rb

+|-- install.rb

+|-- lib

+|   |-- app

+|   |   |-- controllers

+|   |   |   `-- woodpeckers_controller.rb

+|   |   |-- helpers

+|   |   |   `-- woodpeckers_helper.rb

+|   |   `-- models

+|   |       `-- woodpecker.rb

+|   |-- db

+|   |   `-- migrate

+|   |       `-- 20081116181115_create_birdhouses.rb

+|   |-- yaffle

+|   |   |-- acts_as_yaffle.rb

+|   |   |-- commands.rb

+|   |   |-- core_ext.rb

+|   |   `-- routing.rb

+|   `-- yaffle.rb

+|-- pkg

+|   `-- yaffle-0.0.1.gem

+|-- rails

+|   `-- init.rb

+|-- tasks

+|   `-- yaffle_tasks.rake

+|-- test

+|   |-- acts_as_yaffle_test.rb

+|   |-- core_ext_test.rb

+|   |-- database.yml

+|   |-- debug.log

+|   |-- definition_generator_test.rb

+|   |-- migration_generator_test.rb

+|   |-- route_generator_test.rb

+|   |-- routes_test.rb

+|   |-- schema.rb

+|   |-- test_helper.rb

+|   |-- woodpecker_test.rb

+|   |-- woodpeckers_controller_test.rb

+|   |-- wookpeckers_helper_test.rb

+|   |-- yaffle_plugin.sqlite3.db

+|   `-- yaffle_test.rb

+`-- uninstall.rb</tt></pre>

 </div></div>

 </div>

 
diff --git a/railties/doc/guides/html/getting_started_with_rails.html b/railties/doc/guides/html/getting_started_with_rails.html
index 5111d0c645..304c26a54f 100644
--- a/railties/doc/guides/html/getting_started_with_rails.html
+++ b/railties/doc/guides/html/getting_started_with_rails.html
@@ -1791,7 +1791,7 @@ http://www.gnu.org/software/src-highlite -->
 

   <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> show

     <span style="color: #009900">@post</span> <span style="color: #990000">=</span> Post<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>post_id<span style="color: #990000">])</span>

-    <span style="color: #009900">@comment</span> <span style="color: #990000">=</span> Comment<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>id<span style="color: #990000">])</span>

+    <span style="color: #009900">@comment</span> <span style="color: #990000">=</span> <span style="color: #009900">@post</span><span style="color: #990000">.</span>comments<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>id<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> new

@@ -1803,7 +1803,7 @@ http://www.gnu.org/software/src-highlite -->
     <span style="color: #009900">@post</span> <span style="color: #990000">=</span> Post<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>post_id<span style="color: #990000">])</span>

     <span style="color: #009900">@comment</span> <span style="color: #990000">=</span> <span style="color: #009900">@post</span><span style="color: #990000">.</span>comments<span style="color: #990000">.</span>build<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>comment<span style="color: #990000">])</span>

     <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="color: #009900">@comment</span><span style="color: #990000">.</span>save

-      redirect_to post_comment_path<span style="color: #990000">(</span><span style="color: #009900">@post</span><span style="color: #990000">,</span> <span style="color: #009900">@comment</span><span style="color: #990000">)</span>

+      redirect_to post_comment_url<span style="color: #990000">(</span><span style="color: #009900">@post</span><span style="color: #990000">,</span> <span style="color: #009900">@comment</span><span style="color: #990000">)</span>

     <span style="font-weight: bold"><span style="color: #0000FF">else</span></span>

       render <span style="color: #990000">:</span>action <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"new"</span>

     <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

@@ -1811,14 +1811,14 @@ http://www.gnu.org/software/src-highlite -->
 

   <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> edit

     <span style="color: #009900">@post</span> <span style="color: #990000">=</span> Post<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>post_id<span style="color: #990000">])</span>

-    <span style="color: #009900">@comment</span> <span style="color: #990000">=</span> Comment<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>id<span style="color: #990000">])</span>

+    <span style="color: #009900">@comment</span> <span style="color: #990000">=</span> <span style="color: #009900">@post</span><span style="color: #990000">.</span>comments<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>id<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> update

     <span style="color: #009900">@post</span> <span style="color: #990000">=</span> Post<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>post_id<span style="color: #990000">])</span>

     <span style="color: #009900">@comment</span> <span style="color: #990000">=</span> Comment<span style="color: #990000">.</span>find<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>id<span style="color: #990000">])</span>

     <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="color: #009900">@comment</span><span style="color: #990000">.</span>update_attributes<span style="color: #990000">(</span>params<span style="color: #990000">[:</span>comment<span style="color: #990000">])</span>

-      redirect_to post_comment_path<span style="color: #990000">(</span><span style="color: #009900">@post</span><span style="color: #990000">,</span> <span style="color: #009900">@comment</span><span style="color: #990000">)</span>

+      redirect_to post_comment_url<span style="color: #990000">(</span><span style="color: #009900">@post</span><span style="color: #990000">,</span> <span style="color: #009900">@comment</span><span style="color: #990000">)</span>

     <span style="font-weight: bold"><span style="color: #0000FF">else</span></span>

       render <span style="color: #990000">:</span>action <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"edit"</span>

     <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

@@ -1990,7 +1990,7 @@ http://www.gnu.org/software/src-highlite -->
 <div class="ilist"><ul>

 <li>

 <p>

-The <a href="http://manuals.rubyonrails.org/">Ruby On Rails guides</a>

+The <a href="http://guides.rubyonrails.org/">Ruby On Rails guides</a>

 </p>

 </li>

 <li>

diff --git a/railties/doc/guides/html/i18n.html b/railties/doc/guides/html/i18n.html
new file mode 100644
index 0000000000..3504a9e366
--- /dev/null
+++ b/railties/doc/guides/html/i18n.html
@@ -0,0 +1,1079 @@
+<!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 Rails Internationalization API</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="#_how_i18n_in_ruby_on_rails_works">How I18n in Ruby on Rails works</a>
+						<ul>
+						
+							<li><a href="#_the_overall_architecture_of_the_library">The overall architecture of the library</a></li>
+						
+							<li><a href="#_the_public_i18n_api">The public I18n API</a></li>
+						
+						</ul>
+					</li>
+					<li>
+					<a href="#_walkthrough_setup_a_simple_i18n_ed_rails_application">Walkthrough: setup a simple I18n'ed Rails application</a>
+						<ul>
+						
+							<li><a href="#_configure_the_i18n_module">Configure the I18n module</a></li>
+						
+							<li><a href="#_set_the_locale_in_each_request">Set the locale in each request</a></li>
+						
+							<li><a href="#_internationalize_your_application">Internationalize your application</a></li>
+						
+						</ul>
+					</li>
+					<li>
+					<a href="#_overview_of_the_i18n_api_features">Overview of the I18n API features</a>
+						<ul>
+						
+							<li><a href="#_looking_up_translations">Looking up translations</a></li>
+						
+							<li><a href="#_interpolation">Interpolation</a></li>
+						
+							<li><a href="#_pluralization">Pluralization</a></li>
+						
+							<li><a href="#_setting_and_passing_a_locale">Setting and passing a locale</a></li>
+						
+						</ul>
+					</li>
+					<li>
+					<a href="#_how_to_store_your_custom_translations">How to store your custom translations</a>
+						<ul>
+						
+							<li><a href="#_translations_for_activerecord_models">Translations for ActiveRecord models</a></li>
+						
+							<li><a href="#_other_translations_and_localizations">Other translations and localizations</a></li>
+						
+						</ul>
+					</li>
+					<li>
+					<a href="#_customize_your_i18n_setup">Customize your I18n setup</a>
+						<ul>
+						
+							<li><a href="#_using_different_backends">Using different backends</a></li>
+						
+							<li><a href="#_using_different_exception_handlers">Using different exception handlers</a></li>
+						
+						</ul>
+					</li>
+					<li>
+					<a href="#_resources">Resources</a>
+					</li>
+					<li>
+					<a href="#_footnotes">Footnotes</a>
+					</li>
+					<li>
+					<a href="#_credits">Credits</a>
+					</li>
+					<li>
+					<a href="#_notes">NOTES</a>
+					</li>
+			</ol>
+		</div>
+		
+		<div id="content">
+				<h1>The Rails Internationalization API</h1>
+			<div id="preamble">

+<div class="sectionbody">

+<div class="para"><p>The Ruby I18n gem which is shipped with Ruby on Rails (starting from Rails 2.2) provides an easy-to-use and extensible framework for translating your application to a single custom language other than English or providing multi-language support in your application.</p></div>

+</div>

+</div>

+<h2 id="_how_i18n_in_ruby_on_rails_works">1. How I18n in Ruby on Rails works</h2>

+<div class="sectionbody">

+<div class="para"><p>Internationalization is a complex problem. Natural languages differ in so many ways that it is hard to provide tools for solving all problems at once. For that reason the Rails I18n API focusses on:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+providing support for English and similar languages out of the box

+</p>

+</li>

+<li>

+<p>

+making it easy to customize and extend everything for other languages

+</p>

+</li>

+</ul></div>

+<h3 id="_the_overall_architecture_of_the_library">1.1. The overall architecture of the library</h3>

+<div class="para"><p>To solve this the Ruby I18n gem is split into two parts:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+The public API which is just a Ruby module with a bunch of public methods and definitions how the library works.

+</p>

+</li>

+<li>

+<p>

+A shipped backend (which is intentionally named the Simple backend) that implements these methods.

+</p>

+</li>

+</ul></div>

+<div class="para"><p>As a user you should always only access the public methods on the I18n module but it is useful to know about the capabilities of the backend you use and maybe exchange the shipped Simple backend with a more powerful one.</p></div>

+<h3 id="_the_public_i18n_api">1.2. The public I18n API</h3>

+<div class="para"><p>We will go into more detail about the public methods later but here's a quick overview. The most important methods are:</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>translate         <span style="font-style: italic"><span style="color: #9A1900"># lookup translations</span></span>

+localize          <span style="font-style: italic"><span style="color: #9A1900"># localize Date and Time objects to local formats</span></span>

+</tt></pre></div></div>

+<div class="para"><p>There are also attribute readers and writers for the following attributes:</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>load_path         <span style="font-style: italic"><span style="color: #9A1900"># announce your custom translation files</span></span>

+locale            <span style="font-style: italic"><span style="color: #9A1900"># get and set the current locale</span></span>

+default_locale    <span style="font-style: italic"><span style="color: #9A1900"># get and set the default locale</span></span>

+exception_handler <span style="font-style: italic"><span style="color: #9A1900"># use a different exception_handler</span></span>

+backend           <span style="font-style: italic"><span style="color: #9A1900"># use a different backend</span></span>

+</tt></pre></div></div>

+</div>

+<h2 id="_walkthrough_setup_a_simple_i18n_ed_rails_application">2. Walkthrough: setup a simple I18n'ed Rails application</h2>

+<div class="sectionbody">

+<div class="para"><p>There are just a few, simple steps to get up and running with a I18n support for your application.</p></div>

+<h3 id="_configure_the_i18n_module">2.1. Configure the I18n module</h3>

+<div class="para"><p>First of all you want to tell the I18n library where it can find your custom translation files. You might also want to set your default locale to something else than English.</p></div>

+<div class="para"><p>You can pick whatever directory and translation file naming scheme makes sense for you. The simplest thing possible is probably to put the following into an initializer:</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-style: italic"><span style="color: #9A1900"># in config/initializer/locale.rb</span></span>

+

+<span style="font-style: italic"><span style="color: #9A1900"># tell the I18n library where to find your translations</span></span>

+I18n<span style="color: #990000">.</span>load_path <span style="color: #990000">+=</span> Dir<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">'lib'</span><span style="color: #990000">,</span> <span style="color: #FF0000">'locale'</span><span style="color: #990000">,</span> <span style="color: #FF0000">'*.{rb,yml}'</span><span style="color: #990000">)</span> <span style="color: #990000">]</span>

+

+<span style="font-style: italic"><span style="color: #9A1900"># you can omit this if you're happy with English as a default locale</span></span>

+I18n<span style="color: #990000">.</span>default_locale <span style="color: #990000">=</span> <span style="color: #990000">:</span><span style="color: #FF0000">"pt-BR"</span>

+</tt></pre></div></div>

+<div class="para"><p>I18n.load_path is just a Ruby Array of paths to your translation files. The backend will lazy-load these translations when a translation is looked up for the first time. This makes it possible to just swap the backend with something else even after translations have already been announced.</p></div>

+<h3 id="_set_the_locale_in_each_request">2.2. Set the locale in each request</h3>

+<div class="para"><p>By default the I18n library will use the I18n.default_locale for looking up translations (if you do not specify a locale for a lookup) and this will, by default, en-US (American English).</p></div>

+<div class="para"><p>If you want to translate your Rails application to a single language other than English you can set I18n.default_locale to your locale. If you want to change the locale on a per-request basis though you can set it in a before_filter on the ApplicationController like this:</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>before_filter <span style="color: #990000">:</span>set_locale

+<span style="font-weight: bold"><span style="color: #0000FF">def</span></span> set_locale

+  <span style="font-style: italic"><span style="color: #9A1900"># if this is nil then I18n.default_locale will be used</span></span>

+  I18n<span style="color: #990000">.</span>locale <span style="color: #990000">=</span> params<span style="color: #990000">[:</span>locale<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>This will already work for URLs where you pass the locale as a query parameter as in example.com?locale=pt-BR (which is what Google also does). (TODO hints about other approaches in the resources section).</p></div>

+<div class="para"><p>Now you've initialized I18n support for your application and told it which locale should be used. With that in place you're now ready for the really interesting stuff.</p></div>

+<h3 id="_internationalize_your_application">2.3. Internationalize your application</h3>

+<div class="para"><p>The process of "internationalization" usually means to abstract all strings and other locale specific bits out of your application (TODO reference to wikipedia). The process of "localization" means to then provide translations and localized formats for these bits.</p></div>

+<div class="para"><p>So, let's internationalize something. You most probably have something like this in one of your applications:</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-style: italic"><span style="color: #9A1900"># config/routes.rb</span></span>

+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>root <span style="color: #990000">:</span>controller <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'home'</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>action <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'index'</span>

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+<span style="font-style: italic"><span style="color: #9A1900"># app/controllers/home_controller.rb</span></span>

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> HomeController <span style="color: #990000">&lt;</span> ApplicationController

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> index

+    flash<span style="color: #990000">[:</span>notice<span style="color: #990000">]</span> <span style="color: #990000">=</span> <span style="color: #FF0000">"Hello flash!"</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-style: italic"><span style="color: #9A1900"># app/views/home/index.html.erb</span></span>

+<span style="color: #FF0000">&lt;h1&gt;</span>Hello world!<span style="color: #FF0000">&lt;/h1&gt;</span>

+<span style="color: #FF0000">&lt;p&gt;&lt;%= flash[:notice] %&gt;&lt;/p&gt;</span>

+</tt></pre></div></div>

+<div class="para"><p>TODO screenshot</p></div>

+<div class="para"><p>Obviously there are two strings that are localized to English. In order to internationalize this code replace these strings with calls to Rails' #t helper with a key that makes sense for the translation:</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-style: italic"><span style="color: #9A1900"># app/controllers/home_controller.rb</span></span>

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> HomeController <span style="color: #990000">&lt;</span> ApplicationController

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> index

+    flash<span style="color: #990000">[:</span>notice<span style="color: #990000">]</span> <span style="color: #990000">=</span> t<span style="color: #990000">(:</span>hello_flash<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-style: italic"><span style="color: #9A1900"># app/views/home/index.html.erb</span></span>

+<span style="color: #FF0000">&lt;h1&gt;&lt;%=t :hello_world %&gt;&lt;/h1&gt;</span>

+<span style="color: #FF0000">&lt;p&gt;&lt;%= flash[:notice] %&gt;&lt;/p&gt;</span>

+</tt></pre></div></div>

+<div class="para"><p>TODO insert note about #t helper compared to I18n.t</p></div>

+<div class="para"><p>TODO insert note/reference about structuring translation keys</p></div>

+<div class="para"><p>When you now render this view it will show an error message that tells you that the translations for the keys :hello_world and :hello_flash are missing.</p></div>

+<div class="para"><p>TODO screenshot</p></div>

+<div class="para"><p>So let's add the missing translations (i.e. do the "localization" part):</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-style: italic"><span style="color: #9A1900"># lib/locale/en-US.yml</span></span>

+en<span style="color: #990000">-</span>US<span style="color: #990000">:</span>

+  hello_world<span style="color: #990000">:</span> Hello World

+  hello_flash<span style="color: #990000">:</span> Hello Flash

+

+<span style="font-style: italic"><span style="color: #9A1900"># lib/locale/pirate.yml</span></span>

+pirate<span style="color: #990000">:</span>

+  hello_world<span style="color: #990000">:</span> Ahoy World

+  hello_flash<span style="color: #990000">:</span> Ahoy Flash

+</tt></pre></div></div>

+<div class="para"><p>There you go. Your application now shows:</p></div>

+<div class="para"><p>TODO screenshot</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>I18n<span style="color: #990000">.</span>t <span style="color: #FF0000">'store.title'</span>

+I18n<span style="color: #990000">.</span>l Time<span style="color: #990000">.</span>now

+</tt></pre></div></div>

+</div>

+<h2 id="_overview_of_the_i18n_api_features">3. Overview of the I18n API features</h2>

+<div class="sectionbody">

+<div class="para"><p>The following purposes are covered:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+lookup translations

+</p>

+</li>

+<li>

+<p>

+interpolate data into translations

+</p>

+</li>

+<li>

+<p>

+pluralize translations

+</p>

+</li>

+<li>

+<p>

+localize dates, numbers, currency etc.

+</p>

+</li>

+</ul></div>

+<h3 id="_looking_up_translations">3.1. Looking up translations</h3>

+<h4 id="_basic_lookup_scopes_and_nested_keys">3.1.1. Basic lookup, scopes and nested keys</h4>

+<div class="para"><p>Translations are looked up by keys which can be both Symbols or Strings, so these calls are equivalent:</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>I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>message

+I18n<span style="color: #990000">.</span>t <span style="color: #FF0000">'message'</span>

+</tt></pre></div></div>

+<div class="para"><p>translate also takes a :scope option which can contain one or many additional keys that will be used to specify a “namespace” or scope for a translation key:</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>I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>invalid<span style="color: #990000">,</span> <span style="color: #990000">:</span>scope <span style="color: #990000">=&gt;</span> <span style="color: #990000">[:</span>active_record<span style="color: #990000">,</span> <span style="color: #990000">:</span>error_messages<span style="color: #990000">]</span>

+</tt></pre></div></div>

+<div class="para"><p>This looks up the :invalid message in the ActiveRecord error messages.</p></div>

+<div class="para"><p>Additionally, both the key and scopes can be specified as dot separated keys as in:</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>I18n<span style="color: #990000">.</span>translate <span style="color: #990000">:</span><span style="color: #FF0000">"active_record.error_messages.invalid"</span>

+</tt></pre></div></div>

+<div class="para"><p>Thus the following calls are equivalent:</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>I18n<span style="color: #990000">.</span>t <span style="color: #FF0000">'active_record.error_messages.invalid'</span>

+I18n<span style="color: #990000">.</span>t <span style="color: #FF0000">'error_messages.invalid'</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>scope <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>active_record

+I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>invalid<span style="color: #990000">,</span> <span style="color: #990000">:</span>scope <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'active_record.error_messages'</span>

+I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>invalid<span style="color: #990000">,</span> <span style="color: #990000">:</span>scope <span style="color: #990000">=&gt;</span> <span style="color: #990000">[:</span>active_record<span style="color: #990000">,</span> <span style="color: #990000">:</span>error_messages<span style="color: #990000">]</span>

+</tt></pre></div></div>

+<h4 id="_defaults">3.1.2. Defaults</h4>

+<div class="para"><p>When a default option is given its value will be returned if the translation is missing:</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>I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>missing<span style="color: #990000">,</span> <span style="color: #990000">:</span>default <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'Not here'</span>

+<span style="font-style: italic"><span style="color: #9A1900"># =&gt; 'Not here'</span></span>

+</tt></pre></div></div>

+<div class="para"><p>If the default value is a Symbol it will be used as a key and translated. One can provide multiple values as default. The first one that results in a value will be returned.</p></div>

+<div class="para"><p>E.g. the following first tries to translate the key :missing and then the key :also_missing. As both do not yield a result the string ‘Not here’ will be returned:</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>I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>missing<span style="color: #990000">,</span> <span style="color: #990000">:</span>default <span style="color: #990000">=&gt;</span> <span style="color: #990000">[:</span>also_missing<span style="color: #990000">,</span> <span style="color: #FF0000">'Not here'</span><span style="color: #990000">]</span>

+<span style="font-style: italic"><span style="color: #9A1900"># =&gt; 'Not here'</span></span>

+</tt></pre></div></div>

+<h4 id="_bulk_and_namespace_lookup">3.1.3. Bulk and namespace lookup</h4>

+<div class="para"><p>To lookup multiple translations at once an array of keys can be passed:</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>I18n<span style="color: #990000">.</span>t <span style="color: #990000">[:</span>odd<span style="color: #990000">,</span> <span style="color: #990000">:</span>even<span style="color: #990000">],</span> <span style="color: #990000">:</span>scope <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'active_record.error_messages'</span>

+<span style="font-style: italic"><span style="color: #9A1900"># =&gt; ["must be odd", "must be even"]</span></span>

+</tt></pre></div></div>

+<div class="para"><p>Also, a key can translate to a (potentially nested) hash as grouped translations. E.g. one can receive all ActiveRecord error messages as a Hash with:</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>I18n<span style="color: #990000">.</span>t <span style="color: #FF0000">'active_record.error_messages'</span>

+<span style="font-style: italic"><span style="color: #9A1900"># =&gt; { :inclusion =&gt; "is not included in the list", :exclusion =&gt; ... }</span></span>

+</tt></pre></div></div>

+<h3 id="_interpolation">3.2. Interpolation</h3>

+<div class="para"><p>TODO explain what this is good for</p></div>

+<div class="para"><p>All options besides :default and :scope that are passed to #translate will be interpolated to the translation:</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>I18n<span style="color: #990000">.</span>backend<span style="color: #990000">.</span>store_translations <span style="color: #FF0000">'en-US'</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>thanks <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'Thanks {{name}}!'</span>

+I18n<span style="color: #990000">.</span>translate <span style="color: #990000">:</span>thanks<span style="color: #990000">,</span> <span style="color: #990000">:</span>name <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'Jeremy'</span>

+<span style="font-style: italic"><span style="color: #9A1900"># =&gt; 'Thanks Jeremy!'</span></span>

+</tt></pre></div></div>

+<div class="para"><p>If a translation uses :default or :scope as a interpolation variable an I18n::ReservedInterpolationKey exception is raised. If a translation expects an interpolation variable but it has not been passed to #translate an I18n::MissingInterpolationArgument exception is raised.</p></div>

+<h3 id="_pluralization">3.3. Pluralization</h3>

+<div class="para"><p>TODO explain what this is good for</p></div>

+<div class="para"><p>The :count interpolation variable has a special role in that it both is interpolated to the translation and used to pick a pluralization from the translations according to the pluralization rules defined by CLDR:</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>I18n<span style="color: #990000">.</span>backend<span style="color: #990000">.</span>store_translations <span style="color: #FF0000">'en-US'</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>inbox <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">{</span> <span style="font-style: italic"><span style="color: #9A1900"># TODO change this</span></span>

+  <span style="color: #990000">:</span>one <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'1 message'</span><span style="color: #990000">,</span>

+  <span style="color: #990000">:</span>other <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'{{count}} messages'</span>

+<span style="color: #FF0000">}</span>

+I18n<span style="color: #990000">.</span>translate <span style="color: #990000">:</span>inbox<span style="color: #990000">,</span> <span style="color: #990000">:</span>count <span style="color: #990000">=&gt;</span> <span style="color: #993399">2</span>

+<span style="font-style: italic"><span style="color: #9A1900"># =&gt; '2 messages'</span></span>

+</tt></pre></div></div>

+<div class="para"><p>The algorithm for pluralizations in en-US is as simple as:</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>entry<span style="color: #990000">[</span>count <span style="color: #990000">==</span> <span style="color: #993399">1</span> <span style="color: #990000">?</span> <span style="color: #993399">0</span> <span style="color: #990000">:</span> <span style="color: #993399">1</span><span style="color: #990000">]</span>

+</tt></pre></div></div>

+<div class="para"><p>I.e. the translation denoted as :one is regarded as singular, the other is used as plural (including the count being zero).</p></div>

+<div class="para"><p>If the lookup for the key does not return an Hash suitable for pluralization an I18n::InvalidPluralizationData exception is raised.</p></div>

+<h3 id="_setting_and_passing_a_locale">3.4. Setting and passing a locale</h3>

+<div class="para"><p>The locale can be either set pseudo-globally to I18n.locale (which uses Thread.current like, e.g., Time.zone) or can be passed as an option to #translate and #localize.</p></div>

+<div class="para"><p>If no locale is passed I18n.locale is used:</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>I18n<span style="color: #990000">.</span>locale <span style="color: #990000">=</span> <span style="color: #990000">:</span><span style="color: #FF0000">'de-DE'</span>

+I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>foo

+I18n<span style="color: #990000">.</span>l Time<span style="color: #990000">.</span>now

+</tt></pre></div></div>

+<div class="para"><p>Explicitely passing a locale:</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>I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>foo<span style="color: #990000">,</span> <span style="color: #990000">:</span>locale <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span><span style="color: #FF0000">'de-DE'</span>

+I18n<span style="color: #990000">.</span>l Time<span style="color: #990000">.</span>now<span style="color: #990000">,</span> <span style="color: #990000">:</span>locale <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span><span style="color: #FF0000">'de-DE'</span>

+</tt></pre></div></div>

+<div class="para"><p>I18n.locale defaults to I18n.default_locale which defaults to :<em>en-US</em>. The default locale can be set like this:</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>I18n<span style="color: #990000">.</span>default_locale <span style="color: #990000">=</span> <span style="color: #990000">:</span><span style="color: #FF0000">'de-DE'</span>

+</tt></pre></div></div>

+</div>

+<h2 id="_how_to_store_your_custom_translations">4. How to store your custom translations</h2>

+<div class="sectionbody">

+<div class="para"><p>The shipped Simple backend allows you to store translations in both plain Ruby and YAML format. (2)</p></div>

+<div class="para"><p>For example a Ruby Hash providing translations can look like this:</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: #FF0000">{</span>

+  <span style="color: #990000">:</span><span style="color: #FF0000">'pt-BR'</span> <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">{</span>

+    <span style="color: #990000">:</span>foo <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">{</span>

+      <span style="color: #990000">:</span>bar <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"baz"</span>

+    <span style="color: #FF0000">}</span>

+  <span style="color: #FF0000">}</span>

+<span style="color: #FF0000">}</span>

+</tt></pre></div></div>

+<div class="para"><p>The equivalent YAML file would look like this:</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: #FF0000">"pt-BR"</span><span style="color: #990000">:</span>

+  foo<span style="color: #990000">:</span>

+    bar<span style="color: #990000">:</span> baz

+</tt></pre></div></div>

+<div class="para"><p>As you see in both cases the toplevel key is the locale. :foo is a namespace key and :bar is the key for the translation "baz".</p></div>

+<div class="para"><p>Here is a "real" example from the ActiveSupport en-US translations YAML file:</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: #FF0000">"en-US"</span><span style="color: #990000">:</span>

+  date<span style="color: #990000">:</span>

+    formats<span style="color: #990000">:</span>

+      default<span style="color: #990000">:</span> <span style="color: #FF0000">"%Y-%m-%d"</span>

+      short<span style="color: #990000">:</span> <span style="color: #FF0000">"%b %d"</span>

+      long<span style="color: #990000">:</span> <span style="color: #FF0000">"%B %d, %Y"</span>

+</tt></pre></div></div>

+<div class="para"><p>So, all of the following equivalent lookups will return the :short date format "%B %d":</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>I18n<span style="color: #990000">.</span>t <span style="color: #FF0000">'date.formats.short'</span>

+I18n<span style="color: #990000">.</span>t <span style="color: #FF0000">'formats.short'</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>scope <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>date

+I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>short<span style="color: #990000">,</span> <span style="color: #990000">:</span>scope <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'date.formats'</span>

+I18n<span style="color: #990000">.</span>t <span style="color: #990000">:</span>short<span style="color: #990000">,</span> <span style="color: #990000">:</span>scope <span style="color: #990000">=&gt;</span> <span style="color: #990000">[:</span>date<span style="color: #990000">,</span> <span style="color: #990000">:</span>formats<span style="color: #990000">]</span>

+</tt></pre></div></div>

+<h3 id="_translations_for_activerecord_models">4.1. Translations for ActiveRecord models</h3>

+<div class="para"><p>You can use the methods Model.human_name and Model.human_attribute_name(attribute) to transparently lookup translations for your model and attribute names.</p></div>

+<div class="para"><p>For example when you add the following translations:</p></div>

+<div class="para"><p>en-US:

+  activerecord:

+    models:

+      user: Dude

+    attributes:

+      user:

+        login: "Handle"

+      # will translate User attribute "login" as "Handle"</p></div>

+<div class="para"><p>Then User.human_name will return "Dude" and User.human_attribute_name(:login) will return "Handle".</p></div>

+<h4 id="_error_message_scopes">4.1.1. Error message scopes</h4>

+<div class="para"><p>ActiveRecord validation error messages can also be translated easily. ActiveRecord gives you a couple of namespaces where you can place your message translations in order to provide different messages and translation for certain models, attributes and/or validations. It also transparently takes single table inheritance into account.</p></div>

+<div class="para"><p>This gives you quite powerful means to flexibly adjust your messages to your application's needs.</p></div>

+<div class="para"><p>Consider a User model with a validates_presence_of validation for the name attribute like this:</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> User <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  validates_presence_of <span style="color: #990000">:</span>name

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+</tt></pre></div></div>

+<div class="para"><p>The key for the error message in this case is :blank. So ActiveRecord will first try to look up an error message with:</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>errors<span style="color: #990000">.</span>messages<span style="color: #990000">.</span>models<span style="color: #990000">.</span>user<span style="color: #990000">.</span>attributes<span style="color: #990000">.</span>name<span style="color: #990000">.</span>blank

+</tt></pre></div></div>

+<div class="para"><p>If it's not there it will try:</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>errors<span style="color: #990000">.</span>messages<span style="color: #990000">.</span>models<span style="color: #990000">.</span>user<span style="color: #990000">.</span>blank

+</tt></pre></div></div>

+<div class="para"><p>If this is also not there it will use the default message from:</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>errors<span style="color: #990000">.</span>messages<span style="color: #990000">.</span>blank

+</tt></pre></div></div>

+<div class="para"><p>When your models are additionally using inheritance then the messages are looked up for the inherited model class names are looked up.</p></div>

+<div class="para"><p>For example, you might have an Admin model inheriting from User:</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> Admin <span style="color: #990000">&lt;</span> User

+  validates_presence_of <span style="color: #990000">:</span>name

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+</tt></pre></div></div>

+<div class="para"><p>Then ActiveRecord will look for messages in this order:</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>errors<span style="color: #990000">.</span>models<span style="color: #990000">.</span>admin<span style="color: #990000">.</span>attributes<span style="color: #990000">.</span>title<span style="color: #990000">.</span>blank

+activerecord<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>models<span style="color: #990000">.</span>admin<span style="color: #990000">.</span>blank

+activerecord<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>models<span style="color: #990000">.</span>user<span style="color: #990000">.</span>attributes<span style="color: #990000">.</span>title<span style="color: #990000">.</span>blank

+activerecord<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>models<span style="color: #990000">.</span>user<span style="color: #990000">.</span>blank

+activerecord<span style="color: #990000">.</span>errors<span style="color: #990000">.</span>messages<span style="color: #990000">.</span>blank

+</tt></pre></div></div>

+<div class="para"><p>This way you can provide special translations for various error messages at different points in your models inheritance chain and in the attributes, models or default scopes.</p></div>

+<h4 id="_error_message_interpolation">4.1.2. Error message interpolation</h4>

+<div class="para"><p>The translated model name and translated attribute name are always available for interpolation.</p></div>

+<div class="para"><p></p></div>

+<div class="para"><p>Count and/or value are available where applicable. Count can be used for pluralization if present:</p></div>

+<div class="tableblock">

+<table rules="all"

+frame="hsides"

+cellspacing="0" cellpadding="4">

+<col width="320" />

+<col width="194" />

+<col width="182" />

+<col width="194" />

+<tbody valign="top">

+  <tr>

+    <td align="left">

+    validation

+    </td>

+    <td align="left">

+    with option

+    </td>

+    <td align="left">

+    message

+    </td>

+    <td align="left">

+    interpolation

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_confirmation_of

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :confirmation

+    </td>

+    <td align="left">

+    -

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_acceptance_of

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :accepted

+    </td>

+    <td align="left">

+    -

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_presence_of

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :blank

+    </td>

+    <td align="left">

+    -

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_length_of

+    </td>

+    <td align="left">

+    :within, :in

+    </td>

+    <td align="left">

+    :too_short

+    </td>

+    <td align="left">

+    count

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_length_of

+    </td>

+    <td align="left">

+    :within, :in

+    </td>

+    <td align="left">

+    :too_long

+    </td>

+    <td align="left">

+    count

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_length_of

+    </td>

+    <td align="left">

+    :is

+    </td>

+    <td align="left">

+    :wrong_length

+    </td>

+    <td align="left">

+    count

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_length_of

+    </td>

+    <td align="left">

+    :minimum

+    </td>

+    <td align="left">

+    :too_short

+    </td>

+    <td align="left">

+    count

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_length_of

+    </td>

+    <td align="left">

+    :maximum

+    </td>

+    <td align="left">

+    :too_long

+    </td>

+    <td align="left">

+    count

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_uniqueness_of

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :taken

+    </td>

+    <td align="left">

+    value

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_format_of

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :invalid

+    </td>

+    <td align="left">

+    value

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_inclusion_of

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :inclusion

+    </td>

+    <td align="left">

+    value

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_exclusion_of

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :exclusion

+    </td>

+    <td align="left">

+    value

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_associated

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :invalid

+    </td>

+    <td align="left">

+    value

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_numericality_of

+    </td>

+    <td align="left">

+    -

+    </td>

+    <td align="left">

+    :not_a_number

+    </td>

+    <td align="left">

+    value

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_numericality_of

+    </td>

+    <td align="left">

+    :odd

+    </td>

+    <td align="left">

+    :odd

+    </td>

+    <td align="left">

+    value

+    </td>

+  </tr>

+  <tr>

+    <td align="left">

+    validates_numericality_of

+    </td>

+    <td align="left">

+    :even

+    </td>

+    <td align="left">

+    :even

+    </td>

+    <td align="left">

+    value

+    </td>

+  </tr>

+</tbody>

+</table>

+</div>

+<h4 id="_translations_for_the_activerecord_error_messages_for_helper">4.1.3. Translations for the ActiveRecord error_messages_for helper</h4>

+<div class="para"><p>If you are using the ActiveRecord error_messages_for helper you will want to add translations for it.</p></div>

+<div class="para"><p>Rails ships with the following translations:</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: #FF0000">"en-US"</span><span style="color: #990000">:</span>

+  activerecord<span style="color: #990000">:</span>

+    errors<span style="color: #990000">:</span>

+      template<span style="color: #990000">:</span>

+        header<span style="color: #990000">:</span>

+          one<span style="color: #990000">:</span>   <span style="color: #FF0000">"1 error prohibited this {{model}} from being saved"</span>

+          other<span style="color: #990000">:</span> <span style="color: #FF0000">"{{count}} errors prohibited this {{model}} from being saved"</span>

+        body<span style="color: #990000">:</span> <span style="color: #FF0000">"There were problems with the following fields:"</span>

+</tt></pre></div></div>

+<h3 id="_other_translations_and_localizations">4.2. Other translations and localizations</h3>

+<div class="para"><p>Rails uses fixed strings and other localizations, such as format strings and other format information in a couple of helpers.</p></div>

+<div class="para"><p>TODO list helpers and available keys</p></div>

+</div>

+<h2 id="_customize_your_i18n_setup">5. Customize your I18n setup</h2>

+<div class="sectionbody">

+<h3 id="_using_different_backends">5.1. Using different backends</h3>

+<div class="para"><p>For several reasons the shipped Simple backend only does the "simplest thing that ever could work" <em>for Ruby on Rails</em> (1) &#8230; which means that it is only guaranteed to work for English and, as a side effect, languages that are very similar to English. Also, the simple backend is only capable of reading translations but can not dynamically store them to any format.</p></div>

+<div class="para"><p>That does not mean you're stuck with these limitations though. The Ruby I18n gem makes it very easy to exchange the Simple backend implementation with something else that fits better for your needs. E.g. you could exchange it with Globalize's Static backend:</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>I18n<span style="color: #990000">.</span>backend <span style="color: #990000">=</span> Globalize<span style="color: #990000">::</span>Backend<span style="color: #990000">::</span>Static<span style="color: #990000">.</span>new

+</tt></pre></div></div>

+<div class="para"><p>TODO expand this &#8230;? list some backends and their features?</p></div>

+<h3 id="_using_different_exception_handlers">5.2. Using different exception handlers</h3>

+<div class="para"><p>TODO</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+Explain what exceptions are raised and why we are using exceptions for communication from backend to frontend.

+</p>

+</li>

+<li>

+<p>

+Explain the default behaviour.

+</p>

+</li>

+<li>

+<p>

+Explain the :raise option

+</p>

+</li>

+<li>

+<p>

+Example 1: the Rails #t helper uses a custom exception handler that catches I18n::MissingTranslationData and wraps the message into a span with the CSS class "translation_missing"

+</p>

+</li>

+<li>

+<p>

+Example 2: for tests you might want a handler that just raises all exceptions all the time

+</p>

+</li>

+<li>

+<p>

+Example 3: a handler

+</p>

+</li>

+</ul></div>

+</div>

+<h2 id="_resources">6. Resources</h2>

+<div class="sectionbody">

+</div>

+<h2 id="_footnotes">7. Footnotes</h2>

+<div class="sectionbody">

+<div class="para"><p>(1) One of these reasons is that we don't want to any unnecessary load for applications that do not need any I18n capabilities, so we need to keep the I18n library as simple as possible for English. Another reason is that it is virtually impossible to implement a one-fits-all solution for all problems related to I18n for all existing languages. So a solution that allows us to exchange the entire implementation easily is appropriate anyway. This also makes it much easier to experiment with custom features and extensions.</p></div>

+<div class="para"><p>(2) Other backends might allow or require to use other formats, e.g. a GetText backend might allow to read GetText files.</p></div>

+</div>

+<h2 id="_credits">8. Credits</h2>

+<div class="sectionbody">

+</div>

+<h2 id="_notes">9. NOTES</h2>

+<div class="sectionbody">

+<div class="para"><p>How to contribute?</p></div>

+</div>

+
+		</div>
+	</div>
+</body>
+</html>
diff --git a/railties/doc/guides/html/index.html b/railties/doc/guides/html/index.html
index 991b10c7e8..45e131012e 100644
--- a/railties/doc/guides/html/index.html
+++ b/railties/doc/guides/html/index.html
@@ -338,6 +338,19 @@ of your code.</p></div>
 <div class="sidebar-title"><a href="creating_plugins.html">The Basics of Creating Rails Plugins</a></div>

 <div class="para"><p>This guide covers how to build a plugin to extend the functionality of Rails.</p></div>

 </div></div>

+<div class="sidebarblock">

+<div class="sidebar-content">

+<div class="sidebar-title"><a href="i18n.html">The Rails Internationalization API</a></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/caution.png" alt="Caution" />

+</td>

+<td class="content">still a basic draft</td>

+</tr></table>

+</div>

+<div class="para"><p>This guide introduces you to the basic concepts and features of the Rails I18n API and shows you how to localize your application.</p></div>

+</div></div>

 <div class="para"><p>Authors who have contributed to complete guides are listed <a href="authors.html">here</a>.</p></div>

 <div class="para"><p>This work is licensed under a <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/">Creative Commons Attribution-Noncommercial-Share Alike 3.0  License</a></p></div>

 </div>

diff --git a/railties/doc/guides/html/migrations.html b/railties/doc/guides/html/migrations.html
index 8b580d8086..9f7fa28daf 100644
--- a/railties/doc/guides/html/migrations.html
+++ b/railties/doc/guides/html/migrations.html
@@ -279,7 +279,7 @@ ul#navMain {
 				<h1>Migrations</h1>
 			<div id="preamble">

 <div class="sectionbody">

-<div class="para"><p>Migrations are a convenient way for you to alter your database in a structured and organised manner. You could edit fragments of SQL by hand but you would then be responsible for telling other developers that they need to go and run it. You'd also have to keep track of which changes need to be run against the production machines next time you deploy. Active Record tracks which migrations have already been run so all you have to do is update your source and run <tt>rake db:migrate</tt>. Active Record will work out which migrations should be run.</p></div>

+<div class="para"><p>Migrations are a convenient way for you to alter your database in a structured and organised manner. You could edit fragments of SQL by hand but you would then be responsible for telling other developers that they need to go and run it. You'd also have to keep track of which changes need to be run against the production machines next time you deploy. Active Record tracks which migrations have already been run so all you have to do is update your source and run <tt>rake db:migrate</tt>. Active Record will work out which migrations should be run. It will also update your db/schema.rb file to match the structure of your database.</p></div>

 <div class="para"><p>Migrations also allow you to describe these transformations using Ruby. The great thing about this is that (like most of Active Record's functionality) it is database independent: you don't need to worry about the precise syntax of CREATE TABLE any more that you worry about variations on SELECT * (you can drop down to raw SQL for database specific features). For example you could use SQLite3 in development, but MySQL in production.</p></div>

 <div class="para"><p>You'll learn all about migrations including:</p></div>

 <div class="ilist"><ul>

@@ -699,6 +699,7 @@ displayed saying that it can't be done.</p></div>
 <h2 id="_running_migrations">4. Running Migrations</h2>

 <div class="sectionbody">

 <div class="para"><p>Rails provides a set of rake tasks to work with migrations which boils down to running certain sets of migrations. The very first migration related rake task you use will probably be <tt>db:migrate</tt>. In its most basic form it just runs the <tt>up</tt> method for all the migrations that have not yet been run. If there are no such migrations it exits.</p></div>

+<div class="para"><p>Note that running the <tt>db:migrate</tt> also invokes the <tt>db:schema:dump</tt> task, which will update your db/schema.rb file to match the structure of your database.</p></div>

 <div class="para"><p>If you specify a target version, Active Record will run the required migrations (up or down) until it has reached the specified version. The

 version is the numerical prefix on the migration's filename. For example to migrate to version 20080906120000 run</p></div>

 <div class="listingblock">

diff --git a/railties/doc/guides/html/routing_outside_in.html b/railties/doc/guides/html/routing_outside_in.html
index 8add4e7789..1d313b619f 100644
--- a/railties/doc/guides/html/routing_outside_in.html
+++ b/railties/doc/guides/html/routing_outside_in.html
@@ -1448,13 +1448,13 @@ http://www.gnu.org/software/src-highlite -->
 <pre><tt>map<span style="color: #990000">.</span>resources <span style="color: #990000">:</span>photos<span style="color: #990000">,</span> <span style="color: #990000">:</span>except <span style="color: #990000">=&gt;</span> <span style="color: #990000">:</span>destroy

 </tt></pre></div></div>

 <div class="para"><p>In this case, all of the normal routes except the route for <tt>destroy</tt> (a <tt>DELETE</tt> request to <tt>/photos/<em>id</em></tt>) will be generated.</p></div>

-<div class="para"><p>In addition to an action or a list of actions, you can also supply the special symbols <tt>:all</tt> or <tt>:none</tt> to the <tt>:only</tt> and <tt>:accept</tt> options.</p></div>

+<div class="para"><p>In addition to an action or a list of actions, you can also supply the special symbols <tt>:all</tt> or <tt>:none</tt> to the <tt>:only</tt> and <tt>:except</tt> options.</p></div>

 <div class="admonitionblock">

 <table><tr>

 <td class="icon">

 <img src="./images/icons/tip.png" alt="Tip" />

 </td>

-<td class="content">If your application has many RESTful routes, using <tt>:only</tt> and <tt>:accept</tt> to generate only the routes that you actually need can cut down on memory use and speed up the routing process.</td>

+<td class="content">If your application has many RESTful routes, using <tt>:only</tt> and <tt>:except</tt> to generate only the routes that you actually need can cut down on memory use and speed up the routing process.</td>

 </tr></table>

 </div>

 <h3 id="_nested_resources">3.8. Nested Resources</h3>

diff --git a/railties/doc/guides/html/testing_rails_applications.html b/railties/doc/guides/html/testing_rails_applications.html
index 666d1dff85..b8a99767ee 100644
--- a/railties/doc/guides/html/testing_rails_applications.html
+++ b/railties/doc/guides/html/testing_rails_applications.html
@@ -202,7 +202,7 @@ ul#navMain {
 					<a href="#_why_write_tests_for_your_rails_applications">Why Write Tests for your Rails Applications?</a>
 					</li>
 					<li>
-					<a href="#_before_you_start_writing_tests">Before you Start Writing Tests</a>
+					<a href="#_introduction_to_testing">Introduction to Testing</a>
 						<ul>
 						
 							<li><a href="#_the_3_environments">The 3 Environments</a></li>
@@ -214,9 +214,11 @@ ul#navMain {
 						</ul>
 					</li>
 					<li>
-					<a href="#_unit_testing_your_models">Unit Testing Your Models</a>
+					<a href="#_unit_testing_your_models">Unit Testing your Models</a>
 						<ul>
 						
+							<li><a href="#_preparing_you_application_for_testing">Preparing you Application for Testing</a></li>
+						
 							<li><a href="#_running_tests">Running Tests</a></li>
 						
 							<li><a href="#_what_to_include_in_your_unit_tests">What to Include in Your Unit Tests</a></li>
@@ -256,6 +258,18 @@ ul#navMain {
 						</ul>
 					</li>
 					<li>
+					<a href="#_rake_tasks_for_running_your_tests">Rake Tasks for Running your Tests</a>
+					</li>
+					<li>
+					<a href="#_brief_note_about_test_unit">Brief Note About Test::Unit</a>
+					</li>
+					<li>
+					<a href="#_setup_and_teardown">Setup and Teardown</a>
+					</li>
+					<li>
+					<a href="#_testing_routes">Testing Routes</a>
+					</li>
+					<li>
 					<a href="#_testing_your_mailers">Testing Your Mailers</a>
 						<ul>
 						
@@ -268,9 +282,6 @@ ul#navMain {
 						</ul>
 					</li>
 					<li>
-					<a href="#_rake_tasks_for_testing">Rake Tasks for Testing</a>
-					</li>
-					<li>
 					<a href="#_other_testing_approaches">Other Testing Approaches</a>
 					</li>
 					<li>
@@ -309,12 +320,7 @@ Identify other popular testing approaches and plugins
 <div class="ilist"><ul>

 <li>

 <p>

-Because Ruby code that you write in your Rails application is interpreted, you may only find that it's broken when you actually run your application server and use it through the browser. Writing tests is a clean way of running through your code in advance and catching syntactical and logic errors.

-</p>

-</li>

-<li>

-<p>

-Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

+Rails makes it super easy to write your tests. It starts by producing skeleton test code in background while you are creating your models and controllers.

 </p>

 </li>

 <li>

@@ -324,16 +330,16 @@ By simply running your Rails tests you can ensure your code adheres to the desir
 </li>

 <li>

 <p>

-Rails makes it super easy to write your tests. It starts by producing skeleton test code in background while you are creating your models and controllers.

+Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

 </p>

 </li>

 </ul></div>

 </div>

-<h2 id="_before_you_start_writing_tests">2. Before you Start Writing Tests</h2>

+<h2 id="_introduction_to_testing">2. Introduction to Testing</h2>

 <div class="sectionbody">

-<div class="para"><p>Just about every Rails application interacts heavily with a database - and, as a result, your tests will need a database to interact with as well. To write efficient tests, you'll need to understand how to set up this database and populate it with sample data.</p></div>

+<div class="para"><p>Testing support was woven into the Rails fabric from the beginning. It wasn't an "oh! let's bolt on support for running tests because they're new and cool" epiphany. Just about every Rails application interacts heavily with a database - and, as a result, your tests will need a database to interact with as well. To write efficient tests, you'll need to understand how to set up this database and populate it with sample data.</p></div>

 <h3 id="_the_3_environments">2.1. The 3 Environments</h3>

-<div class="para"><p>Testing support was woven into the Rails fabric from the beginning. It wasn't an "oh! let's bolt on support for running tests because they're new and cool" epiphany. One of the consequences of this design decision is that every Rails application you build has 3 sides: a side for production, a side for development, and a side for testing.</p></div>

+<div class="para"><p>Every Rails application you build has 3 sides: a side for production, a side for development, and a side for testing.</p></div>

 <div class="para"><p>One place you'll find this distinction is in the <tt>config/database.yml</tt> file. This YAML configuration file has 3 different sections defining 3 unique database setups:</p></div>

 <div class="ilist"><ul>

 <li>

@@ -370,9 +376,9 @@ fixtures<span style="color: #990000">/</span>       functional<span style="color
 <h3 id="_the_low_down_on_fixtures">2.3. The Low-Down on Fixtures</h3>

 <div class="para"><p>For good tests, you'll need to give some thought to setting up test data. In Rails, you can handle this by defining and customizing fixtures.</p></div>

 <h4 id="_what_are_fixtures">2.3.1. What Are Fixtures?</h4>

-<div class="para"><p><em>Fixtures</em> is a fancy word for sample data. Fixtures allow you to populate your testing database with predefined data before your tests run. Fixtures are database independent and assume one of two formats: <strong>YAML</strong> or <strong>CSV</strong>.</p></div>

+<div class="para"><p><em>Fixtures</em> is a fancy word for sample data. Fixtures allow you to populate your testing database with predefined data before your tests run. Fixtures are database independent and assume one of two formats: <strong>YAML</strong> or <strong>CSV</strong>. In this guide we will use <strong>YAML</strong> which is the preferred format.</p></div>

 <div class="para"><p>You'll find fixtures under your <tt>test/fixtures</tt> directory. When you run <tt>script/generate model</tt> to create a new model, fixture stubs will be automatically created and placed in this directory.</p></div>

-<h4 id="_yaml_the_camel_is_a_mammal_with_enamel">2.3.2. YAML the Camel is a Mammal with Enamel</h4>

+<h4 id="_yaml">2.3.2. YAML</h4>

 <div class="para"><p>YAML-formatted fixtures are a very human-friendly way to describe your sample data. These types of fixtures have the <strong>.yml</strong> file extension (as in <tt>users.yml</tt>).</p></div>

 <div class="para"><p>Here's a sample YAML fixture file:</p></div>

 <div class="listingblock">

@@ -382,78 +388,18 @@ http://www.lorenzobettini.it
 http://www.gnu.org/software/src-highlite -->

 <pre><tt><span style="font-style: italic"><span style="color: #9A1900"># low &amp; behold!  I am a YAML comment!</span></span>

 david<span style="color: #990000">:</span>

- id<span style="color: #990000">:</span> <span style="color: #993399">1</span>

  name<span style="color: #990000">:</span> David Heinemeier Hansson

  birthday<span style="color: #990000">:</span> <span style="color: #993399">1979</span><span style="color: #990000">-</span><span style="color: #993399">10</span><span style="color: #990000">-</span><span style="color: #993399">15</span>

  profession<span style="color: #990000">:</span> Systems development

 

 steve<span style="color: #990000">:</span>

- id<span style="color: #990000">:</span> <span style="color: #993399">2</span>

  name<span style="color: #990000">:</span> Steve Ross Kellock

  birthday<span style="color: #990000">:</span> <span style="color: #993399">1974</span><span style="color: #990000">-</span><span style="color: #993399">09</span><span style="color: #990000">-</span><span style="color: #993399">27</span>

  profession<span style="color: #990000">:</span> guy with keyboard

 </tt></pre></div></div>

 <div class="para"><p>Each fixture is given a name followed by an indented list of colon-separated key/value pairs. Records are separated by a blank space. You can place comments in a fixture file by using the # character in the first column.</p></div>

-<h4 id="_comma_seperated">2.3.3. Comma Seperated</h4>

-<div class="para"><p>Fixtures can also be described using the all-too-familiar comma-separated value (CSV) file format. These files, just like YAML fixtures, are placed in the <em>test/fixtures</em> directory, but these end with the <tt>.csv</tt> file extension (as in <tt>celebrity_holiday_figures.csv</tt>).</p></div>

-<div class="para"><p>A CSV fixture looks like this:</p></div>

-<div class="listingblock">

-<div class="content">

-<pre><tt>id, username, password, stretchable, comments

-1, sclaus, ihatekids, false, I like to say ""Ho! Ho! Ho!""

-2, ebunny, ihateeggs, true, Hoppity hop y'all

-3, tfairy, ilovecavities, true, "Pull your teeth, I will"</tt></pre>

-</div></div>

-<div class="para"><p>The first line is the header. It is a comma-separated list of fields. The rest of the file is the payload: 1 record per line. A few notes about this format:</p></div>

-<div class="ilist"><ul>

-<li>

-<p>

-Leading and trailing spaces are trimmed from each value when it is imported

-</p>

-</li>

-<li>

-<p>

-If you use a comma as data, the cell must be encased in quotes

-</p>

-</li>

-<li>

-<p>

-If you use a quote as data, you must escape it with a 2nd quote

-</p>

-</li>

-<li>

-<p>

-Don't use blank lines

-</p>

-</li>

-<li>

-<p>

-Nulls can be defined by including no data between a pair of commas

-</p>

-</li>

-</ul></div>

-<div class="para"><p>Unlike the YAML format where you give each record in a fixture a name, CSV fixture names are automatically generated. They follow a pattern of "model-name-counter". In the above example, you would have:</p></div>

-<div class="ilist"><ul>

-<li>

-<p>

-<tt>celebrity-holiday-figures-1</tt>

-</p>

-</li>

-<li>

-<p>

-<tt>celebrity-holiday-figures-2</tt>

-</p>

-</li>

-<li>

-<p>

-<tt>celebrity-holiday-figures-3</tt>

-</p>

-</li>

-</ul></div>

-<div class="para"><p>The CSV format is great to use if you have existing data in a spreadsheet or database and you are able to save it (or export it) as a CSV.</p></div>

-<h4 id="_erb_in_it_up">2.3.4. ERb'in It Up</h4>

+<h4 id="_erb_in_it_up">2.3.3. ERb'in It Up</h4>

 <div class="para"><p>ERb allows you embed ruby code within templates. Both the YAML and CSV fixture formats are pre-processed with ERb when you load fixtures. This allows you to use Ruby to help you generate some sample data.</p></div>

-<div class="para"><p>I'll demonstrate with a YAML file:</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -461,16 +407,16 @@ http://www.lorenzobettini.it
 http://www.gnu.org/software/src-highlite -->

 <pre><tt><span style="color: #FF0000">&lt;% earth_size = 20 -%&gt;</span>

 mercury<span style="color: #990000">:</span>

-  id<span style="color: #990000">:</span> <span style="color: #993399">1</span>

   size<span style="color: #990000">:</span> <span style="color: #FF0000">&lt;%= earth_size / 50 %&gt;</span>

+  brightest_on<span style="color: #990000">:</span> <span style="color: #FF0000">&lt;%= 113.days.ago.to_s(:db) %&gt;</span>

 

 venus<span style="color: #990000">:</span>

-  id<span style="color: #990000">:</span> <span style="color: #993399">2</span>

   size<span style="color: #990000">:</span> <span style="color: #FF0000">&lt;%= earth_size / 2 %&gt;</span>

+  brightest_on<span style="color: #990000">:</span> <span style="color: #FF0000">&lt;%= 67.days.ago.to_s(:db) %&gt;</span>

 

 mars<span style="color: #990000">:</span>

-  id<span style="color: #990000">:</span> <span style="color: #993399">3</span>

   size<span style="color: #990000">:</span> <span style="color: #FF0000">&lt;%= earth_size - 69 %&gt;</span>

+  brightest_on<span style="color: #990000">:</span> <span style="color: #FF0000">&lt;%= 13.days.from_now.to_s(:db) %&gt;</span>

 </tt></pre></div></div>

 <div class="para"><p>Anything encased within the</p></div>

 <div class="listingblock">

@@ -480,8 +426,8 @@ http://www.lorenzobettini.it
 http://www.gnu.org/software/src-highlite -->

 <pre><tt><span style="color: #FF0000">&lt;% %&gt;</span>

 </tt></pre></div></div>

-<div class="para"><p>tag is considered Ruby code. When this fixture is loaded, the <tt>size</tt> attribute of the three records will be set to 20/50, 20/2, and 20-69 respectively.</p></div>

-<h4 id="_fixtures_in_action">2.3.5. Fixtures in Action</h4>

+<div class="para"><p>tag is considered Ruby code. When this fixture is loaded, the <tt>size</tt> attribute of the three records will be set to 20/50, 20/2, and 20-69 respectively. The <tt>brightest_on</tt> attribute will also be evaluated and formatted by Rails to be compatible with the database.</p></div>

+<h4 id="_fixtures_in_action">2.3.4. Fixtures in Action</h4>

 <div class="para"><p>Rails by default automatically loads all fixtures from the <em>test/fixtures</em> folder for your unit and functional test. Loading involves three steps:</p></div>

 <div class="ilist"><ul>

 <li>

@@ -500,7 +446,7 @@ Dump the fixture data into a variable in case you want to access it directly
 </p>

 </li>

 </ul></div>

-<h4 id="_hashes_with_special_powers">2.3.6. Hashes with Special Powers</h4>

+<h4 id="_hashes_with_special_powers">2.3.5. Hashes with Special Powers</h4>

 <div class="para"><p>Fixtures are basically Hash objects. As mentioned in point #3 above, you can access the hash object directly because it is automatically setup as a local variable of the test case. For example:</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

@@ -513,8 +459,7 @@ users<span style="color: #990000">(:</span>david<span style="color: #990000">)</
 <span style="font-style: italic"><span style="color: #9A1900"># this will return the property for david called id</span></span>

 users<span style="color: #990000">(:</span>david<span style="color: #990000">).</span>id

 </tt></pre></div></div>

-<div class="para"><p>But, by there's another side to fixtures&#8230; at night, if the moon is full and the wind completely still, fixtures can also transform themselves into the form of the original class!</p></div>

-<div class="para"><p>Now you can get at the methods only available to that class.</p></div>

+<div class="para"><p>Fixtures can also transform themselves into the form of the original class. Thus, you can get at the methods only available to that class.</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -527,13 +472,22 @@ david <span style="color: #990000">=</span> users<span style="color: #990000">(:
 email<span style="color: #990000">(</span>david<span style="color: #990000">.</span>girlfriend<span style="color: #990000">.</span>email<span style="color: #990000">,</span> david<span style="color: #990000">.</span>location_tonight<span style="color: #990000">)</span>

 </tt></pre></div></div>

 </div>

-<h2 id="_unit_testing_your_models">3. Unit Testing Your Models</h2>

+<h2 id="_unit_testing_your_models">3. Unit Testing your Models</h2>

 <div class="sectionbody">

 <div class="para"><p>In Rails, unit tests are what you write to test your models.</p></div>

-<div class="para"><p>When you create a model using <tt>script/generate</tt>, among other things it creates a test stub in the <tt>test/unit</tt> folder, as well as a fixture for the model:</p></div>

+<div class="para"><p>For this guide we will be using Rails <em>scaffolding</em>. It will create the model, a migration, controller and views for the new resource in a single operation. It will also create a full test suite following Rails best practises. I will be using examples from this generated code and would be supplementing it with additional examples where necessary.</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content">For more information on Rails <em>scaffolding</em>, refer to <a href="../getting_started_with_rails.html">Getting Started with Rails</a></td>

+</tr></table>

+</div>

+<div class="para"><p>When you use <tt>script/generate scaffold</tt>, for a resource among other things it creates a test stub in the <tt>test/unit</tt> folder:</p></div>

 <div class="listingblock">

 <div class="content">

-<pre><tt>$ script/generate model Post

+<pre><tt>$ script/generate scaffold post title:string body:text

 ...

 create  app/models/post.rb

 create  test/unit/post_test.rb

@@ -611,7 +565,46 @@ is the user's password greater than 5 characters?
 </li>

 </ul></div>

 <div class="para"><p>Every test contains one or more assertions. Only when all the assertions are successful the test passes.</p></div>

-<h3 id="_running_tests">3.1. Running Tests</h3>

+<h3 id="_preparing_you_application_for_testing">3.1. Preparing you Application for Testing</h3>

+<div class="para"><p>Before you can run your tests you need to ensure that the test database structure is current. For this you can use the following rake commands:</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>$ rake db<span style="color: #990000">:</span>migrate

+<span style="color: #990000">...</span>

+$ rake db<span style="color: #990000">:</span><span style="font-weight: bold"><span style="color: #0000FF">test</span></span><span style="color: #990000">:</span>load

+</tt></pre></div></div>

+<div class="para"><p>Above <tt>rake db:migrate</tt> runs any pending migrations on the <em>developemnt</em> environment and updates <tt>db/schema.rb</tt>. <tt>rake db:test:load</tt> recreates the test database from the current db/schema.rb. On subsequent attempts it is a good to first run <tt>db:test:prepare</tt> as it first checks for pending migrations and warns you appropriately.</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content"><tt>db:test:prepare</tt> will fail with an error if db/schema.rb doesn't exists.</td>

+</tr></table>

+</div>

+<h4 id="_rake_tasks_for_preparing_you_application_for_testing">3.1.1. Rake Tasks for Preparing you Application for Testing ==</h4>

+<div class="para"><p>--------------------------------`----------------------------------------------------

+Tasks                           Description</p></div>

+<div class="listingblock">

+<div class="content">

+<pre><tt>+rake db:test:clone+            Recreate the test database from the current environment's database schema

++rake db:test:clone_structure+  Recreate the test databases from the development structure

++rake db:test:load+             Recreate the test database from the current +schema.rb+

++rake db:test:prepare+          Check for pending migrations and load the test schema

++rake db:test:purge+            Empty the test database.</tt></pre>

+</div></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/tip.png" alt="Tip" />

+</td>

+<td class="content">You can see all these rake tasks and their descriptions by running <tt>rake &#8212;tasks &#8212;describe</tt></td>

+</tr></table>

+</div>

+<h3 id="_running_tests">3.2. Running Tests</h3>

 <div class="para"><p>Running a test is as simple as invoking the file containing the test cases through Ruby:</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

@@ -642,34 +635,34 @@ Finished in 0.023513 seconds.
 1 tests, 1 assertions, 0 failures, 0 errors</tt></pre>

 </div></div>

 <div class="para"><p>The <tt>.</tt> (dot) above indicates a passing test. When a test fails you see an <tt>F</tt>; when a test throws an error you see an <tt>E</tt> in its place. The last line of the output is the summary.</p></div>

-<div class="para"><p>To see how a test failure is reported, you can add a failing test to the <tt>post_test.rb</tt> test case:</p></div>

+<div class="para"><p>To see how a test failure is reported, you can add a failing test to the <tt>post_test.rb</tt> test case.</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">def</span></span> test_should_have_atleast_one_post

-  post <span style="color: #990000">=</span> Post<span style="color: #990000">.</span>find<span style="color: #990000">(:</span>first<span style="color: #990000">)</span>

-  assert_not_nil post

+<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">def</span></span> test_should_not_save_post_without_title

+  post <span style="color: #990000">=</span> Post<span style="color: #990000">.</span>new

+  assert <span style="color: #990000">!</span>post<span style="color: #990000">.</span>save

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

-<div class="para"><p>If you haven't added any data to the test fixture for posts, this test will fail. You can see this by running it:</p></div>

+<div class="para"><p>Let us run this newly added test.</p></div>

 <div class="listingblock">

 <div class="content">

-<pre><tt>$ ruby unit/post_test.rb

+<pre><tt>$ ruby unit/post_test.rb -n test_should_not_save_post_without_title

 Loaded suite unit/post_test

 Started

-F.

-Finished in 0.027274 seconds.

+F

+Finished in 0.197094 seconds.

 

   1) Failure:

-test_should_have_atleast_one_post(PostTest)

-    [unit/post_test.rb:12:in `test_should_have_atleast_one_post'

+test_should_not_save_post_without_title(PostTest)

+    [unit/post_test.rb:11:in `test_should_not_save_post_without_title'

      /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `__send__'

      /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `run']:

-&lt;nil&gt; expected to not be nil.

+&lt;false&gt; is not true.

 

-2 tests, 2 assertions, 1 failures, 0 errors</tt></pre>

+1 tests, 1 assertions, 1 failures, 0 errors</tt></pre>

 </div></div>

 <div class="para"><p>In the output, <tt>F</tt> denotes a failure. You can see the corresponding trace shown under <tt>1)</tt> along with the name of the failing test. The next few lines contain the stack trace followed by a message which mentions the actual value and the expected value by the assertion. The default assertion messages provide just enough information to help pinpoint the error. To make the assertion failure message more readable every assertion provides an optional message parameter, as shown here:</p></div>

 <div class="listingblock">

@@ -677,30 +670,60 @@ test_should_have_atleast_one_post(PostTest)
 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">def</span></span> test_should_have_atleast_one_post

-  post <span style="color: #990000">=</span> Post<span style="color: #990000">.</span>find<span style="color: #990000">(:</span>first<span style="color: #990000">)</span>

-  assert_not_nil post<span style="color: #990000">,</span> <span style="color: #FF0000">"Should not be nil as Posts table should have atleast one post"</span>

+<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">def</span></span> test_should_not_save_post_without_title

+  post <span style="color: #990000">=</span> Post<span style="color: #990000">.</span>new

+  assert <span style="color: #990000">!</span>post<span style="color: #990000">.</span>save<span style="color: #990000">,</span> <span style="color: #FF0000">"Saved the post without a title"</span>

 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

 <div class="para"><p>Running this test shows the friendlier assertion message:</p></div>

 <div class="listingblock">

 <div class="content">

-<pre><tt>$ ruby unit/post_test.rb

+<pre><tt>$ ruby unit/post_test.rb -n test_should_not_save_post_without_title

 Loaded suite unit/post_test

 Started

-F.

-Finished in 0.024727 seconds.

+F

+Finished in 0.198093 seconds.

 

   1) Failure:

-test_should_have_atleast_one_post(PostTest)

-    [unit/post_test.rb:11:in `test_should_have_atleast_one_post'

+test_should_not_save_post_without_title(PostTest)

+    [unit/post_test.rb:11:in `test_should_not_save_post_without_title'

      /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `__send__'

      /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `run']:

-Should not be nil as Posts table should have atleast one post.

-&lt;nil&gt; expected to not be nil.

+Saved the post without a title.

+&lt;false&gt; is not true.

+

+1 tests, 1 assertions, 1 failures, 0 errors</tt></pre>

+</div></div>

+<div class="para"><p>Now to get this test to pass we can add a model level validation for the <em>title</em> field.</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> Post <span style="color: #990000">&lt;</span> ActiveRecord<span style="color: #990000">::</span>Base

+  validates_presence_of <span style="color: #990000">:</span>title

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+</tt></pre></div></div>

+<div class="para"><p>Now the test should pass. Let us verify by running the test again:</p></div>

+<div class="listingblock">

+<div class="content">

+<pre><tt>$ ruby unit/post_test.rb -n test_should_not_save_post_without_title

+Loaded suite unit/post_test

+Started

+.

+Finished in 0.193608 seconds.

 

-2 tests, 2 assertions, 1 failures, 0 errors</tt></pre>

+1 tests, 1 assertions, 0 failures, 0 errors</tt></pre>

 </div></div>

+<div class="para"><p>Now if you noticed we first wrote a test which fails for a desired functionality, then we wrote some code which adds the functionality and finally we ensured that our test passes. This approach to software development is referred to as <em>Test-Driven Development</em> (TDD).</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/tip.png" alt="Tip" />

+</td>

+<td class="content">Many Rails developers practice <em>Test-Driven Development</em> (TDD). This is an excellent way to build up a test suite that exercises every part of your application. TDD is beyond the scope of this guide, but one place to start is with <a href="http://andrzejonsoftware.blogspot.com/2007/05/15-tdd-steps-to-create-rails.html">15 TDD steps to create a Rails application</a>.</td>

+</tr></table>

+</div>

 <div class="para"><p>To see how an error gets reported, here's a test containing an error:</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

@@ -716,29 +739,21 @@ http://www.gnu.org/software/src-highlite -->
 <div class="para"><p>Now you can see even more output in the console from running the tests:</p></div>

 <div class="listingblock">

 <div class="content">

-<pre><tt>$ ruby unit/post_test.rb

+<pre><tt>$ ruby unit/post_test.rb -n test_should_report_error

 Loaded suite unit/post_test

 Started

-FE.

-Finished in 0.108389 seconds.

+E

+Finished in 0.195757 seconds.

 

-  1) Failure:

-test_should_have_atleast_one_post(PostTest)

-    [unit/post_test.rb:11:in `test_should_have_atleast_one_post'

-     /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `__send__'

-     /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `run']:

-Should not be nil as Posts table should have atleast one post.

-&lt;nil&gt; expected to not be nil.

-

-  2) Error:

+  1) Error:

 test_should_report_error(PostTest):

-NameError: undefined local variable or method `some_undefined_variable' for #&lt;PostTest:0x304a7b0&gt;

+NameError: undefined local variable or method `some_undefined_variable' for #&lt;PostTest:0x2cc9de8&gt;

     /opt/local/lib/ruby/gems/1.8/gems/actionpack-2.1.1/lib/action_controller/test_process.rb:467:in `method_missing'

-    unit/post_test.rb:15:in `test_should_report_error'

+    unit/post_test.rb:16:in `test_should_report_error'

     /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `__send__'

     /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `run'

 

-3 tests, 2 assertions, 1 failures, 1 errors</tt></pre>

+1 tests, 0 assertions, 0 failures, 1 errors</tt></pre>

 </div></div>

 <div class="para"><p>Notice the <em>E</em> in the output. It denotes a test with error.</p></div>

 <div class="admonitionblock">

@@ -749,17 +764,9 @@ NameError: undefined local variable or method `some_undefined_variable' for #&lt
 <td class="content">The execution of each test method stops as soon as any error or a assertion failure is encountered, and the test suite continues with the next method. All test methods are executed in alphabetical order.</td>

 </tr></table>

 </div>

-<h3 id="_what_to_include_in_your_unit_tests">3.2. What to Include in Your Unit Tests</h3>

+<h3 id="_what_to_include_in_your_unit_tests">3.3. What to Include in Your Unit Tests</h3>

 <div class="para"><p>Ideally you would like to include a test for everything which could possibly break. It's a good practice to have at least one test for each of your validations and at least one test for every method in your model.</p></div>

-<div class="admonitionblock">

-<table><tr>

-<td class="icon">

-<img src="./images/icons/tip.png" alt="Tip" />

-</td>

-<td class="content">Many Rails developers practice <em>test-driven development</em> (TDD), in which the tests are written <em>before</em> the code that they are testing. This is an excellent way to build up a test suite that exercises every part of your application. TDD is beyond the scope of this guide, but one place to start is with <a href="http://andrzejonsoftware.blogspot.com/2007/05/15-tdd-steps-to-create-rails.html">15 TDD steps to create a Rails application</a>.</td>

-</tr></table>

-</div>

-<h3 id="_assertions_available">3.3. Assertions Available</h3>

+<h3 id="_assertions_available">3.4. Assertions Available</h3>

 <div class="para"><p>By now you've caught a glimpse of some of the assertions that are available. Assertions are the worker bees of testing. They are the ones that actually perform the checks to ensure that things are going as planned.</p></div>

 <div class="para"><p>There are a bunch of different types of assertions you can use. Here's the complete list of assertions that ship with <tt>test/unit</tt>, the testing library used by Rails. The <tt>[msg]</tt> parameter is an optional string message you can specify to make your test failure messages clearer. It's not required.</p></div>

 <div class="tableblock">

@@ -943,7 +950,7 @@ cellspacing="0" cellpadding="4">
 <td class="content">Creating your own assertions is an advanced topic that we won't cover in this tutorial.</td>

 </tr></table>

 </div>

-<h3 id="_rails_specific_assertions">3.4. Rails Specific Assertions</h3>

+<h3 id="_rails_specific_assertions">3.5. Rails Specific Assertions</h3>

 <div class="para"><p>Rails adds some custom assertions of its own to the <tt>test/unit</tt> framework:</p></div>

 <div class="tableblock">

 <table rules="all"

@@ -1063,34 +1070,8 @@ was the appropriate message displayed to the user in the view
 </p>

 </li>

 </ul></div>

-<div class="para"><p>When you use <tt>script/generate</tt> to create a controller, it automatically creates a functional test for that controller in <tt>test/functional</tt>. For example, if you create a post controller:</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>$ script/generate controller post

-<span style="color: #990000">...</span>

-      create  app/controllers/post_controller<span style="color: #990000">.</span>rb

-      create  test/functional/post_controller_test<span style="color: #990000">.</span>rb

-<span style="color: #990000">...</span>

-</tt></pre></div></div>

-<div class="para"><p>Now if you take a look at the file <tt>posts_controller_test.rb</tt> in the <tt>test/functional</tt> directory, you should see:</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">'test_helper'</span>

-

-<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> PostsControllerTest <span style="color: #990000">&lt;</span> ActionController<span style="color: #990000">::</span>TestCase

-  <span style="font-style: italic"><span style="color: #9A1900"># Replace this with your real tests.</span></span>

-  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> test_truth

-    assert <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>Of course, you need to replace the simple assertion with real testing. Here's a starting example of a functional test:</p></div>

+<div class="para"><p>Now that we have used Rails scaffold generator for our <tt>Post</tt> resource, it has already created the controller code and functional tests. You can take look at the file <tt>posts_controller_test.rb</tt> in the <tt>test/functional</tt> directory.</p></div>

+<div class="para"><p>Let me take you through one such test, <tt>test_should_get_index</tt> from the file <tt>posts_controller_test.rb</tt>.</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

 by Lorenzo Bettini

@@ -1142,6 +1123,29 @@ http://www.lorenzobettini.it
 http://www.gnu.org/software/src-highlite -->

 <pre><tt>get<span style="color: #990000">(:</span>view<span style="color: #990000">,</span> <span style="color: #FF0000">{</span><span style="color: #FF0000">'id'</span> <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'12'</span><span style="color: #FF0000">}</span><span style="color: #990000">,</span> <span style="font-weight: bold"><span style="color: #0000FF">nil</span></span><span style="color: #990000">,</span> <span style="color: #FF0000">{</span><span style="color: #FF0000">'message'</span> <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'booya!'</span><span style="color: #FF0000">}</span><span style="color: #990000">)</span>

 </tt></pre></div></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content">If you try running <tt>test_should_create_post</tt> test from <tt>posts_controller_test.rb</tt> it will fail on account of the newly added model level validation and rightly so.</td>

+</tr></table>

+</div>

+<div class="para"><p>Let us modify <tt>test_should_create_post</tt> test in <tt>posts_controller_test.rb</tt> so that all our test pass:</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">def</span></span> test_should_create_post

+  assert_difference<span style="color: #990000">(</span><span style="color: #FF0000">'Post.count'</span><span style="color: #990000">)</span> <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

+    post <span style="color: #990000">:</span>create<span style="color: #990000">,</span> <span style="color: #990000">:</span>post <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">{</span> <span style="color: #990000">:</span>title <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">'Some title'</span><span style="color: #FF0000">}</span>

+  <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+  assert_redirected_to post_path<span style="color: #990000">(</span>assigns<span style="color: #990000">(:</span>post<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>Now you can try running all the tests and they should pass.</p></div>

 <h3 id="_available_request_types_for_functional_tests">4.2. Available Request Types for Functional Tests</h3>

 <div class="para"><p>If you're familiar with the HTTP protocol, you'll know that <tt>get</tt> is a type of request. There are 5 request types supported in Rails functional tests:</p></div>

 <div class="ilist"><ul>

@@ -1564,10 +1568,159 @@ http://www.gnu.org/software/src-highlite -->
 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

 </div>

-<h2 id="_testing_your_mailers">6. Testing Your Mailers</h2>

+<h2 id="_rake_tasks_for_running_your_tests">6. Rake Tasks for Running your Tests</h2>

+<div class="sectionbody">

+<div class="para"><p>You don't need to set up and run your tests by hand on a test-by-test basis. Rails comes with a number of rake tasks to help in testing. The table below lists all rake tasks that come along in the default Rakefile when you initiate a Rail project.</p></div>

+<div class="para"><p>--------------------------------`----------------------------------------------------

+Tasks                           Description</p></div>

+<div class="listingblock">

+<div class="content">

+<pre><tt>+rake test+                     Runs all unit, functional and integration tests. You can also simply run +rake+ as the _test_ target is the default.

++rake test:units+               Runs all the unit tests from +test/unit+

++rake test:functionals+         Runs all the functional tests from +test/functional+

++rake test:integration+         Runs all the integration tests from +test/integration+

++rake test:recent+              Tests recent changes

++rake test:uncommitted+         Runs all the tests which are uncommitted. Only supports Subversion

++rake test:plugins+             Run all the plugin tests from +vendor/plugins/*/**/test+ (or specify with +PLUGIN=_name_+)</tt></pre>

+</div></div>

+</div>

+<h2 id="_brief_note_about_test_unit">7. Brief Note About Test::Unit</h2>

+<div class="sectionbody">

+<div class="para"><p>Ruby ships with a boat load of libraries. One little gem of a library is <tt>Test::Unit</tt>, a framework for unit testing in Ruby. All the basic assertions discussed above are actually defined in <tt>Test::Unit::Assertions</tt>. The class <tt>ActiveSupport::TestCase</tt> which we have been using in our unit and functional tests extends <tt>Test::Unit::TestCase</tt> that it is how we can use all the basic assertions in our tests.</p></div>

+<div class="admonitionblock">

+<table><tr>

+<td class="icon">

+<img src="./images/icons/note.png" alt="Note" />

+</td>

+<td class="content">For more information on <tt>Test::Unit</tt>, refer to <a href="http://ruby-doc.org/stdlib/libdoc/test/unit/rdoc/">test/unit Documentation</a></td>

+</tr></table>

+</div>

+</div>

+<h2 id="_setup_and_teardown">8. Setup and Teardown</h2>

+<div class="sectionbody">

+<div class="para"><p>If you would like to run a block of code before the start of each test and another block of code after the end of each test you have two special callbacks for your rescue. Let's take note of this by looking at an example for our functional test in <tt>Posts</tt> controller:</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">'test_helper'</span>

+

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> PostsControllerTest <span style="color: #990000">&lt;</span> ActionController<span style="color: #990000">::</span>TestCase

+

+  <span style="font-style: italic"><span style="color: #9A1900"># called before every single test</span></span>

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> setup

+    <span style="color: #009900">@post</span> <span style="color: #990000">=</span> posts<span style="color: #990000">(:</span>one<span style="color: #990000">)</span>

+  <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+  <span style="font-style: italic"><span style="color: #9A1900"># called after every single test</span></span>

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> teardown

+    <span style="font-style: italic"><span style="color: #9A1900"># as we are re-initializing @post before every test</span></span>

+    <span style="font-style: italic"><span style="color: #9A1900"># setting it to nil here is not essential but I hope</span></span>

+    <span style="font-style: italic"><span style="color: #9A1900"># you understand how you can use the teardown method</span></span>

+    <span style="color: #009900">@post</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #0000FF">nil</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_should_show_post

+    get <span style="color: #990000">:</span>show<span style="color: #990000">,</span> <span style="color: #990000">:</span>id <span style="color: #990000">=&gt;</span> <span style="color: #009900">@post</span><span style="color: #990000">.</span>id

+    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">def</span></span> test_should_destroy_post

+    assert_difference<span style="color: #990000">(</span><span style="color: #FF0000">'Post.count'</span><span style="color: #990000">,</span> <span style="color: #990000">-</span><span style="color: #993399">1</span><span style="color: #990000">)</span> <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

+      delete <span style="color: #990000">:</span>destroy<span style="color: #990000">,</span> <span style="color: #990000">:</span>id <span style="color: #990000">=&gt;</span> <span style="color: #009900">@post</span><span style="color: #990000">.</span>id

+    <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+    assert_redirected_to posts_path

+  <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>Above, the <tt>setup</tt> method is called before each test and so <tt>@post</tt> is available for each of the tests. Rails implements <tt>setup</tt> and <tt>teardown</tt> as ActiveSupport::Callbacks. Which essentially means you need not only use <tt>setup</tt> and <tt>teardown</tt> as methods in your tests. You could specify them by using:</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+a block

+</p>

+</li>

+<li>

+<p>

+a method (like in the earlier example)

+</p>

+</li>

+<li>

+<p>

+a method name as a symbol

+</p>

+</li>

+<li>

+<p>

+a lambda

+</p>

+</li>

+</ul></div>

+<div class="para"><p>Let's see the earlier example by specifying <tt>setup</tt> callback by specifying a method name as a symbol:</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">'../test_helper'</span>

+

+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> PostsControllerTest <span style="color: #990000">&lt;</span> ActionController<span style="color: #990000">::</span>TestCase

+

+  <span style="font-style: italic"><span style="color: #9A1900"># called before every single test</span></span>

+  setup <span style="color: #990000">:</span>initialize_post

+

+  <span style="font-style: italic"><span style="color: #9A1900"># called after every single test</span></span>

+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> teardown

+    <span style="color: #009900">@post</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #0000FF">nil</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_should_show_post

+    get <span style="color: #990000">:</span>show<span style="color: #990000">,</span> <span style="color: #990000">:</span>id <span style="color: #990000">=&gt;</span> <span style="color: #009900">@post</span><span style="color: #990000">.</span>id

+    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">def</span></span> test_should_update_post

+    put <span style="color: #990000">:</span>update<span style="color: #990000">,</span> <span style="color: #990000">:</span>id <span style="color: #990000">=&gt;</span> <span style="color: #009900">@post</span><span style="color: #990000">.</span>id<span style="color: #990000">,</span> <span style="color: #990000">:</span>post <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">{</span> <span style="color: #FF0000">}</span>

+    assert_redirected_to post_path<span style="color: #990000">(</span>assigns<span style="color: #990000">(:</span>post<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_should_destroy_post

+    assert_difference<span style="color: #990000">(</span><span style="color: #FF0000">'Post.count'</span><span style="color: #990000">,</span> <span style="color: #990000">-</span><span style="color: #993399">1</span><span style="color: #990000">)</span> <span style="font-weight: bold"><span style="color: #0000FF">do</span></span>

+      delete <span style="color: #990000">:</span>destroy<span style="color: #990000">,</span> <span style="color: #990000">:</span>id <span style="color: #990000">=&gt;</span> <span style="color: #009900">@post</span><span style="color: #990000">.</span>id

+    <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+

+    assert_redirected_to posts_path

+  <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> initialize_post

+    <span style="color: #009900">@post</span> <span style="color: #990000">=</span> posts<span style="color: #990000">(:</span>one<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>

+<h2 id="_testing_routes">9. Testing Routes</h2>

+<div class="sectionbody">

+<div class="para"><p>Like everything else in you Rails application, it's recommended to test you routes. An example test for a route in the default <tt>show</tt> action of <tt>Posts</tt> controller above should look like:</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">def</span></span> test_should_route_to_post

+  assert_routing <span style="color: #FF0000">'/posts/1'</span><span style="color: #990000">,</span> <span style="color: #FF0000">{</span> <span style="color: #990000">:</span>controller <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"posts"</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>action <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"show"</span><span style="color: #990000">,</span> <span style="color: #990000">:</span>id <span style="color: #990000">=&gt;</span> <span style="color: #FF0000">"1"</span> <span style="color: #FF0000">}</span>

+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

+</tt></pre></div></div>

+</div>

+<h2 id="_testing_your_mailers">10. Testing Your Mailers</h2>

 <div class="sectionbody">

 <div class="para"><p>Testing mailer classes requires some specific tools to do a thorough job.</p></div>

-<h3 id="_keeping_the_postman_in_check">6.1. Keeping the Postman in Check</h3>

+<h3 id="_keeping_the_postman_in_check">10.1. Keeping the Postman in Check</h3>

 <div class="para"><p>Your <tt>ActionMailer</tt> classes &#8212; like every other part of your Rails application &#8212; should be tested to ensure that it is working as expected.</p></div>

 <div class="para"><p>The goals of testing your <tt>ActionMailer</tt> classes are to ensure that:</p></div>

 <div class="ilist"><ul>

@@ -1587,14 +1740,14 @@ the right emails are being sent at the right times
 </p>

 </li>

 </ul></div>

-<h4 id="_from_all_sides">6.1.1. From All Sides</h4>

+<h4 id="_from_all_sides">10.1.1. From All Sides</h4>

 <div class="para"><p>There are two aspects of testing your mailer, the unit tests and the functional tests. In the unit tests, you run the mailer in isolation with tightly controlled inputs and compare the output to a knownvalue (a fixture &#8212; yay! more fixtures!). In the functional tests you don't so much test the minute details produced by the mailer Instead we test that our controllers and models are using the mailer in the right way. You test to prove that the right email was sent at the right time.</p></div>

-<h3 id="_unit_testing">6.2. Unit Testing</h3>

+<h3 id="_unit_testing">10.2. Unit Testing</h3>

 <div class="para"><p>In order to test that your mailer is working as expected, you can use unit tests to compare the actual results of the mailer with pre-written examples of what should be produced.</p></div>

-<h4 id="_revenge_of_the_fixtures">6.2.1. Revenge of the Fixtures</h4>

+<h4 id="_revenge_of_the_fixtures">10.2.1. Revenge of the Fixtures</h4>

 <div class="para"><p>For the purposes of unit testing a mailer, fixtures are used to provide an example of how the output <em>should</em> look. Because these are example emails, and not Active Record data like the other fixtures, they are kept in their own subdirectory apart from the other fixtures. The name of the directory within <tt>test/fixtures</tt> directly corresponds to the name of the mailer. So, for a mailer named <tt>UserMailer</tt>, the fixtures should reside in <tt>test/fixtures/user_mailer</tt> directory.</p></div>

 <div class="para"><p>When you generated your mailer, the generator creates stub fixtures for each of the mailers actions. If you didn't use the generator you'll have to make those files yourself.</p></div>

-<h4 id="_the_basic_test_case">6.2.2. The Basic Test case</h4>

+<h4 id="_the_basic_test_case">10.2.2. The Basic Test case</h4>

 <div class="para"><p>Here's a unit test to test a mailer named <tt>UserMailer</tt> whose action <tt>invite</tt> is used to send an invitation to a friend. It is an adapted version of the base test created by the generator for an <tt>invite</tt> action.</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

@@ -1629,7 +1782,7 @@ Cheers!</tt></pre>
 </div></div>

 <div class="para"><p>This is the right time to understand a little more about writing tests for your mailers. The line <tt>ActionMailer::Base.delivery_method = :test</tt> in <tt>config/environments/test.rb</tt> sets the delivery method to test mode so that email will not actually be delivered (useful to avoid spamming your users while testing) but instead it will be appended to an array (<tt>ActionMailer::Base.deliveries</tt>).</p></div>

 <div class="para"><p>However often in unit tests, mails will not actually be sent, simply constructed, as in the example above, where the precise content of the email is checked against what it should be.</p></div>

-<h3 id="_functional_testing">6.3. Functional Testing</h3>

+<h3 id="_functional_testing">10.3. Functional Testing</h3>

 <div class="para"><p>Functional testing for mailers involves more than just checking that the email body, recipients and so forth are correct. In functional mail tests you call the mail deliver methods and check that the appropriate emails have been appended to the delivery list. It is fairly safe to assume that the deliver methods themselves do their job You are probably more interested in is whether your own business logic is sending emails when you expect them to got out. For example, you can check that the invite friend operation is sending an email appropriately:</p></div>

 <div class="listingblock">

 <div class="content"><!-- Generator: GNU source-highlight 2.9

@@ -1652,36 +1805,7 @@ http://www.gnu.org/software/src-highlite -->
 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>

 </tt></pre></div></div>

 </div>

-<h2 id="_rake_tasks_for_testing">7. Rake Tasks for Testing</h2>

-<div class="sectionbody">

-<div class="para"><p>You don't need to set up and run your tests by hand on a test-by-test basis. Rails comes with a number of rake tasks to help in testing. The table below lists all rake tasks that come along in the default Rakefile when you initiate a Rail project.</p></div>

-<div class="para"><p>--------------------------------`----------------------------------------------------

-Tasks                           Description</p></div>

-<div class="listingblock">

-<div class="content">

-<pre><tt>+rake test+                     Runs all unit, functional and integration tests. You can also simply run +rake+ as the _test_ target is the default.

-+rake test:units+               Runs all the unit tests from +test/unit+

-+rake test:functionals+         Runs all the functional tests from +test/functional+

-+rake test:integration+         Runs all the integration tests from +test/integration+

-+rake test:recent+              Tests recent changes

-+rake test:uncommitted+         Runs all the tests which are uncommitted. Only supports Subversion

-+rake test:plugins+             Run all the plugin tests from +vendor/plugins/*/**/test+ (or specify with +PLUGIN=_name_+)

-+rake db:test:clone+            Recreate the test database from the current environment's database schema

-+rake db:test:clone_structure+  Recreate the test databases from the development structure

-+rake db:test:load+             Recreate the test database from the current +schema.rb+

-+rake db:test:prepare+          Check for pending migrations and load the test schema

-+rake db:test:purge+            Empty the test database.</tt></pre>

-</div></div>

-<div class="admonitionblock">

-<table><tr>

-<td class="icon">

-<img src="./images/icons/tip.png" alt="Tip" />

-</td>

-<td class="content">You can see all these rake task and their descriptions by running <tt>rake &#8212;tasks &#8212;describe</tt></td>

-</tr></table>

-</div>

-</div>

-<h2 id="_other_testing_approaches">8. Other Testing Approaches</h2>

+<h2 id="_other_testing_approaches">11. Other Testing Approaches</h2>

 <div class="sectionbody">

 <div class="para"><p>The built-in <tt>test/unit</tt> based testing is not the only way to test Rails applications. Rails developers have come up with a wide variety of other approaches and aids for testing, including:</p></div>

 <div class="ilist"><ul>

@@ -1707,18 +1831,23 @@ link: <a href="http://rspec.info/">RSpec</a>, a behavior-driven development fram
 </li>

 </ul></div>

 </div>

-<h2 id="_changelog">9. Changelog</h2>

+<h2 id="_changelog">12. Changelog</h2>

 <div class="sectionbody">

 <div class="para"><p><a href="http://rails.lighthouseapp.com/projects/16213-rails-guides/tickets/8">Lighthouse ticket</a></p></div>

 <div class="ilist"><ul>

 <li>

 <p>

+November 13, 2008: Revised based on feedback from Pratik Naik by <a href="../authors.html#asurve">Akshay Surve</a> (not yet approved for publication)

+</p>

+</li>

+<li>

+<p>

 October 14, 2008: Edit and formatting pass by <a href="../authors.html#mgunderloy">Mike Gunderloy</a> (not yet approved for publication)

 </p>

 </li>

 <li>

 <p>

-October 12, 2008: First draft by <a href="../authors.html#asurve">Akashay Surve</a> (not yet approved for publication)

+October 12, 2008: First draft by <a href="../authors.html#asurve">Akshay Surve</a> (not yet approved for publication)

 </p>

 </li>

 </ul></div>