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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
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 collapse

MSG =
'Department name is missing.'
DISABLE_COMMENT_FORMAT =
/\A(# *rubocop *: *((dis|en)able|todo) +)(.*)/.freeze
DISABLING_COPS_CONTENT_TOKEN =

The token that makes up a disable comment. The allowed specification for comments after `# rubocop: disable` is `DepartmentName/CopName` or` all`.

%r{[A-z]+/[A-z]+|all}.freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_new_investigationObject


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# 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