cookstyle 6.11.4 → 6.12.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4593dcbd93b8d0d668e0fe5e5551147db850c38deabcccf698b3f8ea391c281d
-  data.tar.gz: ef4557926f01a865f3ced43e0ad7a464659f597f4f6ffc8104c2f978d959324a
+  metadata.gz: f2a5a64113481754a334b8f95b80e976875672ca750c506dbdb586c2ccbab598
+  data.tar.gz: 0ff373380e2f388e723a25b6ce1fae3e2447487cfe4c3692f3151e81f412a67a
 SHA512:
-  metadata.gz: e3d3b5ed0ccd193ae9aad8d8e44a03935010a841c3cf551ce070c557f2f27e93ba2ffa2082042741f481ccabb7abf68e83d958ed06e3c5751556b7f0528aa3ae
-  data.tar.gz: e48e47c6d27316fe8054ecc45164aedf0385be8d8e8e1077781dd3ef9948ccb756864bb6adad422941f061232f0ca0d3c6c41679166bcf345dfa29fc71f79ed3
+  metadata.gz: e4b62f764012b0f77378a0fa3d7b97abc249ece2fcc464234ce8c0b68d3bc41692324ce0557652f084a3d923f834973f660aa060206ab9d520fb09bbe75bc3de
+  data.tar.gz: 6f3a5b63437a4dd752b211959915744fa6c6b7cce86c6da0711f950bcba8f1e3d8d40c3b661b19b4f2f5a871d3801316d12d39a29b367c097740852f704e78ee

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

@@ -1020,6 +1020,33 @@ 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: '#chefdkgenerators'
+  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: '#chefhandlerrecipe'
+  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: '#useautomaticresourcename'
+  Enabled: true
+  VersionAdded: '6.12.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################

data/config/disable_all.yml

@@ -223,6 +223,8 @@ Lint/DisjunctiveAssignmentInConstructor:
   Enabled: false
 Lint/DuplicateCaseCondition:
   Enabled: false
+Lint/DuplicateElsifCondition:
+  Enabled: false
 Lint/DuplicateHashKey:
   Enabled: false
 Lint/DuplicateMethods:
@@ -427,6 +429,8 @@ Style/Alias:
   Enabled: false
 Style/AndOr:
   Enabled: false
+Style/ArrayCoercion:
+  Enabled: false
 Style/ArrayJoin:
   Enabled: false
 Style/AsciiComments:
@@ -447,6 +451,8 @@ Style/BlockDelimiters:
   Enabled: false
 Style/CaseEquality:
   Enabled: false
+Style/CaseLikeIf:
+  Enabled: false
 Style/CharacterLiteral:
   Enabled: false
 Style/ClassAndModuleChildren:
@@ -533,8 +539,12 @@ 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,6 +585,8 @@ Style/RedundantAssignment:
   Enabled: false
 Style/RedundantFetchBlock:
   Enabled: false
+Style/RedundantFileExtensionInRequire:
+  Enabled: false
 Style/MethodCalledOnDoEndBlock:
   Enabled: false
 Style/MethodDefParentheses:

data/config/upstream.yml

@@ -1397,12 +1397,18 @@ Lint/DisjunctiveAssignmentInConstructor:
   Enabled: true
   Safe: false
   VersionAdded: '0.62'
+  VersionChanged: '0.88'
 
 Lint/DuplicateCaseCondition:
   Description: 'Do not repeat values in case conditionals.'
   Enabled: true
   VersionAdded: '0.45'
 
+Lint/DuplicateElsifCondition:
+  Description: 'Do not repeat conditions used in if `elsif`.'
+  Enabled: 'pending'
+  VersionAdded: '0.88'
+
 Lint/DuplicateHashKey:
   Description: 'Check for duplicate keys in hash literals.'
   Enabled: true
@@ -2179,17 +2185,18 @@ Naming/MethodParameterName:
   AllowNamesEndingInNumbers: true
   # Allowed names that will not register an offense
   AllowedNames:
-    - io
-    - id
-    - to
+    - at
     - by
-    - 'on'
+    - db
+    - id
     - in
-    - at
+    - io
     - ip
-    - db
+    - of
+    - 'on'
     - os
     - pp
+    - to
   # Forbidden names that will register an offense
   ForbiddenNames: []
 
@@ -2340,6 +2347,14 @@ Style/AndOr:
     - always
     - conditionals
 
+Style/ArrayCoercion:
+  Description: >-
+                  Use Array() instead of explicit Array check or [*var], when dealing
+                  with a variable you want to treat as an Array, but you're not certain it's an array.
+  StyleGuide: '#array-coercion'
+  Enabled: 'pending'
+  VersionAdded: '0.88'
+
 Style/ArrayJoin:
   Description: 'Use Array#join instead of Array#*.'
   StyleGuide: '#array-join'
@@ -2522,6 +2537,12 @@ Style/CaseEquality:
   #   String === "string"
   AllowOnConstant: false
 
+Style/CaseLikeIf:
+  Description: 'This cop identifies places where `if-elsif` constructions can be replaced with `case-when`.'
+  StyleGuide: '#case-vs-if-else'
+  Enabled: 'pending'
+  VersionAdded: '0.88'
+
 Style/CharacterLiteral:
   Description: 'Checks for uses of character literals.'
   StyleGuide: '#no-character-literals'
@@ -2961,6 +2982,18 @@ Style/GuardClause:
   # needs to have to trigger this cop
   MinBodyLength: 1
 
+Style/HashAsLastArrayItem:
+  Description: >-
+                 Checks for presence or absence of braces around hash literal as a last
+                 array item depending on configuration.
+  StyleGuide: '#hash-literal-as-last-array-item'
+  Enabled: 'pending'
+  VersionAdded: '0.88'
+  EnforcedStyle: braces
+  SupportedStyles:
+    - braces
+    - no_braces
+
 Style/HashEachMethods:
   Description: 'Use Hash#each_key and Hash#each_value.'
   StyleGuide: '#hash-each'
@@ -2968,6 +3001,16 @@ Style/HashEachMethods:
   VersionAdded: '0.80'
   Safe: false
 
+Style/HashLikeCase:
+  Description: >-
+                  Checks for places where `case-when` represents a simple 1:1
+                  mapping and can be replaced with a hash lookup.
+  Enabled: 'pending'
+  VersionAdded: '0.88'
+  # `MinBranchesCount` defines the number of branches `case` needs to have
+  # to trigger this cop
+  MinBranchesCount: 3
+
 Style/HashSyntax:
   Description: >-
                  Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
@@ -3665,6 +3708,14 @@ Style/RedundantFetchBlock:
   SafeForConstants: false
   VersionAdded: '0.86'
 
+Style/RedundantFileExtensionInRequire:
+  Description: >-
+                  Checks for the presence of superfluous `.rb` extension in
+                  the filename provided to `require` and `require_relative`.
+  StyleGuide: '#no-explicit-rb-to-require'
+  Enabled: 'pending'
+  VersionAdded: '0.88'
+
 Style/RedundantFreeze:
   Description: "Checks usages of Object#freeze on immutable objects."
   Enabled: true

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'

data/lib/cookstyle.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'cookstyle/version'
 
 require 'pathname'

data/lib/cookstyle/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.11.4".freeze # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.87.1'.freeze
+  VERSION = "6.12.6" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.88.0'
 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>)
@@ -32,7 +33,7 @@ module RuboCop
         #   ::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) ... )

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>)
@@ -33,7 +34,7 @@ module RuboCop
         class InvalidPlatformFamilyHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
 
-          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*)

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") )