cookstyle 6.15.3 → 6.16.9

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

@@ -38,7 +38,7 @@ module RuboCop
         #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
         #   provider = resource.provider_for_action(:create)
         #
-        class DeprecatedPlatformMethods < Cop
+        class DeprecatedPlatformMethods < Base
           MSG = 'Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
 
           def_node_matcher :platform_method?, <<-PATTERN
@@ -47,7 +47,7 @@ module RuboCop
 
           def on_send(node)
             platform_method?(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/deprecated_shellout_methods.rb

@@ -39,25 +39,24 @@ module RuboCop
         #   shell_out!('foo')
         #   shell_out!('foo', default_env: false) # replaces shell_out_with_systems_locale
         #
-        class DeprecatedShelloutMethods < Cop
+        class DeprecatedShelloutMethods < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '14.3'
 
-          DEPRECATED_SHELLOUT_METHODS = %i( shell_out_compact
-                                            shell_out_compact!
-                                            shell_out_compact_timeout
-                                            shell_out_compact_timeout!
-                                            shell_out_with_timeout
-                                            shell_out_with_timeout!
-                                            shell_out_with_systems_locale
-                                            shell_out_with_systems_locale!
-                                          ).freeze
-
           MSG = 'Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.'
+          RESTRICT_ON_SEND = %i( shell_out_compact
+          shell_out_compact!
+          shell_out_compact_timeout
+          shell_out_compact_timeout!
+          shell_out_with_timeout
+          shell_out_with_timeout!
+          shell_out_with_systems_locale
+          shell_out_with_systems_locale!
+        ).freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if DEPRECATED_SHELLOUT_METHODS.include?(node.method_name)
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -28,11 +28,12 @@ module RuboCop
         #     # do some legacy things
         #   end
         #
-        class DeprecatedWindowsVersionCheck < Cop
+        class DeprecatedWindowsVersionCheck < Base
           MSG = "Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false."
+          RESTRICT_ON_SEND = [:older_than_win_2012_or_8?].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :older_than_win_2012_or_8?
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -41,9 +41,10 @@ module RuboCop
         #     action :create
         #   end
         #
-        class DeprecatedYumRepositoryProperties < Cop
+        class DeprecatedYumRepositoryProperties < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.14'
 
@@ -52,16 +53,15 @@ module RuboCop
           def on_block(node)
             %w(url keyurl mirrorexpire).each do |prop|
               match_property_in_resource?(:yum_repository, prop, node) do |prop_node|
-                add_offense(prop_node, location: :expression, message: MSG, severity: :warning)
+                add_offense(prop_node, message: MSG, severity: :warning)  do |corrector|
+                  corrector.replace(prop_node.loc.expression, prop_node.loc.expression.source
+                    .gsub(/^url/, 'baseurl')
+                    .gsub(/^keyurl/, 'gpgkey')
+                    .gsub(/^mirrorexpire/, 'mirror_expire'))
+                end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^url/, 'baseurl').gsub(/^keyurl/, 'gpgkey').gsub(/^mirrorexpire/, 'mirror_expire'))
-            end
-          end
         end
       end
     end

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

@@ -29,11 +29,12 @@ module RuboCop
         #     bar
         #   end
         #
-        class EasyInstallResource < Cop
+        class EasyInstallResource < Base
           MSG = "Don't use the deprecated easy_install resource removed in Chef Infra Client 13"
+          RESTRICT_ON_SEND = [:easy_install].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :easy_install
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -32,14 +32,15 @@ module RuboCop
         #     end
         #   end
 
-        class EOLAuditModeUsage < Cop
+        class EOLAuditModeUsage < Base
           MSG = 'The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.'
+          RESTRICT_ON_SEND = [:control_group].freeze
 
           def_node_matcher :control_group?, '(send nil? :control_group ...)'
 
           def on_send(node)
             control_group?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
+              add_offense(node.loc.selector, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -34,15 +34,14 @@ module RuboCop
         #     ignore_failure true
         #   end
         #
-        class EpicFail < Cop
+        class EpicFail < Base
+          extend AutoCorrector
+
           MSG = 'Use ignore_failure method instead of the deprecated epic_fail method'
+          RESTRICT_ON_SEND = [:epic_fail].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :epic_fail
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
               corrector.replace(node.loc.expression, 'ignore_failure true')
             end
           end

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

@@ -29,11 +29,12 @@ module RuboCop
         #     bar
         #   end
         #
-        class ErlCallResource < Cop
+        class ErlCallResource < Base
           MSG = "Don't use the deprecated erl_call resource removed in Chef Infra Client 13"
+          RESTRICT_ON_SEND = [:erl_call].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :erl_call
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -82,7 +82,9 @@ module RuboCop
         #  # better
         #  Convert your legacy HWRPs to custom resources
         #
-        class HWRPWithoutProvides < Cop
+        class HWRPWithoutProvides < Base
+          extend AutoCorrector
+
           MSG = 'In Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.'
 
           def_node_matcher :HWRP?, <<-PATTERN
@@ -102,8 +104,15 @@ module RuboCop
           def_node_search :resource_name, '(send nil? :resource_name (sym $_))'
 
           def on_class(node)
+            return if has_provides?
             HWRP?(node) do |inherit|
-              add_offense(inherit, location: :expression, message: MSG, severity: :warning) unless has_provides?
+              add_offense(inherit, message: MSG, severity: :warning) do |corrector|
+                resource_name_ast(node) do |ast_match|
+                  # build a new string to add after that includes the new line and the proper indentation
+                  new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
+                  corrector.insert_after(ast_match.source_range, new_string)
+                end
+              end
             end
           end
 
@@ -125,16 +134,6 @@ module RuboCop
           def indentation(node)
             node.source_range.source_line =~ /\S/
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              resource_name_ast(node) do |ast_match|
-                # build a new string to add after that includes the new line and the proper indentation
-                new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
-                corrector.insert_after(ast_match.source_range, new_string)
-              end
-            end
-          end
         end
       end
     end

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

@@ -37,7 +37,9 @@ module RuboCop
         #  # better
         #  Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely
         #
-        class ResourceInheritsFromCompatResource < Cop
+        class ResourceInheritsFromCompatResource < Base
+          extend AutoCorrector
+
           MSG = "HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook."
 
           def_node_matcher :inherits_from_compat_resource?, <<-PATTERN
@@ -46,13 +48,9 @@ module RuboCop
 
           def on_class(node)
             inherits_from_compat_resource?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub('ChefCompat', 'Chef'))
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, node.loc.expression.source.gsub('ChefCompat', 'Chef'))
+              end
             end
           end
         end

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

@@ -33,23 +33,20 @@ module RuboCop
         #     plist_hash foo: 'bar'
         #   end
         #
-        class LaunchdDeprecatedHashProperty < Cop
+        class LaunchdDeprecatedHashProperty < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.19'
 
           MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class."
 
           def on_block(node)
-            match_property_in_resource?(:launchd, 'hash', node) do |hash_prop|
-              add_offense(hash_prop, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^hash/, 'plist_hash'))
+            match_property_in_resource?(:launchd, 'hash', node) do |offense|
+              add_offense(offense.loc.expression, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(offense.loc.expression, offense.loc.expression.source.gsub(/^hash/, 'plist_hash'))
+              end
             end
           end
         end

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

@@ -57,22 +57,19 @@ module RuboCop
         #     subscribes :restart, "service[#{service_name_variable}]", :immediately
         #   end
         #
-        class LegacyNotifySyntax < Cop
+        class LegacyNotifySyntax < Base
+          extend AutoCorrector
+
           MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
 
           def_node_matcher :legacy_notify?, <<-PATTERN
             (send nil? ${:notifies :subscribes} $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
           PATTERN
 
           def on_send(node)
-            legacy_notify?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              legacy_notify?(node) do |notify_type, action, type, name, timing|
+            legacy_notify?(node) do |notify_type, action, type, name, timing|
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
                 service_value = case name.type
                                 when :str
                                   "'#{type.source}[#{name.value}]'"

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

@@ -33,8 +33,9 @@ module RuboCop
         #   include_recipe 'yum::repoforge'
         #   include_recipe 'yum::yum'
         #
-        class LegacyYumCookbookRecipes < Cop
+        class LegacyYumCookbookRecipes < Base
           MSG = 'The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :old_yum_recipe?, <<-PATTERN
             (send nil? :include_recipe (str {"yum::elrepo" "yum::epel" "yum::ius" "yum::remi" "yum::repoforge" "yum::yum"}))
@@ -42,7 +43,7 @@ module RuboCop
 
           def on_send(node)
             old_yum_recipe?(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/locale_lc_all_property.rb

@@ -29,14 +29,14 @@ module RuboCop
         #     lc_all 'en_gb.utf-8'
         #   end
         #
-        class LocaleDeprecatedLcAllProperty < Cop
+        class LocaleDeprecatedLcAllProperty < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = "The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17"
 
           def on_block(node)
             match_property_in_resource?(:locale, 'lc_all', node) do |property|
-              add_offense(property, location: :expression, message: MSG, severity: :warning)
+              add_offense(property, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -31,10 +31,12 @@ module RuboCop
         #   property :config_file, String, name_property: true
         #   attribute :config_file, String, name_attribute: true
         #
-        class NamePropertyWithDefaultValue < Cop
+        class NamePropertyWithDefaultValue < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = "A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later."
+          RESTRICT_ON_SEND = [:attribute, :property].freeze
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains name_property/name_attribute true and any default value. These are wrapped in
@@ -44,14 +46,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            name_property_with_default?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              name_property_with_default?(node) do |default|
+            name_property_with_default?(node) do |default|
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
                 range = range_with_surrounding_comma(range_with_surrounding_space(range: default.loc.expression, side: :left), :left)
                 corrector.remove(range)
               end

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

@@ -37,7 +37,9 @@ module RuboCop
         #   node['platform_version']
         #   node['hostname']
         #
-        class NodeMethodsInsteadofAttributes < Cop
+        class NodeMethodsInsteadofAttributes < Base
+          extend AutoCorrector
+
           MSG = 'Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.'
 
           def_node_matcher :node_ohai_methods?, <<-PATTERN
@@ -46,13 +48,9 @@ module RuboCop
 
           def on_send(node)
             node_ohai_methods?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "node['#{node.method_name}']")
+              add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, "node['#{node.method_name}']")
+              end
             end
           end
 

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

@@ -30,7 +30,9 @@ module RuboCop
         #   # good
         #   node.normal['foo'] = true
         #
-        class NodeSet < Cop
+        class NodeSet < Base
+          extend AutoCorrector
+
           MSG = 'Do not use node.set. Replace with node.normal to keep identical behavior.'
 
           def_node_matcher :node_set?, <<-PATTERN
@@ -39,13 +41,9 @@ module RuboCop
 
           def on_send(node)
             node_set?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.selector, 'normal')
+              add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.selector, 'normal')
+              end
             end
           end
         end

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

@@ -30,7 +30,9 @@ module RuboCop
         #   # good
         #   node.normal_unless['foo'] = true
         #
-        class NodeSetUnless < Cop
+        class NodeSetUnless < Base
+          extend AutoCorrector
+
           MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'
 
           def_node_matcher :node_set_unless?, <<-PATTERN
@@ -39,13 +41,9 @@ module RuboCop
 
           def on_send(node)
             node_set_unless?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.selector, 'normal_unless')
+              add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.selector, 'normal_unless')
+              end
             end
           end
         end