cookstyle 6.10.2 → 6.15.3

data/cookstyle.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cookstyle/version'
@@ -10,6 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['thom@chef.io', 'tsmith@chef.io']
   spec.summary       = 'Cookstyle is a code linting tool that helps you to write better Chef Infra cookbooks by detecting and automatically correcting style, syntax, and logic mistakes in your code.'
   spec.license       = 'Apache-2.0'
+  spec.homepage      = 'https://docs.chef.io/workstation/cookstyle/'
   spec.required_ruby_version = '>= 2.4'
 
   # the gemspec and Gemfile are necessary for appbundling of the gem

data/lib/cookstyle.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'cookstyle/version'
 
 require 'pathname'
@@ -6,13 +7,13 @@ require 'yaml'
 # ensure the desired target version of RuboCop is gem activated
 gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
 require 'rubocop'
-require 'rubocop/monkey_patches/comment_config.rb'
+require_relative 'rubocop/monkey_patches/comment_config.rb'
 
 # monkey patches needed for the TargetChefVersion config option
-require 'rubocop/monkey_patches/config.rb'
-require 'rubocop/monkey_patches/cop.rb'
-require 'rubocop/monkey_patches/team.rb'
-require 'rubocop/monkey_patches/registry_cop.rb'
+require_relative 'rubocop/monkey_patches/config.rb'
+require_relative 'rubocop/monkey_patches/base.rb'
+require_relative 'rubocop/monkey_patches/team.rb'
+require_relative 'rubocop/monkey_patches/registry_cop.rb'
 
 module RuboCop
   class ConfigLoader

data/lib/cookstyle/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.10.2".freeze # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.86.0'.freeze
+  VERSION = "6.15.3" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.89.1'
 end

data/lib/rubocop/chef.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RuboCop
   # RuboCop Chef project namespace
   module Chef

data/lib/rubocop/chef/autocorrect_helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)

data/lib/rubocop/chef/cookbook_helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)

data/lib/rubocop/chef/platform_helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -37,7 +38,7 @@ module RuboCop
         #   end
         #
         class BlockGuardWithOnlyString < Cop
-          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it be executed as Ruby code which will always returns true instead of a shell command that will actually run.'.freeze
+          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it be executed as Ruby code which will always returns true instead of a shell command that will actually run.'
 
           def_node_matcher :block_guard_with_only_string?, <<-PATTERN
             (block (send nil? ${:not_if :only_if}) (args) (str $_) )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         class CookbooksDependsOnSelf < Cop
           include RangeHelp
 
-          MSG = 'A cookbook cannot depend on itself. This will fail on Chef Infra Client 13+'.freeze
+          MSG = 'A cookbook cannot depend on itself. This will fail on Chef Infra Client 13+'
 
           def_node_search :dependencies, '(send nil? :depends str ...)'
           def_node_matcher :cb_name?, '(send nil? :name str ...)'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   raise "Something horrible happened!"
         #
         class ChefApplicationFatal < Cop
-          MSG = 'Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal'.freeze
+          MSG = 'Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal'
 
           def_node_matcher :application_fatal?, <<-PATTERN
             (send

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -41,7 +42,7 @@ module RuboCop
         #
         class ConditionalRubyShellout < Cop
           include RuboCop::Chef::CookbookHelpers
-          MSG = "Don't use Ruby to shellout in an only_if / not_if conditional when you can shellout directly by wrapping the command in quotes.".freeze
+          MSG = "Don't use Ruby to shellout in an only_if / not_if conditional when you can shellout directly by wrapping the command in quotes."
 
           def_node_matcher :conditional_shellout?, <<-PATTERN
           (block

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -37,7 +38,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'dnf_package does not support the allow_downgrades property'.freeze
+          MSG = 'dnf_package does not support the allow_downgrades property'
 
           def on_block(node)
             match_property_in_resource?(:dnf_package, :allow_downgrades, node) do |prop|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -25,21 +26,31 @@ module RuboCop
         #   # bad
         #   ::Chef::Recipe.send(:include, Filebeat::Helpers)
         #   ::Chef::Provider.send(:include, Filebeat::Helpers)
+        #   ::Chef::Recipe.include Filebeat::Helpers
+        #   ::Chef::Provider.include Filebeat::Helpers
         #
         #   # good
         #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
         #
         class IncorrectLibraryInjection < Cop
-          MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'.freeze
+          MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'
 
           def_node_matcher :legacy_class_sends?, <<-PATTERN
             (send (const (const (cbase) :Chef) {:Recipe :Provider}) :send (sym :include) ... )
           PATTERN
 
+          def_node_matcher :legacy_class_includes?, <<-PATTERN
+            (send (const (const (cbase) :Chef) {:Recipe :Provider}) :include ... )
+          PATTERN
+
           def on_send(node)
             legacy_class_sends?(node) do
               add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
+
+            legacy_class_includes?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
 
           def autocorrect(node)

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+# 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
+      # Default actions in resources should be symbols or an array of symbols.
+      #
+      # @example
+      #
+      #   # bad
+      #   default_action 'create'
+      #
+      #   # good
+      #   default_action :create
+      #
+      module ChefCorrectness
+        class InvalidDefaultAction < Cop
+          MSG = 'Default actions in resources should be symbols or an array of symbols.'
+
+          def_node_matcher :default_action?, '(send nil? :default_action $_)'
+
+          def on_send(node)
+            default_action?(node) do |match|
+              return if %i(send sym array).include?(match.type)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -35,7 +36,7 @@ module RuboCop
         #   end
         #
         class InvalidNotificationTiming < Cop
-          MSG = 'Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.'.freeze
+          MSG = 'Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.'
 
           def_node_matcher :notification_with_timing?, <<-PATTERN
             (send nil? {:notifies :subscribes} (sym _) (...) $(sym _))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,17 +33,40 @@ module RuboCop
         #
         class InvalidPlatformFamilyHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
+          include RangeHelp
 
-          MSG = 'Pass valid platform families to the platform_family? helper.'.freeze
+          MSG = 'Pass valid platform families to the platform_family? helper.'
 
           def_node_matcher :platform_family_helper?, <<-PATTERN
             (send nil? :platform_family? $str*)
           PATTERN
 
           def on_send(node)
-            platform_family_helper?(node) do |plat|
-              plat.to_a.each do |p|
-                add_offense(p, location: :expression, message: MSG, severity: :refactor) if INVALID_PLATFORM_FAMILIES.key?(p.value)
+            platform_family_helper?(node) do |plats|
+              plats.to_a.each do |p|
+                next unless INVALID_PLATFORM_FAMILIES.key?(p.value)
+                add_offense(p, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+
+          def autocorrect(node)
+            replacement_platform = INVALID_PLATFORM_FAMILIES[node.value]
+            all_passed_platforms = node.parent.arguments.map(&:value)
+
+            # see if we have a replacement platform in our hash. If not we can't autocorrect
+            if replacement_platform
+              # if the replacement platform was one of the other platforms passed we can just delete this bad platform
+              if all_passed_platforms.include?(replacement_platform)
+                all_passed_platforms.delete(node.value)
+                lambda do |corrector|
+                  arg_range = node.parent.arguments.first.loc.expression.join(node.parent.arguments[-1].loc.expression.end)
+                  corrector.replace(arg_range, all_passed_platforms.map { |x| "'#{x}'" }.join(', '))
+                end
+              else
+                lambda do |corrector|
+                  corrector.replace(node.loc.expression, node.value.gsub(node.value, "'#{replacement_platform}'")) # gsub to retain quotes
+                end
               end
             end
           end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
           include RangeHelp
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Use valid platform family values in case statements.'.freeze
+          MSG = 'Use valid platform family values in case statements.'
 
           def_node_matcher :node_platform_family?, <<-PATTERN
             (send (send nil? :node) :[] (str "platform_family") )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         class InvalidPlatformHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Pass valid platforms to the platform? helper.'.freeze
+          MSG = 'Pass valid platforms to the platform? helper.'
 
           def_node_matcher :platform_helper?, <<-PATTERN
             (send nil? :platform? $str*)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         class InvalidPlatformMetadata < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'metadata.rb "supports" platform is invalid'.freeze
+          MSG = 'metadata.rb "supports" platform is invalid'
 
           def_node_matcher :supports?, '(send nil? :supports $str ...)'
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
           include RangeHelp
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Use valid platform values in case statements.'.freeze
+          MSG = 'Use valid platform values in case statements.'
 
           def_node_matcher :node_platform?, <<-PATTERN
             (send (send nil? :node) :[] (str "platform") )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -37,7 +38,7 @@ module RuboCop
         class InvalidPlatformValueForPlatformFamilyHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Pass valid platform families to the value_for_platform_family helper.'.freeze
+          MSG = 'Pass valid platform families to the value_for_platform_family helper.'
 
           def_node_matcher :value_for_platform_family?, <<-PATTERN
           (send nil? :value_for_platform_family

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -36,7 +37,7 @@ module RuboCop
         class InvalidPlatformValueForPlatformHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          MSG = 'Pass valid platforms to the value_for_platform helper.'.freeze
+          MSG = 'Pass valid platforms to the value_for_platform helper.'
 
           def_node_matcher :value_for_platform?, <<-PATTERN
           (send nil? :value_for_platform

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         #   version '1.2.3'
         #
         class InvalidVersionMetadata < Cop
-          MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'.freeze
+          MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'
 
           def_node_matcher :version?, '(send nil? :version $str ...)'
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
         class LazyEvalNodeAttributeDefaults < Cop
           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.'.freeze
+          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.'
 
           def_node_matcher :non_lazy_node_attribute_default?, <<-PATTERN
             (send nil? :property (sym _) ... (hash <(pair (sym :default) $(send (send _ :node) :[] _) ) ...>))

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

@@ -0,0 +1,68 @@
+# 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|
+                if INVALID_VALUE_MAP[type_val]
+                  corrector.replace(type.loc.expression, "type '#{INVALID_VALUE_MAP[type_val]}'")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end