cookstyle 6.20.1 → 7.2.1

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
         #
         # @example
@@ -60,8 +60,8 @@ module RuboCop
                     (lvar _))}) nil?)
           PATTERN
 
-          def_node_matcher :package_array_install?, <<-PATTERN
-          (block
+          def_node_search :package_array_install, <<-PATTERN
+          $(block
             (send
               $(array ... ) :each)
             (args ... )
@@ -78,27 +78,31 @@ module RuboCop
           # see if all platforms in the when condition are multi-package compliant
           def multipackage_platforms?(condition_obj)
             condition_obj.all? do |p|
-              MULTIPACKAGE_PLATS.include?(p.value)
+              # make sure it's a string (not a regex) and it's in the array
+              p.str_type? && MULTIPACKAGE_PLATS.include?(p.value)
             end
           end
 
           def on_when(node)
             return unless platform_or_platform_family?(node.parent.condition) &&
-                          package_array_install?(node.body) &&
                           multipackage_platforms?(node.conditions)
-            check_offense(node.body)
+            return if node.body.nil? # don't blow up on empty whens
+
+            package_array_install(node.body) do |install_block, pkgs|
+              add_offense(install_block, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(install_block, "package #{pkgs.source}")
+              end
+            end
           end
 
           def on_if(node)
             platform_helper?(node) do |plats, blk, _pkgs|
-              check_offense(blk) if multipackage_platforms?(plats)
-            end
-          end
+              return unless multipackage_platforms?(plats)
 
-          def check_offense(node)
-            add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              package_array_install?(node) do |vals|
-                corrector.replace(node, "package #{vals.source}")
+              add_offense(blk, message: MSG, severity: :refactor) do |corrector|
+                package_array_install(blk) do |install_block, pkgs|
+                  corrector.replace(install_block, "package #{pkgs.source}")
+                end
               end
             end
           end

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # whyrun_supported? no longer needs to be set to true as that is the default in Chef Infra Client 13+
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Don't include the windows default recipe that is either full of gem install that are part of the Chef Infra Client, or empty (depends on version).
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.
         #
         #   # bad
@@ -37,7 +37,7 @@ module RuboCop
         #    consent_behavior_admins :no_prompt
         #  end
         #
-        class WindowsRegistryUAC < Cop
+        class WindowsRegistryUAC < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
@@ -53,7 +53,7 @@ module RuboCop
 
             # use source instead of .value in case there's string interpolation which adds a complex dstr type
             # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            add_offense(node, message: MSG, severity: :refactor)
           end
 
           # block execute resources
@@ -61,7 +61,7 @@ module RuboCop
             match_property_in_resource?(:registry_key, 'key', node) do |key_prop|
               property_data = method_arg_ast_to_string(key_prop)
               return unless property_data && property_data.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
-              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/windows_zipfile.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.
         #
         #   # bad

data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.
         #
         #   # bad

data/lib/rubocop/cop/chef/redundant/attribute_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The attribute metadata.rb method is not used and is unnecessary in cookbooks.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/conflicts_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The conflicts metadata.rb method is not used and is unnecessary in cookbooks.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/double_compile_time.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
         #
         #   # bad

data/lib/rubocop/cop/chef/redundant/grouping_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The grouping metadata.rb method is not used and is unnecessary in cookbooks.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/long_description_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The long_description metadata.rb method is not used and is unnecessary in cookbooks.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/name_property_and_required.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # When using properties in a custom resource you shouldn't set a property to
         # be both required and a name_property. Name properties are a way to optionally
         # override the name given to the resource block in cookbook code. In your resource

data/lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Many Ohai node attributes are already strings and don't need to be cast to strings again
         #
         # @example

data/lib/rubocop/cop/chef/redundant/property_splat_regex.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # When a property has a type of String it can accept any string. There is no need to also validate string inputs against a regex that accept all values.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/property_with_default_and_required.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # When using properties in a custom resource you shouldn't set a property to
         # required and then provide a default value. If a property is required the
         # user will always pass in a value and the default will never be used. In Chef

data/lib/rubocop/cop/chef/redundant/provides_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The provides metadata.rb method is not used and is unnecessary in cookbooks.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/recipe_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/replaces_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The replaces metadata.rb method is not used and is unnecessary in cookbooks. Replacements for existing cookbooks should be documented in the cookbook's README.md file instead.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/resource_with_nothing_action.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Chef Infra Client provides the :nothing action by default for every resource. There is no need to define a :nothing action in your resource code.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Every Chef Infra resource already includes a sensitive property with a default value of false.
         #
         # # bad

data/lib/rubocop/cop/chef/redundant/string_property_with_nil_default.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Properties have a nil value by default so there is no need to set the default value to nil.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/suggests_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The suggests metadata.rb method is not used and is unnecessary in cookbooks.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb

@@ -18,16 +18,22 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
-        # There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.
+      module RedundantCode
+        # There is no need to set a property/attribute to desired_state: true as all properties/attributes have a desired_state of true by default.
         #
         # @example
         #
         #   # bad
         #   property :foo, String, desired_state: true
+        #   attribute :foo, String, desired_state: true
         #
-        class UnnecessaryDesiredState < Cop
+        #   # good
+        #   property :foo, String
+        #   attribute :foo, String
+        #
+        class UnnecessaryDesiredState < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
           RESTRICT_ON_SEND = [:property, :attribute].freeze
@@ -39,19 +45,14 @@ module RuboCop
           def on_send(node)
             property?(node) do |hash_vals|
               hash_vals.each_pair do |k, v|
-                if k == s(:sym, :desired_state) && v == s(:true) # cookstyle: disable Lint/BooleanSymbol
-                  add_offense(v.parent, location: :expression, message: MSG, severity: :refactor)
+                next unless k == s(:sym, :desired_state) && v == s(:true) # cookstyle: disable Lint/BooleanSymbol
+                add_offense(v.parent, message: MSG, severity: :refactor) do |corrector|
+                  range = range_with_surrounding_comma(range_with_surrounding_space(range: v.parent.loc.expression, side: :left), :left)
+                  corrector.remove(range)
                 end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              range = range_with_surrounding_comma(range_with_surrounding_space(range: node.loc.expression, side: :left), :left)
-              corrector.remove(range)
-            end
-          end
         end
       end
     end

data/lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/use_create_if_missing.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.
         #
         # @example

data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # Metadata contains default maintainer information from the `chef generate cookbook` command. This should be updated to reflect that actual maintainer of the cookbook.
         #
         # @example

data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # metadata.rb should not include fields with an empty string. Either don't include the field or add a value.
         #
         # @example