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

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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(token) ⇒ Object

Raises:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/rubocop/cop/style/copyright.rb', line 71

def autocorrect(token)
  raise Warning, 'An AutocorrectNotice must be defined in ' \
    'your RuboCop config' if autocorrect_notice.empty?
  regex = Regexp.new(notice)
  raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must " \
    "match Notice /#{notice}/" unless autocorrect_notice =~ regex

  lambda do |corrector|
    range = if token.nil?
              Parser::Source::Range.new('', 0, 0)
            else
              token.pos
            end
    corrector.insert_before(range, "#{autocorrect_notice}\n")
  end
end

#autocorrect_notice ⇒ Object 



29
30
31
 
# File 'lib/rubocop/cop/style/copyright.rb', line 29

def autocorrect_notice
  cop_config['AutocorrectNotice']
end

#encoding_token?(processed_source, token_index) ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
56
57
58
 
# File 'lib/rubocop/cop/style/copyright.rb', line 53

def encoding_token?(processed_source, token_index)
  return false if token_index >= processed_source.tokens.size
  token = processed_source.tokens[token_index]
  token.type == :tCOMMENT &&
    token.text =~ /^#.*coding\s?[:=]\s?(?:UTF|utf)-8/
end

#insert_notice_before(processed_source) ⇒ Object 



40
41
42
43
44
45
 
# File 'lib/rubocop/cop/style/copyright.rb', line 40

def insert_notice_before(processed_source)
  token_index = 0
  token_index += 1 if shebang_token?(processed_source, token_index)
  token_index += 1 if encoding_token?(processed_source, token_index)
  processed_source.tokens[token_index]
end

#investigate(processed_source) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/rubocop/cop/style/copyright.rb', line 33

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), range, message)
end

#message ⇒ Object 



20
21
22
23
 
# File 'lib/rubocop/cop/style/copyright.rb', line 20

def message
  "Include a copyright notice matching /#{notice}/" \
  'before any code.'
end

#notice ⇒ Object 



25
26
27
 
# File 'lib/rubocop/cop/style/copyright.rb', line 25

def notice
  cop_config['Notice']
end

#notice_found?(processed_source) ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rubocop/cop/style/copyright.rb', line 60

def notice_found?(processed_source)
  notice_found = false
  notice_regexp = Regexp.new(notice)
  processed_source.tokens.each do |token|
    break unless token.type == :tCOMMENT
    notice_found = !(token.text =~ notice_regexp).nil?
    break if notice_found
  end
  notice_found
end

#shebang_token?(processed_source, token_index) ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
50
51
 
# File 'lib/rubocop/cop/style/copyright.rb', line 47

def shebang_token?(processed_source, token_index)
  return false if token_index >= processed_source.tokens.size
  token = processed_source.tokens[token_index]
  token.type == :tCOMMENT && token.text =~ /^#!.*$/
end