Sha256: bcd8d28e8373ef6bf419479486d7c47cf9b7eaaec1678f3200aef81ff7c001d7

Contents?: true

Size: 1.49 KB

Versions: 23

Compression:

Stored size: 1.49 KB

Contents

#
# 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 ChefDeprecations
        # Make sure to use include_recipe instead of require_recipe
        #
        # @example
        #
        #   # bad
        #   require_recipe 'foo'
        #
        #   # good
        #   include_recipe 'foo'
        #
        class RequireRecipe < Cop
          MSG = 'Use include_recipe instead of the require_recipe method'.freeze

          def_node_matcher :require_recipe?, <<-PATTERN
            (send nil? :require_recipe $str)
          PATTERN

          def on_send(node)
            require_recipe?(node) { add_offense(node, location: :selector, message: MSG, severity: :refactor) }
          end

          def autocorrect(node)
            lambda do |corrector|
              corrector.replace(node.loc.selector, 'include_recipe')
            end
          end
        end
      end
    end
  end
end

Version data entries

23 entries across 23 versions & 1 rubygems

Version Path
cookstyle-5.23.0 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.22.6 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.21.9 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.20.0 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.19.9 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.18.4 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.17.4 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.16.11 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.16.10 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.15.7 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.14.1 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.13.7 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.12.13 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.12.12 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.11.0 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.10.13 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.10.11 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.9.3 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.8.1 lib/rubocop/cop/chef/deprecation/require_recipe.rb
cookstyle-5.7.0 lib/rubocop/cop/chef/deprecation/require_recipe.rb