Class: RuboCop::Cop::Lint::UnneededDisable

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/unneeded_disable.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.

Constant Summary collapse

COP_NAME = 
'Lint/UnneededDisable'

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, 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, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#check(offenses, cop_disabled_line_ranges, comments) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/rubocop/cop/lint/unneeded_disable.rb', line 18

def check(offenses, cop_disabled_line_ranges, comments)
  unneeded_cops = {}
  disabled_ranges = cop_disabled_line_ranges[COP_NAME] || [0..0]

  cop_disabled_line_ranges.each do |cop, line_ranges|
    cop_offenses = offenses.select { |o| o.cop_name == cop }
    line_ranges.each do |line_range|
      comment = comments.find { |c| c.loc.line == line_range.begin }
      unneeded_cop = find_unneeded(comment, offenses, cop, cop_offenses,
                                   line_range)

      unless all_disabled?(comment)
        next if ignore_offense?(disabled_ranges, line_range)
      end

      if unneeded_cop
        unneeded_cops[comment.loc.expression] ||= Set.new
        unneeded_cops[comment.loc.expression].add(unneeded_cop)
      end
    end
  end

  add_offenses(unneeded_cops)
end