cookstyle 6.20.1 → 7.2.1

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13.
         # Use Mixlib::ShellOut instead, which behaves identically or convert to the shell_out
         # helper provided in chef-utils.

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper
         #
         # @example

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

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

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

@@ -21,7 +21,7 @@ module RuboCop
     module Chef
       # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
       #
-      module ChefDeprecations
+      module Deprecations
         class Cheffile < Base
           include RangeHelp
 

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't use the deprecated ChefSpec Coverage report functionality in your specs. This feature has been removed as coverage reports encourage cookbook authors to write ineffective specs. Focus on testing your logic instead of achieving 100% code coverage.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner. These new runners were introduced in ChefSpec 4.1 (Oct 2014).
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't depend on the deprecated compat_resource cookbook made obsolete by Chef Infra Client 12.19+
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't depend on the partial_search cookbook made obsolete by Chef Infra Client 13
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Cookbooks should not depend on the deprecated Poise framework cookbooks. They should instead be refactored to use standard Chef Infra custom resources.
         #
         # @example

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

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

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The large number of shell_out helper methods in Chef Infra Client has been reduced to just shell_out and shell_out! methods. The legacy methods were removed in Chef Infra Client and cookbooks using these legacy helpers will need to be updated.
         #
         # @example

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

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

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't use the deprecated easy_install resource removed in Chef Infra Client 13
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The beta Audit Mode for Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Make sure ignore_failure is used instead of epic_fail
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Don't use the deprecated erl_call resource
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # In Chef Infra Client 13 and later you must set path env vars in execute resources using the `environment` property not the legacy `path` property.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
         #
         # @example

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

@@ -0,0 +1,43 @@
+# 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 Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks.
+        #
+        # @example
+        #
+        #   # bad
+        #   gem 'foodcritic'
+        #   require 'foodcritic'
+        #
+        class FoodcriticTesting < Base
+          MSG = 'The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks.'
+          RESTRICT_ON_SEND = [:require, :gem].freeze
+
+          def on_send(node)
+            return unless node.arguments.first == s(:str, 'foodcritic')
+
+            add_offense(node, message: MSG, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Resources written in the class based HWRP style should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them
         # in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which
         # should be used instead as it doesn't require forking the ohai cookbook.

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.