cookstyle 6.2.5 → 6.6.9

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2019, Chef Software, Inc.
+# Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,8 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem.
-        # Chef Infra Client 12 and later ships with nokogiri included.
+        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.
         #
         # @example
         #
@@ -35,6 +34,7 @@ module RuboCop
 
           def on_send(node)
             xml_ruby_recipe?(node) do
+              node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
               add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
           end

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

@@ -0,0 +1,93 @@
+#
+# 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 ChefModernize
+        # There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
+        #
+        #   # bad
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if Chef::Resource::ChefGem.method_defined?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if Chef::Resource::ChefGem.instance_methods(false).include?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if respond_to?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   # good
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true
+        #     action :nothing
+        #   end
+        #
+        class RespondToCompileTime < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.1'
+
+          MSG = 'There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.'.freeze
+
+          def_node_matcher :compile_time_method_defined?, <<-PATTERN
+          (if
+            {
+              (send
+              (const
+                (const
+                  (const nil? :Chef) :Resource) :ChefGem) :method_defined?
+              (sym :compile_time))
+
+              (send
+                (send
+                  (const
+                    (const
+                      (const nil? :Chef) :Resource) :ChefGem) :instance_methods
+                  (false)) :include?
+                (sym :compile_time))
+
+              (send nil? :respond_to?
+                (sym :compile_time))
+            }
+            (send nil? :compile_time
+              $(_)) nil?)
+          PATTERN
+
+          def on_if(node)
+            compile_time_method_defined?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              compile_time_method_defined?(node) do |val|
+                corrector.replace(node.loc.expression, "compile_time #{val.source}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2019, Chef Software, Inc.
+# Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,19 +18,20 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # It is not longer necessary respond_to?(:foo) in metadata. This was used to support new metadata
-        # methods in Chef 11 and early versions of Chef 12.
+        # In Chef Infra Client 12+ is is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
         #
         # @example
         #
         #   # bad
         #   provides :foo if respond_to?(:provides)
         #
+        #   provides :foo if defined? provides
+        #
         #   # good
         #   provides :foo
         #
         class RespondToProvides < Cop
-          MSG = 'respond_to?(:provides) in resources is no longer necessary in Chef Infra Client 12+'.freeze
+          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'.freeze
 
           def on_if(node)
             if_respond_to_provides?(node) do
@@ -39,7 +40,16 @@ module RuboCop
           end
 
           def_node_matcher :if_respond_to_provides?, <<~PATTERN
-          (if (send nil? :respond_to? ( :sym :provides ) ) ... )
+          (if
+            {
+            (send nil? :respond_to?
+              (sym :provides))
+
+            (:defined?
+              (send nil? :provides))
+            }
+            (send nil? :provides
+              (sym _)) ... )
           PATTERN
 
           def autocorrect(node)

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

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

@@ -47,12 +47,14 @@ module RuboCop
               (send
                 $(array ... ) :each)
               (args ... )
-              (block
+              {(block
                 (send nil? :package
                   (lvar ... ))
                 (args)
                 (send nil? :action
-                  (sym :install)))) nil?)
+                  (sym :install)))
+                (send nil? :package
+                    (lvar _))}) nil?)
           PATTERN
 
           def_node_matcher :package_array_install?, <<-PATTERN
@@ -60,12 +62,14 @@ module RuboCop
             (send
               $(array ... ) :each)
             (args ... )
-            (block
+            {(block
               (send nil? :package
                 (lvar ... ))
               (args)
               (send nil? :action
-                (sym :install))))
+                (sym :install)))
+              (send nil? :package
+                  (lvar _))})
           PATTERN
 
           # see if all platforms in the when condition are multipackage compliant

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2019, Chef Software Inc.
+# Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -35,8 +35,15 @@ module RuboCop
 
           MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'.freeze
 
+          # match on both whyrun_supported? and the typo form why_run_supported?
+          def_node_matcher :whyrun_true?, <<-PATTERN
+            (def {:whyrun_supported? :why_run_supported?}
+              (args)
+              (true))
+          PATTERN
+
           def on_def(node)
-            if node.method_name == :whyrun_supported? && node.body == s(:true) # rubocop: disable Lint/BooleanSymbol
+            whyrun_true?(node) do
               add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
           end

data/lib/rubocop/cop/chef/redundant/grouping_metadata.rb

@@ -26,7 +26,6 @@ module RuboCop
         #   # bad
         #   grouping 'windows_log_rotate', title: 'Demonstration cookbook with code to switch loggers'
         #
-        #
         class GroupingMetadata < Cop
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers

data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2019, Chef Software Inc.
+# Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,13 +18,13 @@ module RuboCop
   module Cop
     module Chef
       module ChefRedundantCode
-        # Every Chef Infra resources already include a sensitive property with a default value of false.
+        # Every Chef Infra resource already includes a sensitive property with a default value of false.
         #
         # # bad
         # property :sensitive, [true, false], default: false
         #
         class SensitivePropertyInResource < Cop
-          MSG = 'Every Chef Infra resources already include a sensitive property with a default value of false.'.freeze
+          MSG = 'Every Chef Infra resource already includes a sensitive property with a default value of false.'.freeze
 
           def_node_matcher :sensitive_property?, <<-PATTERN
             (send nil? {:property :attribute} (sym :sensitive) ... (hash (pair (sym :default) (false))))

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefStyle
-        # Use not_if instead of only_if that negates the Ruby statement with a !
+        # Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read
         #
         # @example
         #
@@ -33,7 +33,7 @@ module RuboCop
         #   end
         #
         class NegatingOnlyIf < Cop
-          MSG = 'Use not_if instead of only_if that negates the Ruby statement with a !'.freeze
+          MSG = 'Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read'.freeze
 
           def_node_matcher :negated_only_if?, <<-PATTERN
             (block
@@ -45,8 +45,13 @@ module RuboCop
 
           def on_block(node)
             negated_only_if?(node) do |_only_if, code|
+              # skip inspec controls where we don't have not_if
+              return if node.parent&.parent&.block_type? &&
+                        node.parent&.parent&.method_name == :control
+
               # the value was double negated to work around types: ex: !!systemd?
-              return if code.descendants.first.negation_method?
+              return if code.descendants.first.send_type? &&
+                        code.descendants.first.negation_method?
 
               add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefStyle
-        # Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set.  Setting multiple `supports` or `depends` values is simpler and easier to understand for new users.
+        # Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set. Setting multiple `supports` or `depends` values is simpler and easier to understand for new users.
         #
         # @example
         #

data/lib/rubocop/cop/target_chef_version.rb

@@ -6,6 +6,10 @@ module RuboCop
   module Cop
     # Common functionality for checking target chef version.
     module TargetChefVersion
+      def required_minimum_chef_version
+        @minimum_target_chef_version
+      end
+
       def minimum_target_chef_version(version)
         @minimum_target_chef_version = version
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.2.5
+  version: 6.6.9
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.83.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.83.0
 description: 
 email:
 - thom@chef.io
@@ -57,17 +57,21 @@ files:
 - lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb
 - lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb
+- lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb
+- lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb
 - lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb
+- lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb
 - lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb
 - lib/rubocop/cop/chef/correctness/metadata_missing_name.rb
 - lib/rubocop/cop/chef/correctness/node_normal.rb
 - lib/rubocop/cop/chef/correctness/node_normal_unless.rb
 - lib/rubocop/cop/chef/correctness/node_save.rb
 - lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb
+- lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb
 - lib/rubocop/cop/chef/correctness/powershell_delete_file.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
@@ -89,6 +93,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb
+- lib/rubocop/cop/chef/deprecation/deprecated_shellout_methods.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_windows_version_check.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb
 - lib/rubocop/cop/chef/deprecation/easy_install.rb
@@ -117,6 +122,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
@@ -176,11 +182,13 @@ files:
 - lib/rubocop/cop/chef/modernize/resource_name_initializer.rb
 - lib/rubocop/cop/chef/modernize/resource_set_or_return.rb
 - lib/rubocop/cop/chef/modernize/resource_with_attributes.rb
+- lib/rubocop/cop/chef/modernize/respond_to_compile_time.rb
 - lib/rubocop/cop/chef/modernize/respond_to_metadata.rb
 - lib/rubocop/cop/chef/modernize/respond_to_provides.rb
 - 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