cookstyle 5.4.13 → 5.5.7

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

@@ -18,29 +18,30 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't use the deprecated 'attribute' metadata value
-      #
-      # @example
-      #
-      #   # bad in metadata.rb:
-      #
-      #    attribute 'zookeeper_bridge/server',
-      #              display_name: 'zookeeper server',
-      #              description: 'Zookeeper server address.',
-      #              type: 'string',
-      #              required: 'optional',
-      #              default: '"127.0.0.1:2181"'
+      module ChefDeprecations
+        # Don't use the deprecated 'attribute' metadata value
+        #
+        # @example
+        #
+        #   # bad in metadata.rb:
+        #
+        #    attribute 'zookeeper_bridge/server',
+        #              display_name: 'zookeeper server',
+        #              description: 'Zookeeper server address.',
+        #              type: 'string',
+        #              required: 'optional',
+        #              default: '"127.0.0.1:2181"'
+        class AttributeMetadata < Cop
+          MSG = "Don't use the deprecated 'attribute' metadata value".freeze
 
-      class AttributeMetadata < Cop
-        MSG = "Don't use the deprecated 'attribute' metadata value".freeze
-
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :attribute
-        end
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :attribute
+          end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.expression)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
           end
         end
       end

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

@@ -0,0 +1,56 @@
+#
+# 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
+        # Chef::REST was removed in Chef Infra Client 13.
+        #
+        # @example
+        #
+        #   # bad
+        #   require 'chef/rest'
+        #   Chef::REST::RESTRequest.new(:GET, FOO, nil).call
+        #
+        class UsesChefRESTHelpers < Cop
+          MSG = "Don't use the helpers in Chef::REST which were removed in Chef Infra Client 13".freeze
+
+          def_node_matcher :require_rest?, <<-PATTERN
+          (send nil? :require ( str "chef/rest"))
+          PATTERN
+
+          def_node_matcher :rest_const?, <<-PATTERN
+          (const (const nil? :Chef) :REST)
+          PATTERN
+
+          def on_send(node)
+            require_rest?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def on_const(node)
+            rest_const?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+#
+# 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 :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+
+        #
+        # @example
+        #
+        #   # bad
+        #   chocolatey_package 'nginx' do
+        #     action :uninstall
+        #   end
+        #
+        #   # good
+        #   chocolatey_package 'nginx' do
+        #     action :remove
+        #   end
+        #
+        class ChocolateyPackageUninstallAction < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:chocolatey_package, 'action', node) do |choco_action|
+              choco_action.arguments.each do |action|
+                add_offense(action, location: :expression, message: MSG, severity: :refactor) if action.source == ':uninstall'
+              end
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, ':remove')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,24 +18,26 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't use the deprecated 'conflicts' metadata value
-      #
-      # @example
-      #
-      #   # bad in metadata.rb:
-      #
-      #   conflicts "another_cookbook"
-      #
-      class ConflictsMetadata < Cop
-        MSG = "Don't use the deprecated 'conflicts' metadata value".freeze
+      module ChefDeprecations
+        # Don't use the deprecated 'conflicts' metadata value
+        #
+        # @example
+        #
+        #   # bad in metadata.rb:
+        #
+        #   conflicts "another_cookbook"
+        #
+        class ConflictsMetadata < Cop
+          MSG = "Don't use the deprecated 'conflicts' metadata value".freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :conflicts
-        end
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :conflicts
+          end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.expression)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
           end
         end
       end

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

@@ -17,29 +17,31 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+
-      #
-      # @example
-      #
-      #   # bad
-      #   depends 'compat_resource'
-      #
-      class CookbookDependsOnCompatResource < Cop
-        MSG = "Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+".freeze
+      module ChefDeprecations
+        # Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'compat_resource'
+        #
+        class CookbookDependsOnCompatResource < Cop
+          MSG = "Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+".freeze
 
-        def_node_matcher :depends_compat_resource?, <<-PATTERN
-          (send nil? :depends (str {"compat_resource"}))
-        PATTERN
+          def_node_matcher :depends_compat_resource?, <<-PATTERN
+            (send nil? :depends (str {"compat_resource"}))
+          PATTERN
 
-        def on_send(node)
-          depends_compat_resource?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            depends_compat_resource?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.expression)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
           end
         end
       end

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

@@ -17,23 +17,25 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't depend on the partial_search cookbook made obsolete by Chef 13
-      #
-      # @example
-      #
-      #   # bad
-      #   depends 'partial_search'
-      #
-      class CookbookDependsOnPartialSearch < Cop
-        MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13".freeze
+      module ChefDeprecations
+        # Don't depend on the partial_search cookbook made obsolete by Chef 13
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'partial_search'
+        #
+        class CookbookDependsOnPartialSearch < Cop
+          MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13".freeze
 
-        def_node_matcher :depends_partial_search?, <<-PATTERN
-          (send nil? :depends (str {"partial_search"}))
-        PATTERN
+          def_node_matcher :depends_partial_search?, <<-PATTERN
+            (send nil? :depends (str {"partial_search"}))
+          PATTERN
 
-        def on_send(node)
-          depends_partial_search?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            depends_partial_search?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

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

@@ -17,23 +17,25 @@
 module RuboCop
   module Cop
     module Chef
-      # Cookbooks should not depend on the deprecated Poise framework. They should instead
-      # be refactored as standard custom resources.
-      #
-      # @example
-      #
-      #   # bad
-      #   depends 'poise'
-      class CookbookDependsOnPoise < Cop
-        MSG = 'Cookbooks should not depend on the deprecated Poise framework'.freeze
+      module ChefDeprecations
+        # Cookbooks should not depend on the deprecated Poise framework. They should instead
+        # be refactored as standard custom resources.
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'poise'
+        class CookbookDependsOnPoise < Cop
+          MSG = 'Cookbooks should not depend on the deprecated Poise framework'.freeze
 
-        def_node_matcher :depends_method?, <<-PATTERN
-          (send nil? :depends $str)
-        PATTERN
+          def_node_matcher :depends_method?, <<-PATTERN
+            (send nil? :depends $str)
+          PATTERN
 
-        def on_send(node)
-          depends_method?(node) do |arg|
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if arg == s(:str, 'poise')
+          def on_send(node)
+            depends_method?(node) do |arg|
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if arg == s(:str, 'poise')
+            end
           end
         end
       end

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

@@ -18,52 +18,54 @@
 module RuboCop
   module Cop
     module Chef
-      # The long_description metadata.rb method is not used and is unnecessary in cookbooks
-      #
-      # @example
-      #
-      #   # bad
-      #   include Chef::Mixin::LanguageIncludeAttribute
-      #   include Chef::Mixin::RecipeDefinitionDSLCore
-      #   include Chef::Mixin::LanguageIncludeRecipe
-      #   include Chef::Mixin::Language
-      #   include Chef::DSL::Recipe::FullDSL
-      #   require 'chef/mixin/language
-      #   require 'chef/mixin/language_include_attribute
-      #   require 'chef/mixin/language_include_recipe
+      module ChefDeprecations
+        # Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later
+        #
+        # @example
+        #
+        #   # bad
+        #   include Chef::Mixin::LanguageIncludeAttribute
+        #   include Chef::Mixin::RecipeDefinitionDSLCore
+        #   include Chef::Mixin::LanguageIncludeRecipe
+        #   include Chef::Mixin::Language
+        #   include Chef::DSL::Recipe::FullDSL
+        #   require 'chef/mixin/language'
+        #   require 'chef/mixin/language_include_attribute'
+        #   require 'chef/mixin/language_include_recipe'
 
-      class UsesDeprecatedMixins < Cop
-        MSG = "Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later.".freeze
+        class UsesDeprecatedMixins < Cop
+          MSG = "Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later.".freeze
 
-        def_node_matcher :deprecated_mixin?, <<-PATTERN
-          (send nil? :include (const (const (const nil? :Chef) :Mixin) { :Language :LanguageIncludeAttribute :RecipeDefinitionDSLCore :LanguageIncludeRecipe }))
-        PATTERN
+          def_node_matcher :deprecated_mixin?, <<-PATTERN
+            (send nil? :include (const (const (const nil? :Chef) :Mixin) { :Language :LanguageIncludeAttribute :RecipeDefinitionDSLCore :LanguageIncludeRecipe }))
+          PATTERN
 
-        def_node_matcher :deprecated_dsl?, <<-PATTERN
-          (send nil? :include (const (const (const (const nil? :Chef) :DSL) :Recipe) :FullDSL))
-        PATTERN
+          def_node_matcher :deprecated_dsl?, <<-PATTERN
+            (send nil? :include (const (const (const (const nil? :Chef) :DSL) :Recipe) :FullDSL))
+          PATTERN
 
-        def_node_matcher :dsl_mixin_require?, <<-PATTERN
-          (send nil? :require ( str {"chef/mixin/language" "chef/mixin/language_include_attribute" "chef/mixin/language_include_recipe"}))
-        PATTERN
+          def_node_matcher :dsl_mixin_require?, <<-PATTERN
+            (send nil? :require ( str {"chef/mixin/language" "chef/mixin/language_include_attribute" "chef/mixin/language_include_recipe"}))
+          PATTERN
 
-        def on_send(node)
-          deprecated_mixin?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
-          end
+          def on_send(node)
+            deprecated_mixin?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
 
-          deprecated_dsl?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
-          end
+            deprecated_dsl?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
 
-          dsl_mixin_require?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            dsl_mixin_require?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.expression)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
           end
         end
       end

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

@@ -18,20 +18,22 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't use the deprecated easy_install resource removed in Chef 13
-      #
-      # @example
-      #
-      #   # bad
-      #   easy_install "my_thing" do
-      #     bar
-      #   end
-      #
-      class EasyInstallResource < Cop
-        MSG = "Don't use the deprecated easy_install resource removed in Chef 13".freeze
+      module ChefDeprecations
+        # Don't use the deprecated easy_install resource removed in Chef 13
+        #
+        # @example
+        #
+        #   # bad
+        #   easy_install "my_thing" do
+        #     bar
+        #   end
+        #
+        class EasyInstallResource < Cop
+          MSG = "Don't use the deprecated easy_install resource removed in Chef 13".freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :easy_install
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :easy_install
+          end
         end
       end
     end