Contents

#
# Copyright:: 2019, Chef Software Inc.
# Author:: Tim Smith (<[e-mail]>)
#
# 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 ChefRedundantCode
        # The replaces metadata.rb method is not used and is unnecessary in cookbooks. Replacements for existing cookbooks should be documented in the cookbook's README.md file instead.
        #
        # @example
        #
        #   # bad in metadata.rb:
        #
        #   replaces "another_cookbook"
        #
        class ReplacesMetadata < Cop
          MSG = 'The replaces metadata.rb method is not used and is unnecessary in cookbooks.'.freeze

          def on_send(node)
            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :replaces
          end

          def autocorrect(node)
            lambda do |corrector|
              corrector.remove(node.loc.expression)
            end
          end
        end
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
cookstyle-5.18.4	lib/rubocop/cop/chef/redundant/replaces_metadata.rb
cookstyle-5.17.4	lib/rubocop/cop/chef/redundant/replaces_metadata.rb
cookstyle-5.16.11	lib/rubocop/cop/chef/redundant/replaces_metadata.rb
cookstyle-5.16.10	lib/rubocop/cop/chef/redundant/replaces_metadata.rb
cookstyle-5.15.7	lib/rubocop/cop/chef/redundant/replaces_metadata.rb