Sha256: 5caed40b1cb8659a77002b712ccc1946f1627419e9514dd695583a366a7259ea
Contents?: true
Size: 1.33 KB
Versions: 37
Compression:
Stored size: 1.33 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Lint
# This cop checks for `return` from an `ensure` block.
# `return` from an ensure block is a dangerous code smell as it
# will take precedence over any exception being raised,
# and the exception will be silently thrown away as if it were rescued.
#
# If you want to rescue some (or all) exceptions, best to do it explicitly
#
# @example
#
# # bad
#
# def foo
# do_something
# ensure
# cleanup
# return self
# end
#
# @example
#
# # good
#
# def foo
# do_something
# self
# ensure
# cleanup
# end
#
# # also good
#
# def foo
# begin
# do_something
# rescue SomeException
# # Let's ignore this exception
# end
# self
# ensure
# cleanup
# end
class EnsureReturn < Base
extend AutoCorrector
include RangeHelp
MSG = 'Do not return from an `ensure` block.'
def on_ensure(node)
node.body&.each_node(:return) do |return_node|
add_offense(return_node)
end
end
end
end
end
end
Version data entries
37 entries across 37 versions & 3 rubygems