cookstyle 6.20.2 → 7.3.10

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

@@ -0,0 +1,42 @@
+# 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 Deprecations
+        # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.
+        #
+        # @example
+        #
+        #   # bad
+        #   require 'chefspec/librarian'
+        #
+        class LibrarianChefSpec < Base
+          MSG = 'The Librarian-Chef depsolving project is no longer maintained and ChefSpec should not use Librarian-Chef for cookbook depsolving. Consider using Policyfiles instead.'
+          RESTRICT_ON_SEND = [:require].freeze
+
+          def on_send(node)
+            return unless node.arguments.first == s(:str, 'chefspec/librarian')
+
+            add_offense(node, message: MSG, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # In Chef Infra Client 16 the log resource no longer notifies when logging so notifications should not be triggered from log resources. Use the notify_group resource introduced in Chef Infra Client 15.8 instead to aggregate notifications.
         #
         # @example
@@ -44,7 +44,7 @@ module RuboCop
         #     notifies :restart, 'service[foo]', :delayed
         #   end
         #
-        class LogResourceNotifications < Cop
+        class LogResourceNotifications < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
@@ -54,7 +54,7 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(:log, 'notifies', node) do |prop_node|
-              add_offense(prop_node, location: :expression, message: MSG, severity: :warning)
+              add_offense(prop_node, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. This property was never properly implemented and caused failures under many conditions. Omitting the `domain` property will now set global defaults.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # A resource property (or attribute) can't be marked as a name_property (or name_attribute) and also have a default value. The name property is a special property that is derived from the name of the resource block in and thus always has a value passed to the resource. For example if you define `my_resource 'foo'` in recipe, then the name property of `my_resource` will automatically be set to `foo`. Setting a property to be both a name_property and have a default value will cause Chef Infra Client failures in 13.0 and later releases.
         #
         # @example

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

@@ -17,7 +17,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The node.deep_fetch method has been removed from Chef-Sugar, and must be replaced by the node.read API.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use node attributes to access data provided by Ohai instead of using node methods to access that data.
         #
         # @example

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

@@ -17,7 +17,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The `node.set` method has been removed in Chef Infra Client 13 and usage must be replaced with `node.normal`.
         #
         # This cop will autocorrect code to use node.normal, which is functionally identical to node.set, but we also discourage the use of that method as normal level attributes persist on the node even if the code setting the attribute is later removed.

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

@@ -17,7 +17,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The node.set_unless method has been removed in Chef Infra Client 13 and usage must be replaced with node.normal_unless.
         #
         # This cop will autocorrect code to use node.normal_unless, which is functionally identical to node.set_unless, but we also discourage the use of that method as normal level attributes persist on the node even if the code setting the attribute is later removed.

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

@@ -17,7 +17,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Legacy Chef::PartialSearch class usage should be updated to use the `search` helper instead with the `filter_result` key.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Legacy partial_search usage should be updated to use :filter_result in the search helper instead
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use `node['powershell']['version']` or the new `powershell_version` helper available in Chef Infra Client 15.8+ instead of the deprecated PowerShell cookbook helpers
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Make sure to use include_recipe instead of require_recipe
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Some providers in resources override the provides? method, used to check whether they are a valid provider on the current platform. In Chef Infra Client 13, this will cause an error. Instead use `provides :SOME_PROVIDER_NAME` to register the provider.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't use the dsl_name method in a resource to find the name of the resource. Use the resource_name method instead. dsl_name was removed in Chef Infra Client 13 and will now result in an error.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # 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.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The Resource.provider_base allows the developer to specify within a resource a module to load the resource's provider from. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't call the deprecated updated= method in a resource to set the resource to updated. This method was removed from Chef Infra Client 13 and this will now cause an error. Instead wrap code that updated the state of the node in a converge_by block. Documentation on using the converge_by block can be found at https://docs.chef.io/custom_resources.html.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use the :run action in the ruby_block resource instead of the deprecated :create action
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # 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.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # In the cookbook search helper you need to use named parameters (key/value style) other than the first (type) and second (query string) values.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # use_inline_resources became the default in Chef Infra Client 13+ and no longer needs
         # to be called in resources
         #

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 Deprecations
+        # 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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # In Chef Infra Client 13 the "file" variable for use within the verify property was replaced with the "path" variable.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # 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.
         #

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use node['platform_version'] and node['kernel'] data instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't include the deprecated yum DNF compatibility recipe, which is no longer necessary
         # as Chef Infra Client includes DNF package support
         #

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefEffortless
+      module Effortless
         # Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
         #
         class Berksfile < Base

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefEffortless
+      module Effortless
         # 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

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefEffortless
+      module Effortless
         # Data bags cannot be used with the Effortless Infra pattern
         #
         # @example