Sha256: cdc5ed347b45dd77b0c19e203c788fdc3e0a6a5b42cc1c65d3889c1cce35e6d2
Contents?: true
Size: 1.66 KB
Versions: 8
Compression:
Stored size: 1.66 KB
Contents
# frozen_string_literal: true
#
# Copyright:: 2016-2019, Chef Software, Inc.
# Author:: Tim Smith (<tsmith@chef.io>)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
module RuboCop
module Cop
module Chef
module ChefStyle
# Checks for default copyright comments from the chef generator cookbook command
#
# @example
#
# # bad
# Copyright:: 2019 YOUR_NAME
# Copyright:: 2019 YOUR_COMPANY_NAME
#
# # good
# Copyright:: 2019 Tim Smith
# Copyright:: 2019 Chef Software, Inc.
#
class DefaultCopyrightComments < Base
MSG = 'Cookbook copyright comment headers should be updated for a real person or organization.'
def on_new_investigation
return unless processed_source.ast
processed_source.comments.each do |comment|
next unless comment.inline? && # headers aren't in blocks
/# (?:Copyright\W*).*YOUR_(NAME|COMPANY_NAME)/.match?(comment.text)
add_offense(comment.loc.expression, message: MSG, severity: :refactor)
end
end
end
end
end
end
end
Version data entries
8 entries across 8 versions & 1 rubygems