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

Inherits:
Cop
  • Object
show all
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 included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/migration/department_name.rb', line 41

def autocorrect(range)
  shall_warn = false
  cop_name = range.source
  qualified_cop_name = Cop.registry.qualified_cop_name(cop_name,
                                                       nil, shall_warn)
  unless qualified_cop_name.include?('/')
    qualified_cop_name = qualified_legacy_cop_name(cop_name)
  end

  ->(corrector) { corrector.replace(range, qualified_cop_name) }
end

#investigate(processed_source) ⇒ Object 



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 investigate(processed_source)
  processed_source.each_comment 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

      break if contain_plain_comment?(trimmed_name)

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

      offset += name.length
    end
  end
end