cookstyle 6.17.7 → 6.20.2

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.17.7" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.90.0'
+  VERSION = "6.20.2" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.93.1'
 end

data/lib/rubocop/cop/chef/correctness/block_guard_clause_string_only.rb

@@ -50,7 +50,7 @@ module RuboCop
             block_guard_with_only_string?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 new_val = "#{node.method_name} #{node.body.source}"
-                corrector.replace(node.loc.expression, new_val)
+                corrector.replace(node, new_val)
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/chef_application_fatal.rb

@@ -33,6 +33,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal'
+          RESTRICT_ON_SEND = [:fatal!].freeze
 
           def_node_matcher :application_fatal?, <<-PATTERN
             (send
@@ -44,7 +45,7 @@ module RuboCop
           def on_send(node)
             application_fatal?(node) do |val|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "raise(#{val.source})")
+                corrector.replace(node, "raise(#{val.source})")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb

@@ -58,7 +58,7 @@ module RuboCop
           def on_block(node)
             conditional_shellout?(node) do |type, val|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "#{type} #{val.source}")
+                corrector.replace(node, "#{type} #{val.source}")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb

@@ -37,52 +37,34 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'
+          RESTRICT_ON_SEND = [:send, :include].freeze
 
-          def_node_search :correct_send?, <<-PATTERN
-            (send
-              (const
-                (const
-                  (const {cbase nil?} :Chef) :DSL) :Recipe) :send
-              (sym :include)
-            ... )
+          def_node_search :correct_injection?, <<-PATTERN
+            {(send
+               (const
+                 (const
+                   (const {cbase nil?} :Chef) :DSL) :Recipe) :send
+               (sym :include)
+             ... )
+             (send
+               (const
+                 (const
+                   (const {cbase nil?} :Chef) :DSL) :Recipe) :include
+             ... )}
           PATTERN
 
-          def_node_search :correct_include?, <<-PATTERN
-          (send
-            (const
-              (const
-                (const {cbase nil?} :Chef) :DSL) :Recipe) :include
-          ... )
+          def_node_matcher :legacy_injection?, <<-PATTERN
+            {(send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :send (sym :include) ... )
+             (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :include ... )}
           PATTERN
 
-          def_node_matcher :legacy_class_sends?, <<-PATTERN
-            (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :send (sym :include) ... )
-          PATTERN
-
-          def_node_matcher :legacy_class_include?, <<-PATTERN
-            (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :include ... )
-          PATTERN
-
-          # @todo: This is highly repetitive and could be simplified into a single node_matcher
-          # call with some matcher magic that should be figured out
           def on_send(node)
-            legacy_class_sends?(node) do
-              add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                if node.parent && correct_send?(node.parent)
-                  corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-                else
-                  corrector.replace(node.loc.expression,
-                    node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
-                end
-              end
-            end
-
-            legacy_class_include?(node) do
+            legacy_injection?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                if node.parent && correct_include?(node.parent)
+                if node.parent && correct_injection?(node.parent)
                   corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
                 else
-                  corrector.replace(node.loc.expression,
+                  corrector.replace(node,
                     node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
                 end
               end

data/lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb

@@ -56,7 +56,7 @@ module RuboCop
                       range = range_with_surrounding_comma(range_with_surrounding_space(range: con.loc.expression, side: :left), :both)
                       corrector.remove(range)
                     else
-                      corrector.replace(con.loc.expression, "'#{new_value}'")
+                      corrector.replace(con, "'#{new_value}'")
                     end
                   end
                 end

data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb

@@ -56,7 +56,7 @@ module RuboCop
               add_offense(plat, message: MSG, severity: :refactor) do |corrector|
                 correct_string = corrected_platform_source(plat)
                 next unless correct_string
-                corrector.replace(plat.loc.expression, correct_string)
+                corrector.replace(plat, correct_string)
               end
             end
           end
@@ -68,7 +68,7 @@ module RuboCop
                 add_offense(plat, message: MSG, severity: :refactor) do |corrector|
                   correct_string = corrected_platform_source(plat)
                   next unless correct_string
-                  corrector.replace(plat.loc.expression, correct_string)
+                  corrector.replace(plat, correct_string)
                 end
               end
             end

data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb

@@ -35,6 +35,7 @@ module RuboCop
           include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'Use valid platform values in case statements.'
+          RESTRICT_ON_SEND = [:[]].freeze
 
           def_node_matcher :node_platform?, <<-PATTERN
             (send (send nil? :node) :[] (str "platform") )
@@ -55,7 +56,7 @@ module RuboCop
                       range = range_with_surrounding_comma(range_with_surrounding_space(range: con.loc.expression, side: :left), :both)
                       corrector.remove(range)
                     else
-                      corrector.replace(con.loc.expression, "'#{new_value}'")
+                      corrector.replace(con, "'#{new_value}'")
                     end
                   end
                 end

data/lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb

@@ -32,6 +32,7 @@ module RuboCop
         #
         class InvalidVersionMetadata < Base
           MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'
+          RESTRICT_ON_SEND = [:version].freeze
 
           def_node_matcher :version?, '(send nil? :version $str ...)'
 

data/lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb

@@ -43,7 +43,7 @@ module RuboCop
           def on_send(node)
             non_lazy_node_attribute_default?(node) do |default|
               add_offense(default, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(default.loc.expression, "lazy { #{default.loc.expression.source} }")
+                corrector.replace(default, "lazy { #{default.source} }")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 ChefCorrectness
+        # Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
+        #
+        # @example
+        #
+        #   # bad
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if { lazy { ::File.exist?('/etc/foo')} }
+        #   end
+        #
+        #   # good
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if { ::File.exist?('/etc/foo') }
+        #   end
+        #
+        class LazyInResourceGuard < Base
+          extend AutoCorrector
+
+          MSG = 'Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.'
+
+          def_node_matcher :lazy_in_guard?, <<-PATTERN
+            (block
+              (send nil? ${:not_if :only_if})
+              (args)
+              (block
+                (send nil? :lazy)
+                (args)
+                $(...)
+             ))
+          PATTERN
+
+          def on_block(node)
+            lazy_in_guard?(node) do |type, code|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "#{type} { #{code.source} }")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb

@@ -54,9 +54,9 @@ module RuboCop
             match_property_in_resource?(:macos_userdefaults, 'type', node) do |type|
               type_val = method_arg_ast_to_string(type)
               return if VALID_VALUES.include?(type_val)
-              add_offense(type.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(type, message: MSG, severity: :refactor) do |corrector|
                 next unless INVALID_VALUE_MAP[type_val]
-                corrector.replace(type.loc.expression, "type '#{INVALID_VALUE_MAP[type_val]}'")
+                corrector.replace(type, "type '#{INVALID_VALUE_MAP[type_val]}'")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/node_normal.rb

@@ -39,6 +39,7 @@ module RuboCop
         #
         class NodeNormal < Base
           MSG = 'Do not use node.normal. Replace with default/override/force_default/force_override attribute levels.'
+          RESTRICT_ON_SEND = [:normal].freeze
 
           def_node_matcher :node_normal?, <<-PATTERN
             (send (send _ :node) :normal)

data/lib/rubocop/cop/chef/correctness/node_normal_unless.rb

@@ -39,6 +39,7 @@ module RuboCop
         #
         class NodeNormalUnless < Base
           MSG = 'Do not use node.normal_unless. Replace with default/override/force_default/force_override attribute levels.'
+          RESTRICT_ON_SEND = [:normal_unless].freeze
 
           def_node_matcher :node_normal_unless?, <<-PATTERN
             (send (send _ :node) :normal_unless)

data/lib/rubocop/cop/chef/correctness/node_save.rb

@@ -30,6 +30,7 @@ module RuboCop
         #
         class CookbookUsesNodeSave < Base
           MSG = "Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
+          RESTRICT_ON_SEND = [:save].freeze
 
           def_node_matcher :node_save?, <<-PATTERN
             (send (send nil? :node) :save)

data/lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb

@@ -53,7 +53,7 @@ module RuboCop
               return unless notifies_property.node_parts[2].str_type?
 
               add_offense(notifies_property, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(notifies_property.first_argument.loc.expression,
+                corrector.replace(notifies_property.first_argument,
                   ":#{notifies_property.node_parts[2].value}")
               end
             end

data/lib/rubocop/cop/chef/correctness/property_without_type.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 ChefCorrectness
+        # Resource properties or attributes should always define a type to help users understand the correct allowed values.
+        #
+        # @example
+        #
+        #   # bad
+        #   property :size, regex: /^\d+[KMGTP]$/
+        #   attribute :size, regex: /^\d+[KMGTP]$/
+        #
+        #   # good
+        #   property :size, String, regex: /^\d+[KMGTP]$/
+        #   attribute :size, kind_of: String, regex: /^\d+[KMGTP]$/
+        #
+        class PropertyWithoutType < Base
+          MSG = 'Resource properties or attributes should always define a type to help users understand the correct allowed values.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          def_node_matcher :property_without_type?, <<-PATTERN
+          (send nil? {:property :attribute}
+            (sym _)
+            $(hash
+
+              ...
+            )?
+          )
+          PATTERN
+
+          def on_send(node)
+            property_without_type?(node) do |hash_vals|
+              return if hash_vals&.first&.keys&.include?(s(:sym, :kind_of))
+
+              add_offense(node, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/resource_with_none_action.rb

@@ -45,7 +45,7 @@ module RuboCop
               action_node.arguments.each do |action|
                 next unless action.source == ':none'
                 add_offense(action, message: MSG, severity: :refactor) do |corrector|
-                  corrector.replace(action.loc.expression, ':nothing')
+                  corrector.replace(action, ':nothing')
                 end
               end
             end

data/lib/rubocop/cop/chef/correctness/scoped_file_exist.rb

@@ -41,7 +41,7 @@ module RuboCop
           def on_block(node)
             unscoped_file_exist?(node) do |m|
               add_offense(m, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(m.loc.expression, '::File')
+                corrector.replace(m, '::File')
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb

@@ -41,8 +41,8 @@ module RuboCop
           def on_send(node)
             supports_with_constraint?(node) do |ver|
               return if ver.source.include?('.')
-              add_offense(ver.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(ver.loc.expression, ver.source.gsub(ver.value, (ver.value + '.0')))
+              add_offense(ver, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(ver, ver.source.gsub(ver.value, (ver.value + '.0')))
               end
             end
           end

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

@@ -45,7 +45,7 @@ module RuboCop
               add_offense(prop_node, message: MSG, severity: :warning) do |corrector|
                 # make sure to delete leading and trailing {}s that would create invalid ruby syntax
                 extracted_val = prop_node.arguments.first.source.gsub(/{|}/, '')
-                corrector.replace(prop_node.loc.expression, "type #{extracted_val}")
+                corrector.replace(prop_node, "type #{extracted_val}")
               end
             end
           end

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

@@ -79,7 +79,7 @@ module RuboCop
 
             rewind_resources?(node) do |string|
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, node.source.gsub(string.to_s, MAPPING[string]))
+                corrector.replace(node, node.source.gsub(string.to_s, MAPPING[string]))
               end
             end
           end
@@ -88,7 +88,7 @@ module RuboCop
             match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
               next unless pkg_name.arguments&.first&.str_content == 'chef-rewind'
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.remove(node.loc.expression) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
+                corrector.remove(node) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
               end
             end
           end

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

@@ -41,7 +41,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically."
-          # RESTRICT_ON_SEND = [:new, :require, :include].freeze
+          RESTRICT_ON_SEND = [:new, :require, :include].freeze
 
           def_node_matcher :include_shellout?, <<-PATTERN
           (send nil? :include
@@ -75,7 +75,7 @@ module RuboCop
 
             shellout_new?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
+                corrector.replace(node, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
               end
             end
           end

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

@@ -33,6 +33,7 @@ module RuboCop
         class ChefWindowsPlatformHelper < Base
           extend AutoCorrector
           MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper."
+          RESTRICT_ON_SEND = [:windows?].freeze
 
           def_node_matcher :chef_platform_windows?, <<-PATTERN
             (send
@@ -43,7 +44,7 @@ module RuboCop
           def on_send(node)
             chef_platform_windows?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, "platform?('windows')")
+                corrector.replace(node, "platform?('windows')")
               end
             end
           end