getting_started.textile 60.0 KB
Newer Older
1
h2. Getting Started with Rails
2 3 4 5 6 7 8 9 10 11

This guide covers getting up and running with Ruby on Rails. After reading it, you should be familiar with:

* Installing Rails, creating a new Rails application, and connecting your application to a database
* The general layout of a Rails application
* The basic principles of MVC (Model, View Controller) and RESTful design
* How to quickly generate the starting pieces of a Rails application.

endprologue.

M
Mikel Lindsaar 已提交
12
WARNING. This Guide is based on Rails 3.0. Some of the code shown here will not work in earlier versions of Rails.
13

14
h3. Guide Assumptions
15 16 17

This guide is designed for beginners who want to get started with a Rails application from scratch. It does not assume that you have any prior experience with Rails. However, to get the most out of it, you need to have some prerequisites installed:

18
* The "Ruby":http://www.ruby-lang.org/en/downloads language version 1.8.7 or higher
19
* The "RubyGems":http://rubyforge.org/frs/?group_id=126 packaging system
20
* A working installation of the "SQLite3 Database":http://www.sqlite.org
21

22
Rails is a web application framework running on the Ruby programming language. If you have no prior experience with Ruby, you will find a very steep learning curve diving straight into Rails.  There are some good free resources on the internet for learning Ruby, including:
23

24
* "Mr. Neighborly's Humble Little Ruby Book":http://www.humblelittlerubybook.com
25
* "Programming Ruby":http://www.ruby-doc.org/docs/ProgrammingRuby/
26
* "Why's (Poignant) Guide to Ruby":http://mislav.uniqpath.com/poignant-guide/
27 28 29

h3. What is Rails?

30
Rails is a web application development framework written in the Ruby language. It is designed to make programming web applications easier by making assumptions about what every developer needs to get started. It allows you to write less code while accomplishing more than many other languages and frameworks. Experienced Rails developers also report that it makes web application development more fun.
31

32
Rails is opinionated software. It makes the assumption that there is a "best" way to do things, and it's designed to encourage that way - and in some cases to discourage alternatives. If you learn "The Rails Way" you'll probably discover a tremendous increase in productivity. If you persist in bringing old habits from other languages to your Rails development, and trying to use patterns you learned elsewhere, you may have a less happy experience.
33 34 35

The Rails philosophy includes several guiding principles:

36
* DRY - "Don't Repeat Yourself" - suggests that writing the same code over and over again is a bad thing.
37
* Convention Over Configuration - means that Rails makes assumptions about what you want to do and how you're going to do it, rather than requiring you to specify every little thing through endless configuration files.
38 39 40 41
* REST is the best pattern for web applications - organizing your application around resources and standard HTTP verbs is the fastest way to go.

h4. The MVC Architecture

42
At the core of Rails is the Model, View, Controller architecture, usually just called MVC. MVC benefits include:
43 44 45 46 47 48 49

* Isolation of business logic from the user interface
* Ease of keeping code DRY
* Making it clear where different types of code belong for easier maintenance

h5. Models

50
A model represents the information (data) of the application and the rules to manipulate that data. In the case of Rails, models are primarily used for managing the rules of interaction with a corresponding database table. In most cases, one table in your database will correspond to one model in your application. The bulk of your application's business logic will be concentrated in the models.
51 52 53

h5. Views

K
kitallis 已提交
54
Views represent the user interface of your application. In Rails, views are often HTML files with embedded Ruby code that perform tasks related solely to the presentation of the data. Views handle the job of providing data to the web browser or other tool that is used to make requests from your application.
55 56 57 58 59 60 61

h5. Controllers

Controllers provide the "glue" between models and views. In Rails, controllers are responsible for processing the incoming requests from the web browser, interrogating the models for data, and passing that data on to the views for presentation.

h4. The Components of Rails

62
Rails ships as many individual components.
63

64 65 66 67
* Action Pack
  ** Action Controller
  ** Action Dispatch
  ** Action View
68
* Action Mailer
69 70
* Active Model
* Active Record
71 72
* Active Resource
* Active Support
73 74 75 76 77 78
* Railties


h5. Action Pack

Action Pack is a single gem that contains Action Controller, Action View and Action Dispatch.  The "VC" part of "MVC".
79 80 81 82 83 84 85 86 87

h5. Action Controller

Action Controller is the component that manages the controllers in a Rails application. The Action Controller framework processes incoming requests to a Rails application, extracts parameters, and dispatches them to the intended action. Services provided by Action Controller include session management, template rendering, and redirect management.

h5. Action View

Action View manages the views of your Rails application. It can create both HTML and XML output by default. Action View manages rendering templates, including nested and partial templates, and includes built-in AJAX support.

88
h5. Action Dispatch
89

90
Action Dispatch handles routing of web requests and dispatches them as you want, either to your application or any other Rack application.
91 92 93

h5. Action Mailer

94
Action Mailer is a framework for building e-mail services. You can use Action Mailer to receive and process incoming email and send simple plain text or complex multipart emails based on flexible templates.
95

96
h5. Active Model
97

98
Active Model provides a defined interface between the Action Pack gem services and Object Relationship Mapping gems such as Active Record.  Active Model allows Rails to utilize other ORM frameworks in place of Active Record if your application needs this.
99

100
h5. Active Record
101

102 103 104 105 106
Active Record is the base for the models in a Rails application. It provides database independence, basic CRUD functionality, advanced finding capabilities, and the ability to relate models to one another, among other services.

h5. Active Resource

Active Resource provides a framework for managing the connection between business objects and RESTful web services. It implements a way to map web-based resources to local objects with CRUD semantics.
107 108 109 110 111

h5. Active Support

Active Support is an extensive collection of utility classes and standard Ruby library extensions that are used in the Rails, both by the core code and by your applications.

112 113 114 115
h5. Railties

Railties is the core Rails code that builds new Rails applications and glues the various frameworks and plugins together in any Rails application.

116 117
h4. REST

118
Rest stands for Representational State Transfer and is the foundation of the RESTful architecture. This is generally considered to be Roy Fielding's doctoral thesis, "Architectural Styles and the Design of Network-based Software Architectures":http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm. While you can read through the thesis, REST in terms of Rails boils down to two main principles:
119

120
* Using resource identifiers such as URLs to represent resources.
121 122 123 124 125 126
* Transferring representations of the state of that resource between system components.

For example, to a Rails application a request such as this:

<tt>DELETE /photos/17</tt>

127
would be understood to refer to a photo resource with the ID of 17, and to indicate a desired action - deleting that resource. REST is a natural style for the architecture of web applications, and Rails hooks into this shielding you from many of the RESTful complexities and browser quirks.
128

129
If you'd like more details on REST as an architectural style, these resources are more approachable than Fielding's thesis:
130 131 132 133

* "A Brief Introduction to REST":http://www.infoq.com/articles/rest-introduction by Stefan Tilkov
* "An Introduction to REST":http://bitworking.org/news/373/An-Introduction-to-REST (video tutorial) by Joe Gregorio
* "Representational State Transfer":http://en.wikipedia.org/wiki/Representational_State_Transfer article in Wikipedia
M
Mike Gunderloy 已提交
134
* "How to GET a Cup of Coffee":http://www.infoq.com/articles/webber-rest-workflow by Jim Webber, Savas Parastatidis & Ian Robinson
135 136 137

h3. Creating a New Rails Project

138
If you follow this guide, you'll create a Rails project called <tt>blog</tt>, a (very) simple weblog. Before you can start building the application, you need to make sure that you have Rails itself installed.
139 140 141 142 143 144

h4. Installing Rails

In most cases, the easiest way to install Rails is to take advantage of RubyGems:

<shell>
145 146
Usually run this as the root user:
# gem install rails
147 148
</shell>

149
NOTE. In the Rails 3.0.0-beta, you will need to manually install the dependencies for Rails itself as a bug in rubygems will cause these to not be installed, see the "3.0 Release Notes":3_0_release_notes.html for the commands to run.
150

151
TIP. If you're working on Windows, you may find it easier to install "Instant Rails":http://instantrails.rubyforge.org/wiki/wiki.pl. Be aware, though, that Instant Rails releases tend to lag seriously behind the actual Rails version. Also, you will find that Rails development on Windows is overall less pleasant than on other operating systems. If at all possible, we suggest that you install a Linux virtual machine and use that for Rails development, instead of using Windows.
152

153 154
h4. Creating the Blog Application

155
The best way to use this guide is to follow each step as it happens, no code or step needed to make this example application has been left out, so you can literally follow along step by step.  If you need to see the completed code, you can download it from "Getting Started Code":http://github.com/mikel/getting-started-code.
156

157
To begin, open a terminal, navigate to a folder where you have rights to create files, and type:
158 159

<shell>
160
$ rails blog
161 162
</shell>

163
This will create a Rails application called Blog in a directory called blog.
164

165
TIP: You can see all of the switches that the Rails application builder accepts by running <tt>rails -h</tt>.
166 167 168 169 170 171 172

After you create the blog application, switch to its folder to continue work directly in that application:

<shell>
$ cd blog
</shell>

173
In any case, Rails will create a folder in your working directory called <tt>blog</tt>. Open up that folder and explore its contents. Most of the work in this tutorial will happen in the <tt>app/</tt> folder, but here's a basic rundown on the function of each folder that Rails creates in a new application by default:
174

A
Andreas Scherer 已提交
175
|_.File/Folder|_.Purpose|
176 177
|Gemfile|This file allows you to specify what gem dependencies are needed for your Rails application.|
|README.rdoc|This is a brief instruction manual for your application. Use it to tell others what your application does, how to set it up, and so on.|
178 179 180
|Rakefile|This file contains batch jobs that can be run from the terminal.|
|app/|Contains the controllers, models, and views for your application. You'll focus on this folder for the remainder of this guide.|
|config/|Configure your application's runtime rules, routes, database, and more.|
181
|config.ru|Rack configuration for Rack based servers used to start the application.|
182 183 184 185 186
|db/|Shows your current database schema, as well as the database migrations. You'll learn about migrations shortly.|
|doc/|In-depth documentation for your application.|
|lib/|Extended modules for your application (not covered in this guide).|
|log/|Application log files.|
|public/|The only folder seen to the world as-is.  This is where your images, javascript, stylesheets (CSS), and other static files go.|
187
|script/|Contains the rails script that starts your app and can contain other scripts you use to deploy or run your application.|
188
|test/|Unit tests, fixtures, and other test apparatus. These are covered in "Testing Rails Applications":testing.html|
189
|tmp/|Temporary files|
190 191 192 193
|vendor/|A place for all third-party code. In a typical Rails application, this includes Ruby Gems, the Rails source code (if you install it into your project) and plugins containing additional prepackaged functionality.|

h4. Installing the Required Gems

194
Rails uses the "Bundler":http://www.github.com/carlhuda/bundler gem to populate the +vendor+ directory with all the gems your application depends on.  As we don't need any special gems beyond the default, we just need to do the following:
195 196

<shell>
197 198 199
As the root user:
# gem install bundler
# bundle install
200 201
</shell>

202
This will copy down the versions of all the gems you need to start a rails application.
203 204 205 206

h4. Configuring a Database

Just about every Rails application will interact with a database. The database to use is specified in a configuration file, +config/database.yml+.
207
If you open this file in a new Rails application, you'll see a default database configuration using SQLite3. The file contains sections for three different environments in which Rails can run by default:
208 209 210 211 212

* The +development+ environment is used on your development computer as you interact manually with the application
* The +test+ environment is used to run automated tests
* The +production+ environment is used when you deploy your application for the world to use.

213
h5. Configuring a SQLite3 Database
214

215
Rails comes with built-in support for "SQLite3":http://www.sqlite.org, 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.
216

217
Here's the section of the default configuration file (<tt>config/database.yml</tt>) with connection information for the development environment:
218 219 220

<yaml>
development:
221 222 223 224
  adapter: sqlite3
  database: db/development.sqlite3
  pool: 5
  timeout: 5000
225 226
</yaml>

227
NOTE: In this guide we are using an SQLite3 database for data storage, this is because it is a zero configuration database that just works.  Rails also supports MySQL and PostgreSQL "out of the box", and has plugins for many database systems, if you are using a database in a production environment, Rails most likely has an adapter for it.
228 229 230

h5. Configuring a MySQL Database

231
If you choose to use MySQL instead of the shipped Sqlite3 database, your +config/database.yml+ will look a little different. Here's the development section:
232 233 234

<yaml>
development:
235 236 237 238 239 240 241
  adapter: mysql
  encoding: utf8
  database: blog_development
  pool: 5
  username: root
  password:
  socket: /tmp/mysql.sock
242 243 244 245 246 247
</yaml>

If your development computer's MySQL installation includes a root user with an empty password, this configuration should work for you. Otherwise, change the username and password in the +development+ section as appropriate.

h5. Configuring a PostgreSQL Database

248
Finally if you choose to use PostgreSQL, your +config/database.yml+ will be customized to use PostgreSQL databases:
249 250 251

<yaml>
development:
252 253 254 255 256 257
  adapter: postgresql
  encoding: unicode
  database: blog_development
  pool: 5
  username: blog
  password:
258 259 260 261 262 263 264 265 266 267 268 269
</yaml>

Change the username and password in the +development+ section as appropriate.

h4. Creating the Database

Now that you have your database configured, it's time to have Rails create an empty database for you. You can do this by running a rake command:

<shell>
$ rake db:create
</shell>

270 271 272
This will create your development and test SQLite3 databases inside the <tt>db/</tt> folder.

TIP: Rake is a general-purpose command-runner that Rails uses for many things. You can see the list of available rake commands in your application by running +rake -T+.
273 274 275

h3. Hello, Rails!

276
One of the traditional places to start with a new language is by getting some text up on screen quickly, to do this, you need to get your Rails application server running.
277 278 279

h4. Starting up the Web Server

280
You actually have a functional Rails application already. To see it, you need to start a web server on your development machine. You can do this by running:
281 282

<shell>
283
$ rails server
284 285
</shell>

286
This will fire up an instance of the Mongrel web server by default (Rails can also use several other web servers). To see your application in action, open a browser window and navigate to "http://localhost:3000":http://localhost:3000. You should see Rails' default information page:
287 288 289

!images/rails_welcome.png(Welcome Aboard screenshot)!

290
TIP: To stop the web server, hit Ctrl+C in the terminal window where it's running. In development mode, Rails does not generally require you to stop the server; changes you make in files will be automatically picked up by the server.
291

292
The "Welcome Aboard" page is the _smoke test_ for a new Rails application: it makes sure that you have your software configured correctly enough to serve a page.  You can also click on the _About your application’s environment_ link to see a summary of your Application's environment.
293 294 295 296 297 298

h4. Say "Hello", Rails

To get Rails saying "Hello", you need to create at minimum a controller and a view. Fortunately, you can do that in a single command. Enter this command in your terminal:

<shell>
299
$ rails generate controller home index
300 301
</shell>

302
TIP: If you're on Windows, or your Ruby is set up in some non-standard fashion, you may need to explicitly pass Rails +rails+ commands to Ruby: +ruby \path\to\rails controller home index+.
303 304 305 306 307 308

Rails will create several files for you, including +app/views/home/index.html.erb+. This is the template that will be used to display the results of the +index+ action (method) in the +home+ controller. Open this file in your text editor and edit it to contain a single line of code:

<code class="html">
<h1>Hello, Rails!</h1>
</code>
309 310 311

h4. Setting the Application Home Page

312
Now that we have made the controller and view, we need to tell Rails when we want "Hello Rails" to show up.  In our case, we want it to show up when we navigate to the root URL of our site, "http://localhost:3000":http://localhost:3000, instead of the "Welcome Aboard" smoke test.
313 314

The first step to doing this is to delete the default page from your application:
315 316 317 318 319

<shell>
$ rm public/index.html
</shell>

320
We need to do this as Rails will deliver any static file in the +public+ directory in preference to any dynamic contact we generate from the controllers.
321

D
Daniel Schierbeck 已提交
322
Now, you have to tell Rails where your actual home page is located. Open the file +config/routes.rb+ in your editor. This is your application's _routing file_ which holds entries in a special DSL (domain-specific language) that tells Rails how to connect incoming requests to controllers and actions. There are only comments in this file, so we need to add at the top the following:
323

324 325
<ruby>
Blog::Application.routes.draw do |map|
326

327
  root :to => "home#index"
328

329 330 331
  # The priority is based upon order of creation:
  # first created -> highest priority.
  #...
332 333
</ruby>

334
The +root :to => "home#index"+ tells Rails to map the root action to the home controller's index action.
335

336
Now if you navigate to "http://localhost:3000":http://localhost:3000 in your browser, you'll see +Hello, Rails!+.
337

338
NOTE. For more information about routing, refer to "Rails Routing from the Outside In":routing.html.
339

X
Xavier Noria 已提交
340
h3. Getting Up and Running Quickly with Scaffolding
341

342
Rails _scaffolding_ is a quick way to generate some of the major pieces of an application. If you want to create the models, views, and controllers for a new resource in a single operation, scaffolding is the tool for the job.
343 344 345 346 347 348

h3. Creating a Resource

In the case of the blog application, you can start by generating a scaffolded Post resource: this will represent a single blog posting. To do this, enter this command in your terminal:

<shell>
349
$ rails generate scaffold Post name:string title:string content:text
350 351 352 353
</shell>

NOTE. While scaffolding will get you up and running quickly, the "one size fits all" code that it generates is unlikely to be a perfect fit for your application. In most cases, you'll need to customize the generated code. Many experienced Rails developers avoid scaffolding entirely, preferring to write all or most of their source code from scratch.

354
The scaffold generator will build 15 files in your application, along with some folders, and edit one more. Here's a quick overview of what it creates:
355

356
|_.File                                       |_.Purpose|
357
|db/migrate/20100207214725_create_posts.rb.rb    |Migration to create the posts table in your database (your name will include a different timestamp)|
358
|app/models/post.rb                           |The Post model|
359 360 361
|test/fixtures/posts.yml                      |Dummy posts for use in testing|
|app/controllers/posts_controller.rb          |The Posts controller|
|app/views/posts/index.html.erb               |A view to display an index of all posts |
J
James Miller 已提交
362 363 364
|app/views/posts/edit.html.erb                |A view to edit an existing post|
|app/views/posts/show.html.erb                |A view to display a single post|
|app/views/posts/new.html.erb                 |A view to create a new post|
365
|app/views/posts/_form.html.erb               |A partial to control the overall look and feel of the form used in edit and new views|
366 367
|app/helpers/posts_helper.rb                  |Helper functions to be used from the post views|
|test/unit/post_test.rb                       |Unit testing harness for the posts model|
368 369
|test/functional/posts_controller_test.rb     |Functional testing harness for the posts controller|
|test/unit/helpers/posts_helper_test.rb       |Unit testing harness for the posts helper|
370
|config/routes.rb                             |Edited to include routing information for posts|
371
|public/stylesheets/scaffold.css              |Cascading style sheet to make the scaffolded views look better|
372 373 374

h4. Running a Migration

375
One of the products of the +rails generate scaffold+ command is a _database migration_. Migrations are Ruby classes that are designed to make it simple to create and modify database tables. Rails uses rake commands to run migrations, and it's possible to undo a migration after it's been applied to your database. Migration filenames include a timestamp to ensure that they're processed in the order that they were created.
376

377
If you look in the +db/migrate/20100207214725_create_posts.rb+ file (remember, yours will have a slightly different name), here's what you'll find:
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396

<ruby>
class CreatePosts < ActiveRecord::Migration
  def self.up
    create_table :posts do |t|
      t.string :name
      t.string :title
      t.text :content

      t.timestamps
    end
  end

  def self.down
    drop_table :posts
  end
end
</ruby>

397
The above migration creates two methods, +up+, called when you run this migration into the database, and +down+ in case you need to reverse the changes made by this migration at a later date.  The +up+ command in this case creates a +posts+ table with two string columns and a text column.  It also creates two timestamp fields to track record creation and updating.  More information about Rails migrations can be found in the "Rails Database Migrations":migrations.html guide.
398 399 400 401 402 403 404

At this point, you can use a rake command to run the migration:

<shell>
$ rake db:migrate
</shell>

405
Rails will execute this migration command and tell you it created the Posts table.
406 407

<shell>
408
==  CreatePosts: migrating ====================================================
409 410
-- create_table(:posts)
   -> 0.0019s
411
==  CreatePosts: migrated (0.0020s) ===========================================
412 413
</shell>

M
mazuhl 已提交
414
NOTE. Because you're working in the development environment by default, this command will apply to the database defined in the +development+ section of your +config/database.yml+ file.
415 416 417

h4. Adding a Link

J
Joseph Pecoraro 已提交
418
To hook the posts up to the home page you've already created, you can add a link to the home page. Open +app/views/home/index.html.erb+ and modify it as follows:
419 420 421 422 423 424 425 426 427 428

<code lang="ruby">
<h1>Hello, Rails!</h1>
<%= link_to "My Blog", posts_path %>
</code>

The +link_to+ method is one of Rails' built-in view helpers. It creates a hyperlink based on text to display and where to go - in this case, to the path for posts.

h4. Working with Posts in the Browser

429
Now you're ready to start working with posts. To do that, navigate to "http://localhost:3000":http://localhost:3000/ and then click the "My Blog" link:
430 431 432

!images/posts_index.png(Posts Index screenshot)!

433
This is the result of Rails rendering the +index+ view of your posts. There aren't currently any posts in the database, but if you click the +New Post+ link you can create one. After that, you'll find that you can edit posts, look at their details, or destroy them. All of the logic and HTML to handle this was built by the single +rails generate scaffold+ command.
434

435
TIP: In development mode (which is what you're working in by default), Rails reloads your application with every browser request, so there's no need to stop and restart the web server.
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455

Congratulations, you're riding the rails! Now it's time to see how it all works.

h4. The Model

The model file, +app/models/post.rb+ is about as simple as it can get:

<ruby>
class Post < ActiveRecord::Base
end
</ruby>

There isn't much to this file - but note that the +Post+ class inherits from +ActiveRecord::Base+. Active Record supplies a great deal of functionality to your Rails models for free, including basic database CRUD (Create, Read, Update, Destroy) operations, data validation, as well as sophisticated search support and the ability to relate multiple models to one another.

h4. Adding Some Validation

Rails includes methods to help you validate the data that you send to models. Open the +app/models/post.rb+ file and edit it:

<ruby>
class Post < ActiveRecord::Base
456 457 458
  validates :name,  :presence => true
  validates :title, :presence => true,
                    :length => { :minimum => 5 }
459 460 461 462 463 464 465 466 467 468
end
</ruby>

These changes will ensure that all posts have a name and a title, and that the title is at least five characters long. Rails can validate a variety of conditions in a model, including the presence or uniqueness of columns, their format, and the existence of associated objects.

h4. Using the Console

To see your validations in action, you can use the console. The console is a command-line tool that lets you execute Ruby code in the context of your application:

<shell>
469
$ rails console
470 471 472 473 474 475
</shell>

After the console loads, you can use it to work with your application's models:

<shell>
>> p = Post.create(:content => "A new post")
476 477 478
=> #<Post id: nil, name: nil, title: nil, 
     content: "A new post", created_at: nil,
     updated_at: nil>
479 480 481
>> p.save
=> false
>> p.errors
482 483 484
=> #<OrderedHash { :title=>["can't be blank", 
                           "is too short (minimum is 5 characters)"],
                   :name=>["can't be blank"] }>
485 486 487 488 489 490 491 492 493 494 495 496
</shell>

This code shows creating a new +Post+ instance, attempting to save it and getting +false+ for a return value (indicating that the save failed), and inspecting the +errors+ of the post.

TIP: Unlike the development web server, the console does not automatically load your code afresh for each line. If you make changes to your models while the console is open, type +reload!+ at the console prompt to load them.

h4. Listing All Posts

The easiest place to start looking at functionality is with the code that lists all posts. Open the file +app/controllers/posts_controller.rb + and look at the +index+ action:

<ruby>
def index
497
  @posts = Post.all
498 499 500 501 502 503 504 505

  respond_to do |format|
    format.html # index.html.erb
    format.xml  { render :xml => @posts }
  end
end
</ruby>

506
+Post.all+ calls the +Post+ model to return all of the posts currently in the database. The result of this call is an array containing the posts which has been saved in an instance variable called +@posts+.
507

508
TIP: For more information on finding records with Active Record, see "Active Record Query Interface":active_record_querying.html.
509

510
The +respond_to+ block handles both HTML and XML calls to this action. If you browse to "http://localhost:3000/posts.xml":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/views/posts/index.html.erb+:
511 512 513 514 515 516 517 518 519

<erb>
<h1>Listing posts</h1>

<table>
  <tr>
    <th>Name</th>
    <th>Title</th>
    <th>Content</th>
520 521 522
    <th></th>
    <th></th>
    <th></th>
523 524
  </tr>

525
<% @posts.each do |post| %>
526
  <tr>
527 528 529
    <td><%= post.name %></td>
    <td><%= post.title %></td>
    <td><%= post.content %></td>
530 531
    <td><%= link_to 'Show', post %></td>
    <td><%= link_to 'Edit', edit_post_path(post) %></td>
532
    <td><%= link_to 'Destroy', post, :confirm => 'Are you sure?', :method => :delete %></td>
533 534 535 536 537 538 539 540 541 542 543 544
  </tr>
<% end %>
</table>

<br />

<%= link_to 'New post', new_post_path %>
</erb>

This view iterates over the contents of the +@posts+ array to display content and links. A few things to note in the view:

* +link_to+ builds a hyperlink to a particular destination
545
* +edit_post_path+ is a helper that Rails provides as part of RESTful routing. You'll see a variety of these helpers for the different actions that the controller includes.
546

547
NOTE. In previous versions of Rails, you had to use +&lt;%=h post.name %&gt;+ so that any HTML would be escaped before being inserted into the page.  In Rails 3.0, this is now the default.  To get unescaped HTML, you now use +&lt;%= raw post.name %&gt;+.
548

549
TIP: For more details on the rendering process, see "Layouts and Rendering in Rails":layouts_and_rendering.html.
550 551 552

h4. Customizing the Layout

553
The view is only part of the story of how HTML is displayed in your web browser. Rails also has the concept of +layouts+, which are containers for views. When Rails renders a view to the browser, it does so by putting the view's HTML into a layout's HTML. In previous versions of Rails, the +rails generate scaffold+ command would automatically create a controller specific layout, like +app/views/layouts/posts.html.erb+, for the posts controller. However this has been changed in Rails 3.0. A application specific +layout+ is used for all the controllers and can be found in +app/views/layouts/application.html.erb+. Open this layout in your editor and modify the +body+ tag:
554 555

<erb>
556 557
<!DOCTYPE html>
<html>
558
<head>
559 560 561 562
  <title>Blog</title>
  <%= stylesheet_link_tag :all %>
  <%= javascript_include_tag :defaults %>
  <%= csrf_meta_tag %>
563 564 565
</head>
<body style="background: #EEEEEE;">

566
<%= yield %>
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

</body>
</html>
</erb>

Now when you refresh the +/posts+ page, you'll see a gray background to the page. This same gray background will be used throughout all the views for posts.

h4. Creating New Posts

Creating a new post involves two actions. The first is the +new+ action, which instantiates an empty +Post+ object:

<ruby>
def new
  @post = Post.new

  respond_to do |format|
    format.html # new.html.erb
    format.xml  { render :xml => @post }
  end
end
</ruby>

The +new.html.erb+ view displays this empty Post to the user:

<erb>
<h1>New post</h1>

594 595 596 597 598
<%= render 'form' %>

<%= link_to 'Back', posts_path %>
</erb>

599
The +&lt;%= render 'form' %&gt;+ line is our first introduction to _partials_ in Rails.  A partial is a snippet of HTML and Ruby code that can be reused in multiple locations.  In this case, the form used to make a new post, is basically identical to a form used to edit a post, both have text fields for the name and title and a text area for the content with a button to make a new post or update the existing post.
600 601 602 603

If you take a look at +views/posts/_form.html.erb+ file, you will see the following:

<erb>
604
<%= form_for(@post) do |f| %>
605 606 607 608 609 610 611 612 613 614
  <% if @post.errors.any? %>
  <div id="errorExplanation">
    <h2><%= pluralize(@post.errors.count, "error") %> prohibited this post from being saved:</h2>
    <ul>
    <% @post.errors.full_messages.each do |msg| %>
      <li><%= msg %></li>
    <% end %>
    </ul>
  </div>
  <% end %>
615

616
  <div class="field">
617 618
    <%= f.label :name %><br />
    <%= f.text_field :name %>
619 620
  </div>
  <div class="field">
621 622
    <%= f.label :title %><br />
    <%= f.text_field :title %>
623 624
  </div>
  <div class="field">
625 626
    <%= f.label :content %><br />
    <%= f.text_area :content %>
627 628 629 630
  </div>
  <div class="actions">
    <%= f.submit %>
  </div>
631 632 633
<% end %>
</erb>

634 635 636 637
This partial receives all the instance variables defined in the calling view file, so in this case, the controller assigned the new Post object to +@post+ and so, this is available in both the view and partial as +@post+.

For more information on partials, refer to the "Layouts and Rendering in Rails":layouts_and_rendering.html#using-partials guide.

638
The +form_for+ block is used to create an HTML form. Within this block, you have access to methods to build various controls on the form. For example, +f.text_field :name+ tells Rails to create a text input on the form, and to hook it up to the +name+ attribute of the instance being displayed. You can only use these methods with attributes of the model that the form is based on (in this case +name+, +title+, and +content+). Rails uses +form_for+ in preference to having you write raw HTML because the code is more succinct, and because it explicitly ties the form to a particular model instance.
639

640 641
The +form_for+ block is also smart enough to work out if you are doing a _New Post_ or an _Edit Post_ action, and will set the form +action+ tags and submit button names appropriately in the HTML output.

642 643
TIP: If you need to create an HTML form that displays arbitrary fields, not tied to a model, you should use the +form_tag+ method, which provides shortcuts for building forms that are not necessarily tied to a model instance.

644
When the user clicks the +Create Post+ button on this form, the browser will send information back to the +create+ method of the controller (Rails knows to call the +create+ method because the form is sent with an HTTP POST request; that's one of the conventions that I mentioned earlier):
645 646 647 648 649 650 651

<ruby>
def create
  @post = Post.new(params[:post])

  respond_to do |format|
    if @post.save
652 653 654 655
      format.html { redirect_to(@post,
                    :notice => 'Post was successfully created.') }
      format.xml  { render :xml => @post,
                    :status => :created, :location => @post }
656 657
    else
      format.html { render :action => "new" }
658
      format.xml  { render :xml => @post.errors,
659
                    :status => :unprocessable_entity }
660 661 662 663 664
    end
  end
end
</ruby>

665
The +create+ action instantiates a new Post object from the data supplied by the user on the form, which Rails makes available in the +params+ hash. After successfully saving the new post, returns the appropriate format that the user has requested (HTML in our case). It then redirects the user to the resulting post +show+ action and sets a notice to the user that the Post was successfully created.
666

667 668 669
If the post was not successfully saved, due to a validation error, then the controller returns the user back to the +new+ action with any error messages so that the user has the chance to fix the error and try again.

The "Post was successfully created" message is stored inside of the Rails +flash+ hash, (usually just called the Flash) so that messages can be carried over to another action, providing the user with useful information on the status of their request. In the case of +create+, the user never actually sees any page rendered during the Post creation process, because it immediately redirects to the new Post as soon Rails saves the record. The Flash carries over a message to the next action, so that when the user is redirected back to the +show+ action, they are presented with a message saying "Post was successfully created."
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688

h4. Showing an Individual Post

When you click the +show+ link for a post on the index page, it will bring you to a URL like +http://localhost:3000/posts/1+. Rails interprets this as a call to the +show+ action for the resource, and passes in +1+ as the +:id+ parameter. Here's the +show+ action:

<ruby>
def show
  @post = Post.find(params[:id])

  respond_to do |format|
    format.html # show.html.erb
    format.xml  { render :xml => @post }
  end
end
</ruby>

The +show+ action uses +Post.find+ to search for a single record in the database by its id value. After finding the record, Rails displays it by using +show.html.erb+:

<erb>
689 690
<p class="notice"><%= notice %></p>

691
<p>
692
  <b>Name:</b>
693
  <%= @post.name %>
694 695 696
</p>

<p>
697
  <b>Title:</b>
698
  <%= @post.title %>
699 700 701
</p>

<p>
702
  <b>Content:</b>
703
  <%= @post.content %>
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
</p>


<%= link_to 'Edit', edit_post_path(@post) %> |
<%= link_to 'Back', posts_path %>
</erb>

h4. Editing Posts

Like creating a new post, editing a post is a two-part process. The first step is a request to +edit_post_path(@post)+ with a particular post. This calls the +edit+ action in the controller:

<ruby>
def edit
  @post = Post.find(params[:id])
end
</ruby>

After finding the requested post, Rails uses the +edit.html.erb+ view to display it:

<erb>
<h1>Editing post</h1>

726
<%= render 'form' %>
727 728 729

<%= link_to 'Show', @post %> |
<%= link_to 'Back', posts_path %>
730
<% end %>
731 732
</erb>

733 734
Again, as with the +new+ action, the +edit+ action is using the +form+ partial, this time however, the form will do a PUT action to the PostsController and the submit button will display "Update Post"

735 736 737 738 739 740 741 742
Submitting the form created by this view will invoke the +update+ action within the controller:

<ruby>
def update
  @post = Post.find(params[:id])

  respond_to do |format|
    if @post.update_attributes(params[:post])
743 744
      format.html { redirect_to(@post, 
                    :notice => 'Post was successfully updated.') }
745 746 747
      format.xml  { head :ok }
    else
      format.html { render :action => "edit" }
748
      format.xml  { render :xml => @post.errors,
749
                    :status => :unprocessable_entity }
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
    end
  end
end
</ruby>

In the +update+ action, Rails first uses the +:id+ parameter passed back from the edit view to locate the database record that's being edited. The +update_attributes+ call then takes the rest of the parameters from the request and applies them to this record. If all goes well, the user is redirected to the post's +show+ view. If there are any problems, it's back to +edit+ to correct them.

h4. Destroying a Post

Finally, clicking one of the +destroy+ links sends the associated id to the +destroy+ action:

<ruby>
def destroy
  @post = Post.find(params[:id])
  @post.destroy

  respond_to do |format|
    format.html { redirect_to(posts_url) }
    format.xml  { head :ok }
  end
end
</ruby>

The +destroy+ method of an Active Record model instance removes the corresponding record from the database. After that's done, there isn't any record to display, so Rails redirects the user's browser to the index view for the model.

h3. Adding a Second Model

Now that you've seen what's in a model built with scaffolding, it's time to add a second model to the application. The second model will handle comments on blog posts.

779
h4. Generating a Model
780 781 782 783

Models in Rails use a singular name, and their corresponding database tables use a plural name. For the model to hold comments, the convention is to use the name Comment. Even if you don't want to use the entire apparatus set up by scaffolding, most Rails developers still use generators to make things like models and controllers. To create the new model, run this command in your terminal:

<shell>
784
$ rails generate model Comment commenter:string body:text post:references
785 786 787 788 789
</shell>

This command will generate four files:

* +app/models/comment.rb+ - The model
790
* +db/migrate/20100207235629_create_comments.rb+ - The migration
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
* +test/unit/comment_test.rb+ and +test/fixtures/comments.yml+ - The test harness.

First, take a look at +comment.rb+:

<ruby>
class Comment < ActiveRecord::Base
  belongs_to :post
end
</ruby>

This is very similar to the +post.rb+ model that you saw earlier. The difference is the line +belongs_to :post+, which sets up an Active Record _association_. You'll learn a little about associations in the next section of this guide.

In addition to the model, Rails has also made a migration to create the corresponding database table:

<ruby>
class CreateComments < ActiveRecord::Migration
  def self.up
    create_table :comments do |t|
      t.string :commenter
      t.text :body
      t.references :post

      t.timestamps
    end
  end

  def self.down
    drop_table :comments
  end
end
</ruby>

The +t.references+ line sets up a foreign key column for the association between the two models. Go ahead and run the migration:

<shell>
$ rake db:migrate
</shell>

829 830 831 832 833
Rails is smart enough to only execute the migrations that have not already been run against the current database, so in this case you will just see:

<shell>
==  CreateComments: migrating =================================================
-- create_table(:comments)
834 835
   -> 0.0017s
==  CreateComments: migrated (0.0018s) ========================================
836
</shell>
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856

h4. Associating Models

Active Record associations let you easily declare the relationship between two models. In the case of comments and posts, you could write out the relationships this way:

* Each comment belongs to one post
* One post can have many comments

In fact, this is very close to the syntax that Rails uses to declare this association. You've already seen the line of code inside the Comment model that makes each comment belong to a Post:

<ruby>
class Comment < ActiveRecord::Base
  belongs_to :post
end
</ruby>

You'll need to edit the +post.rb+ file to add the other side of the association:

<ruby>
class Post < ActiveRecord::Base
857 858 859
  validates :name,  :presence => true
  validates :title, :presence => true,
                    :length => { :minimum => 5 }
860

861 862 863 864 865 866 867 868
  has_many :comments
end
</ruby>

These two declarations enable a good bit of automatic behavior. For example, if you have an instance variable +@post+ containing a post, you can retrieve all the comments belonging to that post as the array +@post.comments+.

TIP: For more information on Active Record associations, see the "Active Record Associations":association_basics.html guide.

869
h4. Adding a Route for Comments
870

871
As with the +home+ controller, we will need to add a route so that Rails knows where we would like to navigate to see +comments+.  Open up the +config/routes.rb+ file again, you will see an entry that was added automatically for +posts+ near the top by the scaffold generator, +resources :posts+, edit it as follows:
872 873

<ruby>
874 875 876
resources :posts do
  resources :comments
end
877 878 879 880
</ruby>

This creates +comments+ as a _nested resource_ within +posts+. This is another part of capturing the hierarchical relationship that exists between posts and comments.

881
TIP: For more information on routing, see the "Rails Routing from the Outside In":routing.html guide.
882 883 884 885 886 887

h4. Generating a Controller

With the model in hand, you can turn your attention to creating a matching controller. Again, there's a generator for this:

<shell>
888
$ rails generate controller Comments
889 890
</shell>

891
This creates four files and one empty directory:
892 893 894 895

* +app/controllers/comments_controller.rb+ - The controller
* +app/helpers/comments_helper.rb+ - A view helper file
* +test/functional/comments_controller_test.rb+ - The functional tests for the controller
896
* +test/unit/helpers/comments_helper_test.rb+ - The unit tests for the helper
897
* +app/views/comments/+ - Views of the controller are stored here
898

899
Like with any blog, our readers will create their comments directly after reading the post, and once they have added their comment, will be sent back to the post show page to see their comment now listed.  Due to this, our +CommentsController+ is there to provide a method to create comments and delete SPAM comments when they arrive.
900

901
So first, we'll wire up the Post show template (+/app/views/posts/show.html.erb+) to let us make a new comment:
902

903
<erb>
904 905
<p class="notice"><%= notice %></p>

906
<p>
907
  <b>Name:</b>
908 909
  <%= @post.name %>
</p>
910

911
<p>
912
  <b>Title:</b>
913 914
  <%= @post.title %>
</p>
915

916
<p>
917
  <b>Content:</b>
918 919
  <%= @post.content %>
</p>
920

921
<h2>Add a comment:</h2>
922
<%= form_for([@post, @post.comments.build]) do |f| %>
923
  <%= f.error_messages %>
924

925 926 927 928 929 930 931 932 933 934 935 936
  <div class="field">
    <%= f.label :commenter %><br />
    <%= f.text_field :commenter %>
  </div>
  <div class="field">
    <%= f.label :body %><br />
    <%= f.text_area :body %>
  </div>
  <div class="actions">
    <%= f.submit %>
  </div>
<% end %>
937

938 939 940
<%= link_to 'Edit Post', edit_post_path(@post) %> |
<%= link_to 'Back to Posts', posts_path %> |
</erb>
941

942
This adds a form on the Post show page that creates a new comment, which will call the +CommentsController+ +create+ action, so let's wire that up:
943

944 945
<ruby>
class CommentsController < ApplicationController
946
  def create
947
    @post = Post.find(params[:post_id])
948 949
    @comment = @post.comments.create(params[:comment])
    redirect_to post_path(@post)
950
  end
951 952 953
end
</ruby>

954
You'll see a bit more complexity here than you did in the controller for posts. That's a side-effect of the nesting that you've set up; each request for a comment has to keep track of the post to which the comment is attached, thus the initial find action to the Post model to get the post in question.
955

R
rohit 已提交
956
In addition, the code takes advantage of some of the methods available for an association. We use the +create+ method on +@post.comments+ to create and save the comment. This will automatically link the comment so that it belongs to that particular post.
957

R
rohit 已提交
958
Once we have made the new comment, we send the user back to the original post using the +post_path(@post)+ helper. As we have already seen, this calls the +show+ action of the +PostsController+ which in turn renders the +show.html.erb+ template. This is where we want the comment to show, so let's add that to the +app/view/posts/show.html.erb+.
959

960
<erb>
961 962
<p class="notice"><%= notice %></p>

963
<p>
964
  <b>Name:</b>
965 966
  <%= @post.name %>
</p>
967

968
<p>
969
  <b>Title:</b>
970 971
  <%= @post.title %>
</p>
972

973
<p>
974
  <b>Content:</b>
975 976
  <%= @post.content %>
</p>
977

978 979 980
<h2>Comments</h2>
<% @post.comments.each do |comment| %>
  <p>
981
    <b>Commenter:</b>
982 983
    <%= comment.commenter %>
  </p>
984

985
  <p>
986
    <b>Comment:</b>
987 988 989
    <%= comment.body %>
  </p>
<% end %>
990

991
<h2>Add a comment:</h2>
992
<%= form_for([@post, @post.comments.build]) do |f| %>
993
  <%= f.error_messages %>
994

995 996 997 998 999 1000 1001 1002 1003 1004 1005
  <div class="field">
    <%= f.label :commenter %><br />
    <%= f.text_field :commenter %>
  </div>
  <div class="field">
    <%= f.label :body %><br />
    <%= f.text_area :body %>
  </div>
  <div class="actions">
    <%= f.submit %>
  </div>
1006 1007 1008 1009
<% end %>

<br />

1010 1011
<%= link_to 'Edit Post', edit_post_path(@post) %> |
<%= link_to 'Back to Posts', posts_path %> |
1012 1013
</erb>

1014
Now you can add posts and comments to your blog and have them show up in the right places.
1015

1016
h3. Refactorization
1017

1018
Now that we have Posts and Comments working, if we take a look at the +app/views/posts/show.html.erb+ template, it's getting long and awkward. We can use partials to clean this up.
1019

1020
h4. Rendering Partial Collections
1021

1022
First we will make a comment partial to extract showing all the comments for the post. Create the file +app/views/comments/_comment.html.erb+ and put the following into it:
1023 1024

<erb>
1025
<p>
1026
  <b>Commenter:</b>
1027 1028
  <%= comment.commenter %>
</p>
1029

1030
<p>
1031
  <b>Comment:</b>
1032 1033
  <%= comment.body %>
</p>
1034 1035
</erb>

1036
Then in the +app/views/posts/show.html.erb+ you can change it to look like the following:
1037 1038

<erb>
1039 1040
<p class="notice"><%= notice %></p>

1041
<p>
1042
  <b>Name:</b>
1043 1044 1045 1046
  <%= @post.name %>
</p>

<p>
1047
  <b>Title:</b>
1048 1049 1050 1051
  <%= @post.title %>
</p>

<p>
1052
  <b>Content:</b>
1053 1054 1055 1056 1057 1058 1059 1060
  <%= @post.content %>
</p>

<h2>Comments</h2>
<%= render :partial => "comments/comment", 
           :collection => @post.comments %>

<h2>Add a comment:</h2>
1061
<%= form_for([@post, @post.comments.build]) do |f| %>
1062 1063
  <%= f.error_messages %>

1064
  <div class="field">
1065 1066
    <%= f.label :commenter %><br />
    <%= f.text_field :commenter %>
1067 1068
  </div>
  <div class="field">
1069 1070
    <%= f.label :body %><br />
    <%= f.text_area :body %>
1071 1072 1073 1074
  </div>
  <div class="actions">
    <%= f.submit %>
  </div>
1075 1076
<% end %>

1077
<br />
1078

1079 1080 1081
<%= link_to 'Edit Post', edit_post_path(@post) %> |
<%= link_to 'Back to Posts', posts_path %> |
</erb>
1082

1083
This will now render the partial in +app/views/comments/_comment.html.erb+ once for each comment that is in the +@post.comments+ collection.  As the +render+ method iterates over the <tt>@post.comments</tt> collection, it assigns each comment to a local variable named the same as the partial, in this case +comment+ which is then available in the partial for us to show.
1084

1085
h4. Rendering a Partial Form
1086

1087
Lets also move that new comment section out to it's own partial, again, you create a file +app/views/comments/_form.html.erb+ and in it you put:
1088

1089
<erb>
1090
<%= form_for([@post, @post.comments.build]) do |f| %>
1091
  <%= f.error_messages %>
1092

1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
  <div class="field">
    <%= f.label :commenter %><br />
    <%= f.text_field :commenter %>
  </div>
  <div class="field">
    <%= f.label :body %><br />
    <%= f.text_area :body %>
  </div>
  <div class="actions">
    <%= f.submit %>
  </div>
<% end %>
</erb>
1106

1107
Then you make the +app/views/posts/show.html.erb+ look like the following:
1108 1109

<erb>
1110 1111
<p class="notice"><%= notice %></p>

1112
<p>
1113
  <b>Name:</b>
1114
  <%= @post.name %>
1115 1116 1117
</p>

<p>
1118
  <b>Title:</b>
1119
  <%= @post.title %>
1120 1121 1122
</p>

<p>
1123
  <b>Content:</b>
1124
  <%= @post.content %>
1125 1126 1127
</p>

<h2>Comments</h2>
1128 1129
<%= render :partial => "comments/comment", 
           :collection => @post.comments %>
1130

1131 1132 1133 1134
<h2>Add a comment:</h2>
<%= render "comments/form" %>

<br />
1135 1136 1137 1138 1139

<%= link_to 'Edit Post', edit_post_path(@post) %> |
<%= link_to 'Back to Posts', posts_path %> |
</erb>

1140 1141
The second render just defines the partial template we want to render, <tt>comments/form</tt>, Rails is smart enough to spot the forward slash in that string and realise that you want to render the <tt>_form.html.erb</tt> file in the <tt>app/views/comments</tt> directory.

1142
The +@post+ object is available to any partials rendered in the view because we defined it as an instance variable.
1143 1144 1145 1146 1147 1148 1149 1150 1151

h3. Deleting Comments

Another important feature on a blog is being able to delete SPAM comments.  To do this, we need to implement a link of some sort in the view and a +DELETE+ action in the +CommentsController+.

So first, let's add the delete link in the +app/views/comments/_comment.html.erb+ partial:

<erb>
<p>
1152
  <b>Commenter:</b>
1153 1154 1155 1156
  <%= comment.commenter %>
</p>

<p>
1157
  <b>Comment:</b>
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
  <%= comment.body %>
</p>

<p>
  <%= link_to 'Destroy Comment', [comment.post, comment],
               :confirm => 'Are you sure?',
               :method => :delete %>
</p>
</erb>

Clicking this new "Destroy Comment" link will fire off a <tt>DELETE /posts/:id/comments/:id</tt> to our +CommentsController+, which can then use this to find the comment we want to delete, so let's add a destroy action to our controller:

<ruby>
class CommentsController < ApplicationController

  def create
    @post = Post.find(params[:post_id])
    @comment = @post.comments.create(params[:comment])
    redirect_to post_path(@post)
  end

  def destroy
    @post = Post.find(params[:post_id])
    @comment = @post.comments.find(params[:id])
    @comment.destroy
    redirect_to post_path(@post)
  end

end
</ruby>

The +destroy+ action will find the post we are looking at, locate the comment within the <tt>@post.comments</tt> collection, and then remove it from the database and send us back to the show action for the post.

1191

1192 1193
h4. Deleting Associated Objects

1194
If you delete a post then it's associated comments will also need to be deleted. Otherwise they would simply occupy space in the database. Rails allows you to use the +dependent+ option of an association to achieve this. Modify the Post model, +app/models/post.rb+, as follows:
1195 1196 1197

<ruby>
class Post < ActiveRecord::Base
1198 1199 1200
  validates :name,  :presence => true
  validates :title, :presence => true,
                    :length => { :minimum => 5 }
1201 1202
  has_many :comments, :dependent => :destroy
end
1203 1204 1205 1206
</ruby>

h3. Security

R
rohit 已提交
1207
If you were to publish your blog online, anybody would be able to add, edit and delete posts or delete comments.
1208

R
rohit 已提交
1209
Rails provides a very simple HTTP authentication system that will work nicely in this situation. First, we enable simple HTTP based authentication in our <tt>app/controllers/application_controller.rb</tt>:
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260

<ruby>
class ApplicationController < ActionController::Base
  protect_from_forgery
  
  private
  
  def authenticate
    authenticate_or_request_with_http_basic do |user_name, password|
      user_name == 'admin' && password == 'password'
    end
  end
  
end
</ruby>

You can obviously change the username and password to whatever you want.  We put this method inside of +ApplicationController+ so that it is available to all of our controllers.

Then in the +PostsController+ we need to have a way to block access to the various actions if the person is not authenticated, here we can use the Rails <tt>before_filter</tt> method, which allows us to specify that Rails must run a method and only then allow access to the requested action if that method allows it.

To use the before filter, we specify it at the top of our +PostsController+, in this case, we want the user to be authenticated on every action, except for +index+ and +show+, so we write that:

<ruby>
class PostsController < ApplicationController

  before_filter :authenticate, :except => [:index, :show]

  # GET /posts
  # GET /posts.xml
  def index
    @posts = Post.all
    respond_to do |format|
# snipped for brevity
</ruby>

We also only want to allow authenticated users to delete comments, so in the +CommentsController+ we write:

<ruby>
class CommentsController < ApplicationController

  before_filter :authenticate, :only => :destroy

  def create
    @post = Post.find(params[:post_id])
# snipped for brevity
</ruby>

Now if you try to create a new post, you will be greeted with a basic HTTP Authentication challenge

!images/challenge.png(Basic HTTP Authentication Challenge)!

1261

1262 1263
h3. Building a Multi-Model Form

1264 1265 1266
Another piece of your average blog is the ability to tag posts.  This requires that your application edits more than one thing on a single form.  Rails offers support for nested forms.

To demonstrate this, we will add support for giving each post multiple tags, right in the form where you create the post. First, create a new model to hold the tags:
1267 1268

<shell>
1269
$ rails generate model tag name:string post:references
1270 1271
</shell>

1272
Again, run the migration to create the database table:
1273 1274 1275 1276 1277

<shell>
$ rake db:migrate
</shell>

1278
Next, edit the +post.rb+ file to create the other side of the association, and to tell Rails (via the +accepts_nested_attributes+ macro) that you intend to edit tags via posts:
1279 1280 1281

<ruby>
class Post < ActiveRecord::Base
1282 1283 1284
  validates :name,  :presence => true
  validates :title, :presence => true,
                    :length => { :minimum => 5 }
1285 1286

  has_many :comments, :dependent => :destroy
1287
  has_many :tags
1288

1289
  accepts_nested_attributes_for :tags, :allow_destroy => :true,
1290 1291 1292 1293 1294 1295
    :reject_if => proc { |attrs| attrs.all? { |k, v| v.blank? } }
end
</ruby>

The +:allow_destroy+ option on the nested attribute declaration tells Rails to display a "remove" checkbox on the view that you'll build shortly. The +:reject_if+ option prevents saving new tags that do not have any attributes filled in.

1296
We will modify +views/posts/_form.html.erb+ to render a partial to make a tag:
1297 1298

<erb>
1299
<% @post.tags.build %>
1300
<%= form_for(@post) do |post_form| %>
1301 1302
  <%= post_form.error_messages %>

1303
  <div class="field">
1304 1305
    <%= post_form.label :name %><br />
    <%= post_form.text_field :name %>
1306 1307 1308
  </div>
  <div class="field">
    <%= post_form.label :title %><br />
1309
    <%= post_form.text_field :title %>
1310 1311
  </div>
  <div class="field">
1312 1313
    <%= post_form.label :content %><br />
    <%= post_form.text_area :content %>
1314
  </div>
1315
  <h2>Tags</h2>
1316 1317
  <%= render :partial => 'tags/form',
             :locals => {:form => post_form} %>
1318 1319 1320
  <div class="actions">
    <%= post_form.submit %>
  </div>
1321 1322 1323
<% end %>
</erb>

1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
This example shows another option of the render helper, being able to pass in local variables, in this case, we want the local variable +form+ in the partial to refer to the +post_form+ object.

You will also note that we also have changed the +f+ in <tt>form_for(@post) do |f|</tt> to <tt>post_form</tt> to clarify what is going on somewhat.

We also add a <tt>@post.tags.build</tt> at the top of this form, this is to make sure there is a new tag ready to have it's name filled in by the user.  If you do not build the new tag, then the form will not appear as there is no new Tag object ready to create.

Now create the folder <tt>app/views/tags</tt> and make a file in there called <tt>_form.html.erb</tt> which contains the form for the tag:

<erb>
<% form.fields_for :tags do |tag_form| %>
  <div class="field">
    <%= tag_form.label :name, 'Tag:' %>
    <%= tag_form.text_field :name %>
  </div>
  <% unless tag_form.object.nil? || tag_form.object.new_record? %>
    <div class="field">
      <%= tag_form.label :_destroy, 'Remove:' %>
      <%= tag_form.check_box :_destroy %>
    </div>
  <% end %>
<% end %>
</erb>

Finally, we will edit the <tt>app/views/posts/show.html.erb</tt> template to show our tags.

<erb>
1350 1351
<p class="notice"><%= notice %></p>

1352
<p>
1353
  <b>Name:</b>
1354 1355 1356 1357
  <%= @post.name %>
</p>

<p>
1358
  <b>Title:</b>
1359 1360 1361 1362
  <%= @post.title %>
</p>

<p>
1363
  <b>Content:</b>
1364 1365 1366 1367
  <%= @post.content %>
</p>

<p>
1368
  <b>Tags:</b>
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
  <%= @post.tags.map { |t| t.name }.join(", ") %>
</p>

<h2>Comments</h2>
<%= render :partial => "comments/comment", 
           :collection => @post.comments %>

<h2>Add a comment:</h2>
<%= render "comments/form" %>


<%= link_to 'Edit Post', edit_post_path(@post) %> |
<%= link_to 'Back to Posts', posts_path %> |
</erb>
1383

1384 1385
With these changes in place, you'll find that you can edit a post and its tags directly on the same view.

1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
However, that method call <tt>@post.tags.map { |t| t.name }.join(", ")</tt> is awkward, we could handle this by making a helper method.

h3. View Helpers

View Helpers live in <tt>app/helpers</tt> and provide small snippets of reusable code for views.  In our case, we want a method that strings a bunch of objects together using their name attribute and joining them with a comma.  As this is for the Post show template, we put it in the PostsHelper.

Open up <tt>app/helpers/posts_helper.rb</tt> and add the following:

<erb>
module PostsHelper
  def join_tags(post)
    post.tags.map { |t| t.name }.join(", ") 
  end
end
</erb>

Now you can edit the view in <tt>app/views/posts/show.html.erb</tt> to look like this:

<erb>
1405 1406
<p class="notice"><%= notice %></p>

1407
<p>
1408
  <b>Name:</b>
1409 1410 1411 1412
  <%= @post.name %>
</p>

<p>
1413
  <b>Title:</b>
1414 1415 1416 1417
  <%= @post.title %>
</p>

<p>
1418
  <b>Content:</b>
1419 1420 1421 1422
  <%= @post.content %>
</p>

<p>
1423
  <b>Tags:</b>
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
  <%= join_tags(@post) %>
</p>

<h2>Comments</h2>
<%= render :partial => "comments/comment", 
           :collection => @post.comments %>

<h2>Add a comment:</h2>
<%= render "comments/form" %>


<%= link_to 'Edit Post', edit_post_path(@post) %> |
<%= link_to 'Back to Posts', posts_path %> |
</erb>
1438 1439 1440 1441 1442

h3. What's Next?

Now that you've seen your first Rails application, you should feel free to update it and experiment on your own. But you don't have to do everything without help. As you need assistance getting up and running with Rails, feel free to consult these support resources:

1443
* The "Ruby On Rails guides":index.html
1444
* The "Ruby on Rails mailing list":http://groups.google.com/group/rubyonrails-talk
J
Joseph Pecoraro 已提交
1445
* The "#rubyonrails":irc://irc.freenode.net/#rubyonrails channel on irc.freenode.net
1446
* The "Rails Wiki":http://wiki.rubyonrails.org/
1447 1448 1449

Rails also comes with built-in help that you can generate using the rake command-line utility:

J
Joseph Pecoraro 已提交
1450 1451
* Running +rake doc:guides+ will put a full copy of the Rails Guides in the +doc/guides+ folder of your application. Open +doc/guides/index.html+ in your web browser to explore the Guides.
* Running +rake doc:rails+ will put a full copy of the API documentation for Rails in the +doc/api+ folder of your application. Open +doc/api/index.html+ in your web browser to explore the API documentation.
1452

1453

1454 1455 1456 1457
h3. Changelog

"Lighthouse ticket":http://rails.lighthouseapp.com/projects/16213-rails-guides/tickets/2

1458
* April 25, 2010: Couple of more minor fixups "Mikel Lindsaar":credits:html#raasdnil
1459
* April 1, 2010: Fixed document to validate XHTML 1.0 Strict. "Jaime Iniesta":http://jaimeiniesta.com
1460
* February 8, 2010: Full re-write for Rails 3.0-beta, added helpers and before_filters, refactored code by "Mikel Lindsaar":credits:html#raasdnil
1461
* January 24, 2010: Re-write for Rails 3.0 by "Mikel Lindsaar":credits:html#raasdnil
1462
* July 18, 2009: Minor cleanup in anticipation of Rails 2.3.3 by "Mike Gunderloy":credits.html#mgunderloy
1463 1464 1465 1466 1467 1468
* February 1, 2009: Updated for Rails 2.3 by "Mike Gunderloy":credits.html#mgunderloy
* November 3, 2008: Formatting patch from Dave Rothlisberger
* November 1, 2008: First approved version by "Mike Gunderloy":credits.html#mgunderloy
* October 16, 2008: Revised based on feedback from Pratik Naik by "Mike Gunderloy":credits.html#mgunderloy (not yet approved for publication)
* October 13, 2008: First complete draft by "Mike Gunderloy":credits.html#mgunderloy (not yet approved for publication)
* October 12, 2008: More detail, rearrangement, editing by "Mike Gunderloy":credits.html#mgunderloy (not yet approved for publication)
J
James Miller 已提交
1469
* September 8, 2008: initial version by "James Miller":credits.html#bensie (not yet approved for publication)