Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop checks for *return* from an *ensure* block.
      # Explicit return from an ensure block alters the control flow
      # as the return will take precedence over any exception being raised,
      # and the exception will be silently thrown away as if it were rescued.
      #
      # @example
      #
      #   # bad
      #
      #   begin
      #     do_something
      #   ensure
      #     do_something_else
      #     return
      #   end
      #
      # @example
      #
      #   # good
      #
      #   begin
      #     do_something
      #   ensure
      #     do_something_else
      #   end
      class EnsureReturn < Cop
        include RangeHelp

        MSG = 'Do not return from an `ensure` block.'

        def on_ensure(node)
          ensure_body = node.body

          return unless ensure_body

          ensure_body.each_node(:return) do |return_node|
            next if return_node.arguments.size >= 2

            add_offense(return_node, location: :keyword)
          end
        end

        def autocorrect(node)
          lambda do |corrector|
            if node.arguments?
              corrector.replace(node, node.source.gsub(/return\s*/, ''))
            else
              range = range_by_whole_lines(
                node.loc.expression, include_final_newline: true
              )
              corrector.remove(range)
            end
          end
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rubocop-0.84.0	lib/rubocop/cop/lint/ensure_return.rb
rubocop-0.83.0	lib/rubocop/cop/lint/ensure_return.rb