Class: RuboCop::Cop::Style::WhileUntilModifier

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RuboCop::Cop::StatementModifier
Defined in:
lib/rubocop/cop/style/while_until_modifier.rb

Overview

Checks for while and until statements that would fit on one line if written as a modifier while/until. The maximum line length is configured in the ‘Layout/LineLength` cop.

Examples:

# bad
while x < 10
  x += 1
end

# good
x += 1 while x < 10

# bad
until x > 10
  x += 1
end

# good
x += 1 until x > 10
# bad
x += 100 while x < 500 # a long comment that makes code too long if it were a single line

# good
while x < 500 # a long comment that makes code too long if it were a single line
  x += 100
end

Constant Summary collapse

MSG = 
'Favor modifier `%<keyword>s` usage when having a single-line body.'

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Instance Method Details

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



41
42
43
44
45
46
47
 
# File 'lib/rubocop/cop/style/while_until_modifier.rb', line 41

def on_while(node)
  return unless single_line_as_modifier?(node)

  add_offense(node.loc.keyword, message: format(MSG, keyword: node.keyword)) do |corrector|
    corrector.replace(node, to_modifier_form(node))
  end
end