cookstyle 5.8.1 → 5.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3125819fab3d282926b73935652abee3c33badfdd12bbb257d983df77f575968
-  data.tar.gz: 74522c27e329921082c8f04e4ba0570ae45e39ae897f13f87ffa5c54c8658974
+  metadata.gz: b4f5eafb40f3af8be2a8af2d128ad4b9788e41c52ab1a410831143ab50d719be
+  data.tar.gz: a580aaee49df70685f9e1f0cf8ca6a71270d81b5277e37a497a572e06cf3aea3
 SHA512:
-  metadata.gz: 1c0daefee8ecb8249105e48d6c9ff1578fd150847fa5abf55bb07e175367c923481dcfa1e57339ae757f61bc94a5f23a7856ac3b320ca5f13c9c554f56be12fa
-  data.tar.gz: 8128f87b453e15356b7814dec8e7b87e6ba73f60dde690de6db480b856711fbbd73b77acec3ebaae078251b4d74ad96fb422c53f3a401d0bbdfd8e8865240113
+  metadata.gz: 1684945f60801dd046dc16c0b5d813863ae9dd0ec0616a681a23d86e12fe77c5a337d2bce0002a59041afafc2b02f0f3d1a99b338e39c43d940a8fd66302abcb
+  data.tar.gz: db367ba9d75c4dad58daf64759bb361c6da1141131b134d7a3c52e18a21e627f831ef59f274a38842871939a810e78945db0a8d3f821a322f7c3dae6d9323f9c

data/config/cookstyle.yml

@@ -499,6 +499,21 @@ ChefDeprecations/ChefSpecLegacyRunner:
   Include:
     - '**/spec/*.rb'
 
+ChefDeprecations/UsesRunCommandHelper:
+  Description: Use 'shell_out!' instead of the legacy 'run_command' helper for shelling out. The run_command helper was removed in Chef Infra Client 13.
+  Enabled: true
+  VersionAdded: '5.9.0'
+  Exclude:
+    - '**/metadata.rb'
+    - 'Rakefile'
+
+ChefDeprecations/ChefHandlerUsesSupports:
+  Description: 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.
+  Enabled: true
+  VersionAdded: '5.9.0'
+  Exclude:
+    - '**/metadata.rb'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -520,7 +535,7 @@ ChefModernize/WhyRunSupportedTrue:
     - '**/libraries/*.rb'
 
 ChefModernize/UnnecessaryDependsChef14:
-  Description: Don't depend on cookbooks made obsolete by Chef 14
+  Description: Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
   Enabled: true
   VersionAdded: '5.1.0'
   Include:
@@ -740,6 +755,13 @@ ChefModernize/MacOsXUserdefaults:
   Exclude:
     - '**/metadata.rb'
 
+ChefModernize/PowerShellGuardInterpreter:
+  Description: PowerShell is already set as the default guard interpreter for powershell_script resources in Chef Infra Client 13 and later and does not need to be specified.
+  Enabled: true
+  VersionAdded: '5.9.0'
+  Exclude:
+    - '**/metadata.rb'
+
 ###############################
 # Migrating to new patterns
 ###############################

data/cookstyle.gemspec

@@ -8,8 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Cookstyle::VERSION
   spec.authors       = ['Thom May', 'Tim Smith']
   spec.email         = ['thom@chef.io', 'tsmith@chef.io']
-
-  spec.summary       = 'RuboCop configuration for Chef cookbooks'
+  spec.summary       = 'Cookstyle is a code linting tool that helps you to write better Chef Infra cookbooks by detecting and automatically correcting style, syntax, and logic mistakes in your code.'
   spec.homepage      = 'https://github.com/chef/cookstyle'
   spec.license       = 'Apache-2.0'
   spec.required_ruby_version = '>= 2.4'

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.8.1".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "5.9.3".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.72.0'.freeze
 end

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

@@ -0,0 +1,56 @@
+#
+# 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 ChefDeprecations
+        # 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.
+        #
+        # @example
+        #
+        #   # bad
+        #   chef_handler 'whatever' do
+        #     supports start: true, report: true, exception: true
+        #   end0
+        #
+        #   # good
+        #   chef_handler 'whatever' do
+        #     type start: true, report: true, exception: true
+        #   end
+        #
+        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
+
+          def on_block(node)
+            match_property_in_resource?('chef_handler', 'supports', node) do |prop_node|
+              add_offense(prop_node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, "type #{node.arguments.first.source}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+#
+# 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 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.
+        #
+        # @example
+        #
+        #   # bad
+        #   run_command('/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
+
+          def_node_matcher :calls_run_command?, '(send nil? :run_command ...)'
+          def_node_search :defines_run_command?, '(def :run_command ...)'
+
+          def on_send(node)
+            calls_run_command?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) unless defines_run_command?(processed_source.ast)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Don't depend on cookbooks made obsolete by Chef 14
+        # Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
         #
         # @example
         #
@@ -32,10 +32,10 @@ module RuboCop
         #   depends 'sysctl'
         #
         class UnnecessaryDependsChef14 < Cop
-          MSG = "Don't depend on cookbooks made obsolete by Chef 14".freeze
+          MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.".freeze
 
           def_node_matcher :legacy_depends?, <<-PATTERN
-            (send nil? :depends (str {"build-essential" "chef_handler" "chef_hostname" "dmg" "mac_os_x" "swap" "sysctl"}))
+            (send nil? :depends (str {"build-essential" "chef_handler" "chef_hostname" "dmg" "mac_os_x" "swap" "sysctl"}) ... )
           PATTERN
 
           def on_send(node)

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

@@ -0,0 +1,59 @@
+#
+# 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
+        # PowerShell is already set as the default guard interpreter for powershell_script resources in Chef Infra Client 13 and later and does not need to be specified.
+        #
+        # @example
+        #
+        #   # bad
+        #   powershell_script 'whatever' do
+        #     code "mkdir test_dir"
+        #     guard_interpreter :powershell_script
+        #   end
+        #
+        #   # good
+        #   powershell_script 'whatever' do
+        #     code "mkdir test_dir"
+        #   end
+        #
+        class PowerShellGuardInterpreter < Cop
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+
+          MSG = 'PowerShell is already set as the default guard interpreter for powershell_script resources in Chef Infra Client 13 and later and does not need to be specified.'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'guard_interpreter', node) do |interpreter|
+              if interpreter.arguments.first.source == ':powershell_script'
+                add_offense(interpreter, location: :expression, message: MSG, severity: :refactor)
+              end
+            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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.8.1
+  version: 5.9.3
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -70,6 +70,7 @@ files:
 - 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/chefspec_coverage_report.rb
 - lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb
@@ -98,6 +99,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.rb
 - lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb
 - lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb
+- lib/rubocop/cop/chef/deprecation/run_command_helper.rb
 - lib/rubocop/cop/chef/deprecation/suggests_metadata.rb
 - lib/rubocop/cop/chef/deprecation/use_inline_resources.rb
 - lib/rubocop/cop/chef/deprecation/user_supports_property.rb
@@ -123,6 +125,7 @@ files:
 - lib/rubocop/cop/chef/modernize/openssl_x509_resource.rb
 - lib/rubocop/cop/chef/modernize/osx_config_profile_resource.rb
 - lib/rubocop/cop/chef/modernize/powershell_expand_archive.rb
+- lib/rubocop/cop/chef/modernize/powershell_guard_interpreter.rb
 - lib/rubocop/cop/chef/modernize/powershell_install_package.rb
 - lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.rb
 - lib/rubocop/cop/chef/modernize/resource_set_or_return.rb
@@ -168,5 +171,7 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: RuboCop configuration for Chef cookbooks
+summary: Cookstyle is a code linting tool that helps you to write better Chef Infra
+  cookbooks by detecting and automatically correcting style, syntax, and logic mistakes
+  in your code.
 test_files: []