#63
Jul 27, 2007

Model Name in URL

By default, Rails uses the model's id in the URL. What if you want to use the name of the model instead? You can change this behavior by overriding the to_param method in the model. Watch this episode for details.
Download (10.8 MB, 6:07)
alternative download for iPod & Apple TV (7.9 MB, 6:07)
# product.rb
def to_param
  "#{id}-#{permalink}"
end

# controller
@product = Product.find(params[:id])

or

# product.rb
def to_param
  permalink
end

# controller
@product = Product.find_by_permalink(params[:id])

RSS Feed for Episode Comments 49 comments

1. chineseGuy Jul 27, 2007 at 00:34

nice!~


2. seb Jul 27, 2007 at 00:36

It will be great to use a before_filter fo @product = Product.find(params[:id]) to avoid duplicated lines.

Your screencast is a good example to show interest of using before_filter because you need to modify find to find_by_permalink in a bunch of actions instead of modifing one before_filter.

I don't know why rails generator do not generate this before_filter. (even in the views, it does not generate a _form partial but duplicates it in new and edit rhtml file) May be an idea for a new screencast if it's not already done :)

Thanks for this video!!


3. Skyblaze Jul 27, 2007 at 00:49

I didn't seen this screencast yet but anyway can't we change the "id" behaviour acting on routes.rb? It is only a route issue if the last part of the url goes in params[:id] we can change that by adding a new custom route.


4. Jimmie Jul 27, 2007 at 01:12

Nice!


5. bitbutter Jul 27, 2007 at 03:17

Just recently I made a plugin to do exactly this: http://www.bitbutter.com/seo_urls-plugin-making-show-pages-more-findable/14


6. Rich Jul 27, 2007 at 06:25

Does Rails automatically populate the permalink field? Most permalink implementations I've seen ask you to prepopulate the permalink column.


7. Rob Jul 27, 2007 at 07:20

Rich - you can use Rick Olson's permalink_fu plugin to automatically create permalinks for you. You'll want to use PermalinkFu.escape(...) in a before_save however instead of the automatic "has_permalink" as the latter doesn't update the permalink when you edit a model.


8. Ryan Bates Jul 27, 2007 at 08:38

@seb, good call. A before filter would work really well here, I should have mentioned it.

@Skyblaze, yes, you can add a custom route to do this as well. I don't know of an easy way to do this when using map.resources however.


9. Robert Evans Jul 27, 2007 at 10:04

I've writen a permalink plugin that extends String to allow permalizing of just about any type of string, including unicode.

http://svn.robertrevans.com/plugins/Permalize/
http://robertrevans.com/article/permalize-fun


10. Nicolás Sanguinetti Jul 27, 2007 at 19:48

Well, another approach would be to override the find method with something like:

@class Product
  def find(*args)
    return find_by_permalink(*args) if !args.first =~ /^\d+$/
    super
  end
end@

Or something similar, but You'd need to validate your product permalinks to not be all numbers, or else things can get messy. Still, could solve problems when you are adding this to an already existing app.

If you are doing this for a new app, then there shouldn't be much to worry about.

Oh, and of course, nothing beats having good tests to make sure no find method goes wild ;)


11. Oskar Lissheim-Boethius Jul 28, 2007 at 10:56

Great stuff, Ryan. It's really humbling the service you're doing to our community.

More, more, more RESTful stuff, please. This is the future.


12. Alek Jul 28, 2007 at 15:29

Hi Ryan:
Thanks for wonderful work that you are doing in the Rails community. I am just getting aquatinted with Rails and Ruby in general, and have completely gone nuts over the fact that it's wonderful to code in Rails and fun too! I think I am become a Rails addict!

I have been watching some of the most wonderful pod-cast on iTunes by you and have equally become and addict their too:-).

I have a question with regard to generating a view in which multiple controllers can be called into it. Instead of having only one model being displayed in the view, can I have multiple models, through one of the controllers, in one view? I am talking about the way one can generate a query in the database that then become another table. I am not sure if I am making sense, but very very much appreciate your response and a take on this.

Thanks so much,
Alek


13. Carl Jul 28, 2007 at 18:51

I had to do something like this for an admin page where people could see what employees had worked on on a specific day, but I needed to be able to use either an id number or username (it's an internal website for logging people's work), so I had the controller do a regex on the param. If it was all digits, then it must be an id, of it's not it must be a username. Of course I only had one controller I had to do that in, so it would probably not be a good idea in other areas.


14. Josh Peek Jul 29, 2007 at 07:15

Yet another plugin.

http://svn.joshpeek.com/projects/plugins/pseudo_primary_key


15. Josh Peek Jul 29, 2007 at 07:19

@seb

See Dan Manges post on Taking DRY Too Far

http://www.dcmanges.com/blog/36


16. Ryan Bates Jul 29, 2007 at 22:20

@Alek, I'm not entirely sure what you're asking. A controller can fetch as many models as it needs in one action/view. However, if you want to apply the technique showed in this episode, you will need a name to use in the URL. In that case the focus will be on one model, not on multiple models.


17. Alek Jul 31, 2007 at 10:26

Ryan:

Thanks very much for responding to my question. I am sorry that my question sounded somewhat confusing.

Here is what I really had in mind from the question I posed. Just as you would create queries within database, by merging tables into one entity, can you do the same in Rails?

Thanks Ryan,

Alek


18. Ryan Bates Jul 31, 2007 at 13:35

You can use the ":include" option in the find method to include multiple tables/models in one query.

If you're trying to make one model span multiple tables then I don't think that's possible without serious hacking.


19. Ismael Jul 31, 2007 at 15:30

Yet another permalink plugin!
This one raises RecordNotFound in case given permalink doesn't exist, so you can use it like #find and catch not found errors in rescue_action_in_public

http://code.estadobeta.com/plugins/sluggable_finder/README


20. Alek Aug 01, 2007 at 12:15

Thanks Ryan! Your info helps a lot. As for having one model spanning multiple tables, it is something I will not commit, even though it can be done, just because of "serious hacking" as you say. The :include option sounds perfect, however! Thanks again.


21. David Madden Sep 01, 2007 at 12:19

Thanks, a very simple solution.


22. Henrik N Oct 04, 2007 at 13:44

Note that you DON'T want to use "_" as the separator between the id and the permalink, if you rely on String#to_i. The screencast uses "-" which is fine.

If you use "_" and the permalink part begins with a number, you could get e.g. "123_456blah", and "123_456blah".to_i is 123456, not the expected 123. This is because "_" can be used in Ruby to make numbers more readable.


23. Mo Rashed Oct 27, 2007 at 09:47

Found this on the net:

You don't have to make a new field in your table, yu could just use this instead:

def to_param
    "#{id}-#{name.gsub(/[^a-z1-9]+/i, '-')}"
end

replace name with the field you want to slug/permalink.

What do you think Ryan?


24. Jaffet Nov 24, 2007 at 05:01

Im confused a little bit. I created new column in my db called permalink. Then i did like in the video, but my urls are /5-
no permalink string. I know the problem, i dont have anything in permalink. Is this permalink generated automatically from somewhere? Or do i have to do it manually, when i create new ex. article?


25. jaffet Dec 14, 2007 at 04:20

It works. But does this work with paginate plugin as well?


26. Stefano Dec 15, 2007 at 17:19

This has to be my favourite till now!
Thank you so much i really didn't know how to accomplish that (it is my first rails (and web development in general) project!)


27. Bala Dec 24, 2007 at 15:05

Mo Rashed: Thanks for the tip! I actually have :

  def to_param
    "#{id}-#{title.gsub(/[^a-z1-9]+/i, '-')}.html"
  end

Having .html makes it more search engine friendly.


28. cover Dec 26, 2007 at 13:55

Very cool, i think i've to change a lot of stuff. i've done a really bad thing (the permalink contains all the id-permalink stuff, and then i changed the routes.rb to use it instead of the id... a really bad thing :) )


29. steph Apr 06, 2008 at 11:07

great stuff...

now how would I format this route:

/users/156/items/6547

like this:

/john/items/6547


30. Tony Carrera May 16, 2008 at 10:46

This tutorial just saved me even MORE time. I was missing the def to_param in the user model. I was about to start messing with the routes, thankfully this is a much cleaner way to get this done.

Some of these things should be easier done. Oh well. Thank you!


31. scootertuning Oct 15, 2008 at 17:45

Thanks for this video :-)
Really nice and simple solution.


32. Gary Paulsen Jan 13, 2009 at 18:47

Perfect! Thanks for the information and tips! Hope to see more of your posts! Again Thanks!


33. Eric Mar 20, 2009 at 21:10

I thought for sure a permalink set as "1-epson-abcd-1234" would fail, but sure enough, to_i still converts it to 1.

I must admit I'm not entirely certain why or how, but it does. I will have to look into this.


34. Ryan Sandridge Aug 02, 2009 at 14:59

Any suggestions on how to allow permalink's with periods (".") in them? Assuming product is routed using "map.resources :products", then anything after a period will be treated as a format.


35. Wealthy Women Debts Dec 03, 2009 at 17:07

Its very intresting and Informative stuff. Women finds it difficult to manage their cost, save $1 a day and you can see the difference it makes


36. Michelle Boudreau Debt Dec 04, 2009 at 17:08

I like your post. No matter what amount of debt a person has, willingness to retire is the first step


37. Debt Rescue Dec 07, 2009 at 08:34

It’s really amazing. Debt can be rescued by reducing expenses not by increase income


38. Tax Lines Dec 10, 2009 at 10:45

Foreclosure properties are in high demand as the lenders are in troble and there are many tax foreclosure properties available


39. Tax Foreclosed Sales Dec 11, 2009 at 11:30

Very Informative blog. This is true, in real estate investment foreclosure properties under tax lien is big investment


40. John BeckTax Sales Dec 12, 2009 at 11:34

Getting to know about the real estate investment starts with an understanding to worth of house / average worth of neighbours


41. Nicolás Hock Dec 17, 2009 at 04:41

I have a small question. I've defined the "to_param" method but when I acess to /projects/1 (typing the URL) it doesn't change to /projects/1-name.

Here at railscasts it does changes the /episodes/63 to /episodes/63-name... how do you get that?


42. Free and Clear System Dec 18, 2009 at 11:50

Nice post. The profit gain from real estate is enormous but on other side those who really wants to buy a house gets hurt


43. Conciant Dec 19, 2009 at 15:12

I like your post, it's a really good stuff, keep it up! Office Conceirge has another benefit that it is economic too


44. SEO Web Analytics Dec 20, 2009 at 11:24

Its really intresting reading your post. Another aspect of generic marketing is that the results are shown at different places with google or yahoo api is used for search results


46. TripleThreat Dec 27, 2009 at 02:13

LOL @ Settlers of Catan... thats a fun game. You screencasts are invaluable!


47. Ben Holland Jan 03, 2010 at 19:08

Thank you! Once again you have saved my project from failure! I've learned 90% of my knowledge about rails from watching your screencasts. Please don't stop :)


48. ourshoesbox Jan 23, 2010 at 02:20

www.ourshoesbox.com


49. buy lumigan online Feb 05, 2010 at 18:22

buy lumigan online

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