cookstyle 6.7.3 → 6.12.6

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

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

@@ -0,0 +1,60 @@
+# 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 Workstation 0.8 and later renamed the ChefDK module used when writing custom cookbook generators from ChefDK to ChefCLI. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
+        #
+        # @example
+        #
+        #   # bad
+        #   ChefDK::CLI
+        #   ChefDK::Generator::TemplateHelper
+        #   module ChefDK
+        #     ...
+        #   end
+        #
+        #   # good
+        #   ChefCLI::CLI
+        #   ChefCLI::Generator::TemplateHelper
+        #   module ChefCLI
+        #     ...
+        #   end
+        #
+        class ChefDKGenerators < Cop
+          MSG = 'When writing cookbook generators use the ChefCLI module instead of the ChefDK module which was removed in Chef Workstation 0.8 and later.'
+
+          def on_const(node)
+            # We want to catch calls like ChefCLI::CLI.whatever or places where classes are defined in the ChefDK module
+            return unless node.const_name == 'ChefDK' && (node.parent&.module_type? || node.parent&.const_type?)
+
+            add_offense(node, location: :expression, message: MSG, severity: :warning)
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.source.gsub('ChefDK', 'ChefCLI'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/cheffile.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 Cheffile < Cop
           include RangeHelp
 
-          MSG = 'The Libarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.'.freeze
+          MSG = 'The Libarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.'
 
           def investigate(processed_source)
             return if processed_source.blank?

data/lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.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
         #   at_exit { ChefSpec::Coverage.report! }
         #
         class ChefSpecCoverageReport < Cop
-          MSG = "Don't use the deprecated ChefSpec coverage report functionality in your specs.".freeze
+          MSG = "Don't use the deprecated ChefSpec coverage report functionality in your specs."
 
           def_node_matcher :coverage_reporter?, <<-PATTERN
           (block (send nil? :at_exit ) (args) (send (const (const nil? :ChefSpec) :Coverage) :report!))

data/lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.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
         #   end
         #
         class ChefSpecLegacyRunner < Cop
-          MSG = 'Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner.'.freeze
+          MSG = 'Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner.'
 
           def_node_matcher :chefspec_runner?, <<-PATTERN
           (const (const nil? :ChefSpec) :Runner)

data/lib/rubocop/cop/chef/deprecation/chocolatey_package_uninstall_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 ChocolateyPackageUninstallAction < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+'.freeze
+          MSG = 'Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+'
 
           def on_block(node)
             match_property_in_resource?(:chocolatey_package, 'action', node) do |choco_action|

data/lib/rubocop/cop/chef/deprecation/depends_compat_resource.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
 
           minimum_target_chef_version '12.19'
 
-          MSG = "Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+".freeze
+          MSG = "Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+"
 
           def_node_matcher :depends_compat_resource?, <<-PATTERN
             (send nil? :depends (str {"compat_resource"}))

data/lib/rubocop/cop/chef/deprecation/depends_partial_search.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
 
           minimum_target_chef_version '13.0'
 
-          MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13".freeze
+          MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13"
 
           def_node_matcher :depends_partial_search?, <<-PATTERN
             (send nil? :depends (str "partial_search"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -27,7 +28,7 @@ module RuboCop
         #   depends 'poise-service'
         #
         class CookbookDependsOnPoise < Cop
-          MSG = 'Cookbooks should not depend on the deprecated Poise framework'.freeze
+          MSG = 'Cookbooks should not depend on the deprecated Poise framework'
 
           def_node_matcher :depends_method?, <<-PATTERN
             (send nil? :depends $str)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -28,7 +29,7 @@ module RuboCop
         class DeprecatedChefSpecPlatform < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = "Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3".freeze
+          MSG = "Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3"
 
           Gem::Dependency.new('', ['~> 1.4.5', '>= 1.4.6']).match?('', '1.4.6')
 

data/lib/rubocop/cop/chef/deprecation/deprecated_mixins.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 UsesDeprecatedMixins < Cop
           include RangeHelp
 
-          MSG = "Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later.".freeze
+          MSG = "Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later."
 
           def_node_matcher :deprecated_mixin?, <<-PATTERN
             (send nil? :include (const (const (const nil? :Chef) :Mixin) { :Language :LanguageIncludeAttribute :RecipeDefinitionDSLCore :LanguageIncludeRecipe }))

data/lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.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
         #   provider = resource.provider_for_action(:create)
         #
         class DeprecatedPlatformMethods < Cop
-          MSG = 'Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'.freeze
+          MSG = 'Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
 
           def_node_matcher :platform_method?, <<-PATTERN
             (send (const (const nil? :Chef) :Platform) {:provider_for_resource :find_provider :find_provider_for_node} ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -53,7 +54,7 @@ module RuboCop
                                             shell_out_with_systems_locale!
                                           ).freeze
 
-          MSG = 'Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.'.freeze
+          MSG = 'Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :warning) if DEPRECATED_SHELLOUT_METHODS.include?(node.method_name)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -28,7 +29,7 @@ module RuboCop
         #   end
         #
         class DeprecatedWindowsVersionCheck < Cop
-          MSG = "Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false.".freeze
+          MSG = "Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false."
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :older_than_win_2012_or_8?