cookstyle 6.17.6 → 6.20.1

data/lib/rubocop/cop/chef/effortless/depends_chef_vault.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Scott Vidmar (<svidmar@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 ChefEffortless
+        # Chef Vault is not supported in the Effortless pattern, so usage of Chef Vault must be shifted to another secrets management solution before leveraging the Effortless pattern.
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'chef-vault'
+        #
+
+        class DependsChefVault < Base
+          MSG = 'Chef Vault usage is not supported in the Effortless pattern'
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :depends?, <<-PATTERN
+            (send nil? :depends
+              (str "chef-vault"))
+          PATTERN
+
+          def on_send(node)
+            depends?(node) do
+              add_offense(node.loc.expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -45,9 +45,9 @@ module RuboCop
             return if node.arguments? # if they passed in arguments they may actually need this
             return if node.parent && includes_poise?(node.parent)
 
-            add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               # @todo when we drop ruby 2.4 support we can convert this to use delete_suffix
-              corrector.replace(node.loc.expression, node.source.gsub("def #{node.method_name}", "action :#{node.method_name.to_s.gsub(/^action_/, '')} do"))
+              corrector.replace(node, node.source.gsub("def #{node.method_name}", "action :#{node.method_name.to_s.gsub(/^action_/, '')} do"))
             end
           end
         end

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

@@ -55,13 +55,13 @@ module RuboCop
           def on_send(node)
             berksfile_source?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+                corrector.replace(node, "source 'https://supermarket.chef.io'")
               end
             end
 
             berksfile_site?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+                corrector.replace(node, "source 'https://supermarket.chef.io'")
               end
             end
           end

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

@@ -44,7 +44,7 @@ module RuboCop
           def on_send(node)
             build_essential_recipe_usage?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "build_essential 'install compilation tools'")
+                corrector.replace(node, "build_essential 'install compilation tools'")
               end
             end
           end

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

@@ -35,6 +35,7 @@ module RuboCop
         #
         class ResourceForcingCompileTime < Base
           MSG = "Set 'compile_time true' in resources when available instead of forcing resources to run at compile time by setting an action on the block."
+          RESTRICT_ON_SEND = [:run_action].freeze
 
           def_node_matcher :compile_time_resource?, <<-PATTERN
             (send (block (send nil? {:build_essential :chef_gem :hostname :ohai_hint} (...)) (args) (...)) $:run_action (sym ...))

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

@@ -36,7 +36,7 @@ module RuboCop
           RESTRICT_ON_SEND = [:not_if, :only_if].freeze
 
           def_node_matcher :resource_conditional?, <<~PATTERN
-          (send nil? {:not_if :only_if} $str )
+            (send nil? {:not_if :only_if} $str )
           PATTERN
 
           def on_send(node)
@@ -44,7 +44,7 @@ module RuboCop
               return unless conditional.value.match?(/^test -[ef] \S*$/)
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 new_string = "{ ::File.exist?('#{conditional.value.match(/^test -[ef] (\S*)$/)[1]}') }"
-                corrector.replace(conditional.loc.expression, new_string)
+                corrector.replace(conditional, new_string)
               end
             end
           end

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

@@ -40,7 +40,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^cron_manage/, 'cron_access'))
+              corrector.replace(node, node.source.gsub(/^cron_manage/, 'cron_access'))
             end
           end
         end

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

@@ -35,6 +35,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.'
+          RESTRICT_ON_SEND = [:load].freeze
 
           def_node_matcher :data_bag_class_load?, <<-PATTERN
           (send
@@ -46,7 +47,7 @@ module RuboCop
           def on_send(node)
             data_bag_class_load?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression,
+                corrector.replace(node,
                    node.source.gsub(/Chef::(EncryptedDataBagItem|DataBagItem).load/, 'data_bag_item'))
               end
             end

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

@@ -36,7 +36,7 @@ module RuboCop
             processed_source.comments.each do |comment|
               next unless comment.text.match?(/#\s*~FC\d{3}.*/)
               add_offense(comment, message: MSG, severity: :refactor) do |corrector|
-                corrector.remove(comment.loc.expression)
+                corrector.remove(comment)
               end
             end
           end

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

@@ -38,7 +38,7 @@ module RuboCop
             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, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.children[1].source)
+              corrector.replace(node, node.children[1].source)
             end
           end
         end

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

@@ -51,14 +51,14 @@ module RuboCop
             # 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'))
+                corrector.replace(node, node.source.gsub('libarchive_file', 'archive_file'))
               end
             end
 
             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'))
+                corrector.replace(node, node.source.gsub('libarchive_file', 'archive_file'))
               end
             end
           end

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

@@ -47,7 +47,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^mac_os_x_userdefaults/, 'macos_userdefaults'))
+              corrector.replace(node, node.source.gsub(/^mac_os_x_userdefaults/, 'macos_userdefaults'))
             end
           end
         end

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

@@ -43,6 +43,7 @@ module RuboCop
           extend RuboCop::Cop::AutoCorrector
 
           MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'"
+          RESTRICT_ON_SEND = [:open, :read, :exist?, :==, :not_if, :only_if].freeze
 
           def_node_matcher :file_reads_proc_1_comm?, <<-PATTERN
             (send (const {(cbase) nil?} {:File :IO}) {:open :read} (str "/proc/1/comm"))
@@ -62,7 +63,7 @@ module RuboCop
           PATTERN
 
           def_node_matcher :file_systemd_conditional?, <<~PATTERN
-          (send nil? {:not_if :only_if} $(str "test -f /bin/systemctl && /bin/systemctl"))
+            (send nil? {:not_if :only_if} $(str "test -f /bin/systemctl && /bin/systemctl"))
           PATTERN
 
           def on_send(node)
@@ -70,14 +71,14 @@ module RuboCop
               # if there's a ::File.exist?('/proc/1/comm') check first we want to match that as well
               node = node.parent if node.parent&.and_type? && proc_1_comm_exists?(node.parent.conditions.first)
 
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(node, "node['init_package'] == 'systemd'")
               end
             end
 
             file_systemd_conditional?(node) do |conditional|
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(conditional.loc.expression, "{ node['init_package'] == 'systemd' }")
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(conditional, "{ node['init_package'] == 'systemd' }")
               end
             end
           end

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

@@ -33,6 +33,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`."
+          RESTRICT_ON_SEND = [:include?].freeze
 
           def_node_matcher :node_role_include?, <<-PATTERN
           (send
@@ -45,7 +46,7 @@ module RuboCop
           def on_send(node)
             node_role_include?(node) do |val|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "node.role?(#{val.source})")
+                corrector.replace(node, "node.role?(#{val.source})")
               end
             end
           end

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

@@ -43,7 +43,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^openssl_rsa_key/, 'openssl_rsa_private_key'))
+              corrector.replace(node, node.source.gsub(/^openssl_rsa_key/, 'openssl_rsa_private_key'))
             end
           end
         end

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

@@ -49,7 +49,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^openssl_x509/, 'openssl_x509_certificate'))
+              corrector.replace(node, node.source.gsub(/^openssl_x509/, 'openssl_x509_certificate'))
             end
           end
         end

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

@@ -40,7 +40,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^osx_config_profile/, 'osx_profile'))
+              corrector.replace(node, node.source.gsub(/^osx_config_profile/, 'osx_profile'))
             end
           end
         end

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

@@ -45,7 +45,7 @@ module RuboCop
           def on_send(node)
             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')
+                corrector.replace(name_attribute, 'name_property: true')
               end
             end
           end

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

@@ -44,6 +44,7 @@ module RuboCop
         #   end
         #
         class RespondToCompileTime < Base
+          include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
           extend AutoCorrector
 
@@ -75,10 +76,12 @@ module RuboCop
               $(_)) nil?)
           PATTERN
 
-          def on_if(node)
-            compile_time_method_defined?(node) do |val|
-              add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "compile_time #{val.source}")
+          def on_block(node)
+            match_property_in_resource?(:chef_gem, 'compile_time', node) do |compile_time_property|
+              compile_time_method_defined?(compile_time_property.parent) do |val|
+                add_offense(compile_time_property.parent, message: MSG, severity: :refactor) do |corrector|
+                  corrector.replace(compile_time_property.parent, "compile_time #{val.source}")
+                end
               end
             end
           end

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

@@ -27,6 +27,7 @@ module RuboCop
         #   # bad
         #   chef_version '>= 13' if respond_to?(:chef_version)
         #   chef_version '>= 13' if defined?(chef_version)
+        #   chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
         #   if defined(chef_version)
         #     chef_version '>= 13'
         #   end
@@ -40,7 +41,7 @@ module RuboCop
 
           minimum_target_chef_version '12.15'
 
-          MSG = 'It is no longer necessary to use respond_to? or if_defined? in metadata.rb in Chef Infra Client 12.15 and later'
+          MSG = 'It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later'
 
           def on_if(node)
             if_respond_to?(node) do
@@ -51,7 +52,7 @@ module RuboCop
                 # is a block under the if statement and node.parent.if_branch can get us that block
                 node = node.parent unless node.if_type?
 
-                corrector.replace(node.loc.expression, node.if_branch.source)
+                corrector.replace(node, node.if_branch.source)
               end
             end
           end
@@ -61,15 +62,14 @@ module RuboCop
             # node.if_branch is the actual method call we want to extract.
             # If a series of metadata methods are wrapped in an if statement then the content we want
             # is a block under the if statement and node.parent.if_branch can get us that block
-
-            node = node.parent if node.parent.if? && !node.if_type? # we want the whole if statement
+            node = node.parent if node.parent.conditional? # we want the whole conditional statement
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.if_branch.source)
+              corrector.replace(node, node.if_branch.source)
             end
           end
 
           def_node_matcher :if_respond_to?, <<~PATTERN
-          (if (send nil? :respond_to? _ ) ... )
+            (if (send nil? :respond_to? _ ) ... )
           PATTERN
         end
       end

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

@@ -39,22 +39,22 @@ module RuboCop
           def on_if(node)
             if_respond_to_provides?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, node.children[1].source)
+                corrector.replace(node, node.children[1].source)
               end
             end
           end
 
           def_node_matcher :if_respond_to_provides?, <<~PATTERN
-          (if
-            {
-            (send nil? :respond_to?
-              (sym :provides))
+            (if
+              {
+              (send nil? :respond_to?
+                (sym :provides))
 
-            (:defined?
-              (send nil? :provides))
-            }
-            (send nil? :provides
-              (sym _)) ... )
+              (:defined?
+                (send nil? :provides))
+              }
+              (send nil? :provides
+                (sym _)) ... )
           PATTERN
         end
       end

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

@@ -37,13 +37,13 @@ module RuboCop
           def on_if(node)
             if_respond_to_resource_name?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, node.children[1].source)
+                corrector.replace(node, node.children[1].source)
               end
             end
           end
 
           def_node_matcher :if_respond_to_resource_name?, <<~PATTERN
-          (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
+            (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
           PATTERN
         end
       end

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

@@ -37,6 +37,7 @@ module RuboCop
           minimum_target_chef_version '12.11'
 
           MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`."
+          RESTRICT_ON_SEND = [:run_command].freeze
 
           def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
           (send
@@ -49,7 +50,7 @@ module RuboCop
           def on_send(node)
             mixlib_shellout_run_cmd?(node) do |cmd|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "shell_out(#{cmd.loc.expression.source})")
+                corrector.replace(node, "shell_out(#{cmd.source})")
               end
             end
           end

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

@@ -52,7 +52,7 @@ module RuboCop
               if %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu$}.match?(uri.arguments&.first&.str_content)
                 add_offense(uri, message: MSG, severity: :refactor) do |corrector|
                   next unless (replacement_val = %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu}.match(node.source)[2])
-                  corrector.replace(uri.loc.expression, "uri 'ppa:#{replacement_val}'")
+                  corrector.replace(uri, "uri 'ppa:#{replacement_val}'")
                 end
               end
             end

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

@@ -43,7 +43,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^sysctl_param/, 'sysctl'))
+              corrector.replace(node, node.source.gsub(/^sysctl_param/, 'sysctl'))
             end
           end
         end

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

@@ -98,7 +98,7 @@ module RuboCop
           def check_offense(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
               package_array_install?(node) do |vals|
-                corrector.replace(node.loc.expression, "package #{vals.source}")
+                corrector.replace(node, "package #{vals.source}")
               end
             end
           end