cookstyle 7.12.3 → 7.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6b4ac76f05be60a51f678d80bb34d68d4396560b2887214a0a3dd7ac6cd038f
-  data.tar.gz: 74a95cd52549baf8086aa14e3579370d917b8db198deafdc6ced6c28071b3956
+  metadata.gz: 9e7636105260988af89327c7e9c5dc27b668fd307fed9000cfe2749780358a23
+  data.tar.gz: 13c4a79ce3721f3f9116ef7f440b8d207cb1c2b0f2d34f9999305cfa0dc68eea
 SHA512:
-  metadata.gz: 105f70150e5c66d01b6e157b7f07660a3bf4c755dbb7eed18709fca10b911b54c14fbfff2a2cd41d04ce11b649525b742a469f5f3631ee6c13eaa9f7fa1dc90b
-  data.tar.gz: fb7ffae6e230fa1f26f68626cd9adf4f8d265aee2feeec5fed68c963fde79bbce1022fa973e6bc2cccfbb07e396e4784d81ba0747778915eb3c288ea7e20f19b
+  metadata.gz: bc5b985e7d9355b6e8d7029e590e019649ccbca37c41510cc9a57fc46c533af38e1cb0e022bc412dfcc0f3039a6a6da32f793cac9b496bfea70f937a5cbe7113
+  data.tar.gz: 826b7a3f355935d55ef2fb6636a815f2bebfe35b1ecb9a43038e2d164dff6d9f7d35c39ebc72961ea85c90e02b3d5312e052986213914d45d855f4e1857f08ef

data/config/cookstyle.yml

@@ -3,8 +3,8 @@ AllCops:
   TargetRubyVersion: 2.5
   TargetChefVersion: ~
   Exclude:
-    - '/**/files/**/*'
-    - '/**/vendor/**/*'
+    - '**/files/**/*'
+    - '**/vendor/**/*'
     - Guardfile
 
 ###############################
@@ -1205,6 +1205,16 @@ Chef/Deprecations/ResourceWithoutUnifiedTrue:
   VersionAdded: '7.12.0'
   Include:
     - '**/resources/*.rb'
+  Exclude:
+    - '**/spec/**/*.rb'
+
+Chef/Deprecations/PolicyfileCommunitySource:
+  Description: The Policyfile source of `:community` has been replaced with `:supermarket`
+  StyleGuide: 'chef_deprecations_policyfilecommunitysource'
+  Enabled: true
+  VersionAdded: '7.15.0'
+  Include:
+    - '**/Policyfile.rb'
 
 ###############################
 # Chef/Modernize: Cleaning up legacy code and using new built-in resources
@@ -2078,6 +2088,27 @@ Chef/Effortless/Berksfile:
   Include:
     - '**/Berksfile'
 
+#### InSpec cops
+
+InSpec/Deprecations:
+  StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
+
+InSpec/Deprecations/AttributeHelper:
+  Description: InSpec attributes have been renamed to inputs. Use the `input` method not the deprecation `attribute` method to access these values.
+  StyleGuide: 'inspec_deprecations_attributehelper'
+  Enabled: true
+  VersionAdded: '7.14.0'
+  Include:
+    - '**/controls/*.rb'
+
+InSpec/Deprecations/AttributeDefault:
+  Description: The InSpec inputs `default` option has been replaced with the `value` option.
+  StyleGuide: 'inspec_deprecations_attributedefaults'
+  Enabled: true
+  VersionAdded: '7.14.0'
+  Include:
+    - '**/controls/*.rb'
+
 #### The base rubocop 0.37 enabled.yml file we started with ####
 
 Layout/AccessModifierIndentation:

data/config/disable_all.yml

@@ -275,6 +275,8 @@ Lint/EmptyExpression:
   Enabled: false
 Lint/EmptyFile:
   Enabled: false
+Lint/EmptyInPattern:
+  Enabled: false
 Lint/EmptyInterpolation:
   Enabled: false
 Lint/EmptyWhen:
@@ -667,6 +669,8 @@ Style/IfWithSemicolon:
   Enabled: false
 Style/ImplicitRuntimeError:
   Enabled: false
+Style/InPatternThen:
+  Enabled: false
 Style/InfiniteLoop:
   Enabled: false
 Style/InverseMethods:
@@ -687,6 +691,8 @@ Style/MethodCallWithoutArgsParentheses:
   Enabled: false
 Style/MethodCallWithArgsParentheses:
   Enabled: false
+Style/MultilineInPatternThen:
+  Enabled: false
 Style/RedundantAssignment:
   Enabled: false
 Style/RedundantFetchBlock:
@@ -787,6 +793,8 @@ Style/PreferredHashMethods:
   Enabled: false
 Style/Proc:
   Enabled: false
+Style/QuotedSymbols:
+  Enabled: false
 Style/RaiseArgs:
   Enabled: false
 Style/RandomWithOffset:
@@ -883,6 +891,8 @@ Style/SymbolProc:
   Enabled: false
 Style/TernaryParentheses:
   Enabled: false
+Style/TopLevelMethodDefinition:
+  Enabled: false
 Style/TrailingBodyOnClass:
   Enabled: false
 Style/TrailingBodyOnMethodDefinition:

data/config/upstream.yml

@@ -377,10 +377,11 @@ Layout/BlockEndNewline:
   VersionAdded: '0.49'
 
 Layout/CaseIndentation:
-  Description: 'Indentation of when in a case/when/[else/]end.'
+  Description: 'Indentation of when in a case/(when|in)/[else/]end.'
   StyleGuide: '#indent-when-to-case'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '1.16'
   EnforcedStyle: case
   SupportedStyles:
     - case
@@ -771,7 +772,7 @@ Layout/HashAlignment:
   Enabled: true
   AllowMultipleStyles: true
   VersionAdded: '0.49'
-  VersionChanged: '0.77'
+  VersionChanged: '1.16'
   # Alignment of entries using hash rocket as separator. Valid values are:
   #
   # key - left alignment of keys
@@ -1612,7 +1613,7 @@ Lint/EmptyBlock:
   Description: 'This cop checks for blocks without a body.'
   Enabled: pending
   VersionAdded: '1.1'
-  VersionChanged: '1.3'
+  VersionChanged: '1.15'
   AllowComments: true
   AllowEmptyLambdas: true
 
@@ -1645,6 +1646,12 @@ Lint/EmptyFile:
   AllowComments: true
   VersionAdded: '0.90'
 
+Lint/EmptyInPattern:
+  Description: 'Checks for the presence of `in` pattern branches without a body.'
+  Enabled: pending
+  AllowComments: true
+  VersionAdded: '1.16'
+
 Lint/EmptyInterpolation:
   Description: 'Checks for empty string interpolation.'
   Enabled: true
@@ -2092,6 +2099,7 @@ Lint/SymbolConversion:
   Description: 'Checks for unnecessary symbol conversions.'
   Enabled: pending
   VersionAdded: '1.9'
+  VersionChanged: '1.16'
   EnforcedStyle: strict
   SupportedStyles:
     - strict
@@ -3480,6 +3488,7 @@ Style/HashAsLastArrayItem:
 
 Style/HashConversion:
   Description: 'Avoid Hash[] in favor of ary.to_h or literal hashes.'
+  StyleGuide: '#avoid-hash-constructor'
   Enabled: pending
   VersionAdded: '1.10'
   VersionChanged: '1.11'
@@ -3489,8 +3498,10 @@ Style/HashEachMethods:
   Description: 'Use Hash#each_key and Hash#each_value.'
   StyleGuide: '#hash-each'
   Enabled: true
-  VersionAdded: '0.80'
   Safe: false
+  VersionAdded: '0.80'
+  VersionChanged: '1.16'
+  AllowedReceivers: []
 
 Style/HashExcept:
   Description: >-
@@ -3553,6 +3564,7 @@ Style/IdenticalConditionalBranches:
                  out of the conditional.
   Enabled: true
   VersionAdded: '0.36'
+  VersionChanged: '1.16'
 
 Style/IfInsideElse:
   Description: 'Finds if nodes inside else, which can be converted to elsif.'
@@ -3599,6 +3611,12 @@ Style/ImplicitRuntimeError:
   Enabled: false
   VersionAdded: '0.41'
 
+Style/InPatternThen:
+  Description: 'Checks for `in;` uses in `case` expressions.'
+  StyleGuide: '#no-in-pattern-semicolons'
+  Enabled: pending
+  VersionAdded: '1.16'
+
 Style/InfiniteLoop:
   Description: >-
                  Use Kernel#loop for infinite loops.
@@ -3827,6 +3845,12 @@ Style/MultilineIfThen:
   VersionAdded: '0.9'
   VersionChanged: '0.26'
 
+Style/MultilineInPatternThen:
+  Description: 'Do not use `then` for multi-line `in` statement.'
+  StyleGuide: '#no-then'
+  Enabled: pending
+  VersionAdded: '1.16'
+
 Style/MultilineMemoization:
   Description: 'Wrap multiline memoizations in a `begin` and `end` block.'
   Enabled: true
@@ -3998,6 +4022,7 @@ Style/NilLambda:
   Description: 'Prefer `-> {}` to `-> { nil }`.'
   Enabled: pending
   VersionAdded: '1.3'
+  VersionChanged: '1.15'
 
 Style/NonNilCheck:
   Description: 'Checks for redundant nil checks.'
@@ -4184,6 +4209,16 @@ Style/Proc:
   VersionAdded: '0.9'
   VersionChanged: '0.18'
 
+Style/QuotedSymbols:
+  Description: 'Use a consistent style for quoted symbols.'
+  Enabled: pending
+  VersionAdded: '1.16'
+  EnforcedStyle: same_as_string_literals
+  SupportedStyles:
+    - same_as_string_literals
+    - single_quotes
+    - double_quotes
+
 Style/RaiseArgs:
   Description: 'Checks the arguments passed to raise/fail.'
   StyleGuide: '#exception-class-messages'
@@ -4651,6 +4686,12 @@ Style/TernaryParentheses:
     - require_parentheses_when_complex
   AllowSafeAssignment: true
 
+Style/TopLevelMethodDefinition:
+  Description: 'This cop looks for top-level method definitions.'
+  StyleGuide: '#top-level-methods'
+  Enabled: false
+  VersionAdded: '1.15'
+
 Style/TrailingBodyOnClass:
   Description: 'Class body goes below class statement.'
   Enabled: true
@@ -4737,7 +4778,7 @@ Style/TrivialAccessors:
   StyleGuide: '#attr_family'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.77'
+  VersionChanged: '1.15'
   # When set to `false` the cop will suggest the use of accessor methods
   # in situations like:
   #
@@ -4756,7 +4797,7 @@ Style/TrivialAccessors:
   # on_exception :restart
   #
   # Commonly used in DSLs
-  AllowDSLWriters: false
+  AllowDSLWriters: true
   IgnoreClassMethods: false
   AllowedMethods:
     - to_ary

data/lib/cookstyle.rb

@@ -46,7 +46,7 @@ require_relative 'rubocop/chef/cookbook_only'
 require_relative 'rubocop/cop/target_chef_version'
 
 # Chef Infra specific cops
-Dir.glob(__dir__ + '/rubocop/cop/chef/**/*.rb') do |file|
+Dir.glob(__dir__ + '/rubocop/cop/**/*.rb') do |file|
   next if File.directory?(file)
 
   require_relative file # not actually relative but require_relative is faster

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.12.3" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.14.0'
+  VERSION = "7.15.0" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.17.0'
 end

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

@@ -0,0 +1,53 @@
+# 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 Policyfile source of `:community` has been replaced with `:supermarket`
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   default_source :community
+        #
+        #   #### correct
+        #   default_source :supermarket
+        #
+        class PolicyfileCommunitySource < Base
+          extend AutoCorrector
+
+          MSG = 'The Policyfile source of `:community` has been replaced with `:supermarket`.'
+          RESTRICT_ON_SEND = [:default_source].freeze
+
+          def_node_matcher :community_source?, <<-PATTERN
+            (send nil? :default_source (:sym :community))
+          PATTERN
+
+          def on_send(node)
+            community_source?(node) do
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node, 'default_source :supermarket')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,12 +32,12 @@ module RuboCop
         #     action :create
         #   end
         #
-        #  #### correct
-        #  windows_uac 'Set Windows UAC settings' do
-        #    enable_uac false
-        #    prompt_on_secure_desktop true
-        #    consent_behavior_admins :no_prompt
-        #  end
+        #   #### correct
+        #   windows_uac 'Set Windows UAC settings' do
+        #     enable_uac false
+        #     prompt_on_secure_desktop true
+        #     consent_behavior_admins :no_prompt
+        #   end
         #
         class WindowsRegistryUAC < Base
           include RuboCop::Chef::CookbookHelpers

data/lib/rubocop/cop/inspec/deprecation/attribute_default.rb

@@ -0,0 +1,53 @@
+# 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 InSpec
+      module Deprecations
+        # The InSpec inputs `default` option has been replaced with the `value` option.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   login_defs_umask = input('login_defs_umask', default: '077', description: 'Default umask to set in login.defs')
+        #
+        #   #### correct
+        #   login_defs_umask = input('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
+        #
+        class AttributeDefault < Base
+          extend AutoCorrector
+
+          MSG = 'The InSpec inputs `default` option has been replaced with the `value` option.'
+          RESTRICT_ON_SEND = [:attribute, :input].freeze
+
+          def_node_matcher :default?, <<-PATTERN
+            (send nil? {:attribute :input} _ (hash <(pair $(sym :default) ...) ...>) )
+          PATTERN
+
+          def on_send(node)
+            default?(node) do |n|
+              add_offense(n, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(n, 'value')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspec/deprecation/attribute_helper.rb

@@ -0,0 +1,47 @@
+# 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 InSpec
+      module Deprecations
+        # InSpec attributes have been renamed to inputs. Use the `input` method not the deprecation `attribute` method to access these values.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   login_defs_umask = attribute('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
+        #
+        #   #### correct
+        #   login_defs_umask = input('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
+        #
+        class AttributeHelper < Base
+          extend AutoCorrector
+
+          MSG = 'InSpec attributes have been renamed to inputs. Use the `input` method not the deprecation `attribute` method to access these values.'
+          RESTRICT_ON_SEND = [:attribute].freeze
+
+          def on_send(node)
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
+              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^attribute/, 'input'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.12.3
+  version: 7.15.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.17.0
 description: 
 email:
 - thom@chef.io
@@ -134,6 +134,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/partial_search_class_usage.rb
 - lib/rubocop/cop/chef/deprecation/partial_search_helper_usage.rb
 - lib/rubocop/cop/chef/deprecation/poise_archive.rb
+- lib/rubocop/cop/chef/deprecation/policyfile_community_source.rb
 - lib/rubocop/cop/chef/deprecation/powershell_cookbook_helpers.rb
 - lib/rubocop/cop/chef/deprecation/require_recipe.rb
 - lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb
@@ -275,6 +276,8 @@ files:
 - lib/rubocop/cop/chef/style/unnecessary_os_check.rb
 - lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
+- lib/rubocop/cop/inspec/deprecation/attribute_default.rb
+- lib/rubocop/cop/inspec/deprecation/attribute_helper.rb
 - lib/rubocop/cop/target_chef_version.rb
 - lib/rubocop/monkey_patches/base.rb
 - lib/rubocop/monkey_patches/config.rb