Class: RuboCop::Cop::Style::Copyright

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/copyright.rb

Overview

Check that a copyright notice was given in each source file.

The default regexp for an acceptable copyright notice can be found in config/default.yml. The default can be changed as follows:

Style/Copyright:
  Notice: '^Copyright (\(c\) )?2\d{3} Acme Inc'

This regex string is treated as an unanchored regex. For each file that RuboCop scans, a comment that matches this regex must be found or an offense is reported.

Constant Summary collapse

MSG = 
'Include a copyright notice matching /%<notice>s/ before ' \
'any code.'
AUTOCORRECT_EMPTY_WARNING = 
'An AutocorrectNotice must be defined in ' \
'your RuboCop config'

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?, #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?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, 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(token) ⇒ Object

Raises:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/copyright.rb', line 35

def autocorrect(token)
  raise Warning, AUTOCORRECT_EMPTY_WARNING if autocorrect_notice.empty?

  regex = Regexp.new(notice)
  unless autocorrect_notice =~ regex
    raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must " \
                   "match Notice /#{notice}/"
  end

  lambda do |corrector|
    range = token.nil? ? range_between(0, 0) : token.pos
    corrector.insert_before(range, "#{autocorrect_notice}\n")
  end
end

#investigate(processed_source) ⇒ Object 



26
27
28
29
30
31
32
33
 
# File 'lib/rubocop/cop/style/copyright.rb', line 26

def investigate(processed_source)
  return if notice.empty?
  return if notice_found?(processed_source)

  range = source_range(processed_source.buffer, 1, 0)
  add_offense(insert_notice_before(processed_source),
              location: range, message: format(MSG, notice: notice))
end