Sha256: f442d70d1b65b1975805bb451702c76a307bf5d29d4dc151bfb3d3fc0cb3076b
Contents?: true
Size: 1.72 KB
Versions: 74
Compression:
Stored size: 1.72 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop looks for uses of block comments (=begin...=end).
#
# @example
# # bad
# =begin
# Multiple lines
# of comments...
# =end
#
# # good
# # Multiple lines
# # of comments...
#
class BlockComments < Base
include RangeHelp
extend AutoCorrector
MSG = 'Do not use block comments.'
BEGIN_LENGTH = "=begin\n".length
END_LENGTH = "\n=end".length
def on_new_investigation
processed_source.comments.each do |comment|
next unless comment.document?
add_offense(comment) do |corrector|
eq_begin, eq_end, contents = parts(comment)
corrector.remove(eq_begin)
unless contents.length.zero?
corrector.replace(
contents,
contents.source.gsub(/\A/, '# ').gsub(/\n\n/, "\n#\n").gsub(/\n(?=[^#])/, "\n# ")
)
end
corrector.remove(eq_end)
end
end
end
private
def parts(comment)
expr = comment.loc.expression
eq_begin = expr.resize(BEGIN_LENGTH)
eq_end = eq_end_part(comment, expr)
contents = range_between(eq_begin.end_pos, eq_end.begin_pos)
[eq_begin, eq_end, contents]
end
def eq_end_part(comment, expr)
if comment.text.chomp == comment.text
range_between(expr.end_pos - END_LENGTH - 1, expr.end_pos - 2)
else
range_between(expr.end_pos - END_LENGTH, expr.end_pos)
end
end
end
end
end
end
Version data entries
74 entries across 74 versions & 8 rubygems