123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::CopDirectiveSyntax

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

Overview

Checks that # rubocop:enable …​ and # rubocop:disable …​ statements are strictly formatted.

A comment can be added to the directive by prefixing it with --.

Examples:

# bad
# rubocop:disable Layout/LineLength Style/Encoding

# good
# rubocop:disable Layout/LineLength, Style/Encoding

# bad
# rubocop:disable

# good
# rubocop:disable all

# bad
# rubocop:disable Layout/LineLength # rubocop:disable Style/Encoding

# good
# rubocop:disable Layout/LineLength
# rubocop:disable Style/Encoding

# bad
# rubocop:wrongmode Layout/LineLength

# good
# rubocop:disable Layout/LineLength

# bad
# rubocop:disable Layout/LineLength comment

# good
# rubocop:disable Layout/LineLength -- comment

# bad
# rucocop:disable Layout/LineLength

# good
# rubocop:disable Layout/LineLength

# bad
# rubocop:disable Layout/LineLenght

# good
# rubocop:disable Layout/LineLength

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::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 a 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

Reserved for Commissioner.

::RuboCop::ExcludeLimit - Extended

exclude_limit

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

Instance Attribute Summary

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #project_index, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?,
#skipped_unsafe_correction_with_disable_uncorrectable?

Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while --disable-uncorrectable asks for a todo comment on everything this run cannot correct.

Instance Method Summary

::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_gem_version

Returns a gems locked versions (i.e.
#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, #covering_disabled_range, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?,
#enabled_lines?

A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code.
#file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#suppression_reason

The -- reason on the directive that suppresses offenses on this range, or nil when the directive carries none.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#check_directive(comment, directive_comment) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/lint/cop_directive_syntax.rb', line 91



def check_directive(comment, directive_comment)
  if directive_comment.malformed?
    add_offense(comment, message: offense_message(directive_comment))
  elsif misplaced_next_directive?(directive_comment)
    add_offense(comment, message: NEXT_DIRECTIVE_AT_EOL_MSG)
  elsif (name = unknown_cop_name(directive_comment))
    add_offense(comment, message: unknown_cop_message(directive_comment, name))
  end
end


  








  

    #misplaced_next_directive?(directive_comment)  ⇒ Boolean  (private)
  



  

    


An EOL disable-next is not honored - it must fail loudly instead
of silently doing nothing.



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/cop_directive_syntax.rb', line 103



def misplaced_next_directive?(directive_comment)
  directive_comment.disable_next? &&
    !processed_source.comment_config.comment_only_line?(directive_comment.line_number)
end


  








  

    #near_miss_keyword(comment)   (private)
  

  [ GitHub ]


  

  


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



def near_miss_keyword(comment)
  match = comment.text.match(NEAR_MISS_KEYWORD_REGEXP)
  return unless match

  keyword = match[:keyword]
  return if keyword == 'rubocop'

  keyword if similar_to_rubocop?(keyword)
end


  








  

    #offense_message(directive_comment)   (private)
  



  

    


rubocop:disable-next Metrics/MethodLength



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/cop_directive_syntax.rb', line 109



def offense_message(directive_comment)
  comment = directive_comment.comment
  after_marker = comment.text.sub(DirectiveComment::DIRECTIVE_MARKER_REGEXP, '')
  mode = after_marker.split(' ', 2).first
  additional_msg = if mode.nil?
                     MISSING_MODE_NAME_MSG
                   elsif !DirectiveComment::AVAILABLE_MODES.include?(mode)
                     INVALID_MODE_NAME_MSG
                   elsif directive_comment.missing_cop_name?
                     MISSING_COP_NAME_MSG
                   else
                     MALFORMED_COP_NAMES_MSG
                   end

  "#{COMMON_MSG} #{additional_msg}"
end


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/cop_directive_syntax.rb', line 77



def on_new_investigation
  processed_source.comments.each do |comment|
    directive_comment = DirectiveComment.new(comment)
    if directive_comment.start_with_marker?
      check_directive(comment, directive_comment)
    elsif (keyword = near_miss_keyword(comment))
      message = format("#{COMMON_MSG} #{INVALID_KEYWORD_MSG}", keyword: keyword)
      add_offense(comment, message: message)
    end
  end
end


  








  

    #similar_to_rubocop?(keyword)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/cop_directive_syntax.rb', line 136



def similar_to_rubocop?(keyword)
  return true if keyword.casecmp?('rubocop')
  # `DidYouMean` is not always available - see `NameSimilarity`.
  return false unless defined?(DidYouMean::Levenshtein)

  DidYouMean::Levenshtein.distance(keyword.downcase, 'rubocop') <= 2
end


  








  

    #unknown_cop_message(directive_comment, name)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/cop_directive_syntax.rb', line 156



def unknown_cop_message(directive_comment, name)
  similar = NameSimilarity.find_similar_name(name, directive_comment.cop_registry.names)
  suggestion = similar ? " (did you mean `#{similar}`?)" : ''
  format(UNKNOWN_COP_MSG, name: name, suggestion: suggestion)
end


  








  

    #unknown_cop_name(directive_comment)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/cop_directive_syntax.rb', line 144



def unknown_cop_name(directive_comment)
  return if directive_comment.push? || directive_comment.pop? || directive_comment.all_cops?

  registry = directive_comment.cop_registry
  directive_comment.raw_cop_names.find do |name|
    next false if registry.department?(name)

    qualified = registry.qualified_cop_name(name, nil, warn: false)
    !registry.contains_cop_matching?([qualified])
  end
end