Class: RuboCop::Cop::Style::Next

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle, IfNode, MinBodyLength
Defined in:
lib/rubocop/cop/style/next.rb

Overview

Use ‘next` to skip iteration instead of a condition at the end.

Examples:

# bad
[1, 2].each do |a|
  if a == 1 do
    puts a
  end
end

# good
[1, 2].each do |a|
  next unless a == 1
  puts a
end

Constant Summary collapse

MSG = 
'Use `next` to skip iteration.'.freeze
EXIT_TYPES = 
[:break, :return].freeze
EACH_ = 
'each_'.freeze
ENUMERATORS = 
[:collect, :collect_concat, :detect, :downto, :each,
:find, :find_all, :find_index, :inject, :loop, :map!,
:map, :reduce, :reject, :reject!, :reverse_each, :select,
:select!, :times, :upto].freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from MinBodyLength

#min_body_length, #min_body_length?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected

Methods included from IfNode

#elsif?, #if_else?, #if_node_parts, #modifier_if?, #ternary_op?

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#investigate(_processed_source) ⇒ Object 



35
36
37
38
39
 
# File 'lib/rubocop/cop/style/next.rb', line 35

def investigate(_processed_source)
  # When correcting nested offenses, we need to keep track of how much
  # we have adjusted the indentation of each line
  @reindented_lines = Hash.new(0)
end

#on_block(node) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/style/next.rb', line 41

def on_block(node)
  block_owner, _, body = *node
  return unless block_owner.send_type?
  return unless body && ends_with_condition?(body)

  _, method_name = *block_owner
  return unless enumerator?(method_name)

  offense_node = offense_node(body)
  add_offense(offense_node, offense_location(offense_node), MSG)
end

#on_for(node) ⇒ Object 



62
63
64
65
66
67
68
 
# File 'lib/rubocop/cop/style/next.rb', line 62

def on_for(node)
  _, _, body = *node
  return unless body && ends_with_condition?(body)

  offense_node = offense_node(body)
  add_offense(offense_node, offense_location(offense_node), MSG)
end

#on_while(node) ⇒ Object Also known as: on_until 



53
54
55
56
57
58
59
 
# File 'lib/rubocop/cop/style/next.rb', line 53

def on_while(node)
  _, body = *node
  return unless body && ends_with_condition?(body)

  offense_node = offense_node(body)
  add_offense(offense_node, offense_location(offense_node), MSG)
end