Class: RuboCop::Cop::Lint::NonLocalExitFromIterator
- 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, block followed by method chain, and block have arguments.
Constant Summary collapse
- MSG =
'Non-local exit from iterator, without return value. ' \ '`next`, `break`, `Array#find`, `Array#any?`, etc. is preferred.'
Constants included from Util
Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #chained_send?(send_node) ⇒ Boolean
- #on_return(return_node) ⇒ Object
- #return_value?(return_node) ⇒ Boolean
Methods inherited from Cop
#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_name_with_namespace, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #style_guide_url
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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?
Methods included from PathUtil
hidden?, issue_deprecation_warning, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#chained_send?(send_node) ⇒ Boolean
54 55 56 57 |
# File 'lib/rubocop/cop/lint/non_local_exit_from_iterator.rb', line 54 def chained_send?(send_node) receiver_node, _selector_node = *send_node !receiver_node.nil? end |
#on_return(return_node) ⇒ Object
38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/rubocop/cop/lint/non_local_exit_from_iterator.rb', line 38 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 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
50 51 52 |
# File 'lib/rubocop/cop/lint/non_local_exit_from_iterator.rb', line 50 def return_value?(return_node) !return_node.children.empty? end |