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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
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 |a|
  puts a if a == 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| puts a if a == 1 }`

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

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

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_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#add_global_offense, #add_offense, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, 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, trim_string_interporation_escape_character

Methods included from TokensUtil

index_of_first_token, index_of_last_token, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Class Method Details

.autocorrect_incompatible_withObject


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

def self.autocorrect_incompatible_with
  [Style::SafeNavigation]
end

Instance Method Details

#on_block(node) ⇒ Object


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

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

  check(node)
end

#on_new_investigationObject


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

def on_new_investigation
  # 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_while(node) ⇒ Object Also known as: on_until, on_for


75
76
77
# File 'lib/rubocop/cop/style/next.rb', line 75

def on_while(node)
  check(node)
end