Sha256: 5ca5af74581fb4661951adb4fbfa6d5f5ab5f74de617935b641181b7b054724e

Contents?: true

Size: 1.69 KB

Versions: 6

Compression:

Stored size: 1.69 KB

Contents

# frozen_string_literal: true
#
# Copyright:: 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 ChefRedundantCode
        # The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead.
        #
        # @example
        #
        #   # bad
        #   recipe 'openldap::default', 'Install and configure OpenLDAP'
        #
        #
        class RecipeMetadata < Cop
          include RangeHelp
          include RuboCop::Chef::AutocorrectHelpers

          MSG = "The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead."

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

          def autocorrect(node)
            lambda do |corrector|
              corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
            end
          end
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
cookstyle-6.15.9 lib/rubocop/cop/chef/redundant/recipe_metadata.rb
cookstyle-6.15.5 lib/rubocop/cop/chef/redundant/recipe_metadata.rb
cookstyle-6.15.3 lib/rubocop/cop/chef/redundant/recipe_metadata.rb
cookstyle-6.14.7 lib/rubocop/cop/chef/redundant/recipe_metadata.rb
cookstyle-6.13.3 lib/rubocop/cop/chef/redundant/recipe_metadata.rb
cookstyle-6.12.6 lib/rubocop/cop/chef/redundant/recipe_metadata.rb