class RuboCop::Cop::Style::Copyright

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:

source,yaml

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.

Constants

AUTOCORRECT_EMPTY_WARNING
MSG

Public Instance Methods

on_new_investigation() click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 28
def on_new_investigation
  return if notice.empty? || notice_found?(processed_source)

  verify_autocorrect_notice!
  message = format(MSG, notice: notice)
  if processed_source.blank?
    add_global_offense(message)
  else
    offense_range = source_range(processed_source.buffer, 1, 0)
    add_offense(offense_range, message: message) do |corrector|
      autocorrect(corrector)
    end
  end
end

Private Instance Methods

autocorrect(corrector) click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 45
def autocorrect(corrector)
  token = insert_notice_before(processed_source)
  range = token.nil? ? range_between(0, 0) : token.pos

  corrector.insert_before(range, "#{autocorrect_notice}\n")
end
autocorrect_notice() click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 56
def autocorrect_notice
  cop_config['AutocorrectNotice']
end
encoding_token?(processed_source, token_index) click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 86
def encoding_token?(processed_source, token_index)
  return false if token_index >= processed_source.tokens.size

  token = processed_source.tokens[token_index]
  token.comment? && /\A#.*coding\s?[:=]\s?(?:UTF|utf)-8/.match?(token.text)
end
insert_notice_before(processed_source) click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 72
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
notice() click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 52
def notice
  cop_config['Notice']
end
notice_found?(processed_source) click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 93
def notice_found?(processed_source)
  notice_regexp = Regexp.new(notice.lines.map(&:strip).join)
  multiline_notice = +''
  processed_source.tokens.each do |token|
    break unless token.comment?

    multiline_notice << token.text.sub(/\A# */, '')

    break if notice_regexp.match?(token.text)
  end

  multiline_notice.match?(notice_regexp)
end
shebang_token?(processed_source, token_index) click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 79
def shebang_token?(processed_source, token_index)
  return false if token_index >= processed_source.tokens.size

  token = processed_source.tokens[token_index]
  token.comment? && /\A#!.*\z/.match?(token.text)
end
verify_autocorrect_notice!() click to toggle source
# File lib/rubocop/cop/style/copyright.rb, line 60
def verify_autocorrect_notice!
  if autocorrect_notice.nil? || autocorrect_notice.empty?
    raise Warning, "#{cop_name}: #{AUTOCORRECT_EMPTY_WARNING}"
  end

  regex = Regexp.new(notice)
  return if autocorrect_notice.gsub(/^# */, '').match?(regex)

  message = "AutocorrectNotice '#{autocorrect_notice}' must match Notice /#{notice}/"
  raise Warning, "#{cop_name}: #{message}"
end