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

Author: fxn

actionmailer/README.rdoc

@@ -32,7 +32,7 @@ This can be as simple as:
   end
 
 The body of the email is created by using an Action View template (regular
-ERb) that has the instance variables that are declared in the mailer action.
+ERB) that has the instance variables that are declared in the mailer action.
 
 So the corresponding body template for the method above could look like this:
 

actionpack/README.rdoc

@@ -19,7 +19,7 @@ It consists of several modules:
 
 * Action View, which handles view template lookup and rendering, and provides
   view helpers that assist when building HTML forms, Atom feeds and more.
-  Template formats that Action View handles are ERb (embedded Ruby, typically
+  Template formats that Action View handles are ERB (embedded Ruby, typically
   used to inline short Ruby snippets inside HTML), XML Builder and RJS
   (dynamically generated JavaScript from Ruby code).
 
@@ -57,7 +57,7 @@ A short rundown of some of the major features:
   {Learn more}[link:classes/ActionController/Base.html]
 
 
-* ERb templates (static content mixed with dynamic output from ruby)
+* ERB templates (static content mixed with dynamic output from ruby)
 
     <% for post in @posts %>
       Title: <%= post.title %>

actionpack/lib/action_controller/base.rb

@@ -105,7 +105,7 @@ module ActionController
   # == Renders
   #
   # Action Controller sends content to the user by using one of five rendering methods. The most versatile and common is the rendering
-  # of a template. Included in the Action Pack is the Action View, which enables rendering of ERb templates. It's automatically configured.
+  # of a template. Included in the Action Pack is the Action View, which enables rendering of ERB templates. It's automatically configured.
   # The controller passes objects to the view by assigning instance variables:
   #
   #   def show
@@ -128,7 +128,7 @@ module ActionController
   #     end
   #   end
   #
-  # Read more about writing ERb and Builder templates in ActionView::Base.
+  # Read more about writing ERB and Builder templates in ActionView::Base.
   #
   # == Redirects
   #

actionpack/lib/action_controller/metal.rb

@@ -201,19 +201,23 @@ def to_a #:nodoc:
     class_attribute :middleware_stack
     self.middleware_stack = ActionController::MiddlewareStack.new
 
-    def self.inherited(base)
+    def self.inherited(base) #nodoc:
       base.middleware_stack = self.middleware_stack.dup
       super
     end
 
+    # Adds given middleware class and its args to bottom of middleware_stack
     def self.use(*args, &block)
       middleware_stack.use(*args, &block)
     end
 
+    # Alias for middleware_stack
     def self.middleware
       middleware_stack
     end
 
+    # Makes the controller a rack endpoint that points to the action in
+    # the given env's action_dispatch.request.path_parameters key.
     def self.call(env)
       action(env['action_dispatch.request.path_parameters'][:action]).call(env)
     end

actionpack/lib/action_controller/metal/http_authentication.rb

@@ -67,7 +67,7 @@ module HttpAuthentication
     #   class PostsController < ApplicationController
     #     REALM = "SuperSecret"
     #     USERS = {"dhh" => "secret", #plain text password
-    #              "dap" => Digest:MD5::hexdigest(["dap",REALM,"secret"].join(":"))  #ha1 digest password
+    #              "dap" => Digest::MD5.hexdigest(["dap",REALM,"secret"].join(":"))  #ha1 digest password
     #
     #     before_filter :authenticate, :except => [:index]
     #

actionpack/lib/action_controller/metal/mime_responds.rb

@@ -222,6 +222,9 @@ def respond_to(*mimes, &block)
     # is quite simple (it just needs to respond to call), you can even give
     # a proc to it.
     #
+    # In order to use respond_with, first you need to declare the formats your
+    # controller responds to in the class level with a call to <tt>respond_to</tt>.
+    #
     def respond_with(*resources, &block)
       raise "In order to use respond_with, first you need to declare the formats your " <<
             "controller responds to in the class level" if self.class.mimes_for_respond_to.empty?

actionpack/lib/action_dispatch/testing/integration.rb

@@ -26,31 +26,31 @@ module RequestHelpers
       # object's <tt>@response</tt> instance variable will point to the same
       # response object.
       #
-      # You can also perform POST, PUT, DELETE, and HEAD requests with +post+,
-      # +put+, +delete+, and +head+.
+      # You can also perform POST, PUT, DELETE, and HEAD requests with +#post+,
+      # +#put+, +#delete+, and +#head+.
       def get(path, parameters = nil, headers = nil)
         process :get, path, parameters, headers
       end
 
-      # Performs a POST request with the given parameters. See get() for more
+      # Performs a POST request with the given parameters. See +#get+ for more
       # details.
       def post(path, parameters = nil, headers = nil)
         process :post, path, parameters, headers
       end
 
-      # Performs a PUT request with the given parameters. See get() for more
+      # Performs a PUT request with the given parameters. See +#get+ for more
       # details.
       def put(path, parameters = nil, headers = nil)
         process :put, path, parameters, headers
       end
 
-      # Performs a DELETE request with the given parameters. See get() for
+      # Performs a DELETE request with the given parameters. See +#get+ for
       # more details.
       def delete(path, parameters = nil, headers = nil)
         process :delete, path, parameters, headers
       end
 
-      # Performs a HEAD request with the given parameters. See get() for more
+      # Performs a HEAD request with the given parameters. See +#get+ for more
       # details.
       def head(path, parameters = nil, headers = nil)
         process :head, path, parameters, headers
@@ -59,7 +59,7 @@ def head(path, parameters = nil, headers = nil)
       # Performs an XMLHttpRequest request with the given parameters, mirroring
       # a request from the Prototype library.
       #
-      # The request_method is :get, :post, :put, :delete or :head; the
+      # The request_method is +:get+, +:post+, +:put+, +:delete+ or +:head+; the
       # parameters are +nil+, a hash, or a url-encoded or multipart string;
       # the headers are a hash.  Keys are automatically upcased and prefixed
       # with 'HTTP_' if not already.
@@ -384,7 +384,7 @@ def integration_session
     end
   end
 
-  # An test that spans multiple controllers and actions,
+  # An integration test spans multiple controllers and actions,
   # tying them all together to ensure they work together as expected. It tests
   # more completely than either unit or functional tests do, exercising the
   # entire stack, from the dispatcher to the database.

actionpack/lib/action_view/base.rb

@@ -8,13 +8,13 @@
 module ActionView #:nodoc:
   # = Action View Base
   #
-  # Action View templates can be written in three ways. If the template file has a <tt>.erb</tt> (or <tt>.rhtml</tt>) extension then it uses a mixture of ERb
+  # Action View templates can be written in three ways. If the template file has a <tt>.erb</tt> (or <tt>.rhtml</tt>) extension then it uses a mixture of ERB
   # (included in Ruby) and HTML. If the template file has a <tt>.builder</tt> (or <tt>.rxml</tt>) extension then Jim Weirich's Builder::XmlMarkup library is used.
   # If the template file has a <tt>.rjs</tt> extension then it will use ActionView::Helpers::PrototypeHelper::JavaScriptGenerator.
   #
-  # == ERb
+  # == ERB
   #
-  # You trigger ERb by using embeddings such as <% %>, <% -%>, and <%= %>. The <%= %> tag set is used when you want output. Consider the
+  # You trigger ERB by using embeddings such as <% %>, <% -%>, and <%= %>. The <%= %> tag set is used when you want output. Consider the
   # following loop for names:
   #
   #   <b>Names of all the people</b>
@@ -23,7 +23,7 @@ module ActionView #:nodoc:
   #   <% end %>
   #
   # The loop is setup in regular embedding tags <% %> and the name is written using the output embedding tag <%= %>. Note that this
-  # is not just a usage suggestion. Regular output functions like print or puts won't work with ERb templates. So this would be wrong:
+  # is not just a usage suggestion. Regular output functions like print or puts won't work with ERB templates. So this would be wrong:
   #
   #   <%# WRONG %>
   #   Hi, Mr. <% puts "Frodo" %>
@@ -81,7 +81,7 @@ module ActionView #:nodoc:
   #
   # == Builder
   #
-  # Builder templates are a more programmatic alternative to ERb. They are especially useful for generating XML content. An XmlMarkup object
+  # Builder templates are a more programmatic alternative to ERB. They are especially useful for generating XML content. An XmlMarkup object
   # named +xml+ is automatically made available to templates with a <tt>.builder</tt> extension.
   #
   # Here are some basic examples:

actionpack/lib/action_view/helpers/atom_feed_helper.rb

@@ -4,7 +4,7 @@ module ActionView
   # = Action View Atom Feed Helpers
   module Helpers #:nodoc:
     module AtomFeedHelper
-      # Adds easy defaults to writing Atom feeds with the Builder template engine (this does not work on ERb or any other
+      # Adds easy defaults to writing Atom feeds with the Builder template engine (this does not work on ERB or any other
       # template languages).
       #
       # Full usage example:

actionpack/lib/action_view/helpers/capture_helper.rb

@@ -14,7 +14,7 @@ module CaptureHelper
       # variable. You can then use this variable anywhere in your templates or layout.
       #
       # ==== Examples
-      # The capture method can be used in ERb templates...
+      # The capture method can be used in ERB templates...
       #
       #   <% @greeting = capture do %>
       #     Welcome to my shiny new web page!  The date and time is

actionpack/lib/action_view/helpers/prototype_helper.rb

@@ -584,7 +584,7 @@ def update_page(&block)
 
       # Works like update_page but wraps the generated JavaScript in a
       # <tt>\<script></tt> tag. Use this to include generated JavaScript in an
-      # ERb template. See JavaScriptGenerator for more information.
+      # ERB template. See JavaScriptGenerator for more information.
       #
       # +html_options+ may be a hash of <tt>\<script></tt> attributes to be
       # passed to ActionView::Helpers::JavaScriptHelper#javascript_tag.

actionpack/lib/action_view/helpers/url_helper.rb

@@ -183,7 +183,7 @@ def url_for(options = {})
       #   link_to "Profiles", :controller => "profiles"
       #   # => <a href="/profiles">Profiles</a>
       #
-      # You can use a block as well if your link target is hard to fit into the name parameter. ERb example:
+      # You can use a block as well if your link target is hard to fit into the name parameter. ERB example:
       #
       #   <%= link_to(@profile) do %>
       #     <strong><%= @profile.name %></strong> -- <span>Check it out!</span>

actionpack/lib/action_view/template/handlers/erb.rb

@@ -55,7 +55,7 @@ def add_postamble(src)
 
       class ERB
         # Specify trim mode for the ERB compiler. Defaults to '-'.
-        # See ERb documentation for suitable values.
+        # See ERB documentation for suitable values.
         class_attribute :erb_trim_mode
         self.erb_trim_mode = '-'
 

activemodel/lib/active_model/errors.rb

@@ -278,19 +278,18 @@ def full_messages
     # When using inheritance in your models, it will check all the inherited
     # models too, but only if the model itself hasn't been found. Say you have
     # <tt>class Admin < User; end</tt> and you wanted the translation for
-    # the <tt>:blank</tt> error +message+ for the <tt>title</tt> +attribute+,
+    # the <tt>:blank</tt> error message for the <tt>title</tt> attribute,
     # it looks for these translations:
     #
-    # <ol>
-    # <li><tt>activemodel.errors.models.admin.attributes.title.blank</tt></li>
-    # <li><tt>activemodel.errors.models.admin.blank</tt></li>
-    # <li><tt>activemodel.errors.models.user.attributes.title.blank</tt></li>
-    # <li><tt>activemodel.errors.models.user.blank</tt></li>
-    # <li>any default you provided through the +options+ hash (in the activemodel.errors scope)</li>
-    # <li><tt>activemodel.errors.messages.blank</tt></li>
-    # <li><tt>errors.attributes.title.blank</tt></li>
-    # <li><tt>errors.messages.blank</tt></li>
-    # </ol>
+    # * <tt>activemodel.errors.models.admin.attributes.title.blank</tt>
+    # * <tt>activemodel.errors.models.admin.blank</tt>
+    # * <tt>activemodel.errors.models.user.attributes.title.blank</tt>
+    # * <tt>activemodel.errors.models.user.blank</tt>
+    # * any default you provided through the +options+ hash (in the <tt>activemodel.errors</tt> scope)
+    # * <tt>activemodel.errors.messages.blank</tt>
+    # * <tt>errors.attributes.title.blank</tt>
+    # * <tt>errors.messages.blank</tt>
+    #
     def generate_message(attribute, type = :invalid, options = {})
       type = options.delete(:message) if options[:message].is_a?(Symbol)
 

activerecord/lib/active_record/callbacks.rb

@@ -214,6 +214,24 @@ module ActiveRecord
   # needs to be aware of it because an ordinary +save+ will raise such exception
   # instead of quietly returning +false+.
   #
+  # == Debugging callbacks
+  # 
+  # The callback chain is accessible via the <tt>_*_callbacks</tt> method on an object. ActiveModel Callbacks support 
+  # <tt>:before</tt>, <tt>:after</tt> and <tt>:around</tt> as values for the <tt>kind</tt> property. The <tt>kind</tt> property
+  # defines what part of the chain the callback runs in.
+  # 
+  # To find all callbacks in the before_save callback chain: 
+  # 
+  #   Topic._save_callbacks.select { |cb| cb.kind.eql?(:before) }
+  # 
+  # Returns an array of callback objects that form the before_save chain.
+  # 
+  # To further check if the before_save chain contains a proc defined as <tt>rest_when_dead</tt> use the <tt>filter</tt> property of the callback object:
+  # 
+  #   Topic._save_callbacks.select { |cb| cb.kind.eql?(:before) }.collect(&:filter).include?(:rest_when_dead)
+  # 
+  # Returns true or false depending on whether the proc is contained in the before_save callback chain on a Topic model.
+  # 
   module Callbacks
     extend ActiveSupport::Concern
 

activerecord/lib/active_record/fixtures.rb

@@ -173,10 +173,10 @@ class FixturesFileNotFound < StandardError; end
 # traversed in the database to create the fixture hash and/or instance variables. This is expensive for
 # large sets of fixtured data.
 #
-# = Dynamic fixtures with ERb
+# = Dynamic fixtures with ERB
 #
 # Some times you don't care about the content of the fixtures as much as you care about the volume. In these cases, you can
-# mix ERb in with your YAML or CSV fixtures to create a bunch of fixtures for load testing, like:
+# mix ERB in with your YAML or CSV fixtures to create a bunch of fixtures for load testing, like:
 #
 #   <% for i in 1..1000 %>
 #   fix_<%= i %>:
@@ -186,7 +186,7 @@ class FixturesFileNotFound < StandardError; end
 #
 # This will create 1000 very simple YAML fixtures.
 #
-# Using ERb, you can also inject dynamic values into your fixtures with inserts like <tt><%= Date.today.strftime("%Y-%m-%d") %></tt>.
+# Using ERB, you can also inject dynamic values into your fixtures with inserts like <tt><%= Date.today.strftime("%Y-%m-%d") %></tt>.
 # This is however a feature to be used with some caution. The point of fixtures are that they're
 # stable units of predictable sample data. If you feel that you need to inject dynamic values, then
 # perhaps you should reexamine whether your application is properly testable. Hence, dynamic values

activerecord/lib/active_record/named_scope.rb

@@ -99,6 +99,29 @@ def scoped(options = nil)
       #
       #   Article.published.new.published    # => true
       #   Article.published.create.published # => true
+      #
+      # Class methods on your model are automatically available
+      # on scopes. Assuming the following setup:
+      #
+      #   class Article < ActiveRecord::Base
+      #     scope :published, where(:published => true)
+      #     scope :featured, where(:featured => true)
+      #
+      #     def self.latest_article
+      #       order('published_at desc').first
+      #     end
+      #
+      #     def self.titles
+      #       map(&:title)
+      #     end
+      #
+      #   end
+      #
+      # We are able to call the methods like this:
+      #
+      #   Article.published.featured.latest_article
+      #   Article.featured.titles
+
       def scope(name, scope_options = {})
         name = name.to_sym
         valid_scope_name?(name)

activesupport/lib/active_support/core_ext/string/output_safety.rb

@@ -9,7 +9,7 @@ module Util
     # A utility method for escaping HTML tag characters.
     # This method is also aliased as <tt>h</tt>.
     #
-    # In your ERb templates, use this method to escape any unsafe content. For example:
+    # In your ERB templates, use this method to escape any unsafe content. For example:
     #   <%=h @person.name %>
     #
     # ==== Example:

railties/guides/source/action_controller_overview.textile

@@ -615,26 +615,15 @@ Rails comes with two built-in HTTP authentication mechanisms:
 
 h4. HTTP Basic Authentication
 
-HTTP basic authentication is an authentication scheme that is supported by the majority of browsers and other HTTP clients. As an example, consider an administration section which will only be available by entering a username and a password into the browser's HTTP basic dialog window. Using the built-in authentication is quite easy and only requires you to use one method, +authenticate_or_request_with_http_basic+.
+HTTP basic authentication is an authentication scheme that is supported by the majority of browsers and other HTTP clients. As an example, consider an administration section which will only be available by entering a username and a password into the browser's HTTP basic dialog window. Using the built-in authentication is quite easy and only requires you to use one method, +http_basic_authenticate_with+.
 
 <ruby>
 class AdminController < ApplicationController
-  USERNAME, PASSWORD = "humbaba", "5baa61e4"
-
-  before_filter :authenticate
-
-  private
-
-  def authenticate
-    authenticate_or_request_with_http_basic do |username, password|
-      username == USERNAME &&
-      Digest::SHA1.hexdigest(password) == PASSWORD
-    end
-  end
+  http_basic_authenticate_with :name => "humbaba", :password => "5baa61e4"
 end
 </ruby>
 
-With this in place, you can create namespaced controllers that inherit from +AdminController+. The before filter will thus be run for all actions in those controllers, protecting them with HTTP basic authentication.
+With this in place, you can create namespaced controllers that inherit from +AdminController+. The filter will thus be run for all actions in those controllers, protecting them with HTTP basic authentication.
 
 h4. HTTP Digest Authentication
 

railties/guides/source/action_view_overview.textile

@@ -1295,7 +1295,7 @@ end
 
 h5. update_page_tag
 
-Works like update_page but wraps the generated JavaScript in a +script+ tag. Use this to include generated JavaScript in an ERb template.
+Works like update_page but wraps the generated JavaScript in a +script+ tag. Use this to include generated JavaScript in an ERB template.
 
 h4. PrototypeHelper::JavaScriptGenerator::GeneratorMethods
 

railties/guides/source/api_documentation_guidelines.textile

@@ -29,7 +29,7 @@ Documentation has to be concise but comprehensive. Explore and document edge cas
 
 The proper names of Rails components have a space in between the words, like "Active Support". +ActiveRecord+ is a Ruby module, whereas Active Record is an ORM. All Rails documentation should consistently refer to Rails components by their proper name, and if in your next blog post or presentation you remember this tidbit and take it into account that'd be phenomenal.
 
-Spell names correctly: Arel, Test::Unit, RSpec, HTML, MySQL, JavaScript, ERb. When in doubt, please have a look at some authoritative source like their official documentation.
+Spell names correctly: Arel, Test::Unit, RSpec, HTML, MySQL, JavaScript, ERB. When in doubt, please have a look at some authoritative source like their official documentation.
 
 Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database".
 

railties/guides/source/command_line.textile

@@ -484,7 +484,7 @@ end
 We take whatever args are supplied, save them to an instance variable, and literally copying from the Rails source, implement a +manifest+ method, which calls +record+ with a block, and we:
 
 * Check there's a *public* directory. You bet there is.
-* Run the ERb template called "tutorial.erb".
+* Run the ERB template called "tutorial.erb".
 * Save it into "Rails.root/public/tutorial.txt".
 * Pass in the arguments we saved through the +:assigns+ parameter.