Sha256: c517db5be3e2a990234f4dc1b92d8d312831242f50a23c40aacbf93d8afa3b53

Contents?: true

Size: 1.86 KB

Versions: 20

Compression:

Stored size: 1.86 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 ChefModernize
        # 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.
        #
        #   # bad
        #   include Chef::DSL::Recipe
        #   include Chef::DSL::IncludeRecipe
        #
        class DslIncludeInResource < Cop
          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.'.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, location: :expression, message: MSG, severity: :refactor)
            end
          end

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

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
cookstyle-6.11.4 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.10.2 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.9.0 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.8.0 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.7.3 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.6.9 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.5.3 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.4.4 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-5.23.0 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.3.4 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.2.9 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.2.5 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.1.6 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-6.0.19 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-5.22.6 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-5.21.9 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-5.20.0 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-5.19.9 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-5.18.4 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
cookstyle-5.17.4 lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb