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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/infinite_loop.rb

Overview

Use ‘Kernel#loop` for infinite loops.

This cop is marked as unsafe as the rule does not necessarily apply if the body might raise a ‘StopIteration` exception; contrary to other infinite loops, `Kernel#loop` silently rescues that and returns `nil`.

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

Base::RESTRICT_ON_SEND

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

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, callbacks_needed, #callbacks_needed, #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, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

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

silence_warnings

Constructor Details

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

Class Method Details

.joining_forces ⇒ Object 



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

def self.joining_forces
  VariableForce
end

Instance Method Details

#after_leaving_scope(scope, _variable_table) ⇒ Object 



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

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

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



42
43
44
 
# File 'lib/rubocop/cop/style/infinite_loop.rb', line 42

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

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



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

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