cookstyle 6.17.7 → 6.18.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0385aed05c2f7b990958984ace106ea1f8b12d62feae5ba63fc0c382a880f678'
-  data.tar.gz: e7888f5a8f5959069e00a5d3be8ce8a80325b34fe0d943baddb8a414f97947fd
+  metadata.gz: 5155a9b35b7783b4f93c60355db6c98114c8f337536cd468738d06481b5e8e7e
+  data.tar.gz: 0f7d7fae656539861f7bcdd6b4bda8463896eacd3a82c9ba4964b6ad4d35f193
 SHA512:
-  metadata.gz: a89eab0482fd1c1c158b9f5ead6f61b4693a391fd88855bba6b5e46f60ae3ebb28074ef7782e4d249cd097ebd8093461c25baaff2c699ae214bc12d8584b95ef
-  data.tar.gz: b125b09055b3388353ac3374ea1aa5061dc6dfe75f051a538004ed13d064820e40920d2d13fd2a0557cfe3b602237f346b7316adaa2e1174f9b0e4400ff7e71b
+  metadata.gz: de5247580b6f6432ac8d0fff694115b8c8765ec012c3f5686fd56453ea7ebb3b943c60025102d0a8531ecb0c605484786d3fa7c500819fd6d188bc8589e11a56
+  data.tar.gz: 54baddbe1f9419c2387ed4c94d678fdc7d599e903876ed84ccaa9aa99aa7add6443167b003f05a38f7f1b79d574e14507006650152a0bce0ed65d4ba368adf47

data/bin/cookstyle

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.join(__dir__, %w(.. lib))

data/config/cookstyle.yml

@@ -451,6 +451,24 @@ ChefCorrectness/MacosUserdefaultsInvalidType:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefCorrectness/LazyInResourceGuard:
+  Description: Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
+  StyleGuide: '#chefcorrectnesslazyinresourceguard'
+  Enabled: true
+  VersionAdded: '6.18.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefCorrectness/PropertyWithoutType:
+  Description: Custom resource properties or attributes should always define a type to help users understand the correct allowed values.
+  StyleGuide: '#chefcorrectnesspropertywithouttype'
+  Enabled: true
+  VersionAdded: '6.18.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+
 ###############################
 # ChefSharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -2343,21 +2361,6 @@ Lint/UselessSetterCall:
 Lint/Void:
   Enabled: true
 
-##### Additional rules we enable/disable over the rubocop 0.37 rules ago #####
-
-Layout/AlignParameters:
-  Enabled: false
-Style/Encoding:
-  Enabled: false
-Style/Alias:
-  Enabled: false
-Layout/SpaceBeforeFirstArg:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/DoubleNegation:
-  Enabled: false
-
 # file names don't matter in cookbooks
 Naming/FileName:
   Enabled: false
@@ -2658,3 +2661,51 @@ Style/RedundantAssignment:
 # alert on invalid ruby
 Lint/Syntax:
   Enabled: true
+
+# remove extra requires like 'thread'
+Lint/RedundantRequireStatement:
+  Enabled: true
+
+# simplify stripping strings
+Style/Strip:
+  Enabled: true
+
+# simplify how you warn
+Style/StderrPuts:
+  Enabled: true
+
+# more code simplification
+Style/Sample:
+  Enabled: true
+
+# simpler returns
+Style/ReturnNil:
+  Enabled: true
+
+# use .sort when .sort_by isn't needed
+Style/RedundantSortBy:
+  Enabled: true
+
+# simplify getting min/max
+Style/RedundantSort:
+  Enabled: true
+
+# no need for .rb in requires
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+# more code you don't need
+Style/RedundantCondition:
+  Enabled: true
+
+# Ruby 2 makes these pointless
+Style/Encoding:
+  Enabled: true
+
+# Use  __dir__ to simplify things
+Style/Dir:
+  Enabled: true
+
+# Use __FILE__ or __dir__ to simplify expand_paths
+Style/ExpandPathArguments:
+  Enabled: true

data/config/disable_all.yml

@@ -25,6 +25,8 @@ Layout/ArrayAlignment:
   Enabled: false
 Layout/AssignmentIndentation:
   Enabled: false
+Layout/BeginEndAlignment:
+  Enabled: false
 Layout/BlockAlignment:
   Enabled: false
 Layout/BlockEndNewline:
@@ -215,6 +217,8 @@ Lint/BooleanSymbol:
   Enabled: false
 Lint/CircularArgumentReference:
   Enabled: false
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
 Lint/ConstantResolution:
   Enabled: false
 Lint/Debugger:
@@ -267,6 +271,8 @@ Lint/FormatParameterMismatch:
   Enabled: false
 Lint/HeredocMethodCallPosition:
   Enabled: false
+Lint/IdentityComparison:
+  Enabled: false
 Lint/ImplicitStringConcatenation:
   Enabled: false
 Lint/InheritException:
@@ -395,6 +401,8 @@ Lint/UselessMethodDefinition:
   Enabled: false
 Lint/UselessSetterCall:
   Enabled: false
+Lint/UselessTimes:
+  Enabled: false
 Lint/Void:
   Enabled: false
 Metrics/CyclomaticComplexity:

data/config/upstream.yml

@@ -117,6 +117,8 @@ AllCops:
   # CacheRootDirectory is ~ (nil), which it is by default, the root will be
   # taken from the environment variable `$XDG_CACHE_HOME` if it is set, or if
   # `$XDG_CACHE_HOME` is not set, it will be `$HOME/.cache/`.
+  # The CacheRootDirectory can be overwritten by passing the `--cache-root` command
+  # line option or by setting `$RUBOCOP_CACHE_ROOT` environment variable.
   CacheRootDirectory: ~
   # It is possible for a malicious user to know the location of RuboCop's cache
   # directory by looking at CacheRootDirectory, and create a symlink in its
@@ -309,6 +311,19 @@ Layout/AssignmentIndentation:
   # But it can be overridden by setting this parameter
   IndentationWidth: ~
 
+Layout/BeginEndAlignment:
+  Description: 'Align ends corresponding to begins correctly.'
+  Enabled: pending
+  VersionAdded: '0.91'
+  # The value `start_of_line` means that `end` should be aligned the start of the line
+  # where the `begin` keyword is.
+  # The value `begin` means that `end` should be aligned with the `begin` keyword.
+  EnforcedStyleAlignWith: start_of_line
+  SupportedStylesAlignWith:
+    - start_of_line
+    - begin
+  Severity: warning
+
 Layout/BlockAlignment:
   Description: 'Align block ends correctly.'
   Enabled: true
@@ -1380,6 +1395,12 @@ Lint/CircularArgumentReference:
   Enabled: true
   VersionAdded: '0.33'
 
+Lint/ConstantDefinitionInBlock:
+  Description: 'Do not define constants within a block.'
+  StyleGuide: '#no-constant-definition-in-block'
+  Enabled: pending
+  VersionAdded: '0.91'
+
 Lint/ConstantResolution:
   Description: 'Check that constants are fully qualified with `::`.'
   Enabled: false
@@ -1533,6 +1554,12 @@ Lint/HeredocMethodCallPosition:
   StyleGuide: '#heredoc-method-calls'
   VersionAdded: '0.68'
 
+Lint/IdentityComparison:
+  Description: 'Prefer `equal?` over `==` when comparing `object_id`.'
+  Enabled: pending
+  StyleGuide: '#identity-comparison'
+  VersionAdded: '0.91'
+
 Lint/ImplicitStringConcatenation:
   Description: >-
                  Checks for adjacent string literals on the same line, which
@@ -1784,6 +1811,7 @@ Lint/SafeNavigationChain:
     - presence
     - try
     - try!
+    - in?
 
 Lint/SafeNavigationConsistency:
   Description: >-
@@ -1861,6 +1889,7 @@ Lint/Syntax:
   Enabled: true
   VersionAdded: '0.9'
 
+
 Lint/ToJSON:
   Description: 'Ensure #to_json includes an optional argument.'
   Enabled: true
@@ -1965,6 +1994,12 @@ Lint/UselessSetterCall:
   VersionChanged: '0.80'
   Safe: false
 
+Lint/UselessTimes:
+  Description: 'Checks for useless `Integer#times` calls.'
+  Enabled: pending
+  VersionAdded: '0.91'
+  Safe: false
+
 Lint/Void:
   Description: 'Possible use of operator/literal/variable in void context.'
   Enabled: true
@@ -3073,6 +3108,7 @@ Style/GlobalStdStream:
   StyleGuide: '#global-stdout'
   Enabled: pending
   VersionAdded: '0.89'
+  SafeAutoCorrect: false
 
 Style/GlobalVars:
   Description: 'Do not introduce global variables.'

data/cookstyle.gemspec

@@ -1,6 +1,5 @@
-# coding: utf-8
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cookstyle/version'
 

data/lib/cookstyle.rb

@@ -7,13 +7,16 @@ require 'yaml' unless defined?(YAML)
 # ensure the desired target version of RuboCop is gem activated
 gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
 require 'rubocop'
-require_relative 'rubocop/monkey_patches/comment_config.rb'
+require_relative 'rubocop/monkey_patches/comment_config'
 
 # monkey patches needed for the TargetChefVersion config option
-require_relative 'rubocop/monkey_patches/config.rb'
-require_relative 'rubocop/monkey_patches/base.rb'
-require_relative 'rubocop/monkey_patches/team.rb'
-require_relative 'rubocop/monkey_patches/registry_cop.rb'
+require_relative 'rubocop/monkey_patches/config'
+require_relative 'rubocop/monkey_patches/base'
+require_relative 'rubocop/monkey_patches/team'
+require_relative 'rubocop/monkey_patches/registry_cop'
+
+# @TODO remove this monkeypatch after we upgrade from 0.91.0
+require_relative 'rubocop/monkey_patches/rescue_ensure_alignment'
 
 module RuboCop
   class ConfigLoader

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.17.7" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.90.0'
+  VERSION = "6.18.8" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.91.0'
 end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 ChefCorrectness
+        # Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
+        #
+        # @example
+        #
+        #   # bad
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if { lazy { ::File.exist?('/etc/foo')} }
+        #   end
+        #
+        #   # good
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if { ::File.exist?('/etc/foo') }
+        #   end
+        #
+        class LazyInResourceGuard < Base
+          extend AutoCorrector
+
+          MSG = 'Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.'
+
+          def_node_matcher :lazy_in_guard?, <<-PATTERN
+            (block
+              (send nil? ${:not_if :only_if})
+              (args)
+              (block
+                (send nil? :lazy)
+                (args)
+                $(...)
+             ))
+          PATTERN
+
+          def on_block(node)
+            lazy_in_guard?(node) do |type, code|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, "#{type} { #{code.source} }")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 ChefCorrectness
+        # Resource properties or attributes should always define a type to help users understand the correct allowed values.
+        #
+        # @example
+        #
+        #   # bad
+        #   property :size, regex: /^\d+[KMGTP]$/
+        #   attribute :size, regex: /^\d+[KMGTP]$/
+        #
+        #   # good
+        #   property :size, String, regex: /^\d+[KMGTP]$/
+        #   attribute :size, kind_of: String, regex: /^\d+[KMGTP]$/
+        #
+        class PropertyWithoutType < Base
+          MSG = 'Resource properties or attributes should always define a type to help users understand the correct allowed values.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          def_node_matcher :property_without_type?, <<-PATTERN
+          (send nil? {:property :attribute}
+            (sym _)
+            $(hash
+
+              ...
+            )?
+          )
+          PATTERN
+
+          def on_send(node)
+            property_without_type?(node) do |hash_vals|
+              return if hash_vals&.first&.keys&.include?(s(:sym, :kind_of))
+
+              add_offense(node, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -44,6 +44,7 @@ module RuboCop
         #   end
         #
         class RespondToCompileTime < Base
+          include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
           extend AutoCorrector
 
@@ -75,10 +76,12 @@ module RuboCop
               $(_)) nil?)
           PATTERN
 
-          def on_if(node)
-            compile_time_method_defined?(node) do |val|
-              add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "compile_time #{val.source}")
+          def on_block(node)
+            match_property_in_resource?(:chef_gem, 'compile_time', node) do |compile_time_property|
+              compile_time_method_defined?(compile_time_property.parent) do |val|
+                add_offense(compile_time_property.parent, message: MSG, severity: :refactor) do |corrector|
+                  corrector.replace(compile_time_property.parent.loc.expression, "compile_time #{val.source}")
+                end
               end
             end
           end

data/lib/rubocop/monkey_patches/rescue_ensure_alignment.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module RuboCop
+  module Cop
+    module Layout
+      class RescueEnsureAlignment < Base
+        # @TODO remove this monkeypatch after we upgrade from RuboCop 0.91.0
+        def begin_end_alignment_style
+          # FIXME: Workaround for pending status for `Layout/BeginEndAlignment` cop
+          #        When RuboCop 1.0 is released, please replace it with the following condition.
+          #
+          # config.for_cop('Layout/BeginEndAlignment')['Enabled'] &&
+          #   config.for_cop('Layout/BeginEndAlignment')['EnforcedStyleAlignWith']
+          if config.for_all_cops['NewCops'] == 'enable' ||
+             config.for_cop('Layout/BeginEndAlignment')['Enabled'] &&
+             config.for_cop('Layout/BeginEndAlignment')['Enabled'] != 'pending'
+            config.for_cop('Layout/BeginEndAlignment')['EnforcedStyleAlignWith']
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.17.7
+  version: 6.18.8
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 0.91.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 0.91.0
 description: 
 email:
 - thom@chef.io
@@ -66,6 +66,7 @@ files:
 - lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb
 - lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb
+- 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_missing_name.rb
@@ -75,6 +76,7 @@ files:
 - lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb
 - lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb
 - lib/rubocop/cop/chef/correctness/powershell_delete_file.rb
+- lib/rubocop/cop/chef/correctness/property_without_type.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
 - lib/rubocop/cop/chef/correctness/resource_with_none_action.rb
@@ -268,6 +270,7 @@ files:
 - lib/rubocop/monkey_patches/comment_config.rb
 - lib/rubocop/monkey_patches/config.rb
 - lib/rubocop/monkey_patches/registry_cop.rb
+- lib/rubocop/monkey_patches/rescue_ensure_alignment.rb
 - lib/rubocop/monkey_patches/team.rb
 homepage: https://docs.chef.io/workstation/cookstyle/
 licenses: