Sha256: a4a4f75803d000a08fdb08e7f2d5e1c364316fdb21416b96d53250532235604e
Contents?: true
Size: 1.38 KB
Versions: 6791
Compression:
Stored size: 1.38 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# 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 `Metrics/LineLength` cop.
#
# @example
# # bad
# while x < 10
# x += 1
# end
#
# # good
# x += 1 while x < 10
#
# @example
# # bad
# until x > 10
# x += 1
# end
#
# # good
# x += 1 until x > 10
class WhileUntilModifier < Cop
include StatementModifier
MSG = 'Favor modifier `%<keyword>s` usage when ' \
'having a single-line body.'.freeze
def on_while(node)
check(node)
end
def on_until(node)
check(node)
end
def autocorrect(node)
oneline = "#{node.body.source} #{node.keyword} " \
"#{node.condition.source}"
lambda do |corrector|
corrector.replace(node.source_range, oneline)
end
end
private
def check(node)
return unless node.multiline? && single_line_as_modifier?(node)
add_offense(node, location: :keyword,
message: format(MSG, keyword: node.keyword))
end
end
end
end
end
Version data entries
6,791 entries across 6,785 versions & 25 rubygems