cookstyle 7.28.2 → 7.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 205f14a7f600dc2fe712e9407e16165b72cadab5624913efba78a6f0748f65ae
-  data.tar.gz: c03813392f90967e5036e49a8886d6c1b7e31ea7319da75c12008d3a01c635f8
+  metadata.gz: af05586e951fed9a9a11777583d2f8b0ec7634cca38b3b5b9641e2afb11be50b
+  data.tar.gz: 8d727e0f4898bf20149fa74ee6d15782840577c98eeb9fe25048ae71ab13c4b1
 SHA512:
-  metadata.gz: 6f7f8c8c719dbb83b740882be2f247250c95fb7f330a82a0cf8d7b5b96fa7071ca7b55761a8a599ac4801f2c75eb403f64c04bde4245f31fc12b8f753418d3f5
-  data.tar.gz: 8a32adeedb7654948337162eeb9a8c660f66ab13655ec537aa584b15a156f726130f16630dddb2f1fa0169d10e5dd4a84b7353392591431490f12129ed0245c4
+  metadata.gz: dbd9a0129be207bd120c0ba860260726c4547b8e0356eda5c221b70d29aaf9ec92fdce5af7450b919f8a74774b79820c128220749e883c226de4c82f45c21915
+  data.tar.gz: 74e57634c9aef93e952858a542cac3966c849fa3e1deb2dd5b0ef4b7cd9f8167eba767e55635b72c2cbc7f3d08228a3fed26ed4f2e072e4eb6d8c78a09c3b151

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.28.2" # rubocop: disable Style/StringLiterals
+  VERSION = "7.30.1" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.24.1'
 end

data/lib/rubocop/chef/cookbook_helpers.rb

@@ -111,6 +111,8 @@ module RuboCop
         case node.type
         when :send
           yield(node) if node.receiver.nil? # if it's not nil then we're not in a property foo we're in bar.foo
+        when :block # ie: not_if { ruby_foo }
+          yield(node)
         when :while
           extract_send_types(node.body) { |t| yield(t) }
         when :if

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright:: 2019, Chef Software, Inc.
+# Copyright:: 2019-2022, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,6 +26,7 @@ module RuboCop
         #   #### incorrect
         #   depends 'poise'
         #   depends 'poise-service'
+        #   depends 'poise-hoist'
         #
         class CookbookDependsOnPoise < Base
           MSG = 'Cookbooks should not depend on the deprecated Poise framework'
@@ -37,7 +38,7 @@ module RuboCop
 
           def on_send(node)
             depends_method?(node) do |arg|
-              add_offense(node, message: MSG, severity: :warning) if %w(poise poise-service).include?(arg.value)
+              add_offense(node, message: MSG, severity: :warning) if %w(poise poise-service poise-hoist).include?(arg.value)
             end
           end
         end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright:: 2020, Chef Software, Inc.
+# Copyright:: 2020-2022, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module RedundantCode
-        # Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.
+        # Use the `:create_if_missing` action instead of `not_if` with a `::File.exist(FOO)` check.
         #
         # @example
         #
@@ -32,6 +32,15 @@ module RuboCop
         #     not_if { ::File.exists?('/logs/foo/error.log') }
         #   end
         #
+        #   remote_file 'Download file' do
+        #     path '/foo/bar'
+        #     source 'https://foo.com/bar'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '0644'
+        #     not_if { ::File.exist?('/foo/bar') }
+        #   end
+        #
         #   #### correct
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
@@ -41,30 +50,61 @@ module RuboCop
         #     action :create_if_missing
         #   end
         #
+        #   remote_file 'Download file' do
+        #     path '/foo/bar'
+        #     source 'https://foo.com/bar'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '0644'
+        #     action :create_if_missing
+        #   end
+        #
         class UseCreateIfMissing < Base
           include RuboCop::Chef::CookbookHelpers
           extend AutoCorrector
+          include RangeHelp
 
           MSG = 'Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.'
+          RESOURCES = %i(cookbook_file file remote_directory cron_d remote_file template).freeze
 
-          def_node_matcher :not_if_file_exist?, <<-PATTERN
-          (block (send nil? :not_if) (args) (send (const {nil? (cbase)} :File) {:exist? :exists?} $(str ...)))
+          def_node_matcher :file_exist_value, <<-PATTERN
+          (send (const {nil? (cbase)} :File) {:exist? :exists?} $(...))
           PATTERN
 
-          def_node_matcher :file_like_resource?, <<-PATTERN
-          (block (send nil? {:cookbook_file :file :remote_directory :cron_d :remote_file :template} $str) ... )
-          PATTERN
+          def_node_search :has_action?, '(send nil? :action ...)'
 
-          def_node_search :create_action?, '(send nil? :action $sym)'
+          def_node_search :create_action, '(send nil? :action $sym)'
+
+          def_node_search :path_property_node, '(send nil? :path $...)'
 
           def on_block(node)
-            not_if_file_exist?(node) do |props|
-              file_like_resource?(node.parent.parent) do |resource_blk_name|
-                # the not_if file name is the same as the resource name and there's no action defined (it's the default)
-                return unless props == resource_blk_name && create_action?(node.parent.parent).nil?
+            match_property_in_resource?(RESOURCES, :not_if, node) do |prop|
+              # if it's not a block type then it's not a ruby block with a file.exist
+              return unless prop.block_type?
+
+              file_exist_value(prop.body) do |exists_content| # check the contents of the ruby block that's passed
+                # not an offense if:
+                #   - The resource block name (the last arg of the send) doesn't match the exists check content
+                #   - If a path property is used it doesn't match the exists check content
+                return unless exists_content == node.send_node.last_argument ||
+                              exists_content == path_property_node(node)&.first&.first
+
+                # we have an action so check if it is :create. If that's the case we can replace that value
+                # and delete the not_if line. Otherwise it's an action like :remove and while the whole resource
+                # no longer makes sense that's not our problem here.
+                create_action(node) do |create_action|
+                  return unless create_action == s(:sym, :create)
+                  add_offense(prop, message: MSG, severity: :refactor) do |corrector|
+                    corrector.replace(create_action, ':create_if_missing')
+                    corrector.remove(range_by_whole_lines(prop.source_range, include_final_newline: true))
+                  end
+                  return
+                end
 
-                add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                  corrector.replace(node, 'action :create_if_missing')
+                # if we got this far we didn't return above when we had an action
+                # so we can just replace the not_if line with a new :create_if_missing action
+                add_offense(prop, message: MSG, severity: :refactor) do |corrector|
+                  corrector.replace(prop, 'action :create_if_missing')
                 end
               end
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.28.2
+  version: 7.30.1
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop