Class: RuboCop::Cop::Style::DoubleCopDisableDirective

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

Overview

Detects double disable comments on one line. This is mostly to catch automatically generated comments that need to be regenerated.

Examples:

# bad
def f # rubocop:disable Style/For # rubocop:disable Metrics/AbcSize
end

# good
# rubocop:disable Metrics/AbcSize
def f # rubocop:disable Style/For
end
# rubocop:enable Metrics/AbcSize

# if both fit on one line
def f # rubocop:disable Style/For, Metrics/AbcSize
end

Constant Summary collapse

MSG =

rubocop:enable Style/For, Style/DoubleCopDisableDirective rubocop:enable Lint/RedundantCopDisableDirective, Metrics/AbcSize

'More than one disable comment on one line.'

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 NodePattern::Macros

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

Methods included from AST::Sexp

#s

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


40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/rubocop/cop/style/double_cop_disable_directive.rb', line 40

def autocorrect(comment)
  prefix = if comment.text.start_with?('# rubocop:disable')
             '# rubocop:disable'
           else
             '# rubocop:todo'
           end

  lambda do |corrector|
    corrector.replace(comment.loc.expression,
                      comment.text[/#{prefix} \S+/])
  end
end

#investigate(processed_source) ⇒ Object


32
33
34
35
36
37
38
# File 'lib/rubocop/cop/style/double_cop_disable_directive.rb', line 32

def investigate(processed_source)
  processed_source.comments.each do |comment|
    next unless comment.text.scan(/# rubocop:(?:disable|todo)/).size > 1

    add_offense(comment)
  end
end