Contents

# frozen_string_literal: true
#
# 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 Modernize
        # Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.
        #
        # @example
        #
        #   ### incorrect
        #   include Chef::DSL::Recipe
        #   include Chef::DSL::IncludeRecipe
        #
        class DslIncludeInResource < Base
          extend AutoCorrector
          include RangeHelp

          MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.'
          RESTRICT_ON_SEND = [:include].freeze

          def_node_matcher :dsl_include?, <<-PATTERN
          (send nil? :include
            (const
              (const
                (const nil? :Chef) :DSL) {:Recipe :IncludeRecipe}))
          PATTERN

          def on_send(node)
            dsl_include?(node) do
              add_offense(node, severity: :refactor) do |corrector|
                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
              end
            end
          end
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 2 rubygems

Version	Path
cookstyle-7.32.8	lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-7.32.7	lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-ng-8.0.0	lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb