Merge branch 'master' of git://github.com/lifo/docrails

10 files changed, 65 insertions, 26 deletions

diff --git a/README.rdoc b/README.rdoc
index 0b209cf56f..216a122c66 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -48,7 +48,7 @@ more separate. Each of these packages can be used independently outside of
 
     "Welcome aboard: You're riding Ruby on Rails!"
 
-5. Follow the guidelines to start developing your application. You can find the following resources handy:
+5. Follow the guidelines to start developing your application. You may find the following resources handy:
 
 * The README file created within your application.
 * The {Getting Started with Rails}[http://guides.rubyonrails.org/getting_started.html].
diff --git a/actionmailer/README.rdoc b/actionmailer/README.rdoc
index 14d20bb08d..9b206fbcc7 100644
--- a/actionmailer/README.rdoc
+++ b/actionmailer/README.rdoc
@@ -72,6 +72,19 @@ Or you can just chain the methods together like:
 
   Notifier.welcome.deliver    # Creates the email and sends it immediately
 
+== Setting defaults
+
+It is possible to set default values that will be used in every method in your Action Mailer class. To implement this functionality, you just call the public class method <tt>default</tt> which you get for free from ActionMailer::Base. This method accepts a Hash as the parameter. You can use any of the headers e-mail messages has, like <tt>:from</tt> as the key. You can also pass in a string as the key, like "Content-Type", but Action Mailer does this out of the box for you, so you wont need to worry about that. Finally it is also possible to pass in a Proc that will get evaluated when it is needed.
+
+Note that every value you set with this method will get over written if you use the same key in your mailer method.
+
+Example:
+
+  class Authenticationmailer < ActionMailer::Base
+    default :from => "awesome@application.com", :subject => Proc.new { "E-mail was generated at #{Time.now}" }
+    .....
+  end
+
 == Receiving emails
 
 To receive emails, you need to implement a public instance method called <tt>receive</tt> that takes an
diff --git a/actionpack/lib/abstract_controller/callbacks.rb b/actionpack/lib/abstract_controller/callbacks.rb
index 95992c2698..f7b2b7ff53 100644
--- a/actionpack/lib/abstract_controller/callbacks.rb
+++ b/actionpack/lib/abstract_controller/callbacks.rb
@@ -29,7 +29,7 @@ module AbstractController
       #
       # ==== Options
       # * <tt>only</tt>   - The callback should be run only for this action
-      # * <tt>except<tt>  - The callback should be run for all actions except this action
+      # * <tt>except</tt>  - The callback should be run for all actions except this action
       def _normalize_callback_options(options)
         if only = options[:only]
           only = Array(only).map {|o| "action_name == '#{o}'"}.join(" || ")
diff --git a/actionpack/lib/action_controller/metal/mime_responds.rb b/actionpack/lib/action_controller/metal/mime_responds.rb
index 9885110d5d..618a6cdb7d 100644
--- a/actionpack/lib/action_controller/metal/mime_responds.rb
+++ b/actionpack/lib/action_controller/metal/mime_responds.rb
@@ -3,7 +3,7 @@ require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/object/inclusion'
 
 module ActionController #:nodoc:
-  module MimeResponds #:nodoc:
+  module MimeResponds
     extend ActiveSupport::Concern
 
     included do
@@ -261,7 +261,7 @@ module ActionController #:nodoc:
     # Collects mimes and return the response for the negotiated format. Returns
     # nil if :not_acceptable was sent to the client.
     #
-    def retrieve_response_from_mimes(mimes=nil, &block)
+    def retrieve_response_from_mimes(mimes=nil, &block) #:nodoc:
       mimes ||= collect_mimes_from_class_level
       collector = Collector.new(mimes) { |options| default_render(options || {}) }
       block.call(collector) if block_given?
diff --git a/actionpack/lib/action_view/helpers/url_helper.rb b/actionpack/lib/action_view/helpers/url_helper.rb
index 65b002ebad..de75488e72 100644
--- a/actionpack/lib/action_view/helpers/url_helper.rb
+++ b/actionpack/lib/action_view/helpers/url_helper.rb
@@ -81,9 +81,12 @@ module ActionView
       #   # => /workshops
       #
       #   <%= url_for(@workshop) %>
-      #   # calls @workshop.to_s
+      #   # calls @workshop.to_param which by default returns the id
       #   # => /workshops/5
       #
+      #   # to_param can be re-defined in a model to provide different URL names:
+      #   # => /workshops/1-workshop-name
+      #
       #   <%= url_for("http://www.example.com") %>
       #   # => http://www.example.com
       #
diff --git a/activemodel/lib/active_model/dirty.rb b/activemodel/lib/active_model/dirty.rb
index a479795d51..5ede78617a 100644
--- a/activemodel/lib/active_model/dirty.rb
+++ b/activemodel/lib/active_model/dirty.rb
@@ -8,7 +8,7 @@ module ActiveModel
   # Provides a way to track changes in your object in the same way as
   # Active Record does.
   #
-  # The requirements to implement ActiveModel::Dirty are to:
+  # The requirements for implementing ActiveModel::Dirty are:
   #
   # * <tt>include ActiveModel::Dirty</tt> in your object
   # * Call <tt>define_attribute_methods</tt> passing each method you want to
diff --git a/railties/guides/source/2_3_release_notes.textile b/railties/guides/source/2_3_release_notes.textile
index 67743a4797..15abba66ab 100644
--- a/railties/guides/source/2_3_release_notes.textile
+++ b/railties/guides/source/2_3_release_notes.textile
@@ -410,7 +410,7 @@ You're likely familiar with Rails' practice of adding timestamps to static asset
 
 h4. Asset Hosts as Objects
 
-Asset hosts get more flexible in edge Rails with the ability to declare an asset host as a specific object that responds to a call. This allows you to to implement any complex logic you need in your asset hosting.
+Asset hosts get more flexible in edge Rails with the ability to declare an asset host as a specific object that responds to a call. This allows you to implement any complex logic you need in your asset hosting.
 
 * More Information: "asset-hosting-with-minimum-ssl":http://github.com/dhh/asset-hosting-with-minimum-ssl/tree/master
 
diff --git a/railties/guides/source/active_record_querying.textile b/railties/guides/source/active_record_querying.textile
index f3a10b8b92..df8e35ed33 100644
--- a/railties/guides/source/active_record_querying.textile
+++ b/railties/guides/source/active_record_querying.textile
@@ -790,7 +790,7 @@ Post.includes(:comments).where("comments.visible", true)
 This would generate a query which contains a +LEFT OUTER JOIN+ whereas the +joins+ method would generate one using the +INNER JOIN+ function instead.
 
 <ruby>
-  SELECT "posts"."id" AS t0_r0, ... "comments"."updated_at" AS t1_r5 FROM "posts" LEFT OUTER JOIN "comments" ON "comments"."post_id" = "posts"."id" WHERE (comments.visible)
+  SELECT "posts"."id" AS t0_r0, ... "comments"."updated_at" AS t1_r5 FROM "posts" LEFT OUTER JOIN "comments" ON "comments"."post_id" = "posts"."id" WHERE (comments.visible = 1)
 </ruby>
 
 If there was no +where+ condition, this would generate the normal set of two queries.
diff --git a/railties/guides/source/active_support_core_extensions.textile b/railties/guides/source/active_support_core_extensions.textile
index 788f528654..3ba840c044 100644
--- a/railties/guides/source/active_support_core_extensions.textile
+++ b/railties/guides/source/active_support_core_extensions.textile
@@ -442,6 +442,28 @@ require_library_or_gem('mysql')
 
 NOTE: Defined in +active_support/core_ext/kernel/requires.rb+.
 
+h4. +in?+ and +either?+
+
+The predicate +in?+ tests if an object is included in another object, and the predicate +either?+ tests if an object is included in a list of objects which will be passed as arguments.
+
+Examples of +in?+:
+
+<ruby>
+  1.in?([1,2])        # => true
+  "lo".in?("hello")   # => true
+  25.in?(30..50)      # => false
+</ruby>
+
+Examples of +either?+:
+
+<ruby>
+  1.either?(1,2,3)                      # => true
+  5.either?(1,2,3)                      # => false
+  [1,2,3].either?([1,2,3], 2, [3,4,5])  # => true
+</ruby>
+
+NOTE: Defined in +active_support/core_ext/object/inclusion.rb+.
+
 h3. Extensions to +Module+
 
 h4. +alias_method_chain+
diff --git a/railties/guides/source/getting_started.textile b/railties/guides/source/getting_started.textile
index 1122a4b9e3..5906f953bf 100644
--- a/railties/guides/source/getting_started.textile
+++ b/railties/guides/source/getting_started.textile
@@ -501,8 +501,8 @@ def index
   @posts = Post.all
 
   respond_to do |format|
-    format.html # index.html.erb
-    format.xml  { render :xml => @posts }
+    format.html  # index.html.erb
+    format.json  { render :json => @posts }
   end
 end
 </ruby>
@@ -511,7 +511,7 @@ end
 
 TIP: For more information on finding records with Active Record, see "Active Record Query Interface":active_record_querying.html.
 
-The +respond_to+ block handles both HTML and XML calls to this action. If you browse to "http://localhost:3000/posts.xml":http://localhost:3000/posts.xml, you'll see all of the posts in XML format. The HTML format looks for a view in +app/views/posts/+ with a name that corresponds to the action name. Rails makes all of the instance variables from the action available to the view. Here's +app/views/posts/index.html.erb+:
+The +respond_to+ block handles both HTML and JSON calls to this action. If you browse to "http://localhost:3000/posts.json":http://localhost:3000/posts.json, you'll see a JSON containing all of the posts. The HTML format looks for a view in +app/views/posts/+ with a name that corresponds to the action name. Rails makes all of the instance variables from the action available to the view. Here's +app/views/posts/index.html.erb+:
 
 <erb>
 <h1>Listing posts</h1>
@@ -584,8 +584,8 @@ def new
   @post = Post.new
 
   respond_to do |format|
-    format.html # new.html.erb
-    format.xml  { render :xml => @post }
+    format.html  # new.html.erb
+    format.json  { render :json => @post }
   end
 end
 </ruby>
@@ -653,13 +653,13 @@ def create
 
   respond_to do |format|
     if @post.save
-      format.html { redirect_to(@post,
+      format.html  { redirect_to(@post,
                     :notice => 'Post was successfully created.') }
-      format.xml  { render :xml => @post,
+      format.json  { render :json => @post,
                     :status => :created, :location => @post }
     else
-      format.html { render :action => "new" }
-      format.xml  { render :xml => @post.errors,
+      format.html  { render :action => "new" }
+      format.json  { render :json => @post.errors,
                     :status => :unprocessable_entity }
     end
   end
@@ -681,8 +681,8 @@ def show
   @post = Post.find(params[:id])
 
   respond_to do |format|
-    format.html # show.html.erb
-    format.xml  { render :xml => @post }
+    format.html  # show.html.erb
+    format.json  { render :json => @post }
   end
 end
 </ruby>
@@ -743,12 +743,12 @@ def update
 
   respond_to do |format|
     if @post.update_attributes(params[:post])
-      format.html { redirect_to(@post,
+      format.html  { redirect_to(@post,
                     :notice => 'Post was successfully updated.') }
-      format.xml  { head :ok }
+      format.json  { render :json => {}, :status => :ok }
     else
-      format.html { render :action => "edit" }
-      format.xml  { render :xml => @post.errors,
+      format.html  { render :action => "edit" }
+      format.json  { render :json => @post.errors,
                     :status => :unprocessable_entity }
     end
   end
@@ -767,8 +767,8 @@ def destroy
   @post.destroy
 
   respond_to do |format|
-    format.html { redirect_to(posts_url) }
-    format.xml  { head :ok }
+    format.html  { redirect_to(posts_url) }
+    format.json  { render :json => {}, :status => :ok }
   end
 end
 </ruby>
@@ -1213,7 +1213,7 @@ class PostsController < ApplicationController
   http_basic_authenticate_with :name => "dhh", :password => "secret", :except => :index
 
   # GET /posts
-  # GET /posts.xml
+  # GET /posts.json
   def index
     @posts = Post.all
     respond_to do |format|
@@ -1458,6 +1458,7 @@ Two very common sources of data that are not UTF-8:
 
 h3. Changelog
 
+* April 11, 2011: Changed scaffold_controller generator to create format block for JSON instead of XML "Sebastian Martinez":http://www.wyeworks.com
 * August 30, 2010: Minor editing after Rails 3 release by "Joost Baaij":http://www.spacebabies.nl
 * July 12, 2010: Fixes, editing and updating of code samples by "Jaime Iniesta":http://jaimeiniesta.com
 * May 16, 2010: Added a section on configuration gotchas to address common encoding problems that people might have by "Yehuda Katz":http://www.yehudakatz.com