123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.

#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.

#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#autocorrect(corrector) (private)

[ GitHub ]

  
# 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 (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/copyright.rb', line 56

def autocorrect_notice
  cop_config['AutocorrectNotice']
end

#encoding_token?(processed_source, token_index) ⇒ Boolean (private)

[ GitHub ]

  
# 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) (private)

[ GitHub ]

  
# 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 (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/copyright.rb', line 52

def notice
  cop_config['Notice']
end

#notice_found?(processed_source) ⇒ Boolean (private)

[ GitHub ]

  
# 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

#on_new_investigation

[ GitHub ]

  
# 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

#shebang_token?(processed_source, token_index) ⇒ Boolean (private)

[ GitHub ]

  
# 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! (private)

Raises:

[ GitHub ]

  
# 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