cookstyle 5.22.6 → 5.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dad51325bcc35540eeba663b24105674daa20a35d198427a9331be5d02ca3e3b
-  data.tar.gz: 83e2ab6a718092d10ec8ce423e14c995e5a64bc696cd99b3a447144cf2a10fdb
+  metadata.gz: b643382e9541a9d542bda66cde1aae0922ba3bb43318e21bc5f8abe3ebb37ce8
+  data.tar.gz: 4b7939a38dfa5d0065560a834c770bdde57ed58e5bfc86b4adeaaea622470ae7
 SHA512:
-  metadata.gz: 56cba25a342b3f48f69160838cc03807640b11864ba43c5915c715520b1dd751f6ff263e89fd79d8414f3d9b206adbfa441833373dbcb5aed46e0beb32518b74
-  data.tar.gz: 45af6528c08c91fc29f83542d407a081cd0d6897c9fb42b63a51ad512ca0895aa4e48019fc6bb41fe34a4436cbf58b4c64b1306ae41a6f9faec6c2ec855378fb
+  metadata.gz: 359c2d5b2b9112ce9d16e5ca8bbc76a4dd76db8076a9d5467fcdc9f69905997a67bbe8a6b869dc3099aab72ecdb6b2ca1cffacd1b2b378dbe9416430ecf10b8f
+  data.tar.gz: 971d8d6472462ce60641d5c097670d212e071dd99ef5e0e6f8082ce5ab4592860ef71423eb94a853a8a3181ebc27d6c8081bd97435ec6a19638482f51b52fcf7

data/config/cookstyle.yml

@@ -129,7 +129,7 @@ ChefStyle/ChefWhaaat:
 
 ChefStyle/UnnecessaryOSCheck:
   Description: Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match 1:1 with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic.
-  Enabled: false
+  Enabled: true
   VersionAdded: '5.21.0'
 
 ###############################
@@ -1553,8 +1553,6 @@ Style/PercentQLiterals:
   Enabled: true
 Style/PerlBackrefs:
   Enabled: true
-Naming/PredicateName:
-  Enabled: true
 Style/Proc:
   Enabled: true
 Style/RaiseArgs:

data/lib/cookstyle/version.rb

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

data/lib/rubocop/cop/chef/correctness/dnf_package_allow_downgrades.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");
@@ -34,6 +34,7 @@ module RuboCop
         #   end
         #
         class DnfPackageAllowDowngrades < Cop
+          include RangeHelp
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'dnf_package does not support the allow_downgrades property'.freeze
@@ -43,6 +44,12 @@ module RuboCop
               add_offense(prop, location: :expression, message: MSG, severity: :refactor)
             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

data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.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,24 +18,22 @@ module RuboCop
   module Cop
     module Chef
       module ChefCorrectness
-        # Libraries should be injected into the Chef::DSL::Recipe or Chef::DSL::Resource classes and not Recipe/Resource/Provider classes directly.
+        # Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.
         #
         # @example
         #
         #   # bad
         #   ::Chef::Recipe.send(:include, Filebeat::Helpers)
         #   ::Chef::Provider.send(:include, Filebeat::Helpers)
-        #   ::Chef::Resource.send(:include, Filebeat::Helpers)
         #
         #   # good
         #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
-        #   ::Chef::DSL::Resource.send(:include, Filebeat::Helpers)
         #
         class IncorrectLibraryInjection < Cop
-          MSG = 'Libraries should be injected into the Chef::DSL::Recipe or Chef::DSL::Resource classes and not Recipe/Resource/Provider classes directly.'.freeze
+          MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'.freeze
 
           def_node_matcher :legacy_class_sends?, <<-PATTERN
-            (send (const (const (cbase) :Chef) {:Recipe :Provider :Resource}) :send (sym :include) ... )
+            (send (const (const (cbase) :Chef) {:Recipe :Provider}) :send (sym :include) ... )
           PATTERN
 
           def on_send(node)
@@ -46,11 +44,7 @@ module RuboCop
 
           def autocorrect(node)
             lambda do |corrector|
-              new_val = node.source
-              new_val.gsub!(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe')
-              new_val.gsub!(/Chef::Resource/, 'Chef::DSL::Resource')
-
-              corrector.replace(node.loc.expression, new_val)
+              corrector.replace(node.loc.expression, node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
             end
           end
         end

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

@@ -26,6 +26,10 @@ module RuboCop
         #   depends 'partial_search'
         #
         class CookbookDependsOnPartialSearch < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.0'
+
           MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13".freeze
 
           def_node_matcher :depends_partial_search?, <<-PATTERN

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

@@ -42,6 +42,9 @@ module RuboCop
         #
         class DeprecatedYumRepositoryProperties < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.14'
 
           MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire.'.freeze
 

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

@@ -34,6 +34,9 @@ module RuboCop
         #
         class LaunchdDeprecatedHashProperty < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.19'
 
           MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.".freeze
 

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

@@ -34,6 +34,9 @@ module RuboCop
         #
         class VerifyPropertyUsesFileExpansion < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.5'
 
           MSG = "Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13.".freeze
 

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

@@ -41,6 +41,9 @@ module RuboCop
         #
         class WindowsTaskChangeAction < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.0'
 
           MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.'.freeze
 

data/lib/rubocop/cop/chef/modernize/default_action_initializer.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,17 +42,17 @@ module RuboCop
 
           MSG = 'The default action of a resource can be set with the "default_action" helper instead of using the initialize method.'.freeze
 
-          def_node_matcher :action_in_initializer?, <<-PATTERN
-            (def :initialize (args ...) <(begin ... $(ivasgn {:@action :@default_action} $(...)))> )
+          def_node_matcher :action_variable_assignment?, <<-PATTERN
+            (ivasgn {:@action :@default_action} $(...))
           PATTERN
 
           def_node_search :intialize_method, '(def :initialize ... )'
 
           def_node_search :default_action_method?, '(send nil? :default_action ... )'
 
-          def on_def(node)
-            action_in_initializer?(node) do |action, _val|
-              add_offense(action, location: :expression, message: MSG, severity: :refactor)
+          def on_ivasgn(node)
+            action_variable_assignment?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if intialize_method(node.parent.parent)
             end
           end
 

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Use the windows_feature resource built into Chef Infra Client 15+ instead of the powershell_script resource
+        # Use the windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource
         # to run Install-WindowsFeature or Add-WindowsFeature
         #
         # @example
@@ -38,9 +38,9 @@ module RuboCop
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
-          minimum_target_chef_version '13.0'
+          minimum_target_chef_version '14.0'
 
-          MSG = 'Use the windows_feature resource built into Chef Infra Client 13+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'.freeze
+          MSG = 'Use the windows_feature resource built into Chef Infra Client 14+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'.freeze
 
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|

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/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/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/redundant/unnecessary_name_property.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");
@@ -25,23 +25,42 @@ module RuboCop
         #   # bad
         #   property :name, String
         #   property :name, String, name_property: true
-        #   attribute :name, String
-        #   attribute :name, String, name_attribute: true
+        #   attribute :name, kind_of: String
+        #   attribute :name, kind_of: String, name_attribute: true
         #
         class UnnecessaryNameProperty < Cop
           MSG = 'There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.'.freeze
 
-          # match on a property/attribute named :name that's a string. The property/attribute optionally
-          # set name_property/name_attribute true, but nothing else is allowed. If you're doing that it's
-          # no longer the default and your usage is fine.
+          def_node_matcher :name_attribute?, <<-PATTERN
+          (send nil? :attribute
+            (sym :name)
+            (hash
+              (pair
+                (sym :kind_of)
+                (const nil? :String))
+              (pair
+                (sym :name_attribute)
+                (true))?))
+          PATTERN
+
           def_node_matcher :name_property?, <<-PATTERN
-            (send nil? {:property :attribute} (sym :name) (const nil? :String) (hash (pair (sym {:name_attribute :name_property}) (true)))?)
+            (send nil? :property
+              (sym :name)
+              (const nil? :String)
+              (hash
+                (pair
+                  (sym :name_property)
+                  (true)))?)
           PATTERN
 
           def on_send(node)
             name_property?(node) do
               add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
+
+            name_attribute?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
 
           def autocorrect(node)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.22.6
+  version: 5.23.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop