instance method rescue_from

Ruby on Rails edge

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.11.3 v5.0.7.2 v5.1.7 v5.2.8.1 v6.0.6.1 v6.1.7.10 v7.0.10 v7.1.6 v7.2.4 v8.0.5.1 v8.1.4 edge

Signature

rescue_from(*klasses, with: nil, &block)

Registers exception classes with a handler to be called by rescue_with_handler.

rescue_from receives a series of exception classes or class names, and an exception handler specified by a trailing :with option containing the name of a method or a Proc object. Alternatively, a block can be given as the handler.

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 rescue_from ActiveRecord::RecordInvalid, with: :show_record_errors

rescue_from “MyApp::BaseError” do |exception| redirect_to root_url, alert: exception.message end

private def deny_access head :forbidden end

 def show_record_errors(exception)
   redirect_back_or_to root_url, alert: exception.record.errors.full_messages.to_sentence
 end

end “‘

Exceptions raised inside exception handlers are not propagated up. : ((Module | String)) { (Exception) [self: untyped] -> void } -> void : ((Module | String), with: Symbol | Proc) -> void

Parameters

klasses rest
with key = nil
block block
Source
# File activesupport/lib/active_support/rescuable.rb, line 59
      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

        with = Ractors.try_shareable_proc(with) if with.is_a?(Proc)

        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 = [*rescue_handlers, [key, with].freeze].freeze
        end
      end

Defined in activesupport/lib/active_support/rescuable.rb line 59 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveSupport::Rescuable::ClassMethods

Type at least 2 characters to search.

Use the arrow keys to navigate results, Enter to open one, Escape to close.

Keyboard shortcuts

/
Focus search
⌘K / Ctrl-K
Command palette
?
This help
Esc
Close