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

MSG = 
'Use `Kernel#loop` for infinite loops.'
TRUTHY_LITERALS = 
[:str, :dstr, :int, :float, :array,
:hash, :regexp, :true]
FALSEY_LITERALS = 
[:nil, :false]

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 inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #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, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



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

def autocorrect(node)
  @corrections << lambda do |corrector|
    condition_node, = *node
    start_range = node.loc.keyword.begin
    end_range = if node.loc.begin
                  node.loc.begin.end
                else
                  condition_node.loc.expression.end
                end
    corrector.replace(start_range.join(end_range), 'loop do')
  end
end

#on_until(node) ⇒ Object 



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

def on_until(node)
  condition, = *node

  return unless FALSEY_LITERALS.include?(condition.type)

  add_offense(node, :keyword)
end

#on_while(node) ⇒ Object 



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

def on_while(node)
  condition, = *node

  return unless TRUTHY_LITERALS.include?(condition.type)

  add_offense(node, :keyword)
end