cookstyle 7.15.3 → 7.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f116bfdcd0e284199c7b8b88cee62d6996fc1d73a9121cee6bb0680d5caffdc
-  data.tar.gz: b6ec8250e505bc20e30188f50981f90f5d866520ce533f3c7feb35f40fd860be
+  metadata.gz: e1efe7fb1177e49d1ee5f83fef4238438ad397342bf04e4aa1efa705b567ebc2
+  data.tar.gz: 0a5899ba6f505c59470620c738affb9a5642258ede37d690fb6270b81b89c8d1
 SHA512:
-  metadata.gz: 28c7d62c93b33ca7fc885a02cf17b87a1ea51a296e656aedf509d48215de59701aae1edc063ecf21d9287a94d7bc0c4464ca19ecb32de985e4ab15305e286528
-  data.tar.gz: bc7811af3489dc73ee1fa0d2e2934cdb321ca0486386ccd24f190bd19e914f1da7c896c40ea6f8390181c580a19218cb8c368c336c3ec1ed015b256cbadc9764
+  metadata.gz: e96d0dc478cb7ff1b75d04bbeee4bd35b66a88f4f930b738f92edbb908df7f002878688253a28473da39ccac587c950fa4c694e5f3f400d693ae54340029a5cd
+  data.tar.gz: adf2a361b46f9c47c47343990a677bac16161f1d53b76f23cadea0ba22b708d6d131f227350a058a42d9be690fedf0f264f0f4231f4d7bb9fa2bf088c1cef802

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
 ###############################
@@ -1217,6 +1225,18 @@ Chef/Deprecations/PolicyfileCommunitySource:
   Include:
     - '**/Policyfile.rb'
 
+Chef/Deprecations/DeprecatedSudoActions:
+  Description: The `sudo` resource in the sudo cookbook 5.0 (2018) or Chef Infra Client 14 and later have replaced the existing `:install` and `:remove` actions with `:create` and `:delete` actions to better match other resources in Chef Infra.
+  StyleGuide: 'chef_deprecations_deprecatedsudoactions'
+  Enabled: true
+  VersionAdded: '7.18.0'
+  Exclude:
+    - '**/spec/**/*.rb'
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+    - '**/Rakefile'
+
 ###############################
 # Chef/Modernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -2450,6 +2470,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.3" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.18.4'
+  VERSION = "7.18.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/deprecated_sudo_actions.rb

@@ -0,0 +1,65 @@
+# 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 Deprecations
+        # The `sudo` resource in the sudo cookbook 5.0 (2018) or Chef Infra Client 14 and later have replaced the existing `:install` and `:remove` actions with `:create` and `:delete` actions to better match other resources in Chef Infra.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   sudo 'admins' do
+        #     users 'bob'
+        #     groups 'sysadmins, superusers'
+        #     action :remove
+        #   end
+        #
+        #   #### correct
+        #   sudo 'admins' do
+        #     users 'bob'
+        #     groups 'sysadmins, superusers'
+        #     action :delete
+        #   end
+        #
+        class DeprecatedSudoActions < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'The `sudo` resource in the sudo cookbook 5.0 (2018) or Chef Infra Client 14 and later have replaced the existing `:install` and `:remove` actions with `:create` and `:delete` actions to better match other resources in Chef Infra.'
+
+          def on_block(node)
+            match_property_in_resource?(:sudo, 'action', node) do |prop_node|
+              next unless prop_node.arguments.first.sym_type?
+              next unless [s(:sym, :install), s(:sym, :remove)].include?(prop_node.arguments.first)
+
+              add_offense(prop_node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(prop_node, prop_node.source
+                  .gsub('install', 'create')
+                  .gsub('remove', 'delete'))
+              end
+            end
+          end
+        end
+      end
+    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.3
+  version: 7.18.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2021-08-14 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
@@ -105,6 +106,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_shellout_methods.rb
+- lib/rubocop/cop/chef/deprecation/deprecated_sudo_actions.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