/
copyright.rb
99 lines (80 loc) · 3.14 KB
/
copyright.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# 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.
#
class Copyright < Cop
include RangeHelp
MSG = 'Include a copyright notice matching /%<notice>s/ before ' \
'any code.'
AUTOCORRECT_EMPTY_WARNING = 'An AutocorrectNotice must be defined in ' \
'your RuboCop config'
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
def autocorrect(token)
verify_autocorrect_notice!
lambda do |corrector|
range = token.nil? ? range_between(0, 0) : token.pos
corrector.insert_before(range, "#{autocorrect_notice}\n")
end
end
private
def notice
cop_config['Notice']
end
def autocorrect_notice
cop_config['AutocorrectNotice']
end
def verify_autocorrect_notice!
raise Warning, AUTOCORRECT_EMPTY_WARNING if autocorrect_notice.empty?
regex = Regexp.new(notice)
return if autocorrect_notice&.match?(regex)
raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must " \
"match Notice /#{notice}/"
end
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
def shebang_token?(processed_source, token_index)
return false if token_index >= processed_source.tokens.size
token = processed_source.tokens[token_index]
token.comment? && token.text =~ /^#!.*$/
end
def encoding_token?(processed_source, token_index)
return false if token_index >= processed_source.tokens.size
token = processed_source.tokens[token_index]
token.comment? && token.text =~ /^#.*coding\s?[:=]\s?(?:UTF|utf)-8/
end
def notice_found?(processed_source)
notice_found = false
notice_regexp = Regexp.new(notice)
processed_source.each_token do |token|
break unless token.comment?
notice_found = !(token.text =~ notice_regexp).nil?
break if notice_found
end
notice_found
end
end
end
end
end