cookstyle 5.10.13 → 5.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a4dfc3bad7b5f35e0665fc7c9f0d255c74729faa3de74fb126962f4f41b65f
-  data.tar.gz: 285f0eff32d8f1c528328f266136bc4b5899d35d567b0ee185440c8d0438e362
+  metadata.gz: 23367383d5c8736b9ab2f8bfbf580f79fb41584840e5f7c8bc00fe473cbb0ef7
+  data.tar.gz: fc2c67a465da5575f311f2eebcb658a2aa161d55fb2a41c2ddfe234fb9303ce7
 SHA512:
-  metadata.gz: fbebffebb05c03de047144b6f38dd5d35724b80c240347f8b939ce092cbed4c91d2cca3cf6c9104846852886d84e26067afe8ae6778698b1a745694ee7282dca
-  data.tar.gz: dac2940dba58d62d900e01d071b068f455455e08278766f425c329c51508d145f1916df38b9e90fa3b9a7c7590a2618ad463eae627ef63e96fd869413ef006dc
+  metadata.gz: 38e8cbb19de77adcb8eb239749fd729e2aced72b20ba31b8e6cc81b186c3125fcbf774ce2c88a00b03da779f477f8247e3d219cf024d9ac9e2e05799ea3003a2
+  data.tar.gz: 6a29d736057c956ec4b420af00f3f84db703ccc3c959ec05f30ab6d195c7d7dac738cfe768f3705539d158211232626a74ea5b7e876f2f4674596dfc29963b1b

data/config/cookstyle.yml

@@ -556,6 +556,32 @@ ChefDeprecations/VerifyPropertyUsesFileExpansion:
   Exclude:
     - '**/metadata.rb'
 
+ChefDeprecations/PoiseArchiveUsage:
+  Description: The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+.
+  Enabled: true
+  VersionAdded: '5.11.0'
+
+ChefDeprecations/PartialSearchHelperUsage:
+  Description: Legacy partial_search usage should be updated to use :filter_result in the search helper instead.
+  Enabled: true
+  VersionAdded: '5.11.0'
+  Exclude:
+    - '**/metadata.rb'
+
+ChefDeprecations/SearchUsesPositionalParameters:
+  Description: Don't use deprecated positional parameters in cookbook search queries.
+  Enabled: true
+  VersionAdded: '5.11.0'
+  Exclude:
+    - '**/metadata.rb'
+
+ChefDeprecations/PartialSearchClassUsage:
+  Description: Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.
+  Enabled: true
+  VersionAdded: '5.11.0'
+  Exclude:
+    - '**/metadata.rb'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -823,6 +849,13 @@ ChefModernize/ResourceNameFromInitialize:
     - '**/providers/*.rb'
     - '**/libraries/*.rb'
 
+ChefModernize/Definitions:
+  Description: Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.
+  Enabled: true
+  VersionAdded: '5.11.0'
+  Include:
+    - '**/definitions/*.rb'
+
 ###############################
 # Migrating to new patterns
 ###############################
@@ -831,26 +864,43 @@ ChefEffortless/CookbookUsesSearch:
   Description: Cookbook uses search, which cannot be used in the Effortless Infra pattern
   Enabled: false
   VersionAdded: '5.1.0'
+  Exclude:
+    - '**/metadata.rb'
 
 ChefEffortless/CookbookUsesDatabags:
   Description: Cookbook uses data bags, which cannot be used in the Effortless Infra pattern
   Enabled: false
   VersionAdded: '5.1.0'
+  Exclude:
+    - '**/metadata.rb'
 
 ChefEffortless/CookbookUsesEnvironmments:
   Description: Cookbook uses environments, which cannot be used in the Effortless Infra pattern
   Enabled: false
   VersionAdded: '5.10.0'
+  Exclude:
+    - '**/metadata.rb'
 
 ChefEffortless/CookbookUsesPolicygroups:
   Description: Cookbook uses Policy Groups, which cannot be used in the Effortless Infra pattern
   Enabled: false
   VersionAdded: '5.10.0'
+  Exclude:
+    - '**/metadata.rb'
 
 ChefEffortless/CookbookUsesRoles:
   Description: Cookbook uses Roles, which cannot be used in the Effortless Infra pattern
   Enabled: false
   VersionAdded: '5.10.0'
+  Exclude:
+    - '**/metadata.rb'
+
+ChefEffortless/SearchForEnvironmentsOrRoles:
+  Description: Cookbook uses search with a node query that looks for a role or environment
+  Enabled: false
+  VersionAdded: '5.11.0'
+  Exclude:
+    - '**/metadata.rb'
 
 #### The base rubocop 0.37 enabled.yml file we started with ####
 
@@ -1288,6 +1338,19 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+#### COPS FOR THE NEXT MAJOR RELEASE
+
+# This updates how we send helpers into the Chef recipe/resource classes and makes WAY more sense
+# Chef::Recipe.send(:include, ::Apt::Helpers) -> Chef::Recipe.include ::Apt::Helpers
+# Lint/SendWithMixinArgument:
+#   Enabled: true
+
+#### END COPS FOR THE NEXT MAJOR RELEASE
+
+# this migrates old # rubocop: comments to use the latest namespaces, which prevents a ton of spam during cookstyle runs
+Migration/DepartmentName:
+  Enabled: true
+
 # https://github.com/chef/cookstyle/pull/5
 Style/TrailingCommaInHashLiteral:
   Enabled: true

data/config/disable_all.yml

@@ -1,4 +1,6 @@
 ---
+Migration/DepartmentName:
+  Enabled: false
 Bundler/DuplicatedGem:
   Enabled: false
 Bundler/GemComment:
@@ -303,6 +305,8 @@ Lint/SafeNavigationWithEmpty:
   Enabled: false
 Lint/ScriptPermission:
   Enabled: false
+Lint/SendWithMixinArgument:
+  Enabled: false
 Lint/ShadowedArgument:
   Enabled: false
 Lint/ShadowedException:
@@ -465,6 +469,8 @@ Style/DocumentationMethod:
   Enabled: false
 Style/Documentation:
   Enabled: false
+Style/DoubleCopDisableDirective:
+  Enabled: false
 Style/DoubleNegation:
   Enabled: false
 Style/EachForSimpleLoop:
@@ -569,6 +575,8 @@ Style/MultilineMemoization:
   Enabled: false
 Style/MultilineTernaryOperator:
   Enabled: false
+Style/MultilineWhenThen:
+  Enabled: false
 Style/MultipleComparison:
   Enabled: false
 Style/MutableConstant:

data/config/upstream.yml

@@ -816,6 +816,8 @@ Layout/LeadingCommentSpace:
   StyleGuide: '#hash-space'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '0.73'
+  AllowDoxygenCommentStyle: false
 
 Layout/MultilineArrayBraceLayout:
   Description: >-
@@ -1589,6 +1591,11 @@ Lint/ScriptPermission:
   VersionAdded: '0.49'
   VersionChanged: '0.50'
 
+Lint/SendWithMixinArgument:
+  Description: 'Checks for `send` method when using mixin.'
+  Enabled: true
+  VersionAdded: '0.75'
+
 Lint/ShadowedArgument:
   Description: 'Avoid reassigning arguments before they were used.'
   Enabled: true
@@ -1660,6 +1667,7 @@ Lint/UnneededSplatExpansion:
   Description: 'Checks for splat unnecessarily being called on literals.'
   Enabled: true
   VersionAdded: '0.43'
+  VersionChanged: '0.74'
 
 Lint/UnreachableCode:
   Description: 'Unreachable code.'
@@ -1743,7 +1751,7 @@ Metrics/AbcSize:
                  branches, and conditions.
   Reference:
     - http://c2.com/cgi/wiki?AbcMetric
-    - https://en.wikipedia.org/wiki/ABC_Software_Metric'
+    - https://en.wikipedia.org/wiki/ABC_Software_Metric
   Enabled: true
   VersionAdded: '0.27'
   VersionChanged: '0.66'
@@ -1807,7 +1815,7 @@ Metrics/LineLength:
     - https
   # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
   # directives like '# rubocop: enable ...' when calculating a line's length.
-  IgnoreCopDirectives: false
+  IgnoreCopDirectives: true
   # The IgnoredPatterns option is a list of !ruby/regexp and/or string
   # elements. Strings will be converted to Regexp objects. A line that matches
   # any regular expression listed in this option will be ignored by LineLength.
@@ -1846,6 +1854,14 @@ Metrics/PerceivedComplexity:
   VersionAdded: '0.25'
   Max: 7
 
+################## Migration #############################
+
+Migration/DepartmentName:
+  Description: >-
+                 Check that cop names in rubocop:disable (etc) comments are
+                 given with department name.
+  Enabled: false
+
 #################### Naming ##############################
 
 Naming/AccessorMethodName:
@@ -1981,6 +1997,13 @@ Naming/MethodName:
   SupportedStyles:
     - snake_case
     - camelCase
+  # Method names matching patterns are always allowed.
+  #
+  #   IgnoredPatterns:
+  #     - '\A\s*onSelectionBulkChange\s*'
+  #     - '\A\s*onSelectionCleared\s*'
+  #
+  IgnoredPatterns: []
 
 Naming/PredicateName:
   Description: 'Check the names of predicate methods.'
@@ -2344,7 +2367,7 @@ Style/ClassAndModuleChildren:
   StyleGuide: '#namespace-definition'
   # Moving from compact to nested children requires knowledge of whether the
   # outer parent is a module or a class. Moving from nested to compact requires
-  # verification that the outer parent is defined elsewhere. RuboCop does not
+  # verification that the outer parent is defined elsewhere. Rubocop does not
   # have the knowledge to perform either operation safely and thus requires
   # manual oversight.
   SafeAutoCorrect: false
@@ -2555,6 +2578,11 @@ Style/DocumentationMethod:
     - 'test/**/*'
   RequireForNonPublicMethods: false
 
+Style/DoubleCopDisableDirective:
+  Description: 'Checks for double rubocop:disable comments on a single line.'
+  Enabled: true
+  VersionAdded: '0.73'
+
 Style/DoubleNegation:
   Description: 'Checks for uses of double negation (!!).'
   StyleGuide: '#no-bang-bang'
@@ -2698,7 +2726,7 @@ Style/FormatStringToken:
     - template
     - unannotated
   VersionAdded: '0.49'
-  VersionChanged: '0.52'
+  VersionChanged: '0.75'
 
 Style/FrozenStringLiteralComment:
   Description: >-
@@ -2891,6 +2919,7 @@ Style/MethodCallWithArgsParentheses:
   VersionChanged: '0.61'
   IgnoreMacros: true
   IgnoredMethods: []
+  IgnoredPatterns: []
   IncludedMacros: []
   AllowParenthesesInMultilineCall: false
   AllowParenthesesInChaining: false
@@ -3041,6 +3070,12 @@ Style/MultilineTernaryOperator:
   Enabled: true
   VersionAdded: '0.9'
 
+Style/MultilineWhenThen:
+  Description: 'Do not use then for multi-line when statement.'
+  StyleGuide: '#no-then'
+  Enabled: true
+  VersionAdded: '0.73'
+
 Style/MultipleComparison:
   Description: >-
                  Avoid comparing a variable with multiple items in a conditional,
@@ -3572,6 +3607,8 @@ Style/StringHashKeys:
   StyleGuide: '#symbols-as-keys'
   Enabled: false
   VersionAdded: '0.52'
+  VersionChanged: '0.75'
+  Safe: false
 
 Style/StringLiterals:
   Description: 'Checks if uses of quotes match the configured preference.'
@@ -3890,8 +3927,9 @@ Style/YodaCondition:
     - require_for_all_comparison_operators
     # enforce yoda only for equality operators: `!=` and `==`
     - require_for_equality_operators_only
+  Safe: false
   VersionAdded: '0.49'
-  VersionChanged: '0.63'
+  VersionChanged: '0.75'
 
 Style/ZeroLengthPredicate:
   Description: 'Use #empty? when testing for objects of length 0.'

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.10.13".freeze # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.72.0'.freeze
+  VERSION = "5.11.0".freeze # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.75.1'.freeze
 end

data/lib/rubocop/chef/cookbook_helpers.rb

@@ -2,24 +2,35 @@ module RuboCop
   module Chef
     # Common node helpers used for matching against Chef Infra Cookbooks
     module CookbookHelpers
+      def resource_block_name_if_string(node)
+        if looks_like_resource?(node) && node.children.first.arguments.first.respond_to?(:value)
+          node.children.first.arguments.first.value
+        end
+      end
+
+      # Match a particular resource
+      #
+      # @param [String] resource_name The name of the resource to match
+      # @param [RuboCop::AST::Node] node The rubocop ast node to search
+      #
+      # @yield
+      #
+      def match_resource_type?(resource_name, node)
+        return unless looks_like_resource?(node)
+        # bail out if we're not in the resource we care about or nil was passed (all resources)
+        yield(node) if node.children.first.method?(resource_name.to_sym)
+      end
+
       # Match particular properties within a resource
       #
       # @param [String] resource_name The name of the resource to match
       # @param [String] property_name The name of the property to match (or action)
-      # @param [<Type>] node The rubocop ast node to search
+      # @param [RuboCop::AST::Node] node The rubocop ast node to search
       #
       # @yield
       #
       def match_property_in_resource?(resource_name, property_name, node)
-        return unless node.block_type? # resources are blocks if they have properties
-        return unless node.children.first.receiver.nil? # resource blocks don't have a receiver
-        return if node.send_node.arguments.first.is_a?(RuboCop::AST::SymbolNode) # resources have a string name. resource actions have symbols
-
-        # bail if the block doesn't have a name a resource *generally* has a name.
-        # This isn't 100% true with things like apt_update and build_essential, but we'll live
-        # with that for now to avoid the false positives of getting stuck in generic blocks in resources
-        return if node.children.first.arguments.empty?
-
+        return unless looks_like_resource?(node)
         # bail out if we're not in the resource we care about or nil was passed (all resources)
         return unless resource_name.nil? || node.children.first.method?(resource_name.to_sym) # see if we're in the right resource
 
@@ -48,6 +59,28 @@ module RuboCop
 
       private
 
+      #
+      # given a node object does it look like a chef resource or not?
+      # warning: currently this requires a resource with properties since we key off blocks and property-less resources look like methods
+      #
+      # @param [RuboCop::AST::Node] node AST object to test
+      #
+      # @return [boolean]
+      #
+      def looks_like_resource?(node)
+        return false unless node.block_type? # resources are blocks if they have properties
+        return false unless node.children.first.receiver.nil? # resource blocks don't have a receiver
+        return false if node.send_node.arguments.first.is_a?(RuboCop::AST::SymbolNode) # resources have a string name. resource actions have symbols
+
+        # bail if the block doesn't have a name a resource *generally* has a name.
+        # This isn't 100% true with things like apt_update and build_essential, but we'll live
+        # with that for now to avoid the false positives of getting stuck in generic blocks in resources
+        return false if node.children.first.arguments.empty?
+
+        # if we made it this far we're probably in a resource
+        true
+      end
+
       def extract_send_types(node)
         return if node.nil? # there are cases we can be passed an empty node
         case node.type

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

@@ -0,0 +1,65 @@
+#
+# 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 ChefDeprecations
+        # Legacy Chef::PartialSearch class usage should be updated to use the `search` helper instead with the `filter_result` key.
+        #
+        # @example
+        #
+        #   # bad
+        #   ::Chef::PartialSearch.new.search((:node, 'role:web',
+        #     keys: { 'name' => [ 'name' ],
+        #             'ip' => [ 'ipaddress' ],
+        #             'kernel_version' => %w(kernel version),
+        #               }
+        #   ).each do |result|
+        #     puts result['name']
+        #     puts result['ip']
+        #     puts result['kernel_version']
+        #   end
+        #
+        #   # good
+        #   search(:node, 'role:web',
+        #     filter_result: { 'name' => [ 'name' ],
+        #                      'ip' => [ 'ipaddress' ],
+        #                      'kernel_version' => %w(kernel version),
+        #               }
+        #   ).each do |result|
+        #     puts result['name']
+        #     puts result['ip']
+        #     puts result['kernel_version']
+        #   end
+        #
+        class PartialSearchClassUsage < Cop
+          MSG = 'Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.'.freeze
+
+          def_node_matcher :partial_search_class?, <<-PATTERN
+            (send (const (const ... :Chef) :PartialSearch) :new)
+          PATTERN
+
+          def on_send(node)
+            partial_search_class?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+#
+# 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 ChefDeprecations
+        # Legacy partial_search usage should be updated to use :filter_result in the search helper instead
+        #
+        # @example
+        #
+        #   # bad
+        #   partial_search(:node, 'role:web',
+        #     keys: { 'name' => [ 'name' ],
+        #             'ip' => [ 'ipaddress' ],
+        #             'kernel_version' => %w(kernel version),
+        #               }
+        #   ).each do |result|
+        #     puts result['name']
+        #     puts result['ip']
+        #     puts result['kernel_version']
+        #   end
+        #
+        #   # good
+        #   search(:node, 'role:web',
+        #     filter_result: { 'name' => [ 'name' ],
+        #                      'ip' => [ 'ipaddress' ],
+        #                      'kernel_version' => %w(kernel version),
+        #               }
+        #   ).each do |result|
+        #     puts result['name']
+        #     puts result['ip']
+        #     puts result['kernel_version']
+        #   end
+        #
+        class PartialSearchHelperUsage < Cop
+          MSG = 'Legacy partial_search usage should be updated to use :filter_result in the search helper instead'.freeze
+
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :partial_search
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+#
+# 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 ChefDeprecations
+        # The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+.
+        #
+        # @example
+        #
+        #   # bad
+        #   poise_archive 'https://example.com/myapp.tgz' do
+        #     destination '/opt/myapp'
+        #   end
+        #
+        #   # good
+        #   archive_file 'https://example.com/myapp.tgz' do
+        #     destination '/opt/myapp'
+        #   end
+        #
+        class PoiseArchiveUsage < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+'.freeze
+
+          def_node_matcher :depends_poise_archive?, <<-PATTERN
+            (send nil? :depends (str "poise-archive"))
+          PATTERN
+
+          def on_send(node)
+            depends_poise_archive?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def on_block(node)
+            match_resource_type?(:poise_archive, node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,134 @@
+#
+# 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 ChefDeprecations
+        # In the cookbook search helper you need to use named parameters (key/value style) other than the first (type) and second (query string) values.
+        #
+        # @example
+        #
+        # bad:
+        #  search(:node, '*:*', 0, 1000, { :ip_address => ["ipaddress"] })
+        #  search(:node, '*:*', 0, 1000)
+        #  search(:node, '*:*', 0)
+
+        # good
+        #
+        # query(:node, '*:*')
+        #  search(:node, '*:*', start: 0, rows: 1000, filter_result: { :ip_address => ["ipaddress"] })
+        #  search(:node, '*:*', start: 0, rows: 1000)
+        #  search(:node, '*:*', start: 0)
+        #
+        class SearchUsesPositionalParameters < Cop
+          MSG = "Don't use deprecated positional parameters in cookbook search queries.".freeze
+
+          NAMED_PARAM_LOOKUP_TABLE = [nil, nil, 'start', 'rows', 'filter_result'].freeze
+
+          def_node_matcher :search_method?, <<-PATTERN
+            (send nil? :search ... )
+          PATTERN
+
+          def on_send(node)
+            search_method?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if positional_arguments?(node)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, corrected_string(node))
+            end
+          end
+
+          private
+
+          #
+          # Are the arguments in the passed node object positional
+          #
+          # @param [RuboCop::AST::Node] node
+          #
+          # @return [Boolean]
+          #
+          def positional_arguments?(node)
+            return false if node.arguments.count < 3
+            node.arguments[2..-1].each do |arg|
+              # hashes, blocks, or variable/methods are valid. Anything else is not
+              return true unless %i(send hash block_pass).include?(arg.type)
+            end
+            false
+          end
+
+          #
+          # Return the corrected search string
+          #
+          # @param [RuboCop::AST::Node] node
+          #
+          # @return [String]
+          #
+          def corrected_string(node)
+            args = node.arguments
+
+            # If the 2nd argument is a String and not an Integer as a String
+            # then it's the old sort field and we need to delete it. Same thing
+            # goes for nil values here.
+            args.delete_at(2) if (args[2].str_type? && !integer_like_val?(args[2])) || args[2].nil_type?
+
+            "search(#{args.collect.with_index { |arg, i| hashify_argument(arg, i) }.join(', ')})"
+          end
+
+          #
+          # lookup the position in NAMED_PARAM_LOOKUP_TABLE to create a new
+          # hashified version of the query. Also convert Integer like Strings into Integers
+          #
+          # @param [RuboCop::AST::Node] arg
+          # @param [Integer] position
+          #
+          # @return [String]
+          #
+          def hashify_argument(arg, position)
+            hash_key = NAMED_PARAM_LOOKUP_TABLE[position]
+            if hash_key
+              # convert Integers stored as Strings into plain Integers
+              if integer_like_val?(arg)
+                "#{hash_key}: #{Integer(arg.value)}"
+              else
+                "#{hash_key}: #{arg.source}"
+              end
+            else
+              arg.source
+            end
+          end
+
+          #
+          # Does this value look like an Integer (it's an integer or a string)
+          #
+          # @param [RuboCop::AST::Node] val
+          #
+          # @return [Boolean]
+          #
+          def integer_like_val?(val)
+            Integer(val.value)
+            true
+          rescue
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb

@@ -0,0 +1,41 @@
+#
+# Copyright:: 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 ChefEffortless
+        # Policyfiles (and Effortless) do not use environments or roles so searching for those will need to be refactored before migrating to Policyfiles and the Effortless pattern.
+        #
+        # @example
+        #
+        #   # bad
+        #   search(:node, 'chef_environment:foo')
+        #   search(:node, 'role:bar')
+        #
+        class SearchForEnvironmentsOrRoles < Cop
+          MSG = 'Cookbook uses search with a node query that looks for a role or environment'.freeze
+
+          def on_send(node)
+            if node.method_name == :search && node.arguments[1]&.value&.match?(/chef_environment|role/)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Use secure Github and Gitlab URLs for source_url and issues_url
+        # Use the build_essential resource from the build-essential cookbook 5.0+ or Chef Infra Client 14+ instead of using the build-essential::default recipe.
         #
         # @example
         #
@@ -29,6 +29,7 @@ module RuboCop
         #
         #   # good
         #   build_essential 'install compilation tools'
+        #
         class UseBuildEssentialResource < Cop
           MSG = 'Use the build_essential resource instead of the legacy build-essential recipe. This resource ships in the build-essential cookbook v5.0+ and is built into Chef Infra Client 14+'.freeze
 

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

@@ -53,7 +53,7 @@ module RuboCop
             lambda do |corrector|
               # insert the new default_action call above the initialize method
               initialize_node = intialize_method(processed_source.ast).first
-              corrector.insert_before(initialize_node.source_range, "default_action #{node.asgn_rhs.source}\n\n")
+              corrector.insert_before(initialize_node.source_range, "default_action #{node.descendants.first.source}\n\n")
 
               # remove the variable from the initialize method
               corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))

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

@@ -0,0 +1,35 @@
+#
+# 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
+        # In 2016 with Chef Infra Client 12.5 Custom Resources were introduced as a way of writing reusable resource code that could be shipped in cookbooks. Custom Resources offer many advantages of legacy Definitions including unit testing with ChefSpec, input validation, actions, commmon properties like not_if/only_if, and resource reporting.
+        #
+        class Definitions < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.'.freeze
+
+          def on_block(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.respond_to?(:method_name) && node.method_name == :define
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -53,7 +53,7 @@ module RuboCop
             lambda do |corrector|
               # insert the new resource_name call above the initialize method
               initialize_node = intialize_method(processed_source.ast).first
-              corrector.insert_before(initialize_node.source_range, "resource_name #{node.asgn_rhs.source}\n\n")
+              corrector.insert_before(initialize_node.source_range, "resource_name #{node.descendants.first.source}\n\n")
 
               # remove the variable from the initialize method
               corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))

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

@@ -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
+        # It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata
         # methods in Chef 11 and early versions of Chef 12.
         #
         # @example
         #
         #   # bad
         #   chef_version '>= 13' if respond_to?(:chef_version)
+        #   chef_version '>= 13' if defined?(chef_version)
         #
         #   # good
         #   chef_version '>= 13'
         #
         class RespondToInMetadata < Cop
-          MSG = 'It is no longer necessary to use respond_to? in metadata.rb in Chef Infra Client 12.15 and later'.freeze
+          MSG = 'It is no longer necessary to use respond_to? or if_defined? in metadata.rb in Chef Infra Client 12.15 and later'.freeze
 
           def on_if(node)
             if_respond_to?(node) do
@@ -38,6 +39,11 @@ module RuboCop
             end
           end
 
+          def on_defined?(node)
+            node = node.parent if node.parent.if? # we want the whole if statement
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+
           def_node_matcher :if_respond_to?, <<~PATTERN
           (if (send nil? :respond_to? _ ) ... )
           PATTERN

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.10.13
+  version: 5.11.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-25 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.72.0
+        version: 0.75.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.72.0
+        version: 0.75.1
 description: 
 email:
 - thom@chef.io
@@ -96,6 +96,9 @@ files:
 - lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb
 - lib/rubocop/cop/chef/deprecation/node_set.rb
 - lib/rubocop/cop/chef/deprecation/node_set_unless.rb
+- 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/provides_metadata.rb
 - lib/rubocop/cop/chef/deprecation/recipe_metadata.rb
 - lib/rubocop/cop/chef/deprecation/replaces_metadata.rb
@@ -105,6 +108,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb
 - lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb
 - lib/rubocop/cop/chef/deprecation/run_command_helper.rb
+- lib/rubocop/cop/chef/deprecation/search_uses_positional_parameters.rb
 - lib/rubocop/cop/chef/deprecation/suggests_metadata.rb
 - lib/rubocop/cop/chef/deprecation/use_inline_resources.rb
 - lib/rubocop/cop/chef/deprecation/user_supports_property.rb
@@ -116,6 +120,7 @@ files:
 - lib/rubocop/cop/chef/effortless/node_environment.rb
 - lib/rubocop/cop/chef/effortless/node_policygroup.rb
 - lib/rubocop/cop/chef/effortless/node_roles.rb
+- lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb
 - lib/rubocop/cop/chef/effortless/search_used.rb
 - lib/rubocop/cop/chef/modernize/apt_default_recipe.rb
 - lib/rubocop/cop/chef/modernize/berksfile_source.rb
@@ -124,6 +129,7 @@ files:
 - lib/rubocop/cop/chef/modernize/cron_manage_resource.rb
 - lib/rubocop/cop/chef/modernize/default_action_initializer.rb
 - lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
+- lib/rubocop/cop/chef/modernize/definitions.rb
 - lib/rubocop/cop/chef/modernize/depends_zypper_cookbook.rb
 - lib/rubocop/cop/chef/modernize/execute_apt_update.rb
 - lib/rubocop/cop/chef/modernize/execute_tzutil.rb