From 19c3495a671c364e0dc76c276efbcd9dc6914c74 Mon Sep 17 00:00:00 2001
From: Yehuda Katz + Carl Lerche
Date: Mon, 15 Jun 2009 16:29:45 -0700
Subject: [PATCH] rm -r controller/base!
---
actionmailer/lib/action_mailer/base.rb | 2 +-
actionpack/lib/action_controller.rb | 18 +-
.../{old_base => base}/cookies.rb | 0
.../filter_parameter_logging.rb | 0
.../{old_base/chained => base}/flash.rb | 0
.../{old_base => base}/http_authentication.rb | 0
.../{old_base => base}/mime_responds.rb | 0
.../request_forgery_protection.rb | 0
.../{old_base => base}/session_management.rb | 0
.../{old_base => base}/streaming.rb | 0
.../{old_base => base}/verification.rb | 0
.../{old_base => legacy}/layout.rb | 0
.../lib/action_controller/old_base/base.rb | 884 ------------------
.../old_base/chained/benchmarking.rb | 107 ---
.../old_base/chained/filters.rb | 670 -------------
.../lib/action_controller/old_base/helpers.rb | 221 -----
.../action_controller/old_base/redirect.rb | 89 --
.../lib/action_controller/old_base/render.rb | 403 --------
.../lib/action_controller/old_base/rescue.rb | 50 -
.../action_controller/old_base/responder.rb | 43 -
20 files changed, 10 insertions(+), 2477 deletions(-)
rename actionpack/lib/action_controller/{old_base => base}/cookies.rb (100%)
rename actionpack/lib/action_controller/{old_base => base}/filter_parameter_logging.rb (100%)
rename actionpack/lib/action_controller/{old_base/chained => base}/flash.rb (100%)
rename actionpack/lib/action_controller/{old_base => base}/http_authentication.rb (100%)
rename actionpack/lib/action_controller/{old_base => base}/mime_responds.rb (100%)
rename actionpack/lib/action_controller/{old_base => base}/request_forgery_protection.rb (100%)
rename actionpack/lib/action_controller/{old_base => base}/session_management.rb (100%)
rename actionpack/lib/action_controller/{old_base => base}/streaming.rb (100%)
rename actionpack/lib/action_controller/{old_base => base}/verification.rb (100%)
rename actionpack/lib/action_controller/{old_base => legacy}/layout.rb (100%)
delete mode 100644 actionpack/lib/action_controller/old_base/base.rb
delete mode 100644 actionpack/lib/action_controller/old_base/chained/benchmarking.rb
delete mode 100644 actionpack/lib/action_controller/old_base/chained/filters.rb
delete mode 100644 actionpack/lib/action_controller/old_base/helpers.rb
delete mode 100644 actionpack/lib/action_controller/old_base/redirect.rb
delete mode 100644 actionpack/lib/action_controller/old_base/render.rb
delete mode 100644 actionpack/lib/action_controller/old_base/rescue.rb
delete mode 100644 actionpack/lib/action_controller/old_base/responder.rb
diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb
index 8054d78a90..b5a0d0ab96 100644
--- a/actionmailer/lib/action_mailer/base.rb
+++ b/actionmailer/lib/action_mailer/base.rb
@@ -1,6 +1,6 @@
require "active_support/core_ext/class"
# Use the old layouts until actionmailer gets refactored
-require "action_controller/old_base/layout"
+require "action_controller/legacy/layout"
module ActionMailer #:nodoc:
# Action Mailer allows you to send email from your application using a mailer model and views.
diff --git a/actionpack/lib/action_controller.rb b/actionpack/lib/action_controller.rb
index 924c58e0e8..073600f69b 100644
--- a/actionpack/lib/action_controller.rb
+++ b/actionpack/lib/action_controller.rb
@@ -21,24 +21,24 @@ module ActionController
autoload :Caching, 'action_controller/caching'
autoload :Dispatcher, 'action_controller/dispatch/dispatcher'
autoload :Integration, 'action_controller/testing/integration'
- autoload :MimeResponds, 'action_controller/old_base/mime_responds'
+ autoload :MimeResponds, 'action_controller/base/mime_responds'
autoload :PolymorphicRoutes, 'action_controller/routing/generation/polymorphic_routes'
autoload :RecordIdentifier, 'action_controller/record_identifier'
autoload :Resources, 'action_controller/routing/resources'
- autoload :SessionManagement, 'action_controller/old_base/session_management'
+ autoload :SessionManagement, 'action_controller/base/session_management'
autoload :TestCase, 'action_controller/testing/test_case'
autoload :TestProcess, 'action_controller/testing/process'
autoload :UrlRewriter, 'action_controller/routing/generation/url_rewriter'
autoload :UrlWriter, 'action_controller/routing/generation/url_rewriter'
- autoload :Verification, 'action_controller/old_base/verification'
- autoload :Flash, 'action_controller/old_base/chained/flash'
- autoload :RequestForgeryProtection, 'action_controller/old_base/request_forgery_protection'
- autoload :Streaming, 'action_controller/old_base/streaming'
- autoload :HttpAuthentication, 'action_controller/old_base/http_authentication'
- autoload :FilterParameterLogging, 'action_controller/old_base/filter_parameter_logging'
+ autoload :Verification, 'action_controller/base/verification'
+ autoload :Flash, 'action_controller/base/flash'
+ autoload :RequestForgeryProtection, 'action_controller/base/request_forgery_protection'
+ autoload :Streaming, 'action_controller/base/streaming'
+ autoload :HttpAuthentication, 'action_controller/base/http_authentication'
+ autoload :FilterParameterLogging, 'action_controller/base/filter_parameter_logging'
autoload :Translation, 'action_controller/translation'
- autoload :Cookies, 'action_controller/old_base/cookies'
+ autoload :Cookies, 'action_controller/base/cookies'
require 'action_controller/routing'
end
diff --git a/actionpack/lib/action_controller/old_base/cookies.rb b/actionpack/lib/action_controller/base/cookies.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/cookies.rb
rename to actionpack/lib/action_controller/base/cookies.rb
diff --git a/actionpack/lib/action_controller/old_base/filter_parameter_logging.rb b/actionpack/lib/action_controller/base/filter_parameter_logging.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/filter_parameter_logging.rb
rename to actionpack/lib/action_controller/base/filter_parameter_logging.rb
diff --git a/actionpack/lib/action_controller/old_base/chained/flash.rb b/actionpack/lib/action_controller/base/flash.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/chained/flash.rb
rename to actionpack/lib/action_controller/base/flash.rb
diff --git a/actionpack/lib/action_controller/old_base/http_authentication.rb b/actionpack/lib/action_controller/base/http_authentication.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/http_authentication.rb
rename to actionpack/lib/action_controller/base/http_authentication.rb
diff --git a/actionpack/lib/action_controller/old_base/mime_responds.rb b/actionpack/lib/action_controller/base/mime_responds.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/mime_responds.rb
rename to actionpack/lib/action_controller/base/mime_responds.rb
diff --git a/actionpack/lib/action_controller/old_base/request_forgery_protection.rb b/actionpack/lib/action_controller/base/request_forgery_protection.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/request_forgery_protection.rb
rename to actionpack/lib/action_controller/base/request_forgery_protection.rb
diff --git a/actionpack/lib/action_controller/old_base/session_management.rb b/actionpack/lib/action_controller/base/session_management.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/session_management.rb
rename to actionpack/lib/action_controller/base/session_management.rb
diff --git a/actionpack/lib/action_controller/old_base/streaming.rb b/actionpack/lib/action_controller/base/streaming.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/streaming.rb
rename to actionpack/lib/action_controller/base/streaming.rb
diff --git a/actionpack/lib/action_controller/old_base/verification.rb b/actionpack/lib/action_controller/base/verification.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/verification.rb
rename to actionpack/lib/action_controller/base/verification.rb
diff --git a/actionpack/lib/action_controller/old_base/layout.rb b/actionpack/lib/action_controller/legacy/layout.rb
similarity index 100%
rename from actionpack/lib/action_controller/old_base/layout.rb
rename to actionpack/lib/action_controller/legacy/layout.rb
diff --git a/actionpack/lib/action_controller/old_base/base.rb b/actionpack/lib/action_controller/old_base/base.rb
deleted file mode 100644
index 67369eb122..0000000000
--- a/actionpack/lib/action_controller/old_base/base.rb
+++ /dev/null
@@ -1,884 +0,0 @@
-require 'action_controller/deprecated'
-require 'set'
-require 'active_support/core_ext/class/inheritable_attributes'
-require 'active_support/core_ext/module/attr_internal'
-
-module ActionController #:nodoc:
- class ActionControllerError < StandardError #:nodoc:
- end
-
- class SessionRestoreError < ActionControllerError #:nodoc:
- end
-
- class RenderError < ActionControllerError #:nodoc:
- end
-
- class RoutingError < ActionControllerError #:nodoc:
- attr_reader :failures
- def initialize(message, failures=[])
- super(message)
- @failures = failures
- end
- end
-
- class MethodNotAllowed < ActionControllerError #:nodoc:
- attr_reader :allowed_methods
-
- def initialize(*allowed_methods)
- super("Only #{allowed_methods.to_sentence(:locale => :en)} requests are allowed.")
- @allowed_methods = allowed_methods
- end
-
- def allowed_methods_header
- allowed_methods.map { |method_symbol| method_symbol.to_s.upcase } * ', '
- end
- end
-
- class NotImplemented < MethodNotAllowed #:nodoc:
- end
-
- class UnknownController < ActionControllerError #:nodoc:
- end
-
- class UnknownAction < ActionControllerError #:nodoc:
- end
-
- class MissingFile < ActionControllerError #:nodoc:
- end
-
- class RenderError < ActionControllerError #:nodoc:
- end
-
- class SessionOverflowError < ActionControllerError #:nodoc:
- DEFAULT_MESSAGE = 'Your session data is larger than the data column in which it is to be stored. You must increase the size of your data column if you intend to store large data.'
-
- def initialize(message = nil)
- super(message || DEFAULT_MESSAGE)
- end
- end
-
- class UnknownHttpMethod < ActionControllerError #:nodoc:
- end
-
- # Action Controllers are the core of a web request in Rails. They are made up of one or more actions that are executed
- # on request and then either render a template or redirect to another action. An action is defined as a public method
- # on the controller, which will automatically be made accessible to the web-server through Rails Routes.
- #
- # A sample controller could look like this:
- #
- # class GuestBookController < ActionController::Base
- # def index
- # @entries = Entry.find(:all)
- # end
- #
- # def sign
- # Entry.create(params[:entry])
- # redirect_to :action => "index"
- # end
- # end
- #
- # Actions, by default, render a template in the app/views directory corresponding to the name of the controller and action
- # after executing code in the action. For example, the +index+ action of the GuestBookController would render the
- # template app/views/guestbook/index.erb by default after populating the @entries instance variable.
- #
- # Unlike index, the sign action will not render a template. After performing its main purpose (creating a
- # new entry in the guest book), it initiates a redirect instead. This redirect works by returning an external
- # "302 Moved" HTTP response that takes the user to the index action.
- #
- # The index and sign represent the two basic action archetypes used in Action Controllers. Get-and-show and do-and-redirect.
- # Most actions are variations of these themes.
- #
- # == Requests
- #
- # Requests are processed by the Action Controller framework by extracting the value of the "action" key in the request parameters.
- # This value should hold the name of the action to be performed. Once the action has been identified, the remaining
- # request parameters, the session (if one is available), and the full request with all the HTTP headers are made available to
- # the action through instance variables. Then the action is performed.
- #
- # The full request object is available with the request accessor and is primarily used to query for HTTP headers. These queries
- # are made by accessing the environment hash, like this:
- #
- # def server_ip
- # location = request.env["SERVER_ADDR"]
- # render :text => "This server hosted at #{location}"
- # end
- #
- # == Parameters
- #
- # All request parameters, whether they come from a GET or POST request, or from the URL, are available through the params method
- # which returns a hash. For example, an action that was performed through /weblog/list?category=All&limit=5 will include
- # { "category" => "All", "limit" => 5 } in params.
- #
- # It's also possible to construct multi-dimensional parameter hashes by specifying keys using brackets, such as:
- #
- #
- #
- #
- # A request stemming from a form holding these inputs will include { "post" => { "name" => "david", "address" => "hyacintvej" } }.
- # If the address input had been named "post[address][street]", the params would have included
- # { "post" => { "address" => { "street" => "hyacintvej" } } }. There's no limit to the depth of the nesting.
- #
- # == Sessions
- #
- # Sessions allows you to store objects in between requests. This is useful for objects that are not yet ready to be persisted,
- # such as a Signup object constructed in a multi-paged process, or objects that don't change much and are needed all the time, such
- # as a User object for a system that requires login. The session should not be used, however, as a cache for objects where it's likely
- # they could be changed unknowingly. It's usually too much work to keep it all synchronized -- something databases already excel at.
- #
- # You can place objects in the session by using the session method, which accesses a hash:
- #
- # session[:person] = Person.authenticate(user_name, password)
- #
- # And retrieved again through the same hash:
- #
- # Hello #{session[:person]}
- #
- # For removing objects from the session, you can either assign a single key to +nil+:
- #
- # # removes :person from session
- # session[:person] = nil
- #
- # or you can remove the entire session with +reset_session+.
- #
- # Sessions are stored by default in a browser cookie that's cryptographically signed, but unencrypted.
- # This prevents the user from tampering with the session but also allows him to see its contents.
- #
- # Do not put secret information in cookie-based sessions!
- #
- # Other options for session storage are:
- #
- # * ActiveRecord::SessionStore - Sessions are stored in your database, which works better than PStore with multiple app servers and,
- # unlike CookieStore, hides your session contents from the user. To use ActiveRecord::SessionStore, set
- #
- # config.action_controller.session_store = :active_record_store
- #
- # in your config/environment.rb and run rake db:sessions:create.
- #
- # * MemCacheStore - Sessions are stored as entries in your memcached cache.
- # Set the session store type in config/environment.rb:
- #
- # config.action_controller.session_store = :mem_cache_store
- #
- # This assumes that memcached has been installed and configured properly.
- # See the MemCacheStore docs for more information.
- #
- # == Responses
- #
- # Each action results in a response, which holds the headers and document to be sent to the user's browser. The actual response
- # object is generated automatically through the use of renders and redirects and requires no user intervention.
- #
- # == 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.
- # The controller passes objects to the view by assigning instance variables:
- #
- # def show
- # @post = Post.find(params[:id])
- # end
- #
- # Which are then automatically available to the view:
- #
- # Title: <%= @post.title %>
- #
- # You don't have to rely on the automated rendering. Especially actions that could result in the rendering of different templates will use
- # the manual rendering methods:
- #
- # def search
- # @results = Search.find(params[:query])
- # case @results
- # when 0 then render :action => "no_results"
- # when 1 then render :action => "show"
- # when 2..10 then render :action => "show_many"
- # end
- # end
- #
- # Read more about writing ERb and Builder templates in link:classes/ActionView/Base.html.
- #
- # == Redirects
- #
- # Redirects are used to move from one action to another. For example, after a create action, which stores a blog entry to a database,
- # we might like to show the user the new entry. Because we're following good DRY principles (Don't Repeat Yourself), we're going to reuse (and redirect to)
- # a show action that we'll assume has already been created. The code might look like this:
- #
- # def create
- # @entry = Entry.new(params[:entry])
- # if @entry.save
- # # The entry was saved correctly, redirect to show
- # redirect_to :action => 'show', :id => @entry.id
- # else
- # # things didn't go so well, do something else
- # end
- # end
- #
- # In this case, after saving our new entry to the database, the user is redirected to the show method which is then executed.
- #
- # == Calling multiple redirects or renders
- #
- # An action may contain only a single render or a single redirect. Attempting to try to do either again will result in a DoubleRenderError:
- #
- # def do_something
- # redirect_to :action => "elsewhere"
- # render :action => "overthere" # raises DoubleRenderError
- # end
- #
- # If you need to redirect on the condition of something, then be sure to add "and return" to halt execution.
- #
- # def do_something
- # redirect_to(:action => "elsewhere") and return if monkeys.nil?
- # render :action => "overthere" # won't be called if monkeys is nil
- # end
- #
- class Base
-
- include ActionDispatch::StatusCodes
-
- cattr_reader :protected_instance_variables
- # Controller specific instance variables which will not be accessible inside views.
- @@protected_instance_variables = %w(@assigns @performed_redirect @performed_render @variables_added @request_origin @url @parent_controller
- @action_name @before_filter_chain_aborted @action_cache_path @_headers @_params
- @_flash @_response)
-
- # Prepends all the URL-generating helpers from AssetHelper. This makes it possible to easily move javascripts, stylesheets,
- # and images to a dedicated asset server away from the main web server. Example:
- # ActionController::Base.asset_host = "http://assets.example.com"
- cattr_accessor :asset_host
-
- # All requests are considered local by default, so everyone will be exposed to detailed debugging screens on errors.
- # When the application is ready to go public, this should be set to false, and the protected method local_request?
- # should instead be implemented in the controller to determine when debugging screens should be shown.
- @@consider_all_requests_local = true
- cattr_accessor :consider_all_requests_local
-
- # Indicates whether to allow concurrent action processing. Your
- # controller actions and any other code they call must also behave well
- # when called from concurrent threads. Turned off by default.
- @@allow_concurrency = false
- cattr_accessor :allow_concurrency
-
- # Modern REST web services often need to submit complex data to the web application.
- # The @@param_parsers hash lets you register handlers which will process the HTTP body and add parameters to the
- # params hash. These handlers are invoked for POST and PUT requests.
- #
- # By default application/xml is enabled. A XmlSimple class with the same param name as the root will be instantiated
- # in the params. This allows XML requests to mask themselves as regular form submissions, so you can have one
- # action serve both regular forms and web service requests.
- #
- # Example of doing your own parser for a custom content type:
- #
- # ActionController::Base.param_parsers[Mime::Type.lookup('application/atom+xml')] = Proc.new do |data|
- # node = REXML::Document.new(post)
- # { node.root.name => node.root }
- # end
- #
- # Note: Up until release 1.1 of Rails, Action Controller would default to using XmlSimple configured to discard the
- # root node for such requests. The new default is to keep the root, such that "David" results
- # in params[:r][:name] for "David" instead of params[:name]. To get the old behavior, you can
- # re-register XmlSimple as application/xml handler ike this:
- #
- # ActionController::Base.param_parsers[Mime::XML] =
- # Proc.new { |data| XmlSimple.xml_in(data, 'ForceArray' => false) }
- #
- # A YAML parser is also available and can be turned on with:
- #
- # ActionController::Base.param_parsers[Mime::YAML] = :yaml
- @@param_parsers = { Mime::MULTIPART_FORM => :multipart_form,
- Mime::URL_ENCODED_FORM => :url_encoded_form,
- Mime::XML => :xml_simple,
- Mime::JSON => :json }
- cattr_accessor :param_parsers
-
- # Controls the default charset for all renders.
- @@default_charset = "utf-8"
- cattr_accessor :default_charset
-
- # The logger is used for generating information on the action run-time (including benchmarking) if available.
- # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
- cattr_accessor :logger
-
- # Controls the resource action separator
- @@resource_action_separator = "/"
- cattr_accessor :resource_action_separator
-
- # Allow to override path names for default resources' actions
- @@resources_path_names = { :new => 'new', :edit => 'edit' }
- cattr_accessor :resources_path_names
-
- # Sets the token parameter name for RequestForgery. Calling +protect_from_forgery+
- # sets it to :authenticity_token by default.
- cattr_accessor :request_forgery_protection_token
-
- # Controls the IP Spoofing check when determining the remote IP.
- @@ip_spoofing_check = true
- cattr_accessor :ip_spoofing_check
-
- # Indicates whether or not optimise the generated named
- # route helper methods
- cattr_accessor :optimise_named_routes
- self.optimise_named_routes = true
-
- # Indicates whether the response format should be determined by examining the Accept HTTP header,
- # or by using the simpler params + ajax rules.
- #
- # If this is set to +true+ (the default) then +respond_to+ and +Request#format+ will take the Accept
- # header into account. If it is set to false then the request format will be determined solely
- # by examining params[:format]. If params format is missing, the format will be either HTML or
- # Javascript depending on whether the request is an AJAX request.
- cattr_accessor :use_accept_header
- self.use_accept_header = true
-
- # Controls whether request forgergy protection is turned on or not. Turned off by default only in test mode.
- class_inheritable_accessor :allow_forgery_protection
- self.allow_forgery_protection = true
-
- # If you are deploying to a subdirectory, you will need to set
- # config.action_controller.relative_url_root
- # This defaults to ENV['RAILS_RELATIVE_URL_ROOT']
- cattr_accessor :relative_url_root
- self.relative_url_root = ENV['RAILS_RELATIVE_URL_ROOT']
-
- # Holds the request object that's primarily used to get environment variables through access like
- # request.env["REQUEST_URI"].
- attr_internal :request
-
- # Holds a hash of all the GET, POST, and Url parameters passed to the action. Accessed like params["post_id"]
- # to get the post_id. No type casts are made, so all values are returned as strings.
- attr_internal :params
-
- # Holds the response object that's primarily used to set additional HTTP headers through access like
- # response.headers["Cache-Control"] = "no-cache". Can also be used to access the final body HTML after a template
- # has been rendered through response.body -- useful for after_filters that wants to manipulate the output,
- # such as a OutputCompressionFilter.
- attr_internal :response
-
- # Holds a hash of objects in the session. Accessed like session[:person] to get the object tied to the "person"
- # key. The session will hold any type of object as values, but the key should be a string or symbol.
- def session
- request.session
- end
-
- # Holds a hash of header names and values. Accessed like headers["Cache-Control"] to get the value of the Cache-Control
- # directive. Values should always be specified as strings.
- attr_internal :headers
-
- # Returns the name of the action this controller is processing.
- attr_accessor :action_name
-
- attr_reader :template
-
- def action(name, env)
- request = ActionDispatch::Request.new(env)
- response = ActionDispatch::Response.new
- self.action_name = name && name.to_s
- process(request, response).to_a
- end
-
-
- class << self
- def action(name = nil)
- @actions ||= {}
- @actions[name] ||= proc do |env|
- new.action(name, env)
- end
- end
-
- # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
- def controller_class_name
- @controller_class_name ||= name.demodulize
- end
-
- # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
- def controller_name
- @controller_name ||= controller_class_name.sub(/Controller$/, '').underscore
- end
-
- # Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
- def controller_path
- @controller_path ||= name.gsub(/Controller$/, '').underscore
- end
-
- # Return an array containing the names of public methods that have been marked hidden from the action processor.
- # By default, all methods defined in ActionController::Base and included modules are hidden.
- # More methods can be hidden using hide_action.
- def hidden_actions
- read_inheritable_attribute(:hidden_actions) || write_inheritable_attribute(:hidden_actions, [])
- end
-
- # Hide each of the given methods from being callable as actions.
- def hide_action(*names)
- write_inheritable_attribute(:hidden_actions, hidden_actions | names.map { |name| name.to_s })
- end
-
- # View load paths determine the bases from which template references can be made. So a call to
- # render("test/template") will be looked up in the view load paths array and the closest match will be
- # returned.
- def view_paths
- if defined? @view_paths
- @view_paths
- else
- superclass.view_paths
- end
- end
-
- def view_paths=(value)
- @view_paths = ActionView::Base.process_view_paths(value) if value
- end
-
- # Adds a view_path to the front of the view_paths array.
- # If the current class has no view paths, copy them from
- # the superclass. This change will be visible for all future requests.
- #
- # ArticleController.prepend_view_path("views/default")
- # ArticleController.prepend_view_path(["views/default", "views/custom"])
- #
- def prepend_view_path(path)
- @view_paths = superclass.view_paths.dup if !defined?(@view_paths) || @view_paths.nil?
- @view_paths.unshift(*path)
- end
-
- # Adds a view_path to the end of the view_paths array.
- # If the current class has no view paths, copy them from
- # the superclass. This change will be visible for all future requests.
- #
- # ArticleController.append_view_path("views/default")
- # ArticleController.append_view_path(["views/default", "views/custom"])
- #
- def append_view_path(path)
- @view_paths = superclass.view_paths.dup if @view_paths.nil?
- @view_paths.push(*path)
- end
-
- @@exempt_from_layout = [ActionView::TemplateHandlers::RJS]
-
- def exempt_from_layout(*types)
- types.each do |type|
- @@exempt_from_layout <<
- ActionView::Template.handler_class_for_extension(type)
- end
-
- @@exempt_from_layout
- end
-
- end
-
- public
- def call(env)
- request = ActionDispatch::Request.new(env)
- response = ActionDispatch::Response.new
- process(request, response).to_a
- end
-
- # Extracts the action_name from the request parameters and performs that action.
- def process(request, response, method = :perform_action, *arguments) #:nodoc:
- response.request = request
-
- assign_shortcuts(request, response)
- initialize_template_class(response)
- initialize_current_url
-
- log_processing
- send(method, *arguments)
-
- send_response
- ensure
- process_cleanup
- end
-
- def send_response
- response.prepare!
- response
- end
-
- # Returns a URL that has been rewritten according to the options hash and the defined routes.
- # (For doing a complete redirect, use +redirect_to+).
- #
- # url_for is used to:
- #
- # All keys given to +url_for+ are forwarded to the Route module, save for the following:
- # * :anchor - Specifies the anchor name to be appended to the path. For example,
- # url_for :controller => 'posts', :action => 'show', :id => 10, :anchor => 'comments'
- # will produce "/posts/show/10#comments".
- # * :only_path - If true, returns the relative URL (omitting the protocol, host name, and port) (false by default).
- # * :trailing_slash - If true, adds a trailing slash, as in "/archive/2005/". Note that this
- # is currently not recommended since it breaks caching.
- # * :host - Overrides the default (current) host if provided.
- # * :protocol - Overrides the default (current) protocol if provided.
- # * :port - Optionally specify the port to connect to.
- # * :user - Inline HTTP authentication (only plucked out if :password is also present).
- # * :password - Inline HTTP authentication (only plucked out if :user is also present).
- # * :skip_relative_url_root - If true, the url is not constructed using the +relative_url_root+
- # of the request so the path will include the web server relative installation directory.
- #
- # The URL is generated from the remaining keys in the hash. A URL contains two key parts: the and a query string.
- # Routes composes a query string as the key/value pairs not included in the .
- #
- # The default Routes setup supports a typical Rails path of "controller/action/id" where action and id are optional, with
- # action defaulting to 'index' when not given. Here are some typical url_for statements and their corresponding URLs:
- #
- # url_for :controller => 'posts', :action => 'recent' # => 'proto://host.com/posts/recent'
- # url_for :controller => 'posts', :action => 'index' # => 'proto://host.com/posts'
- # url_for :controller => 'posts', :action => 'index', :port=>'8033' # => 'proto://host.com:8033/posts'
- # url_for :controller => 'posts', :action => 'show', :id => 10 # => 'proto://host.com/posts/show/10'
- # url_for :controller => 'posts', :user => 'd', :password => '123' # => 'proto://d:123@host.com/posts'
- #
- # When generating a new URL, missing values may be filled in from the current request's parameters. For example,
- # url_for :action => 'some_action' will retain the current controller, as expected. This behavior extends to
- # other parameters, including :controller, :id, and any other parameters that are placed into a Route's
- # path.
- #
- # The URL helpers such as url_for have a limited form of memory: when generating a new URL, they can look for
- # missing values in the current request's parameters. Routes attempts to guess when a value should and should not be
- # taken from the defaults. There are a few simple rules on how this is performed:
- #
- # * If the controller name begins with a slash no defaults are used:
- #
- # url_for :controller => '/home'
- #
- # In particular, a leading slash ensures no namespace is assumed. Thus,
- # while url_for :controller => 'users' may resolve to
- # Admin::UsersController if the current controller lives under
- # that module, url_for :controller => '/users' ensures you link
- # to ::UsersController no matter what.
- # * If the controller changes, the action will default to index unless provided
- #
- # The final rule is applied while the URL is being generated and is best illustrated by an example. Let us consider the
- # route given by map.connect 'people/:last/:first/:action', :action => 'bio', :controller => 'people'.
- #
- # Suppose that the current URL is "people/hh/david/contacts". Let's consider a few different cases of URLs which are generated
- # from this page.
- #
- # * url_for :action => 'bio' -- During the generation of this URL, default values will be used for the first and
- # last components, and the action shall change. The generated URL will be, "people/hh/david/bio".
- # * url_for :first => 'davids-little-brother' This generates the URL 'people/hh/davids-little-brother' -- note
- # that this URL leaves out the assumed action of 'bio'.
- #
- # However, you might ask why the action from the current request, 'contacts', isn't carried over into the new URL. The
- # answer has to do with the order in which the parameters appear in the generated path. In a nutshell, since the
- # value that appears in the slot for :first is not equal to default value for :first we stop using
- # defaults. On its own, this rule can account for much of the typical Rails URL behavior.
- #
- # Although a convenience, defaults can occasionally get in your way. In some cases a default persists longer than desired.
- # The default may be cleared by adding :name => nil to url_for's options.
- # This is often required when writing form helpers, since the defaults in play may vary greatly depending upon where the
- # helper is used from. The following line will redirect to PostController's default action, regardless of the page it is
- # displayed on:
- #
- # url_for :controller => 'posts', :action => nil
- #
- # If you explicitly want to create a URL that's almost the same as the current URL, you can do so using the
- # :overwrite_params options. Say for your posts you have different views for showing and printing them.
- # Then, in the show view, you get the URL for the print view like this
- #
- # url_for :overwrite_params => { :action => 'print' }
- #
- # This takes the current URL as is and only exchanges the action. In contrast, url_for :action => 'print'
- # would have slashed-off the path components after the changed action.
- def url_for(options = {})
- options ||= {}
- case options
- when String
- options
- when Hash
- @url.rewrite(rewrite_options(options))
- else
- polymorphic_url(options)
- end
- end
-
- # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
- def controller_class_name
- self.class.controller_class_name
- end
-
- # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
- def controller_name
- self.class.controller_name
- end
-
- # Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
- def controller_path
- self.class.controller_path
- end
-
- def session_enabled?
- ActiveSupport::Deprecation.warn("Sessions are now lazy loaded. So if you don't access them, consider them disabled.", caller)
- end
-
- self.view_paths = []
-
- # View load paths for controller.
- def view_paths
- @template.view_paths
- end
-
- def view_paths=(value)
- @template.view_paths = ActionView::Base.process_view_paths(value)
- end
-
- # Adds a view_path to the front of the view_paths array.
- # This change affects the current request only.
- #
- # self.prepend_view_path("views/default")
- # self.prepend_view_path(["views/default", "views/custom"])
- #
- def prepend_view_path(path)
- @template.view_paths.unshift(*path)
- end
-
- # Adds a view_path to the end of the view_paths array.
- # This change affects the current request only.
- #
- # self.append_view_path("views/default")
- # self.append_view_path(["views/default", "views/custom"])
- #
- def append_view_path(path)
- @template.view_paths.push(*path)
- end
-
- def rewrite_options(options) #:nodoc:
- if defaults = default_url_options(options)
- defaults.merge(options)
- else
- options
- end
- end
-
- # Overwrite to implement a number of default options that all url_for-based methods will use. The default options should come in
- # the form of a hash, just like the one you would use for url_for directly. Example:
- #
- # def default_url_options(options)
- # { :project => @project.active? ? @project.url_name : "unknown" }
- # end
- #
- # As you can infer from the example, this is mostly useful for situations where you want to centralize dynamic decisions about the
- # urls as they stem from the business domain. Please note that any individual url_for call can always override the defaults set
- # by this method.
- def default_url_options(options = nil)
- end
-
- # Sets the etag and/or last_modified on the response and checks it against
- # the client request. If the request doesn't match the options provided, the
- # request is considered stale and should be generated from scratch. Otherwise,
- # it's fresh and we don't need to generate anything and a reply of "304 Not Modified" is sent.
- #
- # Parameters:
- # * :etag
- # * :last_modified
- # * :public By default the Cache-Control header is private, set this to true if you want your application to be cachable by other devices (proxy caches).
- #
- # Example:
- #
- # def show
- # @article = Article.find(params[:id])
- #
- # if stale?(:etag => @article, :last_modified => @article.created_at.utc)
- # @statistics = @article.really_expensive_call
- # respond_to do |format|
- # # all the supported formats
- # end
- # end
- # end
- def stale?(options)
- fresh_when(options)
- !request.fresh?(response)
- end
-
- # Sets the etag, last_modified, or both on the response and renders a
- # "304 Not Modified" response if the request is already fresh.
- #
- # Parameters:
- # * :etag
- # * :last_modified
- # * :public By default the Cache-Control header is private, set this to true if you want your application to be cachable by other devices (proxy caches).
- #
- # Example:
- #
- # def show
- # @article = Article.find(params[:id])
- # fresh_when(:etag => @article, :last_modified => @article.created_at.utc, :public => true)
- # end
- #
- # This will render the show template if the request isn't sending a matching etag or
- # If-Modified-Since header and just a "304 Not Modified" response if there's a match.
- #
- def fresh_when(options)
- options.assert_valid_keys(:etag, :last_modified, :public)
-
- response.etag = options[:etag] if options[:etag]
- response.last_modified = options[:last_modified] if options[:last_modified]
-
- if options[:public]
- cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
- cache_control.delete("private")
- cache_control.delete("no-cache")
- cache_control << "public"
- response.headers["Cache-Control"] = cache_control.join(', ')
- end
-
- if request.fresh?(response)
- head :not_modified
- end
- end
-
- # Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a "private" instruction, so that
- # intermediate caches shouldn't cache the response.
- #
- # Examples:
- # expires_in 20.minutes
- # expires_in 3.hours, :public => true
- # expires in 3.hours, 'max-stale' => 5.hours, :public => true
- #
- # This method will overwrite an existing Cache-Control header.
- # See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.
- def expires_in(seconds, options = {}) #:doc:
- cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
-
- cache_control << "max-age=#{seconds}"
- cache_control.delete("no-cache")
- if options[:public]
- cache_control.delete("private")
- cache_control << "public"
- else
- cache_control << "private"
- end
-
- # This allows for additional headers to be passed through like 'max-stale' => 5.hours
- cache_control += options.symbolize_keys.reject{|k,v| k == :public || k == :private }.map{ |k,v| v == true ? k.to_s : "#{k.to_s}=#{v.to_s}"}
-
- response.headers["Cache-Control"] = cache_control.join(', ')
- end
-
- # Sets a HTTP 1.1 Cache-Control header of "no-cache" so no caching should occur by the browser or
- # intermediate caches (like caching proxy servers).
- def expires_now #:doc:
- response.headers["Cache-Control"] = "no-cache"
- end
-
- # Resets the session by clearing out all the objects stored within and initializing a new session object.
- def reset_session #:doc:
- request.reset_session
- end
-
- private
- def _process_options(options)
- if content_type = options[:content_type]
- response.content_type = content_type.to_s
- end
-
- if location = options[:location]
- response.headers["Location"] = url_for(location)
- end
-
- response.status = interpret_status(options[:status] || DEFAULT_RENDER_STATUS_CODE)
- end
-
- def initialize_template_class(response)
- @template = ActionView::Base.new(self.class.view_paths, {}, self, formats)
- response.template = @template if response.respond_to?(:template=)
- @template.helpers.send :include, self.class.master_helper_module
- @performed_render = @performed_redirect = false
- end
-
- def assign_shortcuts(request, response)
- @_request, @_response, @_params = request, response, request.parameters
- @_headers = @_response.headers
- end
-
- def initialize_current_url
- @url = UrlRewriter.new(request, params.clone)
- end
-
- def log_processing
- if logger && logger.info?
- log_processing_for_request_id
- log_processing_for_parameters
- end
- end
-
- def log_processing_for_request_id
- request_id = "\n\nProcessing #{self.class.name}\##{action_name} "
- request_id << "to #{params[:format]} " if params[:format]
- request_id << "(for #{request_origin}) [#{request.method.to_s.upcase}]"
-
- logger.info(request_id)
- end
-
- def default_render #:nodoc:
- render
- end
-
- def perform_action
- if called = action_methods.include?(action_name)
- ret = send(action_name)
- elsif called = respond_to?(:method_missing)
- ret = method_missing(action_name)
- end
-
- return (performed? ? ret : default_render) if called
-
- begin
- view_paths.find_by_parts(action_name, {:formats => formats, :locales => [I18n.locale]}, controller_path)
- rescue => e
- raise UnknownAction, "No action responded to #{action_name}. Actions: " +
- "#{action_methods.sort.to_sentence}", caller
- end
-
- default_render
- end
-
- # Returns true if a render or redirect has already been performed.
- def performed?
- @performed_render || @performed_redirect
- end
-
- def reset_variables_added_to_assigns
- @template.instance_variable_set("@assigns_added", nil)
- end
-
- def request_origin
- # this *needs* to be cached!
- # otherwise you'd get different results if calling it more than once
- @request_origin ||= "#{request.remote_ip} at #{Time.now.to_s(:db)}"
- end
-
- # Returns the request URI used to get to the current location
- def complete_request_uri
- "#{request.protocol}#{request.host}#{request.request_uri}"
- end
-
- def default_template(action_name = self.action_name)
- self.view_paths.find_template(default_template_name(action_name), default_template_format)
- end
-
- def default_template_name(action_name = self.action_name)
- if action_name
- action_name = action_name.to_s
- if action_name.include?('/') && template_path_includes_controller?(action_name)
- action_name = strip_out_controller(action_name)
- end
- end
- "#{controller_path}/#{action_name}"
- end
-
- def strip_out_controller(path)
- path.split('/', 2).last
- end
-
- def template_path_includes_controller?(path)
- self.controller_path.split('/')[-1] == path.split('/')[0]
- end
-
- def process_cleanup
- end
- end
-
- Base.class_eval do
- [ Filters, Layout, Renderer, Redirector, Responder, Benchmarking, Rescue, Flash, MimeResponds, Helpers,
- Cookies, Caching, Verification, Streaming, SessionManagement,
- HttpAuthentication::Basic::ControllerMethods, HttpAuthentication::Digest::ControllerMethods, RecordIdentifier,
- RequestForgeryProtection, Translation, FilterParameterLogging
- ].each do |mod|
- include mod
- end
- end
-end
diff --git a/actionpack/lib/action_controller/old_base/chained/benchmarking.rb b/actionpack/lib/action_controller/old_base/chained/benchmarking.rb
deleted file mode 100644
index 57a1ac8314..0000000000
--- a/actionpack/lib/action_controller/old_base/chained/benchmarking.rb
+++ /dev/null
@@ -1,107 +0,0 @@
-require 'active_support/core_ext/benchmark'
-
-module ActionController #:nodoc:
- # The benchmarking module times the performance of actions and reports to the logger. If the Active Record
- # package has been included, a separate timing section for database calls will be added as well.
- module Benchmarking #:nodoc:
- def self.included(base)
- base.extend(ClassMethods)
-
- base.class_eval do
- alias_method_chain :perform_action, :benchmark
- alias_method_chain :render, :benchmark
- end
- end
-
- module ClassMethods
- # Log and benchmark the workings of a single block and silence whatever logging that may have happened inside it
- # (unless use_silence is set to false).
- #
- # The benchmark is only recorded if the current level of the logger matches the log_level, which makes it
- # easy to include benchmarking statements in production software that will remain inexpensive because the benchmark
- # will only be conducted if the log level is low enough.
- def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
- if logger && logger.level >= log_level
- result = nil
- ms = Benchmark.ms { result = use_silence ? silence { yield } : yield }
- logger.add(log_level, "#{title} (#{('%.1f' % ms)}ms)")
- result
- else
- yield
- end
- end
-
- # Silences the logger for the duration of the block.
- def silence
- old_logger_level, logger.level = logger.level, Logger::ERROR if logger
- yield
- ensure
- logger.level = old_logger_level if logger
- end
- end
-
- protected
- def render_with_benchmark(options = nil, extra_options = {}, &block)
- if logger
- if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
- db_runtime = ActiveRecord::Base.connection.reset_runtime
- end
-
- render_output = nil
- @view_runtime = Benchmark.ms { render_output = render_without_benchmark(options, extra_options, &block) }
-
- if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
- @db_rt_before_render = db_runtime
- @db_rt_after_render = ActiveRecord::Base.connection.reset_runtime
- @view_runtime -= @db_rt_after_render
- end
-
- render_output
- else
- render_without_benchmark(options, extra_options, &block)
- end
- end
-
- private
- def perform_action_with_benchmark
- if logger && logger.info?
- ms = [Benchmark.ms { perform_action_without_benchmark }, 0.01].max
- logging_view = defined?(@view_runtime)
- logging_active_record = Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
-
- log_message = 'Completed in %.0fms' % ms
-
- if logging_view || logging_active_record
- log_message << " ("
- log_message << view_runtime if logging_view
-
- if logging_active_record
- log_message << ", " if logging_view
- log_message << active_record_runtime + ")"
- else
- ")"
- end
- end
-
- log_message << " | #{response.status}"
- log_message << " [#{complete_request_uri rescue "unknown"}]"
-
- logger.info(log_message)
- response.headers["X-Runtime"] = "%.0f" % ms
- else
- perform_action_without_benchmark
- end
- end
-
- def view_runtime
- "View: %.0f" % @view_runtime
- end
-
- def active_record_runtime
- db_runtime = ActiveRecord::Base.connection.reset_runtime
- db_runtime += @db_rt_before_render if @db_rt_before_render
- db_runtime += @db_rt_after_render if @db_rt_after_render
- "DB: %.0f" % db_runtime
- end
- end
-end
diff --git a/actionpack/lib/action_controller/old_base/chained/filters.rb b/actionpack/lib/action_controller/old_base/chained/filters.rb
deleted file mode 100644
index f528dd0686..0000000000
--- a/actionpack/lib/action_controller/old_base/chained/filters.rb
+++ /dev/null
@@ -1,670 +0,0 @@
-module ActionController #:nodoc:
- module Filters #:nodoc:
- extend ActiveSupport::Concern
-
- class FilterChain < ActiveSupport::Callbacks::CallbackChain #:nodoc:
- def append_filter_to_chain(filters, filter_type, &block)
- pos = find_filter_append_position(filters, filter_type)
- update_filter_chain(filters, filter_type, pos, &block)
- end
-
- def prepend_filter_to_chain(filters, filter_type, &block)
- pos = find_filter_prepend_position(filters, filter_type)
- update_filter_chain(filters, filter_type, pos, &block)
- end
-
- def create_filters(filters, filter_type, &block)
- filters, conditions = extract_options(filters, &block)
- filters.map! { |filter| find_or_create_filter(filter, filter_type, conditions) }
- filters
- end
-
- def skip_filter_in_chain(*filters, &test)
- filters, conditions = extract_options(filters)
- filters.each do |filter|
- if callback = find(filter) then delete(callback) end
- end if conditions.empty?
- update_filter_in_chain(filters, :skip => conditions, &test)
- end
-
- private
- def update_filter_chain(filters, filter_type, pos, &block)
- new_filters = create_filters(filters, filter_type, &block)
- insert(pos, new_filters).flatten!
- end
-
- def find_filter_append_position(filters, filter_type)
- # appending an after filter puts it at the end of the call chain
- # before and around filters go before the first after filter in the chain
- unless filter_type == :after
- each_with_index do |f,i|
- return i if f.after?
- end
- end
- return -1
- end
-
- def find_filter_prepend_position(filters, filter_type)
- # prepending a before or around filter puts it at the front of the call chain
- # after filters go before the first after filter in the chain
- if filter_type == :after
- each_with_index do |f,i|
- return i if f.after?
- end
- return -1
- end
- return 0
- end
-
- def find_or_create_filter(filter, filter_type, options = {})
- update_filter_in_chain([filter], options)
-
- if found_filter = find(filter) { |f| f.type == filter_type }
- found_filter
- else
- filter_kind = case
- when filter.respond_to?(:before) && filter_type == :before
- :before
- when filter.respond_to?(:after) && filter_type == :after
- :after
- else
- :filter
- end
-
- case filter_type
- when :before
- BeforeFilter.new(filter_kind, filter, options)
- when :after
- AfterFilter.new(filter_kind, filter, options)
- else
- AroundFilter.new(filter_kind, filter, options)
- end
- end
- end
-
- def update_filter_in_chain(filters, options, &test)
- filters.map! { |f| block_given? ? find(f, &test) : find(f) }
- filters.compact!
-
- map! do |filter|
- if filters.include?(filter)
- new_filter = filter.dup
- new_filter.update_options!(options)
- new_filter
- else
- filter
- end
- end
- end
- end
-
- class Filter < ActiveSupport::Callbacks::Callback #:nodoc:
- def initialize(kind, method, options = {})
- super
- update_options! options
- end
-
- # override these to return true in appropriate subclass
- def before?
- false
- end
-
- def after?
- false
- end
-
- def around?
- false
- end
-
- # Make sets of strings from :only/:except options
- def update_options!(other)
- if other
- convert_only_and_except_options_to_sets_of_strings(other)
- if other[:skip]
- convert_only_and_except_options_to_sets_of_strings(other[:skip])
- end
- end
-
- options.update(other)
- end
-
- private
- def should_not_skip?(controller)
- if options[:skip]
- !included_in_action?(controller, options[:skip])
- else
- true
- end
- end
-
- def included_in_action?(controller, options)
- if options[:only]
- options[:only].include?(controller.action_name)
- elsif options[:except]
- !options[:except].include?(controller.action_name)
- else
- true
- end
- end
-
- def should_run_callback?(controller)
- should_not_skip?(controller) && included_in_action?(controller, options) && super
- end
-
- def convert_only_and_except_options_to_sets_of_strings(opts)
- [:only, :except].each do |key|
- if values = opts[key]
- opts[key] = Array(values).map {|val| val.to_s }.to_set
- end
- end
- end
- end
-
- class AroundFilter < Filter #:nodoc:
- def type
- :around
- end
-
- def around?
- true
- end
-
- def call(controller, &block)
- if should_run_callback?(controller)
- method = filter_responds_to_before_and_after? ? around_proc : self.method
-
- # For around_filter do |controller, action|
- if method.is_a?(Proc) && method.arity == 2
- evaluate_method(method, controller, block)
- else
- evaluate_method(method, controller, &block)
- end
- else
- block.call
- end
- end
-
- private
- def filter_responds_to_before_and_after?
- method.respond_to?(:before) && method.respond_to?(:after)
- end
-
- def around_proc
- Proc.new do |controller, action|
- method.before(controller)
-
- if controller.__send__(:performed?)
- controller.__send__(:halt_filter_chain, method, :rendered_or_redirected)
- else
- begin
- action.call
- ensure
- method.after(controller)
- end
- end
- end
- end
- end
-
- class BeforeFilter < Filter #:nodoc:
- def type
- :before
- end
-
- def before?
- true
- end
-
- def call(controller, &block)
- super
- if controller.__send__(:performed?)
- controller.__send__(:halt_filter_chain, method, :rendered_or_redirected)
- end
- end
- end
-
- class AfterFilter < Filter #:nodoc:
- def type
- :after
- end
-
- def after?
- true
- end
- end
-
- # Filters enable controllers to run shared pre- and post-processing code for its actions. These filters can be used to do
- # authentication, caching, or auditing before the intended action is performed. Or to do localization or output
- # compression after the action has been performed. Filters have access to the request, response, and all the instance
- # variables set by other filters in the chain or by the action (in the case of after filters).
- #
- # == Filter inheritance
- #
- # Controller inheritance hierarchies share filters downwards, but subclasses can also add or skip filters without
- # affecting the superclass. For example:
- #
- # class BankController < ActionController::Base
- # before_filter :audit
- #
- # private
- # def audit
- # # record the action and parameters in an audit log
- # end
- # end
- #
- # class VaultController < BankController
- # before_filter :verify_credentials
- #
- # private
- # def verify_credentials
- # # make sure the user is allowed into the vault
- # end
- # end
- #
- # Now any actions performed on the BankController will have the audit method called before. On the VaultController,
- # first the audit method is called, then the verify_credentials method. If the audit method renders or redirects, then
- # verify_credentials and the intended action are never called.
- #
- # == Filter types
- #
- # A filter can take one of three forms: method reference (symbol), external class, or inline method (proc). The first
- # is the most common and works by referencing a protected or private method somewhere in the inheritance hierarchy of
- # the controller by use of a symbol. In the bank example above, both BankController and VaultController use this form.
- #
- # Using an external class makes for more easily reused generic filters, such as output compression. External filter classes
- # are implemented by having a static +filter+ method on any class and then passing this class to the filter method. Example:
- #
- # class OutputCompressionFilter
- # def self.filter(controller)
- # controller.response.body = compress(controller.response.body)
- # end
- # end
- #
- # class NewspaperController < ActionController::Base
- # after_filter OutputCompressionFilter
- # end
- #
- # The filter method is passed the controller instance and is hence granted access to all aspects of the controller and can
- # manipulate them as it sees fit.
- #
- # The inline method (using a proc) can be used to quickly do something small that doesn't require a lot of explanation.
- # Or just as a quick test. It works like this:
- #
- # class WeblogController < ActionController::Base
- # before_filter { |controller| head(400) if controller.params["stop_action"] }
- # end
- #
- # As you can see, the block expects to be passed the controller after it has assigned the request to the internal variables.
- # This means that the block has access to both the request and response objects complete with convenience methods for params,
- # session, template, and assigns. Note: The inline method doesn't strictly have to be a block; any object that responds to call
- # and returns 1 or -1 on arity will do (such as a Proc or an Method object).
- #
- # Please note that around_filters function a little differently than the normal before and after filters with regard to filter
- # types. Please see the section dedicated to around_filters below.
- #
- # == Filter chain ordering
- #
- # Using before_filter and after_filter appends the specified filters to the existing chain. That's usually
- # just fine, but some times you care more about the order in which the filters are executed. When that's the case, you
- # can use prepend_before_filter and prepend_after_filter. Filters added by these methods will be put at the
- # beginning of their respective chain and executed before the rest. For example:
- #
- # class ShoppingController < ActionController::Base
- # before_filter :verify_open_shop
- #
- # class CheckoutController < ShoppingController
- # prepend_before_filter :ensure_items_in_cart, :ensure_items_in_stock
- #
- # The filter chain for the CheckoutController is now :ensure_items_in_cart, :ensure_items_in_stock,
- # :verify_open_shop. So if either of the ensure filters renders or redirects, we'll never get around to see if the shop
- # is open or not.
- #
- # You may pass multiple filter arguments of each type as well as a filter block.
- # If a block is given, it is treated as the last argument.
- #
- # == Around filters
- #
- # Around filters wrap an action, executing code both before and after.
- # They may be declared as method references, blocks, or objects responding
- # to +filter+ or to both +before+ and +after+.
- #
- # To use a method as an +around_filter+, pass a symbol naming the Ruby method.
- # Yield (or block.call) within the method to run the action.
- #
- # around_filter :catch_exceptions
- #
- # private
- # def catch_exceptions
- # yield
- # rescue => exception
- # logger.debug "Caught exception! #{exception}"
- # raise
- # end
- #
- # To use a block as an +around_filter+, pass a block taking as args both
- # the controller and the action block. You can't call yield directly from
- # an +around_filter+ block; explicitly call the action block instead:
- #
- # around_filter do |controller, action|
- # logger.debug "before #{controller.action_name}"
- # action.call
- # logger.debug "after #{controller.action_name}"
- # end
- #
- # To use a filter object with +around_filter+, pass an object responding
- # to :filter or both :before and :after. With a
- # filter method, yield to the block as above:
- #
- # around_filter BenchmarkingFilter
- #
- # class BenchmarkingFilter
- # def self.filter(controller, &block)
- # Benchmark.measure(&block)
- # end
- # end
- #
- # With +before+ and +after+ methods:
- #
- # around_filter Authorizer.new
- #
- # class Authorizer
- # # This will run before the action. Redirecting aborts the action.
- # def before(controller)
- # unless user.authorized?
- # redirect_to(login_url)
- # end
- # end
- #
- # # This will run after the action if and only if before did not render or redirect.
- # def after(controller)
- # end
- # end
- #
- # If the filter has +before+ and +after+ methods, the +before+ method will be
- # called before the action. If +before+ renders or redirects, the filter chain is
- # halted and +after+ will not be run. See Filter Chain Halting below for
- # an example.
- #
- # == Filter chain skipping
- #
- # Declaring a filter on a base class conveniently applies to its subclasses,
- # but sometimes a subclass should skip some of its superclass' filters:
- #
- # class ApplicationController < ActionController::Base
- # before_filter :authenticate
- # around_filter :catch_exceptions
- # end
- #
- # class WeblogController < ApplicationController
- # # Will run the :authenticate and :catch_exceptions filters.
- # end
- #
- # class SignupController < ApplicationController
- # # Skip :authenticate, run :catch_exceptions.
- # skip_before_filter :authenticate
- # end
- #
- # class ProjectsController < ApplicationController
- # # Skip :catch_exceptions, run :authenticate.
- # skip_filter :catch_exceptions
- # end
- #
- # class ClientsController < ApplicationController
- # # Skip :catch_exceptions and :authenticate unless action is index.
- # skip_filter :catch_exceptions, :authenticate, :except => :index
- # end
- #
- # == Filter conditions
- #
- # Filters may be limited to specific actions by declaring the actions to
- # include or exclude. Both options accept single actions
- # (:only => :index) or arrays of actions
- # (:except => [:foo, :bar]).
- #
- # class Journal < ActionController::Base
- # # Require authentication for edit and delete.
- # before_filter :authorize, :only => [:edit, :delete]
- #
- # # Passing options to a filter with a block.
- # around_filter(:except => :index) do |controller, action_block|
- # results = Profiler.run(&action_block)
- # controller.response.sub! "