Sha256: 531e415353ae682810ddfa722aa3893dcf79c568229bbf60413da44851a64efc

Contents?: true

Size: 1.89 KB

Versions: 8

Compression:

Stored size: 1.89 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 ChefModernize
        # Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.
        #
        # @example
        #
        #   # bad
        #   Mixlib::ShellOut.new('foo').run_command
        #
        #   # good
        #   shell_out('foo')
        #
        class ShellOutHelper < Base
          extend AutoCorrector
          extend TargetChefVersion

          minimum_target_chef_version '12.11'

          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`."

          def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
          (send
            (send
              (const
                (const nil? :Mixlib) :ShellOut) :new
              $(...)) :run_command)
          PATTERN

          def on_send(node)
            mixlib_shellout_run_cmd?(node) do |cmd|
              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                corrector.replace(node.loc.expression, "shell_out(#{cmd.loc.expression.source})")
              end
            end
          end
        end
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
cookstyle-6.18.8 lib/rubocop/cop/chef/modernize/shell_out_helper.rb
cookstyle-6.17.7 lib/rubocop/cop/chef/modernize/shell_out_helper.rb
cookstyle-6.17.6 lib/rubocop/cop/chef/modernize/shell_out_helper.rb
cookstyle-6.17.5 lib/rubocop/cop/chef/modernize/shell_out_helper.rb
cookstyle-6.16.10 lib/rubocop/cop/chef/modernize/shell_out_helper.rb
cookstyle-6.16.9 lib/rubocop/cop/chef/modernize/shell_out_helper.rb
cookstyle-6.16.7 lib/rubocop/cop/chef/modernize/shell_out_helper.rb
cookstyle-6.16.4 lib/rubocop/cop/chef/modernize/shell_out_helper.rb