cookstyle 5.13.7 → 5.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 536183d50b038f3bd9db265813f38f29502167e80aca88124b8419d5124b786d
-  data.tar.gz: a13c369bc38ce2c8dda503438d86988bff7d6899972df4b3b8f2773d3b96d631
+  metadata.gz: f0fe10480691d3522f05f3d4a0db77cac9543e29cd50ed9f6764d45294973c2f
+  data.tar.gz: 7308ec701ae4d522633a62a59cf28d6eab5b1460179ef1af5be3a7926a8d688c
 SHA512:
-  metadata.gz: d6d0cd3db208a387271bbb6afd4c8ba4afc5e5f625e6e715c03cffe2360f0ef16de1d9d1c6e7e1d3b7d610a891b0cf40281e2691ca47b56931a9144e18ffd260
-  data.tar.gz: 76d0d91643ed7837f8c2316a811e79adf68dc6092ef2b764c4f41c9c4c96bead89db404fdc83bc75f485d83c11b3f8980691208fb8b393f9b08ee82af3afb3ab
+  metadata.gz: d3659fda58293a623b91d907a30fd5f5f1229da9dcbd7a8d5ebc83083baa101db9e274e15a1feae9f14071c274dbac4ee7a86069dc05c0b69fdf3650fd622da9
+  data.tar.gz: b08f3957087487156952dc5856bf2ece8c0f4f432e11d8551d9c4492c10ff148cce4ebad8cdef712a6e1179190106893c6490f07443c54dbef92062c1d8308a1

data/config/cookstyle.yml

@@ -625,6 +625,14 @@ ChefDeprecations/NodeSetWithoutLevel:
     - '**/metadata.rb'
     - '**/attributes/*.rb'
 
+ChefDeprecations/ChefRewind:
+  Description: Use delete_resource / edit_resource instead of functionality in the deprecated chef-rewind gem
+  Enabled: true
+  VersionAdded: '5.14.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -913,7 +921,7 @@ ChefModernize/ZipfileResource:
   VersionAdded: '5.12.0'
 
 ChefModernize/UnnecessaryMixlibShelloutRequire:
-  Description: Chef Infra Client includes mixlib/shellout automatically in resources and providers.
+  Description: Chef Infra Client 12.4 and later include mixlib/shellout automatically in resources and providers.
   Enabled: true
   VersionAdded: '5.12.0'
   Include:
@@ -928,6 +936,14 @@ ChefModernize/EmptyResourceInitializeMethod:
     - '**/resources/*.rb'
     - '**/providers/*.rb'
 
+ChefModernize/ChefGemNokogiri:
+  Description: The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used.
+  Enabled: true
+  VersionAdded: '5.14.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+
 ###############################
 # Migrating to new patterns
 ###############################

data/lib/cookstyle/version.rb

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

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

@@ -0,0 +1,106 @@
+#
+# 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 delete_resource / edit_resource instead of functionality in the deprecated chef-rewind gem
+        #
+        # @example
+        #
+        #   chef_gem 'chef-rewind'
+        #
+        #   require 'chef/rewind'
+        #
+        #   rewind "user[postgres]" do
+        #     home '/var/lib/pgsql/9.2'
+        #     cookbook 'my-postgresql'    # or `cookbook cookbook_name()`
+        #   end
+        #
+        #   unwind "user[postgres]"
+        #
+        class ChefRewind < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MAPPING = {
+            rewind: 'edit_resource',
+            unwind: 'delete_resource',
+          }.freeze
+
+          MSG = 'Use delete_resource / edit_resource instead of functionality in the deprecated chef-rewind gem'.freeze
+
+          def_node_matcher :rewind_gem_install?, <<-PATTERN
+            (send nil? :chef_gem (str "chef-rewind"))
+          PATTERN
+
+          def_node_matcher :require_rewind?, <<-PATTERN
+            (send nil? :require (str "chef/rewind"))
+          PATTERN
+
+          def_node_matcher :rewind_resources?, <<-PATTERN
+            (send nil? ${:rewind :unwind} ... )
+          PATTERN
+
+          def on_send(node)
+            rewind_gem_install?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+
+            require_rewind?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+
+            rewind_resources?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def on_block(node)
+            match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              rewind_gem_install?(node) do
+                node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
+                corrector.remove(node.loc.expression)
+                return
+              end
+
+              require_rewind?(node) do
+                corrector.remove(node.loc.expression)
+                return
+              end
+
+              match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
+                corrector.remove(node.loc.expression) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
+                return
+              end
+
+              rewind_resources?(node) do |string|
+                corrector.replace(node.loc.expression, node.source.gsub(string.to_s, MAPPING[string]))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -23,6 +23,9 @@ module RuboCop
         # @example
         #
         #   # bad
+        #   require 'chef/mixin/command'
+        #   include Chef::Mixin::Command
+        #
         #   run_command('/bin/foo')
         #   run_command_with_systems_locale('/bin/foo')
         #
@@ -33,12 +36,23 @@ module RuboCop
           MSG = "Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13.".freeze
 
           def_node_matcher :calls_run_command?, '(send nil? {:run_command :run_command_with_systems_locale} ...)'
+          def_node_matcher :require_mixin_command?, '(send nil? :require (str "chef/mixin/command"))'
+          def_node_matcher :include_mixin_command?, '(send nil? :include (const (const (const nil? :Chef) :Mixin) :Command))'
+
           def_node_search :defines_run_command?, '(def {:run_command :run_command_with_systems_locale} ...)'
 
           def on_send(node)
             calls_run_command?(node) do
               add_offense(node, location: :expression, message: MSG, severity: :refactor) unless defines_run_command?(processed_source.ast)
             end
+
+            require_mixin_command?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+
+            include_mixin_command?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

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

@@ -0,0 +1,60 @@
+#
+# 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
+        # The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used
+        #
+        # @example
+        #
+        #   # bad
+        #   chef_gem 'nokogiri'
+        #
+        class ChefGemNokogiri < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used.'.freeze
+
+          def_node_matcher :nokogiri_install?, <<-PATTERN
+            (send nil? :chef_gem (str "nokogiri"))
+          PATTERN
+
+          def on_block(node)
+            match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if pkg_name.arguments&.first&.str_content == 'nokogiri'
+            end
+          end
+
+          def on_send(node)
+            nokogiri_install?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
+              corrector.remove(node.loc.expression)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client.
+        # There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
         #
         # @example
         #
@@ -28,7 +28,7 @@ module RuboCop
         #   include Chef::Mixin::ShellOut
 
         class IncludingMixinShelloutInResources < Cop
-          MSG = 'There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client.'.freeze
+          MSG = 'There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'.freeze
 
           def_node_matcher :include_shellout?, <<-PATTERN
             (send nil? :include (const (const (const nil? :Chef) :Mixin) :ShellOut))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.13.7
+  version: 5.14.1
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2019-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -75,6 +75,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/attribute_metadata.rb
 - lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb
 - lib/rubocop/cop/chef/deprecation/chef_rest.rb
+- lib/rubocop/cop/chef/deprecation/chef_rewind.rb
 - lib/rubocop/cop/chef/deprecation/cheffile.rb
 - lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb
 - lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb
@@ -132,6 +133,7 @@ files:
 - lib/rubocop/cop/chef/modernize/berksfile_source.rb
 - lib/rubocop/cop/chef/modernize/build_essential.rb
 - lib/rubocop/cop/chef/modernize/chef_14_resources.rb
+- lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
 - 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