cookstyle 7.32.1 → 7.32.7

data/config/cookstyle.yml

@@ -1,5 +1,7 @@
 AllCops:
   SuggestExtensions: false
+  NewCops: disable
+  DisabledByDefault: true
   TargetRubyVersion: 2.5
   TargetChefVersion: ~
   inherit_mode:
@@ -2371,10 +2373,10 @@ Chef/Security/SshPrivateKey:
 
 Layout/AccessModifierIndentation:
   Enabled: true
-Layout/AlignArray:
-  Enabled: true
-Layout/AlignHash:
-  Enabled: true
+# Layout/AlignArray: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
+# Layout/AlignHash: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Style/AndOr:
   Enabled: true
 Style/ArrayJoin:
@@ -2393,8 +2395,6 @@ Layout/BlockEndNewline:
   Enabled: true
 Style/BlockDelimiters:
   Enabled: true
-Style/BracesAroundHashParameters:
-  Enabled: true
 Style/CaseEquality:
   Enabled: true
 Layout/CaseIndentation:
@@ -2425,8 +2425,8 @@ Naming/ConstantName:
   Enabled: true
 Style/DefWithParentheses:
   Enabled: true
-Style/DeprecatedHashMethods:
-  Enabled: true
+# Style/DeprecatedHashMethods: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Layout/DotPosition:
   Enabled: true
 Style/EachWithObject:
@@ -2482,12 +2482,12 @@ Layout/IndentationWidth:
   Enabled: true
 Style/IdenticalConditionalBranches:
   Enabled: true
-Layout/IndentArray:
-  Enabled: true
-Layout/IndentAssignment:
-  Enabled: true
-Layout/IndentHash:
-  Enabled: true
+# Layout/IndentArray: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
+# Layout/IndentAssignment: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
+# Layout/IndentHash: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Style/InfiniteLoop:
   Enabled: true
 Style/Lambda:
@@ -2498,8 +2498,8 @@ Layout/LeadingCommentSpace:
   Enabled: true
 Style/LineEndConcatenation:
   Enabled: true
-Style/MethodCallParentheses:
-  Enabled: true
+# Style/MethodCallParentheses: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Style/MethodDefParentheses:
   Enabled: true
 Style/MultilineBlockChain:
@@ -2536,8 +2536,8 @@ Style/Not:
   Enabled: true
 Style/OneLineConditional:
   Enabled: true
-Naming/OpMethod:
-  Enabled: true
+# Naming/OpMethod: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Style/OptionalArguments:
   Enabled: true
 Style/ParallelAssignment:
@@ -2641,12 +2641,12 @@ Style/TrivialAccessors:
   Enabled: true
 Style/UnlessElse:
   Enabled: true
-Style/UnneededCapitalW:
-  Enabled: true
-Style/UnneededInterpolation:
-  Enabled: true
-Style/UnneededPercentQ:
-  Enabled: true
+# Style/UnneededCapitalW: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
+# Style/UnneededInterpolation: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
+# Style/UnneededPercentQ: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Style/TrailingUnderscoreVariable:
   Enabled: true
 Style/VariableInterpolation:
@@ -2680,8 +2680,8 @@ Lint/DeprecatedClassMethods:
   Enabled: true
 Lint/DuplicateMethods:
   Enabled: true
-Lint/DuplicatedKey:
-  Enabled: true
+# Lint/DuplicatedKey: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Lint/EachWithObjectArgument:
   Enabled: true
 Lint/ElseLayout:
@@ -2693,8 +2693,8 @@ Lint/EmptyInterpolation:
 Layout/EndAlignment:
   Enabled: true
   AutoCorrect: true
-Lint/EndInMethod:
-  Enabled: true
+# Lint/EndInMethod: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Lint/EnsureReturn:
   Enabled: true
 Security/Eval:
@@ -2703,8 +2703,8 @@ Lint/FloatOutOfRange:
   Enabled: true
 Lint/FormatParameterMismatch:
   Enabled: true
-Lint/HandleExceptions:
-  Enabled: true
+# Lint/HandleExceptions: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Lint/ImplicitStringConcatenation:
   Enabled: true
   Exclude:
@@ -2733,12 +2733,12 @@ Lint/RescueException:
   Enabled: true
 Lint/ShadowingOuterLocalVariable:
   Enabled: true
-Lint/StringConversionInInterpolation:
-  Enabled: true
+# Lint/StringConversionInInterpolation: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Lint/UnderscorePrefixedVariableName:
   Enabled: true
-Lint/UnneededCopDisableDirective:
-  Enabled: true
+# Lint/UnneededCopDisableDirective: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Lint/UnusedBlockArgument:
   Enabled: true
 Lint/UnusedMethodArgument:
@@ -2749,8 +2749,8 @@ Lint/UselessAccessModifier:
   Enabled: true
 Lint/UselessAssignment:
   Enabled: true
-Lint/UselessComparison:
-  Enabled: true
+# Lint/UselessComparison: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 Lint/UselessElseWithoutRescue:
   Enabled: true
 Lint/UselessSetterCall:
@@ -2867,8 +2867,8 @@ Bundler/DuplicatedGem:
   Enabled: true
 
 # This results in very confusing code to read with little perf benefit
-Performance/Casecmp:
-  Enabled: false
+# Performance/Casecmp: # TODO: move to cookstyle project .rubocop.yml?
+#   Enabled: false
 
 # This comes with changing the ruby target to 2.3+
 Style/FrozenStringLiteralComment:
@@ -2926,8 +2926,8 @@ Style/MinMax:
 Lint/UriRegexp:
   Enabled: true
 
-Performance/UriDefaultParser:
-  Enabled: true
+# Performance/UriDefaultParser: # TODO: move to cookstyle project .rubocop.yml?
+#   Enabled: true
 
 # :true or :false seems like a horrible idea
 Lint/BooleanSymbol:
@@ -2938,16 +2938,16 @@ Style/RedundantConditional:
   Enabled: true
 
 # catches people writing a regex check wrong
-Lint/RegexpInCondition:
-  Enabled: true
+# Lint/RegexpInCondition: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 
 # Avoids pointless / complex code
 Lint/RedundantWithObject:
   Enabled: true
 
 # avoid requiring things that come for free
-Lint/UnneededRequireStatement:
-  Enabled: true
+# Lint/UnneededRequireStatement: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 
 # Avoid poorly formatted methods
 Style/TrailingBodyOnMethodDefinition:
@@ -2970,8 +2970,8 @@ Lint/BigDecimalNew:
   Enabled: true
 
 # remove bogus rubocop comments. We already enabled Disable directives
-Lint/UnneededCopEnableDirective:
-  Enabled: true
+# Lint/UnneededCopEnableDirective: TODO broken with rubocop 1.25.1 move
+#   Enabled: true
 
 # get people on a much simpler ruby 2.4+ way of doing things
 Style/UnpackFirst:

data/config/default.yml

@@ -1,4 +1,2 @@
 inherit_from:
-  - upstream.yml
-  - disable_all.yml
   - cookstyle.yml

data/cookstyle.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   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.5'
+  spec.required_ruby_version = '>= 2.7'
 
   # the gemspec and Gemfile are necessary for appbundling of the gem
   spec.files = %w(LICENSE cookstyle.gemspec Gemfile) + Dir.glob('{lib,bin,config}/**/*')

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.32.1" # rubocop: disable Style/StringLiterals
+  VERSION = "7.32.7" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.25.1'
 end

data/lib/cookstyle.rb

@@ -15,26 +15,13 @@ require_relative 'rubocop/monkey_patches/base'
 require_relative 'rubocop/monkey_patches/team'
 require_relative 'rubocop/monkey_patches/registry_cop'
 
-module RuboCop
-  class ConfigLoader
-    RUBOCOP_HOME.gsub!(
-      /^.*$/,
-      File.realpath(File.join(__dir__, '..'))
-    )
-
-    DEFAULT_FILE.gsub!(
-      /^.*$/,
-      File.join(RUBOCOP_HOME, 'config', 'default.yml')
-    )
-  end
-end
-
 # Cookstyle patches the RuboCop tool to set a new default configuration that
 # is vendored in the Cookstyle codebase.
 module Cookstyle
   # @return [String] the absolute path to the main RuboCop configuration YAML file
   def self.config
-    RuboCop::ConfigLoader::DEFAULT_FILE
+    config_file = const_defined?('CHEFSTYLE_CONFIG') ? 'chefstyle.yml' : 'default.yml'
+    File.realpath(File.join(__dir__, '..', 'config', config_file))
   end
 end
 
@@ -51,3 +38,8 @@ Dir.glob(__dir__ + '/rubocop/cop/**/*.rb') do |file|
 
   require_relative file # not actually relative but require_relative is faster
 end
+
+# stub default value of TargetChefVersion to avoid STDERR noise
+RuboCop::ConfigLoader.default_configuration['AllCops']['TargetChefVersion'] = '~'
+
+RuboCop::ConfigLoader.default_configuration = RuboCop::ConfigLoader.configuration_from_file(Cookstyle.config)

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
         #     only_if { 'test -f /etc/foo' }
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   Chef::Application.fatal!('Something horrible happened!')
         #
-        #   #### correct
+        #   ### correct
         #   raise "Something horrible happened!"
         #
         class ChefApplicationFatal < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     only_if { system('wget https://www.bar.com/foobar.txt -O /dev/null') }
@@ -34,7 +34,7 @@ module RuboCop
         #     only_if { shell_out('wget https://www.bar.com/foobar.txt -O /dev/null').exitstatus == 0 }
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     only_if 'wget https://www.bar.com/foobar.txt -O /dev/null'

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   dnf_package 'nginx' do
         #     version '1.2.3'
         #     allow_downgrades true
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   dnf_package 'nginx' do
         #     version '1.2.3'
         #   end

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   ::Chef::Recipe.send(:include, Filebeat::Helpers)
         #   ::Chef::Provider.send(:include, Filebeat::Helpers)
         #   ::Chef::Recipe.include Filebeat::Helpers
         #   ::Chef::Provider.include Filebeat::Helpers
         #
-        #   #### correct
+        #   ### correct
         #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
         #
         class IncorrectLibraryInjection < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   name 'foo.bar'
         #
-        #   #### correct
+        #   ### correct
         #   name 'foo_bar'
         #
         class InvalidCookbookName < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   default_action 'create'
         #
-        #   #### correct
+        #   ### correct
         #   default_action :create
         #
         class InvalidDefaultAction < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, service['apache'], :immediately
@@ -33,7 +33,7 @@ module RuboCop
         #     notifies :restart, service[apache], :immediately
         #   end
         #
-        #   #### correct
+        #   ### correct
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :immediately

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :nope
         #   end
         #
-        #   #### correct
+        #   ### correct
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :immediately

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   platform_family?('redhat')
         #   platform_family?('sles')
         #
-        #   #### incorrect
+        #   ### incorrect
         #   platform_family?('rhel')
         #   platform_family?('suse')
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   case node['platform_family']
         #   when 'redhat'
         #     puts "I'm on a RHEL-like system"

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   platform?('darwin')
         #   platform?('rhel')
         #   platform?('sles')
         #
-        #   #### correct
+        #   ### correct
         #   platform?('mac_os_x')
         #   platform?('redhat')
         #   platform?('suse')

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   supports 'darwin'
         #   supports 'mswin'
         #
-        #   #### correct
+        #   ### correct
         #   supports 'mac_os_x'
         #   supports 'windows'
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   case node['platform']
         #   when 'rhel'
         #     puts "I'm on a Red Hat system!"

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   value_for_platform_family(
         #     %w(rhel sles) => 'foo',
         #     %w(mac) => 'foo'
         #   )
         #
-        #   #### correct
+        #   ### correct
         #   value_for_platform_family(
         #     %w(rhel suse) => 'foo',
         #     %w(mac_os_x) => 'foo'

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   value_for_platform(
         #     %w(rhel mac_os_x_server) => { 'default' => 'foo' },
         #     %w(sles) => { 'default' => 'bar' }
         #   )
-        #   #### correct
+        #   ### correct
         #   value_for_platform(
         #     %w(redhat mac_os_x) => { 'default' => 'foo' },
         #     %w(opensuseleap) => { 'default' => 'bar' }

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   version '1.2.3.4'
         #
-        #   #### correct
+        #   ### correct
         #   version '1.2.3'
         #
         class InvalidVersionMetadata < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :Something, String, default: node['hostname']
         #
-        #   #### correct
+        #   ### correct
         #   property :Something, String, default: lazy { node['hostname'] }
         #
         class LazyEvalNodeAttributeDefaults < Base

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
         #     only_if { lazy { ::File.exist?('/etc/foo')} }
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'
         #     type 'boolean'
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   value_for_platform(
         #     %w(redhat oracle) => 'baz'
         #   )
         #
-        #   #### correct
+        #   ### correct
         #   value_for_platform(
         #     %w(redhat oracle) => {
         #       '5' => 'foo',

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   depends 'some_awesome_cookbook' '= 4.5.5'
         #   depends 'some_other_cool_cookbook' '< 8.0'
         #
-        #   #### correct
+        #   ### correct
         #   depends 'some_awesome_cookbook', '= 4.5.5'
         #   depends 'some_other_cool_cookbook', '< 8.0'
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### correct
+        #   ### correct
         #   name 'foo'
         #
         class MetadataMissingName < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### correct
+        #   ### correct
         #   name 'foo'
         #   version '1.0.0'
         #

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

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   node.normal['foo'] = true
         #
-        #   #### correct
+        #   ### correct
         #   node.default['foo'] = true
         #   node.override['foo'] = true
         #   node.force_default['foo'] = true