Permalink
Browse files

test controller rescues

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@5504 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent f8486e8 commit f0753992ab8cc9bbbf9b047fdc56f8899df5635e @jeremy jeremy committed Nov 13, 2006
@@ -1,12 +1,36 @@
module ActionController #:nodoc:
- # Actions that fail to perform as expected throw exceptions. These exceptions can either be rescued for the public view
+ # Actions that fail to perform as expected throw exceptions. These exceptions can either be rescued for the public view
# (with a nice user-friendly explanation) or for the developers view (with tons of debugging information). The developers view
# is already implemented by the Action Controller, but the public view should be tailored to your specific application. So too
# could the decision on whether something is a public or a developer request.
#
# You can tailor the rescuing behavior and appearance by overwriting the following two stub methods.
module Rescue
+ LOCALHOST = '127.0.0.1'.freeze
+
+ DEFAULT_RESCUE_RESPONSE = :internal_server_error
+ DEFAULT_RESCUE_RESPONSES = {
+ 'ActionController::RoutingError' => :not_found,
+ 'ActionController::UnknownAction' => :not_found
+ }
+
+ DEFAULT_RESCUE_TEMPLATE = 'diagnostics'
+ DEFAULT_RESCUE_TEMPLATES = {
+ 'ActionController::MissingTemplate' => 'missing_template',
+ 'ActionController::RoutingError' => 'routing_error',
+ 'ActionController::UnknownAction' => 'unknown_action',
+ 'ActionView::TemplateError' => 'template_error'
+ }
+
def self.included(base) #:nodoc:
+ base.cattr_accessor :rescue_responses
+ base.rescue_responses = Hash.new(DEFAULT_RESCUE_RESPONSE)
+ base.rescue_responses.update DEFAULT_RESCUE_RESPONSES
+
+ base.cattr_accessor :rescue_templates
+ base.rescue_templates = Hash.new(DEFAULT_RESCUE_TEMPLATE)
+ base.rescue_templates.update DEFAULT_RESCUE_TEMPLATES
+
base.extend(ClassMethods)
base.class_eval do
alias_method_chain :perform_action, :rescue
@@ -38,103 +62,101 @@ def log_error(exception) #:doc:
logger.fatal(exception.to_s)
else
logger.fatal(
- "\n\n#{exception.class} (#{exception.message}):\n " +
- clean_backtrace(exception).join("\n ") +
+ "\n\n#{exception.class} (#{exception.message}):\n " +
+ clean_backtrace(exception).join("\n ") +
"\n\n"
)
end
end
+
# Overwrite to implement public exception handling (for requests answering false to <tt>local_request?</tt>).
def rescue_action_in_public(exception) #:doc:
- case exception
- when RoutingError, UnknownAction
- render_text(IO.read(File.join(RAILS_ROOT, 'public', '404.html')), "404 Not Found")
- else
- render_text(IO.read(File.join(RAILS_ROOT, 'public', '500.html')), "500 Internal Error")
+ render_optional_error_file response_code_for_rescue(exception)
+ end
+
+ def render_optional_error_file(status_code) #:nodoc:
+ status = interpret_status(status_code)
+ path = "#{RAILS_ROOT}/public/#{status[0,3]}.html"
+ if File.exists?(path)
+ render :file => path, :status => status
+ else
+ head status
end
end
- # Overwrite to expand the meaning of a local request in order to show local rescues on other occurrences than
- # the remote IP being 127.0.0.1. For example, this could include the IP of the developer machine when debugging
- # remotely.
+ # True if the request came from localhost, 127.0.0.1. Override this
+ # method if you wish to redefine the meaning of a local request to
+ # include remote IP addresses or other criteria.
def local_request? #:doc:
- [request.remote_addr, request.remote_ip] == ["127.0.0.1"] * 2
+ request.remote_addr == LOCALHOST and request.remote_ip == LOCALHOST
end
- # Renders a detailed diagnostics screen on action exceptions.
+ # Render detailed diagnostics for unhandled exceptions rescued from
+ # a controller action.
def rescue_action_locally(exception)
add_variables_to_assigns
@template.instance_variable_set("@exception", exception)
- @template.instance_variable_set("@rescues_path", File.dirname(rescues_path("stub")))
+ @template.instance_variable_set("@rescues_path", File.dirname(rescues_path("stub")))
@template.send(:assign_variables_from_controller)
@template.instance_variable_set("@contents", @template.render_file(template_path_for_local_rescue(exception), false))
-
+
response.content_type = Mime::HTML
render_file(rescues_path("layout"), response_code_for_rescue(exception))
end
-
+
private
def perform_action_with_rescue #:nodoc:
- begin
- perform_action_without_rescue
- rescue Exception => exception # errors from action performed
- if defined?(Breakpoint) && params["BP-RETRY"]
- msg = exception.backtrace.first
- if md = /^(.+?):(\d+)(?::in `(.+)')?$/.match(msg) then
- origin_file, origin_line = md[1], md[2].to_i
-
- set_trace_func(lambda do |type, file, line, method, context, klass|
- if file == origin_file and line == origin_line then
- set_trace_func(nil)
- params["BP-RETRY"] = false
-
- callstack = caller
- callstack.slice!(0) if callstack.first["rescue.rb"]
- file, line, method = *callstack.first.match(/^(.+?):(\d+)(?::in `(.*?)')?/).captures
-
- message = "Exception at #{file}:#{line}#{" in `#{method}'" if method}." # `´ ( for ruby-mode)
-
- Breakpoint.handle_breakpoint(context, message, file, line)
- end
- end)
-
- retry
- end
- end
+ perform_action_without_rescue
+ rescue Exception => exception # errors from action performed
+ if defined?(Breakpoint) && params["BP-RETRY"]
+ msg = exception.backtrace.first
+ if md = /^(.+?):(\d+)(?::in `(.+)')?$/.match(msg) then
+ origin_file, origin_line = md[1], md[2].to_i
+
+ set_trace_func(lambda do |type, file, line, method, context, klass|
+ if file == origin_file and line == origin_line then
+ set_trace_func(nil)
+ params["BP-RETRY"] = false
+
+ callstack = caller
+ callstack.slice!(0) if callstack.first["rescue.rb"]
+ file, line, method = *callstack.first.match(/^(.+?):(\d+)(?::in `(.*?)')?/).captures
- rescue_action(exception)
+ message = "Exception at #{file}:#{line}#{" in `#{method}'" if method}." # `´ ( for ruby-mode)
+
+ Breakpoint.handle_breakpoint(context, message, file, line)
+ end
+ end)
+
+ retry
+ end
end
+
+ rescue_action(exception)
end
def rescues_path(template_name)
- File.dirname(__FILE__) + "/templates/rescues/#{template_name}.rhtml"
+ "#{File.dirname(__FILE__)}/templates/rescues/#{template_name}.rhtml"
end
def template_path_for_local_rescue(exception)
- rescues_path(
- case exception
- when MissingTemplate then "missing_template"
- when RoutingError then "routing_error"
- when UnknownAction then "unknown_action"
- when ActionView::TemplateError then "template_error"
- else "diagnostics"
- end
- )
+ rescues_path(rescue_templates[exception.class.name])
end
-
+
def response_code_for_rescue(exception)
- case exception
- when UnknownAction, RoutingError
- "404 Page Not Found"
- else
- "500 Internal Error"
- end
+ rescue_responses[exception.class.name]
end
-
+
def clean_backtrace(exception)
- exception.backtrace.collect { |line| Object.const_defined?(:RAILS_ROOT) ? line.gsub(RAILS_ROOT, "") : line }
+ if backtrace = exception.backtrace
+ if defined?(RAILS_ROOT)
+ backtrace.map { |line| line.sub RAILS_ROOT, '' }
+ else
+ backtrace
+ end
+ end
end
end
end
@@ -10,7 +10,7 @@
<% begin %>
<%= form_tag(request.request_uri, "method" => request.method) %>
<input type="hidden" name="BP-RETRY" value="1" />
-
+
<% for key, values in params %>
<% next if key == "BP-RETRY" %>
<% for value in Array(values) %>
@@ -26,19 +26,19 @@
<% end %>
<%
- request_parameters_without_action = request.parameters.clone
- request_parameters_without_action.delete("action")
- request_parameters_without_action.delete("controller")
-
- request_dump = request_parameters_without_action.inspect.gsub(/,/, ",\n")
+ clean_params = request.parameters.clone
+ clean_params.delete("action")
+ clean_params.delete("controller")
+
+ request_dump = clean_params.empty? ? 'None' : clean_params.inspect.gsub(',', ",\n")
%>
<h2 style="margin-top: 30px">Request</h2>
-<p><b>Parameters</b>: <%=h request_dump == "{}" ? "None" : request_dump %></p>
+<p><b>Parameters</b>: <pre><%=h request_dump %></pre></p>
<p><a href="#" onclick="document.getElementById('session_dump').style.display='block'; return false;">Show session dump</a></p>
<div id="session_dump" style="display:none"><%= debug(request.session.instance_variable_get("@data")) %></div>
<h2 style="margin-top: 30px">Response</h2>
-<b>Headers</b>: <%=h response ? response.headers.inspect.gsub(/,/, ",\n") : "None" %><br/>
+<p><b>Headers</b>: <pre><%=h response ? response.headers.inspect.gsub(',', ",\n") : 'None' %></pre></p>
Oops, something went wrong.

0 comments on commit f075399

Please sign in to comment.