Notes posted to Ruby on Rails

Status Codes

Full detail: http://en.wikipedia.org/wiki/List_of_HTTP_status_codes

• 100 - Continue

• 101 - Switching Protocols

• 200 - OK

• 201 - Created

• 202 - Accepted

• 203 - Non-Authoritative Information

• 204 - No Content

• 205 - Reset Content

• 206 - Partial Content

• 300 - Multiple Choices

• 301 - Moved Permanently

• 302 - Found

• 303 - See Other

• 304 - Not Modified

• 305 - Use Proxy

• 306 - No Longer Used

• 307 - Temporary Redirect

• 400 - Bad Request

• 401 - Not Authorised

• 402 - Payment Required

• 403 - Forbidden

• 404 - Not Found

• 405 - Method Not Allowed

• 406 - Not Acceptable

• 407 - Proxy Authentication Required

• 408 - Request Timeout

• 409 - Conflict

• 410 - Gone

• 411 - Length Required

• 412 - Precondition Failed

• 413 - Request Entity Too Large

• 414 - Request URI Too Long

• 415 - Unsupported Media Type

• 416 - Requested Range Not Satisfiable

• 417 - Expectation Failed

• 500 - Internal Server Error

• 501 - Not Implemented

• 502 - Bad Gateway

• 503 - Service Unavailable

• 504 - Gateway Timeout

• 505 - HTTP Version Not Supported

Doesn't return nil if the object you try from isn't nil.

Note that this doesn’t prevent a NoMethodError if you attempt to call a method that doesn’t exist on a valid object.

a = Article.new

a.try(:author) #=> #<Author ...>

nil.try(:doesnt_exist) #=> nil

a.try(:doesnt_exist) #=> NoMethodError: undefined method `doesnt_exist' for #<Article:0x106c7d5d8>

This is on Ruby 1.8.7 patchlevel 174

Alternative:

without using at

[:a, :b, :c].try(:[], 1)

Attribute names are Strings, not Symbols

Another possible gotcha – the returned hash keys are of type String, not Symbol:

user.attributes["login"] # => "joe"
user.attributes[:login] # => nil

Compare dates

You can check a date resides between two dates.

Date.today.between?(Date.yesterday, Date.tomorrow)

will return true

Date.yesterday.between?(Date.today, Date.tomorrow)

will return false

expire_page outside controller and sweepers

If you want to expire cached pages from scripts or console just use class-method expire_page. But don’t forget about difference between instance and class method. In class-method you pass page url, not a hash of action/controller:

ActionController::Base.expire_page your_page_url

Expire cache from console or whatever...

I know only one possible method:

ApplicationController.new.expire_fragment(:your_fragment)

Version Ranges

To specify a version range, use array syntax like this:

config.gem 'paperclip', :version => ['>= 2.3.1.1', '< 3.0']

The example will, of course, match any version 2.3.1.1 or newer up until (not including) 3.0 or later.

path

send_file always uses the absolute path /www/somewebsite/public/downloads/file

yijisoo

create generates the object and saves. new only generates the object.

e.g.

o = Object.new(:foo => 'bar')
o.save

is the same as

o = Object.create(:foo => 'bar')

What's difference between create and new?

What’s difference between create and new?

Capturing blocks after >2.2

After 2.2, you can omit the do …end block and simply use the &block variable directly:

concat(content_tag(:div, :class => "wrapped_content") do
  capture(&block)
end, block.binding)

becomes simply:

concat(content_tag(:div, capture(&block), :class => "wrapped_content"))

IE GOTCHA - multiple javascript_include_tags with cache => true

If you have multiple lines of javascript_include_tag ‘jsfile’, :cache => true, IE does not load them all (though it seems Firefox and Safari do). And the error won’t show up until you’re in production (since that’s only when caching kicks in.)

You should include them all on one line:

javascript_include_tag 'file1.js', 'file2.js', 'file3.js', :cache => 'myfiles'

Clearing out previous values from content_for

By default, content_for :thing appends whatever you put in your block to the previous value of :thing. In some cases, you’d like to clear out :thing rather than append to it.

I just posted a way to do this on my blog: http://stevechanin.blogspot.com/2009/11/clearing-out-content-in-contentfor.html

I add a new method set_content_for that works just like content_for, but clears out :thing first. It doesn’t touch how content_for works, so it shouldn’t cause any problems anywhere else in your app.

You can specify the format as well

You can also specify the format (in case you need to redirect a request coming in one format to another format):

redirect_to :action => 'show', :format => 'html'

How to check if a Yield has content?

How do I do this without actually calling the yield?

- if yield :footer
  = yield :footer
- else
  = render "layouts/footer_big"

(Note: HAML Syntax) Thanks.

How to use with HAML

Are you using HAML and try to do the block-thing (do…)? Please note that the whole block has to be in a single line. More: http://groups.google.com/group/haml/browse_thread/thread/52e62ef501c504a3

Streaming Does Not Work with Mongrel

If you are trying to stream output via render :text => Proc and Mongrel, be sure to note that this does NOT work. Mongrel returns a StringIO, which by nature buffers everything.

Unsure of how to actually stream output with Rails in a consistent fashion.

assert_response(:success) checks if the status code is in the range 200-299

success? in ActionController::TestResponseBehavior is defined as:

def success?
  (200..299).include?(response_code)
end

Be careful with float ranges

Pay close attention to the fact that the object passed to :in must be enumerable.

If you want to validate a ranking, the following won’t work:

validates_inclusion_of :rating, :in => (0.0..10.0)

Instead, you’ll want to use validates_numericality_of like this:

validates_numericality_of :rating, :greater_than_or_equal_to => 0.0, :less_than_or_equal_to => 10.0

More Docs and Explanation

You probably want to look at the class level docs

http://apidock.com/rails/ActiveRecord/NestedAttributes/ClassMethods

(cut and paste, apidocks can’t render the above for some reason)

The docs are in the base class

Look in ActionController::Base for the docs.

style for select

<%= select(“post”, “person_id”, Person.all.collect {|p| [ p.name, p.id ] }, {}, :style => “width:100px” %>

Careful with scopes

Just like find, find_in_batches introduces an implicit scope into the block. So for example

Person.find_in_batches(:conditions => {:birthday => Date.today}) do |birthday_childs|
  Person.all.each do |person|
    person.send_presents_to(birthday_childs)
  end
end

does not work as expected, because the Person.all within the block will also find only persons with :conditions => {:birthday => Date.today}.

You can't use the :limit option either

Person.find_each(:limit => 10000)…

Will result in:

RuntimeError: You can’t specify a limit, it’s forced to be the batch_size

Rails documentation for nested attributes

ActiveRecord/NestedAttributes/ClassMethods

(don’t follow this link, the url interpreter isn’t rendering it correctly :(, but the correct link is at the top of this page)

Use hash form of updates argument

The examples are unfortunate, because passing a string as the updates argument is an invitation to SQL injection attacks. Don’t do this!

Billing.update_all("author='#{author}'")

Use the hash form of updates instead:

Billing.update_all(:author => author)

Then the SQL adapter will quote everything safely. Even if [you think] you’re sure there’s no quoting issue, it’s better to cultivate the habit of using the hash form just in case you missed something.

Same with conditions–use the hash or array form rather than a string if there are variables involved.

BTW, to do this and give options, of course you’ll need to put the braces back in:

Billing.update_all({:author => author},
                   ['title like ?', "#{prefix}%"])

Re: Taking care when writing regex

Oleg’s example from above contains an error and a pitfall:

validates_format_of :something => /^\w$/

The string “blahblahblah” doesn’t pass this validation. What Oleg ment is rather a continuous string of at least one alphanumeric character:

validates_format_of :something => /^\w+$/

However, that’s no good neither because it contains a well hidden trap in case you are validating content from a textarea.

Ruby (both 1.8 and 1.9) always matches ^ and $ against the beginning and ending of lines and not the entire string. Thus “First linenSecond line” will pass the above validation although it’s clearly not a continuous string.

You should use A (replacement for ^) and z (replacement for $) instead as their scope is the entire string:

validates_format_of :something => /\A\w+\z/

(A side note for those with a Perl background: Please note that the “s” modifier has a different meaning in Ruby and won’t do the trick here.)

Calling migrations within migrations observation

Following the advice from RISCfuture I could not call a migration from within another migration. I got the following errror message:

NameError Exception: uninitialized constant FixDrunkMistake::CreateExGirlfriendTexts.down

Only after I did a

require 'create_ex_girl_friend_texts' # the migration file

before the migration call did everything work as expected.

Where are the cached files?

If you configure your app to use the file_store like so:

config.cache_store = :file_store, '/tmp'

and expect you cached page pages to end up in /tmp, think again…

Rails – rather obscurely imho – will store page cached pages in the public/ folder of your app, making it easy for your webserver to find them.

The ‘page_cache_directory’ used in the ‘page_cache_path’ method above is a class var that defaults to the public/ dir.