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\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 collapse
- AUTOCORRECT_EMPTY_WARNING =
'An AutocorrectNotice must be defined in' \ 'your RuboCop config'.freeze
Constants included from Util
Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version
Methods included from AST::Sexp
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first
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, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?
Methods included from PathUtil
absolute?, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(token) ⇒ Object
73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/rubocop/cop/style/copyright.rb', line 73 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 |
#autocorrect_notice ⇒ Object
31 32 33 |
# File 'lib/rubocop/cop/style/copyright.rb', line 31 def autocorrect_notice cop_config['AutocorrectNotice'] end |
#encoding_token?(processed_source, token_index) ⇒ Boolean
55 56 57 58 59 60 |
# File 'lib/rubocop/cop/style/copyright.rb', line 55 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
42 43 44 45 46 47 |
# File 'lib/rubocop/cop/style/copyright.rb', line 42 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
35 36 37 38 39 40 |
# File 'lib/rubocop/cop/style/copyright.rb', line 35 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
22 23 24 25 |
# File 'lib/rubocop/cop/style/copyright.rb', line 22 def "Include a copyright notice matching /#{notice}/" \ 'before any code.' end |
#notice ⇒ Object
27 28 29 |
# File 'lib/rubocop/cop/style/copyright.rb', line 27 def notice cop_config['Notice'] end |
#notice_found?(processed_source) ⇒ Boolean
62 63 64 65 66 67 68 69 70 71 |
# File 'lib/rubocop/cop/style/copyright.rb', line 62 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
49 50 51 52 53 |
# File 'lib/rubocop/cop/style/copyright.rb', line 49 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 |