cookstyle 5.4.13 → 5.5.7

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

@@ -16,35 +16,37 @@
 module RuboCop
   module Cop
     module Chef
-      # The node.set_unless method has been removed in Chef-13 and must be replaced by node.normal_unless.
-      #
-      # Note that node.normal_unless keeps the semantics identical, but the use of node.normal is
-      # also discouraged.
-      #
-      # @example
-      #
-      #   # bad
-      #   node.set_unless['foo'] = true
-      #
-      #   # good
-      #   node.normal_unless['foo'] = true
-      #
-      class NodeSetUnless < Cop
-        MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'.freeze
+      module ChefDeprecations
+        # The node.set_unless method has been removed in Chef-13 and must be replaced by node.normal_unless.
+        #
+        # Note that node.normal_unless keeps the semantics identical, but the use of node.normal is
+        # also discouraged.
+        #
+        # @example
+        #
+        #   # bad
+        #   node.set_unless['foo'] = true
+        #
+        #   # good
+        #   node.normal_unless['foo'] = true
+        #
+        class NodeSetUnless < Cop
+          MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'.freeze
 
-        def_node_matcher :node_set_unless?, <<-PATTERN
-          (send (send _ :node) $:set_unless)
-        PATTERN
+          def_node_matcher :node_set_unless?, <<-PATTERN
+            (send (send _ :node) $:set_unless)
+          PATTERN
 
-        def on_send(node)
-          node_set_unless?(node) do
-            add_offense(node, location: :selector, message: MSG, severity: :refactor)
+          def on_send(node)
+            node_set_unless?(node) do
+              add_offense(node, location: :selector, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.selector, 'normal_unless')
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.selector, 'normal_unless')
+            end
           end
         end
       end

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

@@ -18,24 +18,26 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't use the deprecated 'provides' metadata value
-      #
-      # @example
-      #
-      #   # bad in metadata.rb:
-      #
-      #   provides "some_thing"
-      #
-      class ProvidesMetadata < Cop
-        MSG = "Don't use the deprecated 'provides' metadata value".freeze
+      module ChefDeprecations
+        # Don't use the deprecated 'provides' metadata value
+        #
+        # @example
+        #
+        #   # bad in metadata.rb:
+        #
+        #   provides "some_thing"
+        #
+        class ProvidesMetadata < Cop
+          MSG = "Don't use the deprecated 'provides' metadata value".freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :provides
-        end
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :provides
+          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/replaces_metadata.rb

@@ -18,24 +18,26 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't use the deprecated 'replaces' metadata value
-      #
-      # @example
-      #
-      #   # bad in metadata.rb:
-      #
-      #   replaces "another_cookbook"
-      #
-      class ReplacesMetadata < Cop
-        MSG = "Don't use the deprecated 'replaces' metadata value".freeze
+      module ChefDeprecations
+        # Don't use the deprecated 'replaces' metadata value
+        #
+        # @example
+        #
+        #   # bad in metadata.rb:
+        #
+        #   replaces "another_cookbook"
+        #
+        class ReplacesMetadata < Cop
+          MSG = "Don't use the deprecated 'replaces' metadata value".freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :replaces
-        end
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :replaces
+          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/require_recipe.rb

@@ -18,30 +18,32 @@
 module RuboCop
   module Cop
     module Chef
-      # Make sure to use include_recipe instead of require_recipe
-      #
-      # @example
-      #
-      #   # bad
-      #   require_recipe 'foo'
-      #
-      #   # good
-      #   include_recipe 'foo'
-      #
-      class RequireRecipe < Cop
-        MSG = 'Use include_recipe instead of the require_recipe method'.freeze
+      module ChefDeprecations
+        # Make sure to use include_recipe instead of require_recipe
+        #
+        # @example
+        #
+        #   # bad
+        #   require_recipe 'foo'
+        #
+        #   # good
+        #   include_recipe 'foo'
+        #
+        class RequireRecipe < Cop
+          MSG = 'Use include_recipe instead of the require_recipe method'.freeze
 
-        def_node_matcher :require_recipe?, <<-PATTERN
-          (send nil? :require_recipe $str)
-        PATTERN
+          def_node_matcher :require_recipe?, <<-PATTERN
+            (send nil? :require_recipe $str)
+          PATTERN
 
-        def on_send(node)
-          require_recipe?(node) { add_offense(node, location: :selector, message: MSG, severity: :refactor) }
-        end
+          def on_send(node)
+            require_recipe?(node) { add_offense(node, location: :selector, message: MSG, severity: :refactor) }
+          end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.selector, 'include_recipe')
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.selector, 'include_recipe')
+            end
           end
         end
       end

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

@@ -18,24 +18,26 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't use the deprecated 'suggests' metadata value
-      #
-      # @example
-      #
-      #   # bad in metadata.rb:
-      #
-      #   suggests "another_cookbook"
-      #
-      class SuggestsMetadata < Cop
-        MSG = "Don't use the deprecated 'suggests' metadata value".freeze
+      module ChefDeprecations
+        # Don't use the deprecated 'suggests' metadata value
+        #
+        # @example
+        #
+        #   # bad in metadata.rb:
+        #
+        #   suggests "another_cookbook"
+        #
+        class SuggestsMetadata < Cop
+          MSG = "Don't use the deprecated 'suggests' metadata value".freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :suggests
-        end
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :suggests
+          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/use_inline_resources.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
+        # use_inline_resources became the default in Chef Infra Client 13+ and no longer needs
+        # to be called in resources
+        #
+        # @example
+        #
+        #   # bad
+        #   use_inline_resources
+        #   use_inline_resources if defined?(use_inline_resources)
+        #
+        class UseInlineResourcesDefined < Cop
+          MSG = 'use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified.'.freeze
+
+          def on_send(node)
+            if node.method_name == :use_inline_resources
+              # don't alert on the use_inline_resources within the defined? check
+              # that would result in 2 alerts on the same line and wouldn't be useful
+              return if node.parent && node.parent.defined_type?
+
+              # catch the full offense if the method is gated like this: use_inline_resources if defined?(use_inline_resources)
+              if node.parent && node.parent.if_type? && node.parent.children.first.method_name == :defined?
+                node = node.parent
+              end
+              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/cop/chef/deprecation/user_supports_property.rb

@@ -0,0 +1,53 @@
+#
+# 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 supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties.
+        #
+        # @example
+        #
+        #   # bad
+        #   user "betty" do
+        #     supports({
+        #       manage_home: true,
+        #       non_unique: true
+        #     })
+        #   end
+        #
+        #   # good
+        #   user "betty" do
+        #     manage_home true
+        #     non_unique true
+        #   end
+        #
+        class UserDeprecatedSupportsProperty < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties.".freeze
+
+          def on_block(node)
+            match_property_in_resource?(:user, 'supports', node) do |property|
+              add_offense(property, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+#
+# 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
+        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem.
+        # Chef Infra Client 12 and later ships with nokogiri included.
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe 'xml::ruby'
+        #
+        class IncludingXMLRubyRecipe < Cop
+          MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'.freeze
+
+          def_node_matcher :xml_ruby_recipe?, <<-PATTERN
+            (send nil? :include_recipe (str "xml::ruby"))
+          PATTERN
+
+          def on_send(node)
+            xml_ruby_recipe?(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/cop/chef/deprecation/yum_dnf_compat_recipe.rb

@@ -0,0 +1,51 @@
+#
+# 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
+        # Don't include the deprecated yum DNF compatibility recipe, which is no longer necessary
+        # as Chef Infra Client includes DNF package support
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe 'yum::dnf_yum_compat'
+        #
+        class IncludingYumDNFCompatRecipe < Cop
+          MSG = 'Do not include the deprecated yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF packages.'.freeze
+
+          def_node_matcher :yum_dnf_compat_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str "yum::dnf_yum_compat"))
+          PATTERN
+
+          def on_send(node)
+            yum_dnf_compat_recipe_usage?(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