cookstyle 6.4.4 → 6.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a8c9e4e7d09afb290f4d894de9960bd1a0ffc1ed116321a5887a49206453029
-  data.tar.gz: 53389b9ed11b1571f8ce3e8fd108150594d5cb2c6c7e5ef0fc14b3ba2633d8ad
+  metadata.gz: 84025c0a2c14cea15521215fabb39dd043ad6de8f1bb712ffa66fd0350287b5f
+  data.tar.gz: 1df6c910b7d68aeb649a4e372964047ee059b5220a3db4d1ee3d2a69013c288f
 SHA512:
-  metadata.gz: 9a5a62cc80a0ebc6af299114f25b1d47af14dc857dc206e5281ee167f49207b8399a962addc8b942c8e14bd7055ea97830861e2419ad05da179e961d25c4ccec
-  data.tar.gz: cc44d7eb2418c84131f1916de9a15b83fcd5511ccbc3e19e2eb2103f53e09fd3df2d0828dda31e4b0affe43087abc009d0ec35052e1e63a6aca884ec1c51b2ea
+  metadata.gz: f71145c0012b288b97112ba4bf0e0255b53f2e0d2e6d8e460bd182eaa7d8f41213cd91420e7b759b1c8cd7883ee5727b54dc7aa7cc54d93986691b3f8d729e78
+  data.tar.gz: 4ec0deaaf4c3aad4de6f88c988c90f502682c6f944d19c199a82c735cbee651c2e3b1088bcef5ebe694674a6d04d44735d6792aba005059336f4bde83631f4c2

data/config/cookstyle.yml

@@ -834,6 +834,14 @@ ChefDeprecations/DeprecatedShelloutMethods:
     - '**/attributes/*.rb'
     - '**/Berksfile'
 
+ChefDeprecations/Ruby27KeywordArgumentWarnings:
+  Description: Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
+  Enabled: true
+  VersionAdded: '6.5.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -1293,6 +1301,15 @@ ChefModernize/RespondToCompileTime:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefModernize/ShellOutHelper:
+  Description: Use the built-in shell_out helper available in Chef Infra Client 12.11+ instead of calling Mixlib::ShellOut.new('foo').run_command.
+  Enabled: true
+  VersionAdded: '6.5.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+    - '**/libraries/*.rb'
+
 ###############################
 # ChefRedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "6.4.4".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "6.5.3".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.83.0'.freeze
 end

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

@@ -47,22 +47,28 @@ module RuboCop
               '> 16.04, < 18.04' => true,
             },
             'fedora' => {
-              '< 30' => '30',
+              '< 31' => '31',
             },
             'freebsd' => {
-              '< 11' => '12',
+              '~> 11.0, < 11.2' => '11',
+              '= 12.0' => '12',
+              '< 11' => true,
             },
             'mac_os_x' => {
               '< 10.12' => '10.15',
             },
+            'suse' => {
+              '~> 12.0, < 12.4' => '12',
+              '< 12' => true,
+            },
             'opensuse' => {
               '< 14' => true,
               '~> 42.0' => true,
             },
             'debian' => {
               '< 8' => true,
-              '> 8.0, < 8.9' => '8',
-              '> 9.0, < 9.8' => '9',
+              '> 8.0, < 8.10' => '8',
+              '> 9.0, < 9.9' => '9',
             },
             'centos' => {
               '< 6.0' => true,

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

@@ -0,0 +1,59 @@
+#
+# 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 ChefDeprecations
+        # Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
+        #
+        # @example
+        #
+        #   # bad
+        #   shell_out!('hostnamectl status', { returns: [0, 1] })
+        #   shell_out('hostnamectl status', { returns: [0, 1] })
+        #
+        #   # good
+        #   shell_out!('hostnamectl status', returns: [0, 1])
+        #   shell_out('hostnamectl status', returns: [0, 1])
+        #
+        class Ruby27KeywordArgumentWarnings < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'.freeze
+
+          def_node_matcher :positional_shellout?, <<-PATTERN
+            (send nil? {:shell_out :shell_out!} ... $(hash ... ))
+          PATTERN
+
+          def on_send(node)
+            positional_shellout?(node) do |h|
+              add_offense(h, location: :expression, message: MSG, severity: :refactor) if h.braces?
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              # @todo when we drop ruby 2.4 support we can convert to to just delete_prefix delete_suffix
+              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^{/, '').gsub(/}$/, ''))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+#
+# 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 built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.
+        #
+        # @example
+        #
+        #   # bad
+        #   Mixlib::ShellOut.new('foo').run_command
+        #
+        #   # good
+        #   shell_out('foo')
+        #
+        class ShellOutHelper < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.11'
+
+          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.".freeze
+
+          def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
+          (send
+            (send
+              (const
+                (const nil? :Mixlib) :ShellOut) :new
+              $(...)) :run_command)
+          PATTERN
+
+          def on_send(node)
+            mixlib_shellout_run_cmd?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            mixlib_shellout_run_cmd?(node) do |cmd|
+              lambda do |corrector|
+                corrector.replace(node.loc.expression, "shell_out(#{cmd.loc.expression.source})")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.4.4
+  version: 6.5.3
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -118,6 +118,7 @@ files:
 - 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/resource_without_name_or_provides.rb
+- lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb
 - lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb
 - lib/rubocop/cop/chef/deprecation/run_command_helper.rb
 - lib/rubocop/cop/chef/deprecation/search_uses_positional_parameters.rb
@@ -183,6 +184,7 @@ files:
 - lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb
 - lib/rubocop/cop/chef/modernize/sc_windows_resource.rb
 - lib/rubocop/cop/chef/modernize/seven_zip_archive.rb
+- lib/rubocop/cop/chef/modernize/shell_out_helper.rb
 - lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.rb
 - lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb
 - lib/rubocop/cop/chef/modernize/systctl_param_resource.rb