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.'
ENUMERATORS = 
[:collect, :detect, :downto, :each, :find, :find_all,
:inject, :loop, :map!, :map, :reduce, :reverse_each,
:select, :times, :upto]

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

Methods included from MinBodyLength

#min_body_length, #min_body_length?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #parameter_name, #style, #unrecognized_style_detected

Methods included from IfNode

#elsif?, #if_else?, #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?, #display_cop_names?, #display_style_guide?, inherited, #initialize, #join_force?, lint?, match?, #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

#on_block(node) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/rubocop/cop/style/next.rb', line 31

def on_block(node)
  block_owner, _, body = *node
  return unless block_owner.type == :send
  return if body.nil?

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

  add_offense(block_owner, :selector, MSG)
end

#on_for(node) ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/rubocop/cop/style/next.rb', line 51

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

  add_offense(node, :keyword, MSG)
end

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



43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/next.rb', line 43

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

  add_offense(node, :keyword, MSG)
end