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

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

Overview

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

Constant Summary collapse

MSG = 
'Do not use block comments.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(comment) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/rubocop/cop/style/block_comments.rb', line 16

def autocorrect(comment)
  expr = comment.loc.expression
  eq_begin = expr.resize("=begin\n".length)
  eq_end = Parser::Source::Range.new(expr.source_buffer,
                                     expr.end_pos - "\n=end".length,
                                     expr.end_pos)
  contents = Parser::Source::Range.new(expr.source_buffer,
                                       eq_begin.end_pos,
                                       eq_end.begin_pos)
  @corrections << lambda do |corrector|
    corrector.remove(eq_begin)
    unless contents.length == 0
      corrector.replace(contents,
                        contents.source
                          .gsub(/\A/, '# ')
                          .gsub(/\n\n/, "\n#\n")
                          .gsub(/\n(?=[^\z#])/, "\n# "))
    end
    corrector.remove(eq_end)
  end
end

#investigate(processed_source) ⇒ Object 



10
11
12
13
14
 
# File 'lib/rubocop/cop/style/block_comments.rb', line 10

def investigate(processed_source)
  processed_source.comments.each do |comment|
    add_offense(comment, :expression) if comment.document?
  end
end