cookstyle 6.13.3 → 6.16.4

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

@@ -35,7 +35,7 @@ module RuboCop
         #     %w(mac_os_x) => 'foo'
         #   )
         #
-        class InvalidPlatformValueForPlatformFamilyHelper < Cop
+        class InvalidPlatformValueForPlatformFamilyHelper < Base
           include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'Pass valid platform families to the value_for_platform_family helper.'
@@ -53,10 +53,11 @@ module RuboCop
               plats.each do |p_hash|
                 if p_hash.key.array_type?
                   p_hash.key.values.each do |plat|
-                    add_offense(plat, location: :expression, message: MSG, severity: :refactor) if INVALID_PLATFORM_FAMILIES.key?(plat.value)
+                    next unless INVALID_PLATFORM_FAMILIES.key?(plat.value)
+                    add_offense(plat, message: MSG, severity: :refactor)
                   end
                 elsif INVALID_PLATFORM_FAMILIES.key?(p_hash.key.value)
-                  add_offense(p_hash.key, location: :expression, message: MSG, severity: :refactor)
+                  add_offense(p_hash.key, message: MSG, severity: :refactor)
                 end
               end
             end

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

@@ -34,7 +34,7 @@ module RuboCop
         #     %w(opensuseleap) => { 'default' => 'bar' }
         #   )
         #
-        class InvalidPlatformValueForPlatformHelper < Cop
+        class InvalidPlatformValueForPlatformHelper < Base
           include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'Pass valid platforms to the value_for_platform helper.'
@@ -52,10 +52,11 @@ module RuboCop
               plats.each do |p_hash|
                 if p_hash.key.array_type?
                   p_hash.key.values.each do |plat|
-                    add_offense(plat, location: :expression, message: MSG, severity: :refactor) if INVALID_PLATFORMS.key?(plat.value)
+                    next unless INVALID_PLATFORMS.key?(plat.value)
+                    add_offense(plat, message: MSG, severity: :refactor)
                   end
                 elsif INVALID_PLATFORMS.key?(p_hash.key.value)
-                  add_offense(p_hash.key, location: :expression, message: MSG, severity: :refactor)
+                  add_offense(p_hash.key, message: MSG, severity: :refactor)
                 end
               end
             end

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

@@ -30,16 +30,15 @@ module RuboCop
         #   # good
         #   version '1.2.3'
         #
-        class InvalidVersionMetadata < Cop
+        class InvalidVersionMetadata < Base
           MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'
 
           def_node_matcher :version?, '(send nil? :version $str ...)'
 
           def on_send(node)
             version?(node) do |ver|
-              unless /\A\d+\.\d+(\.\d+)?\z/.match?(ver.value) # entirely borrowed from Foodcritic.
-                add_offense(ver, location: :expression, message: MSG, severity: :refactor)
-              end
+              next if /\A\d+\.\d+(\.\d+)?\z/.match?(ver.value) # entirely borrowed from Foodcritic.
+              add_offense(ver, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -30,7 +30,8 @@ module RuboCop
         #   # good
         #   property :Something, String, default: lazy { node['hostname'] }
         #
-        class LazyEvalNodeAttributeDefaults < Cop
+        class LazyEvalNodeAttributeDefaults < Base
+          extend AutoCorrector
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'When setting a node attribute as the default value for a custom resource property, wrap the node attribute in `lazy {}` so that its value is available when the resource executes.'
@@ -41,13 +42,9 @@ module RuboCop
 
           def on_send(node)
             non_lazy_node_attribute_default?(node) do |default|
-              add_offense(default, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "lazy { #{node.loc.expression.source} }")
+              add_offense(default, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(default.loc.expression, "lazy { #{default.loc.expression.source} }")
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.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
+        # The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are: "array", "bool", "dict", "float", "int", and "string".
+        #
+        # @example
+        #
+        #   # bad
+        #   macos_userdefaults 'set a value' do
+        #     global true
+        #     key 'key'
+        #     type 'boolean'
+        #   end
+        #
+        #   # good
+        #   macos_userdefaults 'set a value' do
+        #     global true
+        #     key 'key'
+        #     type 'bool'
+        #   end
+        #
+        class MacosUserdefaultsInvalidType < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend RuboCop::Cop::AutoCorrector
+
+          VALID_VALUES = %w(array bool dict float int string).freeze
+          INVALID_VALUE_MAP = {
+            'boolean' => 'bool',
+            'str' => 'string',
+            'integer' => 'int',
+          }.freeze
+
+          MSG = 'The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are: "array", "bool", "dict", "float", "int", and "string".'
+
+          def on_block(node)
+            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|
+                next unless INVALID_VALUE_MAP[type_val]
+                corrector.replace(type.loc.expression, "type '#{INVALID_VALUE_MAP[type_val]}'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -44,20 +44,19 @@ module RuboCop
         #     'default' => 'bar'
         #   )
         #
-        class MalformedPlatformValueForPlatformHelper < Cop
+        class MalformedPlatformValueForPlatformHelper < Base
           def on_send(node)
             return unless node.method_name == :value_for_platform
 
             if node.arguments.count > 1
               msg = 'Malformed value_for_platform helper argument. The value_for_platform helper takes a single hash of platforms as an argument.'
-              add_offense(node, location: :expression, message: msg, severity: :refactor)
+              add_offense(node, message: msg, severity: :refactor)
             elsif node.arguments.first.hash_type? # if it's a variable we can't check what's in that variable so skip
               msg = "Malformed value_for_platform helper argument. The value for each platform in your hash must be a hash of either platform version strings or a value with a key of 'default'"
               node.arguments.first.each_pair do |plats, plat_vals|
                 # instead of a platform the hash key can be default with a value of anything. Depending on the hash format this is a string or symbol
-                unless plat_vals.hash_type? || plats == s(:str, 'default') || plats == s(:sym, :default)
-                  add_offense(plat_vals, location: :expression, message: msg, severity: :refactor)
-                end
+                next if plat_vals.hash_type? || plats == s(:str, 'default') || plats == s(:sym, :default)
+                add_offense(plat_vals, message: msg, severity: :refactor)
               end
             end
           end

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

@@ -27,27 +27,20 @@ module RuboCop
       #   name 'foo'
       #
       module ChefCorrectness
-        class MetadataMissingName < Cop
+        class MetadataMissingName < Base
           include RangeHelp
 
           MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'
 
-          def investigate(processed_source)
-            return if processed_source.blank?
+          def_node_search :cb_name, '(send nil? :name str ...)'
 
+          def on_new_investigation
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            return if cb_name(processed_source.ast).any?
             range = source_range(processed_source.buffer, 1, 0)
-
-            add_offense(nil, location: range, message: MSG, severity: :refactor) unless cb_name(processed_source.ast).any?
-          end
-
-          def_node_search :cb_name, '(send nil? :name str ...)'
-
-          def autocorrect(_node)
-            lambda do |_corrector|
+            add_offense(range, message: MSG, severity: :refactor) do |_corrector|
               path = processed_source.path
               cb_name = File.basename(File.dirname(path))
-
               metadata = IO.read(path)
               IO.write(path, "name '#{cb_name}'\n" + metadata)
             end

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

@@ -37,7 +37,7 @@ module RuboCop
         #   node.force_default['foo'] = true
         #   node.force_override['foo'] = true
         #
-        class NodeNormal < Cop
+        class NodeNormal < Base
           MSG = 'Do not use node.normal. Replace with default/override/force_default/force_override attribute levels.'
 
           def_node_matcher :node_normal?, <<-PATTERN
@@ -46,7 +46,7 @@ module RuboCop
 
           def on_send(node)
             node_normal?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -37,7 +37,7 @@ module RuboCop
         #   node.force_default_unless['foo'] = true
         #   node.force_override_unless['foo'] = true
         #
-        class NodeNormalUnless < Cop
+        class NodeNormalUnless < Base
           MSG = 'Do not use node.normal_unless. Replace with default/override/force_default/force_override attribute levels.'
 
           def_node_matcher :node_normal_unless?, <<-PATTERN
@@ -46,7 +46,7 @@ module RuboCop
 
           def on_send(node)
             node_normal_unless?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -28,7 +28,7 @@ module RuboCop
         #   # bad
         #   node.save
         #
-        class CookbookUsesNodeSave < Cop
+        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."
 
           def_node_matcher :node_save?, <<-PATTERN
@@ -37,7 +37,7 @@ module RuboCop
 
           def on_send(node)
             node_save?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -25,37 +25,37 @@ module RuboCop
         # @example
         #
         #   # bad
-        #   execute 'some commmand' do
+        #   execute 'some command' do
         #     notifies 'restart', 'service[httpd]', 'delayed'
         #   end
         #
-        #   execute 'some commmand' do
+        #   execute 'some command' do
         #     subscribes 'restart', 'service[httpd]', 'delayed'
         #   end
         #
         #   # good
-        #   execute 'some commmand' do
+        #   execute 'some command' do
         #     notifies :restart, 'service[httpd]', 'delayed'
         #   end
         #
-        #   execute 'some commmand' do
+        #   execute 'some command' do
         #     subscribes :restart, 'service[httpd]', 'delayed'
         #   end
         #
-        class NotifiesActionNotSymbol < Cop
+        class NotifiesActionNotSymbol < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = 'Resource notification and subscription actions should be symbols not strings.'
 
           def on_block(node)
             match_property_in_resource?(nil, %w(notifies subscribes), node) do |notifies_property|
-              add_offense(notifies_property, location: :expression, message: MSG, severity: :refactor) if notifies_property.node_parts[2].str_type?
-            end
-          end
+              return unless notifies_property.node_parts[2].str_type?
 
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.first_argument.loc.expression, ":#{node.node_parts[2].value}")
+              add_offense(notifies_property, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(notifies_property.first_argument.loc.expression,
+                  ":#{notifies_property.node_parts[2].value}")
+              end
             end
           end
         end

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

@@ -25,7 +25,7 @@ module RuboCop
         #   ::Chef::Recipe.send(:include, Opscode::OpenSSL::Password)
         #   basic_auth_password = secure_password
         #
-        class OpenSSLPasswordHelpers < Cop
+        class OpenSSLPasswordHelpers < Base
           MSG = 'The `secure_password` helper from the openssl cookbooks `Opscode::OpenSSL::Password` class should not be used to generate passwords.'
 
           def_node_matcher :openssl_helper?, <<~PATTERN
@@ -36,7 +36,7 @@ module RuboCop
 
           def on_const(node)
             openssl_helper?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -34,7 +34,7 @@ module RuboCop
         #    action :delete
         #  end
         #
-        class PowershellScriptDeleteFile < Cop
+        class PowershellScriptDeleteFile < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource'
@@ -42,9 +42,9 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
               property_data = method_arg_ast_to_string(code_property)
-              if property_data && property_data.match?(/^remove-item/i) && !property_data.include?('*')
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/^remove-item/i) &&
+                            !property_data.include?('*')
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -36,14 +36,14 @@ module RuboCop
         #     action [:start, :enable]
         #   end
         #
-        class ResourceSetsInternalProperties < Cop
+        class ResourceSetsInternalProperties < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'Do not set properties used internally by Chef Infra Client to track the system state.'
 
           def on_block(node)
             match_property_in_resource?(:service, 'running', node) do |prop|
-              add_offense(prop, location: :expression, message: MSG, severity: :refactor)
+              add_offense(prop, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -35,14 +35,14 @@ module RuboCop
         #    service_name 'bar'
         #   end
         #
-        class ResourceSetsNameProperty < Cop
+        class ResourceSetsNameProperty < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'Resource sets the name property in the resource instead of using a name_property.'
 
           def on_block(node)
             match_property_in_resource?(nil, 'name', node) do |name_node|
-              add_offense(name_node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(name_node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -34,15 +34,19 @@ module RuboCop
         #    action :nothing
         #   end
         #
-        class ResourceWithNoneAction < Cop
+        class ResourceWithNoneAction < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = 'Resource uses the nonexistent :none action instead of the :nothing action'
 
           def on_block(node)
             match_property_in_resource?(nil, 'action', node) do |action_node|
               action_node.arguments.each do |action|
-                add_offense(action, location: :expression, message: MSG, severity: :refactor) if action.source == ':none'
+                next unless action.source == ':none'
+                add_offense(action, message: MSG, severity: :refactor) do |corrector|
+                  corrector.replace(action.loc.expression, ':nothing')
+                end
               end
             end
           end

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

@@ -29,7 +29,9 @@ module RuboCop
         #   # good
         #   not_if { ::File.exist?('/etc/foo/bar') }
         #
-        class ScopedFileExist < Cop
+        class ScopedFileExist < Base
+          extend AutoCorrector
+
           MSG = 'Scope file exist to access the correct File class by using ::File.exist? not File.exist?.'
 
           def_node_matcher :unscoped_file_exist?, <<-PATTERN
@@ -38,13 +40,9 @@ module RuboCop
 
           def on_block(node)
             unscoped_file_exist?(node) do |m|
-              add_offense(m, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, '::File')
+              add_offense(m, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(m.loc.expression, '::File')
+              end
             end
           end
         end