123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::RedundantCopEnableDirective

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/redundant_cop_enable_directive.rb

Overview

Detects instances of rubocop:enable comments that can be removed.

When comment enables all cops at once rubocop:enable all that cop checks whether any cop was actually enabled.

Examples:

# bad
foo = 1
# rubocop:enable Layout/LineLength

# good
foo = 1

# bad
# rubocop:disable Style/StringLiterals
foo = "1"
# rubocop:enable Style/StringLiterals
baz
# rubocop:enable all

# good
# rubocop:disable Style/StringLiterals
foo = "1"
# rubocop:enable all
baz

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

::RuboCop::Cop::SurroundingSpace - Included

NO_SPACE_COMMAND, SINGLE_SPACE_REGEXP, SPACE_COMMAND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::SurroundingSpace - Included

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.

#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.

#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#all_or_name(name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 122

def all_or_name(name)
  name == 'all' ? 'all cops' : name
end

#comment_start(comment) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 78

def comment_start(comment)
  comment.source_range.begin_pos
end

#cop_name_indention(comment, name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 82

def cop_name_indention(comment, name)
  comment.text.index(name)
end

#department?(directive, name) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 126

def department?(directive, name)
  directive.in_directive_department?(name) && !directive.overridden_by_department?(name)
end

#on_new_investigation

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 46

def on_new_investigation
  return if processed_source.blank? || !processed_source.raw_source.include?('enable')

  offenses = processed_source.comment_config.extra_enabled_comments
  offenses.each { |comment, cop_names| register_offense(comment, cop_names) }
end

#range_of_offense(comment, name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 73

def range_of_offense(comment, name)
  start_pos = comment_start(comment) + cop_name_indention(comment, name)
  range_between(start_pos, start_pos + name.size)
end

#range_to_remove(begin_pos, end_pos, comment) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 97

def range_to_remove(begin_pos, end_pos, comment)
  start = comment_start(comment)
  source = comment.source

  if source[begin_pos - 1] == ','
    range_with_comma_before(start, begin_pos, end_pos)
  elsif source[end_pos] == ','
    range_with_comma_after(comment, start, begin_pos, end_pos)
  else
    range_between(start, comment.source_range.end_pos)
  end
end

#range_with_comma(comment, name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 86

def range_with_comma(comment, name)
  source = comment.source

  begin_pos = cop_name_indention(comment, name)
  end_pos = begin_pos + name.size
  begin_pos = reposition(source, begin_pos, -1)
  end_pos = reposition(source, end_pos, 1)

  range_to_remove(begin_pos, end_pos, comment)
end

#range_with_comma_after(comment, start, begin_pos, end_pos) (private)

If the list of cops is comma-separated, but without a empty space after the comma, we should not remove the prepending empty space, thus begin_pos += 1

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 116

def range_with_comma_after(comment, start, begin_pos, end_pos)
  begin_pos += 1 if comment.source[end_pos + 1] != ' '

  range_between(start + begin_pos, start + end_pos + 1)
end

#range_with_comma_before(start, begin_pos, end_pos) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 110

def range_with_comma_before(start, begin_pos, end_pos)
  range_between(start + begin_pos - 1, start + end_pos)
end

#register_offense(comment, cop_names) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/redundant_cop_enable_directive.rb', line 55

def register_offense(comment, cop_names)
  directive = DirectiveComment.new(comment)

  cop_names.each do |name|
    name = name.split('/').first if department?(directive, name)
    add_offense(
      range_of_offense(comment, name),
      message: format(MSG, cop: all_or_name(name))
    ) do |corrector|
      if directive.match?(cop_names)
        corrector.remove(range_with_surrounding_space(directive.range, side: :right))
      else
        corrector.remove(range_with_comma(comment, name))
      end
    end
  end
end