Class: RuboCop::Cop::Lint::UnneededCopDisableDirective

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp, NameSimilarity
Defined in:
lib/rubocop/cop/lint/unneeded_cop_disable_directive.rb

Overview

This cop detects instances of rubocop:disable comments that can be removed without causing any offenses to be reported. It’s implemented as a cop in that it inherits from the Cop base class and calls add_offense. The unusual part of its implementation is that it doesn’t have any on_* methods or an investigate method. This means that it doesn’t take part in the investigation phase when the other cops do their work. Instead, it waits until it’s called in a later stage of the execution. The reason it can’t be implemented as a normal cop is that it depends on the results of all other cops to do its work.

Examples:

# bad
# rubocop:disable Metrics/LineLength
x += 1
# rubocop:enable Metrics/LineLength

# good
x += 1

Constant Summary collapse

COP_NAME = 
'Lint/UnneededCopDisableDirective'.freeze

Constants included from NameSimilarity

NameSimilarity::MINIMUM_SIMILARITY_TO_SUGGEST

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from NameSimilarity

#find_similar_name

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

Methods included from PathUtil

absolute?, 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(args) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/rubocop/cop/lint/unneeded_cop_disable_directive.rb', line 45

def autocorrect(args)
  lambda do |corrector|
    ranges, range = *args # Ranges are sorted by position.

    range = if range.source.start_with?('#')
              comment_range_with_surrounding_space(range)
            else
              directive_range_in_list(range, ranges)
            end

    corrector.remove(range)
  end
end

#check(offenses, cop_disabled_line_ranges, comments) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rubocop/cop/lint/unneeded_cop_disable_directive.rb', line 34

def check(offenses, cop_disabled_line_ranges, comments)
  unneeded_cops = Hash.new { |h, k| h[k] = Set.new }

  each_unneeded_disable(cop_disabled_line_ranges,
                        offenses, comments) do |comment, unneeded_cop|
    unneeded_cops[comment].add(unneeded_cop)
  end

  add_offenses(unneeded_cops)
end