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

actionpack/lib/action_dispatch/middleware/reloader.rb

 module ActionDispatch
-  # ActionDispatch::Reloader provides to_prepare and to_cleanup callbacks.
-  # These are analogs of ActionDispatch::Callback's before and after
-  # callbacks, with the difference that to_cleanup is not called until the
+  # ActionDispatch::Reloader provides prepare and cleanup callbacks,
+  # intended to assist with code reloading during development.
+  #
+  # Prepare callbacks are run before each request, and cleanup callbacks
+  # after each request. In this respect they are analogs of ActionDispatch::Callback's
+  # before and after callbacks. However, cleanup callbacks are not called until the
   # request is fully complete -- that is, after #close has been called on
-  # the request body. This is important for streaming responses such as the
+  # the response body. This is important for streaming responses such as the
   # following:
   #
   #     self.response_body = lambda { |response, output|
@@ -15,7 +18,10 @@ module ActionDispatch
   # classes before they are unloaded.
   #
   # By default, ActionDispatch::Reloader is included in the middleware stack
-  # only in the development environment.
+  # only in the development environment; specifically, when config.cache_classes
+  # is false. Callbacks may be registered even when it is not included in the
+  # middleware stack, but are executed only when +ActionDispatch::Reloader.prepare!+
+  # or +ActionDispatch::Reloader.cleanup!+ are called manually.
   #
   class Reloader
     include ActiveSupport::Callbacks
@@ -23,8 +29,8 @@ class Reloader
     define_callbacks :prepare, :scope => :name
     define_callbacks :cleanup, :scope => :name
 
-    # Add a preparation callback. Preparation callbacks are run before each
-    # request.
+    # Add a prepare callback. Prepare callbacks are run before each request, prior
+    # to ActionDispatch::Callback's before callbacks.
     def self.to_prepare(*args, &block)
       set_callback(:prepare, *args, &block)
     end
@@ -35,10 +41,12 @@ def self.to_cleanup(*args, &block)
       set_callback(:cleanup, *args, &block)
     end
 
+    # Execute all prepare callbacks.
     def self.prepare!
       new(nil).send(:_run_prepare_callbacks)
     end
 
+    # Execute all cleanup callbacks.
     def self.cleanup!
       new(nil).send(:_run_cleanup_callbacks)
     end

activesupport/lib/active_support/callbacks.rb

@@ -447,6 +447,10 @@ def __update_callbacks(name, filters = [], block = nil) #:nodoc:
       #   set_callback :save, :after,  :after_meth, :if => :condition
       #   set_callback :save, :around, lambda { |r| stuff; yield; stuff }
       #
+      # If the second argument is not :before, :after or :around then an implicit :before is assumed.
+      # It means the first example mentioned above can also be written as:
+      #   set_callback :save, :before_meth
+      #
       # Use skip_callback to skip any defined one.
       #
       # When creating or skipping callbacks, you can specify conditions that

activesupport/lib/active_support/deprecation.rb

@@ -4,7 +4,7 @@
 require 'active_support/deprecation/proxy_wrappers'
 
 module ActiveSupport
-  module Deprecation #:nodoc:
+  module Deprecation
     class << self
       # The version the deprecated behavior will be removed, by default.
       attr_accessor :deprecation_horizon

activesupport/lib/active_support/deprecation/behaviors.rb

@@ -7,10 +7,17 @@ class << self
       # Whether to print a backtrace along with the warning.
       attr_accessor :debug
 
+      # Returns the set behaviour or if one isn't set, defaults to +:stderr+
       def behavior
         @behavior ||= [DEFAULT_BEHAVIORS[:stderr]]
       end
 
+      # Sets the behaviour to the specified value. Can be a single value or an array.
+      #
+      # Examples
+      #
+      #   ActiveSupport::Deprecation.behavior = :stderr
+      #   ActiveSupport::Deprecation.behavior = [:stderr, :log]
       def behavior=(behavior)
         @behavior = Array.wrap(behavior).map { |b| DEFAULT_BEHAVIORS[b] || b }
       end

activesupport/lib/active_support/deprecation/reporting.rb

@@ -2,7 +2,13 @@ module ActiveSupport
   module Deprecation
     class << self
       attr_accessor :silenced
-
+      
+      # Outputs a deprecation warning to the output configured by <tt>ActiveSupport::Deprecation.behavior</tt>
+      #
+      # Example:
+      #
+      #   ActiveSupport::Deprecation.warn("something broke!")
+      #   #=> "DEPRECATION WARNING: something broke! (called from your_code.rb:1)"
       def warn(message = nil, callstack = caller)
         return if silenced
         deprecation_message(callstack, message).tap do |m|

railties/guides/source/action_controller_overview.textile

@@ -368,6 +368,7 @@ class UsersController < ApplicationController
     respond_to do |format|
       format.html # index.html.erb
       format.xml  { render :xml => @users}
+      format.json  { render :json => @users}
     end
   end
 end

railties/guides/source/configuring.textile

@@ -154,7 +154,7 @@ Every Rails application comes with a standard set of middleware which it uses in
 * +Rails::Rack::Logger+ Will notify the logs that the request has began. After request is complete, flushes all the logs.
 * +ActionDispatch::ShowExceptions+ rescues any exception returned by the application and renders nice exception pages if the request is local or if +config.consider_all_requests_local+ is set to _true_. If +config.action_dispatch.show_exceptions+ is set to _false_, exceptions will be raised regardless.
 * +ActionDispatch::RemoteIp+ checks for IP spoofing attacks. Configurable with the +config.action_dispatch.ip_spoofing_check+ and +config.action_dispatch.trusted_proxies+ settings.
-* +Rack::Sendfile+ The Sendfile middleware intercepts responses whose body is being served from a file and replaces it with a server specific X-Sendfile header. Configurable with +config.action_dispatch_
+* +Rack::Sendfile+ The Sendfile middleware intercepts responses whose body is being served from a file and replaces it with a server specific X-Sendfile header. Configurable with +config.action_dispatch.x_sendfile_header+
 * +ActionDispatch::Callbacks+ Runs the prepare callbacks before serving the request.
 * +ActiveRecord::ConnectionAdapters::ConnectionManagement+ cleans active connections after each request, unless the +rack.test+ key in the request environment is set to _true_.
 * +ActiveRecord::QueryCache+ caches all +SELECT+ queries generated in a request. If an +INSERT+ or +UPDATE+ takes place then the cache is cleaned.
@@ -376,8 +376,15 @@ There are a few configuration options available in Active Support:
 
 * +ActiveSupport::Cache::Store.logger+ specifies the logger to use within cache store operations.
 
+* +ActiveSupport::Deprecation.behavior+ alternative setter to +config.active_support.deprecation+ which configures the behavior of deprecation warnings for Rails.
+
+* +ActiveSupport::Deprecation.silence+ takes a block in which all deprecation warnings are silenced.
+
+* +ActiveSupport::Deprecation.silenced+ sets whether or not to display deprecation warnings.
+
 * +ActiveSupport::Logger.silencer+ is set to +false+ to disable the ability to silence logging in a block. The default is +true+.
 
+
 h3. Rails Environment Settings
 
 Some parts of Rails can also be configured externally by supplying environment variables. The following environment variables are recognized by various parts of Rails:
@@ -464,7 +471,7 @@ You might have expected an instance of Array.
 The error occurred while evaluating nil.each
 </plain>
 
-*+active_support.deprecation_behavior+* Sets up deprecation reporting for environments, defaulting to +log+ for development, +notify+ for production and +stderr+ for test. If a value isn't set for +config.active_support.deprecation+ then this initializer will prompt the user to configure this line in the current environment's +config/environments+ file.
+*+active_support.deprecation_behavior+* Sets up deprecation reporting for environments, defaulting to +:log+ for development, +:notify+ for production and +:stderr+ for test. If a value isn't set for +config.active_support.deprecation+ then this initializer will prompt the user to configure this line in the current environment's +config/environments+ file. Can be set to an array of values.
 
 *+active_support.initialize_time_zone+* Sets the default time zone for the application based off the +config.time_zone+ setting, which defaults to "UTC".
 

railties/guides/source/initialization.textile

@@ -520,7 +520,88 @@ h4. +active_support/file_update_checker.rb+
 
 The +ActiveSupport::FileUpdateChecker+ class defined within this file is responsible for checking if a file has been updated since it was last checked. This is used for monitoring the routes file for changes during development environment runs.
 
+h4. +railties/lib/rails/plugin.rb+
 
+This file defines +Rails::Plugin+ which inherits from +Rails::Engine+. Unlike +Rails::Engine+ and +Rails::Railtie+ however, this class is not designed to be inherited from. Instead, this is used simply for loading plugins from within an application and an engine.
+
+This file begins by requiring +rails/engine.rb+
+
+h4. +railties/lib/rails/engine.rb+
+
+The +rails/engine.rb+ file defines the +Rails::Engine+ class which inherits from +Rails::Railtie+. The +Rails::Engine+ class defines much of the functionality found within a standard application class such as the +routes+ and +config+ methods.
+
+The "API documentation":http://api.rubyonrails.org/classes/Rails/Engine.html for +Rails::Engine+ explains the function of this class pretty well.
+
+This file's first line requires +rails/railtie.rb+.
+
+h4. +railties/lib/rails/railtie.rb+
+
+The +rails/railtie.rb+ file is responsible for defining +Rails::Railtie+, the underlying class for all ties to Rails now. Gems that want to have their own initializers or rake tasks and hook into Rails should have a +GemName::Railtie+ class that inherits from +Rails::Railtie+.
+
+The "API documentation":http://api.rubyonrails.org/classes/Rails/Railtie.html for +Rails::Railtie+, much like +Rails::Engine+, explains this class exceptionally well.
+
+The first require in this file is +rails/initializable.rb+.
+
+h4. +railties/lib/rails/initializable.rb+
+
+Now we reach the end of this particular rabbit hole as +rails/initializable.rb+ doesn't require any more Rails files, only +tsort+ from the Ruby standard library.
+
+This file defines the +Rails::Initializable+ module which contains the +Initializer+ class, the basis for all initializers in Rails. This module also contains a +ClassMethods+ class which will be included into the +Rails::Railtie+ class when these requires have finished.
+
+Now that +rails/initializable.rb+ has finished being required from +rails/railtie.rb+, the next require is for +rails/configuration+.
+
+h4. +railties/lib/rails/configuration.rb+
+
+This file defines the +Rails::Configuration+ module, containing the +MiddlewareStackProxy+ class as well as the +Generators+ class. The +MiddlewareStackProxy+ class is used for managing the middleware stack for an application, which we'll see later on. The +Generators+ class provides the functionality used for configuring what generators an application uses through the "+config.generators+ option":http://guides.rubyonrails.org/configuring.html#configuring-generators.
+
+The first file required in this file is +activesupport/deprecation+.
+
+h4. +activesupport/lib/active_support/deprecation.rb+
+
+This file, and the files it requires, define the basic deprecation warning features found in Rails. This file is responsible for setting defaults in the +ActiveSupport::Deprecation+ module for the +deprecation_horizon+, +silenced+ and +debug+ values. The files that are required before this happens are:
+
+* +active_support/deprecation/behaviors+
+* +active_support/deprecation/reporting+
+* +active_support/deprecation/method_wrappers+
+* +active_support/deprecation/proxy_wrappers+
+
+h4. +activesupport/lib/active_support/deprecation/behaviors.rb+
+
+This file defines the behavior of the +ActiveSupport::Deprecation+ module, setting up the +DEFAULT_BEHAVIORS+ hash constant which contains the three defaults to outputting deprecation warnings: +:stderr+, +:log+ and +:notify+. This file begins by requiring +activesupport/notifications+ and +activesupport/core_ext/array/wrap+.
+
+h4 +activesupport/lib/active_support/notifications.rb+
+
+TODO: document +ActiveSupport::Notifications+.
+
+h4. +activesupport/core_ext/array/wrap+
+
+As this file comprises of a core extension, it is covered exclusively in "the Active Support Core Extensions guide":http://guides.rubyonrails.org/active_support_core_extensions.html#wrapping
+
+h4. +activesupport/lib/active_support/deprecation/reporting.rb+
+
+This file is responsible for defining the +warn+ and +silence+ methods for +ActiveSupport::Deprecation+ as well as additional private methods for this module.
+
+h4. +activesupport/lib/active_support/deprecation/method_wrappers.rb+
+
+This file defines a +deprecate_methods+ which is primarily used by the +module/deprecation+ core extension required by the first line of this file. Other core extensions required by this file are the +module/aliasing+ and +array/extract_options+ files.
+
+h4. +activesupport/lib/active_support/deprecation/proxy_wrappers.rb+
+
++proxy_wrappers.rb+ defines deprecation wrappers for methods, instance variables and constants. Previously, this was used for the +RAILS_ENV+ and +RAILS_ROOT+ constants for 3.0 but since then these constants have been removed. The deprecation message that would be raised from these would be something like:
+
+<plain>
+  BadConstant is deprecated! Use GoodConstant instead.
+</plain>
+
+h4. +active_support/ordered_options+
+
+This file is the next file required from +rails/configuration.rb+ is the file that defines +ActiveSupport::OrderedOptions+ which is used for configuration options such as +config.active_support+ and the like.
+
+The next file required is +active_support/core_ext/hash/deep_dup+ which is covered in "Active Support Core Extensions guide":http://guides.rubyonrails.org/active_support_core_extensions.html#deep_dup
+
+The file after that is +rails/paths+
+
+h4. +railties/lib/rails/paths.rb+
 
 
 

railties/guides/source/nested_model_forms.textile

 h2. Rails nested model forms
 
-Creating a form for a model _and_ its associations can become quite tedious. Therefor Rails provides helpers to assist in dealing with the complexities of generating these forms _and_ the required CRUD operations to create, update, and destroy associations.
+Creating a form for a model _and_ its associations can become quite tedious. Therefore Rails provides helpers to assist in dealing with the complexities of generating these forms _and_ the required CRUD operations to create, update, and destroy associations.
 
 In this guide you will:
 
@@ -219,4 +219,4 @@ You can basically see the +projects_attributes+ hash as an array of attribute ha
 
 NOTE: The reason that +fields_for+ constructed a form which would result in a hash instead of an array is that it won't work for any forms nested deeper than one level deep.
 
-TIP: You _can_ however pass an array to the writer method generated by +accepts_nested_attributes_for+ if you're using plain Ruby or some other API access. See (TODO) for more info and example.
\ No newline at end of file
+TIP: You _can_ however pass an array to the writer method generated by +accepts_nested_attributes_for+ if you're using plain Ruby or some other API access. See (TODO) for more info and example.

railties/guides/source/rails_on_rack.textile

@@ -17,12 +17,7 @@ bq. Rack provides a minimal, modular and adaptable interface for developing web
 
 - "Rack API Documentation":http://rack.rubyforge.org/doc/
 
-Explaining Rack is not really in the scope of this guide. In case you are not familiar with Rack's basics, you should check out the following links:
-
-* "Official Rack Website":http://rack.github.com
-* "Introducing Rack":http://chneukirchen.org/blog/archive/2007/02/introducing-rack.html
-* "Ruby on Rack #1 - Hello Rack!":http://m.onkey.org/2008/11/17/ruby-on-rack-1
-* "Ruby on Rack #2 - The Builder":http://m.onkey.org/2008/11/18/ruby-on-rack-2-rack-builder
+Explaining Rack is not really in the scope of this guide. In case you are not familiar with Rack's basics, you should check out the "Resources":#resources section below.
 
 h3. Rails on Rack
 
@@ -165,7 +160,7 @@ Much of Action Controller's functionality is implemented as Middlewares. The fol
 |_.Middleware|_.Purpose|
 |+Rack::Lock+|Sets +env["rack.multithread"]+ flag to +true+ and wraps the application within a Mutex.|
 |+ActionController::Failsafe+|Returns HTTP Status +500+ to the client if an exception gets raised while dispatching.|
-|+ActiveRecord::QueryCache+|Enable the Active Record query cache.|
+|+ActiveRecord::QueryCache+|Enables the Active Record query cache.|
 |+ActionController::Session::CookieStore+|Uses the cookie based session store.|
 |+ActionController::Session::MemCacheStore+|Uses the memcached based session store.|
 |+ActiveRecord::SessionStore+|Uses the database based session store.|