1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
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
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
|
h2. Rails Routing from the Outside In
This guide covers the user-facing features of Rails routing. By referring to this guide, you will be able to:
* Understand the code in +routes.rb+
* Construct your own routes, using either the preferred resourceful style or with the @match@ method
* Identify what parameters to expect an action to receive
* Automatically create URLs using route helpers
* Use advanced techniques such as constraints and Rack endpoints
endprologue.
h3. The Purpose of the Rails Router
The Rails router recognizes URLs and dispatches them to a controller's action. It can also generate URLs, avoiding the need to hardcode URL strings in your views.
h4. Connecting URLs to Code
When your Rails application receives an incoming request
<plain>
GET /patients/17
</plain>
it asks the router to match it to a controller action. If the first matching route is
<ruby>
match "/patients/:id" => "patients#show"
</ruby>
the request is dispatched to the +patients+ controller's +show+ action with <tt>{ :id => "17" }</tt> in +params+.
h4. Generating URLs from Code
You can also generate URLs. If your application contains this code:
<ruby>
@patient = Patient.find(17)
</ruby>
<erb>
<%= link_to "Patient Record", patients_path(@patient.id) %>
</erb>
The router will generate the path +/patients/17+. This reduces the brittleness of your view and makes your code easier to understand.
h3. Resource Routing: the Rails Default
Resource routing allows you to quickly declare all of the common routes for a given resourceful controller. Instead of declaring separate routes for your +index+, +show+, +new+, +edit+, +create+, +update+ and +destroy+ actions, a resourceful route declares them in a single line of code.
h4. Resources on the Web
Browsers request pages from Rails by making a request for a URL using a specific HTTP method, such as +GET+, +POST+, +PUT+ and +DELETE+. Each method is a request to perform an operation on the resource. A resource route maps a number of related request to the actions in a single controller.
When your Rails application receives an incoming request for
<plain>
DELETE /photos/17
</plain>
it asks the router to map it to a controller action. If the first matching route is
<ruby>
resources :photos
</ruby>
Rails would dispatch that request to the +destroy+ method on the +photos+ controller with <tt>{ :id => "17" }</tt> in +params+.
h4. CRUD, Verbs, and Actions
In Rails, a resourceful route provides a mapping between HTTP verbs and URLs and controller actions. By convention, each action also maps to particular CRUD operations in a database. A single entry in the routing file, such as
<ruby>
resources :photos
</ruby>
creates seven different routes in your application, all mapping to the +Photos+ controller:
|_. Verb |_.URL |_.action |_.used for|
|GET |/photos |index |display a list of all photos|
|GET |/photos/new |new |return an HTML form for creating a new photo|
|POST |/photos |create |create a new photo|
|GET |/photos/:id |show |display a specific photo|
|GET |/photos/:id/edit |edit |return an HTML form for editing a photo|
|PUT |/photos/:id |update |update a specific photo|
|DELETE |/photos/:id |destroy |delete a specific photo|
h4. URLs and Paths
Creating a resourceful route will also expose a number of helpers to the controllers in your application. In the case of +resources :photos+:
* +photos_path+ returns +/photos+
* +new_photo_path+ returns +/photos/new+
* +edit_photo_path+ returns +/photos/edit+
* +photo_path(id)+ returns +/photos/:id+ (for instance, +photo_path(10)+ returns +/photos/10+)
Each of these helpers has a corresponding +_url+ helper (such as +photos_url+) which returns the same path prefixed with the current host, port and path prefix.
NOTE: Because the router uses the HTTP verb and URL to match inbound requests, four URLs map to seven different actions.
h4. Defining Multiple Resources at the Same Time
If you need to create routes for more than one resource, you can save a bit of typing by defining them all with a single call to +resources+:
<ruby>
resources :photos, :books, :videos
</ruby>
This works exactly the same as
<ruby>
resources :photos
resources :books
resources :videos
</ruby>
h4. Singular Resources
Sometimes, you have a resource that clients always look up without referencing an ID. A common example, +/profile+ always shows the profile of the currently logged in user. In this case, you can use a singular resource to map +/profile+ (rather than +/profile/:id+) to the +show+ action.
<ruby>
match "profile" => "users#show"
</ruby>
This resourceful route
<ruby>
resource :geocoder
</ruby>
creates six different routes in your application, all mapping to the +Geocoders+ controller:
|_. Verb |_.URL |_.action |_.used for|
|GET |/geocoder/new |new |return an HTML form for creating the geocoder|
|POST |/geocoder |create |create the new geocoder|
|GET |/geocoder |show |display the one and only geocoder resource|
|GET |/geocoder/edit |edit |return an HTML form for editing the geocoder|
|PUT |/geocoder |update |update the one and only geocoder resource|
|DELETE |/geocoder |destroy |delete the geocoder resource|
NOTE: Because you might want to use the same controller for a singular route (+/account+) and a plural route (+/accounts/45+), singular resources map to plural controllers.
A singular resourceful route generates these helpers:
* +new_geocoder_path+ returns +/geocoder/new+
* +edit_geocoder_path+ returns +/geocoder/edit+
* +geocoder_path+ returns +/geocoder+
As with plural resources, the same helpers ending in +_url+ will also include the host, port and path prefix.
h4. Controller Namespaces and Routing
You may wish to organize groups of controllers under a namespace. Most commonly, you might group a number of administrative controllers under an +Admin::+ namespace. You would place these controllers under the +app/controllers/admin+ directory, and you can group them together in your router:
<ruby>
namespace "admin" do
resources :posts, :comments
end
</ruby>
This will create a number of routes for each of the +posts+ and +comments+ controller. For +Admin::PostsController+, Rails will create:
|_. Verb |_.URL |_.action |_. helper |
|GET |/admin/photos |index | admin_photos_path |
|GET |/admin/photos/new |new | new_admin_photos_path |
|POST |/admin/photos |create | admin_photos_path |
|GET |/admin/photos/1 |show | admin_photo_path(id) |
|GET |/admin/photos/1/edit |edit | edit_admin_photo_path(id) |
|PUT |/admin/photos/1 |update | admin_photo_path(id) |
|DELETE |/admin/photos/1 |destroy | admin_photo_path(id) |
If you want to route +/photos+ (without the prefix +/admin+) to +Admin::PostsController+, you could use
<ruby>
scope :module => "admin" do
resources :posts, :comments
end
</ruby>
or, for a single case
<ruby>
resources :posts, :module => "admin"
</ruby>
If you want to route +/admin/photos+ to +PostsController+ (without the +Admin::+ module prefix), you could use
<ruby>
scope "/admin" do
resources :posts, :comments
end
</ruby>
or, for a single case
<ruby>
resources :posts, :path => "/admin"
</ruby>
In each of these cases, the named routes remain the same as if you did not use +scope+. In the last case, the following URLs map to +PostsController+:
|_. Verb |_.URL |_.action |_. helper |
|GET |photos |index | photos_path |
|GET |photos/new |new | photos_path |
|POST |photos |create | photos_path |
|GET |photos/1 |show | photo_path(id) |
|GET |photos/1/edit |edit | edit_photo_path(id) |
|PUT |photos/1 |update | photo_path(id) |
|DELETE |photos/1 |destroy | photo_path(id) |
h4. Nested Resources
It's common to have resources that are logically children of other resources. For example, suppose your application includes these models:
<ruby>
class Magazine < ActiveRecord::Base
has_many :ads
end
class Ad < ActiveRecord::Base
belongs_to :magazine
end
</ruby>
Nested routes allow you to capture this relationship in your routing. In this case, you could include this route declaration:
<ruby>
resources :magazines do
resources :ads
end
</ruby>
In addition to the routes for magazines, this declaration will also route ads to an +AdsController+. The ad URLs require a magazine:
|_.Verb |_.URL |_.action |_.used for|
|GET |/magazines/1/ads |index |display a list of all ads for a specific magazine|
|GET |/magazines/1/ads/new |new |return an HTML form for creating a new ad belonging to a specific magazine|
|POST |/magazines/1/ads |create |create a new ad belonging to a specific magazine|
|GET |/magazines/1/ads/1 |show |display a specific ad belonging to a specific magazine|
|GET |/magazines/1/ads/1/edit |edit |return an HTML form for editing an ad belonging to a specific magazine|
|PUT |/magazines/1/ads/1 |update |update a specific ad belonging to a specific magazine|
|DELETE |/magazines/1/ads/1 |destroy |delete a specific ad belonging to a specific magazine|
This will also create routing helpers such as +magazine_ads_url+ and +edit_magazine_ad_path+. These helpers take an instance of Magazine as the first parameter (+magazine_ads_url(@magazine)+).
h5. Limits to Nesting
You can nest resources within other nested resources if you like. For example:
<ruby>
resources :publishers do
resources :magazines do
resources :photos
end
end
</ruby>
Deeply-nested resources quickly become cumbersome. In this case, for example, the application would recognize URLs such as
<pre>
/publishers/1/magazines/2/photos/3
</pre>
The corresponding route helper would be +publisher_magazine_photo_url+, requiring you to specify objects at all three levels. Indeed, this situation is confusing enough that a popular "article":http://weblog.jamisbuck.org/2007/2/5/nesting-resources by Jamis Buck proposes a rule of thumb for good Rails design:
TIP: _Resources should never be nested more than 1 level deep._
h4. Creating URLs From Objects
In addition to using the routing helpers, Rails can also create URLs from an array of parameters. For example, suppose you have this set of routes:
<ruby>
resources :magazines do
resources :ads
end
</ruby>
When using +magazine_ad_path+, you can pass in instances of +Magazine+ and +Ad+ instead of the numeric IDs.
<erb>
<%= link_to "Ad details", magazine_ad_path(@magazine, @ad) %>
</erb>
You can also use +url_for+ with a set of objects, and Rails will automatically determine which route you want:
<erb>
<%= link_to "Ad details", url_for(@magazine, @ad) %>
</erb>
In this case, Rails will see that +@magazine+ is a +Magazine+ and +@ad+ is an +Ad+ and will therefore use the +magazine_ad_path+ helper. In helpers like +link_to+, you can specify just the object in place of the full +url_for+ call:
<erb>
<%= link_to "Ad details", [@magazine, @ad] %>
</erb>
If you wanted to link to just a magazine, you could leave out the +Array+:
<erb>
<%= link_to "Magazine details", @magazine %>
</erb>
This allows you to treat instances of your models as URLs, and is a key advantage to using the resourceful style.
h4. Adding More RESTful Actions
You are not limited to the seven routes that RESTful routing creates by default. If you like, you may add additional routes that apply to the collection or individual members of the collection.
h5. Adding Member Routes
To add a member route, just add a +member+ block into the resource block:
<ruby>
resources :photos do
member do
get :preview
end
end
</ruby>
This will recognize +/photos/1/preview+ with GET, and route to the +preview+ action of +PhotosController+. It will also create the +preview_photo_url+ and +preview_photo_path+ helpers.
Within the block of member routes, each route name specifies the HTTP verb that it will recognize. You can use +get+, +put+, +post+, or +delete+ here. If you don't have multiple +member+ routes, you can also pass +:on+ to a route, eliminating the block:
<ruby>
resources :photos do
get :preview, :on => :member
end
</ruby>
h5. Adding Collection Routes
To add a route to the collection:
<ruby>
resources :photos do
collection do
get :search
end
end
</ruby>
This will enable Rails to recognize URLs such as +/photos/search+ with GET, and route to the +search+ action of +PhotosController+. It will also create the +search_photos_url+ and +search_photos_path+ route helpers.
Just as with member routes, you can pass +:on+ to a route:
<ruby>
resources :photos do
get :search, :on => :collection
end
</ruby>
h5. A Note of Caution
If you find yourself adding many extra actions to a resourceful route, it's time to stop and ask yourself whether you're disguising the presence of another resource.
h3. Non-Resourceful Routes
In addition to resource routing, Rails has powerful support for routing arbitrary URLs to actions. Here, you don't get groups of routes automatically generated by resourceful routing. Instead, you set up each route within your application separately.
While you should usually use resourceful routing, there are still many places where the simpler routing is more appropriate. There's no need to try to shoehorn every last piece of your application into a resourceful framework if that's not a good fit.
In particular, simple routing makes it very easy to map legacy URLs to new Rails actions.
h4. Bound Parameters
When you set up a regular route, you supply a series of symbols that Rails maps to parts of an incoming HTTP request. Two of these symbols are special: +:controller+ maps to the name of a controller in your application, and +:action+ maps to the name of an action within that controller. For example, consider one of the default Rails routes:
<ruby>
match ':controller(/:action(/:id))'
</ruby>
If an incoming request of +/photos/show/1+ is processed by this route (because it hasn't matched any previous route in the file), then the result will be to invoke the +show+ action of the +PhotosController+, and to make the final parameter +"1"+ available as +params[:id]+. This route will also route the incoming request of +/photos+ to +PhotosController+, since +:action+ and +:id+ are optional parameters, denoted by parentheses.
h4. Dynamic Segments
You can set up as many dynamic segments within a regular route as you like. Anything other than +:controller+ or +:action+ will be available to the action as part of +params+. If you set up this route:
<ruby>
match ':controller/:action/:id/:user_id'
</ruby>
An incoming URL of +/photos/show/1/2+ will be dispatched to the +show+ action of the +PhotosController+. +params[:id]+ will be +"1"+, and +params[:user_id]+ will be +"2"+.
h4. Static Segments
You can specify static segments when creating a route:
<ruby>
match ':controller/:action/:id/with_user/:user_id'
</ruby>
This route would respond to URLs such as +/photos/show/1/with_user/2+. In this case, +params+ would be <tt>{ :controller => "photos", :action => "show", :id => "1", :user_id => "2" }</tt>.
h4. The Query String
The +params+ will also include any parameters from the query string. For example, with this route:
<ruby>
match ':controller/:action/:id'
</ruby>
An incoming URL of +/photos/show/1?user_id=2+ will be dispatched to the +show+ action of the +Photos+ controller. +params+ will be <tt>{ :controller => "photos", :action => "show", :id => "1", :user_id => "2" }</tt>.
h4. Defining Defaults
You do not need to explicitly use the +:controller+ and +:action+ symbols within a route. You can supply them as defaults:
<ruby>
match 'photos/:id' => 'photos#show'
</ruby>
With this route, Rails will match an incoming URL of +/photos/12+ to the +show+ action of +PhotosController+.
You can also define other defaults in a route by supplying a hash for the +:defaults+ option. This even applies to parameters that you do not specify as dynamic segments. For example:
<ruby>
match 'photos/:id' => 'photos#show', :defaults => { :format => 'jpg' }
</ruby>
Rails would match +photos/12+ to the +show+ action of +PhotosController+, and set +params[:format]+ to +"jpg"+.
h4. Naming Routes
You can specify a name for any route using the +:as+ option.
<ruby>
match 'exit' => 'sessions#destroy', :as => :logout
</ruby>
This will create +logout_path+ and +logout_url+ as named helpers in your application. Calling +logout_path+ will return +/logout+
h4. Segment Constraints
You can use the +:constraints+ option to enforce a format for a dynamic segment:
<ruby>
match 'photo/:id' => 'photos#show', :constraints => { :id => /[A-Z]\d{5}/ }
</ruby>
This route would match URLs such as +/photo/A12345+. You can more succinctly express the same route this way:
<ruby>
match 'photo/:id' => 'photos#show', :id => /[A-Z]\d{5}/
</ruby>
+:constraints+ takes regular expression. However note that regexp anchors can't be used within constraints. For example following route will not work:
<ruby>
match '/:id' => 'videos#show', :constraints => {:id => /^\d/}
</ruby>
h4. Request-Based Constraints
You can also constrain a route based on any method on the <a href="action_controller_overview.html#the-request-object">Request</a> object that returns a +String+.
You specify a request-based constraint the same way that you specify a segment constraint:
<ruby>
match "photo", :constraints => {:subdomain => "admin"}
</ruby>
You can also specify constrains in a block form:
<ruby>
namespace "admin" do
constraints :subdomain => "admin" do
resources :photos
end
end
</ruby>
h4. Advanced Constraints
If you have a more advanced constraint, you can provide an object that responds to +matches?+ that Rails should use. Let's say you wanted to route all users on a blacklist to the +BlacklistController+. You could do:
<ruby>
class BlacklistConstraint
def initialize
@ips = Blacklist.retrieve_ips
end
def matches?(request)
@ips.include?(request.remote_ip)
end
end
TwitterClone::Application.routes.draw do
match "*path" => "blacklist#index",
:constraints => BlacklistConstraint.new
end
</ruby>
h4. Route Globbing
Route globbing is a way to specify that a particular parameter should be matched to all the remaining parts of a route. For example
<ruby>
match 'photo/*other' => 'photos#unknown'
</ruby>
This route would match +photo/12+ or +/photo/long/path/to/12+, setting +params[:other]+ to +"12"+ or +"long/path/to/12"+.
h4. Redirection
You can redirect any path to another path using the +redirect+ helper in your router:
<ruby>
match "/stories" => redirect("/posts")
</ruby>
You can also reuse dynamic segments from the match in the path to redirect to:
<ruby>
match "/stories/:name" => redirect("/posts/%{name}")
</ruby>
You can also provide a block to redirect, which receives the params and (optionally) the request object:
<ruby>
match "/stories/:name" => redirect {|params| "/posts/#{params[:name].pluralize}" }
match "/stories" => redirect {|p, req| "/posts/#{req.subdomain}" }
</ruby>
In all of these cases, if you don't provide the leading host (+http://www.example.com+), Rails will take those details from the current request.
h4. Routing to Rack Applications
Instead of a String, like +"posts#index"+, which corresponds to the +index+ action in the +PostsController+, you can specify any <a href="rails_on_rack.html">Rack application</a> as the endpoint for a matcher.
<ruby>
match "/application.js" => Sprockets
</ruby>
As long as +Sprockets+ responds to +call+ and returns a <tt>[status, headers, body]</tt>, the router won't know the difference between the Rack application and an action.
NOTE: For the curious, +"posts#index"+ actually expands out to +PostsController.action(:index)+, which returns a valid Rack application.
h4. Using +root+
You can specify what Rails should route +"/"+ to with the +root+ method:
<ruby>
root :to => 'pages#main'
</ruby>
You should put the +root+ route at the end of the file.
h3. Customizing Resourceful Routes
While the default routes and helpers generated by +resources :posts+ will usually serve you well, you may want to customize them in some way. Rails allows you to customize virtually any generic part of the resourceful helpers.
h4. Specifying a Controller to Use
The +:controller+ option lets you explicitly specify a controller to use for the resource. For example:
<ruby>
resources :photos, :controller => "images"
</ruby>
will recognize incoming URLs beginning with +/photo+ but route to the +Images+ controller:
|_. Verb |_.URL |_.action |
|GET |/photos |index |
|GET |/photos/new |new |
|POST |/photos |create |
|GET |/photos/1 |show |
|GET |/photos/1/edit |edit |
|PUT |/photos/1 |update |
|DELETE |/photos/1 |destroy |
NOTE: Use +photos_path+, +new_photos_path+, etc. to generate URLs for this resource.
h4. Specifying Constraints
You can use the +:constraints+ option to specify a required format on the implicit +id+. For example:
<ruby>
resources :photos, :constraints => {:id => /[A-Z][A-Z][0-9]+/}
</ruby>
This declaration constrains the +:id+ parameter to match the supplied regular expression. So, in this case, the router would no longer match +/photos/1+ to this route. Instead, +/photos/RR27+ would match.
You can specify a single constraint to apply to a number of routes by using the block form:
<ruby>
constraints(:id => /[A-Z][A-Z][0-9]+/) do
resources :photos
resources :accounts
end
</ruby>
NOTE: Of course, you can use the more advanced constraints available in non-resourceful routes in this context
h4. Overriding the Named Helpers
The +:as+ option lets you override the normal naming for the named route helpers. For example:
<ruby>
resources :photos, :as => "images"
</ruby>
will recognize incoming URLs beginning with +/photos+ and route the requests to +PhotosController+:
|_.HTTP verb|_.URL |_.action |_.named helper |
|GET |/photos |index | images_path |
|GET |/photos/new |new | new_image_path |
|POST |/photos |create | images_path |
|GET |/photos/1 |show | image_path |
|GET |/photos/1/edit |edit | edit_image_path |
|PUT |/photos/1 |update | image_path |
|DELETE |/photos/1 |destroy | image_path |
h4. Overriding the +new+ and +edit+ Segments
The +:path_names+ option lets you override the automatically-generated "new" and "edit" segments in URLs:
<ruby>
resources :photos, :path_names => { :new => 'make', :edit => 'change' }
</ruby>
This would cause the routing to recognize URLs such as
<plain>
/photos/make
/photos/1/change
</plain>
NOTE: The actual action names aren't changed by this option. The two URLs shown would still route to the new and edit actions.
TIP: If you find yourself wanting to change this option uniformly for all of your routes, you can use a scope:
<ruby>
scope :path_names => { :new => "make" } do
# rest of your routes
end
</ruby>
h4. Overriding the Named Helper Prefix
You can use the :name_prefix option to add a prefix to the named route helpers that Rails generates for a route. You can use this option to prevent collisions between routes using a path scope.
<ruby>
scope "admin" do
resources :photos, :name_prefix => "admin"
end
resources :photos
</ruby>
This will provide route helpers such as +admin_photos_path+, +new_admin_photo_path+ etc.
You could specify a name prefix to use for a group of routes in the scope:
<ruby>
scope "admin", :name_prefix => "admin" do
resources :photos, :accounts
end
resources :photos, :accounts
</ruby>
NOTE: The +namespace+ scope will automatically add a +:name_prefix+ as well as +:module+ and +:path+ prefixes.
h4. Restricting the Routes Created
By default, Rails creates routes for all seven of the default actions (index, show, new, create, edit, update, and destroy) for every RESTful route in your application. You can use the +:only+ and +:except+ options to fine-tune this behavior. The +:only+ option tells Rails to create only the specified routes:
<ruby>
resources :photos, :only => [:index, :show]
</ruby>
Now, a +GET+ request to +/photos+ would succeed, but a +POST+ request to +/photos+ (which would ordinarily be routed to the +create+ action) will fail.
The +:except+ option specifies a route or list of routes that Rails should _not_ create:
<ruby>
resources :photos, :except => :destroy
</ruby>
In this case, Rails will create all of the normal routes except the route for +destroy+ (a +DELETE+ request to +/photos/:id+).
TIP: If your application has many RESTful routes, using +:only+ and +:except+ to generate only the routes that you actually need can cut down on memory use and speed up the routing process.
h4. Translated Paths
Using +scope+, we can alter path names generated by resources:
<ruby>
scope(:path_names => { :new => "neu", :edit => "bearbeiten" }) do
resources :categories, :path => "kategorien"
end
</ruby>
Rails now creates routes to the +CategoriesControlleR+.
|_.HTTP verb|_.URL |_.action |
|GET |/kategorien |index |
|GET |/kategorien/neu |new |
|POST |/kategorien |create |
|GET |/kategorien/1 |show |
|GET |/kategorien/:id/bearbeiten |edit |
|PUT |/kategorien/1 |update |
|DELETE |/kategorien/1 |destroy |
h4. Overriding the Singular Form
If you want to customize the singular name of the route in the named helpers, you can use the +:singular+ option.
<ruby>
resources :teeth, :singular => "tooth"
</ruby>
TIP: If you want to define the singular form of a word for your entire application, you should add additional rules to the +Inflector+ instead.
h4(#nested-name-prefix). Using +:name_prefix+ in Nested Resources
The +:name_prefix+ option overrides the automatically-generated prefix for the parent resource in nested route helpers. For example,
<ruby>
resources :magazines do
resources :ads, :name_prefix => 'periodical'
end
</ruby>
This will create routing helpers such as +magazine_periodical_ads_url+ and +edit_magazine_periodical_ad_path+.
h3. Inspecting and Testing Routes
Rails offers facilities for inspecting and testing your routes.
h4. Seeing Existing Routes with +rake+
If you want a complete list of all of the available routes in your application, run +rake routes+ command. This will print all of your routes, in the same order that they appear in +routes.rb+. For each route, you'll see:
* The route name (if any)
* The HTTP verb used (if the route doesn't respond to all verbs)
* The URL pattern to match
* The routing parameters for the route
For example, here's a small section of the +rake routes+ output for a RESTful route:
<pre>
users GET /users {:controller=>"users", :action=>"index"}
formatted_users GET /users.:format {:controller=>"users", :action=>"index"}
POST /users {:controller=>"users", :action=>"create"}
POST /users.:format {:controller=>"users", :action=>"create"}
</pre>
TIP: You'll find that the output from +rake routes+ is much more readable if you widen your terminal window until the output lines don't wrap.
h4. Testing Routes
Routes should be included in your testing strategy (just like the rest of your application). Rails offers three "built-in assertions":http://api.rubyonrails.org/classes/ActionController/Assertions/RoutingAssertions.html designed to make testing routes simpler:
* +assert_generates+
* +assert_recognizes+
* +assert_routing+
h5. The +assert_generates+ Assertion
Use +assert_generates+ to assert that a particular set of options generate a particular path. You can use this with default routes or custom routes
<ruby>
assert_generates "/photos/1", { :controller => "photos", :action => "show", :id => "1" }
assert_generates "/about", :controller => "pages", :action => "about"
</ruby>
h5. The +assert_recognizes+ Assertion
The +assert_recognizes+ assertion is the inverse of +assert_generates+. It asserts that Rails recognizes the given path and routes it to a particular spot in your application.
<ruby>
assert_recognizes({ :controller => "photos", :action => "show", :id => "1" }, "/photos/1")
</ruby>
You can supply a +:method+ argument to specify the HTTP verb:
<ruby>
assert_recognizes({ :controller => "photos", :action => "create" }, { :path => "photos", :method => :post })
</ruby>
You can also use the resourceful helpers to test recognition of a RESTful route:
<ruby>
assert_recognizes new_photo_url, { :path => "photos", :method => :post }
</ruby>
h5. The +assert_routing+ Assertion
The +assert_routing+ assertion checks the route both ways: it tests that the path generates the options, and that the options generate the path. Thus, it combines the functions of +assert_generates+ and +assert_recognizes+.
<ruby>
assert_routing({ :path => "photos", :method => :post }, { :controller => "photos", :action => "create" })
</ruby>
h3. Changelog
"Lighthouse ticket":http://rails.lighthouseapp.com/projects/16213-rails-guides/tickets/3
* April 10, 2010: Updated guide to remove outdated and superfluous information, and to provide information about new features, by "Yehuda Katz":http://www.yehudakatz.com
* April 2, 2010: Updated guide to match new Routing DSL in Rails 3, by "Rizwan Reza":http://www.rizwanreza.com/
* Febuary 1, 2010: Modifies the routing documentation to match new routing DSL in Rails 3, by Prem Sichanugrist
* October 4, 2008: Added additional detail on specifying verbs for resource member/collection routes, by "Mike Gunderloy":credits.html#mgunderloy
* September 23, 2008: Added section on namespaced controllers and routing, by "Mike Gunderloy":credits.html#mgunderloy
* September 10, 2008: initial version by "Mike Gunderloy":credits.html#mgunderloy
|