9 Essential Rails Tips
posted by gchatz 143 commentsIn this article:
Rails is a framework about conventions. It generates a basic structure which you mold into your dream application.
Over the course of the years, we have gathered some basic, rails specific, hints and tips you might want to check before going live. They are split into sections to make it easier to scan them, and pick the ones you haven’t indulged (yet) in. Read on, have fun, and comment a lot…
ActiveRecord
ActiveRecord’s (AR) magic can be somewhat exciting for the newcomer. But there are some pitfalls to consider:
Don’t forget to :select
AR is RoR’s backbone. If you for example wanted to render all users whose username begins with the letter ‘A’ you would do:
@users = User.find(:all,
:conditions => ["username like ?", "A%"])
In fact most of the time you don’t actually need what the above command returns. It executes a select * on the user table returning a carload of data, which leads to memory and cpu bloat.
What you usually want to show is a small set of the User model attributes.
Using @ :select => [list of attribute names for your view] @ you’ll reduce database traffic, keep AR happy and slim, and those mongrels to a minimum of your available system memory:
@users = User.find(:all, :select => "username, email, registered_on", :conditions => ["username like ?", "A%"])
h3. Eager Loading? Yes, but…
One of the basic performance tips in every rails book/class/blog is to use :include => AssociationName.
By not using it, the following code:
<% for post in @posts %>
<!-- ........ -->
<%=h post.user.username %> <!-- user association requires one query -->
<% end %>
will result in extra queries one for each loop execution.
Using eager loading, you can avoid excessive queries:
def index
@posts = Post.find(:all, :order => "posted_on desc", :limit => 15, :include => [:user])
end
Now the user table is joined and we are all happy.
Rails is a convention framework and a pretty smart one too. Rails 2.0 added a caching mechanism to cache queries for the same action in case you (of course by devilish mistake) execute the same query more then once. But that’s just a countermeasure, you should make sure that your queries are properly joined.
?here was a but here, wasn’t it? I can hear you screaming that AR is now including all of the users data, even columns you don’t need.
And you probably think that you’ll just have to use :select to avoid it.
ActiveRecord completely ignores the select directive if you use include. Ouch!
There are two ways to work around this issue
- use select_with_include, a plugin that lets you
:selecttogether with:include - use
:join, instead of include
select_with_include
First you have to install the gem
> gem install select_with_include
Then you must require the gem in your environment.rb
require 'select_with_include'
Now, you can use the :select option, remembering to use the table name even if a column name is not ambigious.
def index
@posts = Post.find(:all,
:select => "posts.title, posts.created_on, posts.comments_count, users.username",
:order => "posted_on desc",
:limit => 15,
:include => [:user])
end
Select_with_include doesn’t support table selects (e.g. users.*) and calculated fields. If you want to include all columns of a table, you’ll have to type each and every one of them.
I don’t know if select_with_include has any implications on performance. It’s a syntax parser so that should add some overhead but haven’t found any sources that actually prove it.
Using :joins, instead of :include
AR’s find method provides an option to manually specify join tables, using :joins. In that case AR will not try to create objects for you, it will just append the join directive on the sql output and the :select option will not be ignored. The following code snippets will show you what happens in each case:
@posts = Post.find(:all, :select => "posts.id, posts.title, posts.subject, users.username", :include => :user)
Will generate the following sql command:
SELECT `posts`.`id` AS t0_r0,
`posts`.`title` AS t0_r1,
`posts`.`subject` AS t0_r2,
`posts`.`user_id` AS t0_r3,
...
`users`.`username` AS t1_r1, `users`.
....
LEFT OUTER JOIN `users` ON `users`.id = `posts`.user_id
As you can see, the :select option was ignored by AR. We can use :joins instead:
@posts = Post.find(:all, :select => "posts.id, posts.title, posts.subject, users.username", :joins => "left outer join users on users.id = posts.user_id")
that results to an sql query you can actually read:
SELECT
posts.id,
posts.title,
posts.subject,
users.username
FROM `posts`
LEFT OUTER JOIN users on users.id = posts.user_id
Note that you have to access the user’s attribute from within the post object and not from the association. That means to access the user name you should use @posts.first.username and not @posts.first.user.username. The latter will execute a new query to fetch the result.
In 99% of the cases that kind of hacking is unnecessary. You should identify parts in your application that need optimizing and apply whatever can make your app go faster.
Save without validations
A typical update or create action will end up with the model being saved by calling AR’s object.save. Depending on the validation chain results, save will return true or false and we’ll take the appropriate actions to handle that. Something like this:
def some_action
....
if @post.save
end
When calling save any validations defined in the model are validated in the background (some validations can also mean extra database queries). But what if we are updating the views_count of a blog post? We don’t want to add extra load to the database for no reason.
You can call object.save_with_validation(false) to skip validations when doing trivial updates that require no validations. You can also use AR’s update class if you don’t have the object in scope.
One more thing to consider. In a perfect world , your model instances should always validate. But there are cases where that will not happen. You added a new validation, someone changed something directly in the database, shit happens.
If you are updating a very important attribute (like someone’s purchased credits) avoid calling object.save. You don’t want a user complaining about missing credits he paid for just because his email didn’t have the right format.
Going live
There are some nice little tools in the Rails world which make you wonder how you ever deployed an application without them.
Exception Notifier
First off this nifty little plugin. If you are not using it by now, start using it. It mails you a stack trace for every exception that occurs.
Set it up wisely, use ExceptionNotifier.email_prefix with a unique prefix for every application, and filter those mails in your email client.
Asset packager
Rails as most of the other Web 2.0 frameworks comes bundled with a plethora of js files, most of us really never trim down to the very necessary. In order to minimize traffic for the js files you can use the asset packager.
Asset packager has to rebundle the js files each time you make changes. Make sure you set up a nice rake task to automate this.
Rendering the cool way
Partials and layouts in Rails can make your life easy. Nevertheless, some of the defaults that we are used to when coding the rails way, can cause problems if someone doesn’t pay any attention to them.
Move js to the bottom
It is important to have the process in mind a browser goes through when rendering your page.
First of all the HTML file is downloaded. Then the browser beginns top to bottom, to parse the HTML and execute if necessary extra calls as they are encountered.
We usually include our javascript files at the top of the layout. That means that browsers will try to download the javascript files before even having the DOM in place. As a result the actual content of the application will come delayed just because the browser was occupied opening connections and downloading files that we are not going to use only until after the markup code is fetched.
Moving your javascripts to the bottom will save you some loading time, especially for the newcomer that will not have the files cached.
DNS lookups for js files should be avoided. If the file doesn’t change download it once and serve it from your server.
If you are using rails javascript helpers like autocomplete, which are called before everything is dowloaded, you can still make them work using a simple trick. We’ve blogged about it before, so you can read everyting about it here
Watch your form’s attributes
So you code your form using the form helpers, and then pass the parameters to the newly created or to be updated object and save. Let’s say we have this user object with username, email, and purchased_credits and we’re designing a form for the user to change his email.
<% form_for :user, @user, :url => {:controller => "users", :action => "update_email", :id => @user.id} do |f| -%>
<p>
<label for="user_email">Email: </label> <%= f.text_field :email %>
</p>
<p>
<%= submit_tag "Change" %>
</p>
<% end %>
Then inside the controller we update the user’s mail
def update_email
#all access and db logic handled with before filters
if @user.update_attributes(params[:user])
flash[:notice] = "We did it"
else
flash[:alert] = "Nope. We didn't make it"
end
end
When you are doing bulk updates like User.new(params[:user]) or user.update_attributes(params[:user]) you open the door to anyone updating important attributes that you only have (or should) have access to. In the above example someone can append user[:purchased_credits] = 1000 and make himself a gift.
What’s most important in this case is to always have this pitfall in mind when you are coding forms. The solution may vary depending on your business logic, but there is an elegant way of securing your “for your eyes only” attributes with attr_accessible or attr_protected.
Always secure your model’s important attributes from bulk updates using attr_accessible or @attr_protected* in the model declaration. And write tests about it. Always!
class User << ActiveRecord::Base attr_accessible :username, :email #or attr_protected :purchased_credits #check rails documentation for more info ....... end
There are some more tips, most of them have to do with “application testing” and it wouldn’t be fair to squeeze them in one post. Stay tuned for part 2.
Comments (143)
great tips. in my opionion the best is Exception Notifier. thx!
That's a great post! Good tips! Just saved this for future reference! :D
attr_protected it's a very important thing to remember and many programmers forget about. Exception Notifier and select_with_include are also very important!
Best regards,
Felipe Giotto.
Thanks for this informative blog post. It is much appreciated!
I am looking forward to part 2 as well.
Regards
Willem
Many of these are great tips when performance tuning your application *after* you've finished it... but PLEASE, don't apply it while you're still developing! (I know you mention in a couple of places that these tips aren't needed for 99% of cases, but perhaps you should make it bigger and bolder)
Performance tuning comes *after* development. Any tuning before you can measure real benchmarks with realistic production data is premature optimisation, and is the cause of a lot of spaghetti code (even in Rails).
I wrote an article about this:
http://www.inter-sections.net/2007/11/08/premature-optimisation/
Thanks for the list, nevertheless!
Daniel
Danniel:
I don't think using select, or eager loading is premature optimization.
Long before ORM's existed, we wrote sql queries by hand and I don't think that anyone would write a join-less query to avoid premature optimization.
As for include_with_select, you may be right that this is an advanced method you may never have to use.
These are some great tips, thanks.
Since I am working on a relatively new application, I am constantly adding/removing columns to my apps tables.
One of the cool features in Rails 2.0 is that you can have an add/remove columns migration generated for you just by following the proper naming convention for the migration.
If you wanted a migration to add a 'title' column to your users table, you would do the following :
script/generate migration AddTitleToUsers title:string
The migration name is important; the table that receives the new column is designated by the text that follows 'To' and the added column is specified after the title of the migration. If you follow the convention, the proper add_column statements will automatically be inserted into the newly created migration.
I wrote a more detailed blog about this feature here :
http://www.runfatboy.net/blog/2008/03/01/rails-migrations-command-line-power-in-20/
Thanks your tip on :joins!
I was looking at the difference between running time of 2.5 seconds using and AR :include and 0.04 seconds running the same SQL through a DB admin tool. I guessed that it was probably something to do will instantiating lots of silly little objects (instead of has_and_belongs_to_many, I have a Requirement model with a couple of polymorphic references encapsulating the relationship).
Hopefully changing to :joins will rid me of a couple of seconds on the AR query time.
Just tried it: down to 0.1 seconds for that request now.
Thanks for this informative blog post. It is much appreciated!
I was looking at the difference between running time of 2.5 seconds using and AR :include and 0.04 seconds running the same SQL through a DB admin tool. I guessed that it was probably something to do will instantiating lots of silly little objects (instead of has_and_belongs_to_many, I have a Requirement model with a couple of polymorphic references encapsulating the relationship).
Thanks for the useful info...
One thing you might suggest is using a gem called Reek.. (http://wiki.github.com/kevinrutherford/reek)
it gives hint when you should use something like the :include
Thanks for this useful information, bookmarked for future reference.
I was just thinking about Establishing Healthy Routines for Children and you've really helped out. Thanks!
Thanks for this useful information.
this is impressive.i have just started my path to learn the Rails thoroughly and these tips are something i have never read before anywhere.
This is a great post thanks for sharing this informative information..
Very useful information. It´s hard to find a quality post on the subject like this one. Thank you very much!
Awesome. Tips like these are why I love Rails as a development platform. It's so much easier to get stuff up and running in Rails.
Nice tips. It is a long article i think i need digest it in next some days.
Thank you for the rails tips. Now I will be the best at Rails.
amzine poste! thx
google
google
google
Great suggestions. I haven't done a lot of work in rails but now I'm planning on using these ideas.
Thank you for your topic
The subject of bitter, sweet, beautiful, moon
Accept traffic
Gisele thanks from me to you
Mra thanks
To the meeting ..
As always, you've provided some valuable insight. I couldn't figure out for the life of me why I was getting extra queries before I started using the h3! Thanks man.
Been looking for this kind of topic over the internet and i found yours! Very informative! Will keep an eye for part2! ;)
As always, you've provided some valuable insight. I couldn't figure out for the life of me why I was getting extra queries before I started using the h3! Thanks man.
Thanks for the tips they are excellent. I also recommend including Reek in your article as it's a useful tool for improving code quality
Excellent blog
Thank you for these tips. You just help me solve my problem.
thank you. great post.
Thank you for these tips. You just help me solve my problem.
This is a great post thanks for sharing this informative information..
Rails is a great platform.It always comes together so easily. Thanks guys and gals
very very informative site
ytu tyurtyu tyu tyu ty
ghj ghjhgj ghjhg
Thank you for these tips. You just help me solve my problem.
That information will help me very much. thank you so much!
http://www.webjam.com/cainmenukayjing3/$my_blog/2010/03/24/aone_ultra_dvd_creator_144 aone ultra dvd creator 1.4.4 or http://www.webjam.com/cainmenukayjing3/$my_blog/2010/03/24/uk_vagra uk vagra or http://www.webjam.com/cainmenukayjing3/$my_blog/2010/03/24/ab_ultra_drive_encoder_cable_pinout ab ultra drive encoder cable pinout or http://www.webjam.com/cainmenukayjing3/$my_blog/2010/03/24/row_across_the_atlantic row across the atlantic or http://www.webjam.com/cainmenukayjing3/$my_blog/2010/03/24/bain_ultra_birmingham_alabama bain ultra birmingham alabama
I have always admired your point of view mate. I am really glad to be a part of your blog.
I like your posts a lot. Very thankfull for telling us all that. All the best.
It was ok at the start, but now it's not working for me.
www.vancouver-cleaning.com, Quick and easy carpet cleaning
http://phentermine-no-35.bloggum.com/ Phentermine No Prescription Needed or http://best-diet-pills54.bloggum.com/ Best Diet Pills or http://fluoxetine-cod67.bloggum.com/ Fluoxetine Cod or http://mexican-vicodin39.bloggum.com/ Mexican Vicodin or
A little confusing...
Thank you.. admin is information fantastic
http://www.ligtv-justintv.com
http://www.curukelma.tk
post is very useful.
thanks for help..
very very very fantastic topic :D
this is impressive.i have just started my path to learn the Rails thoroughly and these tips are something i have never read before anywhere.
Very confusing
very useful information
Great Post. Lots of useful information.
Just tried it. Now I will be the best at Rails.Thanks for this useful information
I also recommend including Reek in your article as it's a useful tool for improving code quality. thanks sharing for useful information
Thanks for your expert guidance. Excellent stuff. All the best.
Rail is a very cool application and it just makes it easy to maintain the database. By the way is there any chance of getting new version of Rail with some more cool features.
I have always admired your point of view mate. I am really glad to be a part of your blog.
This is the easy way to solve the problem, surely it will help a lot. I will check this in detail and apply it whenever i need it.
Thanks for the great Rails tips.
Rails is a great platform.It always comes together so easily. Thanks guys and gals
When calling save any validations defined in the model are validated in the background (some validations can also mean extra database queries). But what if we are updating the views_count of a blog post? We don’t want to add extra load to the database for no reason.
thanx very good text.
Feels like rails is a good platform building your own web properties and add some function to them easily.
I try and I try but it's still not working for me.
Apprciate the tips.
Thanks for the great information. Keep these posts coming.
Love the information. Keep the tips coming...and coming. We neeed the help!
Love it. love it. love it. I just implemented what you said. Definitely get me started using Rails. Thanks.
AR’s find method provides an option to manually specify join tables, using :joins. In that case AR will not try to create objects for you, it will just append the join directive on the sql output and the :select option will not be ignored. The following code snippets will show you what happens in each case:
Thanks for article. Liked it
Very informative, appreciate it!
This is a great blog. I have bookmarked it and hope for more. I enjoyed it!
Thank you links!
It's down to the coding - a total shamble!
I think that there are even more than 9 tips. If you really think about it there are more like 15.
There are always going to be more, but now we can use these 9 tips to help guide the way.
thanks you learn somthing every day
it's so well
good it's so well
Crazy things happen when you walk through the park. Keep up the great blog.
I am happy I can use it a lot faster now. I understand everything much easier.
Thanks.
Very detail and informative post. Thanks a lot for your share.
voip softphone
I have been reading a lot of Rails stuff recently. It is a great framework; however, it requires an extensive knowledge before much can be done with it.
There are even more than 9 tips. If you really think about it there are more like 15.
Thanks for providing the quality information as there are lots of sites that can just crack your head into pieces for its non-English texts.
It is indeed a great resource to obtain information on this subject. Keep posting. Thanks.
Thanks for this nice info, it's so useful for me.
Thanks werry good!
Ooooo very good text.Forever site:)
Your site is very nice touches on a beautiful subject
As Carpet Cleaners in Vancouver, we offer quality carpet cleaning services for commercial and residential customers in the Lower Mainland and Vancouver area. We are carpet cleaning specialists, however, we also offer a broad range of other cleaning services to meet your cleaning needs.
We are the experts of carpet cleaning in Vancouver, Canada. Our services include Furnace, duct cleaning, window, pressure washing, in Richmond, Burnaby, North Vancouver and West Vancouver.
I recently came across your article and have been reading along. I want to express my admiration of your writing skill and ability to make readers read from the beginning to the end. I would like to read newer posts and to share my thoughts with you.
your text is good .. thanx for all :)
your text is good .. thanx for all :)
thank u my dae
I will be checking into this website again
thank u my dae
Great blogging..Its really great to come across reading best blogging articles..Keep blogging,, cheers dude..
yahu bu tür şeyler gerçekten çok saçma diyebiliriz.
I really loved reading your blog. It was very well authored and easy to understand. Unlike additional blogs I have read which are really not good. I also found your posts very interesting. In fact after reading, I had to go show it to my friend and he enjoyed it as well!
I realy enjoy your text i think it requires special resources forming this result.
for the visitors there is something different in this post
thanks for the help
Thank you for your excellent information
http://www.admntk.com
I try and I try but it's still not working for me.
for the visitors there is something different in this post
I find rails as useful as this post.
I've only just started using Rails but already I am finding your suggestions to be a big help. Thanks a lot!
Rails is great, and this post has helped me out a lot.
http://beatmakingsoftwareinfo.blogspot.com"
Hey, I would like to say, what a cool blog! izlebe u64 j0p
Küresel ısınma kadar ciddiye alınan bu durum karşısında uzmanlar çözüm yolları arıyor. Bu yöntemlerin çoğu aslında doğanın kendisinde var. Çin Küskütü mesela. Çin'de çok eski zamanlardan beri kullanılan bu mucizevi bitki, erken boşalmanın tedavisinde, daha iyi ereksiyonun sağlanmasında ve cinsel performansın artırılmasında etkili. Kısırlığı tedavi ediyor, sperm sayısı ve sperm hareketliliğini artırıyor. Peki bu bitki nasıl kullanılıyor? NORE Türkiye Distribütörü Gökhan Sonbahar, Çin Küskütü ve temsilcisi olduğu ürüne dair sorularımıza yanıt verdi.
ütörü Gökhan Sonbahar, Çin Küskütü ve temsilcisi olduğu ürüne dair sorularımıza yanıt verdi.
I definitely learned more than I could have imagined from this article.
I've been struggling with Rails. Not anymore thanks to this post!!
thanks a lots
sdfsafdsf jknkjnkj kjnk
I will go one more time this way to see if it comes out to the path or not. I think I am spending 2 hours a day with it in the last week.
I don't think using select, or eager loading is premature optimization.
Long before ORM's existed, we wrote sql queries by hand and I don't think that anyone would write a join-less query to avoid premature optimization.
Christmas gifts
It all helped me a lot. I saved time and I less stressed right now after reading it and doing it. Thank you for your input.
Aw, it was a top quality content. Actually I would like to write like this as well – taking time and real energy to bring about an excellent post… however what can I say… I procrastinate an awful lot and by no means appear to get things completed…
This is very nice one and gives in depth information. I think it will be helpful. Thank you very much for that extraordinarily first class editorial! keep up the good work.
mobile webcams iPhone chat
Keep updating good content, I’ll just subscribe to the feed.
I've only just started using Rails but already I am finding your suggestions to be a big help. Thanks
Great set of tips, this should be part of any Rails developer's manual
http://games.sodfah.com/
I am just thinking about going long distance with bath suite in the train for mental refreshment. Your tips will really help me i think as they are showing good impact already.
Very nice tips and could be helpful.
Great tips. I'm sure a few of them will prove useful.
THANKS ALOT
VERY VERY GOOD
This is very nice post and got very good information which is useful to me.
huang101
http://www.coachs.cc
goooooooood master
Very good post. I just stumbled upon your blog and wanted to say that I have really enjoyed reading your blog posts. Any way I'll be subscribing to your feed and I hope you post again soon.
I am so satisfied that I have found this your post because I have been searching for some information about the rail tips almost two hours. You helped me a lot indeed and reading this your article I have found many new and useful information about this subject. Well, I will definitely bookmark your website and wait for other useful and informative posts like this one in the future.
is very good ,monster beats
I found this asticle very helpful. Thanks!
Thanks for this great walkthrough, I tried to do this before without any success, maybe now i may do something.
Those are some great rails tips. Thanks a lot for the post, its very helpful.
Thanks for the tips on Rails. That will help me out.
شات -
دردشه - دردشة -
شات كتابي -
دردشه كتابيه -
العاب فلاش
Drop a comment: