cookstyle 6.11.4 → 6.12.6

data/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         class InvalidPlatformHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Pass valid platforms to the platform? helper.'.freeze
+          MSG = 'Pass valid platforms to the platform? helper.'
 
           def_node_matcher :platform_helper?, <<-PATTERN
             (send nil? :platform? $str*)

data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         class InvalidPlatformMetadata < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'metadata.rb "supports" platform is invalid'.freeze
+          MSG = 'metadata.rb "supports" platform is invalid'
 
           def_node_matcher :supports?, '(send nil? :supports $str ...)'
 

data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
           include RangeHelp
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Use valid platform values in case statements.'.freeze
+          MSG = 'Use valid platform values in case statements.'
 
           def_node_matcher :node_platform?, <<-PATTERN
             (send (send nil? :node) :[] (str "platform") )

data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -37,7 +38,7 @@ module RuboCop
         class InvalidPlatformValueForPlatformFamilyHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Pass valid platform families to the value_for_platform_family helper.'.freeze
+          MSG = 'Pass valid platform families to the value_for_platform_family helper.'
 
           def_node_matcher :value_for_platform_family?, <<-PATTERN
           (send nil? :value_for_platform_family

data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -36,7 +37,7 @@ module RuboCop
         class InvalidPlatformValueForPlatformHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Pass valid platforms to the value_for_platform helper.'.freeze
+          MSG = 'Pass valid platforms to the value_for_platform helper.'
 
           def_node_matcher :value_for_platform?, <<-PATTERN
           (send nil? :value_for_platform

data/lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         #   version '1.2.3'
         #
         class InvalidVersionMetadata < Cop
-          MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'.freeze
+          MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'
 
           def_node_matcher :version?, '(send nil? :version $str ...)'
 

data/lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
         class LazyEvalNodeAttributeDefaults < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'When setting a node attribute as the default value for a custom resource property, wrap the node attribute in `lazy {}` so that its value is available when the resource executes.'.freeze
+          MSG = 'When setting a node attribute as the default value for a custom resource property, wrap the node attribute in `lazy {}` so that its value is available when the resource executes.'
 
           def_node_matcher :non_lazy_node_attribute_default?, <<-PATTERN
             (send nil? :property (sym _) ... (hash <(pair (sym :default) $(send (send _ :node) :[] _) ) ...>))

data/lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)

data/lib/rubocop/cop/chef/correctness/metadata_missing_name.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         class MetadataMissingName < Cop
           include RangeHelp
 
-          MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'.freeze
+          MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'
 
           def investigate(processed_source)
             return if processed_source.blank?

data/lib/rubocop/cop/chef/correctness/node_normal.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 #
@@ -37,7 +38,7 @@ module RuboCop
         #   node.force_override['foo'] = true
         #
         class NodeNormal < Cop
-          MSG = 'Do not use node.normal. Replace with default/override/force_default/force_override attribute levels.'.freeze
+          MSG = 'Do not use node.normal. Replace with default/override/force_default/force_override attribute levels.'
 
           def_node_matcher :node_normal?, <<-PATTERN
             (send (send _ :node) :normal)

data/lib/rubocop/cop/chef/correctness/node_normal_unless.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 #
@@ -37,7 +38,7 @@ module RuboCop
         #   node.force_override_unless['foo'] = true
         #
         class NodeNormalUnless < Cop
-          MSG = 'Do not use node.normal_unless. Replace with default/override/force_default/force_override attribute levels.'.freeze
+          MSG = 'Do not use node.normal_unless. Replace with default/override/force_default/force_override attribute levels.'
 
           def_node_matcher :node_normal_unless?, <<-PATTERN
             (send (send _ :node) :normal_unless)

data/lib/rubocop/cop/chef/correctness/node_save.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -28,7 +29,7 @@ module RuboCop
         #   node.save
         #
         class CookbookUsesNodeSave < Cop
-          MSG = "Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server.".freeze
+          MSG = "Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
 
           def_node_matcher :node_save?, <<-PATTERN
             (send (send nil? :node) :save)

data/lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -44,7 +45,7 @@ module RuboCop
         class NotifiesActionNotSymbol < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Resource notification and subscription actions should be symbols not strings.'.freeze
+          MSG = 'Resource notification and subscription actions should be symbols not strings.'
 
           def on_block(node)
             match_property_in_resource?(nil, %w(notifies subscribes), node) do |notifies_property|

data/lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
@@ -25,7 +26,7 @@ module RuboCop
         #   basic_auth_password = secure_password
         #
         class OpenSSLPasswordHelpers < Cop
-          MSG = 'The `secure_password` helper from the openssl cookbooks `Opscode::OpenSSL::Password` class should not be used to generate passwords.'.freeze
+          MSG = 'The `secure_password` helper from the openssl cookbooks `Opscode::OpenSSL::Password` class should not be used to generate passwords.'
 
           def_node_matcher :openssl_helper?, <<~PATTERN
             (const

data/lib/rubocop/cop/chef/correctness/powershell_delete_file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -36,7 +37,7 @@ module RuboCop
         class PowershellScriptDeleteFile < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource'.freeze
+          MSG = 'Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource'
 
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|

data/lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -38,7 +39,7 @@ module RuboCop
         class ResourceSetsInternalProperties < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Do not set properties used internally by Chef Infra Client to track the system state.'.freeze
+          MSG = 'Do not set properties used internally by Chef Infra Client to track the system state.'
 
           def on_block(node)
             match_property_in_resource?(:service, 'running', node) do |prop|

data/lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -37,7 +38,7 @@ module RuboCop
         class ResourceSetsNameProperty < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Resource sets the name property in the resource instead of using a name_property.'.freeze
+          MSG = 'Resource sets the name property in the resource instead of using a name_property.'
 
           def on_block(node)
             match_property_in_resource?(nil, 'name', node) do |name_node|

data/lib/rubocop/cop/chef/correctness/resource_with_none_action.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -36,7 +37,7 @@ module RuboCop
         class ResourceWithNoneAction < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Resource uses the nonexistent :none action instead of the :nothing action'.freeze
+          MSG = 'Resource uses the nonexistent :none action instead of the :nothing action'
 
           def on_block(node)
             match_property_in_resource?(nil, 'action', node) do |action_node|

data/lib/rubocop/cop/chef/correctness/scoped_file_exist.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   not_if { ::File.exist?('/etc/foo/bar') }
         #
         class ScopedFileExist < Cop
-          MSG = 'Scope file exist to access the correct File class by using ::File.exist? not File.exist?.'.freeze
+          MSG = 'Scope file exist to access the correct File class by using ::File.exist? not File.exist?.'
 
           def_node_matcher :unscoped_file_exist?, <<-PATTERN
           (block (send nil? {:not_if :only_if}) (args) (send $(const nil? :File) {:exist? :exists?} (...)))

data/lib/rubocop/cop/chef/correctness/service_resource.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016, Chris Henry
 #
@@ -27,7 +28,7 @@ module RuboCop
         #   command "/sbin/service/memcached start"
         #
         class ServiceResource < Cop
-          MSG = 'Use a service resource to start and stop services'.freeze
+          MSG = 'Use a service resource to start and stop services'
 
           def_node_matcher :execute_command?, <<-PATTERN
             (send nil? :command $str)

data/lib/rubocop/cop/chef/correctness/tmp_path.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016, Chris Henry
 #
@@ -30,7 +31,7 @@ module RuboCop
         #
         #
         class TmpPath < Cop
-          MSG = 'Use file_cache_path rather than hard-coding tmp paths'.freeze
+          MSG = 'Use file_cache_path rather than hard-coding tmp paths'
 
           def_node_matcher :remote_file?, <<-PATTERN
             (send nil? :remote_file $str)

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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
+        # The use_automatic_resource_name method was removed in Chef Infra Client 16. The resource name/provides should be set explicitly instead.
+        #
+        # @example
+        #
+        #   # bad
+        #   module MyCookbook
+        #     class MyCookbookService < Chef::Resource
+        #       use_automatic_resource_name
+        #       provides :mycookbook_service
+        #       ...
+        #     end
+        #   end
+        #
+        class UseAutomaticResourceName < Base
+          extend RuboCop::Cop::AutoCorrector
+          include RangeHelp
+
+          MSG = 'The use_automatic_resource_name method was removed in Chef Infra Client 16. The resource name/provides should be set explicitly instead.'
+
+          def on_send(node)
+            return unless node.method_name == :use_automatic_resource_name
+
+            add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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
+        # There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe 'chef_handler'
+        #   include_recipe 'chef_handler::default'
+        #
+        class ChefHandlerRecipe < Cop
+          include RangeHelp
+
+          MSG = 'There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource'
+
+          def_node_matcher :chef_handler_recipe?, <<-PATTERN
+            (send nil? :include_recipe (str {"chef_handler" "chef_handler::default"}))
+          PATTERN
+
+          def on_send(node)
+            chef_handler_recipe?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -36,7 +37,7 @@ module RuboCop
         class ChefHandlerUsesSupports < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.'.freeze
+          MSG = 'Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.'
 
           def on_block(node)
             match_property_in_resource?(:chef_handler, 'supports', node) do |prop_node|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -28,7 +29,7 @@ module RuboCop
         #   Chef::REST::RESTRequest.new(:GET, FOO, nil).call
         #
         class UsesChefRESTHelpers < Cop
-          MSG = "Don't use the helpers in Chef::REST which were removed in Chef Infra Client 13".freeze
+          MSG = "Don't use the helpers in Chef::REST which were removed in Chef Infra Client 13"
 
           def_node_matcher :require_rest?, <<-PATTERN
           (send nil? :require ( str "chef/rest"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -46,7 +47,7 @@ module RuboCop
             unwind: 'delete_resource',
           }.freeze
 
-          MSG = 'Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'.freeze
+          MSG = 'Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
 
           def_node_matcher :rewind_gem_install?, <<-PATTERN
             (send nil? :chef_gem (str "chef-rewind"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         #   platform_family?('windows')
         #
         class ChefWindowsPlatformHelper < Cop
-          MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper.".freeze
+          MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper."
 
           def_node_matcher :chef_platform_windows?, <<-PATTERN
             (send