class RuboCop::Cop::Lint::NonLocalExitFromIterator
This cop checks for non-local exits from iterators without a return value. It registers an offense under these conditions:
- No value is returned, - the block is preceded by a method chain, - the block has arguments, - the method which receives the block is not `define_method` or `define_singleton_method`, - the return is not contained in an inner scope, e.g. a lambda or a method definition.
@example
class ItemApi rescue_from ValidationError do |e| # non-iteration block with arg return message: 'validation error' unless e.errors # allowed error_array = e.errors.map do |error| # block with method chain return if error.suppress? # warned return "#{error.param}: invalid" unless error.message # allowed "#{error.param}: #{error.message}" end message: 'validation error', errors: error_array end def update_items transaction do # block without arguments return unless update_necessary? # allowed find_each do |item| # block without method chain return if item.stock == 0 # false-negative... item.update!(foobar: true) end end end end
Constants
- MSG
Public Instance Methods
on_return(return_node)
click to toggle source
# File lib/rubocop/cop/lint/non_local_exit_from_iterator.rb, line 45 def on_return(return_node) return if return_value?(return_node) return_node.each_ancestor(:block, :def, :defs) do |node| break if scoped_node?(node) send_node, args_node, _body_node = *node # if a proc is passed to `Module#define_method` or # `Object#define_singleton_method`, `return` will not cause a # non-local exit error break if define_method?(send_node) next if args_node.children.empty? if chained_send?(send_node) add_offense(return_node, location: :keyword) break end end end
Private Instance Methods
return_value?(return_node)
click to toggle source
# File lib/rubocop/cop/lint/non_local_exit_from_iterator.rb, line 73 def return_value?(return_node) !return_node.children.empty? end
scoped_node?(node)
click to toggle source
# File lib/rubocop/cop/lint/non_local_exit_from_iterator.rb, line 69 def scoped_node?(node) node.def_type? || node.defs_type? || node.lambda? end