cookstyle 7.25.6 → 7.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a67abdf6a42bec1022fc57e53a61a9aa6f371641e6afe429eee6a9489ff2355
-  data.tar.gz: c3ff11c1e6ef1be4af29d034d662a6b662a731103082477b0d8d0e9e3a0455e2
+  metadata.gz: fe0113118edcb59c64b2a176b5f4dc9e4880cedda9cdced9257bdf58901f7ad3
+  data.tar.gz: a0124092a6e81ef8062d6ef14e7deb18cd517ca44d26b03efbc28e6f367be220
 SHA512:
-  metadata.gz: 79074fc5f3c7ef245dbcb64a4739a49298cda263bc216333215599bbc7e052f0979981e67572eec6d77b33c8e620370087b32ad20f90d2c5f5ddcbfaf99182cc
-  data.tar.gz: 116535d0ada1a04fd19bb9af708390402aeeb983a962af1a681d66e9f9fa81afc515450f1bcae187dcf8de83876a8fd5c9a091ea0d93313033821f34263f51a8
+  metadata.gz: a2be0d6a18f5e3db8a572d2561af13504b7cc752eca1e8fbd9d9d6a443a1d327c6110c93b5541f4c4df98469524f7715c6695bbe41c3489f5459590e194e1cf6
+  data.tar.gz: 24e0423ffdab5c801ebb640332f8cb9156f8069dfc4798b2130ca059d01e9f0b5e7962b422c857e66c303e00ec8054d22275afbb0acf6a2b3e792866de0a7322

data/config/cookstyle.yml

@@ -1941,6 +1941,15 @@ Chef/Modernize/UseChefLanguageSystemdHelper:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+Chef/Modernize/DeclareActionClass:
+  Description: In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.
+  StyleGuide: 'chef_modernize_declareactionclass'
+  Enabled: true
+  VersionAdded: '7.26.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
 ###############################
 # Chef/RedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################
@@ -3026,3 +3035,11 @@ Lint/DeprecatedConstants:
 # always turn on deprecation cops from rubocop
 Lint/ErbNewArguments:
   Enabled: true
+
+# reduce file read complexity
+Style/FileRead:
+  Enabled: true
+
+# reduce file write complexity
+Style/FileWrite:
+  Enabled: true

data/config/disable_all.yml

@@ -19,6 +19,8 @@ Gemspec/DuplicatedAssignment:
   Enabled: false
 Gemspec/OrderedDependencies:
   Enabled: false
+Gemspec/RequireMFA:
+  Enabled: false
 Gemspec/RequiredRubyVersion:
   Enabled: false
 Gemspec/RubyVersionGlobalsUsage:
@@ -459,6 +461,8 @@ Lint/UselessElseWithoutRescue:
   Enabled: false
 Lint/UselessMethodDefinition:
   Enabled: false
+Lint/UselessRuby2Keywords:
+  Enabled: false
 Lint/UselessSetterCall:
   Enabled: false
 Lint/UselessTimes:
@@ -487,6 +491,8 @@ Naming/AccessorMethodName:
   Enabled: false
 Naming/AsciiIdentifiers:
   Enabled: false
+Naming/BlockForwarding:
+  Enabled: false
 Naming/BlockParameterName:
   Enabled: false
 Naming/ClassAndModuleCamelCase:
@@ -637,6 +643,10 @@ Style/ExplicitBlockArgument:
   Enabled: false
 Style/ExponentialNotation:
   Enabled: false
+Style/FileRead:
+  Enabled: false
+Style/FileWrite:
+  Enabled: false
 Style/FloatDivision:
   Enabled: false
 Style/For:
@@ -701,6 +711,8 @@ Style/LambdaCall:
   Enabled: false
 Style/LineEndConcatenation:
   Enabled: false
+Style/MapToHash:
+  Enabled: false
 Style/MethodCallWithoutArgsParentheses:
   Enabled: false
 Style/MethodCallWithArgsParentheses:
@@ -709,6 +721,8 @@ Style/MultilineInPatternThen:
   Enabled: false
 Style/NumberedParameters:
   Enabled: false
+Style/OpenStructUse:
+  Enabled: false
 Style/RedundantAssignment:
   Enabled: false
 Style/RedundantFetchBlock:

data/config/upstream.yml

@@ -78,6 +78,8 @@ AllCops:
   # When specifying style guide URLs, any paths and/or fragments will be
   # evaluated relative to the base URL.
   StyleGuideBaseURL: https://rubystyle.guide
+  # Documentation URLs will be constructed using the base URL.
+  DocumentationBaseURL: https://docs.rubocop.org/rubocop
   # Extra details are not displayed in offense messages by default. Change
   # behavior by overriding ExtraDetails, or by giving the
   # `-E/--extra-details` option.
@@ -150,6 +152,7 @@ AllCops:
     rubocop-minitest: [minitest]
     rubocop-sequel: [sequel]
     rubocop-rake: [rake]
+    rubocop-graphql: [graphql]
 
 #################### Bundler ###############################
 
@@ -258,11 +261,20 @@ Gemspec/OrderedDependencies:
   Include:
     - '**/*.gemspec'
 
+Gemspec/RequireMFA:
+  Description: 'Checks that the gemspec has metadata to require MFA from RubyGems.'
+  Enabled: pending
+  VersionAdded: '1.23'
+  Reference:
+    - https://guides.rubygems.org/mfa-requirement-opt-in/
+  Include:
+    - '**/*.gemspec'
+
 Gemspec/RequiredRubyVersion:
   Description: 'Checks that `required_ruby_version` of gemspec is specified and equal to `TargetRubyVersion` of .rubocop.yml.'
   Enabled: true
   VersionAdded: '0.52'
-  VersionChanged: '0.89'
+  VersionChanged: '1.22'
   Include:
     - '**/*.gemspec'
 
@@ -439,7 +451,11 @@ Layout/ClosingParenthesisIndentation:
 Layout/CommentIndentation:
   Description: 'Indentation of comments.'
   Enabled: true
+  # When true, allows comments to have extra indentation if that aligns them
+  # with a comment on the preceding line.
+  AllowForAlignment: false
   VersionAdded: '0.49'
+  VersionChanged: '1.24'
 
 Layout/ConditionPosition:
   Description: >-
@@ -511,13 +527,13 @@ Layout/EmptyLineBetweenDefs:
   StyleGuide: '#empty-lines-between-methods'
   Enabled: true
   VersionAdded: '0.49'
-  VersionChanged: '1.7'
+  VersionChanged: '1.23'
   EmptyLineBetweenMethodDefs: true
   EmptyLineBetweenClassDefs: true
   EmptyLineBetweenModuleDefs: true
-  # If `true`, this parameter means that single line method definitions don't
-  # need an empty line between them.
-  AllowAdjacentOneLineDefs: false
+  # `AllowAdjacentOneLineDefs` means that single line method definitions don't
+  # need an empty line between them. `true` by default.
+  AllowAdjacentOneLineDefs: true
   # Can be array to specify minimum and maximum number of empty lines, e.g. [1, 2]
   NumberOfEmptyLines: 1
 
@@ -1568,6 +1584,7 @@ Lint/DeprecatedConstants:
   Description: 'Checks for deprecated constants.'
   Enabled: pending
   VersionAdded: '1.8'
+  VersionChanged: '1.22'
   # You can configure deprecated constants.
   # If there is an alternative method, you can set alternative value as `Alternative`.
   # And you can set the deprecated version as `DeprecatedVersion`.
@@ -1588,6 +1605,9 @@ Lint/DeprecatedConstants:
     'FALSE':
       Alternative: 'false'
       DeprecatedVersion: '2.4'
+    'Net::HTTPServerException':
+      Alternative: 'Net::HTTPClientException'
+      DeprecatedVersion: '2.6'
     'Random::DEFAULT':
       Alternative: 'Random.new'
       DeprecatedVersion: '3.0'
@@ -1782,7 +1802,9 @@ Lint/ImplicitStringConcatenation:
 Lint/IncompatibleIoSelectWithFiberScheduler:
   Description: 'Checks for `IO.select` that is incompatible with Fiber Scheduler.'
   Enabled: pending
+  SafeAutoCorrect: false
   VersionAdded: '1.21'
+  VersionChanged: '1.24'
 
 Lint/IneffectiveAccessModifier:
   Description: >-
@@ -2304,6 +2326,11 @@ Lint/UselessMethodDefinition:
   Safe: false
   AllowComments: true
 
+Lint/UselessRuby2Keywords:
+  Description: 'Finds unnecessary uses of `ruby2_keywords`.'
+  Enabled: pending
+  VersionAdded: '1.23'
+
 Lint/UselessSetterCall:
   Description: 'Checks for useless setter call to a local variable.'
   Enabled: true
@@ -2460,6 +2487,16 @@ Naming/BinaryOperatorParameterName:
   VersionAdded: '0.50'
   VersionChanged: '1.2'
 
+Naming/BlockForwarding:
+  Description: 'Use anonymous block forwarding.'
+  StyleGuide: '#block-forwarding'
+  Enabled: pending
+  VersionAdded: '1.24'
+  EnforcedStyle: anonymous
+  SupportedStyles:
+    - anonymous
+    - explicit
+
 Naming/BlockParameterName:
   Description: >-
                  Checks for block parameter names that contain capital letters,
@@ -2497,6 +2534,7 @@ Naming/FileName:
   StyleGuide: '#snake-case-files'
   Enabled: true
   VersionAdded: '0.50'
+  VersionChanged: '1.23'
   # Camel case file names listed in `AllCops:Include` and all file names listed
   # in `AllCops:Exclude` are excluded by default. Add extra excludes here.
   Exclude: []
@@ -2509,6 +2547,13 @@ Naming/FileName:
   # whether each source file's class or module name matches the file name --
   # not whether the nested module hierarchy matches the subdirectory path.
   CheckDefinitionPathHierarchy: true
+  # paths that are considered root directories, for example "lib" in most ruby projects
+  # or "app/models" in rails projects
+  CheckDefinitionPathHierarchyRoots:
+    - lib
+    - spec
+    - test
+    - src
   # If non-`nil`, expect all source file names to match the following regex.
   # Only the file name itself is matched, not the entire file path.
   # Use anchors as necessary if you want to match the entire name rather than
@@ -2754,10 +2799,9 @@ Security/JSONLoad:
   Reference: 'https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html#method-i-load'
   Enabled: true
   VersionAdded: '0.43'
-  VersionChanged: '0.44'
+  VersionChanged: '1.22'
   # Autocorrect here will change to a method that may cause crashes depending
   # on the value of the argument.
-  AutoCorrect: false
   SafeAutoCorrect: false
 
 Security/MarshalLoad:
@@ -3466,6 +3510,18 @@ Style/ExponentialNotation:
     - engineering
     - integral
 
+Style/FileRead:
+  Description: 'Favor `File.(bin)read` convenience methods.'
+  StyleGuide: '#file-read'
+  Enabled: pending
+  VersionAdded: '1.24'
+
+Style/FileWrite:
+  Description: 'Favor `File.(bin)write` convenience methods.'
+  StyleGuide: '#file-write'
+  Enabled: pending
+  VersionAdded: '1.24'
+
 Style/FloatDivision:
   Description: 'For performing float division, coerce one side only.'
   StyleGuide: '#float-division'
@@ -3624,7 +3680,7 @@ Style/HashSyntax:
   StyleGuide: '#hash-literals'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.43'
+  VersionChanged: '1.24'
   EnforcedStyle: ruby19
   SupportedStyles:
     # checks for 1.9 syntax (e.g. {a: 1}) for all symbol keys
@@ -3635,6 +3691,13 @@ Style/HashSyntax:
     - no_mixed_keys
     # enforces both ruby19 and no_mixed_keys styles
     - ruby19_no_mixed_keys
+  # Force hashes that have a hash value omission
+  EnforcedShorthandSyntax: always
+  SupportedShorthandSyntax:
+    # forces use of the 3.1 syntax (e.g. {foo:}) when the hash key and value are the same.
+    - always
+    # forces use of explicit hash literal value.
+    - never
   # Force hashes that have a symbol value to use hash rockets
   UseHashRocketsWithSymbolValues: false
   # Do not suggest { a?: 1 } over { :a? => 1 } in ruby19 style
@@ -3811,6 +3874,12 @@ Style/LineEndConcatenation:
   VersionAdded: '0.18'
   VersionChanged: '0.64'
 
+Style/MapToHash:
+  Description: 'Prefer `to_h` with a block over `map.to_h`.'
+  Enabled: pending
+  VersionAdded: '1.24'
+  Safe: false
+
 Style/MethodCallWithArgsParentheses:
   Description: 'Use parentheses for method calls with arguments.'
   StyleGuide: '#method-invocation-parens'
@@ -4179,6 +4248,8 @@ Style/NumericLiterals:
   VersionChanged: '0.48'
   MinDigits: 5
   Strict: false
+  # You can specify allowed numbers. (e.g. port number 3000, 8080, and etc)
+  AllowedNumbers: []
 
 Style/NumericPredicate:
   Description: >-
@@ -4213,6 +4284,16 @@ Style/OneLineConditional:
   VersionAdded: '0.9'
   VersionChanged: '0.90'
 
+Style/OpenStructUse:
+  Description: >-
+                 Avoid using OpenStruct. As of Ruby 3.0, use is officially discouraged due to performance,
+                 version compatibility, and potential security issues.
+  Reference:
+    - https://docs.ruby-lang.org/en/3.0.0/OpenStruct.html#class-OpenStruct-label-Caveats
+
+  Enabled: pending
+  VersionAdded: '1.23'
+
 Style/OptionHash:
   Description: "Don't use option hashes when you can use keyword arguments."
   Enabled: false

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.25.6" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.22.0'
+  VERSION = "7.26.1" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.24.1'
 end

data/lib/rubocop/cop/chef/modernize/class_eval_action_class.rb

@@ -40,7 +40,6 @@ module RuboCop
           minimum_target_chef_version '12.9'
 
           MSG = 'In Chef Infra Client 12.9 and later it is no longer necessary to call the class_eval method on the action class block.'
-          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :class_eval_action_class?, <<-PATTERN
             (block

data/lib/rubocop/cop/chef/modernize/declare_action_class.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Modernize
+        # In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   declare_action_class do
+        #     foo
+        #   end
+        #
+        #   #### correct
+        #   action_class do
+        #     foo
+        #   end
+        #
+        class DeclareActionClass < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.9'
+
+          MSG = 'In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.'
+          RESTRICT_ON_SEND = [:declare_action_class].freeze
+
+          def on_send(node)
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub('declare_action_class', 'action_class'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/monkey_patches/directive_comment.rb

@@ -3,7 +3,7 @@ module RuboCop
   # we're monkey patching the config regex to allow for # cookstyle: disable whatever
   # in addition to the # rubocop: disable whatever that comes with RuboCop
   class DirectiveComment
-    remove_const('DIRECTIVE_COMMENT_REGEXP')
+    remove_const(:DIRECTIVE_COMMENT_REGEXP)
     DIRECTIVE_COMMENT_REGEXP = Regexp.new(
       "# (?:rubocop|cookstyle) : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
         .gsub(' ', '\s*')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.25.6
+  version: 7.26.1
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 1.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 1.24.1
 description: 
 email:
 - thom@chef.io
@@ -188,6 +188,7 @@ files:
 - lib/rubocop/cop/chef/modernize/cron_d_file_or_template.rb
 - lib/rubocop/cop/chef/modernize/cron_manage_resource.rb
 - lib/rubocop/cop/chef/modernize/databag_helpers.rb
+- lib/rubocop/cop/chef/modernize/declare_action_class.rb
 - lib/rubocop/cop/chef/modernize/default_action_initializer.rb
 - lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
 - lib/rubocop/cop/chef/modernize/definitions.rb