cookstyle 6.15.9 → 6.17.5

data/lib/rubocop/cop/chef/modernize/if_provides_default_action.rb

@@ -29,17 +29,15 @@ module RuboCop
         #   # good
         #   default_action :foo
         #
-        class IfProvidesDefaultAction < Cop
+        class IfProvidesDefaultAction < Base
+          extend AutoCorrector
+
           MSG = 'if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.'
 
           def on_defined?(node)
             return unless node.arguments.first == s(:send, nil, :default_action)
             node = node.parent if node.parent.respond_to?(:if?) && node.parent.if? # we want the whole if statement
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.replace(node.loc.expression, node.children[1].source)
             end
           end

data/lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb

@@ -30,10 +30,12 @@ module RuboCop
         #   require 'chef/mixin/powershell_out'
         #   include Chef::Mixin::PowershellOut
         #
-        class IncludingMixinShelloutInResources < Cop
+        class IncludingMixinShelloutInResources < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'
+          RESTRICT_ON_SEND = [:include, :require].freeze
 
           def_node_matcher :include_shellout?, <<-PATTERN
             (send nil? :include (const (const (const nil? :Chef) :Mixin) {:ShellOut :PowershellOut}))
@@ -60,7 +62,9 @@ module RuboCop
 
             # only add offenses when we're in a custom resource or HWRP, but not a plain old library
             if containing_dir == 'resources' || hwrp_classes?(processed_source.ast)
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
 
@@ -73,12 +77,6 @@ module RuboCop
               check_for_offenses(node)
             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

data/lib/rubocop/cop/chef/modernize/libarchive_file.rb

@@ -34,28 +34,32 @@ module RuboCop
         #     path 'C:\expand_here'
         #   end
         #
-        class LibarchiveFileResource < Cop
+        class LibarchiveFileResource < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '15.0'
 
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource'
+          RESTRICT_ON_SEND = [:libarchive_file, :notifies, :subscribes].freeze
 
           def_node_matcher :notification_property?, <<-PATTERN
             (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))
           PATTERN
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :libarchive_file
-
-            notification_property?(node) do |val|
-              add_offense(val, location: :expression, message: MSG, severity: :refactor) if val.str_content&.start_with?('libarchive_file')
+            # The need for this goes away once https://github.com/rubocop-hq/rubocop/pull/8365 is pulled into Cookstyle
+            if node.method_name == :libarchive_file
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, node.source.gsub('libarchive_file', 'archive_file'))
+              end
             end
-          end
 
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub('libarchive_file', 'archive_file'))
+            notification_property?(node) do |val|
+              next unless val.str_content&.start_with?('libarchive_file')
+              add_offense(val, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, node.source.gsub('libarchive_file', 'archive_file'))
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/macos_user_defaults.rb

@@ -36,19 +36,17 @@ module RuboCop
         #     value '2'
         #   end
         #
-        class MacOsXUserdefaults < Cop
+        class MacOsXUserdefaults < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '14.0'
 
           MSG = 'The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:mac_os_x_userdefaults].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :mac_os_x_userdefaults
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.replace(node.loc.expression, node.source.gsub(/^mac_os_x_userdefaults/, 'macos_userdefaults'))
             end
           end

data/lib/rubocop/cop/chef/modernize/minitest_handler_usage.rb

@@ -26,10 +26,12 @@ module RuboCop
         #   # bad
         #   depends 'minitest-handler'
         #
-        class MinitestHandlerUsage < Cop
+        class MinitestHandlerUsage < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.'
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :minitest_depends?, <<-PATTERN
             (send nil? :depends (str "minitest-handler"))
@@ -37,13 +39,9 @@ module RuboCop
 
           def on_send(node)
             minitest_depends?(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))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/node_roles_include.rb

@@ -29,7 +29,9 @@ module RuboCop
         #   # good
         #   node.role?('foo')
         #
-        class NodeRolesInclude < Cop
+        class NodeRolesInclude < Base
+          extend AutoCorrector
+
           MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`."
 
           def_node_matcher :node_role_include?, <<-PATTERN
@@ -41,14 +43,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            node_role_include?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              node_role_include?(node) do |val|
+            node_role_include?(node) do |val|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(node.loc.expression, "node.role?(#{val.source})")
               end
             end

data/lib/rubocop/cop/chef/modernize/ohai_default_recipe.rb

@@ -29,8 +29,9 @@ module RuboCop
         #   include_recipe 'ohai::default'
         #   include_recipe 'ohai'
         #
-        class IncludingOhaiDefaultRecipe < Cop
+        class IncludingOhaiDefaultRecipe < Base
           MSG = "Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely"
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :ohai_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"ohai" "ohai::default"}))
@@ -38,7 +39,7 @@ module RuboCop
 
           def on_send(node)
             ohai_recipe_usage?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/openssl_rsa_key_resource.rb

@@ -32,19 +32,17 @@ module RuboCop
         #     key_length 2048
         #   end
         #
-        class OpensslRsaKeyResource < Cop
+        class OpensslRsaKeyResource < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '14.0'
 
           MSG = 'The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:openssl_rsa_key].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :openssl_rsa_key
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.replace(node.loc.expression, node.source.gsub(/^openssl_rsa_key/, 'openssl_rsa_private_key'))
             end
           end

data/lib/rubocop/cop/chef/modernize/openssl_x509_resource.rb

@@ -38,19 +38,17 @@ module RuboCop
         #     country 'US'
         #   end
         #
-        class OpensslX509Resource < Cop
+        class OpensslX509Resource < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '14.4'
 
           MSG = 'The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:openssl_x509].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :openssl_x509
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.replace(node.loc.expression, node.source.gsub(/^openssl_x509/, 'openssl_x509_certificate'))
             end
           end

data/lib/rubocop/cop/chef/modernize/osx_config_profile_resource.rb

@@ -32,15 +32,14 @@ module RuboCop
         #     profile 'screensaver/com.company.screensaver.mobileconfig'
         #   end
         #
-        class OsxConfigProfileResource < Cop
+        class OsxConfigProfileResource < Base
+          extend AutoCorrector
+
           MSG = 'The osx_config_profile resource was renamed to osx_profile. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:osx_config_profile].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :osx_config_profile
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.replace(node.loc.expression, node.source.gsub(/^osx_config_profile/, 'osx_profile'))
             end
           end

data/lib/rubocop/cop/chef/modernize/powershell_expand_archive.rb

@@ -29,7 +29,7 @@ module RuboCop
         #     code 'Expand-Archive "C:\\file.zip" -DestinationPath "C:\\inetpub\\wwwroot\\" -Force'
         #   end
         #
-        class PowershellScriptExpandArchive < Cop
+        class PowershellScriptExpandArchive < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
@@ -40,9 +40,8 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
               property_data = method_arg_ast_to_string(code_property)
-              if property_data && property_data.match?(/^expand-archive/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/^expand-archive/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/powershell_guard_interpreter.rb

@@ -43,10 +43,11 @@ module RuboCop
         #     code "mkdir C:\mydir"
         #   end
         #
-        class PowerShellGuardInterpreter < Cop
+        class PowerShellGuardInterpreter < Base
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '13.0'
 
@@ -54,17 +55,12 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(%i(powershell_script batch), 'guard_interpreter', node) do |interpreter|
-              if interpreter.arguments.first.source == ':powershell_script'
-                add_offense(interpreter, location: :expression, message: MSG, severity: :refactor)
+              return unless interpreter.arguments.first.source == ':powershell_script'
+              add_offense(interpreter, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: interpreter.loc.expression, side: :left))
               end
             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

data/lib/rubocop/cop/chef/modernize/powershell_install_package.rb

@@ -32,7 +32,7 @@ module RuboCop
         #  # good
         #  powershell_package 'docker'
         #
-        class PowershellInstallPackage < Cop
+        class PowershellInstallPackage < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
@@ -43,9 +43,8 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
               property_data = method_arg_ast_to_string(code_property)
-              if property_data && property_data.match?(/^install-package\s/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/^install-package\s/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.rb

@@ -35,7 +35,7 @@ module RuboCop
         #    install_method :windows_feature_powershell
         #  end
         #
-        class PowershellInstallWindowsFeature < Cop
+        class PowershellInstallWindowsFeature < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
@@ -46,9 +46,8 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
               property_data = method_arg_ast_to_string(code_property)
-              if property_data && property_data.match?(/^(install|add)-windowsfeature\s/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/^(install|add)-windowsfeature\s/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/property_with_name_attribute.rb

@@ -29,8 +29,11 @@ module RuboCop
         #   # good
         #   property :bob, String, name_property: true
         #
-        class PropertyWithNameAttribute < Cop
+        class PropertyWithNameAttribute < Base
+          extend AutoCorrector
+
           MSG = 'Resource property sets name_attribute instead of name_property'
+          RESTRICT_ON_SEND = [:property].freeze
 
           # match on a property that has any name and any type and a hash that
           # contains name_attribute true. The hash pairs are wrapped in
@@ -40,14 +43,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            property_with_name_attribute?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              property_with_name_attribute?(node) do |name_attribute|
+            property_with_name_attribute?(node) do |name_attribute|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(name_attribute.loc.expression, 'name_property: true')
               end
             end

data/lib/rubocop/cop/chef/modernize/provides_initializer.rb

@@ -32,8 +32,9 @@ module RuboCop
         #   # good
         #   provides :foo
         #
-        class ProvidesFromInitialize < Cop
+        class ProvidesFromInitialize < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'
 
@@ -43,26 +44,23 @@ module RuboCop
 
           def on_ivasgn(node)
             provides_assignment?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if initialize_method(node.parent.parent).any?
+              return unless initialize_method(node.parent.parent).any?
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
+                unless provides_method?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
 
           def_node_search :provides_method?, '(send nil? :provides ... )'
 
           def_node_search :initialize_method, '(def :initialize ... )'
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
-              unless provides_method?(processed_source.ast)
-                initialize_node = initialize_method(processed_source.ast).first
-                corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
-              end
-
-              # remove the variable from the initialize method
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-            end
-          end
         end
       end
     end