cookstyle 6.15.9 → 6.17.5

data/lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb

@@ -26,11 +26,12 @@ module RuboCop
         #   # bad
         #   provider_base ::Chef::Provider::SomethingSomething
         #
-        class ResourceUsesProviderBaseMethod < Cop
+        class ResourceUsesProviderBaseMethod < Base
           MSG = "Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later."
+          RESTRICT_ON_SEND = [:provider_base].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :provider_base
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

data/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb

@@ -34,11 +34,11 @@ module RuboCop
         #       # code that causes the resource to converge
         #     end
         #
-        class ResourceUsesUpdatedMethod < Cop
+        class ResourceUsesUpdatedMethod < Base
           MSG = "Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later."
 
           def on_lvasgn(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.node_parts.first == :updated
+            add_offense(node, message: MSG, severity: :warning) if node.node_parts.first == :updated
           end
 
           # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from

data/lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb

@@ -36,6 +36,7 @@ module RuboCop
           extend RuboCop::Cop::AutoCorrector
 
           MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'
+          RESTRICT_ON_SEND = [:shell_out!, :shell_out].freeze
 
           def_node_matcher :positional_shellout?, <<-PATTERN
             (send nil? {:shell_out :shell_out!} ... $(hash ... ))

data/lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb

@@ -40,24 +40,22 @@ module RuboCop
         #     action :run
         #   end
         #
-        class RubyBlockCreateAction < Cop
+        class RubyBlockCreateAction < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'
 
           def on_block(node)
             match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
               ruby_action.arguments.each do |action|
-                add_offense(action, location: :expression, message: MSG, severity: :warning) if action.source == ':create'
+                next unless action.source == ':create'
+                add_offense(action.loc.expression, message: MSG, severity: :warning) do |corrector|
+                  corrector.replace(action.loc.expression, ':run')
+                end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, ':run')
-            end
-          end
         end
       end
     end

data/lib/rubocop/cop/chef/deprecation/run_command_helper.rb

@@ -33,8 +33,9 @@ module RuboCop
         #   # good
         #   shell_out!('/bin/foo')
         #
-        class UsesRunCommandHelper < Cop
+        class UsesRunCommandHelper < Base
           MSG = "Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13."
+          RESTRICT_ON_SEND = [:require, :run_command, :run_command_with_systems_locale, :include].freeze
 
           def_node_matcher :calls_run_command?, '(send nil? {:run_command :run_command_with_systems_locale} ...)'
           def_node_matcher :require_mixin_command?, '(send nil? :require (str "chef/mixin/command"))'
@@ -44,15 +45,15 @@ module RuboCop
 
           def on_send(node)
             calls_run_command?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning) unless defines_run_command?(processed_source.ast)
+              add_offense(node, message: MSG, severity: :warning) unless defines_run_command?(processed_source.ast)
             end
 
             require_mixin_command?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
 
             include_mixin_command?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
         end

data/lib/rubocop/cop/chef/deprecation/search_uses_positional_parameters.rb

@@ -35,8 +35,11 @@ module RuboCop
         #  search(:node, '*:*', start: 0, rows: 1000)
         #  search(:node, '*:*', start: 0)
         #
-        class SearchUsesPositionalParameters < Cop
+        class SearchUsesPositionalParameters < Base
+          extend AutoCorrector
+
           MSG = "Don't use deprecated positional parameters in cookbook search queries."
+          RESTRICT_ON_SEND = [:search].freeze
 
           NAMED_PARAM_LOOKUP_TABLE = [nil, nil, 'start', 'rows', 'filter_result'].freeze
 
@@ -46,18 +49,16 @@ module RuboCop
 
           def on_send(node)
             search_method?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning) if positional_arguments?(node)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, corrected_string(node))
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, corrected_string(node))
+              end if positional_arguments?(node)
             end
           end
 
           private
 
+          VALID_TYPES = %i(send hash block_pass).freeze
+
           #
           # Are the arguments in the passed node object positional
           #
@@ -69,7 +70,7 @@ module RuboCop
             return false if node.arguments.count < 3
             node.arguments[2..-1].each do |arg|
               # hashes, blocks, or variable/methods are valid. Anything else is not
-              return true unless %i(send hash block_pass).include?(arg.type)
+              return true unless VALID_TYPES.include?(arg.type)
             end
             false
           end
@@ -82,7 +83,7 @@ module RuboCop
           # @return [String]
           #
           def corrected_string(node)
-            args = node.arguments
+            args = node.arguments.dup
 
             # If the 2nd argument is a String and not an Integer as a String
             # then it's the old sort field and we need to delete it. Same thing

data/lib/rubocop/cop/chef/deprecation/use_inline_resources.rb

@@ -29,27 +29,24 @@ module RuboCop
         #   use_inline_resources if defined?(use_inline_resources)
         #   use_inline_resources if respond_to?(:use_inline_resources)
         #
-        class UseInlineResourcesDefined < Cop
+        class UseInlineResourcesDefined < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified.'
+          RESTRICT_ON_SEND = [:use_inline_resources].freeze
 
           def on_send(node)
-            if node.method_name == :use_inline_resources
-              # don't alert on the use_inline_resources within the defined? check
-              # that would result in 2 alerts on the same line and wouldn't be useful
-              return if node.parent && node.parent.defined_type?
+            # don't alert on the use_inline_resources within the defined? check
+            # that would result in 2 alerts on the same line and wouldn't be useful
+            return if node.parent && node.parent.defined_type?
 
-              # catch the full offense if the method is gated like this: use_inline_resources if defined?(use_inline_resources)
-              if node.parent && node.parent.if_type? && %i(defined? respond_to?).include?(node.parent.children.first.method_name)
-                node = node.parent
-              end
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+            # catch the full offense if the method is gated like this: use_inline_resources if defined?(use_inline_resources)
+            if node.parent && node.parent.if_type? && %i(defined? respond_to?).include?(node.parent.children.first.method_name)
+              node = node.parent
             end
-          end
 
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
               corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
             end
           end

data/lib/rubocop/cop/chef/deprecation/user_supports_property.rb

@@ -41,30 +41,27 @@ module RuboCop
         #     non_unique true
         #   end
         #
-        class UserDeprecatedSupportsProperty < Cop
+        class UserDeprecatedSupportsProperty < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = "The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties."
 
           def on_block(node)
             match_property_in_resource?(:user, 'supports', node) do |property|
-              add_offense(property, location: :expression, message: MSG, severity: :warning)
-            end
-          end
+              add_offense(property, message: MSG, severity: :warning) do |corrector|
+                new_text = []
 
-          def autocorrect(node)
-            lambda do |corrector|
-              new_text = []
+                property.arguments.first.each_pair do |k, v|
+                  # account for a strange edge case where the person incorrectly makes "manage_home a method
+                  # the code would be broken, but without this handling cookstyle would explode
+                  key_value = (k.send_type? && k.method_name == :manage_home) ? 'manage_home' : k.value
 
-              node.arguments.first.each_pair do |k, v|
-                # account for a strange edge case where the person incorrectly makes "manage_home a method
-                # the code would be broken, but without this handling cookstyle would explode
-                key_value = (k.send_type? && k.method_name == :manage_home) ? 'manage_home' : k.value
+                  new_text << "#{key_value} #{v.source}"
+                end
 
-                new_text << "#{key_value} #{v.source}"
+                corrector.replace(property.loc.expression, new_text.join("\n  "))
               end
-
-              corrector.replace(node.loc.expression, new_text.join("\n  "))
             end
           end
         end

data/lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.rb

@@ -33,9 +33,10 @@ module RuboCop
         #     verify 'nginx -t -c %{path}'
         #   end
         #
-        class VerifyPropertyUsesFileExpansion < Cop
+        class VerifyPropertyUsesFileExpansion < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.5'
 
@@ -43,13 +44,10 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(nil, 'verify', node) do |verify|
-              add_offense(verify, location: :expression, message: MSG, severity: :warning) if verify.source.match?(/%{file}/)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub('%{file}', '%{path}'))
+              return unless verify.source.match?(/%{file}/)
+              add_offense(verify, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(verify.loc.expression, verify.loc.expression.source.gsub('%{file}', '%{path}'))
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/deprecation/windows_feature_servermanagercmd.rb

@@ -41,14 +41,14 @@ module RuboCop
         #
         #   windows_feature_powershell 'DHCP'
         #
-        class WindowsFeatureServermanagercmd < Cop
+        class WindowsFeatureServermanagercmd < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.'
 
           def on_block(node)
             match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|
-              add_offense(prop_node, location: :expression, message: MSG, severity: :warning) if prop_node.source.match?(/:servermanagercmd/)
+              add_offense(prop_node, message: MSG, severity: :warning) if prop_node.source.include?(':servermanagercmd')
             end
           end
         end

data/lib/rubocop/cop/chef/deprecation/windows_package_installer_type_string.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, 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
+        # In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
+        #
+        # @example
+        #
+        #   # bad
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type 'msi'
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        #   # good
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type :msi
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        class WindowsPackageInstallerTypeString < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = "In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol."
+
+          def on_block(node)
+            match_property_in_resource?(:windows_package, 'installer_type', node) do |offense|
+              return unless offense.arguments.count == 1 # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # anything else is fine
+
+              add_offense(offense.loc.expression, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(offense.arguments.first.source_range, ":#{offense.arguments.first.value}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb

@@ -40,9 +40,10 @@ module RuboCop
         #     action :create
         #   end
         #
-        class WindowsTaskChangeAction < Cop
+        class WindowsTaskChangeAction < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '13.0'
 
@@ -60,25 +61,19 @@ module RuboCop
             end
           end
 
-          def autocorrect(node)
-            if node.parent.send_type? # :change was the only action
-              lambda do |corrector|
-                corrector.replace(node.loc.expression, ':create')
-              end
-            # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
-            elsif node.parent.child_nodes.count == 2 &&
-                  node.parent.child_nodes.map(&:value).sort == [:change, :create]
-              lambda do |corrector|
-                corrector.replace(node.parent.loc.expression, ':create')
-              end
-            end
-          end
-
           private
 
           def check_action(ast_obj)
             if ast_obj.respond_to?(:value) && ast_obj.value == :change
-              add_offense(ast_obj, location: :expression, message: MSG, severity: :warning)
+              add_offense(ast_obj, message: MSG, severity: :warning) do |corrector|
+                if ast_obj.parent.send_type? # :change was the only action
+                  corrector.replace(ast_obj.loc.expression, ':create')
+                # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
+                elsif ast_obj.parent.child_nodes.count == 2 &&
+                      ast_obj.parent.child_nodes.map(&:value).sort == [:change, :create]
+                  corrector.replace(ast_obj.parent.loc.expression, ':create')
+                end
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/deprecation/windows_version_helpers.rb

@@ -35,8 +35,9 @@ module RuboCop
         #   node['kernel']['server_core']
         #   node['kernel']['product_type'] == 'Workstation'
         #
-        class WindowsVersionHelpers < Cop
+        class WindowsVersionHelpers < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '14.0'
 
@@ -47,14 +48,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            windows_helper?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              windows_helper?(node) do |method|
+            windows_helper?(node) do |method|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 case method
                 when :nt_version
                   corrector.replace(node.loc.expression, 'node[\'platform_version\'].to_f')

data/lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb

@@ -26,8 +26,11 @@ module RuboCop
         #   # bad
         #   include_recipe 'xml::ruby'
         #
-        class IncludingXMLRubyRecipe < Cop
+        class IncludingXMLRubyRecipe < Base
+          extend AutoCorrector
+
           MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :xml_ruby_recipe?, <<-PATTERN
             (send nil? :include_recipe (str "xml::ruby"))
@@ -36,13 +39,9 @@ module RuboCop
           def on_send(node)
             xml_ruby_recipe?(node) do
               node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(node.loc.expression)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(node.loc.expression)
+              end
             end
           end
         end