cookstyle 6.10.2 → 6.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe8edd0728c5a74a2496aa1fea1093bbcafbe584b37c2e3a65edc1103fa8580d
-  data.tar.gz: 11abc23f923ef8b0e50bb91223cedc33c6b230ba1d30c2f4d37feb49df1452e4
+  metadata.gz: 4593dcbd93b8d0d668e0fe5e5551147db850c38deabcccf698b3f8ea391c281d
+  data.tar.gz: ef4557926f01a865f3ced43e0ad7a464659f597f4f6ffc8104c2f978d959324a
 SHA512:
-  metadata.gz: 779695f4dd5a791a76ba01c59debefcc697826bbd3bbe2663369163a0d451d703dfc30f28c44017e34f9574c7c6365690ed1a4839fe116e51e1a42037bfb7144
-  data.tar.gz: 87aed3d5935014296eae0b5280ef942011e31a546e92391d604eb581fcd0ea8f0882f03b08a50633c18ed876acbe895fc8dbd653adcd3345ac70a683b30afceb
+  metadata.gz: e3d3b5ed0ccd193ae9aad8d8e44a03935010a841c3cf551ce070c557f2f27e93ba2ffa2082042741f481ccabb7abf68e83d958ed06e3c5751556b7f0528aa3ae
+  data.tar.gz: e48e47c6d27316fe8054ecc45164aedf0385be8d8e8e1077781dd3ef9948ccb756864bb6adad422941f061232f0ca0d3c6c41679166bcf345dfa29fc71f79ed3

data/config/cookstyle.yml

@@ -161,6 +161,16 @@ ChefStyle/NegatingOnlyIf:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefStyle/IncludeRecipeWithParentheses:
+  Description: There is no need to wrap the recipe in parentheses when using the include_recipe helper
+  StyleGuide: '#includerecipewithparentheses'
+  VersionAdded: '6.11.0'
+  Enabled: true
+  Exclude:
+    - '**/attributes/*.rb'
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefCorrectness: Avoiding potential problems
 ###############################
@@ -300,8 +310,9 @@ ChefCorrectness/IncorrectLibraryInjection:
   StyleGuide: '#chefcorrectnessincorrectlibraryinjection'
   Enabled: true
   VersionAdded: '5.10.0'
-  Include:
-    - '**/libraries/*.rb'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/InvalidPlatformHelper:
   Description: Pass valid platforms to the platform? helper.
@@ -1541,6 +1552,16 @@ ChefModernize/ShellOutHelper:
     - '**/Berksfile'
     - '**/libraries/*.rb'
 
+ChefModernize/ConditionalUsingTest:
+  Description: Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out.
+  StyleGuide: '#conditionalusingtest'
+  Enabled: true
+  VersionAdded: '6.11.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+    - '**/attributes/*.rb'
+
 ###############################
 # ChefRedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################

data/config/disable_all.yml

@@ -421,6 +421,8 @@ Naming/VariableNumber:
   Enabled: false
 Style/AccessModifierDeclarations:
   Enabled: false
+Style/AccessorGrouping:
+  Enabled: false
 Style/Alias:
   Enabled: false
 Style/AndOr:
@@ -437,6 +439,8 @@ Style/BarePercentLiterals:
   Enabled: false
 Style/BeginBlock:
   Enabled: false
+Style/BisectedAttrAccessor:
+  Enabled: false
 Style/BlockComments:
   Enabled: false
 Style/BlockDelimiters:
@@ -567,6 +571,8 @@ Style/MethodCallWithoutArgsParentheses:
   Enabled: false
 Style/MethodCallWithArgsParentheses:
   Enabled: false
+Style/RedundantAssignment:
+  Enabled: false
 Style/RedundantFetchBlock:
   Enabled: false
 Style/MethodCalledOnDoEndBlock:

data/config/upstream.yml

@@ -180,6 +180,9 @@ Bundler/OrderedGems:
   VersionAdded: '0.46'
   VersionChanged: '0.47'
   TreatCommentsAsGroupSeparators: true
+  # By default, "-" and "_" are ignored for order purposes.
+  # This can be overridden by setting this parameter to true.
+  ConsiderPunctuation: false
   Include:
     - '**/*.gemfile'
     - '**/Gemfile'
@@ -200,6 +203,9 @@ Gemspec/OrderedDependencies:
   Enabled: true
   VersionAdded: '0.51'
   TreatCommentsAsGroupSeparators: true
+  # By default, "-" and "_" are ignored for order purposes.
+  # This can be overridden by setting this parameter to true.
+  ConsiderPunctuation: false
   Include:
     - '**/*.gemspec'
 
@@ -1508,7 +1514,9 @@ Lint/InheritException:
 Lint/InterpolationCheck:
   Description: 'Raise warning for interpolation in single q strs.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.50'
+  VersionChanged: '0.87'
 
 Lint/LiteralAsCondition:
   Description: 'Checks of literals used in conditions.'
@@ -1736,6 +1744,7 @@ Lint/SafeNavigationWithEmpty:
   Description: 'Avoid `foo&.empty?` in conditionals.'
   Enabled: true
   VersionAdded: '0.62'
+  VersionChanged: '0.87'
 
 Lint/ScriptPermission:
   Description: 'Grant script file execute permission.'
@@ -1902,9 +1911,10 @@ Metrics/BlockLength:
   Description: 'Avoid long blocks with many lines.'
   Enabled: true
   VersionAdded: '0.44'
-  VersionChanged: '0.66'
+  VersionChanged: '0.87'
   CountComments: false  # count full line comments?
   Max: 25
+  CountAsOne: []
   ExcludedMethods:
     # By default, exclude the `#refine` method, as it tends to have larger
     # associated blocks.
@@ -1925,8 +1935,10 @@ Metrics/ClassLength:
   Description: 'Avoid classes longer than 100 lines of code.'
   Enabled: true
   VersionAdded: '0.25'
+  VersionChanged: '0.87'
   CountComments: false  # count full line comments?
   Max: 100
+  CountAsOne: []
 
 # Avoid complex methods.
 Metrics/CyclomaticComplexity:
@@ -1944,17 +1956,20 @@ Metrics/MethodLength:
   StyleGuide: '#short-methods'
   Enabled: true
   VersionAdded: '0.25'
-  VersionChanged: '0.59.2'
+  VersionChanged: '0.87'
   CountComments: false  # count full line comments?
   Max: 10
+  CountAsOne: []
   ExcludedMethods: []
 
 Metrics/ModuleLength:
   Description: 'Avoid modules longer than 100 lines of code.'
   Enabled: true
   VersionAdded: '0.31'
+  VersionChanged: '0.87'
   CountComments: false  # count full line comments?
   Max: 100
+  CountAsOne: []
 
 Metrics/ParameterLists:
   Description: 'Avoid parameter lists longer than three or four parameters.'
@@ -1992,10 +2007,12 @@ Naming/AccessorMethodName:
   VersionAdded: '0.50'
 
 Naming/AsciiIdentifiers:
-  Description: 'Use only ascii symbols in identifiers.'
+  Description: 'Use only ascii symbols in identifiers and constants.'
   StyleGuide: '#english-identifiers'
   Enabled: true
   VersionAdded: '0.50'
+  VersionChanged: '0.87'
+  AsciiConstants: true
 
 Naming/BinaryOperatorParameterName:
   Description: 'When defining binary operators, name the argument other.'
@@ -2288,6 +2305,17 @@ Style/AccessModifierDeclarations:
     - group
   AllowModifiersOnSymbols: true
 
+Style/AccessorGrouping:
+  Description: 'Checks for grouping of accessors in `class` and `module` bodies.'
+  Enabled: 'pending'
+  VersionAdded: '0.87'
+  EnforcedStyle: grouped
+  SupportedStyles:
+    # separated: each accessor goes in a separate statement.
+    # grouped: accessors are grouped into a single statement.
+    - separated
+    - grouped
+
 Style/Alias:
   Description: 'Use alias instead of alias_method.'
   StyleGuide: '#alias-method-lexically'
@@ -2355,6 +2383,13 @@ Style/BeginBlock:
   Enabled: true
   VersionAdded: '0.9'
 
+Style/BisectedAttrAccessor:
+  Description: >-
+                Checks for places where `attr_reader` and `attr_writer`
+                for the same method can be combined into single `attr_accessor`.
+  Enabled: 'pending'
+  VersionAdded: '0.87'
+
 Style/BlockComments:
   Description: 'Do not use block comments.'
   StyleGuide: '#no-block-comments'
@@ -2729,6 +2764,7 @@ Style/DoubleNegation:
   VersionAdded: '0.19'
   VersionChanged: '0.84'
   EnforcedStyle: allowed_in_returns
+  SafeAutoCorrect: false
   SupportedStyles:
     - allowed_in_returns
     - forbidden
@@ -2995,6 +3031,7 @@ Style/IfUnlessModifierOfIfUnless:
                  Avoid modifier if/unless usage on conditionals.
   Enabled: true
   VersionAdded: '0.39'
+  VersionChanged: '0.87'
 
 Style/IfWithSemicolon:
   Description: 'Do not use if x; .... Use the ternary operator instead.'
@@ -3581,6 +3618,11 @@ Style/RandomWithOffset:
   Enabled: true
   VersionAdded: '0.52'
 
+Style/RedundantAssignment:
+  Description: 'Checks for redundant assignment before returning.'
+  Enabled: 'pending'
+  VersionAdded: '0.87'
+
 Style/RedundantBegin:
   Description: "Don't use begin blocks when they are not needed."
   StyleGuide: '#begin-implicit'
@@ -3924,7 +3966,7 @@ Style/SymbolLiteral:
 Style/SymbolProc:
   Description: 'Use symbols as procs instead of blocks when possible.'
   Enabled: true
-  SafeAutoCorrect: false
+  Safe: false
   VersionAdded: '0.26'
   VersionChanged: '0.64'
   # A list of method names to be ignored by the check.

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "6.10.2".freeze # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.86.0'.freeze
+  VERSION = "6.11.4".freeze # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.87.1'.freeze
 end

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

@@ -25,6 +25,8 @@ module RuboCop
         #   # bad
         #   ::Chef::Recipe.send(:include, Filebeat::Helpers)
         #   ::Chef::Provider.send(:include, Filebeat::Helpers)
+        #   ::Chef::Recipe.include Filebeat::Helpers
+        #   ::Chef::Provider.include Filebeat::Helpers
         #
         #   # good
         #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
@@ -36,10 +38,18 @@ module RuboCop
             (send (const (const (cbase) :Chef) {:Recipe :Provider}) :send (sym :include) ... )
           PATTERN
 
+          def_node_matcher :legacy_class_includes?, <<-PATTERN
+            (send (const (const (cbase) :Chef) {:Recipe :Provider}) :include ... )
+          PATTERN
+
           def on_send(node)
             legacy_class_sends?(node) do
               add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
+
+            legacy_class_includes?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
 
           def autocorrect(node)

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

@@ -0,0 +1,56 @@
+#
+# Copyright:: 2019, 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 ChefModernize
+        # Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out
+        #
+        # @example
+        #
+        #   # bad
+        #   only_if 'test -f /bin/foo'
+        #
+        #   # good
+        #   only_if { ::File.exist?('bin/foo') }
+        #
+        class ConditionalUsingTest < Cop
+          MSG = "Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out".freeze
+
+          def_node_matcher :resource_conditional?, <<~PATTERN
+          (send nil? {:not_if :only_if} $str )
+          PATTERN
+
+          def on_send(node)
+            resource_conditional?(node) do |conditional|
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if conditional.value.match?(/^test -[ef] \S*$/)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              resource_conditional?(node) do |conditional|
+                new_string = "{ ::File.exist?('#{conditional.value.match(/^test -[ef] (\S*)$/)[1]}') }"
+                corrector.replace(conditional.loc.expression, new_string)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -27,18 +27,20 @@ module RuboCop
         #   ::File.open('/proc/1/comm').chomp == 'systemd'
         #   File.open('/proc/1/comm').gets.chomp == 'systemd'
         #   File.open('/proc/1/comm').chomp == 'systemd'
-        #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
-        #
         #   IO.read('/proc/1/comm').chomp == 'systemd'
         #   IO.read('/proc/1/comm').gets.chomp == 'systemd'
         #   ::IO.read('/proc/1/comm').chomp == 'systemd'
         #   ::IO.read('/proc/1/comm').gets.chomp == 'systemd'
         #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
+        #   only_if 'test -f /bin/systemctl && /bin/systemctl'
         #
         #   # good
         #   node['init_package'] == 'systemd'
+        #   only_if { node['init_package'] == 'systemd' }
         #
-        class NodeInitPackage < Cop
+        class NodeInitPackage < Base
+          extend RuboCop::Cop::AutoCorrector
+
           MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'".freeze
 
           def_node_matcher :file_reads_proc_1_comm?, <<-PATTERN
@@ -58,18 +60,24 @@ module RuboCop
                 :== (str "systemd"))
           PATTERN
 
+          def_node_matcher :file_systemd_conditional?, <<~PATTERN
+          (send nil? {:not_if :only_if} $(str "test -f /bin/systemctl && /bin/systemctl"))
+          PATTERN
+
           def on_send(node)
             compare_init_system?(node) do
               # if there's a ::File.exist?('/proc/1/comm') check first we want to match that as well
               node = node.parent if node.parent&.and_type? && proc_1_comm_exists?(node.parent.conditions.first)
 
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "node['init_package'] == 'systemd'")
+              end
             end
-          end
 
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "node['init_package'] == 'systemd'")
+            file_systemd_conditional?(node) do |conditional|
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(conditional.loc.expression, "{ node['init_package'] == 'systemd' }")
+              end
             end
           end
         end

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

@@ -0,0 +1,57 @@
+#
+# 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 ChefStyle
+        # There is no need to wrap the recipe in parentheses when using the include_recipe helper.
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe('foo::bar')
+        #
+        #   # good
+        #   include_recipe 'foo::bar'
+        #
+        class IncludeRecipeWithParentheses < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'There is no need to wrap the recipe in parentheses when using the include_recipe helper'.freeze
+
+          def_node_matcher :include_recipe?, <<-PATTERN
+            (send nil? :include_recipe $(str _))
+          PATTERN
+
+          def on_send(node)
+            include_recipe?(node) do |recipe|
+              return unless node.parenthesized?
+
+              # avoid chefspec: expect(chef_run).to include_recipe('foo')
+              return if node.parent&.send_type?
+
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, "include_recipe #{recipe.source}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.10.2
+  version: 6.11.4
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.87.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.87.1
 description: 
 email:
 - thom@chef.io
@@ -149,6 +149,7 @@ files:
 - lib/rubocop/cop/chef/modernize/chef_14_resources.rb
 - lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
 - lib/rubocop/cop/chef/modernize/compile_time_resources.rb
+- lib/rubocop/cop/chef/modernize/conditional_using_test.rb
 - lib/rubocop/cop/chef/modernize/cron_manage_resource.rb
 - lib/rubocop/cop/chef/modernize/databag_helpers.rb
 - lib/rubocop/cop/chef/modernize/default_action_initializer.rb
@@ -239,6 +240,7 @@ files:
 - lib/rubocop/cop/chef/style/comments_format.rb
 - lib/rubocop/cop/chef/style/file_mode.rb
 - lib/rubocop/cop/chef/style/immediate_notification_timing.rb
+- lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb
 - lib/rubocop/cop/chef/style/negating_only_if.rb
 - lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb
 - lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb