cookstyle 7.15.2 → 7.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfc2c66f2febd5fbd7ee14e3fe798ae10f1dc8b7fa3df2a3ebfd068a024f845f
-  data.tar.gz: 9f6bef8fb1d57f40fd9a94900d5b0e4a95c98682124b79f7de85e83af244899c
+  metadata.gz: 0c717dffb3528a52a96f90cdfc26f3230a0b621314b1ede81ee2bc907f6e6afa
+  data.tar.gz: 6ffb9d37305d351d6c0512dd070516ebb8d741ba178358cdf38c05ae4c470d4f
 SHA512:
-  metadata.gz: 78197b457795eff5976c4ed4bd6b8458be306b900142799027f4a5848bd0f722d5c9b3b3431349c4a2c48783038289b06a983dba383c13c05bc0391c4ab6c1aa
-  data.tar.gz: 6af82797747ea7eebc69a5f21e8a1d79858534ec318b620ee324bedb9a18530b5e897f087b58bfaa9d7d4e240041c3aa497cb42326725f827d62fd551f092dc4
+  metadata.gz: 2eb06bb46004aa146557e2aae9b95065ad238820b5e832c2bad1fe7c13ce652d43adfd3a18073051b4a575ddfd54b719cd2c5af93e1557fac6e8b987d5801392
+  data.tar.gz: ccf7386507af4bee4e860a40ecc82e0e5a916de30eb3cc2d3e1a4550736f541018546310779c347b0e18db6c9afca6294840d3ed9ee86ab19070d0bf423dbf2e

data/config/cookstyle.yml

@@ -481,6 +481,14 @@ Chef/Correctness/OctalModeAsString:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+Chef/Correctness/MetadataMalformedDepends:
+  Description: Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead.
+  StyleGuide: 'chef_correctness_metadatamalformeddepends'
+  Enabled: true
+  VersionAdded: '7.16'
+  Include:
+    - '**/metadata.rb'
+
 ###############################
 # Chef/Sharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -1206,6 +1214,7 @@ Chef/Deprecations/ResourceWithoutUnifiedTrue:
   Include:
     - '**/resources/*.rb'
   Exclude:
+    - '**/resources/_*.rb'
     - '**/spec/**/*.rb'
 
 Chef/Deprecations/PolicyfileCommunitySource:
@@ -2449,6 +2458,8 @@ Lint/HandleExceptions:
   Enabled: true
 Lint/ImplicitStringConcatenation:
   Enabled: true
+  Exclude:
+    - '**/metadata.rb' # this prevents conflicts with Chef/Correctness/MetadataMalformedDepends
 Lint/IneffectiveAccessModifier:
   Enabled: true
 Lint/LiteralAsCondition:

data/config/disable_all.yml

@@ -219,6 +219,8 @@ Lint/AmbiguousBlockAssociation:
   Enabled: false
 Lint/AmbiguousOperator:
   Enabled: false
+Lint/AmbiguousRange:
+  Enabled: false
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
 Lint/AssignmentInCondition:
@@ -705,6 +707,8 @@ Style/RedundantFileExtensionInRequire:
   Enabled: false
 Style/RedundantSelfAssignment:
   Enabled: false
+Style/RedundantSelfAssignmentBranch:
+  Enabled: false
 Style/SoleNestedConditional:
   Enabled: false
 Style/StaticClass:

data/config/upstream.yml

@@ -1434,6 +1434,13 @@ Lint/AmbiguousOperator:
   VersionAdded: '0.17'
   VersionChanged: '0.83'
 
+Lint/AmbiguousRange:
+  Description: Checks for ranges with ambiguous boundaries.
+  Enabled: pending
+  VersionAdded: '1.19'
+  SafeAutoCorrect: false
+  RequireParenthesesForMethodChains: false
+
 Lint/AmbiguousRegexpLiteral:
   Description: >-
                  Checks for ambiguous regexp literals in the first argument of
@@ -1824,7 +1831,6 @@ Lint/MultipleComparison:
   Enabled: true
   VersionAdded: '0.47'
   VersionChanged: '1.1'
-  AllowMethodComparison: true
 
 Lint/NestedMethodDefinition:
   Description: 'Do not use nested method definitions.'
@@ -2557,6 +2563,7 @@ Naming/InclusiveLanguage:
         - denylist
         - block
     slave:
+      WholeWord: true
       Suggestions: ['replica', 'secondary', 'follower']
 
 Naming/MemoizedInstanceVariableName:
@@ -3155,8 +3162,9 @@ Style/CommentAnnotation:
 Style/CommentedKeyword:
   Description: 'Do not place comments on the same line as certain keywords.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.51'
-  VersionChanged: '1.7'
+  VersionChanged: '1.19'
 
 Style/ConditionalAssignment:
   Description: >-
@@ -3603,8 +3611,9 @@ Style/IdenticalConditionalBranches:
                  line at the end of each branch, which can validly be moved
                  out of the conditional.
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.36'
-  VersionChanged: '1.16'
+  VersionChanged: '1.19'
 
 Style/IfInsideElse:
   Description: 'Finds if nodes inside else, which can be converted to elsif.'
@@ -3929,6 +3938,7 @@ Style/MultipleComparison:
   Enabled: true
   VersionAdded: '0.49'
   VersionChanged: '1.1'
+  AllowMethodComparison: true
 
 Style/MutableConstant:
   Description: 'Do not assign mutable objects to constants.'
@@ -4152,6 +4162,7 @@ Style/OptionHash:
     - args
     - params
     - parameters
+  Allowlist: []
 
 Style/OptionalArguments:
   Description: >-
@@ -4404,6 +4415,11 @@ Style/RedundantSelfAssignment:
   Safe: false
   VersionAdded: '0.90'
 
+Style/RedundantSelfAssignmentBranch:
+  Description: 'Checks for places where conditional branch makes redundant self-assignment.'
+  Enabled: pending
+  VersionAdded: '1.19'
+
 Style/RedundantSort:
   Description: >-
                   Use `min` instead of `sort.first`,
@@ -4575,6 +4591,7 @@ Style/SpecialGlobalVars:
   VersionAdded: '0.13'
   VersionChanged: '0.36'
   SafeAutoCorrect: false
+  RequireEnglish: true
   EnforcedStyle: use_english_names
   SupportedStyles:
     - use_perl_names
@@ -4895,7 +4912,7 @@ Style/VariableInterpolation:
 
 Style/WhenThen:
   Description: 'Use when x then ... for one-line cases.'
-  StyleGuide: '#one-line-cases'
+  StyleGuide: '#no-when-semicolons'
   Enabled: true
   VersionAdded: '0.9'
 
@@ -4919,7 +4936,7 @@ Style/WordArray:
   StyleGuide: '#percent-w'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.36'
+  VersionChanged: '1.19'
   EnforcedStyle: percent
   SupportedStyles:
     # percent style: %w(word1 word2)

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.15.2" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.18.4'
+  VERSION = "7.17.0" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.19.0'
 end

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

@@ -0,0 +1,58 @@
+# 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 Correctness
+        # metadata.rb cookbook dependencies and version constraints should be comma separated
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'some_awesome_cookbook' '= 4.5.5'
+        #   depends 'some_other_cool_cookbook' '< 8.0'
+        #
+        #   #### correct
+        #   depends 'some_awesome_cookbook', '= 4.5.5'
+        #   depends 'some_other_cool_cookbook', '< 8.0'
+        #
+        class MetadataMalformedDepends < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          RESTRICT_ON_SEND = [:depends].freeze
+          MSG = 'metadata.rb cookbook dependencies and version constraints should be comma separated'
+
+          def_node_matcher :depends_without_comma?, <<-PATTERN
+            (send nil? :depends
+              (dstr
+                $(str _ )
+                $(str _ )))
+          PATTERN
+
+          def on_send(node)
+            depends_without_comma?(node) do |cb, ver|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "depends '#{cb.value}', '#{ver.value}'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright:: 2019, Chef Software Inc.
+# Copyright:: 2019-2021, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,6 +27,7 @@ module RuboCop
         #   name 'foo'
         #
         class MetadataMissingName < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'
@@ -37,11 +38,10 @@ module RuboCop
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             return if cb_name?(processed_source.ast)
             range = source_range(processed_source.buffer, 1, 0)
-            add_offense(range, message: MSG, severity: :refactor) do |_corrector|
+            add_offense(range, message: MSG, severity: :refactor) do |corrector|
               path = processed_source.path
               cb_name = File.basename(File.dirname(path))
-              metadata = IO.read(path)
-              IO.write(path, "name '#{cb_name}'\n" + metadata)
+              corrector.insert_before(processed_source.ast, "name '#{cb_name}'\n")
             end
           end
         end

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

@@ -54,6 +54,9 @@ module RuboCop
           def_node_search :provides, '(send nil? :provides ...)'
 
           def on_new_investigation
+            # gracefully fail if the resource is empty
+            return if processed_source.ast.nil?
+
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             return if unified_mode?(processed_source.ast)
             range = source_range(processed_source.buffer, 1, 0)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.15.2
+  version: 7.17.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.4
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.4
+        version: 1.19.0
 description: 
 email:
 - thom@chef.io
@@ -69,6 +69,7 @@ files:
 - lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb
 - lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb
 - lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb
+- lib/rubocop/cop/chef/correctness/metadata_malformed_version.rb
 - lib/rubocop/cop/chef/correctness/metadata_missing_name.rb
 - lib/rubocop/cop/chef/correctness/node_normal.rb
 - lib/rubocop/cop/chef/correctness/node_normal_unless.rb