cookstyle 6.18.8 → 6.21.1

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

@@ -39,6 +39,7 @@ module RuboCop
         #
         class NodeNormal < Base
           MSG = 'Do not use node.normal. Replace with default/override/force_default/force_override attribute levels.'
+          RESTRICT_ON_SEND = [:normal].freeze
 
           def_node_matcher :node_normal?, <<-PATTERN
             (send (send _ :node) :normal)

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

@@ -39,6 +39,7 @@ module RuboCop
         #
         class NodeNormalUnless < Base
           MSG = 'Do not use node.normal_unless. Replace with default/override/force_default/force_override attribute levels.'
+          RESTRICT_ON_SEND = [:normal_unless].freeze
 
           def_node_matcher :node_normal_unless?, <<-PATTERN
             (send (send _ :node) :normal_unless)

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

@@ -30,6 +30,7 @@ module RuboCop
         #
         class CookbookUsesNodeSave < Base
           MSG = "Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
+          RESTRICT_ON_SEND = [:save].freeze
 
           def_node_matcher :node_save?, <<-PATTERN
             (send (send nil? :node) :save)

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

@@ -53,7 +53,7 @@ module RuboCop
               return unless notifies_property.node_parts[2].str_type?
 
               add_offense(notifies_property, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(notifies_property.first_argument.loc.expression,
+                corrector.replace(notifies_property.first_argument,
                   ":#{notifies_property.node_parts[2].value}")
               end
             end

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

@@ -0,0 +1,48 @@
+# 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
+        # Don't represent file modes as Strings containing octal values.
+        #
+        # @example
+        #
+        #   # bad
+        #   file '/etc/some_file' do
+        #     mode '0o755'
+        #   end
+        #
+        #   # good
+        #   file '/etc/some_file' do
+        #     mode '0755'
+        #   end
+        #
+        class OctalModeAsString < Base
+          MSG = "Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead. For example: '0755'."
+          RESTRICT_ON_SEND = [:mode].freeze
+
+          def on_send(node)
+            return unless node.arguments.first&.str_type? && node.arguments.first.value.match?(/^0o/)
+            add_offense(node, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -45,7 +45,7 @@ module RuboCop
               action_node.arguments.each do |action|
                 next unless action.source == ':none'
                 add_offense(action, message: MSG, severity: :refactor) do |corrector|
-                  corrector.replace(action.loc.expression, ':nothing')
+                  corrector.replace(action, ':nothing')
                 end
               end
             end

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

@@ -41,7 +41,7 @@ module RuboCop
           def on_block(node)
             unscoped_file_exist?(node) do |m|
               add_offense(m, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(m.loc.expression, '::File')
+                corrector.replace(m, '::File')
               end
             end
           end

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

@@ -41,8 +41,8 @@ module RuboCop
           def on_send(node)
             supports_with_constraint?(node) do |ver|
               return if ver.source.include?('.')
-              add_offense(ver.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(ver.loc.expression, ver.source.gsub(ver.value, (ver.value + '.0')))
+              add_offense(ver, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(ver, ver.source.gsub(ver.value, (ver.value + '.0')))
               end
             end
           end

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

@@ -45,7 +45,7 @@ module RuboCop
               add_offense(prop_node, message: MSG, severity: :warning) do |corrector|
                 # make sure to delete leading and trailing {}s that would create invalid ruby syntax
                 extracted_val = prop_node.arguments.first.source.gsub(/{|}/, '')
-                corrector.replace(prop_node.loc.expression, "type #{extracted_val}")
+                corrector.replace(prop_node, "type #{extracted_val}")
               end
             end
           end

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

@@ -79,7 +79,7 @@ module RuboCop
 
             rewind_resources?(node) do |string|
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, node.source.gsub(string.to_s, MAPPING[string]))
+                corrector.replace(node, node.source.gsub(string.to_s, MAPPING[string]))
               end
             end
           end
@@ -88,7 +88,7 @@ module RuboCop
             match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
               next unless pkg_name.arguments&.first&.str_content == 'chef-rewind'
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.remove(node.loc.expression) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
+                corrector.remove(node) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
               end
             end
           end

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

@@ -41,7 +41,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically."
-          # RESTRICT_ON_SEND = [:new, :require, :include].freeze
+          RESTRICT_ON_SEND = [:new, :require, :include].freeze
 
           def_node_matcher :include_shellout?, <<-PATTERN
           (send nil? :include
@@ -75,7 +75,7 @@ module RuboCop
 
             shellout_new?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
+                corrector.replace(node, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
               end
             end
           end

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

@@ -33,6 +33,7 @@ module RuboCop
         class ChefWindowsPlatformHelper < Base
           extend AutoCorrector
           MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper."
+          RESTRICT_ON_SEND = [:windows?].freeze
 
           def_node_matcher :chef_platform_windows?, <<-PATTERN
             (send
@@ -43,7 +44,7 @@ module RuboCop
           def on_send(node)
             chef_platform_windows?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, "platform?('windows')")
+                corrector.replace(node, "platform?('windows')")
               end
             end
           end

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

@@ -47,7 +47,7 @@ module RuboCop
             return unless node.const_name == 'ChefDK' && (node.parent&.module_type? || node.parent&.const_type?)
 
             add_offense(node, message: MSG, severity: :warning) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub('ChefDK', 'ChefCLI'))
+              corrector.replace(node, node.source.gsub('ChefDK', 'ChefCLI'))
             end
           end
         end

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

@@ -39,7 +39,7 @@ module RuboCop
           def on_block(node)
             coverage_reporter?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.remove(node.loc.expression)
+                corrector.remove(node)
               end
             end
           end

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

@@ -51,7 +51,7 @@ module RuboCop
           def on_const(node)
             chefspec_runner?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, 'ChefSpec::ServerRunner')
+                corrector.replace(node, 'ChefSpec::ServerRunner')
               end
             end
           end

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

@@ -32,8 +32,6 @@ module RuboCop
 
           MSG = "Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3"
 
-          Gem::Dependency.new('', ['~> 1.4.5', '>= 1.4.6']).match?('', '1.4.6')
-
           DEPRECATED_MAPPING = {
             'amazon' => {
               '2017.12' => '2',
@@ -120,7 +118,7 @@ module RuboCop
               next unless legacy_chefspec_platform(plat.value, ver.value)
               add_offense(node, message: MSG, severity: :warning) do |corrector|
                 if replacement = replacement_string(plat.value, ver.value) # rubocop: disable Lint/AssignmentInCondition
-                  corrector.replace(ver.loc.expression, "'#{replacement}'")
+                  corrector.replace(ver, "'#{replacement}'")
                 end
               end
             end

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

@@ -44,6 +44,7 @@ module RuboCop
 
         class DeprecatedPlatformMethods < Base
           MSG = 'Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
+          RESTRICT_ON_SEND = [:provider_for_resource, :find_provider, :find_provider_for_node, :set].freeze
 
           def_node_matcher :platform_method?, <<-PATTERN
             (send (const (const nil? :Chef) :Platform) {:provider_for_resource :find_provider :find_provider_for_node :set} ... )

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

@@ -54,7 +54,7 @@ module RuboCop
             %w(url keyurl mirrorexpire).each do |prop|
               match_property_in_resource?(:yum_repository, prop, node) do |prop_node|
                 add_offense(prop_node, message: MSG, severity: :warning)  do |corrector|
-                  corrector.replace(prop_node.loc.expression, prop_node.loc.expression.source
+                  corrector.replace(prop_node, prop_node.source
                     .gsub(/^url/, 'baseurl')
                     .gsub(/^keyurl/, 'gpgkey')
                     .gsub(/^mirrorexpire/, 'mirror_expire'))

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

@@ -42,7 +42,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :warning) do |corrector|
-              corrector.replace(node.loc.expression, 'ignore_failure true')
+              corrector.replace(node, 'ignore_failure true')
             end
           end
         end

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

@@ -41,7 +41,7 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(:execute, 'path', node) do |offense|
-              add_offense(offense.loc.expression, message: MSG, severity: :warning) # @todo: we could probably autocorrect this with some work
+              add_offense(offense, message: MSG, severity: :warning) # @todo: we could probably autocorrect this with some work
             end
           end
         end

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

@@ -57,7 +57,7 @@ module RuboCop
                 return
               end
 
-              add_offense(offense.loc.expression, message: MSG, severity: :warning)
+              add_offense(offense, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -49,7 +49,7 @@ module RuboCop
           def on_class(node)
             inherits_from_compat_resource?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, node.loc.expression.source.gsub('ChefCompat', 'Chef'))
+                corrector.replace(node, node.source.gsub('ChefCompat', 'Chef'))
               end
             end
           end

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

@@ -78,9 +78,9 @@ module RuboCop
                                 else
                                   "\"#{type.source}[\#{#{name.source}}]\""
                                 end
-                new_val = "#{notify_type} #{action.source}, #{service_value}".dup
+                new_val = +"#{notify_type} #{action.source}, #{service_value}"
                 new_val << ", #{timing.first.source}" unless timing.empty?
-                corrector.replace(node.loc.expression, new_val)
+                corrector.replace(node, new_val)
               end
             end
           end

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

@@ -37,6 +37,8 @@ module RuboCop
         class NodeDeepFetch < Base
           extend RuboCop::Cop::AutoCorrector
 
+          RESTRICT_ON_SEND = [:deep_fetch, :deep_fetch!].freeze
+
           def_node_matcher :node_deep_fetch?, <<-PATTERN
             (send (send _ :node) ${:deep_fetch :deep_fetch!} _)
           PATTERN

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

@@ -41,43 +41,38 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.'
+          RESTRICT_ON_SEND = %i(
+            current_user
+            domain
+            fqdn
+            hostname
+            ip6address
+            ipaddress
+            macaddress
+            machinename
+            ohai_time
+            os
+            os_version
+            platform
+            platform_build
+            platform_family
+            platform_version
+            root_group
+            shard_seed
+            uptime
+            uptime_seconds).freeze
 
           def_node_matcher :node_ohai_methods?, <<-PATTERN
-            (send (send nil? :node) #non_nested_ohai_attribute?)
+            (send (send nil? :node) _)
           PATTERN
 
           def on_send(node)
             node_ohai_methods?(node) do
               add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, "node['#{node.method_name}']")
+                corrector.replace(node, "node['#{node.method_name}']")
               end
             end
           end
-
-          private
-
-          def non_nested_ohai_attribute?(attribute)
-            %i(
-              current_user
-              domain
-              fqdn
-              hostname
-              ip6address
-              ipaddress
-              macaddress
-              machinename
-              ohai_time
-              os
-              os_version
-              platform
-              platform_build
-              platform_family
-              platform_version
-              root_group
-              shard_seed
-              uptime
-              uptime_seconds).include?(attribute)
-          end
         end
       end
     end

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

@@ -34,6 +34,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Do not use node.set. Replace with node.normal to keep identical behavior.'
+          RESTRICT_ON_SEND = [:set].freeze
 
           def_node_matcher :node_set?, <<-PATTERN
             (send (send _ :node) $:set)

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

@@ -34,6 +34,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'
+          RESTRICT_ON_SEND = [:set_unless].freeze
 
           def_node_matcher :node_set_unless?, <<-PATTERN
             (send (send _ :node) $:set_unless)

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

@@ -36,6 +36,7 @@ module RuboCop
         #
         class NodeSetWithoutLevel < Base
           MSG = 'When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.'
+          RESTRICT_ON_SEND = [:[]=, :<<].freeze
 
           def on_op_asgn(node)
             # make sure it was a += or -=

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

@@ -49,6 +49,7 @@ module RuboCop
         #
         class PartialSearchClassUsage < Base
           MSG = 'Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.'
+          RESTRICT_ON_SEND = [:new].freeze
 
           def_node_matcher :partial_search_class?, <<-PATTERN
             (send (const (const ... :Chef) :PartialSearch) :new)

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

@@ -36,6 +36,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 15.8+ instead of the deprecated PowerShell cookbook helpers."
+          RESTRICT_ON_SEND = [:powershell_version?].freeze
 
           def_node_matcher :ps_cb_helper?, <<-PATTERN
           (send
@@ -47,7 +48,7 @@ module RuboCop
           def on_send(node)
             ps_cb_helper?(node) do |ver|
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, "node['powershell']['version'].to_f == #{ver.source}")
+                corrector.replace(node, "node['powershell']['version'].to_f == #{ver.source}")
               end
             end
           end

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

@@ -34,12 +34,12 @@ module RuboCop
         class ResourceOverridesProvidesMethod < Base
           MSG = "Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later."
 
-          def_node_search :provides, '(send nil? :provides ...)'
+          def_node_search :calls_provides?, '(send nil? :provides ...)'
 
           def on_def(node)
             return unless node.method_name == :provides?
 
-            add_offense(node, message: MSG, severity: :warning) if provides(processed_source.ast).count == 0
+            add_offense(node, message: MSG, severity: :warning) unless calls_provides?(processed_source.ast)
           end
         end
       end

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

@@ -45,8 +45,8 @@ module RuboCop
           def on_send(node)
             positional_shellout?(node) do |h|
               next unless h.braces?
-              add_offense(h.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(h.loc.expression, h.loc.expression.source[1..-2])
+              add_offense(h, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(h, h.source[1..-2])
               end
             end
           end