cookstyle 5.12.13 → 5.13.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e756b583acf014633d6e2e08d00ea74c3992c66969f2c4628e8ab9871904418
-  data.tar.gz: ba48e16104dbeb7a5767993b2cf6bd6e6abb53cf8f0f1f39e2cf0b9fd2fa06f9
+  metadata.gz: 536183d50b038f3bd9db265813f38f29502167e80aca88124b8419d5124b786d
+  data.tar.gz: a13c369bc38ce2c8dda503438d86988bff7d6899972df4b3b8f2773d3b96d631
 SHA512:
-  metadata.gz: efcccd7869348c77ea7f39467f670199ba4150ae3b8ecdb3f599186d24a890632971a9e0868ab837d6c439c615ed1d9734991a4a45862a7022706f374a0140ea
-  data.tar.gz: cc9506bc309032cb1a66e4130782cae81aa18773673f4fe9f8f58148587b788ca6b6c4c38bcd759b1fc34018276d3703316cd24321624af24cb07eb1d7e571af
+  metadata.gz: d6d0cd3db208a387271bbb6afd4c8ba4afc5e5f625e6e715c03cffe2360f0ef16de1d9d1c6e7e1d3b7d610a891b0cf40281e2691ca47b56931a9144e18ffd260
+  data.tar.gz: 76d0d91643ed7837f8c2316a811e79adf68dc6092ef2b764c4f41c9c4c96bead89db404fdc83bc75f485d83c11b3f8980691208fb8b393f9b08ee82af3afb3ab

data/config/cookstyle.yml

@@ -610,6 +610,21 @@ ChefDeprecations/Cheffile:
   Include:
     - '**/Cheffile'
 
+ChefDeprecations/LegacyNotifySyntax:
+  Description: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
+  Enabled: true
+  VersionAdded: '5.13.0'
+  Exclude:
+    - '**/metadata.rb'
+
+ChefDeprecations/NodeSetWithoutLevel:
+  Description: When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.
+  Enabled: true
+  VersionAdded: '5.13.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -905,6 +920,14 @@ ChefModernize/UnnecessaryMixlibShelloutRequire:
     - '**/resources/*.rb'
     - '**/providers/*.rb'
 
+ChefModernize/EmptyResourceInitializeMethod:
+  Description: There is no need for an empty initialize method in a resource
+  Enabled: true
+  VersionAdded: '5.13.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+
 ###############################
 # Migrating to new patterns
 ###############################

data/lib/cookstyle.rb

@@ -7,6 +7,7 @@ require 'yaml'
 gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
 require 'rubocop'
 require 'rubocop/monkey_patches/comment_config.rb'
+require 'rubocop/monkey_patches/json_formatter.rb'
 
 module RuboCop
   class ConfigLoader

data/lib/cookstyle/version.rb

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

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

@@ -0,0 +1,85 @@
+#
+# 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
+        # Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
+        #
+        # @example
+        #
+        #   # bad
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: 'apache')
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: 'apache'), :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: service_name_variable), :immediately
+        #   end
+        #
+        #   # good
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]'
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, "service[#{service_name_variable}]", :immediately
+        #   end
+        #
+        class LegacyNotifySyntax < Cop
+          MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'.freeze
+
+          def_node_matcher :legacy_notify?, <<-PATTERN
+            (send nil? :notifies $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
+          PATTERN
+
+          def on_send(node)
+            legacy_notify?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              legacy_notify?(node) do |action, type, name, timing|
+                service_value = case name.type
+                                when :str
+                                  "'#{type.source}[#{name.value}]'"
+                                when :dstr
+                                  "\"#{type.source}[#{name.value.source}]\""
+                                else
+                                  "\"#{type.source}[\#{#{name.source}}]\""
+                                end
+                new_val = "notifies #{action.source}, #{service_value}"
+                new_val << ", #{timing.first.source}" unless timing.empty?
+                corrector.replace(node.loc.expression, new_val)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+#
+# 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
+        # When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.
+        #
+        # @example
+        #
+        #   # bad
+        #   node['foo']['bar'] = 1
+        #   node['foo']['bar'] << 1
+        #   node['foo']['bar'] += 1
+        #   node['foo']['bar'] -= 1
+        #
+        #   # good
+        #   node.default['foo']['bar'] = 1
+        #   node.default['foo']['bar'] << 1
+        #   node.default['foo']['bar'] += 1
+        #   node.default['foo']['bar'] -= 1
+        #
+        class NodeSetWithoutLevel < Cop
+          MSG = 'When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.'.freeze
+
+          def on_op_asgn(node)
+            # make sure it was a += or -=
+            if %i(- +).include?(node.node_parts[1])
+              add_offense_for_bare_assignment(node.children&.first)
+            end
+          end
+
+          def on_send(node)
+            # make sure the method being send is []= and then make sure the receiver is a send
+            if %i([]= <<).include?(node.method_name) && node.receiver.send_type?
+              add_offense_for_bare_assignment(node)
+            end
+          end
+
+          private
+
+          def add_offense_for_bare_assignment(sub_node)
+            if sub_node.receiver == s(:send, nil, :node) # node['foo'] scenario
+              add_offense(sub_node.receiver, location: :selector, message: MSG, severity: :refactor)
+            elsif sub_node.receiver && sub_node.receiver&.node_parts[0] == s(:send, nil, :node) && sub_node.receiver&.node_parts[1] == :[] # node['foo']['bar'] scenario
+              add_offense(sub_node.receiver.node_parts.first, location: :selector, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -47,13 +47,17 @@ module RuboCop
             end
           end
 
+          def_node_search :default_action_method?, '(send nil? :default_action ... )'
+
           def_node_search :intialize_method, '(def :initialize ... )'
 
           def autocorrect(node)
             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.descendants.first.source}\n\n")
+              # insert the new default_action call above the initialize method, but not if one already exists (this is sadly common)
+              unless default_action_method?(processed_source.ast)
+                initialize_node = intialize_method(processed_source.ast).first
+                corrector.insert_before(initialize_node.source_range, "default_action #{node.descendants.first.source}\n\n")
+              end
 
               # 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/empty_resource_initialize.rb

@@ -0,0 +1,52 @@
+#
+# 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
+        # There is no need for an empty initialize method in a resource
+        #
+        # @example
+        #
+        #   # bad
+        #   def initialize(*args)
+        #     super
+        #   end
+        #
+        class EmptyResourceInitializeMethod < Cop
+          MSG = 'There is no need for an empty initialize method in a resource'.freeze
+
+          def_node_matcher :empty_initialize?, <<-PATTERN
+            (def :initialize (args (restarg :args)) (zsuper))
+          PATTERN
+
+          def on_def(node)
+            empty_initialize?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/monkey_patches/json_formatter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter formats the report data in JSON format.
+    class JSONFormatter < BaseFormatter
+      # We need to expose the correctable status until https://github.com/rubocop-hq/rubocop/pull/7514 is merged
+      def hash_for_offense(offense)
+        {
+          severity: offense.severity.name,
+          message: offense.message,
+          cop_name: offense.cop_name,
+          corrected: offense.corrected?,
+          correctable: offense.status != :unsupported,
+          location: hash_for_location(offense),
+        }
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.12.13
+  version: 5.13.7
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2019-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -91,6 +91,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/erl_call.rb
 - lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb
 - lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb
+- lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb
 - lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb
 - lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb
 - lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
@@ -99,6 +100,7 @@ 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/node_set_without_level.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
@@ -135,6 +137,7 @@ files:
 - 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/empty_resource_initialize.rb
 - lib/rubocop/cop/chef/modernize/execute_apt_update.rb
 - lib/rubocop/cop/chef/modernize/execute_tzutil.rb
 - lib/rubocop/cop/chef/modernize/if_provides_default_action.rb
@@ -175,6 +178,7 @@ files:
 - lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
 - lib/rubocop/monkey_patches/comment_config.rb
+- lib/rubocop/monkey_patches/json_formatter.rb
 homepage: https://github.com/chef/cookstyle
 licenses:
 - Apache-2.0