#79
Nov 11, 2007

Generate Named Routes

This more advanced episode will show you how to dynamically generate named routes by adding a method to the map object.
Tags: routing
Download (9.2 MB, 5:59)
alternative download for iPod & Apple TV (7.4 MB, 5:59)

Update: there’s now a plugin which does this called static_actions.

Resources

# routes.rb
ActionController::Routing::Routes.draw do |map|
  def map.controller_actions(controller, actions)
    actions.each do |action|
      self.send("#{controller}_#{action}", "#{controller}/#{action}", :controller => controller, :action => action)
    end
  end
  
  map.resources :products, :categories
  
  map.controller_actions 'about', %w[company privacy license]
end

RSS Feed for Episode Comments 36 comments

1. Brian Mitchell Nov 12, 2007 at 01:29

While I generally do use simple methods like you defined above on map, I will sometimes take a different approach for those types of urls.

I generally start applications by removing the :c/:a/:id style routes and add a "site" controller for general site topics. The routes file might look like this at first:

map.site ':action', :controller => 'site'

This works well enough since it can be used pretty cleanly:

site_path('jobs') #=> /jobs

There are some pros and cons here. One is that the actions can be added easily, which is a good thing in initial development... but if you like to strictly protect interfaces exposed on the web, then you can add some constraints on action:

map.site ':action', :controller => 'site', :action => /(jobs|sitemap|about)/

That regular expression will ensure only certain actions can get called ( the ()'s are required to correctly match given the |'s -- in 1.2 at least).

Finally, I should note that it is rather easy to add a formatted route as well:

# here is where things like with_options help a little.
map.site ':action', :controller => 'site'
map.site ':action.:format', :controller => 'site'

site_path('jobs') #=> /jobs
site_path('sitemap', 'xml') #=> /sitemap.xml

This might come in handy if you have several types of clients connecting to your service.

Of course, there are probably places where the overhead of these slightly more dynamic routes might be harmful.


2. Brian Nov 12, 2007 at 11:57

The one problem I keep having with routing is when you don't want the controller name in the route. For example, if you're doing a location based app, /texas/dallas/ is a lot more natural than /states/texas/cities/dallas. I do keep running in to a problem where two objects have the same scope, but you want to redirect to one if not found. i.e. /united-states/texas vs. /germany/munich. The way I've done this is ugly, but it works...kinda. Any suggestions would be helpful. I think there's a lot of voodoo with routing to most people.


3. Henrik N Nov 13, 2007 at 00:31

Brian: If worst comes to worst, you can have a catch-all route and do logic in a controller: http://railscasts.com/episodes/46

A very interesting, but pretty ugly/hackish way to use more powerful logic in your routes is http://www.ruby-forum.com/topic/42505.


4. lester bangs Nov 14, 2007 at 17:23

did you say "dick around" near the end there? ryan, i'm shocked! :)


5. James Nov 16, 2007 at 21:17

@lester - He said "dig around"! He has referred to "digging" in the past, so I am sure he is not a potty mouth. You have got your mind in the gutter! ;)


6. andré camargo Nov 16, 2007 at 23:40

Ryan, many thanks for every single episode. It's fantastic how you show the world of ruby, rails and the whole thing interact together. :-)

Keep your good work, thanks again!


7. Paul Barry Nov 19, 2007 at 06:32

It seems to me that this is meta just for the sake of being meta. Maybe that's just something you wanted to show in the screencast, but this seems like a cleaner way to do it:

%w{company privacy license}.each do |a|
  map.send "about_#{a}", "about/#{a}", :controller => 'about', :action => a
end


8. Ryan Bates Nov 20, 2007 at 10:20

@Paul, I agree this is an over-refactoring. It works best if you have quite a few of these kinds of actions in multiple controllers. That scenario was too complex for a simple screencast so I stuck with one controller.

In this case it's more about the technique then the circumstances to use it (which varies from project to project). I should have made that more clear.

@lester, LOL. I said "dig" around. I'll blame it on the cold I'm getting.


9. Drew Dec 06, 2007 at 12:43

Why create a method on map when you could simply send the actions to the map object?

def controller_paths(controller,*actions)
  actions.each do |a|
    map.send(#{controller}_#{a},#{controller/a},:controller => controller, :action => a)
  end
end

controller_paths :about, :company, :privacy, :liscense


10. Adrian Dec 11, 2007 at 01:19

A general question about routes:
Is there a naming convention between the route and the model relations?

model:
has_many usercomment
has_many usercomments, :through => usercomment

route:
map.resources :users do |users|
  users.resources :usercomments
end

Would this one work?


11. Sukhwinder Singh Tambar Sep 30, 2008 at 01:21

Really usefull cast...


12. kailas Feb 25, 2009 at 04:55

i'm trying to setup a route that's something like

map.connect ":foo/:controller/:action/:id", so i get :foo as a parameter.

that statement doesn't work in my routes.rb, but i'm a little confused about how to do it if it's possible at all (all the examples i've seen are of the form "controller"/"action"/[extra stuff]

any advice/suggestions would be greatly appreciated!

thanks!


13. Convert Database Sep 15, 2009 at 05:36

Non-destructive data base conversion tool is designed for converting source database records to destination database records.


14. group sms Sep 21, 2009 at 21:42

Offer pocket PC to mobile messaging software that is reliable solution to deliver text sms over all national or international mobile networks.


15. mobile forensics Sep 22, 2009 at 00:44

Recover sim card software restores recovered data and text messages in original form at user specified memory location.


16. generate barcode Sep 28, 2009 at 21:18

Barcode decoding software is easy to use program for both technical and non technical users


17. spy software Nov 01, 2009 at 21:28

Keylogger tool provides one of the easiest and secured ways to monitor keystroke activities in home or office in your absence.


18. discount gucci shoes Nov 13, 2009 at 20:19

The collection also includes styles that are suitale for business meetiings and everyday wear.Many of these styles are designed with leather and suede and can make quite an impression at the workplace.It is possible to find Gucci shoes discounted to make them more affordable if you take the time to search for some of these exclusive design.


19. data tool Nov 19, 2009 at 22:56

Offering sim card data recovery application recovers and restores ICC-ID identification number.


20. recover memory stick Nov 20, 2009 at 01:33

Ddiit.com provides excellent data recovery softwares at very low cost for all brands of memory cards.


21. Recovery Software Nov 23, 2009 at 02:52

Maker of FAT data recovery software retrieves deleted data from damaged FAT, VFAT, FAT12 files.


22. recovery partition Nov 25, 2009 at 02:51

Windows partition restores utility can recover lost and deleted audio, video and office documents files and folders without any hassle at user specific location.


23. purchase orders Dec 02, 2009 at 04:23

Developers of purchase order software that helps to manage entire billing reports in easily customizable format.


24. USB recovery Dec 03, 2009 at 20:54

Makers of usb drive file rescue application facilitate user to undelete files if Drive not formatted message is displayed by desktop.


25. laptop recovery Dec 03, 2009 at 21:43

Laptop hard disk recovery tool provides data backup from portable storage media like pen drive, memory card, thumb drive etc.


26. mobile messages Dec 11, 2009 at 21:44

Group text messaging software can generate and send job alerts, season greetings, contacting employees from PC to all mobile networks.


27. Recovery Software Jan 07, 2010 at 01:47

USB drive lost data recovery software restores lost or corrupted data files and folders from logically bad crashed memory stick, USB, thumb drive, pen drive, dongle, external USB, hard disk Drive or other USB removable disk drive.


28. file recovery free download Jan 18, 2010 at 20:25

Data recovery full download identify the contents of such lost files on the hard drive and allows you to recover them and If a file has been partially overwritten, File Recover attempts to reconstruct as much of the file as possible with the remaining contents.


29. file recovery free download Jan 18, 2010 at 21:02

Data recovery full download identify the contents of such lost files on the hard drive and allows you to recover them and If a file has been partially overwritten, File Recover attempts to reconstruct as much of the file as possible with the remaining contents.


30. data recovery tools download Jan 19, 2010 at 01:32

Data Recovery software free download is used to restore all lost data and it is designed to recover all the deleted files and folders at free of cost.


31. buy viagra Jan 21, 2010 at 11:53

nice and excellent information about Generate Named Routes


32. software documentation Jan 28, 2010 at 02:52

Provide software to enter image descriptions and support all picture file formats.


33. File recovery free Jan 29, 2010 at 23:25

To restore your absent mp3 files from your Zune music players download free file recovery software from filerecovery.in


34. data undelete Feb 01, 2010 at 01:09

Provides best efficient digital undelete data recovery software that retrieves deleted or corrupted pictures and images from memory card on camera.


35. File Recovery Feb 03, 2010 at 23:30

USB drive file undelete software provides easy recovery of data from all removable media device also popular as flash drive, thumb drive, key drive, jump drive and Jet flash drive.


36. Invoice software Feb 08, 2010 at 22:19

Providing inventory management application keep track on entire business process and make it smooth.

Add your comment:

(SKIP THIS ONE)

(required)

(not shown)


(use pastie or gist for code)

sponsored by:
if you want to help:
required:
Get Quicktime Player
Give Back to Open Source