cookstyle 6.18.8 → 6.21.1

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

@@ -50,8 +50,8 @@ module RuboCop
             match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
               ruby_action.arguments.each do |action|
                 next unless action.source == ':create'
-                add_offense(action.loc.expression, message: MSG, severity: :warning) do |corrector|
-                  corrector.replace(action.loc.expression, ':run')
+                add_offense(action, message: MSG, severity: :warning) do |corrector|
+                  corrector.replace(action, ':run')
                 end
               end
             end

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

@@ -50,7 +50,7 @@ module RuboCop
           def on_send(node)
             search_method?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, corrected_string(node))
+                corrector.replace(node, corrected_string(node))
               end if positional_arguments?(node)
             end
           end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@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 ChefDeprecations
+        # Chef Infra Client 16.5 introduced performance enhancements to Ruby library loading. Due to the underlying implementation of Ruby's `.to_yaml` method, it does not automatically load the `yaml` library and `YAML.dump()` should be used instead to properly load the `yaml` library.
+        #
+        # @example
+        #
+        #   # bad
+        #   {"foo" => "bar"}.to_yaml
+        #
+        #   # good
+        #   YAML.dump({"foo" => "bar"})
+        #
+        class UseYamlDump < Base
+          extend AutoCorrector
+
+          MSG = "Chef Infra Client 16.5 introduced performance enhancements to Ruby library loading. Due to the underlying implementation of Ruby's `.to_yaml` method, it does not automatically load the `yaml` library and `YAML.dump()` should be used instead to properly load the `yaml` library."
+          RESTRICT_ON_SEND = [:to_yaml].freeze
+
+          def on_send(node)
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
+              corrector.replace(node, "YAML.dump(#{node.receiver.source})")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -60,7 +60,7 @@ module RuboCop
                   new_text << "#{key_value} #{v.source}"
                 end
 
-                corrector.replace(property.loc.expression, new_text.join("\n  "))
+                corrector.replace(property, new_text.join("\n  "))
               end
             end
           end

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

@@ -49,7 +49,7 @@ module RuboCop
               return unless offense.arguments.count == 1 # we can only analyze simple string args
               return unless offense.arguments.first.str_type? # anything else is fine
 
-              add_offense(offense.loc.expression, message: MSG, severity: :warning) do |corrector|
+              add_offense(offense, message: MSG, severity: :warning) do |corrector|
                 corrector.replace(offense.arguments.first.source_range, ":#{offense.arguments.first.value}")
               end
             end

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

@@ -67,11 +67,11 @@ module RuboCop
             if ast_obj.respond_to?(:value) && ast_obj.value == :change
               add_offense(ast_obj, message: MSG, severity: :warning) do |corrector|
                 if ast_obj.parent.send_type? # :change was the only action
-                  corrector.replace(ast_obj.loc.expression, ':create')
+                  corrector.replace(ast_obj, ':create')
                 # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
                 elsif ast_obj.parent.child_nodes.count == 2 &&
                       ast_obj.parent.child_nodes.map(&:value).sort == [:change, :create]
-                  corrector.replace(ast_obj.parent.loc.expression, ':create')
+                  corrector.replace(ast_obj.parent, ':create')
                 end
               end
             end

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

@@ -42,6 +42,7 @@ module RuboCop
           minimum_target_chef_version '14.0'
 
           MSG = "Use node['platform_version'] and node['kernel'] data introduced in Chef Infra Client 14 instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook."
+          RESTRICT_ON_SEND = [:nt_version, :server_version?, :core_version?, :workstation_version?].freeze
 
           def_node_matcher :windows_helper?, <<-PATTERN
             (send ( const ( const {nil? cbase} :Windows ) :VersionHelper ) $_ )
@@ -52,13 +53,13 @@ module RuboCop
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 case method
                 when :nt_version
-                  corrector.replace(node.loc.expression, 'node[\'platform_version\'].to_f')
+                  corrector.replace(node, 'node[\'platform_version\'].to_f')
                 when :server_version?
-                  corrector.replace(node.loc.expression, 'node[\'kernel\'][\'product_type\'] == \'Server\'')
+                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Server\'')
                 when :core_version?
-                  corrector.replace(node.loc.expression, 'node[\'kernel\'][\'server_core\']')
+                  corrector.replace(node, 'node[\'kernel\'][\'server_core\']')
                 when :workstation_version?
-                  corrector.replace(node.loc.expression, 'node[\'kernel\'][\'product_type\'] == \'Workstation\'')
+                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Workstation\'')
                 end
               end
             end

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

@@ -40,7 +40,7 @@ module RuboCop
             xml_ruby_recipe?(node) do
               node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.remove(node.loc.expression)
+                corrector.remove(node)
               end
             end
           end

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

@@ -0,0 +1,89 @@
+# 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
+        #   require 'chef-vault'
+        #
+        #   # bad
+        #   ChefVault::Item
+        #
+        #   # bad
+        #   include_recipe 'chef-vault'
+        #
+        #   # bad
+        #   chef_gem 'chef-vault'
+        #
+        #   # bad
+        #   chef_vault_item_for_environment(arg, arg1)
+        #
+        #   # bad
+        #   chef_vault_item(arg, arg1)
+        #
+
+        class ChefVaultUsed < Base
+          MSG = 'Chef Vault usage is not supported in the Effortless pattern'
+          RESTRICT_ON_SEND = [:chef_vault_item,
+                              :chef_vault_item_for_environment,
+                              :include_recipe,
+                              :require,
+                              :chef_gem].freeze
+
+          def_node_matcher :require?, <<-PATTERN
+            (send nil? { :require :include_recipe :chef_gem }
+              (str "chef-vault"))
+          PATTERN
+
+          def_node_matcher :vault_const?, <<-PATTERN
+            (const
+              (const nil? :ChefVault)
+              :Item)
+          PATTERN
+
+          def_node_matcher :chef_vault_item_for_environment?, <<-PATTERN
+            (send nil? :chef_vault_item_for_environment _ _)
+          PATTERN
+
+          def_node_matcher :chef_vault_item?, <<-PATTERN
+            (send nil? :chef_vault_item _ _)
+          PATTERN
+
+          def on_send(node)
+            return unless require?(node) ||
+                          chef_vault_item_for_environment?(node) ||
+                          chef_vault_item?(node)
+            add_offense(node.loc.expression, message: MSG, severity: :refactor)
+          end
+
+          def on_const(node)
+            vault_const?(node) do
+              add_offense(node.loc.expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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