class RuboCop::Cop::Style::Copyright
an offense is reported.
that RuboCop scans, a comment that matches this regex must be found or
This regex string is treated as an unanchored regex. For each file
Notice: ‘^Copyright ((c) )?2d{3} Acme Inc’
Style/Copyright:
config/default.yml. The default can be changed as follows:
The default regexp for an acceptable copyright notice can be found in
Check that a copyright notice was given in each source file.
def autocorrect(token)
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
def autocorrect_notice
def autocorrect_notice cop_config['AutocorrectNotice'] end
def encoding_token?(processed_source, token_index)
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 insert_notice_before(processed_source)
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 investigate(processed_source)
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 notice
def notice cop_config['Notice'] end
def notice_found?(processed_source)
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
def shebang_token?(processed_source, token_index)
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