Class: RuboCop::Cop::Style::Copyright
- 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\d3 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::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #autocorrect(token) ⇒ Object
- #autocorrect_notice ⇒ Object
- #encoding_token?(processed_source, token_index) ⇒ Boolean
- #insert_notice_before(processed_source) ⇒ Object
- #investigate(processed_source) ⇒ Object
- #message ⇒ Object
- #notice ⇒ Object
- #notice_found?(processed_source) ⇒ Boolean
- #shebang_token?(processed_source, token_index) ⇒ Boolean
Methods inherited from Cop
#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, inherited, #initialize, #join_force?, lint?, non_rails, qualified_cop_name, rails?, #relevant_file?, #style_guide_url
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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?
Methods included from PathUtil
hidden?, issue_deprecation_warning, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(token) ⇒ Object
70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/rubocop/cop/style/copyright.rb', line 70 def autocorrect(token) fail 'An AutocorrectNotice must be defined in ' \ 'your RuboCop config' if autocorrect_notice.empty? fail "AutocorrectNotice '#{autocorrect_notice}' must match " \ "Notice /#{notice}/" unless autocorrect_notice =~ Regexp.new(notice) @corrections << lambda do |corrector| if token.nil? range = Parser::Source::Range.new('', 0, 0) else range = token.pos end corrector.insert_before(range, "#{autocorrect_notice}\n") end end |
#autocorrect_notice ⇒ Object
28 29 30 |
# File 'lib/rubocop/cop/style/copyright.rb', line 28 def autocorrect_notice cop_config['AutocorrectNotice'] end |
#encoding_token?(processed_source, token_index) ⇒ Boolean
52 53 54 55 56 57 |
# File 'lib/rubocop/cop/style/copyright.rb', line 52 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
39 40 41 42 43 44 |
# File 'lib/rubocop/cop/style/copyright.rb', line 39 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
32 33 34 35 36 37 |
# File 'lib/rubocop/cop/style/copyright.rb', line 32 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, ) end |
#message ⇒ Object
19 20 21 22 |
# File 'lib/rubocop/cop/style/copyright.rb', line 19 def "Include a copyright notice matching /#{notice}/" \ 'before any code.' end |
#notice ⇒ Object
24 25 26 |
# File 'lib/rubocop/cop/style/copyright.rb', line 24 def notice cop_config['Notice'] end |
#notice_found?(processed_source) ⇒ Boolean
59 60 61 62 63 64 65 66 67 68 |
# File 'lib/rubocop/cop/style/copyright.rb', line 59 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
46 47 48 49 50 |
# File 'lib/rubocop/cop/style/copyright.rb', line 46 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 |