Module: ActiveSupport::Rescuable::ClassMethods

Defined in:
activesupport/lib/active_support/rescuable.rb

Instance Method Summary collapse

Instance Method Details

#handler_for_rescue(exception, object: self) ⇒ Object

:nodoc:


96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'activesupport/lib/active_support/rescuable.rb', line 96

def handler_for_rescue(exception, object: self) #:nodoc:
  case rescuer = find_rescue_handler(exception)
  when Symbol
    method = object.method(rescuer)
    if method.arity == 0
      -> e { method.call }
    else
      method
    end
  when Proc
    if rescuer.arity == 0
      -> e { object.instance_exec(&rescuer) }
    else
      -> e { object.instance_exec(e, &rescuer) }
    end
  end
end

#rescue_from(*klasses, with: nil, &block) ⇒ Object

Rescue exceptions raised in controller actions.

rescue_from receives a series of exception classes or class names, and a trailing :with option with the name of a method or a Proc object to be called to handle them. Alternatively a block can be given.

Handlers that take one argument will be called with the exception, so that the exception can be inspected when dealing with it.

Handlers are inherited. They are searched from right to left, from bottom to top, and up the hierarchy. The handler of the first class for which exception.is_a?(klass) holds true is the one invoked, if any.

class ApplicationController < ActionController::Base
  rescue_from User::NotAuthorized, with: :deny_access # self defined exception
  rescue_from ActiveRecord::RecordInvalid, with: :show_errors

  rescue_from 'MyAppError::Base' do |exception|
    render xml: exception, status: 500
  end

  protected
    def deny_access
      ...
    end

    def show_errors(exception)
      exception.record.new_record? ? ...
    end
end

Exceptions raised inside exception handlers are not propagated up.


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'activesupport/lib/active_support/rescuable.rb', line 50

def rescue_from(*klasses, with: nil, &block)
  unless with
    if block_given?
      with = block
    else
      raise ArgumentError, 'Need a handler. Pass the with: keyword argument or provide a block.'
    end
  end

  klasses.each do |klass|
    key = if klass.is_a?(Module) && klass.respond_to?(:===)
      klass.name
    elsif klass.is_a?(String)
      klass
    else
      raise ArgumentError, "#{klass.inspect} must be an Exception class or a String referencing an Exception class"
    end

    # Put the new handler at the end because the list is read in reverse.
    self.rescue_handlers += [[key, with]]
  end
end

#rescue_with_handler(exception, object: self) ⇒ Object

Matches an exception to a handler based on the exception class.

If no handler matches the exception, check for a handler matching the (optional) exception.cause. If no handler matches the exception or its cause, this returns nil so you can deal with unhandled exceptions. Be sure to re-raise unhandled exceptions if this is what you expect.

begin
  
rescue => exception
  rescue_with_handler(exception) || raise
end

Returns the exception if it was handled and nil if it was not.


87
88
89
90
91
92
93
94
# File 'activesupport/lib/active_support/rescuable.rb', line 87

def rescue_with_handler(exception, object: self)
  if handler = handler_for_rescue(exception, object: object)
    handler.call exception
    exception
  elsif exception
    rescue_with_handler(exception.cause, object: object)
  end
end