cookstyle 6.20.2 → 7.3.10

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # The resource name can now be specified using the `resource_name` helper instead of using the @resource_name variable in the resource provider initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # set_or_return within a method should not be used to define property in a resource. Instead use
         # the property method which properly validates and defines properties in a way that works with
         # reporting and documentation functionality in Chef Infra Client

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to
         # be properties to avoid confusion with chef recipe attributes. When writing a custom resource
         # they should be called properties even though the two are aliased.

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
         #
         #   # bad

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata
         # methods in Chef 11 and early versions of Chef 12.
         #

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # In Chef Infra Client 12+ is is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Chef Infra Client 12.5 introduced the resource_name method for resources. Many cookbooks used respond_to?(:resource_name) to provide backwards compatibility with older chef-client releases. This backwards compatibility is no longer necessary.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # The sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource.
         #
         #   # bad

data/lib/rubocop/cop/chef/modernize/seven_zip_archive.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 seven_zip_archive
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net, which should be used to simplify the resource code in your cookbooks.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefModernize
+      module Modernize
         # The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.
         #
         #   # bad

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