Class: RuboCop::Cop::Style::BlockComments

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/block_comments.rb

Overview

This cop looks for uses of block comments (=begin…=end).

Examples:

# bad
=begin
Multiple lines
of comments...
=end

# good
# Multiple lines
# of comments...

Constant Summary collapse

MSG = 
'Do not use block comments.'
BEGIN_LENGTH = 
"=begin\n".length
END_LENGTH = 
"\n=end".length

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(comment) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/block_comments.rb', line 34

def autocorrect(comment)
  eq_begin, eq_end, contents = parts(comment)

  lambda do |corrector|
    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

#investigate(processed_source) ⇒ Object 



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

def investigate(processed_source)
  processed_source.each_comment do |comment|
    next unless comment.document?

    add_offense(comment)
  end
end