123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Migration::DepartmentName

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/migration/department_name.rb

Overview

Check that cop names in rubocop:disable comments are given with department name.

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

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

#check_cop_name(name, comment, offset) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/migration/department_name.rb', line 47

def check_cop_name(name, comment, offset)
  start = comment.source_range.begin_pos + offset
  range = range_between(start, start + name.length)

  add_offense(range) do |corrector|
    cop_name = range.source
    qualified_cop_name = Registry.global.qualified_cop_name(cop_name, nil, warn: false)

    unless qualified_cop_name.include?('/')
      qualified_cop_name = qualified_legacy_cop_name(cop_name)
    end

    corrector.replace(range, qualified_cop_name)
  end
end

#contain_unexpected_character_for_department_name?(name) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/migration/department_name.rb', line 69

def contain_unexpected_character_for_department_name?(name)
  name.match?(%r{[^A-Za-z/, ]})
end

#disable_comment_offset (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/migration/department_name.rb', line 43

def disable_comment_offset
  Regexp.last_match(1).length
end

#on_new_investigation

[ GitHub ]

  
# File 'lib/rubocop/cop/migration/department_name.rb', line 21

def on_new_investigation
  processed_source.comments.each do |comment|
    next if comment.text !~ DISABLE_COMMENT_FORMAT

    offset = Regexp.last_match(1).length

    Regexp.last_match(4).scan(/[^,]+|\W+/) do |name|
      trimmed_name = name.strip

      unless valid_content_token?(trimmed_name)
        check_cop_name(trimmed_name, comment, offset)
      end

      break if contain_unexpected_character_for_department_name?(name)

      offset += name.length
    end
  end
end

#qualified_legacy_cop_name(cop_name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/migration/department_name.rb', line 73

def qualified_legacy_cop_name(cop_name)
  legacy_cop_names = RuboCop::ConfigObsoletion.legacy_cop_names

  legacy_cop_names.detect { |legacy_cop_name| legacy_cop_name.split('/')[1] == cop_name }
end

#valid_content_token?(content_token) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/migration/department_name.rb', line 63

def valid_content_token?(content_token)
  /\W+/.match?(content_token) ||
    DISABLING_COPS_CONTENT_TOKEN.match?(content_token) ||
    Registry.global.department?(content_token)
end