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

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

Overview

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

Examples:

EnforcedStyle: skip_modifier_ifs (default)

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

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

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

EnforcedStyle: always

# With `always` all conditions at the end of an iteration needs to be
# replaced by next - with `skip_modifier_ifs` the modifier if like
# this one are ignored: `[1, 2].each { |a| return 'yes' if a == 1 }`

# bad
[1, 2].each do |o|
  puts o unless o == 1
end

# bad
[1, 2].each do |a|
  if a == 1
    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 =
%i[break return].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

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

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, 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_rails_version, #target_ruby_version

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 AST::Sexp

#s

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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object



76
77
78
79
80
81
82
83
84
# File 'lib/rubocop/cop/style/next.rb', line 76

def autocorrect(node)
  lambda do |corrector|
    if node.modifier_form?
      autocorrect_modifier(corrector, node)
    else
      autocorrect_block(corrector, node)
    end
  end
end

#investigate(_processed_source) ⇒ Object



57
58
59
60
61
# File 'lib/rubocop/cop/style/next.rb', line 57

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



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

def on_block(node)
  return unless node.send_node.send_type? &&
                node.send_node.enumerator_method?

  check(node)
end

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



70
71
72
# File 'lib/rubocop/cop/style/next.rb', line 70

def on_while(node)
  check(node)
end