From 4bb13a2bfb7a2fc666c74038c1e72ea10544dfae Mon Sep 17 00:00:00 2001 From: Mike Gunderloy Date: Fri, 31 Oct 2008 04:40:29 -0500 Subject: Update release notes. --- railties/doc/guides/html/2_2_release_notes.html | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/2_2_release_notes.html b/railties/doc/guides/html/2_2_release_notes.html index 5e3b2cfc88..d83ad87160 100644 --- a/railties/doc/guides/html/2_2_release_notes.html +++ b/railties/doc/guides/html/2_2_release_notes.html @@ -779,6 +779,11 @@ Benchmarking numbers are now reported in milliseconds rather than tiny fractions Rails now supports HTTP-only cookies (and uses them for sessions), which help mitigate some cross-site scripting risks in newer browsers.

+redirect_to now fully supports URI schemes (so, for example, you can redirect to a svn+ssh: URI) +

7. Action View

@@ -791,7 +796,7 @@ Rails now supports HTTP-only cookies (and uses them for sessions), which help mi

-The included Prototype javascript library has been upgraded to version 1.6.0.2. +The included Prototype javascript library has been upgraded to version 1.6.0.3.

-- cgit v1.2.3 From 1d84c158c1aff15149a91b86f44138d96e417134 Mon Sep 17 00:00:00 2001 From: Mike Gunderloy Date: Sat, 1 Nov 2008 06:14:02 -0500 Subject: Update 2.2 relnotes & Layouts/Rendering Guide to include render :js --- railties/doc/guides/html/2_2_release_notes.html | 7 ++++++- railties/doc/guides/html/layouts_and_rendering.html | 21 ++++++++++++++++++--- 2 files changed, 24 insertions(+), 4 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/2_2_release_notes.html b/railties/doc/guides/html/2_2_release_notes.html index d83ad87160..c68f10ad5a 100644 --- a/railties/doc/guides/html/2_2_release_notes.html +++ b/railties/doc/guides/html/2_2_release_notes.html @@ -781,7 +781,12 @@ Rails now supports HTTP-only cookies (and uses them for sessions), which help mi

-redirect_to now fully supports URI schemes (so, for example, you can redirect to a svn+ssh: URI) +redirect_to now fully supports URI schemes (so, for example, you can redirect to a svn+ssh: URI). +

+render now supports a :js option to render plain vanilla javascript with the right mime type.

diff --git a/railties/doc/guides/html/layouts_and_rendering.html b/railties/doc/guides/html/layouts_and_rendering.html index bf790d7b9d..8f78429610 100644 --- a/railties/doc/guides/html/layouts_and_rendering.html +++ b/railties/doc/guides/html/layouts_and_rendering.html @@ -489,7 +489,17 @@ http://www.gnu.org/software/src-highlite --> You don't need to call to_xml on the object that you want to render. If you use the :xml option, render will automatically call to_xml for you. -

2.2.10. Options for `render`

2.2.10. Rendering Vanilla JavaScript

Rails can render vanilla JavaScript (as an alternative to using update with n .rjs file):

render :js => "alert('Hello Rails');"
+

This will send the supplied string to the browser with a MIME type of text/javascript.

2.2.11. Options for `render`

Calls to the render method generally accept four options:

@@ -560,7 +570,7 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite -->
```
render :xml => photo, :location => photo_url(photo)
 
```

2.2.11. Finding Layouts

2.2.12. Finding Layouts

To find the current layout, Rails first looks for a file in app/views/layouts with the same base name as the controller. For example, rendering actions from the PhotosController class will use /app/views/layouts/photos.html.erb. If there is no such controller-specific layout, Rails will use /app/views/layouts/application.html.erb. If there is no .erb layout, Rails will use a .builder layout if one exists. Rails also provides several ways to more precisely assign specific layouts to individual controllers and actions.

Specifying Layouts on a per-Controller Basis

You can override the automatic layout conventions in your controllers by using the layout declaration in the controller. For example:

@@ -693,7 +703,7 @@ In general, views will be rendered in the main layout

2.2.12. Avoiding Double Render Errors

2.2.13. Avoiding Double Render Errors

Sooner or later, most Rails developers will see the error message "Can only render or redirect once per action". While this is annoying, it's relatively easy to fix. Usually it happens because of a fundamental misunderstanding of the way that render works.

For example, here's some code that will trigger this error:

@@ -1309,6 +1319,11 @@ _employee.html.erb:

+November 1, 2008: Added :js option for render by Mike Gunderloy +
+
+
October 16, 2008: Ready for publication by Mike Gunderloy

Date: Sat, 1 Nov 2008 07:03:15 -0500 Subject: Add warning about deprecated partials behavior to Layout/Rendering Guide --- railties/doc/guides/html/layouts_and_rendering.html | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/layouts_and_rendering.html b/railties/doc/guides/html/layouts_and_rendering.html index 8f78429610..c650a3bc0b 100644 --- a/railties/doc/guides/html/layouts_and_rendering.html +++ b/railties/doc/guides/html/layouts_and_rendering.html @@ -1225,7 +1225,7 @@ _form.html.erb: <% end %>

Although the same partial will be rendered into both views, the label on the submit button is controlled by a local variable passed into the partial.

Every partial also has a local variable with the same name as the partial (minus the underscore). By default, it will look for an instance variable with the same name as the partial in the parent. You can pass an object in to this local variable via the :object option:

Every partial also has a local variable with the same name as the partial (minus the underscore). You can pass an object in to this local variable via the :object option:

<%= render :partial => "customer", :object => @new_customer %>

Within the customer partial, the @customer variable will refer to @new_customer from the parent view.

+ + + +

+ +	In previous versions of Rails, the default local variable would look for an instance variable with the same name as the partial in the parent. This behavior is deprecated in Rails 2.2 and will be removed in a future version.

If you have an instance of a model to render into a partial, you can use a shorthand syntax:

layout "main" #... end - -class PostsController < ApplicationController +

posts_controller.rb:

class PostsController < ApplicationController
   # ...
 end
-
-class SpecialPostsController < PostsController
+

special_posts_controller.rb:

class SpecialPostsController < PostsController
   layout "special"
   # ...
 end
-
-class OldPostsController < SpecialPostsController
+

old_posts_controller.rb:

class OldPostsController < SpecialPostsController
   layout nil
 
   def show
@@ -1195,26 +1214,33 @@ http://www.gnu.org/software/src-highlite -->
 This would look for a partial named _link_area.html.erb and render it using the layout _graybar.html.erb. Note that layouts for partials follow the same leading-underscore naming as regular partials, and are placed in the same folder with the partial that they belong to (not in the master layouts folder).
 3.4.4. Passing Local Variables
 You can also pass local variables into partials, making them even more powerful and flexible. For example, you can use this technique to reduce duplication between new and edit pages, while still keeping a bit of distinct content:
+new.html.erb:
 
 
-new.html.erb:
-
-<h1>New zone</h1>
+<h1>New zone</h1>
 <%= error_messages_for :zone %>
 <%= render :partial => "form", :locals => { :button_label => "Create zone", :zone => @zone } %>
-
-edit.html.erb:
-
-<h1>Editing zone</h1>
+

+edit.html.erb:
+
+
+<h1>Editing zone</h1>
 <%= error_messages_for :zone %>
 <%= render :partial => "form", :locals => { :button_label => "Update zone", :zone => @zone } %>
-
-_form.html.erb:
-
-<% form_for(@zone) do |f| %>
+
+_form.html.erb:
+
+
+<% form_for(zone) do |f| %>
         <p>
           <b>Zone name</b><br />
           <%= f.text_field :name %>
@@ -1253,19 +1279,22 @@ http://www.gnu.org/software/src-highlite -->
 Assuming that the @customer instance variable contains an instance of the Customer model, this will use _customer.html.erb to render it.
 3.4.5. Rendering Collections
 Partials are very useful in rendering collections. When you pass a collection to a partial via the :collection option, the partial will be inserted once for each member in the collection:
+index.html.erb:
 
 
-index.html.erb:
-
-<h1>Products</h1>
+<h1>Products</h1>
 <%= render :partial => "product", :collection => @products %>
-
-_product.html.erb:
-
-<p>Product Name: <%= product.name %></p>
+

+_product.html.erb:
+
+
+<p>Product Name: <%= product.name %></p>
 
 When a partial is called with a pluralized collection, then the individual instances of the partial have access to the member of the collection being rendered via a variable named after the partial. In this case, the partial is _product, and within the +_product partial, you can refer to product to get the instance that is being rendered. To use a custom local variable name within the partial, specify the :as option in the call to the partial:
 
@@ -1286,38 +1315,48 @@ http://www.gnu.org/software/src-highlite -->
 

 Rails will render the _product_ruler partial (with no data passed in to it) between each pair of _product partials.
 There's also a shorthand syntax available for rendering collections. For example, if @products is a collection of products, you can render the collection this way:
+index.html.erb:
 
 
-index.html.erb:
-
-<h1>Products</h1>
+<h1>Products</h1>
 <%= render :partial => @products %>
-
-_product.html.erb:
-
-<p>Product Name: <%= product.name %></p>
+

+_product.html.erb:
+
+
+<p>Product Name: <%= product.name %></p>
 
 Rails determines the name of the partial to use by looking at the model name in the collection. In fact, you can even create a heterogeneous collection and render it this way, and Rails will choose the proper partial for each member of the collection:
+index.html.erb:
 
 
-index.html.erb:
-
-<h1>Contacts</h1>
+<h1>Contacts</h1>
 <%= render :partial => [customer1, employee1, customer2, employee2] %>
-
-_customer.html.erb:
-
-<p>Name: <%= customer.name %></p>
-
-_employee.html.erb:
-
-<p>Name: <%= employee.name %></p>
+

+_customer.html.erb:
+
+
+<p>Name: <%= customer.name %></p>
+
+_employee.html.erb:
+
+
+<p>Name: <%= employee.name %></p>
 
 In this case, Rails will use the customer or employee partials as appropriate for each member of the collection.

-- cgit v1.2.3 From a3aa0c17ef8594a0084511f4852be7b5dc66e5e2 Mon Sep 17 00:00:00 2001 From: Mike Gunderloy Date: Sat, 1 Nov 2008 13:41:18 -0500 Subject: Marking Getting Started and Security guides as finished. --- railties/doc/guides/html/getting_started_with_rails.html | 5 +++++ railties/doc/guides/html/index.html | 16 ---------------- railties/doc/guides/html/security.html | 14 ++++++++++++++ 3 files changed, 19 insertions(+), 16 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/getting_started_with_rails.html b/railties/doc/guides/html/getting_started_with_rails.html index d9a1779d56..797ae2fb3a 100644 --- a/railties/doc/guides/html/getting_started_with_rails.html +++ b/railties/doc/guides/html/getting_started_with_rails.html @@ -2010,6 +2010,11 @@ The Rails wiki +November 1, 2008: First approved version by Mike Gunderloy + + + + October 16, 2008: Revised based on feedback from Pratik Naik by Mike Gunderloy (not yet approved for publication) diff --git a/railties/doc/guides/html/index.html b/railties/doc/guides/html/index.html index f84442d10c..306257678b 100644 --- a/railties/doc/guides/html/index.html +++ b/railties/doc/guides/html/index.html @@ -219,14 +219,6 @@ ul#navMain { Getting Started with Rails - - - - - - - Lighthouse Ticket - Everything you need to know to install Rails and create your first application. Models @@ -326,14 +318,6 @@ Enjoy. Securing Rails Applications - - - - - - - Lighthouse Ticket - This manual describes common security problems in web applications and how to avoid them with Rails. diff --git a/railties/doc/guides/html/security.html b/railties/doc/guides/html/security.html index a135d9b486..390efb5435 100644 --- a/railties/doc/guides/html/security.html +++ b/railties/doc/guides/html/security.html @@ -310,6 +310,9 @@ ul#navMain { Additional resources + + Changelog +

@@ -1324,6 +1327,17 @@ Another good security blog with some Chea + +10. Changelog + +Lighthouse ticket + + + +November 1, 2008: First approved version by Heiko Webers + + + -- cgit v1.2.3 From 6744a8b1bcefea73f9a234a67bf4b1b73cef9938 Mon Sep 17 00:00:00 2001 From: miloops Date: Mon, 3 Nov 2008 12:52:53 -0300 Subject: Added missing sidebar block closing delimiter. --- railties/doc/guides/html/authors.html | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/authors.html b/railties/doc/guides/html/authors.html index 973cf7cd2e..c0a6600571 100644 --- a/railties/doc/guides/html/authors.html +++ b/railties/doc/guides/html/authors.html @@ -218,6 +218,13 @@ work with Rails. His near-daily links and other blogging can be found at Eventioz. He has been using Rails since 2006 and contributing since early 2008. Can be found at gmail, twitter, freenode, everywhere as miloops. + + +Heiko Webers +Heiko Webers is the founder of bauland42, a German web application security consulting and development +company focused on Ruby on Rails. He blogs at http://www.rorsecurity.info. After 10 years of desktop application development, +Heiko has rarely looked back. + -- cgit v1.2.3 From 77c6ba9fcd1494fbc9275217700ad3f0f0a23b0f Mon Sep 17 00:00:00 2001 From: miloops Date: Mon, 3 Nov 2008 12:58:38 -0300 Subject: Added RJS, memory leaks and plugins chapters to Debugging Rails Applications guide. Generated Guides. --- .../guides/html/debugging_rails_applications.html | 152 ++++++++++++++++++++- railties/doc/guides/html/migrations.html | 2 +- 2 files changed, 151 insertions(+), 3 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/debugging_rails_applications.html b/railties/doc/guides/html/debugging_rails_applications.html index bf1e442d59..0fdc1b0a1f 100644 --- a/railties/doc/guides/html/debugging_rails_applications.html +++ b/railties/doc/guides/html/debugging_rails_applications.html @@ -208,6 +208,8 @@ ul#navMain { inspect + Debugging Javascript + @@ -253,6 +255,19 @@ ul#navMain { + Debugging Memory Leaks + + + Bleak House + + Valgrind + + + + + Plugins for Debugging + + References

@@ -397,6 +412,32 @@ http://www.gnu.org/software/src-highlite --> Title: Rails debugging guide +1.4. Debugging Javascript +Rails has built-in support to debug RJS, to active it, set ActionView::Base.debug_rjs to true, this will specify whether RJS responses should be wrapped in a try/catch block that alert()s the caught exception (and then re-raises it). +To enable it, add the following in the Rails::Initializer do |config| block inside environment.rb: + + +config.action_view[:debug_rjs] = true + +Or, at any time, setting ActionView::Base.debug_rjs to true: + + +ActionView::Base.debug_rjs = true + + + + + + + + For more information on debugging javascript refer to Firebug, the popular debugger for Firefox. + 2. The Logger

@@ -978,7 +1019,104 @@ set forcestep set listsize 25

4. References

4. Debugging Memory Leaks

A Ruby application (on Rails or not), can leak memory whether in the Ruby code but also in the C code.

In this section, you will learn how to find and fix this leaks by using Bleak House and Valgrind debugging tools.

4.1. Bleak House

Bleak House is a library for finding memory leaks.

If a Ruby object does not go out of scope, the Ruby Garbage Collector won't sweep it since it is referenced somewhere, this leaks can grow slowly and your application will consume more and more memory gradually affecting the overall system performance. This tool will help you find leaks on the Ruby heap.

To install it run:

sudo gem install bleak_house

Then setup you application for profiling, add the following at the bottom of config/environment.rb:

require 'bleak_house' if ENV['BLEAK_HOUSE']
+

Start a server instance with Bleak House integration:

RAILS_ENV=production BLEAK_HOUSE=1 ruby-bleak-house ./script/server

Make sure to run a couple hundred requests to get better data samples, hit CTRL-C. The server will stop and Bleak House will produce a dumpfile in /tmp:

** BleakHouse: working...
+** BleakHouse: complete
+** Bleakhouse: run 'bleak /tmp/bleak.5979.0.dump' to analyze.
+

To analyze it, just run the listed command. The top 20 leakiest lines will be listed:

  191691 total objects
+  Final heap size 191691 filled, 220961 free
+  Displaying top 20 most common line/class pairs
+  89513 __null__:__null__:__node__
+  41438 __null__:__null__:String
+  2348 /opt/local//lib/ruby/site_ruby/1.8/rubygems/specification.rb:557:Array
+  1508 /opt/local//lib/ruby/gems/1.8/specifications/gettext-1.90.0.gemspec:14:String
+  1021 /opt/local//lib/ruby/gems/1.8/specifications/heel-0.2.0.gemspec:14:String
+   951 /opt/local//lib/ruby/site_ruby/1.8/rubygems/version.rb:111:String
+   935 /opt/local//lib/ruby/site_ruby/1.8/rubygems/specification.rb:557:String
+   834 /opt/local//lib/ruby/site_ruby/1.8/rubygems/version.rb:146:Array
+  ...
+

This way you can find where you application is leaking memory and fix it.

If BleakHouse doesn't report any heap growth but you still have memory growth, you might have a broken C extension, or real leak in the interpreter, try using Valgrind.

4.2. Valgrind

Valgrind is a Linux (only works on Linux) application for detecting C-based memory leaks and race conditions.

There are Valgrind tools that can automatically detect many memory management and threading bugs, and profile your programs in detail. For example, a C extension in the interpreter calls malloc() but is doesn't properly call free(), this memory won't be available until the app terminates.

For further information on how to install and using with Ruby, refer to the Valgrind and Ruby Evan Weaver's article.

5. Plugins for Debugging

To make life easier Rails offer plugins, some of them will help you to find errors and debug your application. Here is a list of useful plugins for debugging:

+
+Footnotes: Every Rails page has footnotes that link give request information and link back to your source via TextMate. +
+
+
+Query Trace: Adds query origin tracing to your logs. +
+
+
+Query Stats: A Rails plugin to track database queries. +
+
+
+Query Reviewer: This rails plugin not only runs "EXPLAIN" before each of your select queries in development, but provides a small DIV in the rendered output of each page with the summary of query warnings that it analyzed. +
+
+
+Exception Notifier: Provides a mailer object and a default set of templates for sending email notifications when errors occur in a Rails application. +
+
+
+Exception Logger: Logs your Rails exceptions in the database and provides a funky web interface to manage them. +
+

6. References

@@ -1026,14 +1164,24 @@ set listsize 25 Ruby on Rails Wiki: How to Configure Logging
+
+Bleak House Documentation +
+

5. Changelog

7. Changelog

Lighthouse ticket

+November 3, 2008: Added RJS, memory leaks and plugins chapters by Emilio Tagua +
+
+
October 19, 2008: Copy editing pass by Mike Gunderloy

rake db:rollback STEP=3

will run the down method fron the last 3 migrations.

will run the down method from the last 3 migrations.

The db:migrate:redo task is a shortcut for doing a rollback and then migrating back up again. As with the db:rollback task you can use the STEP parameter if you need to go more than one version back, for example

-- cgit v1.2.3 From 9b6cefe739c161c0147333d26202038df5e73e4d Mon Sep 17 00:00:00 2001 From: Mike Gunderloy Date: Mon, 3 Nov 2008 11:08:28 -0600 Subject: Finalized debugging guide. --- .../guides/html/debugging_rails_applications.html | 34 +++++++++++----------- railties/doc/guides/html/index.html | 12 ++------ 2 files changed, 19 insertions(+), 27 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/debugging_rails_applications.html b/railties/doc/guides/html/debugging_rails_applications.html index 0fdc1b0a1f..d3a3180842 100644 --- a/railties/doc/guides/html/debugging_rails_applications.html +++ b/railties/doc/guides/html/debugging_rails_applications.html @@ -258,7 +258,7 @@ ul#navMain { Debugging Memory Leaks

Bleak House
BleakHouse
Valgrind

@posts = Post.find(:all)
 (rdb:7)

Now it's time to play and dig into your application. A good place to start is by asking the debugger for help… so type: help (You didn't see that coming, right?)

Now it's time to explore and dig into your application. A good place to start is by asking the debugger for help… so type: help (You didn't see that coming, right?)

(rdb:7) help
@@ -1021,17 +1021,17 @@ set listsize 25

4. Debugging Memory Leaks

-A Ruby application (on Rails or not), can leak memory whether in the Ruby code but also in the C code. -In this section, you will learn how to find and fix this leaks by using Bleak House and Valgrind debugging tools. -4.1. Bleak House -Bleak House is a library for finding memory leaks. -If a Ruby object does not go out of scope, the Ruby Garbage Collector won't sweep it since it is referenced somewhere, this leaks can grow slowly and your application will consume more and more memory gradually affecting the overall system performance. This tool will help you find leaks on the Ruby heap. +A Ruby application (on Rails or not), can leak memory - either in the Ruby code or at the C code level. +In this section, you will learn how to find and fix such leaks by using Bleak House and Valgrind debugging tools. +4.1. BleakHouse +BleakHouse is a library for finding memory leaks. +If a Ruby object does not go out of scope, the Ruby Garbage Collector won't sweep it since it is referenced somewhere. Leaks like this can grow slowly and your application will consume more and more memory, gradually affecting the overall system performance. This tool will help you find leaks on the Ruby heap. To install it run: sudo gem install bleak_house -Then setup you application for profiling, add the following at the bottom of config/environment.rb: +Then setup you application for profiling. Then add the following at the bottom of config/environment.rb: require 'bleak_house' if ENV['BLEAK_HOUSE'] -Start a server instance with Bleak House integration: +Start a server instance with BleakHouse integration: RAILS_ENV=production BLEAK_HOUSE=1 ruby-bleak-house ./script/server -Make sure to run a couple hundred requests to get better data samples, hit CTRL-C. The server will stop and Bleak House will produce a dumpfile in /tmp: +Make sure to run a couple hundred requests to get better data samples, then press CTRL-C. The server will stop and Bleak House will produce a dumpfile in /tmp:

834 /opt/local//lib/ruby/site_ruby/1.8/rubygems/version.rb:146:Array ...

This way you can find where you application is leaking memory and fix it.

If BleakHouse doesn't report any heap growth but you still have memory growth, you might have a broken C extension, or real leak in the interpreter, try using Valgrind.

This way you can find where your application is leaking memory and fix it.

If BleakHouse doesn't report any heap growth but you still have memory growth, you might have a broken C extension, or real leak in the interpreter. In that case, try using Valgrind to investigate further.

4.2. Valgrind

Valgrind is a Linux (only works on Linux) application for detecting C-based memory leaks and race conditions.

Valgrind is a Linux-only application for detecting C-based memory leaks and race conditions.

For further information on how to install and using with Ruby, refer to the Valgrind and Ruby Evan Weaver's article.

For further information on how to install Valgrind and use with Ruby, refer to Valgrind and Ruby by Evan Weaver.

5. Plugins for Debugging

To make life easier Rails offer plugins, some of them will help you to find errors and debug your application. Here is a list of useful plugins for debugging:

There are some Rails plugins to help you to find errors and debug your application. Here is a list of useful plugins for debugging:

@@ -1101,7 +1101,7 @@ http://www.gnu.org/software/src-highlite -->
-Query Reviewer: This rails plugin not only runs "EXPLAIN" before each of your select queries in development, but provides a small DIV in the rendered output of each page with the summary of query warnings that it analyzed. +Query Reviewer: This rails plugin not only runs "EXPLAIN" before each of your select queries in development, but provides a small DIV in the rendered output of each page with the summary of warnings for each query that it analyzed.
@@ -1177,7 +1177,7 @@ http://www.gnu.org/software/src-highlite -->
- -November 3, 2008: Added RJS, memory leaks and plugins chapters by Emilio Tagua +November 3, 2008: Accepted for publication. Added RJS, memory leaks and plugins chapters by Emilio Tagua
- diff --git a/railties/doc/guides/html/index.html b/railties/doc/guides/html/index.html index 306257678b..84618d95e2 100644 --- a/railties/doc/guides/html/index.html +++ b/railties/doc/guides/html/index.html @@ -250,7 +250,7 @@ ul#navMain {
  
  Layouts and Rendering in Rails
  
  This guide covers the basic layout features of Action Controller and Action View, -including rendering and redirecting, using +content_for_ blocks, and working +including rendering and redirecting, using content_for blocks, and working with partials.
@@ -318,20 +318,12 @@ Enjoy.

Securing Rails Applications
-
This manual describes common security problems in web applications and how to +
This guide describes common security problems in web applications and how to avoid them with Rails.

Debugging Rails Applications
-
- - - -
- - Lighthouse Ticket
-

This guide describes how to debug Rails applications. It covers the different ways of achieving this and how to understand what is happening "behind the scenes" of your code.
-- cgit v1.2.3 From e025f94cbe87ad66b8dcef40facccc2a7ad15411 Mon Sep 17 00:00:00 2001 From: Mike Gunderloy Date: Mon, 3 Nov 2008 14:23:29 -0600 Subject: Formatting tweaks on Getting Started, regen Guides HTML --- .../doc/guides/html/actioncontroller_basics.html | 7 +- railties/doc/guides/html/form_helpers.html | 76 +++++++++++++++- .../guides/html/getting_started_with_rails.html | 101 ++++++++++++--------- 3 files changed, 131 insertions(+), 53 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/actioncontroller_basics.html b/railties/doc/guides/html/actioncontroller_basics.html index 32ddbe1f60..23d3c2e450 100644 --- a/railties/doc/guides/html/actioncontroller_basics.html +++ b/railties/doc/guides/html/actioncontroller_basics.html @@ -862,10 +862,9 @@ url - The entire URL used for the request.

8.1.1. path_parameters, query_parameters and request_parameters

TODO: Does this belong here?

Rails collects all of the parameters sent along with the request in the params hash, whether they are sent as part of the query string or the post body. The request object has three accessors that give you access to these parameters depending on where they came from. The query_parameters hash contains parameters that were sent as part of the query string while the request_parameters hash contains parameters sent as part of the post body. The path_parameters hash contains parameters that were recognised by the routing as being part of the path leading to this particular controller and action.

8.2. The response

The response objects is not usually used directly, but is built up during the execution of the action and rendering of the data that is being sent back to the user, but sometimes - like in an after filter - it can be useful to access the response directly. Some of these accessor methods also have setters, allowing you to change their values.

The response object is not usually used directly, but is built up during the execution of the action and rendering of the data that is being sent back to the user, but sometimes - like in an after filter - it can be useful to access the response directly. Some of these accessor methods also have setters, allowing you to change their values.

@@ -896,7 +895,7 @@ charset - The character set being used for the response. Default is "utf8".

9. HTTP Basic Authentication

Rails comes with built-in HTTP Basic authentication. This is an authentication scheme that is supported by the majority of browsers and other HTTP clients. As an example, we will create an administration section which will only be available by entering a username and a password into the browser's HTTP Basic dialog window. Using the built-in authentication is quite easy and only requires you to use one method, authenticate_or_request_with_http_basic.

11. Parameter filtering

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 filter_parameter_logging method can be used to filter out sensitive information from the log. It works by replacing certain keys in the params 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":

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 filter_parameter_logging method can be used to filter out sensitive information from the log. It works by replacing certain values in the params 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":

At this point, it’s worth looking at some of the tools that Rails provides to eliminate duplication in your code. In particular, you can use partials to clean up duplication in views and filters to help with duplication in controllers.

7.1. Using Partials to Eliminate View Duplication

As you saw earlier, the scaffold-generated views for the new and edit actions are largely identical. You can pull the shared code out into a partial template. This requires editing the new and edit views, and adding a new template:

new.html.erb: -[source, ruby]

new.html.erb:

<h1>New post</h1>
+
+<h1>New post</h1>
 
-<%= render :partial => "form" %>
+<%= render :partial => "form" %>
 
-<%= link_to 'Back', posts_path %>
-

-edit.html.erb: -[source, ruby] +<%= link_to 'Back', posts_path %> +

edit.html.erb:

<h1>Editing post</h1>
+
+<h1>Editing post</h1>
 
-<%= render :partial => "form" %>
+<%= render :partial => "form" %>
 
-<%= link_to 'Show', @post %> |
-<%= link_to 'Back', posts_path %>
-

-_form.html.erb: -[source, ruby] +<%= link_to 'Show', @post %> | +<%= link_to 'Back', posts_path %> +

_form.html.erb:

<% form_for(@post) do |f| %>
-  <%= f.error_messages %>
-
-  <p>
-    <%= f.label :name %><br />
-    <%= f.text_field :name %>
-  </p>
-  <p>
-    <%= f.label :title, "title" %><br />
-    <%= f.text_field :title %>
-  </p>
-  <p>
-    <%= f.label :content %><br />
-    <%= f.text_area :content %>
-  </p>
-  <p>
-    <%= f.submit "Save" %>
-  </p>
-<% end %>

<% form_for(@post) do |f| %>
+  <%= f.error_messages %>
+
+  <p>
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </p>
+  <p>
+    <%= f.label :title, "title" %><br />
+    <%= f.text_field :title %>
+  </p>
+  <p>
+    <%= f.label :content %><br />
+    <%= f.text_area :content %>
+  </p>
+  <p>
+    <%= f.submit "Save" %>
+  </p>
+<% end %>
+

Now, when Rails renders the new or edit view, it will insert the _form partial at the indicated point. Note the naming convention for partials: if you refer to a partial named form inside of a view, the corresponding file is _form.html.erb, with a leading underscore.

For more information on partials, refer to the Layouts and Rending in Rails guide.

7.2. Using Filters to Eliminate Controller Duplication

@@ -1721,32 +1727,32 @@ http://www.gnu.org/software/src-highlite -->

-+app/helpers/comments_helper.rb - A view helper file +app/helpers/comments_helper.rb - A view helper file

-+app/views/comments/index.html.erb - The view for the index action +app/views/comments/index.html.erb - The view for the index action

-+app/views/comments/show.html.erb - The view for the show action +app/views/comments/show.html.erb - The view for the show action

-+app/views/comments/new.html.erb - The view for the new action +app/views/comments/new.html.erb - The view for the new action

-+app/views/comments/edit.html.erb - The view for the edit action +app/views/comments/edit.html.erb - The view for the edit action

-+test/functional/comments_controller_test.rb - The functional tests for the controller +test/functional/comments_controller_test.rb - The functional tests for the controller

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

-The [http://manuals.rubyonrails.org/]Ruby On Rails guides +The Ruby On Rails guides
@@ -2010,6 +2016,11 @@ The Rails wiki
- +November 3, 2008: Formatting patch from Dave Rothlisberger +
  +
- +
  November 1, 2008: First approved version by Mike Gunderloy
All told, the Guides provide tens of thousands of words of guidance for beginning and intermediate Rails developers.
-
If you want to these generate guides locally, inside your application:
+
If you want to generate these guides locally, inside your application:

You'll see something like this:
-
+
```
--- !ruby/object:Post
 attributes:
   updated_at: 2008-09-05 22:55:47
@@ -355,8 +352,8 @@ attributes:
 attributes_cache: {}
 
 
-Title: Rails debugging guide
-
```
+Title: Rails debugging guide +

1.2. to_yaml

Displaying an instance variable, or any other object or method, in yaml format can be achieved this way:

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

The to_yaml method converts the method to YAML format leaving it more readable, and then the simple_format helper is used to render each line as in the console. This is how debug method does its magic.

As a result of this, you will have something like this in your view:

--- !ruby/object:Post
 attributes:
 updated_at: 2008-09-05 22:55:47
@@ -387,8 +381,8 @@ id: "1"
 created_at: 2008-09-05 22:55:47
 attributes_cache: {}
 
-Title: Rails debugging guide
-

+Title: Rails debugging guide +

1.3. inspect

Another useful method for displaying object values is inspect, especially when working with arrays or hashes. This will print the object value as a string. For example:

@@ -404,14 +398,11 @@ http://www.gnu.org/software/src-highlite -->

Will be rendered as follows:

[1, 2, 3, 4, 5]
 
-Title: Rails debugging guide
-

+Title: Rails debugging guide +

1.4. Debugging Javascript

Rails has built-in support to debug RJS, to active it, set ActionView::Base.debug_rjs to true, this will specify whether RJS responses should be wrapped in a try/catch block that alert()s the caught exception (and then re-raises it).

To enable it, add the following in the Rails::Initializer do |config| block inside environment.rb:

@@ -529,11 +520,8 @@ http://www.gnu.org/software/src-highlite -->

Here's an example of the log generated by this method:

Processing PostsController#create (for 127.0.0.1 at 2008-09-08 11:52:54) [POST]
+
+Processing PostsController#create (for 127.0.0.1 at 2008-09-08 11:52:54) [POST]
   Session ID: BAh7BzoMY3NyZl9pZCIlMDY5MWU1M2I1ZDRjODBlMzkyMWI1OTg2NWQyNzViZjYiCmZsYXNoSUM6J0FjdGl
 vbkNvbnRyb2xsZXI6OkZsYXNoOjpGbGFzaEhhc2h7AAY6CkB1c2VkewA=--b18cd92fba90eacf8137e5f6b3b06c4d724596a4
   Parameters: {"commit"=>"Create", "post"=>{"title"=>"Debugging Rails",
@@ -547,8 +535,8 @@ Post should be valid: true
  'I''m learning how to print in logs!!!', 'f', '2008-09-08 14:52:54')
 The post was saved and now is the user is going to be redirected...
 Redirected to #<Post:0x20af760>
-Completed in 0.01224 (81 reqs/sec) | DB: 0.00044 (3%) | 302 Found [http://localhost/posts]
-

+Completed in 0.01224 (81 reqs/sec) | DB: 0.00044 (3%) | 302 Found [http://localhost/posts] +

Adding extra logging like this makes it easy to search for unexpected or unusual behavior in your logs. If you add extra logging, be sure to make sensible use of log levels, to avoid filling your production logs with useless trivia.

3. Debugging with ruby-debug

@@ -581,12 +569,9 @@ http://www.gnu.org/software/src-highlite -->

If you see the message in the console or logs:

***** Debugger requested, but was not available: Start server with --debugger to enable *****
-

***** Debugger requested, but was not available: Start server with --debugger to enable *****

Make sure you have started your web server with the option —debugger:

set autolist
 set forcestep
-set listsize 25
-

+set listsize 25 +

4. Debugging Memory Leaks

@@ -1046,20 +1028,14 @@ http://www.gnu.org/software/src-highlite -->

Make sure to run a couple hundred requests to get better data samples, then press CTRL-C. The server will stop and Bleak House will produce a dumpfile in /tmp:

** BleakHouse: working...
 ** BleakHouse: complete
-** Bleakhouse: run 'bleak /tmp/bleak.5979.0.dump' to analyze.
-

+** Bleakhouse: run 'bleak /tmp/bleak.5979.0.dump' to analyze. +

To analyze it, just run the listed command. The top 20 leakiest lines will be listed:

  191691 total objects
   Final heap size 191691 filled, 220961 free
   Displaying top 20 most common line/class pairs
@@ -1071,8 +1047,8 @@ http://www.gnu.org/software/src-highlite -->
    951 /opt/local//lib/ruby/site_ruby/1.8/rubygems/version.rb:111:String
    935 /opt/local//lib/ruby/site_ruby/1.8/rubygems/specification.rb:557:String
    834 /opt/local//lib/ruby/site_ruby/1.8/rubygems/version.rb:146:Array
-  ...
-

+ ... +

This way you can find where your application is leaking memory and fix it.

4.2. Valgrind

diff --git a/railties/doc/guides/html/finders.html b/railties/doc/guides/html/finders.html index f8396bb517..18bc32306f 100644 --- a/railties/doc/guides/html/finders.html +++ b/railties/doc/guides/html/finders.html @@ -373,27 +373,21 @@ http://www.gnu.org/software/src-highlite -->

SELECT * FROM +clients+ WHERE (+clients+.+id+ IN (1,2))

>> Client.find(1,2)
 => [#<Client id: 1, name: => "Ryan", locked: false, orders_count: 2,
   created_at: "2008-09-28 15:38:50", updated_at: "2008-09-28 15:38:50">,
   #<Client id: 2, name: => "Michael", locked: false, orders_count: 3,
-  created_at: "2008-09-28 13:12:40", updated_at: "2008-09-28 13:12:40">]
-

+ created_at: "2008-09-28 13:12:40", updated_at: "2008-09-28 13:12:40">] +

Note that if you pass in a list of numbers that the result will be returned as an array, not as a single Client object.

If you wanted to find the first client you would simply type Client.first and that would find the first client created in your clients table:

>> Client.first
 => #<Client id: 1, name: => "Ryan", locked: false, orders_count: 2,
-  created_at: "2008-09-28 15:38:50", updated_at: "2008-09-28 15:38:50">
-

+ created_at: "2008-09-28 15:38:50", updated_at: "2008-09-28 15:38:50"> +

If you were running script/server you might see the following output:

Indicating the query that Rails has performed on your database.

To find the last client you would simply type Client.find(:last) and that would find the last client created in your clients table:

>> Client.find(:last)
 => #<Client id: 2, name: => "Michael", locked: false, orders_count: 3,
-  created_at: "2008-09-28 13:12:40", updated_at: "2008-09-28 13:12:40">
-

+ created_at: "2008-09-28 13:12:40", updated_at: "2008-09-28 13:12:40"> +

To find all the clients you would simply type Client.all and that would find all the clients in your clients table:

>> Client.all
 => [#<Client id: 1, name: => "Ryan", locked: false, orders_count: 2,
   created_at: "2008-09-28 15:38:50", updated_at: "2008-09-28 15:38:50">,
   #<Client id: 2, name: => "Michael", locked: false, orders_count: 3,
-  created_at: "2008-09-28 13:12:40", updated_at: "2008-09-28 13:12:40">]
-

+ created_at: "2008-09-28 13:12:40", updated_at: "2008-09-28 13:12:40">] +

As alternatives to calling Client.first, Client.last, and Client.all, you can use the class methods Client.first, Client.last, and Client.all instead. Client.first, Client.last and Client.all just call their longer counterparts: Client.find(:first), Client.find(:last) and Client.find(:all) respectively.

Be aware that Client.first/Client.find(:first) and Client.last/Client.find(:last) will both return a single object, where as Client.all/Client.find(:all) will return an array of Client objects, just as passing in an array of ids to find will do also.

@@ -510,12 +498,9 @@ http://www.gnu.org/software/src-highlite -->

This could possibly cause your database server to raise an unexpected error, for example MySQL will throw back this error:

Got a packet bigger than 'max_allowed_packet' bytes: _query_
-

Got a packet bigger than 'max_allowed_packet' bytes: _query_

Where query is the actual query used to get that error.

In this example it would be better to use greater-than and less-than operators in SQL, like so:

diff --git a/railties/doc/guides/html/testing_rails_applications.html b/railties/doc/guides/html/testing_rails_applications.html index 73634ef328..666d1dff85 100644 --- a/railties/doc/guides/html/testing_rails_applications.html +++ b/railties/doc/guides/html/testing_rails_applications.html @@ -233,7 +233,7 @@ ul#navMain {

What to include in your Functional Tests

Available Request Types for Functional Tests===

Available Request Types for Functional Tests

The 4 Hashes of the Apocalypse

@@ -398,15 +398,12 @@ steve:

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 test/fixtures directory, but these end with the .csv file extension (as in celebrity_holiday_figures.csv).

A CSV fixture looks like this:

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

+3, tfairy, ilovecavities, true, "Pull your teeth, I will" +

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:

@@ -535,17 +532,14 @@ email(david.
In Rails, unit tests are what you write to test your models.

When you create a model using script/generate, among other things it creates a test stub in the test/unit folder, as well as a fixture for the model:

$ script/generate model Post
 ...
 create  app/models/post.rb
 create  test/unit/post_test.rb
 create  test/fixtures/posts.yml
-...
-

+... +

The default test stub in test/unit/post_test.rb looks like this:

$ ruby unit/post_test.rb -n test_truth
 
 Loaded suite unit/post_test
@@ -648,8 +639,8 @@ Started
 .
 Finished in 0.023513 seconds.
 
-1 tests, 1 assertions, 0 failures, 0 errors
-

+1 tests, 1 assertions, 0 failures, 0 errors +

The . (dot) above indicates a passing test. When a test fails you see an F; when a test throws an error you see an E in its place. The last line of the output is the summary.

To see how a test failure is reported, you can add a failing test to the post_test.rb test case:

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

If you haven't added any data to the test fixture for posts, this test will fail. You can see this by running it:

$ ruby unit/post_test.rb
 Loaded suite unit/post_test
 Started
@@ -681,8 +669,8 @@ test_should_have_atleast_one_post(PostTest)
      /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.1/lib/active_support/testing/setup_and_teardown.rb:33:in `run']:
 <nil> expected to not be nil.
 
-2 tests, 2 assertions, 1 failures, 0 errors
-

+2 tests, 2 assertions, 1 failures, 0 errors +

In the output, F denotes a failure. You can see the corresponding trace shown under 1) 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:

Running this test shows the friendlier assertion message:

$ ruby unit/post_test.rb
 Loaded suite unit/post_test
 Started
@@ -714,8 +699,8 @@ test_should_have_atleast_one_post(PostTest)
 Should not be nil as Posts table should have atleast one post.
 <nil> expected to not be nil.
 
-2 tests, 2 assertions, 1 failures, 0 errors
-

+2 tests, 2 assertions, 1 failures, 0 errors +

To see how an error gets reported, here's a test containing an error:

Now you can see even more output in the console from running the tests:

$ ruby unit/post_test.rb
 Loaded suite unit/post_test
 Started
@@ -756,8 +738,8 @@ NameError: undefined local variable or method `some_undefined_variable' for #<
     /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
-

+3 tests, 2 assertions, 1 failures, 1 errors +

Notice the E in the output. It denotes a test with error.

@@ -1160,7 +1142,7 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite -->

get(:view, {'id' => '12'}, nil, {'message' => 'booya!'})

4.2. Available Request Types for Functional Tests===

4.2. Available Request Types for Functional Tests

If you're familiar with the HTTP protocol, you'll know that get is a type of request. There are 5 request types supported in Rails functional tests:

@@ -1638,16 +1620,13 @@ http://www.gnu.org/software/src-highlite -->
In this test, @expected is an instance of TMail::Mail that you can use in your tests. It is defined in ActionMailer::TestCase. The test above uses @expected to construct an email, which it then asserts with email created by the custom mailer. The invite fixture is the body of the email and is used as the sample content to assert against. The helper read_fixture is used to read in the content from this file.

Here's the content of the invite fixture:
-
+
```
Hi friend@example.com,
 
 You have been invited.
 
-Cheers!
-
```
+Cheers! +

This is the right time to understand a little more about writing tests for your mailers. The line ActionMailer::Base.delivery_method = :test in config/environments/test.rb 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 (ActionMailer::Base.deliveries).

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.

6.3. Functional Testing

-- cgit v1.2.3 From 746fed22ff5aebe372f55c083bbf0682d02e0381 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Tue, 4 Nov 2008 22:24:29 -0200 Subject: Initial commit for Active Record validations and callbacks guide --- .../html/activerecord_validations_callbacks.html | 267 +++++++++++++++++++++ railties/doc/guides/html/index.html | 10 +- 2 files changed, 275 insertions(+), 2 deletions(-) create mode 100644 railties/doc/guides/html/activerecord_validations_callbacks.html (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html new file mode 100644 index 0000000000..c9128a8533 --- /dev/null +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -0,0 +1,267 @@ + + + + + Active Record Validations and Callbacks + + + + + + + + + +

+ + + +

Active Record Validations and Callbacks

This guide teaches you how to work with the lifecycle of your Active Record objects. More precisely, you will learn how to validate the state of your objects before they go into the database and also how to teach them to perform custom operations at certain points of their lifecycles.

After reading this guide and trying out the presented concepts, we hope that you'll be able to:

+
+Correctly use all the built-in Active Record validation helpers +
+
+
+Create your own custom validation methods +
+
+
+Work with the error messages generated by the validation proccess +
+
+
+Register callback methods that will execute custom operations during your objects lifecycle, for example before/after they are saved. +
+
+
+Create special classes that encapsulate common behaviour for your callbacks +
+
+
+Create Observers - classes with callback methods specific for each of your models, keeping the callback code outside your models' declarations. +
+

1. Active Record Validations

2. Credits

3. Changelog

http://rails.lighthouseapp.com/projects/16213/tickets/26-active-record-validations-and-callbacks

+ +

+ + diff --git a/railties/doc/guides/html/index.html b/railties/doc/guides/html/index.html index 84618d95e2..f8d14ffdd5 100644 --- a/railties/doc/guides/html/index.html +++ b/railties/doc/guides/html/index.html @@ -179,7 +179,7 @@ ul#navMain { -

+ -

+ +

Ruby on Rails guides

-- cgit v1.2.3 From 37ea9de5af3fc8c133bbff060c11750bcb6970de Mon Sep 17 00:00:00 2001 From: Mike Gunderloy Date: Tue, 4 Nov 2008 20:18:47 -0600 Subject: Copy edit on AC Basics Guide --- .../doc/guides/html/actioncontroller_basics.html | 296 +++++++++++++++------ railties/doc/guides/html/index.html | 10 +- 2 files changed, 219 insertions(+), 87 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/actioncontroller_basics.html b/railties/doc/guides/html/actioncontroller_basics.html index 23d3c2e450..d58536cc37 100644 --- a/railties/doc/guides/html/actioncontroller_basics.html +++ b/railties/doc/guides/html/actioncontroller_basics.html @@ -199,18 +199,20 @@ ul#navMain {

Chapters

- What does a controller do? + What Does a Controller do?
- Methods and actions + Methods and Actions
Parameters

Session

Disabling the session
Disabling the Session
Accessing the session
Accessing the Session
The flash

Filters

After filters and around filters
After Filters and Around Filters
Other ways to use filters
Other Ways to Use Filters

Verification

- The request and response objects + Request Forgery Protection +
+ The request and response Objects

HTTP Basic Authentication

- Streaming and file downloads + Streaming and File Downloads
- Sending files
- Sending Files
- RESTful downloads
- RESTful Downloads
- Parameter filtering + Parameter Filtering
Rescue
+ Changelog +

@@ -285,24 +293,69 @@ ul#navMain {

Action Controller basics

In this guide you will learn how controllers work and how they fit into the request cycle in your application. You will learn how to make use of the many tools provided by Action Controller to work with the session, cookies and filters and how to use the built-in HTTP authentication and data streaming facilities. In the end, we will take a look at some tools that will be useful once your controllers are ready and working, like how to filter sensitive parameters from the log and how to rescue and deal with exceptions that may be raised during the request.

In this guide you will learn how controllers work and how they fit into the request cycle in your application. After reading this guide, you will be able to:

+
+Follow the flow of a request through a controller +
+
+
+Understand why and how to store data in the session or cookies +
+
+
+Work with filters to execute code during request processing +
+
+
+Use Action Controller's built-in HTTP authentication +
+
+
+Stream data directly to the user's browser +
+
+
+Filter sensitive parameters so they do not appear in the application's log +
+
+
+Deal with exceptions that may be raised during request processing +
+

1. What does a controller do?

1. What Does a Controller do?

Action Controller is the C in MVC. After routing has determined which controller to use for a request, your controller is responsible for making sense of the request and producing the appropriate output. Luckily, Action Controller does most of the groundwork for you and uses smart conventions to make this as straight-forward as possible.

For most conventional RESTful applications, the controller will receive the request (this is invisible to you as the developer), fetch or save data from a model and use a view to create HTML output. If your controller needs to do things a little differently, that's not a problem, this is just the most common way for a controller to work.

A controller can thus be thought of as a middle man between models and views. It makes the model data available to the view so it can display it to the user, and it saves or updates data from the user to the model.

A controller can thus be thought of as a middle man between models and views. It makes the model data available to the view so it can display that data to the user, and it saves or updates data from the user to the model.

+ + +

+ +	For more details on the routing process, see Rails Routing from the Outside In.

2. Methods and actions

2. Methods and Actions

A controller is a Ruby class which inherits from ActionController::Base and has methods just like any other class. Usually these methods correspond to actions in MVC, but they can just as well be helpful methods which can be called by actions. When your application receives a request, the routing will determine which controller and action to run. Then an instance of that controller will be created and the method corresponding to the action (the method with the same name as the action) gets run.

A controller is a Ruby class which inherits from ApplicationController and has methods just like any other class. Usually these methods correspond to actions in MVC, but they can just as well be helpful methods which can be called by actions. When your application receives a request, the routing will determine which controller and action to run. Then Rails creates an instance of that controller and runs the method corresponding to the action (the method with the same name as the action).

class ClientsController < ActionController::Base
+class ClientsController < ApplicationController
 
   # Actions are public methods
   def new
@@ -321,7 +374,7 @@ private
 end

Private methods in a controller are also used as filters, which will be covered later in this guide. -As an example, if the user goes to /clients/new in your application to add a new client, a ClientsController instance will be created and the new method will be run. Note that the empty method from the example above could work just fine because Rails will by default render the new.html.erb view unless the action says otherwise. The new method could make available to the view a @client instance variable by creating a new Client: +As an example, if the user goes to /clients/new in your application to add a new client, Rails will create a ClientsController instance will be created and run the new method. Note that the empty method from the example above could work just fine because Rails will by default render the new.html.erb view unless the action says otherwise. The new method could make available to the view a @client instance variable by creating a new Client:

end

The Layouts & rendering guide explains this in more detail.

ApplicationController inherits from ActionController::Base, which defines a number of helpful methods. This guide will cover some of these, but if you're curious to see what's in there, you can see all of them in the API documentation or in the source itself.

3. Parameters

You will probably want to access data sent in by the user or other parameters in your controller actions. There are two kinds of parameters possible in a web application. The first are parameters that are sent as part of the URL, query string parameters. The query string is everything after "?" in the URL. The second type of parameter is usually referred to as POST data. This information usually comes from a HTML form which has been filled in by the user. It's called POST data because it can only be sent as part of an HTTP POST request. Rails does not make any distinction between query string parameters and POST parameters, and both are available in the params hash in your controller:

You will probably want to access data sent in by the user or other parameters in your controller actions. There are two kinds of parameters possible in a web application. The first are parameters that are sent as part of the URL, called query string parameters. The query string is everything after "?" in the URL. The second type of parameter is usually referred to as POST data. This information usually comes from a HTML form which has been filled in by the user. It's called POST data because it can only be sent as part of an HTTP POST request. Rails does not make any distinction between query string parameters and POST parameters, and both are available in the params hash in your controller:

class ClientsController < ActionController::Base
 
-  # This action uses query string parameters because it gets run by a HTTP GET request,
-  # but this does not make any difference to the way in which the parameters are accessed.
-  # The URL for this action would look like this in order to list activated clients: /clients?status=activated
+  # This action uses query string parameters because it gets run by a HTTP
+  # GET request, but this does not make any difference to the way in which
+  # the parameters are accessed. The URL for this action would look like this
+  # in order to list activated clients: /clients?status=activated
   def index
     if params[:status] = "activated"
       @clients = Client.activated
@@ -370,11 +425,11 @@ http://www.gnu.org/software/src-highlite -->
 
 end

3.1. Hash and array parameters

3.1. Hash and Array Parameters

The params hash is not limited to one-dimensional keys and values. It can contain arrays and (nested) hashes. To send an array of values, append "[]" to the key name:

GET /clients?ids[]=1&ids[2]&ids[]=3

GET /clients?ids[]=1&ids[]=2&ids[]=3

The value of params[:ids] will now be ["1", "2", "3"]. Note that parameter values are always strings; Rails makes no attempt to guess or cast the type.

To send a hash you include the key name inside the brackets:

@@ -388,8 +443,32 @@ http://www.gnu.org/software/src-highlite --> </form>

The value of params[:client] when this form is submitted will be {:name ⇒ "Acme", :phone ⇒ "12345", :address ⇒ {:postcode ⇒ "12345", :city ⇒ "Carrot City"}}. Note the nested hash in params[:client][:address].

3.2. Routing parameters

3.2. Routing Parameters

The params hash will always contain the :controller and :action keys, but you should use the methods controller_name and action_name instead to access these values. Any other parameters defined by the routing, such as :id will also be available. As an example, consider a listing of clients where the list can show either active or inactive clients. We can add a route which captures the :status parameter in a "pretty" URL:

# ...
+map.connect "/clients/:status", :controller => "clients", :action => "index", :foo => "bar"
+# ...
+

In this case, when a user opens the URL /clients/active, params[:status] will be set to "active". When this route is used, params[:foo] will also be set to "bar" just like it was passed in the query string in the same way params[:action] will contain "index".

3.3. `default_url_options`

You can set global default parameters that will be used when generating URLs with default_url_options. To do this, define a method with that name in your controller:

class ApplicationController < ActionController::Base
+
+  #The options parameter is the hash passed in to url_for
+  def default_url_options(options)
+    {:locale => I18n.locale}
+  end
+
+end

These options will be used as a starting-point when generating, so it's possible they'll be overridden by url_for. Because this method is defined in the controller, you can define it on ApplicationController so it would be used for all URL generation, or you could define it on only one controller for all URLs generated there.

4. Session

@@ -416,8 +495,9 @@ ActiveRecordStore - Stores the data in a database using Active Record.

All session stores store the session id in a cookie - there is no other way of passing it to the server. Most stores also use this key to locate the session data on the server.

The default and recommended store, the Cookie Store, does not store session data on the server, but in the cookie itself. The data is cryptographically signed to make it tamper-proof, but it is not encrypted, so anyone with access to it can read its contents. It can only store about 4kB of data - much less than the others - but this is usually enough. Storing large amounts of data is discouraged no matter which session store your application uses. Expecially discouraged is storing complex objects (anything other than basic Ruby objects, the primary example being model instances) in the session, as the server might not be able to reassemble them between requests, which will result in an error. The Cookie Store has the added advantage that it does not require any setting up beforehand - Rails will generate a "secret key" which will be used to sign the cookie when you create the application.

All session stores store either the session ID or the entire session in a cookie - Rails does not allow the session ID to be passed in any other way. Most stores also use this key to locate the session data on the server.

The default and recommended store, the Cookie Store, does not store session data on the server, but in the cookie itself. The data is cryptographically signed to make it tamper-proof, but it is not encrypted, so anyone with access to it can read its contents but not edit it. It can only store about 4kB of data - much less than the others - but this is usually enough. Storing large amounts of data is discouraged no matter which session store your application uses. You should especially avoid storing complex objects (anything other than basic Ruby objects, the primary example being model instances) in the session, as the server might not be able to reassemble them between requests, which will result in an error. The Cookie Store has the added advantage that it does not require any setting up beforehand - Rails will generate a "secret key" which will be used to sign the cookie when you create the application.

Read more about session storage in the Security Guide.

If you need a different session storage mechanism, you can change it in the config/environment.rb file:

# Set to one of [:active_record_store, :drb_store, :mem_cache_store, :cookie_store]
 config.action_controller.session_store = :active_record_store

4.1. Disabling the session

Sometimes you don't need a session, and you can turn it off to avoid the unnecessary overhead. To do this, use the session class method in your controller:

4.1. Disabling the Session

Sometimes you don't need a session. In this case, you can turn it off to avoid the unnecessary overhead. To do this, use the session class method in your controller:

session :on end

Or even a single action:

Or even for specified actions:

session :on, :only => [:create, :update] end

4.2. Accessing the session

4.2. Accessing the Session

In your controller you can access the session through the session instance method.

@@ -481,7 +561,7 @@ http://www.gnu.org/software/src-highlite --> private # Finds the User with the ID stored in the session with the key :current_user_id - # This is a common way to do user login in a Rails application; logging in sets the + # This is a common way to handle user login in a Rails application; logging in sets the# session value and logging out removes it.def current_user @_current_user||= session[:current_user_id]&& User.find(session[:current_user_id]) @@ -525,9 +605,9 @@ http://www.gnu.org/software/src-highlite --> end -

To reset the entire session, use reset_session.

To reset the entire session, use reset_session.

4.3. The flash

The flash is a special part of the session which is cleared with each request. This means that values stored there will only be available in the next request, which is useful for storing error messages etc. It is accessed in much the same way as the session, like a hash. Let's use the act of logging out as an example. The controller can set a message which will be displayed to the user on the next request:

The flash is a special part of the session which is cleared with each request. This means that values stored there will only be available in the next request, which is useful for storing error messages etc. It is accessed in much the same way as the session, like a hash. Let's use the act of logging out as an example. The controller can send a message which will be displayed to the user on the next request:

end

4.3.1. flash.now

4.3.1. `flash.now`

By default, adding values to the flash will make them available to the next request, but sometimes you may want to access those values in the same request. For example, if the create action fails to save a resource and you render the new template directly, that's not going to result in a new request, but you may still want to display a message using the flash. To do this, you can use flash.now in the same way you use the normal flash:

end

Note that while for session values, you set the key to nil, to delete a cookie value, you use cookies.delete(:key).

Note that while for session values, you set the key to nil, to delete a cookie value, you should use cookies.delete(:key).

6. Filters

Filters are methods that are run before, after or "around" a controller action. For example, one filter might check to see if the logged in user has the right credentials to access that particular controller or action. Filters are inherited, so if you set a filter on ApplicationController, it will be run on every controller in your application. A common, simple filter is one which requires that a user is logged in for an action to be run. Let's define the filter method first:

end

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, so to prevent this filter from running you can use skip_before_filter :

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

end

Now, the LoginsController's "new" and "create" actions will work as before without requiring the user to be logged in. The :only option is used to only skip this filter for these actions, and there is also an :except 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.

6.1. After filters and around filters

Now, the LoginsController's "new" and "create" actions will work as before without requiring the user to be logged in. The :only option is used to only skip this filter for these actions, and there is also an :except 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.

6.1. After Filters and Around Filters

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.

end

Note that the filter in this case uses send because the logged_in? method is private and the filter is not run in the scope of the controller. This is not the recommended way to implement this particular filter, but in more simple cases it might be useful.

The second way is to use a class (actually, any object that responds to the right methods will do) to handle the filtering. This is useful in cases that are more complex than can not be implemented in a readable and reusable way using the two other methods. As an example, we will rewrite the login filter again to use a class:

The second way is to use a class (actually, any object that responds to the right methods will do) to handle the filtering. This is useful in cases that are more complex than can not be implemented in a readable and reusable way using the two other methods. As an example, you could rewrite the login filter again to use a class:

end

Again, this is not an ideal example for this filter, because it's not run in the scope of the controller but gets it passed as an argument. The filter class has a class method filter which gets run before or after the action, depending on if it's a before or after filter. Classes used as around filters can also use the same filter method, which will get run in the same way. The method must yield to execute the action. Alternatively, it can have both a before and an after method that are run before and after the action.

Again, this is not an ideal example for this filter, because it's not run in the scope of the controller but gets the controller passed as an argument. The filter class has a class method filter which gets run before or after the action, depending on if it's a before or after filter. Classes used as around filters can also use the same filter method, which will get run in the same way. The method must yield to execute the action. Alternatively, it can have both a before and an after method that are run before and after the action.

The Rails API documentation has more information on using filters.

7. Verification

Verifications make sure certain criterias are met in order for a controller or action to run. They can specify that a certain key (or several keys in the form of an array) is present in the params, session or flash hashes or that a certain HTTP method was used or that the request was made using XMLHTTPRequest (Ajax). The default action taken when these criterias are not met is to render a 400 Bad Request response, but you can customize this by specifying a redirect URL or rendering something else and you can also add flash messages and HTTP headers to the response. It is described in the API codumentation as "essentially a special kind of before_filter".

Let's see how we can use verification to make sure the user supplies a username and a password in order to log in:

Verifications make sure certain criteria are met in order for a controller or action to run. They can specify that a certain key (or several keys in the form of an array) is present in the params, session or flash hashes or that a certain HTTP method was used or that the request was made using XMLHTTPRequest (Ajax). The default action taken when these criteria are not met is to render a 400 Bad Request response, but you can customize this by specifying a redirect URL or rendering something else and you can also add flash messages and HTTP headers to the response. It is described in the API documentation as "essentially a special kind of before_filter".

Here's an example of using verification to make sure the user supplies a username and a password in order to log in:

verify :params => [:username, :password], :render => {:action => "new"}, :add_flash => {:error => "Username and password required to log in"}, - :only => :create #Only run this verification for the "create" action + :only => :create # Only run this verification for the "create" action end

8. The request and response objects

8. Request Forgery Protection

In every controller there are two accessor methods pointing to the request and the response objects associated with the request cycle that is currently in execution. The request method contains an instance of AbstractRequest and the response method contains the response object representing what is going to be sent back to the client.

8.1. The request

The request object contains a lot of useful information about the request coming in from the client. To get a full list of the available methods, refer to the API documentation.

Cross-site request forgery is a type of attack in which a site tricks a user into making requests on another site, possibly adding, modifying or deleting data on that site without the user's knowledge or permission. The first step to avoid this is to make sure all "destructive" actions (create, update and destroy) can only be accessed with non-GET requests. If you're following RESTful conventions you're already doing this. However, a malicious site can still send a non-GET request to your site quite easily, and that's where the request forgery protection comes in. As the name says, it protects from forged requests. The way this is done is to add a non-guessable token which is only known to your server to each request. This way, if a request comes in without the proper token, it will be denied access.

If you generate a form like this:

<% form_for @user do |f| -%>
+  <%= f.text_field :username %>
+  <%= f.text_field :password -%>
+<% end -%>
+

You will see how the token gets added as a hidden field:

<form action="/users/1" method="post">
+<div><!-- ... --><input type="hidden" value="67250ab105eb5ad10851c00a5621854a23af5489" name="authenticity_token"/></div>
+<!-- Fields -->
+</form>
+

Rails adds this token to every form that's generated using the form helpers, so most of the time you don't have to worry about it. If you're writing a form manually or need to add the token for another reason, it's available through the method form_authenticity_token:

Example: Add a JavaScript variable containing the token for use with Ajax

<%= javascript_tag "MyApp.authenticity_token = '#{form_authenticity_token}'" %>

The Security Guide has more about this and a lot of other security-related issues that you should be aware of when developing a web application.

9. The `request` and `response` Objects

In every controller there are two accessor methods pointing to the request and the response objects associated with the request cycle that is currently in execution. The request method contains an instance of AbstractRequest and the response method returns a response object representing what is going to be sent back to the client.

9.1. The `request` Object

The request object contains a lot of useful information about the request coming in from the client. To get a full list of the available methods, refer to the API documentation. Among the properties that you can access on this object:

@@ -812,7 +925,7 @@ host - The hostname used for this request.
-domain - The hostname without the first part (usually "www"). +domain - The hostname without the first segment (usually "www").
@@ -861,9 +974,9 @@ url - The entire URL used for the request.

8.1.1. path_parameters, query_parameters and request_parameters

8.2. The response

9.1.1. `path_parameters`, `query_parameters` and `request_parameters`

Rails collects all of the parameters sent along with the request in the params hash, whether they are sent as part of the query string or the post body. The request object has three accessors that give you access to these parameters depending on where they came from. The query_parameters hash contains parameters that were sent as part of the query string while the request_parameters hash contains parameters sent as part of the post body. The path_parameters hash contains parameters that were recognized by the routing as being part of the path leading to this particular controller and action.

9.2. The `response` Object

@@ -891,11 +1004,25 @@ content_type - The content type of the response. charset - The character set being used for the response. Default is "utf8".
+
+headers - Headers used for the response. +
+

9.2.1. Setting Custom Headers

If you want to set custom headers for a response then response.headers is the place to do it. The headers attribute is a hash which maps header names to their values, and Rails will set some of them - like "Content-Type" - automatically. If you want to add or change a header, just assign it to headers with the name and value:

response.headers["Content-Type"] = "application/pdf"
+

9. HTTP Basic Authentication

10. HTTP Basic Authentication

Rails comes with built-in HTTP Basic authentication. This is an authentication scheme that is supported by the majority of browsers and other HTTP clients. As an example, consider an administration section which will only be available by entering a username and a password into the browser's HTTP Basic dialog window. Using the built-in authentication is quite easy and only requires you to use one method, authenticate_or_request_with_http_basic.

- +

Be careful when using (or just don't use) "outside" data (params, cookies, etc) to locate the file on disk, as this is a security risk as someone could gain access to files they are not meant to have access to.

Be careful when using (or just don't use) "outside" data (params, cookies, etc) to locate the file on disk, as this is a security risk that might allow someone to gain access to files they are not meant to see.

@@ -985,8 +1112,8 @@ http://www.gnu.org/software/src-highlite --> 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.

10.2. RESTful downloads

While send_data works just fine, if you are creating a RESTful application having separate actions for file downloads is usually not necessary. In REST terminology, the PDF file from the example above can be considered just another representation of the client resource. Rails provides an easy and quite sleek way of doing "RESTful downloads". Let's try to rewrite the example so that the PDF download is a part of the show action:

11.2. RESTful Downloads

While send_data works just fine, if you are creating a RESTful application having separate actions for file downloads is usually not necessary. In REST terminology, the PDF file from the example above can be considered just another representation of the client resource. Rails provides an easy and quite sleek way of doing "RESTful downloads". Here's how you can rewrite the example so that the PDF download is a part of the show action, without any streaming:

end

In order for this example to work, we have to add the PDF MIME type to Rails. This can be done by adding the following line to the file config/initializers/mime_types.rb:

In order for this example to work, you have to add the PDF MIME type to Rails. This can be done by adding the following line to the file config/initializers/mime_types.rb:

GET /clients/1.pdf

11. Parameter filtering

12. Parameter Filtering

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 filter_parameter_logging method can be used to filter out sensitive information from the log. It works by replacing certain values in the params 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":

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 filter_parameter_logging method can be used to filter out sensitive information from the log. It works by replacing certain values in the params 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":

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.

12. Rescue

13. Rescue

Most likely your application is going to contain bugs or otherwise throw an exception that needs to be handled. For example, if the user follows a link to a resource that no longer exists in the database, Active Record will throw the ActiveRecord::RecordNotFound exception. Rails' default exception handling displays a 500 Server Error message for all exceptions. If the request was made locally, a nice traceback and some added information gets displayed so you can figure out what went wrong and deal with it. If the request was remote Rails will just display a simple "500 Server Error" message to the user, or a "404 Not Found" if there was a routing error or a record could not be found. Sometimes you might want to customize how these errors are caught and how they're displayed to the user. There are several levels of exception handling available in a Rails application:

12.1. The default 500 and 404 templates

13.1. The Default 500 and 404 Templates

By default a production application will render either a 404 or a 500 error message. These messages are contained in static HTML files in the public folder, in 404.html and 500.html respectively. You can customize these files to add some extra information and layout, but remember that they are static; i.e. you can't use RHTML or layouts in them, just plain HTML.

12.2. `rescue_from`

If you want to do something a bit more elaborate when catching errors, you can use rescue_from, which handles exceptions of a certain type (or multiple types) in an entire controller and its subclasses. When an exception occurs which is caught by a rescue_from directive, the exception object is passed to the handler. The handler can be a method or a Proc object passed to the :with option. You can also use a block directly instead of an explicit Proc object.

Let's see how we can use rescue_from to intercept all ActiveRecord::RecordNotFound errors and do something with them.

13.2. `rescue_from`

If you want to do something a bit more elaborate when catching errors, you can use rescue_from, which handles exceptions of a certain type (or multiple types) in an entire controller and its subclasses. When an exception occurs which is caught by a rescue_from directive, the exception object is passed to the handler. The handler can be a method or a Proc object passed to the :with option. You can also use a block directly instead of an explicit Proc object.

Here's how you can use rescue_from to intercept all ActiveRecord::RecordNotFound errors and do something with them.

class Person < ActiveRecord::Base
+end
+

We can see how it works by looking at the following script/console output:

>> p = Person.new(:name => "John Doe", :birthdate => Date.parse("09/03/1979"))
+=> #<Person id: nil, name: "John Doe", birthdate: "1979-09-03", created_at: nil, updated_at: nil>
+>> p.new_record?
+=> true
+>> p.save
+=> true
+>> p.new_record?
+=> false

Saving new records means sending an SQL insert operation to the database, while saving existing records (by calling either save, update_attribute or update_attributes) 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.

2.2. The meaning of valid

For verifying if an object is valid, Active Record uses the valid? 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 errors instance method. The proccess is really simple: If the errors 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 errors collection.

3. The declarative validation helpers

Active Record offers many pre-defined validation helpers that you can use directly inside your class definitions. These helpers create validations rules that are commonly used in most of the applications that you'll write, so you don't need to recreate it everytime, avoiding code duplication, keeping everything organized and boosting your productivity. Everytime a validation fails, an error message is added to the object's errors collection, this message being associated with the field being validated.

All these helpers accept the :on and :message options, which define when the validation should be applied and what message should be added to the errors collection when it fails, respectively. The :on option takes one the values :save (it's the default), :create or :update. There is a default error message for each one of the validation helpers. These messages are used when the :message option isn't used. Let's take a look at each one of the available helpers, listed in alphabetic order.

3.1. The `validates_acceptance_of` helper

Validates that a checkbox has been checked for agreement purposes. It's normally used when the user needs to agree with your application's terms of service, confirm reading some clauses or any similar concept. This validation is very specific to web applications and actually this acceptance does not need to be recorded anywhere in your database (if you don't have a field for it, the helper will just create a virtual attribute).

class Person < ActiveRecord::Base
+  validates_acceptance_of :terms_of_service
+end
+

The default error message for validates_acceptance_of is "must be accepted"

validates_acceptance_of can receive an :accept option, which determines the value that will be considered acceptance. It defaults to "1", but you can change it.

class Person < ActiveRecord::Base
+  validates_acceptance_of :terms_of_service, :accept => 'yes'
+end
+

3.2. The `validates_associated` helper

3.3. The `validates_confirmation_of` helper

3.4. The `validates_each` helper

3.5. The `validates_exclusion_of` helper

3.6. The `validates_format_of` helper

3.7. The `validates_inclusion_of` helper

3.8. The `validates_length_of` helper

3.9. The `validates_numericallity_of` helper

3.10. The `validates_presence_of` helper

3.11. The `validates_size_of` helper

3.12. The validates_uniqueness_of+ helper

4. Common validation options

There are two kinds of Active Record objects: those that correspond to a row inside your database and those who do not. When you create a fresh object, using the new method, that object does not belong to the database yet. Once you call save upon that object it'll be recorded to it's table. Active Record uses the new_record? instance method to discover if an object is already in the database or not. Saving new records means sending an SQL insert operation to the database, while saving existing records (by calling either save, update_attribute or update_attributes) 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.

3. Credits

5. Credits

4. Changelog

6. Changelog

http://rails.lighthouseapp.com/projects/16213/tickets/26-active-record-validations-and-callbacks

-- cgit v1.2.3 From 879eba22f220c8e7c779786eb68f31631f59a53c Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Fri, 7 Nov 2008 21:17:57 -0200 Subject: added doc for validates_associated --- .../html/activerecord_validations_callbacks.html | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index a645f175fd..7125b7252f 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -370,6 +370,27 @@ http://www.gnu.org/software/src-highlite --> end

3.2. The `validates_associated` helper

You should use this helper when your model has associations with other models and they also need to be validated. When you try to save your object, valid? will be called upon each one of the associated objects.

class Library < ActiveRecord::Base
+  has_many :books
+  validates_associated :books
+end
+

This validation will work with all the association types.

+ + + +

+ +	Pay attention not to use `validates_associated` on both ends of your associations, because this will lead to several recursive calls and blow up the method calls' stack.

The default error message for validates_associated is "is invalid". Note that the errors for each failed validation in the associated objects will be set there and not in this model.

3.3. The `validates_confirmation_of` helper

3.4. The `validates_each` helper

3.5. The `validates_exclusion_of` helper

-- cgit v1.2.3 From 2cefcef8fef68cf1a7ecfd6a8325b63910d80e32 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Fri, 7 Nov 2008 23:28:21 -0200 Subject: Added documentation for validates_confirmation_of --- .../guides/html/activerecord_validations_callbacks.html | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 7125b7252f..0f03a7ebae 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -392,6 +392,23 @@ http://www.gnu.org/software/src-highlite -->

The default error message for validates_associated is "is invalid". Note that the errors for each failed validation in the associated objects will be set there and not in this model.

3.3. The `validates_confirmation_of` helper

You should use this helper when you have two text fields that should receive exactly the same content, like when you want to confirm an email address or password. This validation creates a virtual attribute, using the name of the field that has to be confirmed with _confirmation appended.

class Person < ActiveRecord::Base
+  validates_confirmation_of :email
+end
+

In your view template you could use something like

<%= text_field :person, :email %>
+<%= text_field :person, :email_confirmation %>

The default error message for validates_confirmation_of is "doesn't match confirmation"

3.4. The `validates_each` helper

3.5. The `validates_exclusion_of` helper

3.6. The `validates_format_of` helper

-- cgit v1.2.3 From 4d122503bb7339d8d87fb54ae5f65ab30c17edd5 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Fri, 7 Nov 2008 23:51:45 -0200 Subject: Added some aditional info to validates_confirmation_of --- .../html/activerecord_validations_callbacks.html | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 0f03a7ebae..1f11ce4d08 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -408,6 +408,24 @@ http://www.gnu.org/software/src-highlite -->

<%= text_field :person, :email %>
 <%= text_field :person, :email_confirmation %>

+ + + +

+ +	This check is performed only if `email_confirmation` is not nil, and by default only on save. To require confirmation, make sure to add a presence check for the confirmation attribute:

class Person < ActiveRecord::Base
+  validates_confirmation_of :email
+  validates_presence_of :email_confirmation
+end
+

The default error message for validates_confirmation_of is "doesn't match confirmation"

3.4. The `validates_each` helper

3.5. The `validates_exclusion_of` helper

-- cgit v1.2.3 From 30a789429948886f0ef7d8204420277c68ab4d18 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Fri, 7 Nov 2008 23:59:36 -0200 Subject: Some more text on validates_confirmation_of, added some more about validations helpers too --- railties/doc/guides/html/activerecord_validations_callbacks.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 1f11ce4d08..a16fbaad05 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -346,6 +346,7 @@ http://www.gnu.org/software/src-highlite -->

3. The declarative validation helpers

Each helper accepts an arbitrary number of attributes, received as symbols, so with a single line of code you can add the same kind of validation to several attributes.

3.1. The `validates_acceptance_of` helper

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

-This check is performed only if email_confirmation is not nil, and by default only on save. To require confirmation, make sure to add a presence check for the confirmation attribute: +This check is performed only if email_confirmation is not nil, and by default only on save. To require confirmation, make sure to add a presence check for the confirmation attribute (we'll take a look at validates_presence_of later on this guide):

-- cgit v1.2.3 From 119a6397f5edb5732c0dfcb2eb750649065004bd Mon Sep 17 00:00:00 2001 From: Mike Gunderloy Date: Sun, 9 Nov 2008 06:45:34 -0600 Subject: Fix major gaffe about shallow routes in routing guide & release notes, regen guides html --- railties/doc/guides/html/2_2_release_notes.html | 2 +- railties/doc/guides/html/configuring.html | 438 +++++++++++++++++++++ .../guides/html/debugging_rails_applications.html | 4 +- railties/doc/guides/html/finders.html | 204 ++++++---- .../guides/html/getting_started_with_rails.html | 4 +- railties/doc/guides/html/migrations.html | 4 +- railties/doc/guides/html/routing_outside_in.html | 10 +- 7 files changed, 583 insertions(+), 83 deletions(-) create mode 100644 railties/doc/guides/html/configuring.html (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/2_2_release_notes.html b/railties/doc/guides/html/2_2_release_notes.html index 931786ef6c..e234242ade 100644 --- a/railties/doc/guides/html/2_2_release_notes.html +++ b/railties/doc/guides/html/2_2_release_notes.html @@ -695,7 +695,7 @@ Counter cache columns (for associations declared with :counter_cache ⇒

On the controller side, there are a couple of changes that will help tidy up your routes. 6.1. Shallow Route Nesting -Shallow route nesting provides a solution to the well-known difficulty of using deeply-nested resources. With shallow nesting, you need only supply enough information to uniquely identify the resource that you want to work with - but you can supply more information. +Shallow route nesting provides a solution to the well-known difficulty of using deeply-nested resources. With shallow nesting, you need only supply enough information to uniquely identify the resource that you want to work with.

+ + + + + + + + + + + + Ruby on Rails + Sustainable productivity for web-application development + + + Ruby on Rails + Guides Index + + + + + + + Chapters + + + Locations for Initialization Code + + + Using a Preinitializer + + + Configuring Rails Components + + + Configuring Active Record + + Configuring Action Controller + + Configuring Action View + + Configuring Action Mailer + + Configuring Active Resource + + Configuring Active Support + + + + + Using Initializers + + + Using an After-Initializer + + + Changelog + + + + + + Configuring Rails Applications + + +This guide covers the configuration and initialization features available to Rails applications. By referring to this guide, you will be able to: + + + +Adjust the behavior of your Rails applications + + + + +Add additional code to be run at application start time + + + + + +1. Locations for Initialization Code + +preinitializers +environment.rb first +env-specific files +initializers (load_application_initializers) +after-initializer + +2. Using a Preinitializer + + +3. Configuring Rails Components + +3.1. Configuring Active Record +3.2. Configuring Action Controller +3.3. Configuring Action View +3.4. Configuring Action Mailer +3.5. Configuring Active Resource +3.6. Configuring Active Support + +4. Using Initializers + + + +organization, controlling load order + + +5. Using an After-Initializer + + +6. Changelog + +Lighthouse ticket + + + +November 5, 2008: Rough outline by Mike Gunderloy + + + +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 +actionmailer/Rakefile +36: rdoc.options << —line-numbers << —inline-source << -A cattr_accessor=object +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 +actionpack/lib/action_controller/caching/pages.rb +55: cattr_accessor :page_cache_directory +58: cattr_accessor :page_cache_extension +actionpack/lib/action_controller/caching.rb +37: cattr_reader :cache_store +48: cattr_accessor :perform_caching +actionpack/lib/action_controller/dispatcher.rb +98: cattr_accessor :error_file_path +actionpack/lib/action_controller/mime_type.rb +24: cattr_reader :html_types, :unverifiable_types +actionpack/lib/action_controller/rescue.rb +36: base.cattr_accessor :rescue_responses +40: base.cattr_accessor :rescue_templates +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 +actionpack/lib/action_controller/vendor/html-scanner/html/sanitizer.rb +44: cattr_accessor :included_tags, :instance_writer ⇒ false +actionpack/lib/action_view/base.rb +189: cattr_accessor :debug_rjs +193: cattr_accessor :warn_cache_misses +actionpack/lib/action_view/helpers/active_record_helper.rb +7: cattr_accessor :field_error_proc +actionpack/lib/action_view/helpers/form_helper.rb +805: cattr_accessor :default_form_builder +actionpack/lib/action_view/template_handlers/erb.rb +47: cattr_accessor :erb_trim_mode +actionpack/test/active_record_unit.rb +5: cattr_accessor :able_to_connect +6: cattr_accessor :connected +actionpack/test/controller/filters_test.rb +286: cattr_accessor :execution_log +actionpack/test/template/form_options_helper_test.rb +3:TZInfo::Timezone.cattr_reader :loaded_zones +activemodel/lib/active_model/errors.rb +28: cattr_accessor :default_error_messages +activemodel/Rakefile +19: rdoc.options << —line-numbers << —inline-source << -A cattr_accessor=object +activerecord/lib/active_record/attribute_methods.rb +9: base.cattr_accessor :attribute_types_cached_by_default, :instance_writer ⇒ false +11: base.cattr_accessor :time_zone_aware_attributes, :instance_writer ⇒ false +activerecord/lib/active_record/base.rb +394: cattr_accessor :logger, :instance_writer ⇒ false +443: cattr_accessor :configurations, :instance_writer ⇒ false +450: cattr_accessor :primary_key_prefix_type, :instance_writer ⇒ false +456: cattr_accessor :table_name_prefix, :instance_writer ⇒ false +461: cattr_accessor :table_name_suffix, :instance_writer ⇒ false +467: cattr_accessor :pluralize_table_names, :instance_writer ⇒ false +473: cattr_accessor :colorize_logging, :instance_writer ⇒ false +478: cattr_accessor :default_timezone, :instance_writer ⇒ false +487: cattr_accessor :schema_format , :instance_writer ⇒ false +491: cattr_accessor :timestamped_migrations , :instance_writer ⇒ false +activerecord/lib/active_record/connection_adapters/abstract/connection_specification.rb +11: cattr_accessor :connection_handler, :instance_writer ⇒ false +activerecord/lib/active_record/connection_adapters/mysql_adapter.rb +166: cattr_accessor :emulate_booleans +activerecord/lib/active_record/fixtures.rb +498: cattr_accessor :all_loaded_fixtures +activerecord/lib/active_record/locking/optimistic.rb +38: base.cattr_accessor :lock_optimistically, :instance_writer ⇒ false +activerecord/lib/active_record/migration.rb +259: cattr_accessor :verbose +activerecord/lib/active_record/schema_dumper.rb +13: cattr_accessor :ignore_tables +activerecord/lib/active_record/serializers/json_serializer.rb +4: base.cattr_accessor :include_root_in_json, :instance_writer ⇒ false +activerecord/Rakefile +142: rdoc.options << —line-numbers << —inline-source << -A cattr_accessor=object +activerecord/test/cases/lifecycle_test.rb +61: cattr_reader :last_inherited +activerecord/test/cases/mixin_test.rb +9: cattr_accessor :forced_now_time +activeresource/lib/active_resource/base.rb +206: cattr_accessor :logger +activeresource/Rakefile +43: rdoc.options << —line-numbers << —inline-source << -A cattr_accessor=object +activesupport/lib/active_support/buffered_logger.rb +17: cattr_accessor :silencer +activesupport/lib/active_support/cache.rb +81: cattr_accessor :logger +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) +activesupport/lib/active_support/core_ext/logger.rb +34: cattr_accessor :silencer +activesupport/test/core_ext/class/attribute_accessor_test.rb +6: cattr_accessor :foo +7: cattr_accessor :bar, :instance_writer ⇒ false +activesupport/test/core_ext/module/synchronization_test.rb +6: @target.cattr_accessor :mutex, :instance_writer ⇒ false +railties/doc/guides/html/creating_plugins.html +786: cattr_accessor <span style="color: #990000">:</span>yaffle_text_field<span style="color: #990000">,</span> <span style="color: #990000">:</span>yaffle_date_field +860: cattr_accessor <span style="color: #990000">:</span>yaffle_text_field<span style="color: #990000">,</span> <span style="color: #990000">:</span>yaffle_date_field +railties/lib/rails_generator/base.rb +93: cattr_accessor :logger +railties/Rakefile +265: rdoc.options << —line-numbers << —inline-source << —accessor << cattr_accessor=object +railties/test/rails_info_controller_test.rb +12: cattr_accessor :local_request +Rakefile +32: rdoc.options << -A cattr_accessor=object + + + + + + diff --git a/railties/doc/guides/html/debugging_rails_applications.html b/railties/doc/guides/html/debugging_rails_applications.html index 95f5b39e4c..0653caaf7a 100644 --- a/railties/doc/guides/html/debugging_rails_applications.html +++ b/railties/doc/guides/html/debugging_rails_applications.html @@ -939,7 +939,7 @@ No breakpoints.

-finish [frame-number] (or fin): execute until the selected stack frame returns. If no frame number is given, the application run until the currently selected frame returns. The currently selected frame starts out the most-recent frame or 0 if no frame positioning (e.g up, down or frame) has been performed. If a frame number is given it will run until the specified frame returns. +finish [frame-number] (or fin): execute until the selected stack frame returns. If no frame number is given, the application will run until the currently selected frame returns. The currently selected frame starts out the most-recent frame or 0 if no frame positioning (e.g up, down or frame) has been performed. If a frame number is given it will run until the specified frame returns.

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

-Footnotes: Every Rails page has footnotes that link give request information and link back to your source via TextMate. +Footnotes: Every Rails page has footnotes that give request information and link back to your source via TextMate.

diff --git a/railties/doc/guides/html/finders.html b/railties/doc/guides/html/finders.html index 18bc32306f..02c1654aa5 100644 --- a/railties/doc/guides/html/finders.html +++ b/railties/doc/guides/html/finders.html @@ -198,9 +198,6 @@ ul#navMain {

Chapters

- In the beginning… -
The Sample Models
Named Scopes +
- Simple Named Scopes
- Combining Named Scopes
- Runtime Evaluation of Named Scope Conditions
- Named Scopes with Multiple Models
- Arguments to Named Scopes
- Anonymous Scopes
Existence of Objects @@ -293,25 +305,48 @@ ul#navMain {
Rails Finders
-
This guide is all about the find method defined in ActiveRecord::Base, finding on associations, and associated goodness such as named scopes. You will learn how to be a find master.
-
+
This guide covers the find method defined in ActiveRecord::Base, as well as other ways of finding particular instances of your models. By using this guide, you will be able to:
+
- +
  +Find records using a variety of methods and conditions +
  +
- +
  +Specify the order, retrieved attributes, grouping, and other properties of the found records +
  +
- +
  +Use eager loading to cut down on the number of database queries in your application +
  +
- +
  +Use dynamic finders +
  +
- +
  +Create named scopes to add custom finding behavior to your models +
  +
- +
  +Check for the existence of particular records +
  +
- +
  +Perform aggregate calculations on Active Record models +
  +
+
If you're used to using raw SQL to find database records, you'll find that there are generally better ways to carry out the same operations in Rails. Active Record insulates you from the need to use SQL in most cases.
-
1. In the beginning…
-
-
In the beginning there was SQL. SQL looked like this:
-
-
-
```
SELECT * FROM clients
-SELECT * FROM clients WHERE id = '1'
-SELECT * FROM clients LIMIT 0,1
-SELECT * FROM clients ORDER BY id DESC LIMIT 0,1
-
```
-
In Rails (unlike some other frameworks) you don't usually have to type SQL because Active Record is there to help you find your records.
-
2. The Sample Models
+
1. The Sample Models

This guide demonstrates finding using the following models:

@@ -342,11 +377,11 @@ http://www.gnu.org/software/src-highlite --> end

3. Database Agnostic

2. Database Agnostic

Active Record will perform queries on the database for you and is compatible with most database systems (MySQL, PostgreSQL and SQLite to name a few). Regardless of which database system you're using, the Active Record method format will always be the same.

4. IDs, First, Last and All

3. IDs, First, Last and All

ActiveRecord::Base has methods defined on it to make interacting with your database and the tables within it much, much easier. For finding records, the key method is find. This method allows you to pass arguments into it to perform certain queries on your database without the need of SQL. If you wanted to find the record with the id of 1, you could type Client.find(1) which would execute this query on your database:

@@ -381,6 +416,14 @@ http://www.gnu.org/software/src-highlite --> created_at: "2008-09-28 13:12:40", updated_at: "2008-09-28 13:12:40">]

Note that if you pass in a list of numbers that the result will be returned as an array, not as a single Client object.

+ + + +

+ +	If `find(id)` or `find([id1, id2])` fails to find any records, it will raise a `RecordNotFound` exception.

If you wanted to find the first client you would simply type Client.first and that would find the first client created in your clients table:

@@ -423,15 +466,21 @@ http://www.gnu.org/software/src-highlite -->

5. Conditions

4. Conditions

5.1. Pure String Conditions

The find method allows you to specify conditions to limit the records returned. You can specify conditions as a string, array, or hash.

4.1. Pure String Conditions

If you'd like to add conditions to your find, you could just specify them in there, just like Client.first(:conditions ⇒ "orders_count = 2"). This will find all clients where the orders_count field's value is 2.

5.2. Array Conditions

Now what if that number could vary, say as a parameter from somewhere, or perhaps from the user's level status somewhere? The find then becomes something like +Client.first(:conditions => ["orders_count = ?", params[:orders]])+. Active Record will go through the first element in the conditions value and any additional elements will replace the question marks (?) in the first element. If you want to specify two conditions, you can do it like +Client.first(:conditions => ["orders_count = ? AND locked = ?", params[:orders], false])+. In this example, the first question mark will be replaced with the value in params orders and the second will be replaced with true and this will find the first record in the table that has '2' as its value for the orders_count field and 'false' for its locked field.

+ + + +

+ +	Building your own conditions as pure strings can leave you vulnerable to SQL injection exploits. For example, `Client.first(:conditions ⇒ "name LIKE %#{params[:name]}%")` is not safe. See the next section for the preferred way to handle conditions using an array.

4.2. Array Conditions

Now what if that number could vary, say as a parameter from somewhere, or perhaps from the user's level status somewhere? The find then becomes something like Client.first(:conditions ⇒ ["orders_count = ?", params[:orders]]). Active Record will go through the first element in the conditions value and any additional elements will replace the question marks (?) in the first element. If you want to specify two conditions, you can do it like Client.first(:conditions ⇒ ["orders_count = ? AND locked = ?", params[:orders], false]). In this example, the first question mark will be replaced with the value in params orders and the second will be replaced with true and this will find the first record in the table that has 2 as its value for the orders_count field and false for its locked field.

The reason for doing code like:

["created_at >= ? AND created_at <= ?", params[:start_date], params[:end_date]])

Just like in Ruby.

5.3. Hash Conditions

4.3. Hash Conditions

Similar to the array style of params you can also specify keys in your conditions:

This makes for clearer readability if you have a large number of variable conditions.

6. Ordering

5. Ordering

If you're getting a set of records and want to force an order, you can use Client.all(:order ⇒ "created_at") which by default will sort the records by ascending order. If you'd like to order it in descending order, just tell it to do that using Client.all(:order ⇒ "created_at desc")

7. Selecting Certain Fields

6. Selecting Certain Fields

To select certain fields, you can use the select option like this: Client.first(:select ⇒ "viewable_by, locked"). This select option does not use an array of fields, but rather requires you to type SQL-like code. The above code will execute SELECT viewable_by, locked FROM clients LIMIT 0,1 on your database.

8. Limit & Offset

7. Limit & Offset

If you want to limit the amount of records to a certain subset of all the records retreived you usually use limit for this, sometimes coupled with offset. Limit is the maximum number of records that will be retreived from a query, and offset is the number of records it will start reading from from the first record of the set. Take this code for example:

If you want to limit the amount of records to a certain subset of all the records retrieved you usually use limit for this, sometimes coupled with offset. Limit is the maximum number of records that will be retrieved from a query, and offset is the number of records it will start reading from from the first record of the set. Take this code for example:

SELECT * FROM clients LIMIT 5, 5

9. Group

8. Group

The group option for find is useful, for example, if you want to find a collection of the dates orders were created on. You could use the option in this context:

@@ -595,9 +644,9 @@ http://www.gnu.org/software/src-highlite -->

SELECT * FROM +orders+ GROUP BY date(created_at)

10. Read Only

9. Read Only

Readonly is a find option that you can set in order to make that instance of the record read-only. Any attempt to alter or destroy the record will not succeed, raising an Active Record::ReadOnlyRecord error. To set this option, specify it like this:

Client.first(:readonly => true)

If you assign this record to a variable client, calling the following code will raise an ActiveRecord::ReadOnlyRecord:

If you assign this record to a variable client, calling the following code will raise an ActiveRecord::ReadOnlyRecord exception:

end

12. Making It All Work Together

11. Making It All Work Together

You can chain these options together in no particular order as Active Record will write the correct SQL for you. If you specify two instances of the same options inside the find statement ActiveRecord will use the latter.

13. Eager Loading

12. Eager Loading

Eager loading is loading associated records along with any number of records in as few queries as possible. For example, if you wanted to load all the addresses associated with all the clients in a single query you could use Client.all(:include ⇒ :address). If you wanted to include both the address and mailing address for the client you would use +Client.find(:all), :include ⇒ [:address, :mailing_address]). Include will first find the client records and then load the associated address records. Running script/server in one window, and executing the code through script/console in another window, the output should look similar to this:

Eager loading is loading associated records along with any number of records in as few queries as possible. For example, if you wanted to load all the addresses associated with all the clients in a single query you could use Client.all(:include ⇒ :address). If you wanted to include both the address and mailing address for the client you would use +Client.find(:all, :include ⇒ [:address, :mailing_address]). Include will first find the client records and then load the associated address records. Running script/server in one window, and executing the code through script/console in another window, the output should look similar to this:

["orders.created_at >= ? AND orders.created_at <= ?", Time.now - 2.weeks, Time.now])

14. Dynamic finders

13. Dynamic finders

For every field (also known as an attribute) you define in your table, Active Record provides a finder method. If you have a field called name on your Client model for example, you get find_by_name and find_all_by_name for free from Active Record. If you have also have a locked field on the client model, you also get find_by_locked and find_all_by_locked. If you want to find both by name and locked, you can chain these finders together by simply typing and between the fields for example Client.find_by_name_and_locked(Ryan, true). These finders are an excellent alternative to using the conditions option, mainly because it's shorter to type find_by_name(params[:name]) than it is to type first(:conditions ⇒ ["name = ?", params[:name]]).

There's another set of dynamic finders that let you find or create/initialize objects if they aren't find. These work in a similar fashion to the other finders and can be used like find_or_create_by_name(params[:name]). Using this will firstly perform a find and then create if the find returns nil. The SQL looks like this for Client.find_or_create_by_name(Ryan):

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

will either assign an existing client object with the name Ryan to the client local variable, or initialize new object similar to calling Client.new(:name ⇒ Ryan). From here, you can modify other fields in client by calling the attribute setters on it: client.locked = true and when you want to write it to the database just call save on it.

15. Finding By SQL

14. Finding By SQL

If you'd like to use your own SQL to find records a table you can use find_by_sql. The find_by_sql method will return an array of objects even if it only returns a single record in it's call to the database. For example you could run this query:

@@ -714,11 +763,11 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite -->

Client.find_by_sql("SELECT * FROM clients INNER JOIN orders ON clients.id = orders.client_id ORDER clients.created_at desc")

find_by_sql provides you with a simple way of making custom calls to the database and retreiving instantiated objects.

find_by_sql provides you with a simple way of making custom calls to the database and retrieving instantiated objects.

16. `select_all`

15. `select_all`

find_by_sql has a close relative called select_all. select_all will retreive objects from the database using custom SQL just like find_by_sql but will not instantiate them. Instead, you will get an array of hashes where each hash indicates a record.

find_by_sql has a close relative called connection#select_all. select_all will retrieve objects from the database using custom SQL just like find_by_sql but will not instantiate them. Instead, you will get an array of hashes where each hash indicates a record.

Client.connection.select_all("SELECT * FROM `clients` WHERE `id` = '1'")

17. Working with Associations

16. Working with Associations

When you define a has_many association on a model you get the find method and dynamic finders also on that association. This is helpful for finding associated records within the scope of an exisiting record, for example finding all the orders for a client that have been sent and not received by doing something like Client.find(params[:id]).orders.find_by_sent_and_received(true, false). Having this find method available on associations is extremely helpful when using nested controllers.

When you define a has_many association on a model you get the find method and dynamic finders also on that association. This is helpful for finding associated records within the scope of an existing record, for example finding all the orders for a client that have been sent and not received by doing something like Client.find(params[:id]).orders.find_by_sent_and_received(true, false). Having this find method available on associations is extremely helpful when using nested controllers.

18. Named Scopes

17. Named Scopes

Named scopes are another way to add custom finding behavior to the models in the application. Suppose want to find all clients who are male. Yould use this code:

Named scopes are another way to add custom finding behavior to the models in the application. Named scopes provide an object-oriented way to narrow the results of a query.

17.1. Simple Named Scopes

Suppose want to find all clients who are male. You could use this code:

named_scope :males, :conditions => { :gender => "male" } end

And you could call it like Client.males.all to get all the clients who are male. Please note that if you do not specify the all on the end you will get a Scope object back, not a set of records which you do get back if you put the all on the end.

Then you could call Client.males.all to get all the clients who are male. Please note that if you do not specify the all on the end you will get a Scope object back, not a set of records which you do get back if you put the all on the end.

If you wanted to find all the clients who are active, you could use this:

named_scope :active, :conditions => { :active => true } end

You can call this new named_scope by doing Client.active.all and this will do the same query as if we just used Client.all(:conditions ⇒ ["active = ?", true]). Please be aware that the conditions syntax in named_scope and find is different and the two are not interchangeable. If you want to find the first client within this named scope you could do Client.active.first.

You can call this new named_scope with Client.active.all and this will do the same query as if we just used Client.all(:conditions ⇒ ["active = ?", true]). Please be aware that the conditions syntax in named_scope and find is different and the two are not interchangeable. If you want to find the first client within this named scope you could do Client.active.first.

17.2. Combining Named Scopes

If you wanted to find all the clients who are active and male you can stack the named scopes like this:

Client.males.active.all(:conditions => ["age > ?", params[:age]])

17.3. Runtime Evaluation of Named Scope Conditions

Consider the following code:

end

And now every time the recent named scope is called, the code in the lambda block will be parsed, so you'll get actually 2 weeks ago from the code execution, not 2 weeks ago from the time the model was loaded.

17.4. Named Scopes with Multiple Models

In a named scope you can use :include and :joins options just like in find.

end

This method, called as Client.active_within_2_weeks.all, will return all clients who have placed orders in the past 2 weeks.

17.5. Arguments to Named Scopes

If you want to pass a named scope a compulsory argument, just specify it as a block parameter like this:

This will work with Client.recent(2.weeks.ago).all and Client.recent.all, with the latter always returning records with a created_at date between right now and 2 weeks ago.

Remember that named scopes are stackable, so you will be able to do Client.recent(2.weeks.ago).unlocked.all to find all clients created between right now and 2 weeks ago and have their locked field set to false.

Finally, if you wish to define named scopes on the fly you can use the scoped method:

17.6. Anonymous Scopes

All Active Record models come with a named scope named scoped, which allows you to create anonymous scopes. For example:

end end

Anonymous scopes are most useful to create scopes "on the fly":

Client.scoped(:conditions => { :gender => "male" })
+

Just like named scopes, anonymous scopes can be stacked, either with other anonymous scopes or with regular named scopes.

19. Existence of Objects

18. Existence of Objects

If you simply want to check for the existence of the object there's a method called exists?. This method will query the database using the same query as find, but instead of returning an object or collection of objects it will return either true or false.

@@ -849,7 +914,7 @@ http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite -->

Client.exists?(1)

The above code will check for the existance of a clients table record with the id of 1 and return true if it exists.

The above code will check for the existence of a clients table record with the id of 1 and return true if it exists.

Client.exists?(:conditions => "first_name = 'Ryan'")

20. Calculations

19. Calculations

This section uses count as an example method in this preamble, but the options described apply to all sub-sections.

count takes conditions much in the same way exists? does:

@@ -907,10 +972,10 @@ http://www.gnu.org/software/src-highlite --> (clients.first_name = 'name' AND orders.status = 'received')

This code specifies clients.first_name just in case one of the join tables has a field also called first_name and it uses orders.status because that's the name of our join table.

20.1. Count

19.1. Count

If you want to see how many records are in your model's table you could call Client.count and that will return the number. If you want to be more specific and find all the clients with their age present in the database you can use Client.count(:age).

For options, please see the parent section, Calculations.

20.2. Average

19.2. Average

If you want to see the average of a certain number in one of your tables you can call the average method on the class that relates to the table. This method call will look something like this:

This will return a number (possibly a floating point number such as 3.14159265) representing the average value in the field.

For options, please see the parent section, Calculations

20.3. Minimum

19.3. Minimum

If you want to find the minimum value of a field in your table you can call the minimum method on the class that relates to the table. This method call will look something like this:

Client.minimum("age")

For options, please see the parent section, Calculations

20.4. Maximum

19.4. Maximum

If you want to find the maximum value of a field in your table you can call the maximum method on the class that relates to the table. This method call will look something like this:

Client.maximum("age")

For options, please see the parent section, Calculations

20.5. Sum

19.5. Sum

If you want to find the sum of a field for all records in your table you can call the sum method on the class that relates to the table. This method call will look something like this:

For options, please see the parent section, Calculations

21. Credits

20. Credits

Thanks to Ryan Bates for his awesome screencast on named scope #108. The information within the named scope section is intentionally similar to it, and without the cast may have not been possible.

Thanks to Mike Gunderloy for his tips on creating this guide.

22. Changelog

21. Changelog

Lighthouse ticket

-October 27, 2008: Added scoped section, added named params for conditions and added sub-section headers for conditions section. +November 8, 2008: Editing pass by Mike Gunderloy . First release version. +
+
+
+October 27, 2008: Added scoped section, added named params for conditions and added sub-section headers for conditions section by Ryan Bigg
-October 27, 2008: Fixed up all points specified in this comment with an exception of the final point. +October 27, 2008: Fixed up all points specified in this comment with an exception of the final point by Ryan Bigg
diff --git a/railties/doc/guides/html/getting_started_with_rails.html b/railties/doc/guides/html/getting_started_with_rails.html index 1b2eac0ce5..5111d0c645 100644 --- a/railties/doc/guides/html/getting_started_with_rails.html +++ b/railties/doc/guides/html/getting_started_with_rails.html @@ -712,7 +712,7 @@ The production environment is used when you deploy your application for

3.3.1. Configuring a SQLite Database

Rails comes with built-in support for SQLite, which is a lightweight flat-file based database application. While a busy production environment may overload SQLite, it works well for development and testing. Rails defaults to using a SQLite database when creating a new project, but you can always change it later.

Rails comes with built-in support for SQLite, which is a lightweight serverless database application. While a busy production environment may overload SQLite, it works well for development and testing. Rails defaults to using a SQLite database when creating a new project, but you can always change it later.

Here's the section of the default configuration file with connection information for the development environment:

For more information on finding records with Active Record, see Active Record Finders.

The respond_to block handles both HTML and XML calls to this action. If you borwse to http://localhost:3000/posts.xml, you'll see all of the posts in XML format. The HTML format looks for a view in app/views/posts/ with a name that corresponds to the action name. Rails makes all of the instance variables from the action available to the view. Here's app/view/posts/index.html.erb:

The respond_to block handles both HTML and XML calls to this action. If you browse to http://localhost:3000/posts.xml, you'll see all of the posts in XML format. The HTML format looks for a view in app/views/posts/ with a name that corresponds to the action name. Rails makes all of the instance variables from the action available to the view. Here's app/view/posts/index.html.erb:

Migrations, mighty as they may be, are not the authoritative source for your database schema. That role falls to either schema.rb or an SQL file which Active Record generates by examining the database. They are not designed to be edited, they just represent the current state of the database.

There is no need (and it is error prone) to deploy a new instance of an app by replaying the entire migration history. It is much simpler and faster to just load into the database a description of the current schema.

For example, this is how the test database is created: the current development database is dumped (either to schema.rb or development.sql) and then loaded into the test database.

Schema files are also useful if want a quick look at what attributes an Active Record object has. This information is not in the model's code and is frequently spread across several migrations but is all summed up in the schema file. The annotate_models plugin, which automatically adds (and updates) comments at the top of each model summarising the schema, may also be of interest.

Schema files are also useful if you want a quick look at what attributes an Active Record object has. This information is not in the model's code and is frequently spread across several migrations but is all summed up in the schema file. The annotate_models plugin, which automatically adds (and updates) comments at the top of each model summarising the schema, may also be of interest.

6.2. Types of schema dumps

There are two ways to dump the schema. This is set in config/environment.rb by the config.active_record.schema_format setting, which may be either :sql or :ruby.

If :ruby is selected then the schema is stored in db/schema.rb. If you look at this file you'll find that it looks an awful lot like one very big migration:

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

7. Active Record and Referential Integrity

The Active Record way is that intelligence belongs in your models, not in the database. As such features such as triggers or foreign key constraints, which push some of that intelligence back into the database are not heavily used.

The Active Record way is that intelligence belongs in your models, not in the database. As such, features such as triggers or foreign key constraints, which push some of that intelligence back into the database are not heavily used.

Validations such as validates_uniqueness_of are one way in which models can enforce data integrity. The :dependent option on associations allows models to automatically destroy child objects when the parent is destroyed. Like anything which operates at the application level these cannot guarantee referential integrity and so some people augment them with foreign key constraints.

Although Active Record does not provide any tools for working directly with such features, the execute method can be used to execute arbitrary SQL. There are also a number of plugins such as redhillonrails which add foreign key support to Active Record (including support for dumping foreign keys in schema.rb).

diff --git a/railties/doc/guides/html/routing_outside_in.html b/railties/doc/guides/html/routing_outside_in.html index a1f1f98cfb..bf9992ff4e 100644 --- a/railties/doc/guides/html/routing_outside_in.html +++ b/railties/doc/guides/html/routing_outside_in.html @@ -1690,15 +1690,7 @@ http://www.gnu.org/software/src-highlite --> /magazines/2/photos ==> magazines_photos_path(2) /photos/3 ==> photo_path(3)

With shallow nesting, you need only supply enough information to uniquely identify the resource that you want to work with - but you can supply more information. All of the nested routes continue to work, just as they would without shallow nesting, but less-deeply nested routes (even direct routes) work as well. So, with the declaration above, all of these routes refer to the same resource:

/publishers/1/magazines/2/photos/3   ==> publisher_magazine_photo_path(1,2,3)
-/magazines/2/photos/3                ==> magazine_photo_path(2,3)
-/photos/3                            ==> photo_path(3)

Shallow nesting gives you the flexibility to use the shorter direct routes when you like, while still preserving the longer nested routes for times when they add code clarity.

If you like, you can combine shallow nesting with the :has_one and :has_many options:

With shallow nesting, you need only supply enough information to uniquely identify the resource that you want to work with. If you like, you can combine shallow nesting with the :has_one and :has_many options:

<%= render :partial => "product", :collection => @products, :as => :item %>

With this change, you can access an instance of the @products collection as the item local variable within the partial.

+ + + +

+ + Rails also makes a counter variable available within a partial called by the collection, named after the member of the collection followed by _counter. For example, if you're rendering @products, within the partial you can refer to product_counter to tell you how many times the partial has been rendered.

You can also specify a second partial to be rendered between instances of the main partial by using the :spacer_template option:

+November 9, 2008: Added partial collection counter by Mike Gunderloy +
+
+
November 1, 2008: Added :js option for render by Mike Gunderloy

Date: Sun, 9 Nov 2008 12:54:27 -0600 Subject: Mention DB2 Adapter transactional migration support in 2.2 relnotes. --- railties/doc/guides/html/2_2_release_notes.html | 7 +++- .../doc/guides/html/actioncontroller_basics.html | 37 ++++++++++++++-------- 2 files changed, 29 insertions(+), 15 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/2_2_release_notes.html b/railties/doc/guides/html/2_2_release_notes.html index e234242ade..59e862a3cb 100644 --- a/railties/doc/guides/html/2_2_release_notes.html +++ b/railties/doc/guides/html/2_2_release_notes.html @@ -525,7 +525,7 @@ More information :

There are two big additions to talk about here: transactional migrations and pooled database transactions. There's also a new (and cleaner) syntax for join table conditions, as well as a number of smaller improvements.

5.1. Transactional Migrations

Historically, multiple-step Rails migrations have been a source of trouble. If something went wrong during a migration, everything before the error changed the database and everything after the error wasn't applied. Also, the migration version was stored as having been executed, which means that it couldn't be simply rerun by rake db:migrate:redo after you fix the problem. Transactional migrations change this by wrapping migration steps in a DDL transaction, so that if any of them fail, the entire migration is undone. In Rails 2.2, transactional migrations are supported on PostgreSQL only. The code is extensible to other database types in the future.

Historically, multiple-step Rails migrations have been a source of trouble. If something went wrong during a migration, everything before the error changed the database and everything after the error wasn't applied. Also, the migration version was stored as having been executed, which means that it couldn't be simply rerun by rake db:migrate:redo after you fix the problem. Transactional migrations change this by wrapping migration steps in a DDL transaction, so that if any of them fail, the entire migration is undone. In Rails 2.2, transactional migrations are supported on PostgreSQL out of the box. The code is extensible to other database types in the future - and IBM has already extended it to support the DB2 adapter.

@@ -542,6 +542,11 @@ More information: DDL Transactions
+
+A major milestone for DB2 on Rails +
+

diff --git a/railties/doc/guides/html/actioncontroller_basics.html b/railties/doc/guides/html/actioncontroller_basics.html index d58536cc37..19d7e9e502 100644 --- a/railties/doc/guides/html/actioncontroller_basics.html +++ b/railties/doc/guides/html/actioncontroller_basics.html @@ -349,7 +349,7 @@ Deal with exceptions that may be raised during request processing

2. Methods and Actions

A controller is a Ruby class which inherits from ApplicationController and has methods just like any other class. When your application receives a request, the routing will determine which controller and action to run, then Rails creates an instance of that controller and runs the public method with the same name as the action.

def new end - # These methods are responsible for producing output + # Action methods are responsible for producing output def edit end @@ -373,8 +373,8 @@ private end

Private methods in a controller are also used as filters, which will be covered later in this guide.

As an example, if the user goes to /clients/new in your application to add a new client, Rails will create a ClientsController instance will be created and run the new method. Note that the empty method from the example above could work just fine because Rails will by default render the new.html.erb view unless the action says otherwise. The new method could make available to the view a @client instance variable by creating a new Client:

There's no rule saying a method on a controller has to be an action; they may well be used for other purposes such as filters, which will be covered later in this guide.

As an example, if a user goes to /clients/new in your application to add a new client, Rails will create an instance of ClientsController and run the new method. Note that the empty method from the example above could work just fine because Rails will by default render the new.html.erb view unless the action says otherwise. The new method could make available to the view a @client instance variable by creating a new Client:

GET /clients?ids[]=1&ids[]=2&ids[]=3

+ + + +

The actual URL in this example will be encoded as "/clients?ids%5b%5d=1&ids%5b%5d=2&ids%5b%5b=3" as [ and ] are not allowed in URLs. Most of the time you don't have to worry about this because the browser will take care of it for you, and Rails will decode it back when it receives it, but if you ever find yourself having to send those requests to the server manually you have to keep this in mind.

The value of params[:ids] will now be ["1", "2", "3"]. Note that parameter values are always strings; Rails makes no attempt to guess or cast the type.

To send a hash you include the key name inside the brackets:

@@ -442,7 +450,8 @@ http://www.gnu.org/software/src-highlite --> <input type="text" name="client[address][city]" value="Carrot City" /> </form>

The value of params[:client] when this form is submitted will be {"name" ⇒ "Acme", "phone" ⇒ "12345", "address" ⇒ {"postcode" ⇒ "12345", "city" ⇒ "Carrot City"}}. Note the nested hash in params[:client][:address].

Note that the params hash is actually an instance of HashWithIndifferentAccess from Active Support which is a subclass of Hash which lets you use symbols and strings interchangeably as keys.

3.2. Routing Parameters

@@ -461,18 +470,18 @@ map.connect "/c

class ApplicationController < ActionController::Base
 
-  #The options parameter is the hash passed in to url_for
+  #The options parameter is the hash passed in to +url_for+
   def default_url_options(options)
     {:locale => I18n.locale}
   end
 
 end

These options will be used as a starting-point when generating, so it's possible they'll be overridden by url_for. Because this method is defined in the controller, you can define it on ApplicationController so it would be used for all URL generation, or you could define it on only one controller for all URLs generated there.

4. Session

Your application has a session for each user in which you can store small amounts of data that will be persisted between requests. The session is only available in the controller and can use one of a number of different storage mechanisms:

Your application has a session for each user in which you can store small amounts of data that will be persisted between requests. The session is only available in the controller and the view and can use one of a number of different storage mechanisms:

@@ -481,12 +490,12 @@ CookieStore - Stores everything on the client.
-DRBStore - Stores the data on a DRb client. +DRbStore - Stores the data on a DRb server.
-MemCacheStore - Stores the data in MemCache. +MemCacheStore - Stores the data in a memcache.
@@ -495,8 +504,8 @@ ActiveRecordStore - Stores the data in a database using Active Record.

The default and recommended store, the Cookie Store, does not store session data on the server, but in the cookie itself. The data is cryptographically signed to make it tamper-proof, but it is not encrypted, so anyone with access to it can read its contents but not edit it. It can only store about 4kB of data - much less than the others - but this is usually enough. Storing large amounts of data is discouraged no matter which session store your application uses. You should especially avoid storing complex objects (anything other than basic Ruby objects, the primary example being model instances) in the session, as the server might not be able to reassemble them between requests, which will result in an error. The Cookie Store has the added advantage that it does not require any setting up beforehand - Rails will generate a "secret key" which will be used to sign the cookie when you create the application.

All session stores use a cookie - this is required and Rails does not allow any part of the session to be passed in any other way (e.g. you can't use the query string to pass a session ID) because of security concerns (it's easier to hijack a session when the ID is part of the URL).

Most stores use a cookie to store the session ID which is then used to look up the session data on the server. The default and recommended store, the CookieStore, does not store session data on the server, but in the cookie itself. The data is cryptographically signed to make it tamper-proof, but it is not encrypted, so anyone with access to it can read its contents but not edit it (Rails will not accept it if it has been edited). It can only store about 4kB of data - much less than the others - but this is usually enough. Storing large amounts of data is discouraged no matter which session store your application uses. You should especially avoid storing complex objects (anything other than basic Ruby objects, the most common example being model instances) in the session, as the server might not be able to reassemble them between requests, which will result in an error. The CookieStore has the added advantage that it does not require any setting up beforehand - Rails will generate a "secret key" which will be used to sign the cookie when you create the application.

Read more about session storage in the Security Guide.

If you need a different session storage mechanism, you can change it in the config/environment.rb file:

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

-There are two session methods, the class and the instance method. The class method which is described above is used to turn the session on and off while the instance method described below is used to access session values. The class method is used outside of method definitions while the instance methods is used inside methods, in actions or filters. +There are two session methods, the class and the instance method. The class method which is described above is used to turn the session on and off while the instance method described below is used to access session values.

Session values are stored using key/value pairs like a hash:

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

The destroy action redirects to the application's root_url, where the message will be displayed. Note that it's entirely up to the next action to decide what, if anything, it will do with what the previous action put in the flash. It's conventional to a display eventual errors or notices from the flash in the application's layout:

The destroy action redirects to the application's root_url, where the message will be displayed. Note that it's entirely up to the next action to decide what, if anything, it will do with what the previous action put in the flash. It's conventional to display eventual errors or notices from the flash in the application's layout:

<html>
-- 
cgit v1.2.3


From 172f3ce35084ac7ae9f37e8cecea00909560a70d Mon Sep 17 00:00:00 2001
From: CassioMarques 
Date: Sat, 8 Nov 2008 10:32:52 -0200
Subject: Added documentation for validates_each

---
 .../doc/guides/html/activerecord_validations_callbacks.html | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'railties/doc/guides/html')

diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html
index a16fbaad05..30e8a82889 100644
--- a/railties/doc/guides/html/activerecord_validations_callbacks.html
+++ b/railties/doc/guides/html/activerecord_validations_callbacks.html
@@ -429,6 +429,19 @@ http://www.gnu.org/software/src-highlite -->

The default error message for validates_confirmation_of is "doesn't match confirmation"

3.4. The `validates_each` helper

This helper validates attributes against a block. It doesn't have a predefined validation function. You should create one using a block, and every attribute passed to validates_each will be tested against it. In the following example, we don't want names and surnames to begin with lower case.

class Person < ActiveRecord::Base
+  validates_each :name, :surname do |model, attr, value|
+    model.errors.add(attr, 'Must start with upper case') if value =~ /^[a-z]/
+  end
+end
+

The block receives the model, the attribute's name and the attribute's value. If your validation fails, you can add an error message to the model, therefore making it invalid.

3.5. The `validates_exclusion_of` helper

3.6. The `validates_format_of` helper

3.7. The `validates_inclusion_of` helper

-- cgit v1.2.3 From 561900fb6715ffd11a1cca672c6c87be6ddda0ae Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Sun, 9 Nov 2008 22:44:17 -0200 Subject: Added documentation for validates_exclusion_of --- .../doc/guides/html/activerecord_validations_callbacks.html | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 30e8a82889..efef58adea 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -443,6 +443,18 @@ http://www.gnu.org/software/src-highlite -->

The block receives the model, the attribute's name and the attribute's value. If your validation fails, you can add an error message to the model, therefore making it invalid.

3.5. The `validates_exclusion_of` helper

This helper validates that the attributes' values are not included in a given set. In fact, this set can be any enumerable object.

class MovieFile < ActiveRecord::Base
+  validates_exclusion_of :format, :in => %w(mov avi), :message => "Extension %s is not allowed"
+end
+

The validates_exclusion_of helper has an option :in that receives the set of values that will not be accepted for the validated attributes. The :in option has an alias called :within that you can use for the same purpose, if you'd like to. In the previous example we used the :message option to show how we can personalize it with the current attribute's value, through the %s format mask.

The default error message for validates_exclusion_of is "is not included in the list"

3.6. The `validates_format_of` helper

3.7. The `validates_inclusion_of` helper

3.8. The `validates_length_of` helper

-- cgit v1.2.3 From 10c7c053a1cfee6f5c87a718bb6913adebaba9ba Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Mon, 10 Nov 2008 00:03:16 -0200 Subject: Added documentation for validates_inclusion_of --- .../html/activerecord_validations_callbacks.html | 25 +++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index efef58adea..26653d396e 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -454,9 +454,32 @@ http://www.gnu.org/software/src-highlite --> end

The default error message for validates_exclusion_of is "is not included in the list"

The default error message for validates_exclusion_of is "is not included in the list".

3.6. The `validates_format_of` helper

This helper validates the attributes's values by testing if they match a given pattern. This pattern must be specified using a Ruby regular expression, which must be passed through the :with option.

class Product < ActiveRecord::Base
+  validates_format_of :description, :with => /^[a-zA-Z]+$/, :message => "Only letters allowed"
+end
+

The default error message for validates_format_of is "is invalid".

3.7. The `validates_inclusion_of` helper

This helper validates that the attributes' values are included in a given set. In fact, this set can be any enumerable object.

class Coffee < ActiveRecord::Base
+  validates_inclusion_of :size, :in => %w(small medium large), :message => "%s is not a valid size"
+end
+

The validates_inclusion_of helper has an option :in that receives the set of values that will be accepted. The :in option has an alias called :within that you can use for the same purpose, if you'd like to. In the previous example we used the :message option to show how we can personalize it with the current attribute's value, through the %s format mask.

The default error message for validates_inclusion_of is "is not included in the list".

3.8. The `validates_length_of` helper

3.9. The `validates_numericallity_of` helper

3.10. The `validates_presence_of` helper

-- cgit v1.2.3 From 23de31aae1b0ee6c7bb3c54c0da27ff427020c00 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Mon, 10 Nov 2008 00:58:04 -0200 Subject: Added documentation for validates_length_of --- .../html/activerecord_validations_callbacks.html | 46 ++++++++++++++++++++++ 1 file changed, 46 insertions(+) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 26653d396e..c82f428985 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -481,6 +481,52 @@ http://www.gnu.org/software/src-highlite -->

The default error message for validates_inclusion_of is "is not included in the list".

3.8. The `validates_length_of` helper

This helper validates the length of your attribute's value. It can receive a variety of different options, so you can specify length contraints in different ways.

class Person < ActiveRecord::Base
+  validates_length_of :name, :minimum => 2
+  validates_length_of :bio, :maximum => 500
+  validates_length_of :password, :in => 6..20
+  validates_length_of :registration_number, :is => 6
+end
+

The possible length constraint options are:

+
+:minimum - The attribute cannot have less than the specified length. +
+
+
+:maximum - The attribute cannot have more than the specified length. +
+
+
+:in (or :within) - The attribute length must be included in a given interval. The value for this option must be a Ruby range. +
+
+
+:is - The attribute length must be equal to a given value. +
+

The default error messages depend on the type of length validation being performed. You can personalize these messages, using the :wrong_length, :too_long and :too_short options and the %d format mask as a placeholder for the number corresponding to the length contraint being used. You can still use the :message option to specify an error message.

class Person < ActiveRecord::Base
+  validates_length_of :bio, :too_long => "you're writing too much. %d characters is the maximum allowed."
+end
+

3.9. The `validates_numericallity_of` helper

3.10. The `validates_presence_of` helper

3.11. The `validates_size_of` helper

-- cgit v1.2.3 From 5affa79f2a5fe73e4bf9ddf1bd2abdfa5667361b Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Mon, 10 Nov 2008 19:15:40 -0200 Subject: Added documentation for validates_numericallity_of --- .../html/activerecord_validations_callbacks.html | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index c82f428985..6feaae68ea 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -245,9 +245,6 @@ ul#navMain { Common validation options

- Credits -

Changelog

@@ -528,6 +525,19 @@ http://www.gnu.org/software/src-highlite --> end

3.9. The `validates_numericallity_of` helper

This helper validates that your attributes have only numeric values. By default, it will match an optional sign followed by a integral or floating point number. Using the :integer_only option set to true, you can specify that only integral numbers are allowed.

If you use :integer_only set to true, then it will use the /\A[+\-]?\d+\Z/ regular expression to validate the attribute's value. Otherwise, it will try to convert the value using Kernel.Float.

class Player < ActiveRecord::Base
+  validates_numericallity_of :points
+  validates_numericallity_of :games_played, :integer_only => true
+end
+

The default error message for validates_numericallity_of is "is not a number".

3.10. The `validates_presence_of` helper

3.11. The `validates_size_of` helper

3.12. The validates_uniqueness_of+ helper

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

4. Common validation options

5. Credits

6. Changelog

5. Changelog

http://rails.lighthouseapp.com/projects/16213/tickets/26-active-record-validations-and-callbacks

-- cgit v1.2.3 From 0668ab67bf6b32950113995303446840ae57d5d9 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Mon, 10 Nov 2008 20:24:51 -0200 Subject: Added documentation for validates_presence_of --- .../html/activerecord_validations_callbacks.html | 29 ++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 6feaae68ea..2e5044eb6e 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -539,6 +539,35 @@ http://www.gnu.org/software/src-highlite -->

The default error message for validates_numericallity_of is "is not a number".

3.10. The `validates_presence_of` helper

This helper validates that the attributes are not empty. It uses the blank? method to check if the value is either nil or an empty string (if the string has only spaces, it will still be considered empty).

class Person < ActiveRecord::Base
+  validates_presence_of :name, :login, :email
+end
+

+ + + +

+ +	If you want to be sure that an association is present, you'll need to test if the foreign key used to map the association is present, and not the associated object itself.

class LineItem < ActiveRecord::Base
+  belongs_to :order
+  validates_presence_of :order_id
+end
+

The default error message for validates_presence_of is "can't be empty".

3.11. The `validates_size_of` helper

3.12. The validates_uniqueness_of+ helper

-- cgit v1.2.3 From d0cb4d7258c9241fcffda854d615c44586189838 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Mon, 10 Nov 2008 20:31:05 -0200 Subject: Added note about testing booleans to validates_presence_of --- railties/doc/guides/html/activerecord_validations_callbacks.html | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 2e5044eb6e..6953c3979a 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -567,6 +567,14 @@ http://www.gnu.org/software/src-highlite --> validates_presence_of :order_id end +

+ + + +

+ +	If you want to validate the presence of a boolean field (where the real values are true and false), you will want to use validates_inclusion_of :field_name, :in ⇒ [true, false] This is due to the way Object#blank? handles boolean values. false.blank? # ⇒ true

The default error message for validates_presence_of is "can't be empty".

3.11. The `validates_size_of` helper

3.12. The validates_uniqueness_of+ helper

-- cgit v1.2.3 From 6f944c06c86fcf30f257202fa10f0ccad6014ef5 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Mon, 10 Nov 2008 20:40:32 -0200 Subject: Added info about validates_size_of, as being an alias for validates_length_of --- railties/doc/guides/html/activerecord_validations_callbacks.html | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 6953c3979a..7149ee5f90 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -235,8 +235,6 @@ ul#navMain {

The validates_presence_of helper

The validates_size_of helper

The validates_uniqueness_of+ helper

@@ -524,6 +522,7 @@ http://www.gnu.org/software/src-highlite --> validates_length_of :bio, :too_long => "you're writing too much. %d characters is the maximum allowed." end +

This helper has an alias called validates_size_of, it's the same helper with a different name. You can use it if you'd like to.

3.9. The `validates_numericallity_of` helper

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

The default error message for validates_presence_of is "can't be empty".

3.11. The `validates_size_of` helper

3.12. The validates_uniqueness_of+ helper

3.11. The validates_uniqueness_of+ helper

4. Common validation options

-- cgit v1.2.3 From 31dcce8c1c41da49bfc0d60bd6ea77e4cd7e7d17 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Mon, 10 Nov 2008 21:02:40 -0200 Subject: Added documentation for validates_uniqueness_of --- .../html/activerecord_validations_callbacks.html | 36 ++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 7149ee5f90..a85a4db5d8 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -235,7 +235,7 @@ ul#navMain {

The validates_presence_of helper

The validates_uniqueness_of+ helper

The validates_uniqueness_of helper

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

The default error message for validates_presence_of is "can't be empty".

3.11. The validates_uniqueness_of+ helper

3.11. The `validates_uniqueness_of` helper

This helper validates that the attribute's value is unique right before the object gets saved. It does not create a uniqueness constraint directly into your database, so it may happen that two different database connections create two records with the same value for a column that you wish were unique. To avoid that, you must create an unique index in your database.

class Account < ActiveRecord::Base
+  validates_uniqueness_of :email
+end
+

The validation happens by performing a SQL query into the model's table, searching for a record where the attribute that must be validated is equal to the value in the object being validated.

There is a :scope option that you can use to specify other attributes that must be used to define uniqueness:

class Holiday < ActiveRecord::Base
+  validates_uniqueness_of :name, :scope => :year, :message => "Should happen once per year"
+end
+

There is also a :case_sensitive option that you can use to define if the uniqueness contraint will be case sensitive or not. This option defaults to true.

class Person < ActiveRecord::Base
+  validates_uniqueness_of :name, :case_sensitive => false
+end
+

The default error message for validates_uniqueness_of is "has already been taken".

4. Common validation options

-- cgit v1.2.3 From fc714840fe3d9cc89b2582b08383a3e4c26a0a78 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Tue, 11 Nov 2008 20:16:33 -0200 Subject: Added 'Common Validation Options' --- .../html/activerecord_validations_callbacks.html | 45 +++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index a85a4db5d8..29549cf591 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -241,6 +241,18 @@ ul#navMain {

Common validation options +

The :allow_nil option
The :message option
The :on option

+ Conditional validation

Changelog @@ -611,8 +623,39 @@ http://www.gnu.org/software/src-highlite -->

4. Common validation options

There are some common options that all the validation helpers can use. Here they are, except for the :if option, which we'll cover right at the next topic.

4.1. The `:allow_nil` option

You may use the :allow_nil option everytime you just want to trigger a validation if the value being validated is not nil. You may be asking yourself if it makes any sense to use :allow_nil and validates_presence_of together. Well, it does. Remember, validation will be skipped only for nil attributes, but empty strings are not considered nil.

class Coffee < ActiveRecord::Base
+  validates_inclusion_of :size, :in => %w(small medium large),
+    :message => "%s is not a valid size", :allow_nil => true
+end
+

4.2. The `:message` option

As stated before, the :message option lets you specify the message that will be added to the errors collection when validation fails. When this option is not used, Active Record will use the respective default error message for each validation helper.

4.3. The `:on` option

As stated before, the :on option lets you specify when the validation should happen. The default behaviour for all the built-in validation helpers is to be ran on save (both when you're creating a new record and when you're updating it). If you want to change it, you can use :on => :create to run the validation only when a new record is created or :on => :update to run the validation only when a record is updated.

class Person < ActiveRecord::Base
+  validates_uniqueness_of :email, :on => :create # => it will be possible to update email with a duplicated value
+  validates_numericallity_of :age, :on => :update # => it will be possible to create the record with a 'non-numerical age'
+  validates_presence_of :name, :on => :save # => that's the default
+end
+

5. Conditional validation

5. Changelog

6. Changelog

http://rails.lighthouseapp.com/projects/16213/tickets/26-active-record-validations-and-callbacks

-- cgit v1.2.3 From 3645fd15dbc397f4017d9046651fa560c45a72b1 Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Tue, 11 Nov 2008 22:34:24 -0200 Subject: Added 'Conditional Validations' to AR validations and callbacks guide --- .../html/activerecord_validations_callbacks.html | 49 +++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index 29549cf591..a81c6c0c64 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -253,6 +253,15 @@ ul#navMain {

Conditional validation +

Using a symbol with the :if and :unless options
Using a string with the :if and :unless options
Using a Proc object with the :if option

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

4. Common validation options

There are some common options that all the validation helpers can use. Here they are, except for the :if option, which we'll cover right at the next topic.

There are some common options that all the validation helpers can use. Here they are, except for the :if and :unless options, which we'll cover right at the next topic.

4.1. The `:allow_nil` option

@@ -654,6 +663,44 @@ http://www.gnu.org/software/src-highlite -->

5. Conditional validation

Sometimes it will make sense to validate an object just when a given predicate is satisfied. You can do that by using the :if and :unless options, which can take a symbol, a string or a Ruby Proc. You may use the :if option when you want to specify when the validation should happen. If you want to specify when the validation should not happen, then you may use the :unless option.

5.1. Using a symbol with the `:if` and `:unless` options

You can associated the :if and :unless options with a symbol corresponding to the name of a method that will get called right before validation happens. This is the most commonly used option.

class Order < ActiveRecord::Base
+  validates_presence_of :card_number, :if => :paid_with_card?
+
+  def paid_with_card?
+    payment_type == "card"
+  end
+end
+

5.2. Using a string with the `:if` and `:unless` options

You can also use a string that will be evaluated using :eval and needs to contain valid Ruby code. You should use this option only when the string represents a really short condition.

class Person < ActiveRecord::Base
+  validates_presence_of :surname, :if => "name.nil?"
+end
+

5.3. Using a Proc object with the `:if` option

Finally, it's possible to associate :if and :unless with a Ruby Proc object which will be called. Using a Proc object can give you the hability to write a condition that will be executed only when the validation happens and not when your code is loaded by the Ruby interpreter. This option is best suited when writing short validation methods, usually one-liners.

class Account < ActiveRecord::Base
+  validates_confirmation_of :password, :if => Proc.new { |a| !a.password.blank? }
+end
+

6. Changelog

-- cgit v1.2.3 From 29e053979e719937a1f5d235ac6cd83a530d020c Mon Sep 17 00:00:00 2001 From: CassioMarques Date: Tue, 11 Nov 2008 22:36:37 -0200 Subject: Changed conditional validation with Proc to use :unless instead of :if --- railties/doc/guides/html/activerecord_validations_callbacks.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'railties/doc/guides/html') diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html index a81c6c0c64..209722e9e0 100644 --- a/railties/doc/guides/html/activerecord_validations_callbacks.html +++ b/railties/doc/guides/html/activerecord_validations_callbacks.html @@ -259,7 +259,7 @@ ul#navMain {

Using a string with the :if and :unless options

Using a Proc object with the :if option

Using a Proc object with the :if and :unless options

@@ -690,7 +690,7 @@ http://www.gnu.org/software/src-highlite --> validates_presence_of :surname, :if => "name.nil?" end -

5.3. Using a Proc object with the `:if` option

5.3. Using a Proc object with the `:if` and :`unless` options

class Account < ActiveRecord::Base
-  validates_confirmation_of :password, :if => Proc.new { |a| !a.password.blank? }
+  validates_confirmation_of :password, :unless => Proc.new { |a| a.password.blank? }
 end

-- cgit v1.2.3

7. Action View

2.2.10. Options for render

2.2.10. Rendering Vanilla JavaScript

2.2.11. Options for render

2.2.11. Finding Layouts

2.2.12. Finding Layouts

Specifying Layouts on a per-Controller Basis

2.2.12. Avoiding Double Render Errors

2.2.13. Avoiding Double Render Errors

3.4.4. Passing Local Variables

3.4.5. Rendering Collections

Models

10. Changelog

1.4. Debugging Javascript

2. The Logger

4. References

4. Debugging Memory Leaks

4.1. Bleak House

4.2. Valgrind

5. Plugins for Debugging

6. References

5. Changelog

7. Changelog

4. Debugging Memory Leaks

4.1. Bleak House

4.1. BleakHouse

4.2. Valgrind

5. Plugins for Debugging

8.1.1. path_parameters, query_parameters and request_parameters

8.2. The response

9. HTTP Basic Authentication

11. Parameter filtering

7.1. Using Partials to Eliminate View Duplication

7.2. Using Filters to Eliminate Controller Duplication

1.2. to_yaml

1.3. inspect

1.4. Debugging Javascript

3. Debugging with ruby-debug

4. Debugging Memory Leaks

4.2. Valgrind

4.2. Available Request Types for Functional Tests===

4.2. Available Request Types for Functional Tests

6.3. Functional Testing

Ruby on Rails

Sustainable productivity for web-application development

Chapters

Active Record Validations and Callbacks

1. Active Record Validations

2. Credits

3. Changelog

Chapters

Ruby on Rails guides

Chapters

Action Controller basics

1. What does a controller do?

1. What Does a Controller do?

2. Methods and actions

2. Methods and Actions

3. Parameters

3.1. Hash and array parameters

3.1. Hash and Array Parameters

3.2. Routing parameters

3.2. Routing Parameters

3.3. default_url_options

4. Session

4.1. Disabling the session

4.1. Disabling the Session

4.2. Accessing the session

4.2. Accessing the Session

4.3. The flash

4.3.1. flash.now

4.3.1. flash.now

6. Filters

6.1. After filters and around filters

6.1. After Filters and Around Filters

7. Verification

8. The request and response objects

8. Request Forgery Protection

8.1. The request

9. The request and response Objects

2.2.10. Options for `render`

2.2.11. Options for `render`

3.3. `default_url_options`

4.3.1. `flash.now`

9. The `request` and `response` Objects

9.1. The `request` Object

9.1.1. `path_parameters`, `query_parameters` and `request_parameters`

9.2. The `response` Object

12.2. `rescue_from`

13.2. `rescue_from`

3.1. The `validates_acceptance_of` helper

3.2. The `validates_associated` helper

3.3. The `validates_confirmation_of` helper

3.4. The `validates_each` helper

3.5. The `validates_exclusion_of` helper

3.6. The `validates_format_of` helper

3.7. The `validates_inclusion_of` helper

3.8. The `validates_length_of` helper

3.9. The `validates_numericallity_of` helper

3.10. The `validates_presence_of` helper

3.11. The `validates_size_of` helper

3.2. The `validates_associated` helper

3.3. The `validates_confirmation_of` helper

3.4. The `validates_each` helper

3.5. The `validates_exclusion_of` helper

3.3. The `validates_confirmation_of` helper

3.4. The `validates_each` helper

3.5. The `validates_exclusion_of` helper

3.6. The `validates_format_of` helper

3.4. The `validates_each` helper

3.5. The `validates_exclusion_of` helper

3.1. The `validates_acceptance_of` helper