cookstyle 6.4.4 → 6.9.0

data/lib/rubocop/cop/chef/modernize/includes_mixin_shellout.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");
@@ -42,13 +42,34 @@ module RuboCop
             (send nil? :require ( str {"chef/mixin/shell_out" "chef/mixin/powershell_out"} ))
           PATTERN
 
+          def_node_search :hwrp_classes?, <<-PATTERN
+            (class
+              (const ... )
+              {(const
+                (const
+                  (const nil? :Chef) :Provider) :LWRPBase)
+               (const
+                 (const nil? :Chef) :Provider)
+               }
+              ...)
+          PATTERN
+
+          def check_for_offenses(node)
+            containing_dir = File.basename(File.dirname(processed_source.path))
+
+            # only add offenses when we're in a custom resource or HWRP, but not a plain old library
+            if containing_dir == 'resources' || hwrp_classes?(processed_source.ast)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
           def on_send(node)
             require_shellout?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              check_for_offenses(node)
             end
 
             include_shellout?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              check_for_offenses(node)
             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

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/sharing/invalid_license_string.rb

@@ -483,7 +483,7 @@ module RuboCop
 
           def valid_license?(license)
             VALID_LICENSE_STRING.include?(license) ||
-              license.downcase == 'all rights reserved'
+              license.casecmp('all rights reserved') == 0
           end
         end
       end

data/lib/rubocop/monkey_patches/team.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    class Team
+      def support_target_chef_version?(cop)
+        return true unless cop.class.respond_to?(:support_target_chef_version?)
+
+        cop.class.support_target_chef_version?(cop.target_chef_version)
+      end
+
+      ### START COOKSTYLE MODIFICATION
+      def roundup_relevant_cops(filename)
+        cops.reject do |cop|
+          cop.excluded_file?(filename) ||
+            !support_target_ruby_version?(cop) ||
+            !support_target_chef_version?(cop) ||
+            !support_target_rails_version?(cop)
+        end
+      end
+      ### END COOKSTYLE MODIFICATION
+    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.9.0
 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-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.86.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.86.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
@@ -96,6 +100,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb
 - lib/rubocop/cop/chef/deprecation/epic_fail.rb
 - lib/rubocop/cop/chef/deprecation/erl_call.rb
+- lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb
 - lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb
 - lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb
 - lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb
@@ -115,9 +120,10 @@ files:
 - lib/rubocop/cop/chef/deprecation/require_recipe.rb
 - lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb
 - lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.rb
+- lib/rubocop/cop/chef/deprecation/resource_uses_only_resource_name.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/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 +189,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
@@ -238,9 +245,9 @@ files:
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
 - lib/rubocop/cop/target_chef_version.rb
 - lib/rubocop/monkey_patches/comment_config.rb
-- lib/rubocop/monkey_patches/commissioner.rb
 - lib/rubocop/monkey_patches/config.rb
 - lib/rubocop/monkey_patches/cop.rb
+- lib/rubocop/monkey_patches/team.rb
 homepage: 
 licenses:
 - Apache-2.0

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

@@ -1,81 +0,0 @@
-#
-# 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
-        # In Chef Infra Client 16 and later a legacy HWRP resource must use either `resource_name` or `provides` to define the resource name.
-        #
-        # @example
-        #
-        #   # bad
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        #  # good
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         resource_name :ulimit_rule
-        #
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        #  # better
-        #  Convert your legacy HWRPs to custom resources
-        #
-        class ResourceWithoutNameOrProvides < Cop
-          MSG = 'In Chef Infra Client 16 and later legacy HWRP resources must use either `resource_name` or `provides` to define the resource name.'.freeze
-
-          def_node_matcher :HWRP?, <<-PATTERN
-          (class
-            (const nil? :Chef) nil?
-            (class
-              (const nil? :Resource) nil?
-              $(class
-                (const nil? ... )
-                (const
-                  (const nil? :Chef) :Resource)
-                  (begin ... ))))
-          PATTERN
-
-          def_node_search :provides_or_resource_name?, '(send nil? {:provides :resource_name} ...)'
-
-          def on_class(node)
-            HWRP?(node) do |inherit|
-              add_offense(inherit, location: :expression, message: MSG, severity: :warning) if provides_or_resource_name?(processed_source.ast).nil?
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/monkey_patches/commissioner.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    class Commissioner
-      def remove_irrelevant_cops(filename)
-        @cops.reject! { |cop| cop.excluded_file?(filename) }
-        @cops.reject! do |cop|
-          cop.class.respond_to?(:support_target_ruby_version?) &&
-            !cop.class.support_target_ruby_version?(cop.target_ruby_version)
-        end
-        @cops.reject! do |cop|
-          cop.class.respond_to?(:support_target_rails_version?) &&
-            !cop.class.support_target_rails_version?(cop.target_rails_version)
-        end
-
-        ### START COOKSTYLE MODIFICATION
-        @cops.reject! do |cop|
-          cop.class.respond_to?(:support_target_chef_version?) &&
-            !cop.class.support_target_chef_version?(cop.target_chef_version)
-        end
-        ### END COOKSTYLE MODIFICATION
-      end
-    end
-  end
-end