cookstyle 7.2.1 → 7.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8088b6d9be87be39e75eb71adcaf0ce5d1470f2fc560313d33a023b46de609f4
-  data.tar.gz: d62c2c523a653133a5926ada9ec9bfcee1fc17bb9f37bc1095e140f4bf106c38
+  metadata.gz: 7e45a26b3da9f964cf0e791fb11bf6c524a627403f266c5ab809c17bef6a6999
+  data.tar.gz: d2adff5897b1b0fc4700252fa51026eff90826d353ce390e70480776caf7993e
 SHA512:
-  metadata.gz: 2dfdc60f0577fd7d2e9445e321f8412a0b8711a9f6b4e0ac8611d98519f809df02d2d4c1614e56dc613eb271230a754b5fef5eb4d61a8265090183d803dcda68
-  data.tar.gz: 628882e2d671e86016e303782139fbf7b3cc8f1715e73f1228fcb6d5eb15dcb19319e3f556533d7a048d2bb613bdcc2cc55d01aa52e45ef70c32548e53bbbfad
+  metadata.gz: 042130c9ee03c716518ab26e4a1f53b9748eba6c1f268c86f74795ca2a1fd06320a0cc16bc248fc8179a3501970576af7777b679d886c71ed3caf09e19d6d2e3
+  data.tar.gz: 96ac7744718b752f666b55cea268d0b9bfd2c7dd17d19305078a5daed83c358c8c07504964a381d3cb5dac7bb05ec2298e15126196143931ab948f67d9d2439f

data/Gemfile

@@ -28,7 +28,4 @@ end
 group :development do
   gem 'rake'
   gem 'rspec', '>= 3.4'
-end
-
-# pin until we drop ruby 2.4 and then remove this entirely
-gem 'parallel', '< 1.20'
+end

data/config/cookstyle.yml

@@ -1,4 +1,5 @@
 AllCops:
+  SuggestExtensions: false
   TargetRubyVersion: 2.4
   TargetChefVersion: ~
   Exclude:
@@ -819,7 +820,8 @@ Chef/Deprecations/UsesRunCommandHelper:
   VersionAdded: '5.9.0'
   Exclude:
     - '**/metadata.rb'
-    - 'Rakefile'
+    - '**/Berksfile'
+    - '**/Rakefile'
 
 Chef/Deprecations/ChefHandlerUsesSupports:
   Description: Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
@@ -836,6 +838,8 @@ Chef/Deprecations/DeprecatedYumRepositoryProperties:
   VersionAdded: '5.10.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
 
 Chef/Deprecations/EOLAuditModeUsage:
   Description: The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more informmation.
@@ -844,6 +848,8 @@ Chef/Deprecations/EOLAuditModeUsage:
   VersionAdded: '5.10.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
 
 Chef/Deprecations/ResourceInheritsFromCompatResource:
   Description: HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
@@ -860,12 +866,18 @@ Chef/Deprecations/VerifyPropertyUsesFileExpansion:
   VersionAdded: '5.10.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
 
 Chef/Deprecations/PoiseArchiveUsage:
   Description: The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+.
   StyleGuide: '#chefdeprecationspoisearchiveusage'
   Enabled: true
   VersionAdded: '5.11.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
 
 Chef/Deprecations/PartialSearchHelperUsage:
   Description: Legacy partial_search usage should be updated to use :filter_result in the search helper instead.
@@ -906,6 +918,8 @@ Chef/Deprecations/LegacyNotifySyntax:
   VersionAdded: '5.13.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
 
 Chef/Deprecations/NodeSetWithoutLevel:
   Description: When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.
@@ -1154,6 +1168,27 @@ Chef/Deprecations/FoodcriticTesting:
     - '**/Rakefile'
     - '**/Gemfile'
 
+Chef/Deprecations/DeprecatedYumRepositoryActions:
+  Description: With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several actions in the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
+  StyleGuide: '#chefdeprecationsdeprecatedyumrepositoryactions'
+  Enabled: true
+  VersionAdded: '7.3.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+    - '**/Rakefile'
+
+Chef/Deprecations/ChefSugarHelpers:
+  Description: Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started
+  StyleGuide: '#chefdeprecationschefsugarhelpers'
+  Enabled: true
+  VersionAdded: '7.3.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+    - '**/Rakefile'
+
 ###############################
 # Chef/Modernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -1211,6 +1246,7 @@ Chef/Modernize/RespondToProvides:
   VersionAdded: '5.2.0'
   Include:
     - '**/providers/*.rb'
+    - '**/resources/*.rb'
     - '**/libraries/*.rb'
 
 Chef/Modernize/SetOrReturnInResources:
@@ -1714,7 +1750,6 @@ Chef/Modernize/ActionMethodInResource:
   Include:
     - '**/resources/*.rb'
     - '**/providers/*.rb'
-    - '**/libraries/*.rb'
 
 ###############################
 # Chef/RedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
@@ -2096,6 +2131,7 @@ Style/EmptyElse:
   Enabled: true
 Layout/EmptyLineBetweenDefs:
   Enabled: true
+  AllowAdjacentOneLineDefs: true
 Layout/EmptyLines:
   Enabled: true
 Layout/EmptyLinesAroundAccessModifier:
@@ -2439,10 +2475,9 @@ Metrics/BlockNesting:
 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
+# The warning message from this is misleading and can lead to wrong but syntactically valid code.
 Lint/SendWithMixinArgument:
-  Enabled: true
+  Enabled: false
 
 # this migrates old # rubocop: comments to use the latest namespaces, which prevents a ton of spam during cookstyle runs
 Migration/DepartmentName:
@@ -2767,4 +2802,4 @@ Lint/RedundantSafeNavigation:
 
 # Avoid using blocks to remove nils from a Hash/Array
 Style/CollectionCompact:
-  Enabled: true
+  Enabled: true

data/config/disable_all.yml

@@ -393,6 +393,8 @@ Lint/TrailingCommaInAttributeDeclaration:
   Enabled: false
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
+Lint/UnexpectedBlockArity:
+  Enabled: false
 Lint/UnifiedInteger:
   Enabled: false
 Lint/UnmodifiedReduceAccumulator:
@@ -755,6 +757,8 @@ Style/RaiseArgs:
   Enabled: false
 Style/RandomWithOffset:
   Enabled: false
+Style/RedundantArgument:
+  Enabled: false
 Style/RedundantBegin:
   Enabled: false
 Style/RedundantCapitalW:

data/config/upstream.yml

@@ -139,6 +139,16 @@ AllCops:
   # from the lock file.) If the Ruby version is still unresolved, RuboCop will
   # use the oldest officially supported Ruby version (currently Ruby 2.4).
   TargetRubyVersion: ~
+  # Determines if a notification for extension libraries should be shown when
+  # rubocop is run. Keys are the name of the extension, and values are an array
+  # of gems in the Gemfile that the extension is suggested for, if not already
+  # included.
+  SuggestExtensions:
+    rubocop-rails: [rails]
+    rubocop-rspec: [rspec, rspec-rails]
+    rubocop-minitest: [minitest]
+    rubocop-sequel: [sequel]
+    rubocop-rake: [rake]
 
 #################### Bundler ###############################
 
@@ -459,10 +469,14 @@ Layout/EmptyLineAfterMultilineCondition:
     - https://github.com/airbnb/ruby#multiline-if-newline
 
 Layout/EmptyLineBetweenDefs:
-  Description: 'Use empty lines between defs.'
+  Description: 'Use empty lines between class/module/method defs.'
   StyleGuide: '#empty-lines-between-methods'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '1.4'
+  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
@@ -891,8 +905,8 @@ Layout/LineLength:
   StyleGuide: '#max-line-length'
   Enabled: true
   VersionAdded: '0.25'
-  VersionChanged: '1.3'
-  AutoCorrect: false
+  VersionChanged: '1.4'
+  AutoCorrect: true
   Max: 120
   # To make it possible to copy or click on URIs in the code, we allow lines
   # containing a URI to be longer than Max.
@@ -1684,6 +1698,7 @@ Lint/MissingSuper:
                   without calls to `super`'.
   Enabled: true
   VersionAdded: '0.89'
+  VersionChanged: '1.4'
 
 Lint/MixedRegexpCaptureTypes:
   Description: 'Do not mix named captures and numbered captures in a Regexp literal.'
@@ -1993,6 +2008,23 @@ Lint/UnderscorePrefixedVariableName:
   VersionAdded: '0.21'
   AllowKeywordBlockArguments: false
 
+Lint/UnexpectedBlockArity:
+  Description: 'Looks for blocks that have fewer arguments that the calling method expects.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.5'
+  Methods:
+    chunk_while: 2
+    each_with_index: 2
+    each_with_object: 2
+    inject: 2
+    max: 2
+    min: 2
+    minmax: 2
+    reduce: 2
+    slice_when: 2
+    sort: 2
+
 Lint/UnifiedInteger:
   Description: 'Use Integer instead of Fixnum or Bignum.'
   Enabled: true
@@ -2002,6 +2034,7 @@ Lint/UnmodifiedReduceAccumulator:
   Description: Checks for `reduce` or `inject` blocks that do not update the accumulator each iteration.
   Enabled: pending
   VersionAdded: '1.1'
+  VersionChanged: '1.5'
 
 Lint/UnreachableCode:
   Description: 'Unreachable code.'
@@ -2105,21 +2138,23 @@ Metrics/AbcSize:
     - https://en.wikipedia.org/wiki/ABC_Software_Metric
   Enabled: true
   VersionAdded: '0.27'
-  VersionChanged: '0.81'
+  VersionChanged: '1.5'
   # The ABC size is a calculated magnitude, so this number can be an Integer or
   # a Float.
   IgnoredMethods: []
+  CountRepeatedAttributes: true
   Max: 17
 
 Metrics/BlockLength:
   Description: 'Avoid long blocks with many lines.'
   Enabled: true
   VersionAdded: '0.44'
-  VersionChanged: '0.87'
+  VersionChanged: '1.5'
   CountComments: false  # count full line comments?
   Max: 25
   CountAsOne: []
-  ExcludedMethods:
+  ExcludedMethods: [] # deprecated, retained for backwards compatibility
+  IgnoredMethods:
     # By default, exclude the `#refine` method, as it tends to have larger
     # associated blocks.
     - refine
@@ -2160,11 +2195,12 @@ Metrics/MethodLength:
   StyleGuide: '#short-methods'
   Enabled: true
   VersionAdded: '0.25'
-  VersionChanged: '0.87'
+  VersionChanged: '1.5'
   CountComments: false  # count full line comments?
   Max: 10
   CountAsOne: []
-  ExcludedMethods: []
+  ExcludedMethods: [] # deprecated, retained for backwards compatibility
+  IgnoredMethods: []
 
 Metrics/ModuleLength:
   Description: 'Avoid modules longer than 100 lines of code.'
@@ -2180,8 +2216,10 @@ Metrics/ParameterLists:
   StyleGuide: '#too-many-params'
   Enabled: true
   VersionAdded: '0.25'
+  VersionChanged: '1.5'
   Max: 5
   CountKeywordArgs: true
+  MaxOptionalParameters: 3
 
 Metrics/PerceivedComplexity:
   Description: >-
@@ -2451,7 +2489,7 @@ Naming/VariableNumber:
   StyleGuide: '#snake-case-symbols-methods-vars-with-numbers'
   Enabled: true
   VersionAdded: '0.50'
-  VersionChanged: '1.3'
+  VersionChanged: '1.4'
   EnforcedStyle: normalcase
   SupportedStyles:
     - snake_case
@@ -2459,7 +2497,13 @@ Naming/VariableNumber:
     - non_integer
   CheckMethodNames: true
   CheckSymbols: true
-  AllowedIdentifiers: []
+  AllowedIdentifiers:
+    - capture3     # Open3.capture3
+    - iso8601      # Time#iso8601
+    - rfc1123_date # CGI.rfc1123_date
+    - rfc822       # Time#rfc822
+    - rfc2822      # Time#rfc2822
+    - rfc3339      # DateTime.rfc3339
 
 #################### Security ##############################
 
@@ -3976,6 +4020,17 @@ Style/RandomWithOffset:
   Enabled: true
   VersionAdded: '0.52'
 
+Style/RedundantArgument:
+  Description: 'Check for a redundant argument passed to certain methods.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.4'
+  Methods:
+    # Array#join
+    join: ''
+    # String#split
+    split: ' '
+
 Style/RedundantAssignment:
   Description: 'Checks for redundant assignment before returning.'
   Enabled: true
@@ -4246,6 +4301,7 @@ Style/SoleNestedConditional:
                   which can be merged into outer conditional node.
   Enabled: true
   VersionAdded: '0.89'
+  VersionChanged: '1.5'
   AllowModifier: false
 
 Style/SpecialGlobalVars:
@@ -4378,7 +4434,7 @@ Style/SymbolProc:
   Enabled: true
   Safe: false
   VersionAdded: '0.26'
-  VersionChanged: '0.64'
+  VersionChanged: '1.5'
   # A list of method names to be ignored by the check.
   # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
   IgnoredMethods:

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.2.1" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.3.1'
+  VERSION = "7.3.10" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.5.0'
 end

data/lib/rubocop/cop/chef/deprecation/chef_sugar_helpers.rb

@@ -0,0 +1,56 @@
+# 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
+      # Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started
+      #
+      # @example
+      #
+      #   # bad
+      #   vagrant_key?
+      #   vagrant_domain?
+      #   vagrant_user?
+      #   require_chef_gem
+      #   best_ip_for(node)
+      #   nexus?
+      #   ios_xr?
+      #   ruby_20?
+      #   ruby_19?
+      #   includes_recipe?('foo::bar')
+      #   wrlinux?
+      #   dev_null
+      #   nexentacore_platform?
+      #   opensolaris_platform?
+      #   nexentacore?
+      #   opensolaris?
+      #
+      module Deprecations
+        class ChefSugarHelpers < Base
+          MSG = 'Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started'
+          RESTRICT_ON_SEND = [:vagrant_key?, :vagrant_domain?, :vagrant_user?, :require_chef_gem, :best_ip_for, :nexus?, :ios_xr?, :ruby_20?, :ruby_19?, :includes_recipe?, :wrlinux?, :dev_null, :nexentacore_platform?, :opensolaris_platform?, :nexentacore?, :opensolaris?].freeze
+
+          def on_send(node)
+            add_offense(node, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb

@@ -55,7 +55,7 @@ module RuboCop
               '< 11' => true,
             },
             'mac_os_x' => {
-              '< 10.12' => '10.15',
+              '< 10.14' => '10.15',
             },
             'suse' => {
               '~> 12.0, < 12.4' => '12',
@@ -67,8 +67,7 @@ module RuboCop
               '= 15.0' => '15',
             },
             'debian' => {
-              '< 8' => true,
-              '> 8.0, < 8.11' => '8',
+              '< 9' => true,
               '> 9.0, < 9.11' => '9',
             },
             'centos' => {

data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_actions.rb

@@ -0,0 +1,67 @@
+# 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
+      module Deprecations
+        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 the actions the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
+        #
+        # @example
+        #
+        #   # bad
+        #   yum_repository 'OurCo' do
+        #     description 'OurCo yum repository'
+        #     baseurl 'http://artifacts.ourco.org/foo/bar'
+        #     gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
+        #     action :add
+        #   end
+        #
+        #   # good
+        #   yum_repository 'OurCo' do
+        #     description 'OurCo yum repository'
+        #     baseurl 'http://artifacts.ourco.org/foo/bar'
+        #     gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
+        #     action :create
+        #   end
+        #
+        class DeprecatedYumRepositoryActions < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.14'
+
+          MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource the actions the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.'
+
+          def on_block(node)
+            match_property_in_resource?(:yum_repository, 'action', node) do |prop_node|
+              next unless prop_node.arguments.first.sym_type?
+              next unless [s(:sym, :add), s(:sym, :delete)].include?(prop_node.arguments.first)
+
+              add_offense(prop_node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(prop_node, prop_node.source
+                  .gsub('add', 'create')
+                  .gsub('delete', 'remove'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/comment_sentence_spacing.rb

@@ -26,7 +26,7 @@ module RuboCop
           extend AutoCorrector
           MSG = 'Use a single space after sentences in comments'
 
-          def investigate(processed_source)
+          def on_new_investigation
             return unless processed_source.ast
 
             processed_source.comments.each do |comment|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.2.1
+  version: 7.3.10
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.5.0
 description: 
 email:
 - thom@chef.io
@@ -92,6 +92,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/chef_rest.rb
 - lib/rubocop/cop/chef/deprecation/chef_rewind.rb
 - lib/rubocop/cop/chef/deprecation/chef_shellout.rb
+- lib/rubocop/cop/chef/deprecation/chef_sugar_helpers.rb
 - lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb
 - lib/rubocop/cop/chef/deprecation/chefdk_generators.rb
 - lib/rubocop/cop/chef/deprecation/cheffile.rb
@@ -106,6 +107,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_shellout_methods.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_windows_version_check.rb
+- lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_actions.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb
 - lib/rubocop/cop/chef/deprecation/easy_install.rb
 - lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb