cookstyle 6.2.9 → 6.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4a34f5dc3234aeb3febf3019211d19e70b32538dfe55a13150ba45086767b2
-  data.tar.gz: 6825981876e3882b87e5699c0e9127cf0c0512201771086bc1ad5948cfb9b71f
+  metadata.gz: 7a9b1ee43fdd2c9baa768f2cdbd18592bea73293b26ce1ef76ddc4e3cb1827a3
+  data.tar.gz: 87d8aff860e98ef48aa935345091bd66586b712e52e3b2ed767ba5aededffe6b
 SHA512:
-  metadata.gz: 31bb85b95815744e511f172d62e83c21624c2192d15cd8e766b4b5a960165f5367bcbd289cb0df8db25d842f826889f1e1b9b6f5dfedc1f2fe2bd82dbd428e95
-  data.tar.gz: 4d5ea06716a8559835225d596594deb81e40a61ab38141b0f9ea3e65bfec8460fd53b45a64eea036de136cf56fcec1ade258160d8d74e7f48fc1f1137e9f19e7
+  metadata.gz: d31f92b56384f5fe012ea3fb39a154b30cc2d02dda3226d4fd2f856de4511efba3e52736886345dfacace945c4c02f74e3f8468537b00d233f7f5180c1553bd0
+  data.tar.gz: 70c9b88f541824fcd23aafb7bfd4ea9a8ad2d4500d201b65910e0055f538f7a9cdca2c7d8998b06e4cb6a06f865d2d19b93d8edf4c659527335d06b26a84430b

data/config/cookstyle.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   TargetChefVersion: ~
   Exclude:
     - '**/files/**/*'
@@ -825,6 +825,15 @@ ChefDeprecations/PowershellCookbookHelpers:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefDeprecations/DeprecatedShelloutMethods:
+  Description: Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.
+  Enabled: true
+  VersionAdded: '6.3.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -1276,6 +1285,14 @@ ChefModernize/NodeRolesInclude:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefModernize/RespondToCompileTime:
+  Description: There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
+  Enabled: true
+  VersionAdded: '6.3.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefRedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################
@@ -1768,7 +1785,7 @@ Style/StructInheritance:
   Enabled: true
 Style/SymbolLiteral:
   Enabled: true
-Layout/Tab:
+Layout/IndentationStyle:
   Enabled: true
 Layout/TrailingBlankLines:
   Enabled: true

data/config/disable_all.yml

@@ -103,6 +103,8 @@ Layout/HeredocIndentation:
   Enabled: false
 Layout/IndentationConsistency:
   Enabled: false
+Layout/IndentationStyle:
+  Enabled: false
 Layout/IndentationWidth:
   Enabled: false
 Layout/InitialIndentation:
@@ -155,6 +157,8 @@ Layout/SpaceAroundEqualsInParameterDefault:
   Enabled: false
 Layout/SpaceAroundKeyword:
   Enabled: false
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
 Layout/SpaceAroundOperators:
   Enabled: false
 Layout/SpaceBeforeBlockBraces:
@@ -187,8 +191,6 @@ Layout/SpaceInsideReferenceBrackets:
   Enabled: false
 Layout/SpaceInsideStringInterpolation:
   Enabled: false
-Layout/Tab:
-  Enabled: false
 Layout/TrailingEmptyLines:
   Enabled: false
 Layout/TrailingWhitespace:
@@ -467,6 +469,8 @@ Style/DefWithParentheses:
   Enabled: false
 Style/Dir:
   Enabled: false
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
 Style/DocumentationMethod:
   Enabled: false
 Style/Documentation:
@@ -501,6 +505,8 @@ Style/EvenOdd:
   Enabled: false
 Style/ExpandPathArguments:
   Enabled: false
+Style/ExponentialNotation:
+  Enabled: false
 Style/FloatDivision:
   Enabled: false
 Style/For:

data/config/upstream.yml

@@ -97,6 +97,14 @@ AllCops:
   # to true in the same configuration.
   EnabledByDefault: false
   DisabledByDefault: false
+  # New cops introduced between major versions are set to a special pending status
+  # and are not enabled by default with warning message.
+  # Change this behavior by overriding either `NewCops: enable` or `NewCops: disable`.
+  # When `NewCops` is `enable`, pending cops are enabled in bulk. Can be overridden by
+  # the `--enable-pending-cops` command-line option.
+  # When `NewCops` is `disable`, pending cops are disabled in bulk. Can be overridden by
+  # the `--disable-pending-cops` command-line option.
+  NewCops: pending
   # Enables the result cache if `true`. Can be overridden by the `--cache` command
   # line option.
   UseCache: true
@@ -125,7 +133,7 @@ AllCops:
   # followed by the Gemfile.lock or gems.locked file. (Although the Ruby version
   # is specified in the Gemfile or gems.rb file, RuboCop reads the final value
   # from the lock file.) If the Ruby version is still unresolved, RuboCop will
-  # use the oldest officially supported Ruby version (currently Ruby 2.3).
+  # use the oldest officially supported Ruby version (currently Ruby 2.4).
   TargetRubyVersion: ~
 
 #################### Bundler ###############################
@@ -793,6 +801,22 @@ Layout/IndentationConsistency:
     # A reference to `EnforcedStyle: indented_internal_methods`.
     - https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#follow-the-coding-conventions
 
+Layout/IndentationStyle:
+  Description: 'Consistent indentation either with tabs only or spaces only.'
+  StyleGuide: '#spaces-indentation'
+  Enabled: true
+  VersionAdded: '0.49'
+  VersionChanged: '0.82'
+  # By default, the indentation width from Layout/IndentationWidth is used
+  # But it can be overridden by setting this parameter
+  # It is used during auto-correction to determine how many spaces should
+  # replace each tab.
+  IndentationWidth: ~
+  EnforcedStyle: spaces
+  SupportedStyles:
+    - spaces
+    - tabs
+
 Layout/IndentationWidth:
   Description: 'Use 2 spaces for indentation.'
   StyleGuide: '#spaces-indentation'
@@ -1080,6 +1104,11 @@ Layout/SpaceAroundKeyword:
   Enabled: true
   VersionAdded: '0.49'
 
+Layout/SpaceAroundMethodCallOperator:
+  Description: 'Checks method call operators to not have spaces around them.'
+  Enabled: pending
+  VersionAdded: '0.82'
+
 Layout/SpaceAroundOperators:
   Description: 'Use a single space around operators.'
   StyleGuide: '#spaces-operators'
@@ -1250,18 +1279,6 @@ Layout/SpaceInsideStringInterpolation:
     - space
     - no_space
 
-Layout/Tab:
-  Description: 'No hard tabs.'
-  StyleGuide: '#spaces-indentation'
-  Enabled: true
-  VersionAdded: '0.49'
-  VersionChanged: '0.51'
-  # By default, the indentation width from Layout/IndentationWidth is used
-  # But it can be overridden by setting this parameter
-  # It is used during auto-correction to determine how many spaces should
-  # replace each tab.
-  IndentationWidth: ~
-
 Layout/TrailingEmptyLines:
   Description: 'Checks trailing blank lines and final newline.'
   StyleGuide: '#newline-eof'
@@ -1567,6 +1584,8 @@ Lint/RaiseException:
   StyleGuide: '#raise-exception'
   Enabled: pending
   VersionAdded: '0.81'
+  AllowedImplicitNamespaces:
+    - 'Gem'
 
 Lint/RandOne:
   Description: >-
@@ -2409,6 +2428,15 @@ Style/CaseEquality:
   StyleGuide: '#no-case-equality'
   Enabled: true
   VersionAdded: '0.9'
+  # If AllowOnConstant is enabled, the cop will ignore violations when the receiver of
+  # the case equality operator is a constant.
+  #
+  #   # bad
+  #   /string/ === "string"
+  #
+  #   # good
+  #   String === "string"
+  AllowOnConstant: false
 
 Style/CharacterLiteral:
   Description: 'Checks for uses of character literals.'
@@ -2449,6 +2477,7 @@ Style/ClassAndModuleChildren:
 
 Style/ClassCheck:
   Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.'
+  StyleGuide: '#is-a-vs-kind-of'
   Enabled: true
   VersionAdded: '0.24'
   EnforcedStyle: is_a?
@@ -2616,6 +2645,12 @@ Style/Dir:
   Enabled: true
   VersionAdded: '0.50'
 
+Style/DisableCopsWithinSourceCodeDirective:
+  Description: >-
+                 Forbids disabling/enabling cops within source code.
+  Enabled: false
+  VersionAdded: '0.82'
+
 Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
   Enabled: true
@@ -2734,6 +2769,17 @@ Style/ExpandPathArguments:
   Enabled: true
   VersionAdded: '0.53'
 
+Style/ExponentialNotation:
+  Description: 'When using exponential notation, favor a mantissa between 1 (inclusive) and 10 (exclusive).'
+  StyleGuide: '#exponential-notation'
+  Enabled: pending
+  VersionAdded: '0.82'
+  EnforcedStyle: scientific
+  SupportedStyles:
+    - scientific
+    - engineering
+    - integral
+
 Style/FloatDivision:
   Description: 'For performing float division, coerce one side only.'
   StyleGuide: '#float-division'

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "6.2.9".freeze # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.81.0'.freeze
+  VERSION = "6.3.4".freeze # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.82.0'.freeze
 end

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

@@ -0,0 +1,65 @@
+#
+# 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 ChefDeprecations
+        # The large number of shell_out helper methods in Chef Infra Client has been reduced to just shell_out and shell_out! methods. The legacy methods were removed in Chef Infra Client and cookbooks using these legacy helpers will need to be updated.
+        #
+        # @example
+        #
+        #   # bad
+        #   shell_out_compact('foo')
+        #   shell_out_compact!('foo')
+        #   shell_out_with_timeout('foo')
+        #   shell_out_with_timeout!('foo')
+        #   shell_out_with_systems_locale('foo')
+        #   shell_out_with_systems_locale!('foo')
+        #   shell_out_compact_timeout('foo')
+        #   shell_out_compact_timeout!('foo')
+        #
+        #   # good
+        #   shell_out('foo')
+        #   shell_out!('foo')
+        #   shell_out!('foo', default_env: false) # replaces shell_out_with_systems_locale
+        #
+        class DeprecatedShelloutMethods < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.3'
+
+          DEPRECATED_SHELLOUT_METHODS = %i( shell_out_compact
+                                            shell_out_compact!
+                                            shell_out_compact_timeout
+                                            shell_out_compact_timeout!
+                                            shell_out_with_timeout
+                                            shell_out_with_timeout!
+                                            shell_out_with_systems_locale
+                                            shell_out_with_systems_locale!
+                                          ).freeze
+
+          MSG = 'Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.'.freeze
+
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :warning) if DEPRECATED_SHELLOUT_METHODS.include?(node.method_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+#
+# 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 ChefModernize
+        # There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
+        #
+        #   # bad
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if Chef::Resource::ChefGem.method_defined?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if Chef::Resource::ChefGem.instance_methods(false).include?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if respond_to?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   # good
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true
+        #     action :nothing
+        #   end
+        #
+        class RespondToCompileTime < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.1'
+
+          MSG = 'There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.'.freeze
+
+          def_node_matcher :compile_time_method_defined?, <<-PATTERN
+          (if
+            {
+              (send
+              (const
+                (const
+                  (const nil? :Chef) :Resource) :ChefGem) :method_defined?
+              (sym :compile_time))
+
+              (send
+                (send
+                  (const
+                    (const
+                      (const nil? :Chef) :Resource) :ChefGem) :instance_methods
+                  (false)) :include?
+                (sym :compile_time))
+
+              (send nil? :respond_to?
+                (sym :compile_time))
+            }
+            (send nil? :compile_time
+              $(_)) nil?)
+          PATTERN
+
+          def on_if(node)
+            compile_time_method_defined?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              compile_time_method_defined?(node) do |val|
+                corrector.replace(node.loc.expression, "compile_time #{val.source}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2019, Chef Software, Inc.
+# Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,19 +18,20 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # It is not longer necessary respond_to?(:foo) in metadata. This was used to support new metadata
-        # methods in Chef 11 and early versions of Chef 12.
+        # In Chef Infra Client 12+ is is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
         #
         # @example
         #
         #   # bad
         #   provides :foo if respond_to?(:provides)
         #
+        #   provides :foo if defined? provides
+        #
         #   # good
         #   provides :foo
         #
         class RespondToProvides < Cop
-          MSG = 'respond_to?(:provides) in resources is no longer necessary in Chef Infra Client 12+'.freeze
+          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'.freeze
 
           def on_if(node)
             if_respond_to_provides?(node) do
@@ -39,7 +40,16 @@ module RuboCop
           end
 
           def_node_matcher :if_respond_to_provides?, <<~PATTERN
-          (if (send nil? :respond_to? ( :sym :provides ) ) ... )
+          (if
+            {
+            (send nil? :respond_to?
+              (sym :provides))
+
+            (:defined?
+              (send nil? :provides))
+            }
+            (send nil? :provides
+              (sym _)) ... )
           PATTERN
 
           def autocorrect(node)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.2.9
+  version: 6.3.4
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-04 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.82.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.82.0
 description: 
 email:
 - thom@chef.io
@@ -89,6 +89,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb
 - 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_windows_version_check.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb
 - lib/rubocop/cop/chef/deprecation/easy_install.rb
@@ -176,6 +177,7 @@ files:
 - lib/rubocop/cop/chef/modernize/resource_name_initializer.rb
 - lib/rubocop/cop/chef/modernize/resource_set_or_return.rb
 - lib/rubocop/cop/chef/modernize/resource_with_attributes.rb
+- lib/rubocop/cop/chef/modernize/respond_to_compile_time.rb
 - lib/rubocop/cop/chef/modernize/respond_to_metadata.rb
 - lib/rubocop/cop/chef/modernize/respond_to_provides.rb
 - lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb