Class: RuboCop::Cop::Layout::EmptyComment

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

Overview

This cop checks empty comment.

Examples:

# bad

#
class Foo
end

# good

#
# Description of `Foo` class.
#
class Foo
end

AllowBorderComment: true (default)

# good

def foo
end

#################

def bar
end

AllowBorderComment: false

# bad

def foo
end

#################

def bar
end

AllowMarginComment: true (default)

# good

#
# Description of `Foo` class.
#
class Foo
end

AllowMarginComment: false

# bad

#
# Description of `Foo` class.
#
class Foo
end

Constant Summary collapse

MSG = 
'Source code comment is empty.'

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #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?, #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(node) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/rubocop/cop/layout/empty_comment.rb', line 88

def autocorrect(node)
  lambda do |corrector|
    previous_token = previous_token(node)
    range = if previous_token && node.loc.line == previous_token.line
              range_with_surrounding_space(range: node.loc.expression,
                                           newlines: false)
            else
              range_by_whole_lines(node.loc.expression,
                                   include_final_newline: true)
            end

    corrector.remove(range)
  end
end

#investigate(processed_source) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/rubocop/cop/layout/empty_comment.rb', line 68

def investigate(processed_source)
  if allow_margin_comment?
    comments = concat_consecutive_comments(processed_source.comments)

    comments.each do |comment|
      next unless empty_comment_only?(comment[0])

      comment[1].each do |offense_comment|
        add_offense(offense_comment)
      end
    end
  else
    processed_source.comments.each do |comment|
      next unless empty_comment_only?(comment_text(comment))

      add_offense(comment)
    end
  end
end