Sha256: 7c12dc06865c1596eb46a22239ab50c5e6bee74d038104434982bc5914ab4f7b

Contents?: true

Size: 1.95 KB

Versions: 12

Compression:

Stored size: 1.95 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
        # There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client.
        #
        # @example
        #
        #   # bad
        #   require 'chef/mixin/shell_out'
        #   include Chef::Mixin::ShellOut

        class IncludingMixinShelloutInResources < Cop
          MSG = 'There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client.'.freeze

          def_node_matcher :include_shellout?, <<-PATTERN
            (send nil? :include (const (const (const nil? :Chef) :Mixin) :ShellOut))
          PATTERN

          def_node_matcher :require_shellout?, <<-PATTERN
            (send nil? :require ( str "chef/mixin/shell_out"))
          PATTERN

          def on_send(node)
            require_shellout?(node) do
              add_offense(node, location: :expression, message: MSG, severity: :refactor)
            end

            include_shellout?(node) do
              add_offense(node, location: :expression, message: MSG, severity: :refactor)
            end
          end

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

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
cookstyle-5.13.7 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.12.13 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.12.12 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.11.0 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.10.13 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.10.11 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.9.3 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.8.1 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.7.0 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.6.5 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.6.2 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
cookstyle-5.5.7 lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb