cookstyle 5.4.13 → 5.5.7

data/lib/rubocop/cop/chef/effortless/data_bags.rb

@@ -17,18 +17,20 @@
 module RuboCop
   module Cop
     module Chef
-      # Data bags cannot be used with the Effortless Infra pattern
-      #
-      # @example
-      #
-      #   # bad
-      #   data_bag_item('admins', login)
-      #   data_bag(data_bag_name)
-      class CookbookUsesDatabags < Cop
-        MSG = 'Cookbook uses data bags, which cannot be used in the Effortless Infra pattern'.freeze
+      module ChefEffortless
+        # Data bags cannot be used with the Effortless Infra pattern
+        #
+        # @example
+        #
+        #   # bad
+        #   data_bag_item('admins', login)
+        #   data_bag(data_bag_name)
+        class CookbookUsesDatabags < Cop
+          MSG = 'Cookbook uses data bags, which cannot be used in the Effortless Infra pattern'.freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if %i(data_bag data_bag_item).include?(node.method_name)
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if %i(data_bag data_bag_item).include?(node.method_name)
+          end
         end
       end
     end

data/lib/rubocop/cop/chef/effortless/search_used.rb

@@ -17,18 +17,20 @@
 module RuboCop
   module Cop
     module Chef
-      # Search is not compatible with the Effortless Infra pattern
-      #
-      # @example
-      #
-      #   # bad
-      #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
-      #
-      class CookbookUsesSearch < Cop
-        MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'.freeze
+      module ChefEffortless
+        # Search is not compatible with the Effortless Infra pattern
+        #
+        # @example
+        #
+        #   # bad
+        #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
+        #
+        class CookbookUsesSearch < Cop
+          MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'.freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :search
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :search
+          end
         end
       end
     end

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

@@ -17,28 +17,30 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't include the apt default recipe to update apt's package cache when you can
-      # use the apt_update resource built into Chef Infra Client 12.7 and later.
-      #
-      # @example
-      #
-      #   # bad
-      #   include_recipe 'apt::default'
-      #   include_recipe 'apt'
-      #
-      #   # good
-      #   apt_update
-      #
-      class IncludingAptDefaultRecipe < Cop
-        MSG = 'Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.'.freeze
+      module ChefModernize
+        # Don't include the apt default recipe to update apt's package cache when you can
+        # use the apt_update resource built into Chef Infra Client 12.7 and later.
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe 'apt::default'
+        #   include_recipe 'apt'
+        #
+        #   # good
+        #   apt_update
+        #
+        class IncludingAptDefaultRecipe < Cop
+          MSG = 'Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.'.freeze
 
-        def_node_matcher :apt_recipe_usage?, <<-PATTERN
-          (send nil? :include_recipe (str {"apt" "apt::default"}))
-        PATTERN
+          def_node_matcher :apt_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"apt" "apt::default"}))
+          PATTERN
 
-        def on_send(node)
-          apt_recipe_usage?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            apt_recipe_usage?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

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

@@ -17,40 +17,42 @@
 module RuboCop
   module Cop
     module Chef
-      # Over the course of years there have been many different valid community site / Supermarket
-      # URLs to use in a cookbook's Berksfile. These old URLs continue to function via redirects,
-      # but should be updated to point to the latest Supermarket URL.
-      #
-      # @example
-      #
-      #   # bad
-      #   source 'http://community.opscode.com/api/v3'
-      #   source 'https://supermarket.getchef.com'
-      #   source 'https://api.berkshelf.com'
-      #
-      #   # good
-      #   source 'https://supermarket.chef.io'
-      #
-      class LegacyBerksfileSource < Cop
-        MSG = 'Do not use legacy Berksfile community sources. Use Chef Supermarket instead.'.freeze
+      module ChefModernize
+        # Over the course of years there have been many different valid community site / Supermarket
+        # URLs to use in a cookbook's Berksfile. These old URLs continue to function via redirects,
+        # but should be updated to point to the latest Supermarket URL.
+        #
+        # @example
+        #
+        #   # bad
+        #   source 'http://community.opscode.com/api/v3'
+        #   source 'https://supermarket.getchef.com'
+        #   source 'https://api.berkshelf.com'
+        #
+        #   # good
+        #   source 'https://supermarket.chef.io'
+        #
+        class LegacyBerksfileSource < Cop
+          MSG = 'Do not use legacy Berksfile community sources. Use Chef Supermarket instead.'.freeze
 
-        def_node_matcher :berksfile_source?, <<-PATTERN
-          (send nil? :source (str #old_berkshelf_url?))
-        PATTERN
+          def_node_matcher :berksfile_source?, <<-PATTERN
+            (send nil? :source (str #old_berkshelf_url?))
+          PATTERN
 
-        def old_berkshelf_url?(url)
-          %w(http://community.opscode.com/api/v3 https://supermarket.getchef.com https://api.berkshelf.com).include?(url)
-        end
+          def old_berkshelf_url?(url)
+            %w(http://community.opscode.com/api/v3 https://supermarket.getchef.com https://api.berkshelf.com).include?(url)
+          end
 
-        def on_send(node)
-          berksfile_source?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            berksfile_source?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+            end
           end
         end
       end

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

@@ -17,33 +17,35 @@
 module RuboCop
   module Cop
     module Chef
-      # Use secure Github and Gitlab URLs for source_url and issues_url
-      #
-      # @example
-      #
-      #   # bad
-      #   depends 'build-essential'
-      #   include_recipe 'build-essential::default'
-      #   include_recipe 'build-essential'
-      #
-      #   # good
-      #   build_essential 'install compilation tools'
-      class UseBuildEssentialResource < Cop
-        MSG = 'Use the build_essential resource instead of the legacy build-essential recipe. This resource ships in the build-essential cookbook v5.0+ and is built into Chef Infra Client 14+'.freeze
+      module ChefModernize
+        # Use secure Github and Gitlab URLs for source_url and issues_url
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'build-essential'
+        #   include_recipe 'build-essential::default'
+        #   include_recipe 'build-essential'
+        #
+        #   # good
+        #   build_essential 'install compilation tools'
+        class UseBuildEssentialResource < Cop
+          MSG = 'Use the build_essential resource instead of the legacy build-essential recipe. This resource ships in the build-essential cookbook v5.0+ and is built into Chef Infra Client 14+'.freeze
 
-        def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
-          (send nil? :include_recipe (str {"build-essential" "build-essential::default"}))
-        PATTERN
+          def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"build-essential" "build-essential::default"}))
+          PATTERN
 
-        def on_send(node)
-          build_essential_recipe_usage?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            build_essential_recipe_usage?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, "build_essential 'install compilation tools'")
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, "build_essential 'install compilation tools'")
+            end
           end
         end
       end

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

@@ -17,35 +17,37 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't depend on cookbooks made obsolete by Chef 14
-      #
-      # @example
-      #
-      #   # bad
-      #   depends 'build-essential'
-      #   depends 'chef_handler'
-      #   depends 'chef_hostname'
-      #   depends 'dmg'
-      #   depends 'mac_os_x'
-      #   depends 'swap'
-      #   depends 'sysctl'
-      #
-      class UnnecessaryDependsChef14 < Cop
-        MSG = "Don't depend on cookbooks made obsolete by Chef 14".freeze
+      module ChefModernize
+        # Don't depend on cookbooks made obsolete by Chef 14
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'build-essential'
+        #   depends 'chef_handler'
+        #   depends 'chef_hostname'
+        #   depends 'dmg'
+        #   depends 'mac_os_x'
+        #   depends 'swap'
+        #   depends 'sysctl'
+        #
+        class UnnecessaryDependsChef14 < Cop
+          MSG = "Don't depend on cookbooks made obsolete by Chef 14".freeze
 
-        def_node_matcher :legacy_depends?, <<-PATTERN
-          (send nil? :depends (str {"build-essential" "chef_handler" "chef_hostname" "dmg" "mac_os_x" "swap" "sysctl"}))
-        PATTERN
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str {"build-essential" "chef_handler" "chef_hostname" "dmg" "mac_os_x" "swap" "sysctl"}))
+          PATTERN
 
-        def on_send(node)
-          legacy_depends?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            legacy_depends?(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/modernize/defines_chefspec_matchers.rb

@@ -17,33 +17,35 @@
 module RuboCop
   module Cop
     module Chef
-      # ChefSpec 7.1 and later auto generate ChefSpec matchers. Matchers in cookbooks can now be removed.
-      #
-      # @example
-      #
-      #   # bad
-      #   if defined?(ChefSpec)
-      #     def create_yum_repository(resource_name)
-      #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)
-      #     end
-      #   end
-      #
-      class DefinesChefSpecMatchers < Cop
-        MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'.freeze
+      module ChefModernize
+        # ChefSpec 7.1 and later auto generate ChefSpec matchers. Matchers in cookbooks can now be removed.
+        #
+        # @example
+        #
+        #   # bad
+        #   if defined?(ChefSpec)
+        #     def create_yum_repository(resource_name)
+        #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)
+        #     end
+        #   end
+        #
+        class DefinesChefSpecMatchers < Cop
+          MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'.freeze
 
-        def_node_matcher :chefspec_matcher?, <<-PATTERN
-          (if ( :defined? (const nil? :ChefSpec)) ... )
-        PATTERN
+          def_node_matcher :chefspec_matcher?, <<-PATTERN
+            (if ( :defined? (const nil? :ChefSpec)) ... )
+          PATTERN
 
-        def on_if(node)
-          chefspec_matcher?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_if(node)
+            chefspec_matcher?(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/modernize/execute_apt_update.rb

@@ -17,25 +17,27 @@
 module RuboCop
   module Cop
     module Chef
-      # Instead of using the execute resource to to run the `apt-get update` use Chef Infra Client's built-n
-      # apt_update resource which is available in Chef Infra Client 12.7 and later.
-      #
-      #   # bad
-      #   execute 'apt-get update'
-      #
-      #   # good
-      #   apt_update
-      #
-      class ExecuteAptUpdate < Cop
-        MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'.freeze
+      module ChefModernize
+        # Instead of using the execute resource to to run the `apt-get update` use Chef Infra Client's built-n
+        # apt_update resource which is available in Chef Infra Client 12.7 and later.
+        #
+        #   # bad
+        #   execute 'apt-get update'
+        #
+        #   # good
+        #   apt_update
+        #
+        class ExecuteAptUpdate < Cop
+          MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'.freeze
 
-        def_node_matcher :execute_apt_update?, <<-PATTERN
-          (send nil? :execute (str "apt-get update"))
-        PATTERN
+          def_node_matcher :execute_apt_update?, <<-PATTERN
+            (send nil? :execute (str "apt-get update"))
+          PATTERN
 
-        def on_send(node)
-          execute_apt_update?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            execute_apt_update?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

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

@@ -18,38 +18,40 @@
 module RuboCop
   module Cop
     module Chef
-      # There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client.
-      #
-      # @example
-      #
-      #   # bad
-      #   require 'chef/mixin/shell_out'
-      #   include Chef::Mixin::ShellOut
+      module ChefModernize
+        # There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client.
+        #
+        # @example
+        #
+        #   # bad
+        #   require 'chef/mixin/shell_out'
+        #   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
+        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
 
-        def_node_matcher :include_shellout?, <<-PATTERN
-          (send nil? :include (const (const (const nil? :Chef) :Mixin) :ShellOut))
-        PATTERN
+          def_node_matcher :include_shellout?, <<-PATTERN
+            (send nil? :include (const (const (const nil? :Chef) :Mixin) :ShellOut))
+          PATTERN
 
-        def_node_matcher :require_shellout?, <<-PATTERN
-          (send nil? :require ( str "chef/mixin/shell_out"))
-        PATTERN
+          def_node_matcher :require_shellout?, <<-PATTERN
+            (send nil? :require ( str "chef/mixin/shell_out"))
+          PATTERN
 
-        def on_send(node)
-          require_shellout?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
-          end
+          def on_send(node)
+            require_shellout?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
 
-          include_shellout?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            include_shellout?(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