class RuboCop::Cop::Lint::NonLocalExitFromIterator

Checks for non-local exits from iterators without a return value. It registers an offense under these conditions:

or ‘define_singleton_method`,

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 46
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)

    # 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?(node.send_node)

    next unless node.arguments?

    if chained_send?(node.send_node)
      add_offense(return_node.loc.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 72
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 68
def scoped_node?(node)
  node.def_type? || node.defs_type? || node.lambda?
end