cookstyle 5.11.0 → 5.12.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23367383d5c8736b9ab2f8bfbf580f79fb41584840e5f7c8bc00fe473cbb0ef7
-  data.tar.gz: fc2c67a465da5575f311f2eebcb658a2aa161d55fb2a41c2ddfe234fb9303ce7
+  metadata.gz: adfb34aede19f924d41272b3cc06e40fab062c0f64fd17afc721d3cbd51c0c4d
+  data.tar.gz: dfaa41b6b14e96c68750d030571bac640feca178a6f88f57486d2b47774bafb9
 SHA512:
-  metadata.gz: 38e8cbb19de77adcb8eb239749fd729e2aced72b20ba31b8e6cc81b186c3125fcbf774ce2c88a00b03da779f477f8247e3d219cf024d9ac9e2e05799ea3003a2
-  data.tar.gz: 6a29d736057c956ec4b420af00f3f84db703ccc3c959ec05f30ab6d195c7d7dac738cfe768f3705539d158211232626a74ea5b7e876f2f4674596dfc29963b1b
+  metadata.gz: c05b9647db46fe529e1d34c149a40fd0012a4245ec8000a835a3c4592048e57846a83de88d2912a1c2d8d944267a96fb4e13cdd317ad3b09d107e1c41b728d9d
+  data.tar.gz: 9d6c334342bb2c9f8fdc2d39818b57e2452dc9a31f364fd27540f56195772664f357bbd88b05a677457ebf8bbfbd3f16ddc47dcc0a39ecb39443d80aea9ad9c3

data/config/cookstyle.yml

@@ -78,6 +78,11 @@ ChefStyle/SimplifyPlatformMajorVersionCheck:
   Exclude:
     - '**/metadata.rb'
 
+ChefStyle/DefaultCopyrightComments:
+  Description: Cookbook copyright comment headers should be updated for a real person or organization.
+  Enabled: true
+  VersionAdded: '5.12.0'
+
 ###############################
 # ChefCorrectness: Avoiding potential problems
 ###############################
@@ -216,7 +221,7 @@ ChefCorrectness/IncludingOhaiDefaultRecipe:
     - '**/metadata.rb'
 
 ChefCorrectness/UnnecessaryNameProperty:
-  Description: There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources out of the box.
+  Description: There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.
   Enabled: true
   VersionAdded: '5.8.0'
   Include:
@@ -251,10 +256,26 @@ ChefCorrectness/IncorrectLibraryInjection:
   Include:
     - '**/libraries/*.rb'
 
+ChefCorrectness/ResourceWithNothingAction:
+  Description: There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.
+  Enabled: true
+  VersionAdded: '5.12.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+
 ###############################
 # ChefDeprecations: Resolving Deprecations that block upgrading Chef Infra Client
 ###############################
 
+ChefDeprecations/NodeDeepFetch:
+  Description: Do not use the deprecated chef-sugar node.deep_fetch methods
+  Enabled: true
+  VersionAdded: '5.12.0'
+  Exclude:
+    - '**/metadata.rb'
+
 ChefDeprecations/NodeSet:
   Description: Do not use the deprecated node.set method
   Enabled: true
@@ -582,6 +603,13 @@ ChefDeprecations/PartialSearchClassUsage:
   Exclude:
     - '**/metadata.rb'
 
+ChefDeprecations/Cheffile:
+  Description: The Libarian-Chef depsolving project is no longer maintained and should not be used for cookbook depsolving. Consider using Policyfiles instead.
+  Enabled: true
+  VersionAdded: '5.12.0'
+  Include:
+    - '**/Cheffile'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -856,6 +884,27 @@ ChefModernize/Definitions:
   Include:
     - '**/definitions/*.rb'
 
+ChefModernize/IfProvidesDefaultAction:
+  Description: if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.
+  Enabled: true
+  VersionAdded: '5.12.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
+ChefModernize/ZipfileResource:
+  Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.
+  Enabled: true
+  VersionAdded: '5.12.0'
+
+ChefModernize/UnnecessaryMixlibShelloutRequire:
+  Description: Chef Infra Client includes mixlib/shellout automatically in resources and providers.
+  Enabled: true
+  VersionAdded: '5.12.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+
 ###############################
 # Migrating to new patterns
 ###############################
@@ -902,6 +951,13 @@ ChefEffortless/SearchForEnvironmentsOrRoles:
   Exclude:
     - '**/metadata.rb'
 
+ChefEffortless/Berksfile:
+  Description: Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
+  Enabled: true
+  VersionAdded: '5.12.0'
+  Include:
+    - '**/Berksfile'
+
 #### The base rubocop 0.37 enabled.yml file we started with ####
 
 Layout/AccessModifierIndentation:

data/lib/cookstyle.rb

@@ -6,6 +6,7 @@ require 'yaml'
 # ensure the desired target version of RuboCop is gem activated
 gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
 require 'rubocop'
+require 'rubocop/monkey_patches/comment_config.rb'
 
 module RuboCop
   class ConfigLoader

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.11.0".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "5.12.12".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.75.1'.freeze
 end

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

@@ -53,6 +53,7 @@ module RuboCop
         #
         #   # bad
         #   property :config_file, String, required: true, name_property: true
+        #   attribute :config_file, String, required: true, name_attribute: true
         #
         #   # good
         #   property :config_file, String, required: true
@@ -69,10 +70,10 @@ module RuboCop
           private
 
           def property_is_name_property?(node)
-            if node.method_name == :property
+            if %i(property attribute).include?(node.method_name)
               node.arguments.each do |arg|
                 if arg.type == :hash
-                  return true if arg.source.match?(/name_property:\s*true/)
+                  return true if arg.source.match?(/name_(property|attribute):\s*true/)
                 end
               end
               false # no required: true found
@@ -80,7 +81,7 @@ module RuboCop
           end
 
           def required_property?(node)
-            if node.method_name == :property
+            if %i(property attribute).include?(node.method_name)
               node.arguments.each do |arg|
                 if arg.type == :hash
                   return true if arg.source.match?(/required:\s*true/)

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

@@ -0,0 +1,52 @@
+#
+# Copyright:: Copyright 2019, 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 ChefCorrectness
+        # Chef Infra Client provides the :nothing action by default for every resource. There is no need to define a :nothing action in your resource code.
+        #
+        # @example
+        #
+        #   # bad
+        #   action :nothing
+        #     # let's do nothing
+        #   end
+        #
+        class ResourceWithNothingAction < Cop
+          MSG = 'There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.'.freeze
+
+          def_node_matcher :nothing_action?, <<-PATTERN
+            (block (send nil? :action (sym :nothing)) (args) ... )
+          PATTERN
+
+          def on_block(node)
+            nothing_action?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.source_range)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefCorrectness
-        # There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources out of the box.
+        # There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.
         #
         # @example
         #
@@ -27,7 +27,7 @@ module RuboCop
         #   property :name, String, name_property: true
         #
         class UnnecessaryNameProperty < Cop
-          MSG = 'There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources out of the box.'.freeze
+          MSG = 'There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.'.freeze
 
           def_node_matcher :name_property?, <<-PATTERN
             (send nil? :property (sym :name) (const nil? :String) $...)

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

@@ -0,0 +1,41 @@
+#
+# Copyright:: 2019, 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
+      # The Libarian-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 Bershelf offers a more similar, and still supported, experience to Librarian-Chef.
+      #
+      module ChefDeprecations
+        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
+
+          def investigate(processed_source)
+            return if processed_source.blank?
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(nil, location: range, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+#
+# 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 node.deep_fetch method has been removed from Chef-Sugar, and must be replaced by
+        # the node.read API.
+        #
+        # @example
+        #
+        #   # bad
+        #   node.deep_fetch("foo")
+        #
+        #   # good
+        #   node.read("foo")
+        #
+        #   # bad
+        #   node.deep_fetch!("foo")
+        #
+        #   # good
+        #   node.read!("foo")
+        #
+        class NodeDeepFetch < Cop
+          MSG = 'Do not use node.deep_fetch. Replace with node.read to keep identical behavior.'.freeze
+          MSG2 = 'Do not use node.deep_fetch!. Replace with node.read! to keep identical behavior.'.freeze
+
+          def_node_matcher :node_deep_fetch?, <<-PATTERN
+            (send (send _ :node) $:deep_fetch _)
+          PATTERN
+
+          def_node_matcher :node_deep_fetch_bang?, <<-PATTERN
+            (send (send _ :node) $:deep_fetch! _)
+          PATTERN
+
+          def on_send(node)
+            node_deep_fetch?(node) do
+              add_offense(node, location: :selector, message: MSG, severity: :refactor)
+            end
+
+            node_deep_fetch_bang?(node) do
+              add_offense(node, location: :selector, message: MSG2, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.selector, fix_name(node.method_name))
+            end
+          end
+
+          private
+
+          def fix_name(name)
+            return 'read!' if name == :deep_fetch!
+            return 'read' if name == :deep_fetch
+            name.to_s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,21 +18,22 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # Use 'shell_out!' instead of the legacy 'run_command' helper for shelling out. The run_command helper was removed in Chef Infra Client 13.
+        # 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
         #
         #   # bad
         #   run_command('/bin/foo')
+        #   run_command_with_systems_locale('/bin/foo')
         #
         #   # good
         #   shell_out!('/bin/foo')
         #
         class UsesRunCommandHelper < Cop
-          MSG = "Use 'shell_out!' instead of the legacy 'run_command' helper 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.".freeze
 
-          def_node_matcher :calls_run_command?, '(send nil? :run_command ...)'
-          def_node_search :defines_run_command?, '(def :run_command ...)'
+          def_node_matcher :calls_run_command?, '(send nil? {:run_command :run_command_with_systems_locale} ...)'
+          def_node_search :defines_run_command?, '(def {:run_command :run_command_with_systems_locale} ...)'
 
           def on_send(node)
             calls_run_command?(node) do

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

@@ -0,0 +1,41 @@
+#
+# Copyright:: 2019, 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
+      # Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
+      #
+      module ChefEffortless
+        class Berksfile < Cop
+          include RangeHelp
+
+          MSG = 'Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.'.freeze
+
+          def investigate(processed_source)
+            return if processed_source.blank?
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(nil, location: range, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+#
+# Copyright:: 2019, 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
+        # if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.
+        #
+        # @example
+        #
+        #   # bad
+        #   default_action :foo if defined?(default_action)
+        #
+        #   # good
+        #   default_action :foo
+        #
+        class IfProvidesDefaultAction < Cop
+          MSG = 'if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.'.freeze
+
+          def on_defined?(node)
+            return unless node.arguments.first == s(:send, nil, :default_action)
+            node = node.parent if node.parent.respond_to?(:if?) && node.parent.if? # we want the whole if statement
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.children[1].source)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -26,6 +26,9 @@ module RuboCop
         #   # bad
         #   chef_version '>= 13' if respond_to?(:chef_version)
         #   chef_version '>= 13' if defined?(chef_version)
+        #   if defined(chef_version)
+        #     chef_version '>= 13'
+        #   end
         #
         #   # good
         #   chef_version '>= 13'
@@ -50,7 +53,13 @@ module RuboCop
 
           def autocorrect(node)
             lambda do |corrector|
-              corrector.replace(node.loc.expression, node.children[1].source)
+              # When the if statement is if modifier like `foo if respond_to?(:foo)` then
+              # node.if_branch is the actual method call we want to extract.
+              # If a series of metadata methods are wrapped in an if statement then the content we want
+              # is a block under the if statement and node.parent.if_branch can get us that block
+              node = node.parent unless node.if_type?
+
+              corrector.replace(node.loc.expression, node.if_branch.source)
             end
           end
         end

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

@@ -0,0 +1,51 @@
+#
+# Copyright:: 2019, 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
+        # Chef Infra Client includes mixlib/shellout automatically in resources and providers.
+        #
+        # @example
+        #
+        #   # bad
+        #   require 'mixlib/shellout'
+        #
+        class UnnecessaryMixlibShelloutRequire < Cop
+          MSG = 'Chef Infra Client includes mixlib/shellout automatically in resources and providers.'.freeze
+
+          def_node_matcher :require_mixlibshellout?, <<-PATTERN
+          (send nil? :require ( str "mixlib/shellout"))
+          PATTERN
+
+          def on_send(node)
+            require_mixlibshellout?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+#
+# Copyright:: 2019, 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 archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.
+        #
+        # @example
+        #
+        #   # bad
+        #   zipfile "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        class ZipfileResource < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.'.freeze
+
+          def_node_matcher :depends_zipfile?, <<-PATTERN
+            (send nil? :depends (str "zipfile"))
+          PATTERN
+
+          def on_send(node)
+            depends_zipfile?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def on_block(node)
+            match_resource_type?(:zipfile, node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+#
+# Copyright:: 2016-2019, 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 ChefStyle
+        # Checks for default copyright comments from the chef generator cookbook command
+        #
+        # @example
+        #
+        #   # bad
+        #   Copyright:: 2019 YOUR_NAME
+        #   Copyright:: 2019 YOUR_COMPANY_NAME
+        #
+        #   # good
+        #   Copyright:: 2019 Tim Smith
+        #   Copyright:: 2019 Chef Software, Inc.
+        #
+        class DefaultCopyrightComments < Cop
+          MSG = 'Cookbook copyright comment headers should be updated for a real person or organization.'.freeze
+
+          def investigate(processed_source)
+            return unless processed_source.ast
+
+            processed_source.comments.each do |comment|
+              next unless comment.inline? # headers aren't in blocks
+
+              if /# (?:Copyright\W*).*YOUR_(NAME|COMPANY_NAME)/.match?(comment.text)
+                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,23 +18,27 @@ module RuboCop
   module Cop
     module Chef
       module ChefStyle
-        # Use the platform?() and platform_family?() helpers instead of node['platform] == 'foo'
-        # and node['platform_family'] == 'bar'. These helpers are easier to read and can accept multiple
-        # platform arguments, which greatly simplifies complex platform logic.
+        # Use the platform?() and platform_family?() helpers instead of node['platform] == 'foo' and node['platform_family'] == 'bar'. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic.
         #
         # @example
         #
         #   # bad
         #   node['platform'] == 'ubuntu'
+        #   node['platform_family'] == 'debian'
+        #   node['platform'] != 'ubuntu'
+        #   node['platform_family'] != 'debian'
         #
         #   # good
         #   platform?('ubuntu')
+        #   !platform?('ubuntu')
+        #   platform_family?('debian')
+        #   !platform_family?('debian')
         #
         class UsePlatformHelpers < Cop
-          MSG = 'Use platform? and platform_family? helpers for checking node platform'.freeze
+          MSG = "Use platform? and platform_family? helpers for checking a node's platform".freeze
 
           def_node_matcher :platform_check?, <<-PATTERN
-            ( send (send (send nil? :node) :[] $(str {"platform" "platform_family"}) ) :== $str )
+            ( send (send (send nil? :node) :[] $(str {"platform" "platform_family"}) ) ${:== :!=} $str )
           PATTERN
 
           def on_send(node)
@@ -45,8 +49,10 @@ module RuboCop
 
           def autocorrect(node)
             lambda do |corrector|
-              platform_check?(node) do |type, plat|
-                corrector.replace(node.loc.expression, "#{type.value}?('#{plat.value}')")
+              platform_check?(node) do |type, operator, plat|
+                corrected_string = operator == :!= ? '!' : ''
+                corrected_string << "#{type.value}?('#{plat.value}')"
+                corrector.replace(node.loc.expression, corrected_string)
               end
             end
           end

data/lib/rubocop/monkey_patches/comment_config.rb

@@ -0,0 +1,10 @@
+module RuboCop
+  # we're monkey patching the config regex to allow for # cookstyle: disable whatever
+  # in addition to the # rubocop: disable whatever that comes with Rubocop
+  class CommentConfig
+    remove_const('COMMENT_DIRECTIVE_REGEXP')
+    COMMENT_DIRECTIVE_REGEXP = Regexp.new(
+      ('# (?:rubocop|cookstyle) : ((?:dis|en)able)\b ' + COPS_PATTERN).gsub(' ', '\s*')
+    )
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.11.0
+  version: 5.12.12
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -68,12 +68,14 @@ files:
 - lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
 - lib/rubocop/cop/chef/correctness/resource_with_none_action.rb
+- lib/rubocop/cop/chef/correctness/resource_with_nothing_action.rb
 - lib/rubocop/cop/chef/correctness/service_resource.rb
 - lib/rubocop/cop/chef/correctness/tmp_path.rb
 - lib/rubocop/cop/chef/correctness/unnecessary_name_property.rb
 - lib/rubocop/cop/chef/deprecation/attribute_metadata.rb
 - lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb
 - lib/rubocop/cop/chef/deprecation/chef_rest.rb
+- lib/rubocop/cop/chef/deprecation/cheffile.rb
 - lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb
 - lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb
 - lib/rubocop/cop/chef/deprecation/chocolatey_package_uninstall_action.rb
@@ -93,6 +95,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb
 - lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
 - lib/rubocop/cop/chef/deprecation/name_property_and_default.rb
+- lib/rubocop/cop/chef/deprecation/node_deep_fetch.rb
 - lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb
 - lib/rubocop/cop/chef/deprecation/node_set.rb
 - lib/rubocop/cop/chef/deprecation/node_set_unless.rb
@@ -116,6 +119,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb
 - lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb
 - lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb
+- lib/rubocop/cop/chef/effortless/berksfile.rb
 - lib/rubocop/cop/chef/effortless/data_bags.rb
 - lib/rubocop/cop/chef/effortless/node_environment.rb
 - lib/rubocop/cop/chef/effortless/node_policygroup.rb
@@ -133,6 +137,7 @@ files:
 - lib/rubocop/cop/chef/modernize/depends_zypper_cookbook.rb
 - lib/rubocop/cop/chef/modernize/execute_apt_update.rb
 - lib/rubocop/cop/chef/modernize/execute_tzutil.rb
+- lib/rubocop/cop/chef/modernize/if_provides_default_action.rb
 - lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb
 - lib/rubocop/cop/chef/modernize/libarchive_file.rb
 - lib/rubocop/cop/chef/modernize/macos_user_defaults.rb
@@ -154,18 +159,22 @@ files:
 - lib/rubocop/cop/chef/modernize/seven_zip_archive.rb
 - lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.rb
 - lib/rubocop/cop/chef/modernize/systctl_param_resource.rb
+- lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb
 - lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb
 - lib/rubocop/cop/chef/modernize/windows_default_recipe.rb
 - lib/rubocop/cop/chef/modernize/windows_version_helper.rb
 - lib/rubocop/cop/chef/modernize/windows_zipfile.rb
+- lib/rubocop/cop/chef/modernize/zipfile_resource.rb
 - lib/rubocop/cop/chef/modernize/zypper_repo.rb
 - lib/rubocop/cop/chef/style/attribute_keys.rb
 - lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
 - lib/rubocop/cop/chef/style/comments_copyright_format.rb
+- lib/rubocop/cop/chef/style/comments_default_copyright.rb
 - lib/rubocop/cop/chef/style/comments_format.rb
 - lib/rubocop/cop/chef/style/file_mode.rb
 - lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
+- lib/rubocop/monkey_patches/comment_config.rb
 homepage: https://github.com/chef/cookstyle
 licenses:
 - Apache-2.0