Class: RuboCop::Cop::Style::InfiniteLoop

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/infinite_loop.rb

Overview

Use `Kernel#loop` for infinite loops.

Examples:

# bad
while true
  work
end

# good
loop do
  work
end

Constant Summary collapse

LEADING_SPACE =
/\A(\s*)/.freeze
MSG =
'Use `Kernel#loop` for infinite loops.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #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?, #correctable?, #disable_offense, #disable_uncorrectable?, #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, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, 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

#after_leaving_scope(scope, _variable_table) ⇒ Object


27
28
29
30
# File 'lib/rubocop/cop/style/infinite_loop.rb', line 27

def after_leaving_scope(scope, _variable_table)
  @variables ||= []
  @variables.concat(scope.variables.values)
end

#autocorrect(node) ⇒ Object


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

def autocorrect(node)
  if node.while_post_type? || node.until_post_type?
    replace_begin_end_with_modifier(node)
  elsif node.modifier_form?
    replace_source(node.source_range, modifier_replacement(node))
  else
    replace_source(non_modifier_range(node), 'loop do')
  end
end

#join_force?(force_class) ⇒ Boolean


23
24
25
# File 'lib/rubocop/cop/style/infinite_loop.rb', line 23

def join_force?(force_class)
  force_class == VariableForce
end

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


36
37
38
# File 'lib/rubocop/cop/style/infinite_loop.rb', line 36

def on_until(node)
  while_or_until(node) if node.condition.falsey_literal?
end

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


32
33
34
# File 'lib/rubocop/cop/style/infinite_loop.rb', line 32

def on_while(node)
  while_or_until(node) if node.condition.truthy_literal?
end