cookstyle 6.8.0 → 6.13.3

data/lib/rubocop/cop/chef/deprecation/powershell_cookbook_helpers.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
         #   powershell_version == 4.0
         #
         class PowershellCookbookHelpers < Cop
-          MSG = "Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 15.8+ instead of the deprecated PowerShell cookbook helpers.".freeze
+          MSG = "Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 15.8+ instead of the deprecated PowerShell cookbook helpers."
 
           def_node_matcher :ps_cb_helper?, <<-PATTERN
           (send

data/lib/rubocop/cop/chef/deprecation/require_recipe.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
         #   include_recipe 'foo'
         #
         class RequireRecipe < Cop
-          MSG = 'Use include_recipe instead of the require_recipe method'.freeze
+          MSG = 'Use include_recipe instead of the require_recipe method'
 
           def_node_matcher :require_recipe?, <<-PATTERN
             (send nil? :require_recipe $str)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -31,7 +32,7 @@ module RuboCop
         #   provides :SOME_PROVIDER_NAME
         #
         class ResourceOverridesProvidesMethod < Cop
-          MSG = "Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later.".freeze
+          MSG = "Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later."
 
           def_node_search :provides, '(send nil? :provides ...)'
 

data/lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.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
         #   my_resource = MyResource.resource_name
         #
         class ResourceUsesDslNameMethod < Cop
-          MSG = 'Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.'.freeze
+          MSG = 'Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :dsl_name

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright (c) Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
 
-          MSG = 'Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.'.freeze
+          MSG = 'Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.'
 
           def_node_matcher :resource_name?, '(send nil? :resource_name (sym $_ ))'
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -26,7 +27,7 @@ module RuboCop
         #   provider_base ::Chef::Provider::SomethingSomething
         #
         class ResourceUsesProviderBaseMethod < Cop
-          MSG = "Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later.".freeze
+          MSG = "Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later."
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :provider_base

data/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.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
         #     end
         #
         class ResourceUsesUpdatedMethod < Cop
-          MSG = "Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later.".freeze
+          MSG = "Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later."
 
           def on_lvasgn(node)
             add_offense(node, location: :expression, message: MSG, severity: :warning) if node.node_parts.first == :updated

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         class Ruby27KeywordArgumentWarnings < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'.freeze
+          MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'
 
           def_node_matcher :positional_shellout?, <<-PATTERN
             (send nil? {:shell_out :shell_out!} ... $(hash ... ))
@@ -48,7 +49,7 @@ module RuboCop
 
           def autocorrect(node)
             lambda do |corrector|
-              # @todo when we drop ruby 2.4 support we can convert to to just delete_prefix delete_suffix
+              # @todo when we drop ruby 2.4 support we can convert this to just delete_prefix delete_suffix
               corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^{/, '').gsub(/}$/, ''))
             end
           end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -42,7 +43,7 @@ module RuboCop
         class RubyBlockCreateAction < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'.freeze
+          MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'
 
           def on_block(node)
             match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         #   shell_out!('/bin/foo')
         #
         class UsesRunCommandHelper < Cop
-          MSG = "Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13.".freeze
+          MSG = "Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13."
 
           def_node_matcher :calls_run_command?, '(send nil? {:run_command :run_command_with_systems_locale} ...)'
           def_node_matcher :require_mixin_command?, '(send nil? :require (str "chef/mixin/command"))'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -35,7 +36,7 @@ module RuboCop
         #  search(:node, '*:*', start: 0)
         #
         class SearchUsesPositionalParameters < Cop
-          MSG = "Don't use deprecated positional parameters in cookbook search queries.".freeze
+          MSG = "Don't use deprecated positional parameters in cookbook search queries."
 
           NAMED_PARAM_LOOKUP_TABLE = [nil, nil, 'start', 'rows', 'filter_result'].freeze
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -31,7 +32,7 @@ module RuboCop
         class UseInlineResourcesDefined < Cop
           include RangeHelp
 
-          MSG = 'use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified.'.freeze
+          MSG = 'use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified.'
 
           def on_send(node)
             if node.method_name == :use_inline_resources

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -43,7 +44,7 @@ module RuboCop
         class UserDeprecatedSupportsProperty < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = "The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties.".freeze
+          MSG = "The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties."
 
           def on_block(node)
             match_property_in_resource?(:user, 'supports', node) do |property|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -38,7 +39,7 @@ module RuboCop
 
           minimum_target_chef_version '12.5'
 
-          MSG = "Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13.".freeze
+          MSG = "Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13."
 
           def on_block(node)
             match_property_in_resource?(nil, 'verify', node) do |verify|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -43,7 +44,7 @@ module RuboCop
         class WindowsFeatureServermanagercmd < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.'.freeze
+          MSG = 'The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.'
 
           def on_block(node)
             match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -45,7 +46,7 @@ module RuboCop
 
           minimum_target_chef_version '13.0'
 
-          MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.'.freeze
+          MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.'
 
           def on_block(node)
             match_property_in_resource?(:windows_task, 'action', node) do |action_node|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -39,7 +40,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.".freeze
+          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."
 
           def_node_matcher :windows_helper?, <<-PATTERN
             (send ( const ( const {nil? cbase} :Windows ) :VersionHelper ) $_ )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -26,7 +27,7 @@ module RuboCop
         #   include_recipe 'xml::ruby'
         #
         class IncludingXMLRubyRecipe < Cop
-          MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'.freeze
+          MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'
 
           def_node_matcher :xml_ruby_recipe?, <<-PATTERN
             (send nil? :include_recipe (str "xml::ruby"))

data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.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 IncludingYumDNFCompatRecipe < Cop
           include RangeHelp
 
-          MSG = 'Do not include the deprecated yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF packages.'.freeze
+          MSG = 'Do not include the deprecated yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF packages.'
 
           def_node_matcher :yum_dnf_compat_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str "yum::dnf_yum_compat"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -24,7 +25,7 @@ module RuboCop
         class Berksfile < Cop
           include RangeHelp
 
-          MSG = 'Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.'.freeze
+          MSG = 'Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.'
 
           def investigate(processed_source)
             return if processed_source.blank?

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -26,7 +27,7 @@ module RuboCop
         #   data_bag_item('admins', login)
         #   data_bag(data_bag_name)
         class CookbookUsesDatabags < Cop
-          MSG = 'Cookbook uses data bags, which cannot be used in the Effortless Infra pattern'.freeze
+          MSG = 'Cookbook uses data bags, which cannot be used in the Effortless Infra pattern'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if %i(data_bag data_bag_item).include?(node.method_name)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -27,7 +28,7 @@ module RuboCop
         #   node.chef_environment == "production"
         #
         class CookbookUsesEnvironmments < Cop
-          MSG = 'Cookbook uses environments, which cannot be used in Policyfiles or Effortless Infra'.freeze
+          MSG = 'Cookbook uses environments, which cannot be used in Policyfiles or Effortless Infra'
 
           def on_send(node)
             if %i(environment chef_environment).include?(node.method_name) && node.receiver && node.receiver.send_type? && node.receiver.method_name == :node

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -26,7 +27,7 @@ module RuboCop
         #   node.policy_group == "foo"
         #
         class CookbookUsesPolicygroups < Cop
-          MSG = 'Cookbook uses Policy Groups, which cannot be used with Effortless Infra'.freeze
+          MSG = 'Cookbook uses Policy Groups, which cannot be used with Effortless Infra'
 
           def on_send(node)
             if node.method_name == :policy_group && node.receiver && node.receiver.send_type? && node.receiver.method_name == :node

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -27,7 +28,7 @@ module RuboCop
         #   node.roles.include?('webserver')
         #
         class CookbookUsesRoles < Cop
-          MSG = 'Cookbook uses roles, which cannot be used in Policyfiles or Effortless Infra'.freeze
+          MSG = 'Cookbook uses roles, which cannot be used in Policyfiles or Effortless Infra'
 
           def on_send(node)
             if %i(role? roles).include?(node.method_name) && node.receiver && node.receiver.send_type? && node.receiver.method_name == :node

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -27,7 +28,7 @@ module RuboCop
         #   search(:node, 'role:bar')
         #
         class SearchForEnvironmentsOrRoles < Cop
-          MSG = 'Cookbook uses search with a node query that looks for a role or environment'.freeze
+          MSG = 'Cookbook uses search with a node query that looks for a role or environment'
 
           def on_send(node)
             if node.method_name == :search && node.arguments[1]&.value&.match?(/chef_environment|role/)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -26,7 +27,7 @@ module RuboCop
         #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
         #
         class CookbookUsesSearch < Cop
-          MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'.freeze
+          MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :search

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

@@ -0,0 +1,57 @@
+# 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 ChefModernize
+        # Use the custom resource language's `action :my_action` blocks instead of creating actions with methods.
+        #
+        # @example
+        #
+        #   # bad
+        #   def action_create
+        #    # :create action code here
+        #   end
+        #
+        #   # good
+        #   action :create do
+        #    # :create action code here
+        #   end
+        #
+        class ActionMethodInResource < Base
+          extend AutoCorrector
+
+          MSG = "Use the custom resource language's `action :my_action` blocks instead of creating actions with methods."
+
+          def_node_search :includes_poise?, '(send nil? :include (const nil? :Poise))'
+
+          def on_def(node)
+            return unless node.method_name.to_s.start_with?('action_') # when we stop support for Ruby < 2.7 the .to_s can go away here
+            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|
+              # @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"))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -40,7 +41,7 @@ module RuboCop
         class AllowedActionsFromInitialize < Cop
           include RangeHelp
 
-          MSG = 'The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.'.freeze
+          MSG = 'The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.'
 
           def on_def(node)
             return unless node.method_name == :initialize