123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::ExceptionWrapper

Relationships & Source Files
Inherits: Object
Defined in: actionpack/lib/action_dispatch/middleware/exception_wrapper.rb

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(backtrace_cleaner, exception) ⇒ ExceptionWrapper

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 34

def initialize(backtrace_cleaner, exception)
  @backtrace_cleaner = backtrace_cleaner
  @exception = original_exception(exception)

  expand_backtrace if exception.is_a?(SyntaxError) || exception.cause.is_a?(SyntaxError)
end

Class Attribute Details

.rescue_responses (rw) Also known as: #rescue_responses

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 8

cattr_accessor :rescue_responses, default: Hash.new(:internal_server_error).merge!(
  "ActionController::RoutingError"               => :not_found,
  "AbstractController::ActionNotFound"           => :not_found,
  "ActionController::MethodNotAllowed"           => :method_not_allowed,
  "ActionController::UnknownHttpMethod"          => :method_not_allowed,
  "ActionController::NotImplemented"             => :not_implemented,
  "ActionController::UnknownFormat"              => :not_acceptable,
  "ActionController::InvalidAuthenticityToken"   => :unprocessable_entity,
  "ActionController::InvalidCrossOriginRequest"  => :unprocessable_entity,
  "ActionDispatch::Http::Parameters::ParseError" => :bad_request,
  "ActionController::BadRequest"                 => :bad_request,
  "ActionController::ParameterMissing"           => :bad_request,
  "Rack::QueryParser::ParameterTypeError"        => :bad_request,
  "Rack::QueryParser::InvalidParameterError"     => :bad_request
)

.rescue_templates (rw) Also known as: #rescue_templates

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 24

cattr_accessor :rescue_templates, default: Hash.new("diagnostics").merge!(
  "ActionView::MissingTemplate"         => "missing_template",
  "ActionController::RoutingError"      => "routing_error",
  "AbstractController::ActionNotFound"  => "unknown_action",
  "ActiveRecord::StatementInvalid"      => "invalid_statement",
  "ActionView::Template::Error"         => "template_error"
)

Class Method Details

.status_code_for_exception(class_name)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 85

def self.status_code_for_exception(class_name)
  Rack::Utils.status_code(@@rescue_responses[class_name])
end

Instance Attribute Details

#backtrace_cleaner (readonly)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 32

attr_reader :backtrace_cleaner, :exception, :line_number, :file

#exception (readonly)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 32

attr_reader :backtrace_cleaner, :exception, :line_number, :file

#file (readonly)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 32

attr_reader :backtrace_cleaner, :exception, :line_number, :file

#line_number (readonly)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 32

attr_reader :backtrace_cleaner, :exception, :line_number, :file

#rescue_responses (rw)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 8

cattr_accessor :rescue_responses, default: Hash.new(:internal_server_error).merge!(
  "ActionController::RoutingError"               => :not_found,
  "AbstractController::ActionNotFound"           => :not_found,
  "ActionController::MethodNotAllowed"           => :method_not_allowed,
  "ActionController::UnknownHttpMethod"          => :method_not_allowed,
  "ActionController::NotImplemented"             => :not_implemented,
  "ActionController::UnknownFormat"              => :not_acceptable,
  "ActionController::InvalidAuthenticityToken"   => :unprocessable_entity,
  "ActionController::InvalidCrossOriginRequest"  => :unprocessable_entity,
  "ActionDispatch::Http::Parameters::ParseError" => :bad_request,
  "ActionController::BadRequest"                 => :bad_request,
  "ActionController::ParameterMissing"           => :bad_request,
  "Rack::QueryParser::ParameterTypeError"        => :bad_request,
  "Rack::QueryParser::InvalidParameterError"     => :bad_request
)

#rescue_templates (rw)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 24

cattr_accessor :rescue_templates, default: Hash.new("diagnostics").merge!(
  "ActionView::MissingTemplate"         => "missing_template",
  "ActionController::RoutingError"      => "routing_error",
  "AbstractController::ActionNotFound"  => "unknown_action",
  "ActiveRecord::StatementInvalid"      => "invalid_statement",
  "ActionView::Template::Error"         => "template_error"
)

Instance Method Details

#application_trace

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 49

def application_trace
  clean_backtrace(:silent)
end

#framework_trace

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 53

def framework_trace
  clean_backtrace(:noise)
end

#full_trace

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 57

def full_trace
  clean_backtrace(:all)
end

#rescue_template

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 41

def rescue_template
  @@rescue_templates[@exception.class.name]
end

#source_extracts

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 89

def source_extracts
  backtrace.map do |trace|
    file, line_number = extract_file_and_line_number(trace)

    {
      code: source_fragment(file, line_number),
      line_number: line_number
    }
  end
end

#status_code

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 45

def status_code
  self.class.status_code_for_exception(@exception.class.name)
end

#traces

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 61

def traces
  application_trace_with_ids = []
  framework_trace_with_ids = []
  full_trace_with_ids = []

  full_trace.each_with_index do |trace, idx|
    trace_with_id = { id: idx, trace: trace }

    if application_trace.include?(trace)
      application_trace_with_ids << trace_with_id
    else
      framework_trace_with_ids << trace_with_id
    end

    full_trace_with_ids << trace_with_id
  end

  {
    "Application Trace" => application_trace_with_ids,
    "Framework Trace" => framework_trace_with_ids,
    "Full Trace" => full_trace_with_ids
  }
end