cookstyle 6.11.4 → 6.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4593dcbd93b8d0d668e0fe5e5551147db850c38deabcccf698b3f8ea391c281d
-  data.tar.gz: ef4557926f01a865f3ced43e0ad7a464659f597f4f6ffc8104c2f978d959324a
+  metadata.gz: 91b883b4825831ec4a6cd167377859fa83bf1eea994b1b0dfa85d28dcdd998e9
+  data.tar.gz: fe4e2c83dc76b6b6713e7f6b1ad3e50f869708eda0bf22eeb1b68a43bd5c7762
 SHA512:
-  metadata.gz: e3d3b5ed0ccd193ae9aad8d8e44a03935010a841c3cf551ce070c557f2f27e93ba2ffa2082042741f481ccabb7abf68e83d958ed06e3c5751556b7f0528aa3ae
-  data.tar.gz: e48e47c6d27316fe8054ecc45164aedf0385be8d8e8e1077781dd3ef9948ccb756864bb6adad422941f061232f0ca0d3c6c41679166bcf345dfa29fc71f79ed3
+  metadata.gz: 330ed487b5946aba1b6b532e5ab79a0875007acd9052f7637e5a275a4db02c4cd39dfab066c981b6f14c8d24fd30b66cbd8b2b23d578232ce58176d7cc3ff11c
+  data.tar.gz: db1991f9e874b4fbb154e0334b09a7fcbe4062bb5207d4b3c1a3f169c4365ab8caf17fec699ca914a792be5ddab56a41207a657bdf7b919634008d1263a698d6

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cookstyle.gemspec
@@ -15,6 +16,11 @@ group :docs do
   gem 'yard'
 end
 
+group :profiling do
+  gem 'stackprof'
+  gem 'memory_profiler'
+end
+
 group :development do
   gem 'adamantium'
   gem 'anima'

data/bin/cookstyle

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w(.. lib))
 

data/bin/cookstyle-profile

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+if ARGV.include?('-h') || ARGV.include?('--help')
+  puts 'Usage: same as main `cookstyle` command but gathers profiling info'
+  puts 'Additional option: `--memory` to print memory usage'
+  exit(0)
+end
+with_mem = ARGV.delete('--memory')
+
+require 'stackprof'
+if with_mem
+  require 'memory_profiler'
+  MemoryProfiler.start
+end
+StackProf.start
+start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+begin
+  load "#{__dir__}/cookstyle"
+ensure
+  delta = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+  puts "Finished in #{delta.round(1)} seconds"
+  StackProf.stop
+  if with_mem
+    puts 'Building memory report...'
+    report = MemoryProfiler.stop
+  end
+  Dir.mkdir('tmp') unless File.exist?('tmp')
+  StackProf.results('tmp/stackprof.dump')
+  report&.pretty_print(scale_bytes: true)
+end

data/config/cookstyle.yml

@@ -5,27 +5,6 @@ AllCops:
     - '/**/files/**/*'
     - '/**/vendor/**/*'
     - Guardfile
-  ChefAttributes:
-    Patterns:
-    - attributes/.*\.rb
-  ChefDefinitions:
-    Patterns:
-    - definitions/.*\.rb
-  ChefLibraries:
-    Patterns:
-    - libraries/.*\.rb
-  ChefMetadata:
-    Patterns:
-    - metadata\.rb
-  ChefProviders:
-    Patterns:
-    - providers/.*\.rb
-  ChefRecipes:
-    Patterns:
-    - recipes/.*\.rb
-  ChefResources:
-    Patterns:
-    - resources/.*\.rb
 
 ###############################
 # ChefStyle: Making cookbooks look better
@@ -67,7 +46,7 @@ ChefStyle/CommentFormat:
     - '**/Berksfile'
 
 ChefStyle/FileMode:
-  Description: Use strings to represent file modes in Chef resources
+  Description: Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
   StyleGuide: '#chefstylefilemode'
   Enabled: true
   VersionAdded: '5.0.0'
@@ -454,6 +433,32 @@ ChefCorrectness/InvalidPlatformInCase:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefCorrectness/InvalidDefaultAction:
+  Description: Default actions in resources should be a symbol or an array of symbols.
+  StyleGuide: '#chefcorrectnessinvaliddefaultaction'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+
+ChefCorrectness/SupportsMustBeFloat:
+  Description: Versions used in metadata.rb supports calls should be floats not integers.
+  StyleGuide: '#chefcorrectnesssupportsmustbefloat'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Include:
+    - '**/metadata.rb'
+
+ChefCorrectness/MacosUserdefaultsInvalidType:
+  Description: 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'.
+  StyleGuide: '#chefcorrectnessmacosuserdefaultsinvalidtype'
+  Enabled: true
+  VersionAdded: '6.14.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefSharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -498,7 +503,7 @@ ChefSharing/EmptyMetadataField:
     - '**/metadata.rb'
 
 ChefSharing/IncludePropertyDescriptions:
-  Description: Properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+  Description: Properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
   StyleGuide: '#chefsharingincludepropetydescriptions'
   Enabled: false
   VersionAdded: '6.1.0'
@@ -507,7 +512,7 @@ ChefSharing/IncludePropertyDescriptions:
     - '**/resources/*.rb'
 
 ChefSharing/IncludeResourceDescriptions:
-  Description: Resources should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+  Description: Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
   StyleGuide: '#chefsharingincluderesourcedescriptions'
   Enabled: false
   VersionAdded: '6.1.0'
@@ -515,7 +520,7 @@ ChefSharing/IncludeResourceDescriptions:
     - '**/resources/*.rb'
 
 ChefSharing/IncludeResourceExamples:
-  Description: Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.
+  Description: Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.
   StyleGuide: '#chefsharingincluderesourceexamples'
   Enabled: false
   VersionAdded: '6.10.0'
@@ -1020,6 +1025,42 @@ ChefDeprecations/ResourceUsesOnlyResourceName:
     - '**/libraries/*.rb'
     - '**/resources/*.rb'
 
+ChefDeprecations/ChefDKGenerators:
+  Description: Chef Workstation 0.8 and later renamed the ChefDK module used when writing custom cookbook generators from ChefDK to ChefCLI. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
+  StyleGuide: '#chefdeprecationschefdkgenerators'
+  Enabled: true
+  VersionAdded: '6.12.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/ChefHandlerRecipe:
+  Description: There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource.
+  StyleGuide: '#chefdeprecationschefhandlerrecipe'
+  Enabled: true
+  VersionAdded: '6.12.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/UseAutomaticResourceName:
+  Description: The use_automatic_resource_name method was removed in Chef Infra Client 16. The resource name/provides should be set explicitly instead.
+  StyleGuide: '#chefdeprecationsuseautomaticresourcename'
+  Enabled: true
+  VersionAdded: '6.12.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+
+ChefDeprecations/MacosUserdefaultsGlobalProperty:
+  Description: The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. Omitting the `domain` property will now set global defaults.
+  StyleGuide: '#chefdeprecationsmacosuserdefaultsglobalproperty'
+  Enabled: true
+  VersionAdded: '6.14.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -1496,7 +1537,7 @@ ChefModernize/WindowsRegistryUAC:
     - '**/Berksfile'
 
 ChefModernize/UseMultipackageInstalls:
-  Description: Pass an array of packages to package resources instead of interating over an array of packages when using multi-package capable package subystem such as apt, yum, chocolatey, dnf, or zypper. Multipackage installs are faster and simplify logs.
+  Description: Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
   StyleGuide: '#chefmodernizeusemultipackageinstalls'
   Enabled: true
   VersionAdded: '6.0.0'
@@ -1554,7 +1595,7 @@ ChefModernize/ShellOutHelper:
 
 ChefModernize/ConditionalUsingTest:
   Description: Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out.
-  StyleGuide: '#conditionalusingtest'
+  StyleGuide: '#chefmodernizeconditionalusingtest'
   Enabled: true
   VersionAdded: '6.11.0'
   Exclude:
@@ -1562,6 +1603,26 @@ ChefModernize/ConditionalUsingTest:
     - '**/Berksfile'
     - '**/attributes/*.rb'
 
+ChefModernize/CronDFileOrTemplate:
+  Description: Use the cron_d resource that ships with Chef Infra Client 14.4+ instead of manually creating the file with template, file, or cookbook_file resources
+  StyleGuide: '#chefmodernizecrondfileortemplate'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+    - '**/attributes/*.rb'
+
+ChefModernize/ActionMethodInResource:
+  Description: Use the custom resource language's `action :my_action` blocks instead of creating actions with methods.
+  StyleGuide: '#chefmodernizeactionmethodinresource'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+    - '**/libraries/*.rb'
+
 ###############################
 # ChefRedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################
@@ -1758,7 +1819,7 @@ ChefRedundantCode/UseCreateIfMissing:
 
 ChefRedundantCode/OhaiAttributeToString:
   Description: Many Ohai node attributes are already strings and don't need to be cast to strings again
-  StyleGuide: '#ohaiattributetostring'
+  StyleGuide: '#chefredundantcodeohaiattributetostring'
   Enabled: true
   VersionAdded: '6.10.0'
   Exclude:
@@ -1767,13 +1828,23 @@ ChefRedundantCode/OhaiAttributeToString:
 
 ChefRedundantCode/MultiplePlatformChecks:
   Description: You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
-  StyleGuide: '#multipleplatformchecks'
+  StyleGuide: '#chefredundantcodemultipleplatformchecks'
   Enabled: true
   VersionAdded: '6.10.0'
   Exclude:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefRedundantCode/DoubleCompileTime:
+  Description: If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
+  StyleGuide: '#chefredundantcodedoublecompiletime'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefEffortless: Migrating to new patterns
 ###############################
@@ -1799,7 +1870,7 @@ ChefEffortless/CookbookUsesDatabags:
     - '**/metadata.rb'
     - '**/Berksfile'
 
-ChefEffortless/CookbookUsesEnvironmments:
+ChefEffortless/CookbookUsesEnvironments:
   Description: Cookbook uses environments, which cannot be used in the Effortless Infra pattern
   StyleGuide: '#chefeffortlesscookbookusesenvironments'
   Enabled: false
@@ -2135,10 +2206,6 @@ Style/WordArray:
   Enabled: true
 Style/ZeroLengthPredicate:
   Enabled: true
-Metrics/BlockNesting:
-  Enabled: true
-Metrics/ParameterLists:
-  Enabled: true
 Lint/AmbiguousOperator:
   Enabled: true
 Lint/AssignmentInCondition:
@@ -2270,16 +2337,16 @@ Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
-
-#### COPS FOR THE NEXT MAJOR RELEASE
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
 
 # This updates how we send helpers into the Chef recipe/resource classes and makes WAY more sense
 # Chef::Recipe.send(:include, ::Apt::Helpers) -> Chef::Recipe.include ::Apt::Helpers
 Lint/SendWithMixinArgument:
   Enabled: true
 
-#### END COPS FOR THE NEXT MAJOR RELEASE
-
 # this migrates old # rubocop: comments to use the latest namespaces, which prevents a ton of spam during cookstyle runs
 Migration/DepartmentName:
   Enabled: true
@@ -2504,3 +2571,44 @@ Style/HashEachMethods:
 # We want to catch this deprecation in cookbooks
 Lint/DeprecatedOpenSSLConstant:
   Enabled: true
+
+# This just isn't a big deal in the context of a cookbook
+Naming/AccessorMethodName:
+  Enabled: false
+
+# Rescuing a particular exception twice isn't going to work
+Lint/DuplicateRescueException:
+  Enabled: true
+
+# if b == 0 && b == 0 is invalid and we should flag it
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+# returning at the top level with an arg is invalid
+# @TODO we can enable this once this is fixed: https://github.com/rubocop-hq/rubocop/issues/8462
+# Lint/TopLevelReturnWithArgument:
+#   Enabled: true
+
+# simplify hash acccess that doesn't actually need .dig
+Style/SingleArgumentDig:
+  Enabled: true
+
+# trying to access $2 when there is no $2 will always return nil
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+# simplify how people coerce arrays
+Style/ArrayCoercion:
+  Enabled: true
+
+# if your elseif is the same as your if you're gonna have a bad day
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+# simplify attr_reader and attr_write into attr_accessor
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+# avoid assignments that aren't needed
+Style/RedundantAssignment:
+  Enabled: true

data/config/disable_all.yml

@@ -207,6 +207,8 @@ Lint/AssignmentInCondition:
   Enabled: false
 Lint/BigDecimalNew:
   Enabled: false
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: false
 Lint/BooleanSymbol:
   Enabled: false
 Lint/CircularArgumentReference:
@@ -223,14 +225,20 @@ Lint/DisjunctiveAssignmentInConstructor:
   Enabled: false
 Lint/DuplicateCaseCondition:
   Enabled: false
+Lint/DuplicateElsifCondition:
+  Enabled: false
 Lint/DuplicateHashKey:
   Enabled: false
 Lint/DuplicateMethods:
   Enabled: false
+Lint/DuplicateRescueException:
+  Enabled: false
 Lint/EachWithObjectArgument:
   Enabled: false
 Lint/ElseLayout:
   Enabled: false
+Lint/EmptyConditionalBody:
+  Enabled: false
 Lint/EmptyEnsure:
   Enabled: false
 Lint/EmptyExpression:
@@ -245,6 +253,8 @@ Lint/ErbNewArguments:
   Enabled: false
 Lint/FlipFlop:
   Enabled: false
+Lint/FloatComparison:
+  Enabled: false
 Lint/FloatOutOfRange:
   Enabled: false
 Lint/FormatParameterMismatch:
@@ -267,6 +277,8 @@ Lint/Loop:
   Enabled: false
 Lint/MissingCopEnableDirective:
   Enabled: false
+Lint/MissingSuper:
+  Enabled: false
 Lint/MixedRegexpCaptureTypes:
   Enabled: false
 Lint/MultipleComparison:
@@ -285,6 +297,8 @@ Lint/NumberConversion:
   Enabled: false
 Lint/OrderedMagicComments:
   Enabled: false
+Lint/OutOfRangeRegexpRef:
+  Enabled: false
 Lint/ParenthesesAsGroupedExpression:
   Enabled: false
 Lint/PercentStringArray:
@@ -327,6 +341,8 @@ Lint/SafeNavigationWithEmpty:
   Enabled: false
 Lint/ScriptPermission:
   Enabled: false
+Lint/SelfAssignment:
+  Enabled: false
 Lint/SendWithMixinArgument:
   Enabled: false
 Lint/ShadowedArgument:
@@ -343,12 +359,16 @@ Lint/Syntax:
   Enabled: false
 Lint/ToJSON:
   Enabled: false
+Lint/TopLevelReturnWithArgument:
+  Enabled: false
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
 Lint/UnifiedInteger:
   Enabled: false
 Lint/UnreachableCode:
   Enabled: false
+Lint/UnreachableLoop:
+  Enabled: false
 Lint/UnusedBlockArgument:
   Enabled: false
 Lint/UnusedMethodArgument:
@@ -361,8 +381,6 @@ Lint/UselessAccessModifier:
   Enabled: false
 Lint/UselessAssignment:
   Enabled: false
-Lint/UselessComparison:
-  Enabled: false
 Lint/UselessElseWithoutRescue:
   Enabled: false
 Lint/UselessSetterCall:
@@ -427,6 +445,8 @@ Style/Alias:
   Enabled: false
 Style/AndOr:
   Enabled: false
+Style/ArrayCoercion:
+  Enabled: false
 Style/ArrayJoin:
   Enabled: false
 Style/AsciiComments:
@@ -447,6 +467,8 @@ Style/BlockDelimiters:
   Enabled: false
 Style/CaseEquality:
   Enabled: false
+Style/CaseLikeIf:
+  Enabled: false
 Style/CharacterLiteral:
   Enabled: false
 Style/ClassAndModuleChildren:
@@ -517,6 +539,8 @@ Style/EvenOdd:
   Enabled: false
 Style/ExpandPathArguments:
   Enabled: false
+Style/ExplicitBlockArgument:
+  Enabled: false
 Style/ExponentialNotation:
   Enabled: false
 Style/FloatDivision:
@@ -529,12 +553,18 @@ Style/FormatStringToken:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
+Style/GlobalStdStream:
+  Enabled: false
 Style/GlobalVars:
   Enabled: false
 Style/GuardClause:
   Enabled: false
+Style/HashAsLastArrayItem:
+  Enabled: false
 Style/HashEachMethods:
   Enabled: false
+Style/HashLikeCase:
+  Enabled: false
 Style/HashSyntax:
   Enabled: false
 Style/HashTransformKeys:
@@ -575,12 +605,12 @@ Style/RedundantAssignment:
   Enabled: false
 Style/RedundantFetchBlock:
   Enabled: false
+Style/RedundantFileExtensionInRequire:
+  Enabled: false
 Style/MethodCalledOnDoEndBlock:
   Enabled: false
 Style/MethodDefParentheses:
   Enabled: false
-Style/MethodMissingSuper:
-  Enabled: false
 Style/MinMax:
   Enabled: false
 Style/MissingElse:
@@ -645,6 +675,8 @@ Style/OptionHash:
   Enabled: false
 Style/OptionalArguments:
   Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
 Style/ParallelAssignment:
   Enabled: false
 Style/ParenthesesAroundCondition:
@@ -713,6 +745,8 @@ Style/Send:
   Enabled: false
 Style/SignalException:
   Enabled: false
+Style/SingleArgumentDig:
+  Enabled: false
 Style/SingleLineBlockParams:
   Enabled: false
 Style/SingleLineMethods:
@@ -725,6 +759,8 @@ Style/StabbyLambdaParentheses:
   Enabled: false
 Style/StderrPuts:
   Enabled: false
+Style/StringConcatenation:
+  Enabled: false
 Style/StringHashKeys:
   Enabled: false
 Style/StringLiterals: