Class: RuboCop::Cop::Lint::NonLocalExitFromIterator

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/non_local_exit_from_iterator.rb

Overview

This cop checks for non-local exit from iterator, without return value. It warns only when satisfies all of these: ‘return` doesn’t have return value, the block is preceded by a method chain, the block has arguments, and the method which receives the block is not ‘define_method` or `define_singleton_method`.

Examples:


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

Constant Summary collapse

MSG = 
'Non-local exit from iterator, without return value. ' \
'`next`, `break`, `Array#find`, `Array#any?`, etc. ' \
'is preferred.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#chained_send?(send_node) ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
68
 
# File 'lib/rubocop/cop/lint/non_local_exit_from_iterator.rb', line 65

def chained_send?(send_node)
  receiver_node, _selector_node = *send_node
  !receiver_node.nil?
end

#define_method?(send_node) ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
73
 
# File 'lib/rubocop/cop/lint/non_local_exit_from_iterator.rb', line 70

def define_method?(send_node)
  _receiver, selector = *send_node
  %i(define_method define_singleton_method).include? selector
end

#on_return(return_node) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/rubocop/cop/lint/non_local_exit_from_iterator.rb', line 41

def on_return(return_node)
  return if return_value?(return_node)
  return_node.each_ancestor(:block) do |block_node|
    send_node, args_node, _body_node = *block_node

    # `return` does not exit to outside of lambda block, this is safe.
    break if block_node.lambda?
    # 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, :keyword)
      break
    end
  end
end

#return_value?(return_node) ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/rubocop/cop/lint/non_local_exit_from_iterator.rb', line 61

def return_value?(return_node)
  !return_node.children.empty?
end