cookstyle 7.31.7 → 7.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0041f7691cd8703343c065df3ff9845f59018276336bf8fe0bf199a802533fc8
-  data.tar.gz: 782fa56469ebdc5895320bcf4c815a1bb9964aced211c52b007b3945cb331adc
+  metadata.gz: 35037ddf834c7c995f3ae81181f923b8fc2c70b10686814beb82462558014fd8
+  data.tar.gz: 8f56143d1d34824560f24f41885a279299c5bef28913795b17531fea355e131f
 SHA512:
-  metadata.gz: 6a67d211251cf6443c9cdd6fbc5cd696f13d3fdd178fa3ea8bef7bd6c3495869b935f0dd01083cf5ca8a9a705ad32370ea8e640c390dbeda9629ee260fe06234
-  data.tar.gz: e7fac0be14547d1fb7ac86a61d8a23923d47d2958bc2f5df466eb487d4d67abd0f28b6f0d76afa4c803fc3f952981fa1c3fd3e03d5763d1eb63217665be3f64b
+  metadata.gz: d0fdf8339747df02c7c64f54f1e3a2366de8220f7e2fb5a8e96fed09c504e1e3dc54463c1fe2fa1dd408228c1dd5bc127b4441458db732d3d8a6587733521b0a
+  data.tar.gz: c56b19393c8d92fe54a5c80a8ab23eea7ada4fbac3fe301a870ece705900cfcd273f9c0fc0507dc3def3b7b0462572f888e849d3857bea3d452ad3fae9322170

data/config/cookstyle.yml

@@ -2,11 +2,33 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.5
   TargetChefVersion: ~
+  inherit_mode:
+    merge:
+     - Include
+  Include:
+    - '**/.delivery/project.toml'      # required by Chef/Deprecations/Delivery
+    - '**/.delivery/config.json'       # required by Chef/Deprecations/Delivery
+    - '**/.foodcritic'
   Exclude:
     - '**/files/**/*'
     - '**/vendor/**/*'
     - Guardfile
 
+Layout:
+  Exclude:
+    - '**/.delivery/project.toml'
+    - '**/.delivery/config.json'
+
+Lint:
+  Exclude:
+    - '**/.delivery/project.toml'
+    - '**/.delivery/config.json'
+
+Style:
+  Exclude:
+    - '**/.delivery/project.toml'
+    - '**/.delivery/config.json'
+
 ###############################
 # Chef/Style: Making cookbooks look better
 ###############################
@@ -14,6 +36,9 @@ AllCops:
 Chef/Style:
   Enabled: true
   StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
+  Exclude:
+    - '**/.delivery/project.toml'
+    - '**/.delivery/config.json'
 
 Chef/Style/AttributeKeys:
   Description: Check which style of keys are used to access node attributes.
@@ -1216,6 +1241,14 @@ Chef/Deprecations/FoodcriticTesting:
     - '**/Rakefile'
     - '**/Gemfile'
 
+Chef/Deprecations/FoodcriticFile:
+  Description: The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks
+  StyleGuide: 'chef_deprecations_foodcriticfile'
+  Enabled: true
+  VersionAdded: '7.32.0'
+  Include:
+    - '**/.foodcritic'
+
 Chef/Deprecations/DeprecatedYumRepositoryActions:
   Description: With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several actions in the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
   StyleGuide: 'chef_deprecations_deprecatedyumrepositoryactions'
@@ -1265,12 +1298,13 @@ Chef/Deprecations/PolicyfileCommunitySource:
     - '**/Policyfile.rb'
 
 Chef/Deprecations/Delivery:
-  Description: Do not include a `.delivery` directory for the `delivery` command in your cookbooks. Chef Delivery (Workflow) went EOL Dec 31st 2021 and the delivery command was removed from Chef Workstation Feb 2022.
+  Description: Do not include Chef Delivery (Workflow) configuration in your cookbooks. Chef Delivery (Workflow) went EOL Dec 31st 2021 and the delivery command was removed from Chef Workstation Feb 2022.
   StyleGuide: 'chef_deprecations_delivery'
   Enabled: true
   VersionAdded: '7.31.0'
   Include:
-    - '**/metadata.rb'
+    - '**/.delivery/project.toml'
+    - '**/.delivery/config.json'
 
 Chef/Deprecations/DeprecatedSudoActions:
   Description: The `sudo` resource in the sudo cookbook 5.0 (2018) or Chef Infra Client 14 and later have replaced the existing `:install` and `:remove` actions with `:create` and `:delete` actions to better match other resources in Chef Infra.
@@ -1954,7 +1988,7 @@ Chef/Modernize/UseChefLanguageCloudHelpers:
     - '**/resources/*.rb'
     - '**/providers/*.rb'
     - '**/recipes/*.rb'
-    
+
 Chef/Modernize/ClassEvalActionClass:
   Description: In Chef Infra Client 12.9 and later it is no longer necessary to call the class_eval method on the action class block.
   StyleGuide: 'chef_modernize_classevalactionclass'
@@ -2332,7 +2366,7 @@ Chef/Security/SshPrivateKey:
     - '**/recipes/*.rb'
     - '**/attributes/*.rb'
     - '**/definitions/*.rb'
-    
+
 #### The base rubocop 0.37 enabled.yml file we started with ####
 
 Layout/AccessModifierIndentation:
@@ -3094,4 +3128,4 @@ Style/FileRead:
 
 # reduce file write complexity
 Style/FileWrite:
-  Enabled: true
+  Enabled: true

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.31.7" # rubocop: disable Style/StringLiterals
+  VERSION = "7.32.1" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.25.1'
 end

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

@@ -25,12 +25,12 @@ module RuboCop
         #
         #   #### incorrect
         #   platform?('darwin')
-        #   platform?('rhel)
+        #   platform?('rhel')
         #   platform?('sles')
         #
         #   #### correct
         #   platform?('mac_os_x')
-        #   platform?('redhat)
+        #   platform?('redhat')
         #   platform?('suse')
         #
         class InvalidPlatformHelper < Base

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

@@ -27,14 +27,14 @@ module RuboCop
         #   ChefDK::CLI
         #   ChefDK::Generator::TemplateHelper
         #   module ChefDK
-        #     ...
+        #     # some additional code
         #   end
         #
         #   #### correct
         #   ChefCLI::CLI
         #   ChefCLI::Generator::TemplateHelper
         #   module ChefCLI
-        #     ...
+        #     # some additional code
         #   end
         #
         class ChefDKGenerators < Base

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

@@ -27,16 +27,20 @@ module RuboCop
         class Delivery < Base
           include RangeHelp
 
-          MSG = 'Do not include a `.delivery` directory for the `delivery` command in your cookbooks. Chef Delivery (Workflow) went EOL Dec 31st 2021 and the delivery command was removed from Chef Workstation Feb 2022.'
+          MSG = 'Do not include Chef Delivery (Workflow) configuration in your cookbooks. It went EOL Dec 31st 2021 and the delivery command was removed from Chef Workstation Feb 2022.'
 
-          def on_new_investigation
-            return unless File.exist?(File.join(File.dirname(processed_source.path) + '/.delivery'))
+          def on_other_file
+            return unless processed_source.path.end_with?('/.delivery/project.toml', '/.delivery/config.json')
 
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             range = source_range(processed_source.buffer, 1, 0)
 
             add_offense(range, severity: :warning)
           end
+
+          # An empty / simple TOML file can also be syntatically valid Ruby, so
+          # RuboCop may start an investigation instead of calling on_other_file.
+          alias_method :on_new_investigation, :on_other_file
         end
       end
     end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2022, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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. Do not include the `.foodcritic` config file used by Foodcritic in your cookbooks.
+        #
+        class FoodcriticFile < Base
+          include RangeHelp
+
+          MSG = 'Do not include the `.foodcritic` config file for the deprecated Foodcritic cookbook linter.'
+
+          def on_new_investigation
+            return unless processed_source.path.end_with?('.foodcritic')
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(range, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module RuboCop
         #
         #   #### correct
         #   action :foo do
-        #     converge_by('resource did something) do
+        #     converge_by('resource did something') do
         #       # code that causes the resource to converge
         #     end
         #

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

@@ -28,7 +28,8 @@ module RuboCop
         #     class MyCookbookService < Chef::Resource
         #       use_automatic_resource_name
         #       provides :mycookbook_service
-        #       ...
+        #
+        #       # some additional code
         #     end
         #   end
         #

data/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb

@@ -33,6 +33,8 @@ module RuboCop
         #
         #   # check to see if we're on RHEL 7 on a RHEL 7.6 node where node['platform_version] is 7.6.1810
         #   if node['platform_version'].to_i == 7
+        #     # some code
+        #   end
         #
         class SimplifyPlatformMajorVersionCheck < Base
           extend AutoCorrector

data/lib/rubocop/cop/inspec/deprecation/attribute_default.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module InSpec
       module Deprecations
-        # The InSpec inputs `default` option has been replaced with the `value` option.
+        # The Chef InSpec inputs `default` option has been replaced with the `value` option.
         #
         # @example
         #

data/lib/rubocop/cop/inspec/deprecation/attribute_helper.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module InSpec
       module Deprecations
-        # InSpec attributes have been renamed to inputs. Use the `input` method not the deprecation `attribute` method to access these values.
+        # Chef InSpec attributes have been renamed to inputs. Use the `input` method not the deprecation `attribute` method to access these values.
         #
         # @example
         #

data/lib/rubocop/monkey_patches/allow_invalid_ruby.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'rubocop/rspec/expect_offense'
+# rubocop:disable Lint/DuplicateMethods
+
+module RuboCop
+  module RSpec
+    module ExpectOffense
+      # Yields to a block with `parse_processed_source` patched to not raise an
+      # exception.
+      #
+      # RSpec's `expect_offense` helper calls a method called
+      # `parse_processed_source` that parses source code and raises an exception
+      # if it is not valid Ruby. Raising an exception prevents RuboCop from
+      # calling the cop's `on_other_file` method for checking non-Ruby files.
+      def allow_invalid_ruby(&block)
+        alias :parse_processed_source :_parse_invalid_source
+        yield block
+        alias :parse_processed_source :_orig_parse_processed_source
+      end
+
+      alias :_orig_parse_processed_source :parse_processed_source
+
+      def _parse_invalid_source(source, file = nil)
+        parse_source(source, file)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.31.7
+  version: 7.32.1
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -124,6 +124,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/erl_call.rb
 - lib/rubocop/cop/chef/deprecation/execute_path_property.rb
 - lib/rubocop/cop/chef/deprecation/execute_relative_creates_without_cwd.rb
+- lib/rubocop/cop/chef/deprecation/foodcritic_file.rb
 - lib/rubocop/cop/chef/deprecation/foodcritic_testing.rb
 - lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb
 - lib/rubocop/cop/chef/deprecation/hwrp_without_unified_mode_true.rb
@@ -303,6 +304,7 @@ files:
 - lib/rubocop/cop/inspec/deprecation/attribute_default.rb
 - lib/rubocop/cop/inspec/deprecation/attribute_helper.rb
 - lib/rubocop/cop/target_chef_version.rb
+- lib/rubocop/monkey_patches/allow_invalid_ruby.rb
 - lib/rubocop/monkey_patches/base.rb
 - lib/rubocop/monkey_patches/config.rb
 - lib/rubocop/monkey_patches/directive_comment.rb