2_2_release_notes.txt

Ruby on Rails 2.2 Release Notes
===============================

Rails 2.2 delivers a number of new and improved features. This list covers the major upgrades, but doesn't include every little bug fix and change. If you want to see everything, check out the link:http://github.com/rails/rails/commits/master[list of commits] in the main Rails repository on GitHub.

Along with Rails, 2.2 marks the launch of the link:http://guides.rubyonrails.org/[Ruby on Rails Guides], the first results of the ongoing link:http://hackfest.rubyonrails.org/guide[Rails Guides hackfest]. This site will deliver high-quality documentation of the major features of Rails.

== Infrastructure

Rails 2.2 is a significant release for the infrastructure that keeps Rails humming along and connected to the rest of the world.

=== Internationalization

Rails 2.2 supplies an easy system for internationalization (or i18n, for those of you tired of typing).

* Lead Contributors: Rails i18 Team
* More information :
  - link:http://rails-i18n.org[Official Rails i18 website]
  - link:http://www.artweb-design.de/2008/7/18/finally-ruby-on-rails-gets-internationalized[Finally. Ruby on Rails gets internationalized]
  - link:http://i18n-demo.phusion.nl[Localizing Rails : Demo application]

=== Compatibility with Ruby 1.9 and JRuby

Along with thread safety, a lot of work has been done to make Rails work well with JRuby and the upcoming Ruby 1.9. With Ruby 1.9 being a moving target, running edge Rails on edge Ruby is still a hit-or-miss proposition, but Rails is ready to make the transition to Ruby 1.9 when the latter is released.

== Documentation

The internal documentation of Rails, in the form of code comments, has been improved in numerous places. In addition, the link:http://guides.rubyonrails.org/[Ruby on Rails Guides] project is the definitive source for information on major Rails components. In its first official release, the Guides page includes:

* link:http://guides.rubyonrails.org/getting_started_with_rails.html[Getting Started with Rails]
* link:http://guides.rubyonrails.org/migrations.html[Rails Database Migrations]
* link:http://guides.rubyonrails.org/association_basics.html[Active Record Associations]
* link:http://guides.rubyonrails.org/finders.html[Active Record Finders]
* link:http://guides.rubyonrails.org/layouts_and_rendering.html[Layouts and Rendering in Rails]
* link:http://guides.rubyonrails.org/form_helpers.html[Action View Form Helpers]
* link:http://guides.rubyonrails.org/routing_outside_in.html[Rails Routing from the Outside In]
* link:http://guides.rubyonrails.org/actioncontroller_basics.html[Basics of Action Controller]
* link:http://guides.rubyonrails.org/caching_with_rails.html[Rails Caching]
* link:http://guides.rubyonrails.org/testing_rails_applications.html[Testing Rails Applications]
* link:http://guides.rubyonrails.org/security.html[Securing Rails Applications]
* link:http://guides.rubyonrails.org/debugging_rails_applications.html[Debugging Rails Applications]
* link:http://guides.rubyonrails.org/benchmarking_and_profiling.html[Benchmarking and Profiling Rails Applications]
* link:http://guides.rubyonrails.org/creating_plugins.html[The Basics of Creating Rails Plugins]

All told, the Guides provide tens of thousands of words of guidance for beginning and intermediate Rails developers.

If you want to these generate guides locally, inside your application:

[source, ruby]
-------------------------------------------------------
rake doc:guides
-------------------------------------------------------

This will put the guides inside +RAILS_ROOT/doc/guides+ and you may start surfing straight away by opening +RAILS_ROOT/doc/guides/index.html+ in your favourite browser.

* Lead Contributors: link:http://guides.rails.info/authors.html[Rails Documentation Team]
* Major contributions from link:http://advogato.org/person/fxn/diary.html[Xavier Noria] and link:http://izumi.plan99.net/blog/[Hongli Lai].
* More information:
 - link:http://hackfest.rubyonrails.org/guide[Rails Guides hackfest]
 - link:http://weblog.rubyonrails.org/2008/5/2/help-improve-rails-documentation-on-git-branch[Help improve Rails documentation on Git branch]

== Better integration with HTTP : Out of the box ETag support

Supporting the etag and last modified timestamp in HTTP headers means that Rails can now send back an empty response if it gets a request for a resource that hasn't been modified lately. This allows you to check whether a response needs to be sent at all.

[source, ruby]
-------------------------------------------------------
class ArticlesController < ApplicationController
  def show_with_respond_to_block
    @article = Article.find(params[:id])

    # If the request sends headers that differs from the options provided to stale?, then
    # the request is indeed stale and the respond_to block is triggered (and the options
    # to the stale? call is set on the response).
    #
    # If the request headers match, then the request is fresh and the respond_to block is
    # not triggered. Instead the default render will occur, which will check the last-modified
    # and etag headers and conclude that it only needs to send a "304 Not Modified" instead
    # of rendering the template.
    if stale?(:last_modified => @article.published_at.utc, :etag => @article)
      respond_to do |wants|
        # normal response processing
      end
    end
  end

  def show_with_implied_render
    @article = Article.find(params[:id])

    # Sets the response headers and checks them against the request, if the request is stale
    # (i.e. no match of either etag or last-modified), then the default render of the template happens.
    # If the request is fresh, then the default render will return a "304 Not Modified"
    # instead of rendering the template.
    fresh_when(:last_modified => @article.published_at.utc, :etag => @article)
  end
end
-------------------------------------------------------

== Thread Safety

The work done to make Rails thread-safe is rolling out in Rails 2.2. Depending on your web server infrastructure, this means you can handle more requests with fewer copies of Rails in memory, leading to better server performance and higher utilization of multiple cores.

To enable multithreaded dispatching in production mode of your application, add the following line in your +config/environments/production.rb+:

[source, ruby]
-------------------------------------------------------
config.threadsafe!
-------------------------------------------------------

* More information :
 - link:http://m.onkey.org/2008/10/23/thread-safety-for-your-rails[Thread safety for your Rails]
 - link:http://weblog.rubyonrails.org/2008/8/16/josh-peek-officially-joins-the-rails-core[Thread safety project announcement]
 - link:http://blog.headius.com/2008/08/qa-what-thread-safe-rails-means.html[Q/A: What Thread-safe Rails Means]

== Active Record

There are two big additions to talk about here: transactional migrations and pooled database transactions. There's also a new (and cleaner) syntax for join table conditions, as well as a number of smaller improvements.

=== Transactional Migrations

Historically, multiple-step Rails migrations have been a source of trouble. If something went wrong during a migration, everything before the error changed the database and everything after the error wasn't applied. Also, the migration version was stored as having been executed, which means that it couldn't be simply rerun by +rake db:migrate:redo+ after you fix the problem. Transactional migrations change this by wrapping migration steps in a DDL transaction, so that if any of them fail, the entire migration is undone. In Rails 2.2, transactional migrations are supported *on PostgreSQL only*. The code is extensible to other database types in the future.

* Lead Contributor: link:http://adam.blog.heroku.com/[Adam Wiggins]
* More information:
 - link:http://adam.blog.heroku.com/past/2008/9/3/ddl_transactions/[DDL Transactions]

=== Connection Pooling

Connection pooling lets Rails distribute database requests across a pool of database connections that will grow to a maximum size (by default 5, but you can add a +pool+ key to your +database.yml+ to adjust this). This helps remove bottlenecks in applications that support many concurrent users. There's also a +wait_timeout+ that defaults to 5 seconds before giving up. +ActiveRecord::Base.connection_pool+ gives you direct access to the pool if you need it.

[source, ruby]
-------------------------------------------------------
development:
  adapter: mysql
  username: root
  database: sample_development
  pool: 10
  wait_timeout: 10
-------------------------------------------------------

* Lead Contributor: link:http://blog.nicksieger.com/[Nick Sieger]
* More information: 
 - link:http://ryandaigle.com/articles/2008/9/7/what-s-new-in-edge-rails-connection-pools[What's New in Edge Rails: Connection Pools]

=== Hashes for Join Table Conditions

You can now specify conditions on join tables using a hash. This is a big help if you need to query across complex joins.

[source, ruby]
-------------------------------------------------------
class Photo < ActiveRecord::Base
  belongs_to :product
end

class Product < ActiveRecord::Base
  has_many :photos
end

# Get all products with copyright-free photos:
Product.all(:joins => :photos, :conditions => { :photos => { :copyright => false }})
-------------------------------------------------------

* More information:
 - link:http://ryandaigle.com/articles/2008/7/7/what-s-new-in-edge-rails-easy-join-table-conditions[What's New in Edge Rails: Easy Join Table Conditions]

=== New Dynamic Finders

Two new sets of methods have been added to Active Record's dynamic finders family.

==== +find_last_by_<attribute>+

The +find_last_by_<attribute>+ method is equivalent to +Model.last(:conditions => {:attribute => value})+
	
[source, ruby]
-------------------------------------------------------
# Get the last user who signed up from London
User.find_last_by_city('London')
-------------------------------------------------------

* Lead Contributor: link:http://www.workingwithrails.com/person/9147-emilio-tagua[Emilio Tagua]

==== +find_by_<attribute>!+ 
	
The new bang! version of +find_by_<attribute>!+ is equivalent to +Model.first(:conditions => {:attribute => value}) || raise ActiveRecord::RecordNotFound+ Instead of returning +nil+ if it can't find a matching record, this method will raise an exception if it cannot find a match.
	
[source, ruby]
-------------------------------------------------------
# Raise ActiveRecord::RecordNotFound exception if 'Moby' hasn't signed up yet!
User.find_by_name!('Moby')
-------------------------------------------------------

* Lead Contributor: link:http://blog.hasmanythrough.com[Josh Susser]

=== Associations Respect Private/Protected Scope

Active Record association proxies now respect the scope of methods on the proxied object. Previously (given User has_one :account) +@user.account.private_method+ would call the private method on the associated Account object. That fails in Rails 2.2; if you need this functionality, you should use +@user.account.send(:private_method)+ (or make the method public instead of private or protected). Please note that if you're overriding +method_missing+, you should also override +respond_to+ to match the behavior in order for associations to function normally.

* Lead Contributor: Adam Milligan
* More information:
 - link:http://afreshcup.com/2008/10/24/rails-22-change-private-methods-on-association-proxies-are-private/[Rails 2.2 Change: Private Methods on Association Proxies are Private]

=== Other ActiveRecord Changes

* +rake db:migrate:redo+ now accepts an optional VERSION to target that specific migration to redo
* Set +config.active_record.timestamped_migrations = false+ to have migrations with numeric prefix instead of UTC timestamp. 
* Counter cache columns (for associations declared with +:counter_cache => true+) do not need to be initialized to zero any longer.
* +ActiveRecord::Base.human_name+ for an internationalization-aware humane translation of model names

== Action Controller

On the controller side, there are a couple of changes that will help tidy up your routes. 

=== Shallow Route Nesting

Shallow route nesting provides a solution to the well-known difficulty of using deeply-nested resources. With shallow nesting, you need only supply enough information to uniquely identify the resource that you want to work with - but you _can_ supply more information. 

[source, ruby]
-------------------------------------------------------
map.resources :publishers, :shallow => true do |publisher|
  publisher.resources :magazines do |magazine|
    magazine.resources :photos
  end
end
-------------------------------------------------------

This will enable recognition of (among others) these routes:

-------------------------------------------------------
/publishers/1           ==> publisher_path(1)
/publishers/1/magazines ==> publisher_magazines_path(1)
/magazines/2            ==> magazine_path(2)
/magazines/2/photos     ==> magazines_photos_path(2)
/photos/3               ==> photo_path(3)
-------------------------------------------------------

* Lead Contributor: link:http://www.unwwwired.net/[S. Brent Faulkner]
* More information: 
 - link:http://guides.rails.info/routing/routing_outside_in.html#_nested_resources[Rails Routing from the Outside In]
 - link:http://ryandaigle.com/articles/2008/9/7/what-s-new-in-edge-rails-shallow-routes[What's New in Edge Rails: Shallow Routes]

=== Method Arrays for Member or Collection Routes

You can now supply an array of methods for new member or collection routes. This removes the annoyance of having to define a route as accepting any verb as soon as you need it to handle more than one. With Rails 2.2, this is a legitimate route declaration:

[source, ruby]
-------------------------------------------------------
map.resources :photos, :collection => { :search => [:get, :post] }
-------------------------------------------------------

* Lead Contributor: link:http://brennandunn.com/[Brennan Dunn]

Action Controller now offers good support for HTTP conditional GET requests, as well as some other additions.

=== Other Action Controller Changes

* You can now easily link:http://m.onkey.org/2008/7/20/rescue-from-dispatching[show a custom error page] for exceptions raised while routing a request.
* The HTTP Accept header is disabled by default now. You should prefer the use of formatted URLs (such as +/customers/1.xml+) to indicate the format that you want. If you need the Accept headers, you can turn them back on with +config.action_controller.user_accept_header = true+.
* Benchmarking numbers are now reported in milliseconds rather than tiny fractions of seconds
* Rails now supports HTTP-only cookies (and uses them for sessions), which help mitigate some cross-site scripting risks in newer browsers.
* +redirect_to+ now fully supports URI schemes (so, for example, you can redirect to a svn+ssh: URI).
* +render+ now supports a +:js+ option to render plain vanilla javascript with the right mime type.

== Action View

* +javascript_include_tag+ and +stylesheet_link_tag+ support a new +:recursive+ option to be used along with +:all+, so that you can load an entire tree of files with a single line of code.
* The included Prototype javascript library has been upgraded to version 1.6.0.3.
* +RJS#page.reload+ to reload the browser's current location via javascript
* The +atom_feed+ helper now takes an +:instruct+ option to let you insert XML processing instructions.

== Action Mailer

Action Mailer now supports mailer layouts. You can make your HTML emails as pretty as your in-browser views by supplying an appropriately-named layout - for example, the +CustomerMailer+ class expects to use +layouts/customer_mailer.html.erb+.

* More information:
 - link:http://ryandaigle.com/articles/2008/9/7/what-s-new-in-edge-rails-mailer-layouts[What's New in Edge Rails: Mailer Layouts]

== Active Support

Active Support now offers built-in memoization for Rails applications, the +each_with_object+ method, prefix support on delegates, and various other new utility methods.

=== Memoization

Memoization is a pattern of initializing a method once and then stashing its value away for repeat use. You've probably used this pattern in your own applications:

[source, ruby]
-------------------------------------------------------
def full_name
  @full_name ||= "#{first_name} #{last_name}"
end
-------------------------------------------------------

Memoization lets you handle this task in a declarative fashion:

[source, ruby]
-------------------------------------------------------
extend ActiveSupport::Memoizable

def full_name
  "#{first_name} #{last_name}"
end
memoize :full_name
-------------------------------------------------------

Other features of memoization include +unmemoize+, +unmemoize_all+, and +memoize_all+ to turn memoization on or off.

* Lead Contributor: link:http://joshpeek.com/[Josh Peek]
* More information:
 - link:http://ryandaigle.com/articles/2008/7/16/what-s-new-in-edge-rails-memoization[What's New in Edge Rails: Easy Memoization]
 - link:http://www.railway.at/articles/2008/09/20/a-guide-to-memoization[Memo-what? A Guide to Memoization]

=== +each_with_object+

The +each_with_object+ method provides an alternative to +inject+, using a method backported from Ruby 1.9. It iterates over a collection, passing the current element and the memo into the block.

[source, ruby]
-------------------------------------------------------
%w(foo bar).each_with_object({}) { |str, hsh| hsh[str] = str.upcase } #=> {'foo' => 'FOO', 'bar' => 'BAR'}
-------------------------------------------------------

Lead Contributor: link:http://therealadam.com/[Adam Keys]

=== Delegates With Prefixes

If you delegate behavior from one class to another, you can now specify a prefix that will be used to identify the delegated methods. For example:

[source, ruby]
-------------------------------------------------------
class Vendor < ActiveRecord::Base
  has_one :account
  delegate :email, :password, :to => :account, :prefix => true
end
-------------------------------------------------------

This will produce delegated methods +vendor#account_email+ and +vendor#account_password+. You can also specify a custom prefix:

[source, ruby]
-------------------------------------------------------
class Vendor < ActiveRecord::Base
  has_one :account
  delegate :email, :password, :to => :account, :prefix => :owner
end
-------------------------------------------------------

This will produce delegated methods +vendor#owner_email+ and +vendor#owner_password+.

Lead Contributor: link:http://workingwithrails.com/person/5830-daniel-schierbeck[Daniel Schierbeck]

=== Other Active Support Changes

* Extensive updates to +ActiveSupport::Multibyte+, including Ruby 1.9 compatibility fixes.
* The addition of +ActiveSupport::Rescuable+ allows any class to mix in the +rescue_from+ syntax.
* +past?+, +today?+ and +future?+ for +Date+ and +Time+ classes to facilitate date/time comparisons.
* +Array#second+ through +Array#tenth+ as aliases for +Array#[1]+ through +Array#[9]+
* +Enumerable#many?+ to encapsulate +collection.size > 1+
* +Inflector#parameterize+ produces a URL-ready version of its input, for use in +to_param+.
* +Time#advance+ recognizes fractional days and weeks, so you can do +1.7.weeks.ago+, +1.5.hours.since+, and so on.
* The included TzInfo library has been upgraded to version 0.3.11.
* +ActiveSuport::StringInquirer+ gives you a pretty way to test for equality in strings: +ActiveSupport::StringInquirer.new("abc").abc? => true+

== Railties

In Railties (the core code of Rails itself) the biggest changes are in the +config.gems+ mechanism.

=== +config.gems+

To avoid deployment issues and make Rails applications more self-contained, it's possible to place copies of all of the gems that your Rails application requires in +/vendor/gems+. This capability first appeared in Rails 2.1, but it's much more flexible and robust in Rails 2.2, handling complicated dependencies between gems. Gem management in Rails includes these commands:

* +config.gem _gem_name_+ in your +config/environment.rb+ file
* +rake gems+ to list all configured gems, as well as whether they (and their dependencies) are installed or frozen
* +rake gems:install+ to install missing gems to the computer
* +rake gems:unpack+ to place a copy of the required gems into +/vendor/gems+
* +rake gems:unpack:dependencies+ to get copies of the required gems and their dependencies into +/vendor/gems+
* +rake gems:build+ to build any missing native extensions
* +rake gems:refresh_specs+ to bring vendored gems created with Rails 2.1 into alignment with the Rails 2.2 way of storing them

You can unpack or install a single gem by specifying +GEM=_gem_name_+ on the command line.

* Lead Contributor: link:http://github.com/al2o3cr[Matt Jones]
* More information:
 - link:http://ryandaigle.com/articles/2008/4/1/what-s-new-in-edge-rails-gem-dependencies[What's New in Edge Rails: Gem Dependencies]
 - link:http://afreshcup.com/2008/10/25/rails-212-and-22rc1-update-your-rubygems/[Rails 2.1.2 and 2.2RC1: Update Your RubyGems]

=== Other Railties Changes

* If you're a fan of the link:http://code.macournoyer.com/thin/[Thin] web server, you'll be happy to know that +script/server+ now supports Thin directly.
* +script/plugin install <plugin> -r <revision>+ now works with git-based as well as svn-based plugins.
* +script/console+ now supports a +--debugger+ option
* Instructions for setting up a continuous integration server to build Rails itself are included in the Rails source
* +rake notes:custom ANNOTATION=MYFLAG+ lets you list out custom annotations.
* Wrapped +Rails.env+ in +StringInquirer+ so you can do +Rails.env.development?+
* +script/generate+ works without deprecation warnings when RubyGems 1.3.0 is present

== Deprecated

A few pieces of older code are deprecated in this release:

* +Rails::SecretKeyGenerator+ has been replaced by +ActiveSupport::SecureRandom+
* +render_component+ is deprecated. There's a link:http://github.com/rails/render_component/tree/master[render_components plugin] available if you need this functionality.
* Implicit local assignments when rendering partials has been deprecated.

[source, ruby]
-------------------------------------------------------
def partial_with_implicit_local_assignment
  @customer = Customer.new("Marcel")
  render :partial => "customer"
end
-------------------------------------------------------

Previously the above code made available a local variable called +customer+ inside the partial 'customer'. You should explicitly pass all the variables via :locals hash now.

* +country_select+ has been removed. See the link:http://www.rubyonrails.org/deprecation/list-of-countries[deprecation page] for more information and a plugin replacement.
* +ActiveRecord::Base.allow_concurrency+ no longer has any effect.
* +ActiveRecord::Errors.default_error_messages+ has been deprecated in favor of +I18n.translate('activerecord.errors.messages')+
* The +%s+ and +%d+ interpolation syntax for internationalization is deprecated.
* +String#chars+ has been deprecated in favor of +String#mb_chars+.
* Durations of fractional months or fractional years are deprecated. Use Ruby's core +Date+ and +Time+ class arithmetic instead.

== Credits

Release notes compiled by link:http://afreshcup.com[Mike Gunderloy]