cookstyle 5.4.13 → 5.5.7

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

@@ -18,30 +18,32 @@
 module RuboCop
   module Cop
     module Chef
-      # Make sure ignore_failure is used instead of epic_fail
-      #
-      # @example
-      #
-      #   # bad
-      #   package "foo" do
-      #     epic_fail true
-      #   end
-      #
-      #   # good
-      #   package "foo" do
-      #     ignore_failure true
-      #   end
-      #
-      class EpicFail < Cop
-        MSG = 'Use ignore_failure method instead of the deprecated epic_fail method'.freeze
+      module ChefDeprecations
+        # Make sure ignore_failure is used instead of epic_fail
+        #
+        # @example
+        #
+        #   # bad
+        #   package "foo" do
+        #     epic_fail true
+        #   end
+        #
+        #   # good
+        #   package "foo" do
+        #     ignore_failure true
+        #   end
+        #
+        class EpicFail < Cop
+          MSG = 'Use ignore_failure method instead of the deprecated epic_fail method'.freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :epic_fail
-        end
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :epic_fail
+          end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, 'ignore_failure true')
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, 'ignore_failure true')
+            end
           end
         end
       end

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

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

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

@@ -0,0 +1,55 @@
+#
+# 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 launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
+        #
+        # @example
+        #
+        #   # bad
+        #   launchd 'foo' do
+        #     hash foo: 'bar'
+        #   end
+        #
+        #   # good
+        #   launchd 'foo' do
+        #     plist_hash foo: 'bar'
+        #   end
+        #
+        class LaunchdDeprecatedHashProperty < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.".freeze
+
+          def on_block(node)
+            match_property_in_resource?(:launchd, 'hash', node) do |hash_prop|
+              add_offense(hash_prop, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^hash/, 'plist_hash'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,30 +17,32 @@
 module RuboCop
   module Cop
     module Chef
-      # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them
-      # in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which
-      # should be used instead as it doesn't require forking the ohai cookbook.
-      #
-      # @example
-      #
-      #   # bad
-      #   include_recipe 'yum::elrepo'
-      #   include_recipe 'yum::epel'
-      #   include_recipe 'yum::ius'
-      #   include_recipe 'yum::remi'
-      #   include_recipe 'yum::repoforge'
-      #   include_recipe 'yum::yum'
-      #
-      class LegacyYumCookbookRecipes < Cop
-        MSG = 'The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).'.freeze
+      module ChefDeprecations
+        # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them
+        # in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which
+        # should be used instead as it doesn't require forking the ohai cookbook.
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe 'yum::elrepo'
+        #   include_recipe 'yum::epel'
+        #   include_recipe 'yum::ius'
+        #   include_recipe 'yum::remi'
+        #   include_recipe 'yum::repoforge'
+        #   include_recipe 'yum::yum'
+        #
+        class LegacyYumCookbookRecipes < Cop
+          MSG = 'The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).'.freeze
 
-        def_node_matcher :old_yum_recipe?, <<-PATTERN
-          (send nil? :include_recipe (str {"yum::elrepo" "yum::epel" "yum::ius" "yum::remi" "yum::repoforge" "yum::yum"}))
-        PATTERN
+          def_node_matcher :old_yum_recipe?, <<-PATTERN
+            (send nil? :include_recipe (str {"yum::elrepo" "yum::epel" "yum::ius" "yum::remi" "yum::repoforge" "yum::yum"}))
+          PATTERN
 
-        def on_send(node)
-          old_yum_recipe?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            old_yum_recipe?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

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

@@ -0,0 +1,45 @@
+#
+# 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 local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 16
+        #
+        # @example
+        #
+        #   # bad
+        #   locale 'set locale' do
+        #     lang 'en_gb.utf-8'
+        #     lc_all 'en_gb.utf-8'
+        #   end
+        #
+        class LocaleDeprecatedLcAllProperty < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 16".freeze
+
+          def on_block(node)
+            match_property_in_resource?(:locale, 'lc_all', 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/long_description_metadata.rb

@@ -18,30 +18,32 @@
 module RuboCop
   module Cop
     module Chef
-      # The long_description metadata.rb method is not used and is unnecessary in cookbooks
-      #
-      # @example
-      #
-      #   # bad
-      #   long_description 'this is my cookbook and this description will never be seen'
-      #
+      module ChefDeprecations
+        # The long_description metadata.rb method is not used and is unnecessary in cookbooks
+        #
+        # @example
+        #
+        #   # bad
+        #   long_description 'this is my cookbook and this description will never be seen'
+        #
 
-      class LongDescriptionMetadata < Cop
-        MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks'.freeze
+        class LongDescriptionMetadata < Cop
+          MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks'.freeze
 
-        def_node_matcher :long_description?, <<-PATTERN
-          (send nil? :long_description ... )
-        PATTERN
+          def_node_matcher :long_description?, <<-PATTERN
+            (send nil? :long_description ... )
+          PATTERN
 
-        def on_send(node)
-          long_description?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description
+          def on_send(node)
+            long_description?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description
+            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/node_methods_not_attributes.rb

@@ -17,66 +17,68 @@
 module RuboCop
   module Cop
     module Chef
-      # Incorrectly using node methods for Ohai data when you really want node attributes
-      #
-      # @example
-      #
-      #   # bad
-      #   node.fqdn
-      #   node.platform
-      #   node.platform_family
-      #   node.platform_version
-      #   node.hostname
-      #
-      #   # good
-      #   node['fqdn']
-      #   node['platform']
-      #   node['platform_family']
-      #   node['platform_version']
-      #   node['hostname']
-      #
-      class NodeMethodsInsteadofAttributes < Cop
-        MSG = 'Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.'.freeze
+      module ChefDeprecations
+        # Incorrectly using node methods for Ohai data when you really want node attributes
+        #
+        # @example
+        #
+        #   # bad
+        #   node.fqdn
+        #   node.platform
+        #   node.platform_family
+        #   node.platform_version
+        #   node.hostname
+        #
+        #   # good
+        #   node['fqdn']
+        #   node['platform']
+        #   node['platform_family']
+        #   node['platform_version']
+        #   node['hostname']
+        #
+        class NodeMethodsInsteadofAttributes < Cop
+          MSG = 'Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.'.freeze
 
-        def_node_matcher :node_ohai_methods?, <<-PATTERN
-          (send (send nil? :node) #non_nested_ohai_attribute?)
-        PATTERN
+          def_node_matcher :node_ohai_methods?, <<-PATTERN
+            (send (send nil? :node) #non_nested_ohai_attribute?)
+          PATTERN
 
-        def on_send(node)
-          node_ohai_methods?(node) do
-            add_offense(node, location: :selector, message: MSG, severity: :refactor)
+          def on_send(node)
+            node_ohai_methods?(node) do
+              add_offense(node, location: :selector, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, "node['#{node.method_name}']")
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, "node['#{node.method_name}']")
+            end
           end
-        end
 
-        private
+          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)
+          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

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