mirror of https://github.com/rails/rails
Merge branch 'master' of github.com:lifo/docrails
Conflicts: RELEASING_RAILS.rdoc actionpack/lib/sprockets/railtie.rb actionpack/test/template/sprockets_helper_test.rb activerecord/test/cases/calculations_test.rb railties/guides/source/3_1_release_notes.textile railties/guides/source/active_resource_basics.textile railties/guides/source/command_line.textile
This commit is contained in:
Xavier Noria
commit
bf2b9d2de3
|
|
@ -30,7 +30,7 @@ Do not release with Red AWDwR tests.
|
|||
Having git dependencies indicates that we depend on unreleased code.
|
||||
Obviously rails cannot be released when it depends on unreleased code.
|
||||
Contact the authors of those particular gems and work out a release date that
|
||||
suites them.
|
||||
suits them.
|
||||
|
||||
=== Contact the security team (either Koz or tenderlove)
|
||||
|
||||
|
|
|
|||
|
|
@ -135,7 +135,7 @@ The Base class has the full list of configuration options. Here's an example:
|
|||
|
||||
== Download and installation
|
||||
|
||||
The latest version of Action Mailer can be installed with Rubygems:
|
||||
The latest version of Action Mailer can be installed with RubyGems:
|
||||
|
||||
% [sudo] gem install actionmailer
|
||||
|
||||
|
|
|
|||
|
|
@ -283,7 +283,7 @@ methods:
|
|||
|
||||
The last two lines are responsible for telling ActionController where the
|
||||
template files are located and actually running the controller on a new
|
||||
request from the web-server (like to be Apache).
|
||||
request from the web-server (e.g., Apache).
|
||||
|
||||
And the templates look like this:
|
||||
|
||||
|
|
@ -316,7 +316,7 @@ an URL such as /weblog/5 (where 5 is the id of the post).
|
|||
|
||||
== Download and installation
|
||||
|
||||
The latest version of Action Pack can be installed with Rubygems:
|
||||
The latest version of Action Pack can be installed with RubyGems:
|
||||
|
||||
% [sudo] gem install actionpack
|
||||
|
||||
|
|
|
|||
|
|
@ -75,38 +75,122 @@ module AbstractController
|
|||
end
|
||||
end
|
||||
|
||||
##
|
||||
# :method: before_filter
|
||||
#
|
||||
# :call-seq: before_filter(names, block)
|
||||
#
|
||||
# Append a before filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: prepend_before_filter
|
||||
#
|
||||
# :call-seq: prepend_before_filter(names, block)
|
||||
#
|
||||
# Prepend a before filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: skip_before_filter
|
||||
#
|
||||
# :call-seq: skip_before_filter(names, block)
|
||||
#
|
||||
# Skip a before filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: append_before_filter
|
||||
#
|
||||
# :call-seq: append_before_filter(names, block)
|
||||
#
|
||||
# Append a before filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: after_filter
|
||||
#
|
||||
# :call-seq: after_filter(names, block)
|
||||
#
|
||||
# Append an after filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: prepend_after_filter
|
||||
#
|
||||
# :call-seq: prepend_after_filter(names, block)
|
||||
#
|
||||
# Prepend an after filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: skip_after_filter
|
||||
#
|
||||
# :call-seq: skip_after_filter(names, block)
|
||||
#
|
||||
# Skip an after filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: append_after_filter
|
||||
#
|
||||
# :call-seq: append_after_filter(names, block)
|
||||
#
|
||||
# Append an after filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: around_filter
|
||||
#
|
||||
# :call-seq: around_filter(names, block)
|
||||
#
|
||||
# Append an around filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: prepend_around_filter
|
||||
#
|
||||
# :call-seq: prepend_around_filter(names, block)
|
||||
#
|
||||
# Prepend an around filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: skip_around_filter
|
||||
#
|
||||
# :call-seq: skip_around_filter(names, block)
|
||||
#
|
||||
# Skip an around filter. See _insert_callbacks for parameter details.
|
||||
|
||||
##
|
||||
# :method: append_around_filter
|
||||
#
|
||||
# :call-seq: append_around_filter(names, block)
|
||||
#
|
||||
# Append an around filter. See _insert_callbacks for parameter details.
|
||||
|
||||
# set up before_filter, prepend_before_filter, skip_before_filter, etc.
|
||||
# for each of before, after, and around.
|
||||
[:before, :after, :around].each do |filter|
|
||||
class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
|
||||
# Append a before, after or around filter. See _insert_callbacks
|
||||
# for details on the allowed parameters.
|
||||
def #{filter}_filter(*names, &blk)
|
||||
_insert_callbacks(names, blk) do |name, options|
|
||||
options[:if] = (Array.wrap(options[:if]) << "!halted") if #{filter == :after}
|
||||
set_callback(:process_action, :#{filter}, name, options)
|
||||
end
|
||||
end
|
||||
def #{filter}_filter(*names, &blk) # def before_filter(*names, &blk)
|
||||
_insert_callbacks(names, blk) do |name, options| # _insert_callbacks(names, blk) do |name, options|
|
||||
options[:if] = (Array.wrap(options[:if]) << "!halted") if #{filter == :after} # options[:if] = (Array.wrap(options[:if]) << "!halted") if false
|
||||
set_callback(:process_action, :#{filter}, name, options) # set_callback(:process_action, :before, name, options)
|
||||
end # end
|
||||
end # end
|
||||
|
||||
# Prepend a before, after or around filter. See _insert_callbacks
|
||||
# for details on the allowed parameters.
|
||||
def prepend_#{filter}_filter(*names, &blk)
|
||||
_insert_callbacks(names, blk) do |name, options|
|
||||
options[:if] = (Array.wrap(options[:if]) << "!halted") if #{filter == :after}
|
||||
set_callback(:process_action, :#{filter}, name, options.merge(:prepend => true))
|
||||
end
|
||||
end
|
||||
def prepend_#{filter}_filter(*names, &blk) # def prepend_before_filter(*names, &blk)
|
||||
_insert_callbacks(names, blk) do |name, options| # _insert_callbacks(names, blk) do |name, options|
|
||||
options[:if] = (Array.wrap(options[:if]) << "!halted") if #{filter == :after} # options[:if] = (Array.wrap(options[:if]) << "!halted") if false
|
||||
set_callback(:process_action, :#{filter}, name, options.merge(:prepend => true)) # set_callback(:process_action, :#{filter}, name, options.merge(:prepend => true))
|
||||
end # end
|
||||
end # end
|
||||
|
||||
# Skip a before, after or around filter. See _insert_callbacks
|
||||
# for details on the allowed parameters.
|
||||
def skip_#{filter}_filter(*names, &blk)
|
||||
_insert_callbacks(names, blk) do |name, options|
|
||||
skip_callback(:process_action, :#{filter}, name, options)
|
||||
end
|
||||
end
|
||||
def skip_#{filter}_filter(*names, &blk) # def skip_before_filter(*names, &blk)
|
||||
_insert_callbacks(names, blk) do |name, options| # _insert_callbacks(names, blk) do |name, options|
|
||||
skip_callback(:process_action, :#{filter}, name, options) # skip_callback(:process_action, :#{filter}, name, options)
|
||||
end # end
|
||||
end # end
|
||||
|
||||
# *_filter is the same as append_*_filter
|
||||
alias_method :append_#{filter}_filter, :#{filter}_filter
|
||||
alias_method :append_#{filter}_filter, :#{filter}_filter # alias_method :append_before_filter, :before_filter
|
||||
RUBY_EVAL
|
||||
end
|
||||
end
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ module ActionController #:nodoc:
|
|||
# <tt>:action => 'lists'</tt> is not the same as
|
||||
# <tt>:action => 'list', :format => :xml</tt>.
|
||||
#
|
||||
# You can set modify the default action cache path by passing a
|
||||
# You can modify the default action cache path by passing a
|
||||
# <tt>:cache_path</tt> option. This will be passed directly to
|
||||
# <tt>ActionCachePath.path_for</tt>. This is handy for actions with
|
||||
# multiple possible routes that should be cached differently. If a
|
||||
|
|
|
|||
|
|
@ -186,7 +186,7 @@ modules:
|
|||
|
||||
== Download and installation
|
||||
|
||||
The latest version of Active Model can be installed with Rubygems:
|
||||
The latest version of Active Model can be installed with RubyGems:
|
||||
|
||||
% [sudo] gem install activemodel
|
||||
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ module ActiveModel
|
|||
#
|
||||
# The last three methods are required in your object for Errors to be
|
||||
# able to generate error messages correctly and also handle multiple
|
||||
# languages. Of course, if you extend your object with ActiveModel::Translations
|
||||
# languages. Of course, if you extend your object with ActiveModel::Translation
|
||||
# you will not need to implement the last two. Likewise, using
|
||||
# ActiveModel::Validations will handle the validation related methods
|
||||
# for you.
|
||||
|
|
|
|||
|
|
@ -197,7 +197,7 @@ Admit the Database:
|
|||
|
||||
== Download and installation
|
||||
|
||||
The latest version of Active Record can be installed with Rubygems:
|
||||
The latest version of Active Record can be installed with RubyGems:
|
||||
|
||||
% [sudo] gem install activerecord
|
||||
|
||||
|
|
|
|||
|
|
@ -177,6 +177,10 @@ module ActiveRecord #:nodoc:
|
|||
# And instead of writing <tt>Person.where(:last_name => last_name).all</tt>, you just do
|
||||
# <tt>Person.find_all_by_last_name(last_name)</tt>.
|
||||
#
|
||||
# It's possible to add an exclamation point (!) on the end of the dynamic finders to get them to raise an
|
||||
# <tt>ActiveRecord::RecordNotFound</tt> error if they do not return any records,
|
||||
# like <tt>Person.find_by_last_name!</tt>.
|
||||
#
|
||||
# It's also possible to use multiple attributes in the same find by separating them with "_and_".
|
||||
#
|
||||
# Person.where(:user_name => user_name, :password => password).first
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ received and serialized into a usable Ruby object.
|
|||
|
||||
== Download and installation
|
||||
|
||||
The latest version of Active Support can be installed with Rubygems:
|
||||
The latest version of Active Support can be installed with RubyGems:
|
||||
|
||||
% [sudo] gem install activeresource
|
||||
|
||||
|
|
@ -135,8 +135,8 @@ as the id of the ARes object.
|
|||
|
||||
==== Update
|
||||
|
||||
'save' is also used to update an existing resource - and follows the same protocol as creating a resource
|
||||
with the exception that no response headers are needed - just an empty response when the update on the
|
||||
'save' is also used to update an existing resource and follows the same protocol as creating a resource
|
||||
with the exception that no response headers are needed -- just an empty response when the update on the
|
||||
server side was successful.
|
||||
|
||||
# <person><first>Ryan</first></person>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ outside of Rails.
|
|||
|
||||
== Download and installation
|
||||
|
||||
The latest version of Active Support can be installed with Rubygems:
|
||||
The latest version of Active Support can be installed with RubyGems:
|
||||
|
||||
% [sudo] gem install activesupport
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Railties is responsible to glue all frameworks together. Overall, it:
|
|||
|
||||
== Download
|
||||
|
||||
The latest version of Railties can be installed with Rubygems:
|
||||
The latest version of Railties can be installed with RubyGems:
|
||||
|
||||
* gem install railties
|
||||
|
||||
|
|
|
|||
|
|
@ -59,12 +59,12 @@ The +config.gem+ method is gone and has been replaced by using +bundler+ and a +
|
|||
|
||||
h4. Upgrade Process
|
||||
|
||||
To help with the upgrade process, a plugin named "Rails Upgrade":http://github.com/jm/rails_upgrade has been created to automate part of it.
|
||||
To help with the upgrade process, a plugin named "Rails Upgrade":http://github.com/rails/rails_upgrade has been created to automate part of it.
|
||||
|
||||
Simply install the plugin, then run +rake rails:upgrade:check+ to check your app for pieces that need to be updated (with links to information on how to update them). It also offers a task to generate a +Gemfile+ based on your current +config.gem+ calls and a task to generate a new routes file from your current one. To get the plugin, simply run the following:
|
||||
|
||||
<shell>
|
||||
$ ruby script/plugin install git://github.com/jm/rails_upgrade.git
|
||||
$ ruby script/plugin install git://github.com/rails/rails_upgrade.git
|
||||
</shell>
|
||||
|
||||
You can see an example of how that works at "Rails Upgrade is now an Official Plugin":http://omgbloglol.com/post/364624593/rails-upgrade-is-now-an-official-plugin
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ endprologue.
|
|||
|
||||
h3. Upgrading to Rails 3.1
|
||||
|
||||
If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 3 and make sure your application still runs as expected before attempting to update to Rails 3.1. Then take heed of the following changes:
|
||||
If you're upgrading an existing application, it's a great idea to have good test coverage before going in. You should also first upgrade to Rails 3 in case you haven't and make sure your application still runs as expected before attempting to update to Rails 3.1. Then take heed of the following changes:
|
||||
|
||||
h4. Rails 3.1 requires at least Ruby 1.8.7
|
||||
|
||||
|
|
@ -21,8 +21,6 @@ Rails 3.1 requires Ruby 1.8.7 or higher. Support for all of the previous Ruby ve
|
|||
|
||||
TIP: Note that Ruby 1.8.7 p248 and p249 have marshaling bugs that crash Rails. Ruby Enterprise Edition have these fixed since release 1.8.7-2010.02 though. On the 1.9 front, Ruby 1.9.1 is not usable because it outright segfaults, so if you want to use 1.9.x jump on 1.9.2 for smooth sailing.
|
||||
|
||||
TODO. What else?
|
||||
|
||||
h3. Creating a Rails 3.1 application
|
||||
|
||||
<shell>
|
||||
|
|
@ -33,13 +31,13 @@ $ cd myapp
|
|||
|
||||
h4. Vendoring Gems
|
||||
|
||||
Rails now uses a +Gemfile+ in the application root to determine the gems you require for your application to start. This +Gemfile+ is processed by the "Bundler":https://github.com/carlhuda/bundler, which then installs all your dependencies. It can even install all the dependencies locally to your application so that it doesn't depend on the system gems.
|
||||
Rails now uses a +Gemfile+ in the application root to determine the gems you require for your application to start. This +Gemfile+ is processed by the "Bundler":https://github.com/carlhuda/bundler gem, which then installs all your dependencies. It can even install all the dependencies locally to your application so that it doesn't depend on the system gems.
|
||||
|
||||
More information: - "bundler homepage":http://gembundler.com
|
||||
|
||||
h4. Living on the Edge
|
||||
|
||||
+Bundler+ and +Gemfile+ makes freezing your Rails application easy as pie with the new dedicated <tt>bundle</tt> command. If you want to bundle straight from the Git repository, you can pass the +--edge+ flag:
|
||||
+Bundler+ and +Gemfile+ makes freezing your Rails application easy as pie with the new dedicated +bundle+ command. If you want to bundle straight from the Git repository, you can pass the +--edge+ flag:
|
||||
|
||||
<shell>
|
||||
$ rails new myapp --edge
|
||||
|
|
@ -67,6 +65,10 @@ h4. Default JS library is now jQuery
|
|||
|
||||
jQuery is the default JavaScript library that ships with Rails 3.1. But if you use Prototype, it's simple to switch.
|
||||
|
||||
<shell>
|
||||
$ rails new myapp -j prototype
|
||||
</shell>
|
||||
|
||||
h4. Identity Map
|
||||
|
||||
Active Record has an Identity Map in Rails 3.1. An identity map keeps previously instantiated records and returns the object associated with the record if accessed again. The identity map is created on a per-request basis and is flushed at request completion.
|
||||
|
|
@ -77,11 +79,11 @@ h3. Railties
|
|||
|
||||
* jQuery is the new default JavaScript library.
|
||||
|
||||
* jQuery and prototype are no longer vendored and is provided from now on by the jquery-rails and prototype-rails gems.
|
||||
* jQuery and Prototype are no longer vendored and is provided from now on by the jquery-rails and prototype-rails gems.
|
||||
|
||||
* The application generator accepts an option -j which can be an arbitrary string. If passed "foo", the gem "foo-rails" is added to the Gemfile, and the application JavaScript manifest requires "foo" and "foo_ujs". Currently only "prototype-rails" and "jquery-rails" exist and provide those files via the asset pipeline.
|
||||
|
||||
* Generating an application or a plugin runs bundle install unless --skip-gemfile or --skip-bundle is specified.
|
||||
* Generating an application or a plugin runs +bundle install+ unless --skip-gemfile or --skip-bundle is specified.
|
||||
|
||||
* The controller and resource generators will now automatically produce asset stubs (this can be turned off with --skip-assets). These stubs will use CoffeeScript and Sass, if those libraries are available.
|
||||
|
||||
|
|
@ -99,43 +101,27 @@ h3. Railties
|
|||
|
||||
* Added <tt>Rack::Cache</tt> to the default middleware stack.
|
||||
|
||||
* TODO Engine related changes
|
||||
* Engines received a major update - You can mount them at any path, enable assets, run generators etc.
|
||||
|
||||
h3. Action Pack
|
||||
|
||||
h4. Abstract Controller
|
||||
|
||||
h4. Action Controller
|
||||
|
||||
* Added streaming support, you can enable it with:
|
||||
|
||||
<ruby>
|
||||
class PostsController < ActionController::Base
|
||||
stream :only => :index
|
||||
end
|
||||
</ruby>
|
||||
|
||||
Please read the docs at "<tt>ActionController::Streaming</tt>":http://edgeapi.rubyonrails.org/classes/ActionController/Streaming.html for more information.
|
||||
|
||||
* Added <tt>ActionController::ParamsWrapper</tt> to wrap parameters into a nested hash, and will be turned on for JSON request in new applications by default. This can be customized by setting <tt>ActionController::Base.wrap_parameters</tt> in <tt>config/initializer/wrap_parameters.rb</tt>.
|
||||
|
||||
h4. Action Dispatch
|
||||
|
||||
* Added <tt>ActionDispatch::Request.ignore_accept_header</tt> to ignore accept headers.
|
||||
|
||||
h4. Action View
|
||||
|
||||
* Created <tt>ActionView::Renderer</tt> and specified an API for <tt>ActionView::Context</tt>.
|
||||
|
||||
TODO
|
||||
|
||||
* A warning is given out if the CSRF token authenticity cannot be verified.
|
||||
|
||||
* Allows AM/PM format in datetime selectors.
|
||||
* Specify +force_ssl+ in a controller to force the browser to transfer data via HTTPS protocol on that particular controller. To limit to specific actions, :only or :except can be used.
|
||||
|
||||
* auto_link has been removed from Rails and extracted into the "rails_autolink gem":https://github.com/tenderlove/rails_autolink
|
||||
* Sensitive query string parameters specified in <tt>config.filter_parameters</tt> will now be filtered out from the request paths in the log.
|
||||
|
||||
* Added Base.http_basic_authenticate_with to do simple http basic authentication with a single class method call.
|
||||
* URL parameters which return nil for +to_param+ are now removed from the query string.
|
||||
|
||||
* Added <tt>ActionController::ParamsWrapper</tt> to wrap parameters into a nested hash, and will be turned on for JSON request in new applications by default. This can be customized by setting <tt>ActionController::Base.wrap_parameters</tt> in <tt>config/initializer/wrap_parameters.rb</tt>.
|
||||
|
||||
* Added <tt>config.action_controller.include_all_helpers</tt>. By default <tt>helper :all</tt> is done in <tt>ActionController::Base</tt>, which includes all the helpers by default. Setting +include_all_helpers+ to false will result in including only application_helper and the helper corresponding to controller (like foo_helper for foo_controller).
|
||||
|
||||
* +url_for+ and named url helpers now accept +:subdomain+ and +:domain+ as options.
|
||||
|
||||
* Added +Base.http_basic_authenticate_with+ to do simple http basic authentication with a single class method call.
|
||||
|
||||
<ruby>
|
||||
class PostsController < ApplicationController
|
||||
|
|
@ -176,31 +162,43 @@ class PostsController < ApplicationController
|
|||
end
|
||||
</ruby>
|
||||
|
||||
* Specify +force_ssl+ in a controller to force the browser to transfer data via HTTPS protocol on that particular controller. To limit to specific actions, :only or :except can be used.
|
||||
* Added streaming support, you can enable it with:
|
||||
|
||||
* Allows <tt>FormHelper#form_for</tt> to specify the :method as a direct option instead of through the :html hash. <tt>form_for(@post, remote: true, method: :delete)</tt> instead of <tt>form_for(@post, remote: true, html: { method: :delete })</tt>
|
||||
<ruby>
|
||||
class PostsController < ActionController::Base
|
||||
stream :only => :index
|
||||
end
|
||||
</ruby>
|
||||
|
||||
* Provided JavaScriptHelper#j() as an alias for JavaScriptHelper#escape_javascript(). This supersedes the Object#j() method that the JSON gem adds within templates using the JavaScriptHelper.
|
||||
|
||||
* Sensitive query string parameters specified in <tt>config.filter_parameters</tt> will now be filtered out from the request paths in the log.
|
||||
|
||||
* URL parameters which return nil for +to_param+ are now removed from the query string.
|
||||
|
||||
* <tt>ActionDispatch::MiddlewareStack</tt> now uses composition over inheritance and is no longer an array.
|
||||
|
||||
* Added an :authenticity_token option to +form_tag+ for custom handling or to omit the token by passing <tt>:authenticity_token => false</tt>.
|
||||
|
||||
* Added HTML5 button_tag helper.
|
||||
|
||||
* Template lookup now searches further up in the inheritance chain.
|
||||
|
||||
* <tt>config.action_view.cache_template_loading</tt> is brought back which allows to decide whether templates should be cached or not. TODO from which version?
|
||||
|
||||
* url_for and named url helpers now accept :subdomain and :domain as options.
|
||||
Please read the docs at "<tt>ActionController::Streaming</tt>":http://edgeapi.rubyonrails.org/classes/ActionController/Streaming.html for more information.
|
||||
|
||||
* The redirect route method now also accepts a hash of options which will only change the parts of the url in question, or an object which responds to call, allowing for redirects to be reused.
|
||||
|
||||
* Added <tt>config.action_controller.include_all_helpers</tt>. By default <tt>helper :all</tt> is done in <tt>ActionController::Base</tt>, which includes all the helpers by default. Setting +include_all_helpers+ to false will result in including only application_helper and the helper corresponding to controller (like foo_helper for foo_controller).
|
||||
h4. Action Dispatch
|
||||
|
||||
* <tt>ActionDispatch::MiddlewareStack</tt> now uses composition over inheritance and is no longer an array.
|
||||
|
||||
* Added <tt>ActionDispatch::Request.ignore_accept_header</tt> to ignore accept headers.
|
||||
|
||||
* Added <tt>Rack::Cache</tt> to the default stack.
|
||||
|
||||
* Moved etag responsibility from <tt>ActionDispatch::Response</tt> to the middleware stack.
|
||||
|
||||
* Rely on <tt>Rack::Session</tt> stores API for more compatibility across the Ruby world. This is backwards incompatible since <tt>Rack::Session</tt> expects <tt>#get_session</tt> to accept four arguments and requires <tt>#destroy_session</tt> instead of simply <tt>#destroy</tt>.
|
||||
|
||||
* Template lookup now searches further up in the inheritance chain.
|
||||
|
||||
h4. Action View
|
||||
|
||||
* Added an +:authenticity_token+ option to +form_tag+ for custom handling or to omit the token by passing <tt>:authenticity_token => false</tt>.
|
||||
|
||||
* Created <tt>ActionView::Renderer</tt> and specified an API for <tt>ActionView::Context</tt>.
|
||||
|
||||
* In place +SafeBuffer+ mutation is prohibited in Rails 3.1.
|
||||
|
||||
* Added HTML5 +button_tag+ helper.
|
||||
|
||||
* +file_field+ automatically adds <tt>:multipart => true</tt> to the enclosing form.
|
||||
|
||||
* Added a convenience idiom to generate HTML5 data-* attributes in tag helpers from a :data hash of options:
|
||||
|
||||
|
|
@ -211,19 +209,23 @@ tag("div", :data => {:name => 'Stephen', :city_state => %w(Chicago IL)})
|
|||
|
||||
Keys are dasherized. Values are JSON-encoded, except for strings and symbols.
|
||||
|
||||
* +csrf_meta_tag+ is renamed to +csrf_meta_tags+ and aliases +csrf_meta_tag+ for backwards compatibility.
|
||||
|
||||
* The old template handler API is deprecated and the new API simply requires a template handler to respond to call.
|
||||
|
||||
* rhtml and rxml are finally removed as template handlers.
|
||||
|
||||
* Moved etag responsibility from <tt>ActionDispatch::Response</tt> to the middleware stack.
|
||||
* <tt>config.action_view.cache_template_loading</tt> is brought back which allows to decide whether templates should be cached or not.
|
||||
|
||||
* Rely on <tt>Rack::Session</tt> stores API for more compatibility across the Ruby world. This is backwards incompatible since <tt>Rack::Session</tt> expects #get_session to accept four arguments and requires #destroy_session instead of simply #destroy.
|
||||
* The submit form helper does not generate an id "object_name_id" anymore.
|
||||
|
||||
* file_field automatically adds :multipart => true to the enclosing form.
|
||||
* Allows <tt>FormHelper#form_for</tt> to specify the :method as a direct option instead of through the :html hash. <tt>form_for(@post, remote: true, method: :delete)</tt> instead of <tt>form_for(@post, remote: true, html: { method: :delete })</tt>.
|
||||
|
||||
* +csrf_meta_tag+ is renamed to +csrf_meta_tags+ and aliases csrf_meta_tag for backwards compatibility.
|
||||
* Provided <tt>JavaScriptHelper#j()</tt> as an alias for <tt>JavaScriptHelper#escape_javascript()</tt>. This supersedes the <tt>Object#j()</tt> method that the JSON gem adds within templates using the JavaScriptHelper.
|
||||
|
||||
* Added <tt>Rack::Cache</tt> to the default stack.
|
||||
* Allows AM/PM format in datetime selectors.
|
||||
|
||||
* +auto_link+ has been removed from Rails and extracted into the "rails_autolink gem":https://github.com/tenderlove/rails_autolink
|
||||
|
||||
h3. Active Record
|
||||
|
||||
|
|
@ -246,9 +248,9 @@ user.build_account{ |a| a.credit_limit => 100.0 }
|
|||
|
||||
* Added <tt>ActiveRecord::Base.attribute_names</tt> to return a list of attribute names. This will return an empty array if the model is abstract or the table does not exist.
|
||||
|
||||
* CSV Fixtures are deprecated and support will be removed in Rails 3.2.0
|
||||
* CSV Fixtures are deprecated and support will be removed in Rails 3.2.0.
|
||||
|
||||
* ActiveRecord#new, ActiveRecord#create and ActiveRecord#update_attributes all accept a second hash as an option that allows you to specify which role to consider when assigning attributes. This is built on top of ActiveModel's new mass assignment capabilities:
|
||||
* <tt>ActiveRecord#new</tt>, <tt>ActiveRecord#create</tt> and <tt>ActiveRecord#update_attributes</tt> all accept a second hash as an option that allows you to specify which role to consider when assigning attributes. This is built on top of ActiveModel's new mass assignment capabilities:
|
||||
|
||||
<ruby>
|
||||
class Post < ActiveRecord::Base
|
||||
|
|
@ -259,19 +261,19 @@ end
|
|||
Post.new(params[:post], :as => :admin)
|
||||
</ruby>
|
||||
|
||||
* default_scope can now take a block, lambda, or any other object which responds to call for lazy evaluation:
|
||||
* +default_scope+ can now take a block, lambda, or any other object which responds to call for lazy evaluation.
|
||||
|
||||
* Default scopes are now evaluated at the latest possible moment, to avoid problems where scopes would be created which would implicitly contain the default scope, which would then be impossible to get rid of via Model.unscoped.
|
||||
|
||||
* PostgreSQL adapter only supports PostgreSQL version 8.2 and higher.
|
||||
|
||||
* ConnectionManagement middleware is changed to clean up the connection pool after the rack body has been flushed.
|
||||
* +ConnectionManagement+ middleware is changed to clean up the connection pool after the rack body has been flushed.
|
||||
|
||||
* Added an update_column method on ActiveRecord. This new method updates a given attribute on an object, skipping validations and callbacks. It is recommended to use #update_attribute unless you are sure you do not want to execute any callback, including the modification of the updated_at column. It should not be called on new records.
|
||||
* Added an +update_column+ method on Active Record. This new method updates a given attribute on an object, skipping validations and callbacks. It is recommended to use +update_attribute+ unless you are sure you do not want to execute any callback, including the modification of the +updated_at+ column. It should not be called on new records.
|
||||
|
||||
* Associations with a :through option can now use any association as the through or source association, including other associations which have a :through option and has_and_belongs_to_many associations.
|
||||
* Associations with a +:through+ option can now use any association as the through or source association, including other associations which have a +:through+ option and +has_and_belongs_to_many+ associations.
|
||||
|
||||
* The configuration for the current database connection is now accessible via ActiveRecord::Base.connection_config.
|
||||
* The configuration for the current database connection is now accessible via <tt>ActiveRecord::Base.connection_config</tt>.
|
||||
|
||||
* limits and offsets are removed from COUNT queries unless both are supplied.
|
||||
<ruby>
|
||||
|
|
@ -280,19 +282,19 @@ People.offset(1).count # => 'SELECT COUNT(*) FROM people'
|
|||
People.limit(1).offset(1).count # => 'SELECT COUNT(*) FROM people LIMIT 1 OFFSET 1'
|
||||
</ruby>
|
||||
|
||||
* <tt>ActiveRecord::Associations::AssociationProxy</tt> has been split. There is now an +Association+ class (and subclasses) which are responsible for operating on associations, and then a separate, thin wrapper +called+ CollectionProxy, which proxies collection associations. This prevents namespace pollution, separates concerns, and will allow further refactorings.
|
||||
* <tt>ActiveRecord::Associations::AssociationProxy</tt> has been split. There is now an +Association+ class (and subclasses) which are responsible for operating on associations, and then a separate, thin wrapper called +CollectionProxy+, which proxies collection associations. This prevents namespace pollution, separates concerns, and will allow further refactorings.
|
||||
|
||||
* Singular associations (has_one, belongs_to) no longer have a proxy and simply returns the associated record or nil. This means that you should not use undocumented methods such as bob.mother.create - use bob.create_mother instead.
|
||||
|
||||
* Support the :dependent option on has_many :through associations. For historical and practical reasons, :delete_all is the default deletion strategy employed by association.delete(*records), despite the fact that the default strategy is :nullify for regular has_many. Also, this only works at all if the source reflection is a belongs_to. For other situations, you should directly modify the through association.
|
||||
* Support the <tt>:dependent</tt> option on <tt>has_many :through</tt> associations. For historical and practical reasons, +:delete_all+ is the default deletion strategy employed by <tt>association.delete(*records)</tt>, despite the fact that the default strategy is +:nullify+ for regular has_many. Also, this only works at all if the source reflection is a belongs_to. For other situations, you should directly modify the through association.
|
||||
|
||||
* The behavior of association.destroy for has_and_belongs_to_many and has_many :through is changed. From now on, 'destroy' or 'delete' on an association will be taken to mean 'get rid of the link', not (necessarily) 'get rid of the associated records'.
|
||||
* The behavior of +association.destroy+ for +has_and_belongs_to_many+ and <tt>has_many :through</tt> is changed. From now on, 'destroy' or 'delete' on an association will be taken to mean 'get rid of the link', not (necessarily) 'get rid of the associated records'.
|
||||
|
||||
* Previously, has_and_belongs_to_many.destroy(*records) would destroy the records themselves. It would not delete any records in the join table. Now, it deletes the records in the join table.
|
||||
* Previously, <tt>has_and_belongs_to_many.destroy(*records)</tt> would destroy the records themselves. It would not delete any records in the join table. Now, it deletes the records in the join table.
|
||||
|
||||
* Previously, has_many_through.destroy(*records) would destroy the records themselves, and the records in the join table. [Note: This has not always been the case; previous version of Rails only deleted the records themselves.] Now, it destroys only the records in the join table.
|
||||
* Previously, <tt>has_many_through.destroy(*records)</tt> would destroy the records themselves, and the records in the join table. [Note: This has not always been the case; previous version of Rails only deleted the records themselves.] Now, it destroys only the records in the join table.
|
||||
|
||||
* Note that this change is backwards-incompatible to an extent, but there is unfortunately no way to 'deprecate' it before changing it. The change is being made in order to have consistency as to the meaning of 'destroy' or 'delete' across the different types of associations. If you wish to destroy the records themselves, you can do records.association.each(&:destroy)
|
||||
* Note that this change is backwards-incompatible to an extent, but there is unfortunately no way to 'deprecate' it before changing it. The change is being made in order to have consistency as to the meaning of 'destroy' or 'delete' across the different types of associations. If you wish to destroy the records themselves, you can do <tt>records.association.each(&:destroy)</tt>.
|
||||
|
||||
* Add <tt>:bulk => true</tt> option to +change_table+ to make all the schema changes defined in a block using a single ALTER statement.
|
||||
|
||||
|
|
@ -319,7 +321,7 @@ class MyMigration < ActiveRecord::Migration
|
|||
end
|
||||
</ruby>
|
||||
|
||||
* Some things cannot be automatically reversed for you. If you know how to reverse those things, you should define 'up' and 'down' in your migration. If you define something in change that cannot be reversed, an +IrreversibleMigration+ exception will be raised when going down.
|
||||
* Some things cannot be automatically reversed for you. If you know how to reverse those things, you should define +up+ and +down+ in your migration. If you define something in change that cannot be reversed, an +IrreversibleMigration+ exception will be raised when going down.
|
||||
|
||||
* Migrations now use instance methods rather than class methods:
|
||||
<ruby>
|
||||
|
|
@ -330,7 +332,7 @@ class FooMigration < ActiveRecord::Migration
|
|||
end
|
||||
</ruby>
|
||||
|
||||
* Migration files generated from model and constructive migration generators (for example, add_name_to_users) use the reversible migration's change method instead of the ordinary up and down methods.
|
||||
* Migration files generated from model and constructive migration generators (for example, add_name_to_users) use the reversible migration's +change+ method instead of the ordinary +up+ and +down+ methods.
|
||||
|
||||
* Removed support for interpolating string SQL conditions on associations. Instead, a proc should be used.
|
||||
|
||||
|
|
@ -346,7 +348,7 @@ You can have any "normal" conditions inside the proc, so the following will work
|
|||
has_many :things, :conditions => proc { ["foo = ?", bar] }
|
||||
</ruby>
|
||||
|
||||
* Previously :insert_sql and :delete_sql on has_and_belongs_to_many association allowed you to call 'record' to get the record being inserted or deleted. This is now passed as an argument to the proc.
|
||||
* Previously +:insert_sql+ and +:delete_sql+ on +has_and_belongs_to_many+ association allowed you to call 'record' to get the record being inserted or deleted. This is now passed as an argument to the proc.
|
||||
|
||||
* Added <tt>ActiveRecord::Base#has_secure_password</tt> (via <tt>ActiveModel::SecurePassword</tt>) to encapsulate dead-simple password usage with BCrypt encryption and salting.
|
||||
<ruby>
|
||||
|
|
@ -358,13 +360,13 @@ end
|
|||
|
||||
* When a model is generated +add_index+ is added by default for +belongs_to+ or +references+ columns.
|
||||
|
||||
* Setting the id of a belongs_to object will update the reference to the object.
|
||||
* Setting the id of a +belongs_to+ object will update the reference to the object.
|
||||
|
||||
* ActiveRecord::Base#dup and ActiveRecord::Base#clone semantics have changed to closer match normal Ruby dup and clone semantics.
|
||||
* <tt>ActiveRecord::Base#dup</tt> and <tt>ActiveRecord::Base#clone</tt> semantics have changed to closer match normal Ruby dup and clone semantics.
|
||||
|
||||
* Calling ActiveRecord::Base#clone will result in a shallow copy of the record, including copying the frozen state. No callbacks will be called.
|
||||
* Calling <tt>ActiveRecord::Base#clone</tt> will result in a shallow copy of the record, including copying the frozen state. No callbacks will be called.
|
||||
|
||||
* Calling ActiveRecord::Base#dup will duplicate the record, including calling after initialize hooks. Frozen state will not be copied, and all associations will be cleared. A duped record will return true for new_record?, have a nil id field, and is saveable.
|
||||
* Calling <tt>ActiveRecord::Base#dup</tt> will duplicate the record, including calling after initialize hooks. Frozen state will not be copied, and all associations will be cleared. A duped record will return true for <tt>new_record?</tt>, have a nil id field, and is saveable.
|
||||
|
||||
h3. Active Model
|
||||
|
||||
|
|
@ -376,6 +378,8 @@ h3. Active Model
|
|||
|
||||
* <tt>ActiveModel::AttributeMethods</tt> allows attributes to be defined on demand.
|
||||
|
||||
* Added support for selectively enabling and disabling observers.
|
||||
|
||||
h3. Active Resource
|
||||
|
||||
* The default format has been changed to JSON for all requests. If you want to continue to use XML you will need to set <tt>self.format = :xml</tt> in the class. For example,
|
||||
|
|
@ -388,25 +392,25 @@ end
|
|||
|
||||
h3. Active Support
|
||||
|
||||
* <tt>ActiveSupport::Dependencies</tt> now raises +NameError+ if it finds an existing constant in load_missing_constant.
|
||||
* <tt>ActiveSupport::Dependencies</tt> now raises +NameError+ if it finds an existing constant in +load_missing_constant+.
|
||||
|
||||
* Added a new reporting method <tt>Kernel#quietly</tt> which silences both STDOUT and STDERR.
|
||||
* Added a new reporting method <tt>Kernel#quietly</tt> which silences both +STDOUT+ and +STDERR+.
|
||||
|
||||
* Added <tt>String#inquiry</tt> as a convenience method for turning a String into a +StringInquirer+ object.
|
||||
|
||||
* Added <tt>Object#in?</tt> to test if an object is included in another object.
|
||||
|
||||
* LocalCache strategy is now a real middleware class and no longer an anonymous class.
|
||||
* +LocalCache+ strategy is now a real middleware class and no longer an anonymous class.
|
||||
|
||||
* <tt>ActiveSupport::Dependencies::ClassCache</tt> class has been introduced for holding references to reloadable classes.
|
||||
|
||||
* <tt>ActiveSupport::Dependencies::Reference</tt> has been refactored to take direct advantage of the new ClassCache.
|
||||
* <tt>ActiveSupport::Dependencies::Reference</tt> has been refactored to take direct advantage of the new +ClassCache+.
|
||||
|
||||
* Backports <tt>Range#cover?</tt> as an alias for <tt>Range#include?</tt> in Ruby 1.8.
|
||||
|
||||
* Added +weeks_ago+ and +prev_week+ to Date/DateTime/Time.
|
||||
|
||||
* Added +before_remove_const+ callback to <tt>ActiveSupport::Dependencies.remove_unloadable_constants!</tt>
|
||||
* Added +before_remove_const+ callback to <tt>ActiveSupport::Dependencies.remove_unloadable_constants!</tt>.
|
||||
|
||||
Deprecations:
|
||||
|
||||
|
|
|
|||
|
|
@ -404,7 +404,7 @@ Will put the HTML part first, and the plain text part second.
|
|||
|
||||
h4. Sending Emails with Attachments
|
||||
|
||||
Attachments can be added by using the +attachment+ method:
|
||||
Attachments can be added by using the +attachments+ method:
|
||||
|
||||
<ruby>
|
||||
class UserMailer < ActionMailer::Base
|
||||
|
|
|
|||
|
|
@ -0,0 +1,205 @@
|
|||
h2. Active Model Basics
|
||||
|
||||
This guide should provide you with all you need to get started using model classes. Active Model allow for Action Pack helpers to interact with non-ActiveRecord models. Active Model also helps building custom ORMs for use outside of the Rails framework.
|
||||
|
||||
endprologue.
|
||||
|
||||
WARNING. This Guide is based on Rails 3.0. Some of the code shown here will not work in earlier versions of Rails.
|
||||
|
||||
h3. Introduction
|
||||
|
||||
Active Model is a library containing various modules used in developing frameworks that need to interact with the Rails Action Pack library. Active Model provides a known set of interfaces for usage in classes. Some of modules are explained below -
|
||||
|
||||
h4. AttributeMethods
|
||||
|
||||
AttributeMethods module can add custom prefixes and suffixes on methods of a class. It is used by defining the prefixes and suffixes, which methods on the object will use them.
|
||||
|
||||
<ruby>
|
||||
class Person
|
||||
include ActiveModel::AttributeMethods
|
||||
|
||||
attribute_method_prefix 'reset_'
|
||||
attribute_method_suffix '_highest?'
|
||||
define_attribute_methods ['age']
|
||||
|
||||
attr_accessor :age
|
||||
|
||||
private
|
||||
def reset_attribute(attribute)
|
||||
send("#{attribute}=", 0)
|
||||
end
|
||||
|
||||
def attribute_highest?(attribute)
|
||||
send(attribute) > 100 ? true : false
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
person = Person.new
|
||||
person.age = 110
|
||||
person.age_highest? # true
|
||||
person.reset_age # 0
|
||||
person.age_highest? # false
|
||||
|
||||
</ruby>
|
||||
|
||||
h4. Callbacks
|
||||
|
||||
Callbacks gives Active Record style callbacks. This provides the ability to define the callbacks and those will run at appropriate time. After defining a callbacks you can wrap with before, after and around custom methods.
|
||||
|
||||
<ruby>
|
||||
class Person
|
||||
extend ActiveModel::Callbacks
|
||||
|
||||
define_model_callbacks :update
|
||||
|
||||
before_update :reset_me
|
||||
|
||||
def update
|
||||
_run_update_callbacks do
|
||||
# This will call when we are trying to call update on object.
|
||||
end
|
||||
end
|
||||
|
||||
def reset_me
|
||||
# This method will call when you are calling update on object as a before_update callback as defined.
|
||||
end
|
||||
end
|
||||
</ruby>
|
||||
|
||||
h4. Conversion
|
||||
|
||||
If a class defines persisted? and id methods then you can include Conversion module in that class and you can able to call Rails conversion methods to objects of that class.
|
||||
|
||||
<ruby>
|
||||
class Person
|
||||
include ActiveModel::Conversion
|
||||
|
||||
def persisted?
|
||||
false
|
||||
end
|
||||
|
||||
def id
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
person = Person.new
|
||||
person.to_model == person #=> true
|
||||
person.to_key #=> nil
|
||||
person.to_param #=> nil
|
||||
</ruby>
|
||||
|
||||
h4. Dirty
|
||||
|
||||
An object becomes dirty when an object is gone through one or more changes to its attributes and not yet saved. This gives the ability to check whether an object has been changed or not. It also has attribute based accessor methods. Lets consider a Person class with attributes first_name and last_name
|
||||
|
||||
<ruby>
|
||||
require 'rubygems'
|
||||
require 'active_model'
|
||||
|
||||
class Person
|
||||
include ActiveModel::Dirty
|
||||
define_attribute_methods [:first_name, :last_name]
|
||||
|
||||
def first_name
|
||||
@first_name
|
||||
end
|
||||
|
||||
def first_name=(value)
|
||||
first_name_will_change!
|
||||
@first_name = value
|
||||
end
|
||||
|
||||
def last_name
|
||||
@last_name
|
||||
end
|
||||
|
||||
def last_name=(value)
|
||||
last_name_will_change!
|
||||
@last_name = value
|
||||
end
|
||||
|
||||
def save
|
||||
@previously_changed = changes
|
||||
end
|
||||
|
||||
end
|
||||
</ruby>
|
||||
|
||||
h5. Querying object directly for its list of all changed attributes.
|
||||
|
||||
<ruby>
|
||||
person = Person.new
|
||||
person.first_name = "First Name"
|
||||
|
||||
person.first_name #=> "First Name"
|
||||
person.first_name = "First Name Changed"
|
||||
|
||||
person.changed? #=> true
|
||||
|
||||
#returns an list of fields arry which all has been changed before saved.
|
||||
person.changed #=> ["first_name"]
|
||||
|
||||
#returns a hash of the fields that have changed with their original values.
|
||||
person.changed_attributes #=> {"first_name" => "First Name Changed"}
|
||||
|
||||
#returns a hash of changes, with the attribute names as the keys, and the values will be an array of the old and new value for that field.
|
||||
person.changes #=> {"first_name" => ["First Name","First Name Changed"]}
|
||||
</ruby>
|
||||
|
||||
h5. Attribute based accessor methods
|
||||
|
||||
Track whether the particular attribute has been changed or not.
|
||||
|
||||
<ruby>
|
||||
#attr_name_changed?
|
||||
person.first_name #=> "First Name"
|
||||
|
||||
#assign some other value to first_name attribute
|
||||
person.first_name = "First Name 1"
|
||||
|
||||
person.first_name_changed? #=> true
|
||||
</ruby>
|
||||
|
||||
Track what was the previous value of the attribute.
|
||||
<ruby>
|
||||
#attr_name_was accessor
|
||||
person.first_name_was #=> "First Name"
|
||||
</ruby>
|
||||
|
||||
|
||||
Track both previous and current value of the changed attribute. Returns an array if changed else returns nil
|
||||
<ruby>
|
||||
#attr_name_change
|
||||
person.first_name_change #=> ["First Name", "First Name 1"]
|
||||
person.last_name_change #=> nil
|
||||
</ruby>
|
||||
|
||||
h4. Validations
|
||||
|
||||
Validations module adds the ability to class objects to validate them in Active Record style.
|
||||
|
||||
<ruby>
|
||||
class Person
|
||||
include ActiveModel::Validations
|
||||
|
||||
attr_accessor :name, :email
|
||||
|
||||
validates :name, :presence => true
|
||||
validates_format_of :email, :with => /^([^\s]+)((?:[-a-z0-9]\.)[a-z]{2,})$/i
|
||||
|
||||
end
|
||||
|
||||
person = Person.new
|
||||
person.valid? #=> false
|
||||
person.name = 'vishnu'
|
||||
person.email = 'me'
|
||||
person.valid? #=> false
|
||||
person.email = 'me@vishnuatrai.com'
|
||||
person.valid? #=> true
|
||||
</ruby>
|
||||
|
||||
h3. Changelog
|
||||
|
||||
* August 5, 2011: Initial version by "Arun Agrawal":http://github.com/arunagw
|
||||
|
|
@ -69,6 +69,56 @@ person = Person.find(1)
|
|||
person.destroy
|
||||
</ruby>
|
||||
|
||||
h3. Validations
|
||||
|
||||
Module to support validation and errors with Active Resource objects. The module overrides Base#save to rescue ActiveResource::ResourceInvalid exceptions and parse the errors returned in the web service response. The module also adds an errors collection that mimics the interface of the errors provided by ActiveRecord::Errors.
|
||||
|
||||
h4. Validating client side resources by overriding validation methods in base class
|
||||
|
||||
<ruby>
|
||||
class Person < ActiveResource::Base
|
||||
self.site = "http://api.people.com:3000/"
|
||||
|
||||
protected
|
||||
|
||||
def validate
|
||||
errors.add("last", "has invalid characters") unless last =~ /[a-zA-Z]*/
|
||||
end
|
||||
end
|
||||
</ruby>
|
||||
|
||||
h4. Validating client side resources
|
||||
|
||||
Consider a Person resource on the server requiring both a first_name and a last_name with a validates_presence_of :first_name, :last_name declaration in the model:
|
||||
|
||||
<ruby>
|
||||
person = Person.new(:first_name => "Jim", :last_name => "")
|
||||
person.save # => false (server returns an HTTP 422 status code and errors)
|
||||
person.valid? # => false
|
||||
person.errors.empty? # => false
|
||||
person.errors.count # => 1
|
||||
person.errors.full_messages # => ["Last name can't be empty"]
|
||||
person.errors[:last_name] # => ["can't be empty"]
|
||||
person.last_name = "Halpert"
|
||||
person.save # => true (and person is now saved to the remote service)
|
||||
</ruby>
|
||||
|
||||
h4. Public instance methods
|
||||
|
||||
ActiveResource::Validations have three public instance methods
|
||||
|
||||
h5. errors()
|
||||
|
||||
This will return errors object that holds all information about attribute error messages
|
||||
|
||||
h5. save_with_validation(options=nil)
|
||||
|
||||
This validates the resource with any local validations written in base class and then it will try to POST if there are no errors.
|
||||
|
||||
h5. valid?
|
||||
|
||||
Runs all the local validations and will return true if no errors.
|
||||
|
||||
h3. Changelog
|
||||
|
||||
* July 30, 2011: Initial version by "Vishnu Atrai":http://github.com/vatrai
|
||||
|
|
@ -276,17 +276,15 @@ The rake task is:
|
|||
rake assets:precompile
|
||||
</plain>
|
||||
|
||||
You can run this as part of a Capistrano deployment:
|
||||
Capistrano (v2.8.0+) has a recipe to to handle this in deployment. Add the following line to +Capfile+:
|
||||
|
||||
<erb>
|
||||
before 'deploy:symlink' do
|
||||
run "cd #{release_path}; RAILS_ENV=#{rails_env} rake assets:precompile"
|
||||
end
|
||||
load 'deploy/assets'
|
||||
</erb>
|
||||
|
||||
If you are not precompiling your assets, and you are using the default cache file store (which is the file system), you will need to symlink +rails_root/tmp/cache/assets+ from the shared folder that is part of the Capistrano deployment structure in order to persist the cached file between deployments.
|
||||
This links the folder specified in +config.assets.prefix+ to +shared/assets+. If you already use this folder you'll need to write your own deployment task.
|
||||
|
||||
TODO: Extend above task to allow for this and add task to set it up (See commits 8f0e0b6 and 704ee0df). Note: Capistrano folks are working on a recipe - update this when it available (see https://github.com/capistrano/capistrano/pull/35).
|
||||
It is important for this folder is shared between deployments so that remotely cached pages that reference the old compiled assets still work for the life of the cached page.
|
||||
|
||||
The default matcher for compiling files will include +application.js+, +application.css+ and all files that do not end in +js+ or +css+:
|
||||
|
||||
|
|
@ -297,7 +295,7 @@ The default matcher for compiling files will include +application.js+, +applicat
|
|||
If you have other manifests or individual stylesheets and JavaScript files to include, you can append them to the +precompile+ array:
|
||||
|
||||
<erb>
|
||||
config.assets.precompile << ['admin.js', 'admin.css', 'swfObject.js']
|
||||
config.assets.precompile += ['admin.js', 'admin.css', 'swfObject.js']
|
||||
</erb>
|
||||
|
||||
Precompiled assets exist on the filesystem and are served directly by your webserver. They do not have far-future headers by default, so to get the benefit of fingerprinting you'll have to update your server configuration to add them.
|
||||
|
|
@ -387,16 +385,15 @@ This is a handy option if you have any existing project (pre Rails 3.1) that alr
|
|||
|
||||
h4. X-Sendfile Headers
|
||||
|
||||
The X-Sendfile header is a directive to the server to ignore the response from the application, and instead serve the file specified in the headers. In production Rails (via Sprockets) does not send the asset - just the location and a zero-length response - relying on the web server to do the file serving, which is usually faster. Both Apache and nginx support this option.
|
||||
The X-Sendfile header is a directive to the server to ignore the response from the application, and instead serve the file specified in the headers. This option is off be default, but can be enabled if your server supports it. When enabled, this passes responsibility for serving the file to the web server, which is faster.
|
||||
|
||||
The configuration is available in <tt>config/environments/production.rb</tt>.
|
||||
Apache and nginx support this option which is enabled in <tt>config/environments/production.rb</tt>.
|
||||
|
||||
<erb>
|
||||
config.action_dispatch.x_sendfile_header = "X-Sendfile" # Use 'X-Accel-Redirect' for nginx
|
||||
# config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
|
||||
# config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
|
||||
</erb>
|
||||
|
||||
You should check that your server or hosting service actually supports this, otherwise comment it out.
|
||||
|
||||
WARNING: If you are upgrading an existing application and intend to use this option, take care to paste this configuration option only into +production.rb+ (and not +application.rb+) and any other environment you define with production behavior.
|
||||
|
||||
h3. How Caching Works
|
||||
|
|
|
|||
|
|
@ -381,6 +381,7 @@ Ruby version 1.8.7 (x86_64-linux)
|
|||
RubyGems version 1.3.6
|
||||
Rack version 1.1
|
||||
Rails version 3.1.0
|
||||
JavaScript Runtime Node.js (V8)
|
||||
Active Record version 3.1.0
|
||||
Action Pack version 3.1.0
|
||||
Active Resource version 3.1.0
|
||||
|
|
@ -390,12 +391,12 @@ Middleware ActionDispatch::Static, Rack::Lock, Rack::Runtime, Rai
|
|||
Application root /home/foobar/commandsapp
|
||||
Environment development
|
||||
Database adapter sqlite3
|
||||
Database schema version 0
|
||||
Database schema version 20110805173523
|
||||
</shell>
|
||||
|
||||
h4. +assets+
|
||||
|
||||
You can precompile the assets in <tt>app/assets</tt> using <tt>rake assets:precompile</tt> and remove compiled assets using <tt>rake assets:clean</tt>.
|
||||
You can precompile the assets in <tt>app/assets</tt> using <tt>rake assets:precompile</tt> and remove those compiled assets using <tt>rake assets:clean</tt>.
|
||||
|
||||
h4. +db+
|
||||
|
||||
|
|
@ -460,13 +461,18 @@ h4. +test+
|
|||
|
||||
INFO: A good description of unit testing in Rails is given in "A Guide to Testing Rails Applications":testing.html
|
||||
|
||||
Rails comes with a test suite called Test::Unit. It is through the use of tests that Rails itself is so stable, and the slew of people working on Rails can prove that everything works as it should.
|
||||
|
||||
The +test:+ namespace helps in running the different tests you will (hopefully!) write.
|
||||
Rails comes with a test suite called <tt>Test::Unit</tt>. Rails owes its stability to the use of tests. The tasks available in the +test:+ namespace helps in running the different tests you will hopefully write.
|
||||
|
||||
h4. +tmp+
|
||||
|
||||
The <tt>Rails.root/tmp</tt> directory is, like the *nix /tmp directory, the holding place for temporary files like sessions (if you're using a file store for files), process id files, and cached actions. The +tmp:+ namespace tasks will help you clear them if you need to if they've become overgrown, or create them in case of deletions gone awry.
|
||||
The <tt>Rails.root/tmp</tt> directory is, like the *nix /tmp directory, the holding place for temporary files like sessions (if you're using a file store for files), process id files, and cached actions.
|
||||
|
||||
The +tmp:+ namespaced tasks will help you clear the <tt>Rails.root/tmp</tt> directory:
|
||||
|
||||
* +rake tmp:cache:clear+ clears <tt>tmp/cache</tt>.
|
||||
* +rake tmp:sessions:clear+ clears <tt>tmp/sessions</tt>.
|
||||
* +rake tmp:sockets:clear+ clears <tt>tmp/sockets</tt>.
|
||||
* +rake tmp:clear+ clears all the three: cache, sessions and sockets.
|
||||
|
||||
h4. Miscellaneous
|
||||
|
||||
|
|
|
|||
|
|
@ -348,10 +348,10 @@ The class *is* defined in +Rack::Server+, but is overwritten in +Rails::Server+
|
|||
def parse!(args)
|
||||
args, options = args.dup, {}
|
||||
|
||||
opt_parser = OptionParser.new do |opts|
|
||||
opts.banner = "Usage: rails server [mongrel, thin, etc] [options]"
|
||||
opts.on("-p", "--port=port", Integer,
|
||||
"Runs Rails on the specified port.", "Default: 3000") { |v| options[:Port] = v }
|
||||
opt_parser = OptionParser.new do |opts|
|
||||
opts.banner = "Usage: rails server [mongrel, thin, etc] [options]"
|
||||
opts.on("-p", "--port=port", Integer,
|
||||
"Runs Rails on the specified port.", "Default: 3000") { |v| options[:Port] = v }
|
||||
...
|
||||
</ruby>
|
||||
|
||||
|
|
|
|||
|
|
@ -438,9 +438,9 @@ alias gcrails='~/rubygc/bin/rails'
|
|||
|
||||
Don't forget to use your aliases from now on.
|
||||
|
||||
h6. Install Rubygems (1.8 only!)
|
||||
h6. Install RubyGems (1.8 only!)
|
||||
|
||||
Download "Rubygems":http://rubyforge.org/projects/rubygems and install it from source. Rubygem's README file should have necessary installation instructions. Please note that this step isn't necessary if you've installed Ruby 1.9 and above.
|
||||
Download "RubyGems":http://rubyforge.org/projects/rubygems and install it from source. Rubygem's README file should have necessary installation instructions. Please note that this step isn't necessary if you've installed Ruby 1.9 and above.
|
||||
|
||||
h4. Using Ruby-Prof on MRI and REE
|
||||
|
||||
|
|
|
|||
|
|
@ -89,23 +89,32 @@ $ rake middleware
|
|||
For a freshly generated Rails application, this might produce something like:
|
||||
|
||||
<ruby>
|
||||
use ActionDispatch::Static
|
||||
use Rack::Lock
|
||||
use ActionController::Failsafe
|
||||
use ActionController::Session::CookieStore, , {:secret=>"<secret>", :session_key=>"_<app>_session"}
|
||||
use Rails::Rack::Metal
|
||||
use ActionDispatch::RewindableInput
|
||||
use ActionController::ParamsParser
|
||||
use Rack::MethodOverride
|
||||
use Rack::Head
|
||||
use ActiveSupport::Cache::Strategy::LocalCache
|
||||
use Rack::Runtime
|
||||
use Rails::Rack::Logger
|
||||
use ActionDispatch::ShowExceptions
|
||||
use ActionDispatch::RemoteIp
|
||||
use Rack::Sendfile
|
||||
use ActionDispatch::Callbacks
|
||||
use ActiveRecord::ConnectionAdapters::ConnectionManagement
|
||||
use ActiveRecord::QueryCache
|
||||
run ActionController::Dispatcher.new
|
||||
use ActionDispatch::Cookies
|
||||
use ActionDispatch::Session::CookieStore
|
||||
use ActionDispatch::Flash
|
||||
use ActionDispatch::ParamsParser
|
||||
use Rack::MethodOverride
|
||||
use ActionDispatch::Head
|
||||
use ActionDispatch::BestStandardsSupport
|
||||
run Blog::Application.routes
|
||||
</ruby>
|
||||
|
||||
Purpose of each of this middlewares is explained in the "Internal Middlewares":#internal-middleware-stack section.
|
||||
|
||||
h4. Configuring Middleware Stack
|
||||
|
||||
Rails provides a simple configuration interface +config.middleware+ for adding, removing and modifying the middlewares in the middleware stack via +environment.rb+ or the environment specific configuration file <tt>environments/<environment>.rb</tt>.
|
||||
Rails provides a simple configuration interface +config.middleware+ for adding, removing and modifying the middlewares in the middleware stack via +application.rb+ or the environment specific configuration file <tt>environments/<environment>.rb</tt>.
|
||||
|
||||
h5. Adding a Middleware
|
||||
|
||||
|
|
@ -118,7 +127,7 @@ You can add a new middleware to the middleware stack using any of the following
|
|||
* <tt>config.middleware.insert_after(existing_middleware, new_middleware, args)</tt> - Adds the new middleware after the specified existing middleware in the middleware stack.
|
||||
|
||||
<ruby>
|
||||
# config/environment.rb
|
||||
# config/application.rb
|
||||
|
||||
# Push Rack::BounceFavicon at the bottom
|
||||
config.middleware.use Rack::BounceFavicon
|
||||
|
|
@ -133,7 +142,7 @@ h5. Swapping a Middleware
|
|||
You can swap an existing middleware in the middleware stack using +config.middleware.swap+.
|
||||
|
||||
<ruby>
|
||||
# config/environment.rb
|
||||
# config/application.rb
|
||||
|
||||
# Replace ActionController::Failsafe with Lifo::Failsafe
|
||||
config.middleware.swap ActionController::Failsafe, Lifo::Failsafe
|
||||
|
|
@ -198,7 +207,7 @@ The following shows how to replace use +Rack::Builder+ instead of the Rails supp
|
|||
<strong>Clear the existing Rails middleware stack</strong>
|
||||
|
||||
<ruby>
|
||||
# environment.rb
|
||||
# config/application.rb
|
||||
config.middleware.clear
|
||||
</ruby>
|
||||
|
||||
|
|
|
|||
|
|
@ -163,7 +163,9 @@ module Rails
|
|||
middleware.use ::Rails::Rack::Logger # must come after Rack::MethodOverride to properly log overridden methods
|
||||
middleware.use ::ActionDispatch::ShowExceptions, config.consider_all_requests_local
|
||||
middleware.use ::ActionDispatch::RemoteIp, config.action_dispatch.ip_spoofing_check, config.action_dispatch.trusted_proxies
|
||||
middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
|
||||
if config.action_dispatch.x_sendfile_header.present?
|
||||
middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
|
||||
end
|
||||
middleware.use ::ActionDispatch::Reloader unless config.cache_classes
|
||||
middleware.use ::ActionDispatch::Callbacks
|
||||
middleware.use ::ActionDispatch::Cookies
|
||||
|
|
|
|||
|
|
@ -20,6 +20,8 @@ module ApplicationTests
|
|||
end
|
||||
|
||||
test "default middleware stack" do
|
||||
add_to_config "config.action_dispatch.x_sendfile_header = 'X-Sendfile'"
|
||||
|
||||
boot!
|
||||
|
||||
assert_equal [
|
||||
|
|
@ -47,6 +49,12 @@ module ApplicationTests
|
|||
], middleware
|
||||
end
|
||||
|
||||
test "Rack::Sendfile is not included by default" do
|
||||
boot!
|
||||
|
||||
assert !middleware.include?("Rack::Sendfile"), "Rack::Sendfile is not included in the default stack unless you set config.action_dispatch.x_sendfile_header"
|
||||
end
|
||||
|
||||
test "Rack::Cache is present when action_controller.perform_caching is set" do
|
||||
add_to_config "config.action_controller.perform_caching = true"
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue