RubyGems - cookstyle - Versions diffs - 8.5.2 → 8.6.4 - Mend

cookstyle 8.5.2 → 8.6.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (253) hide show

data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb CHANGED Viewed

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include_recipe 'yum::dnf_yum_compat'
         #
         class IncludingYumDNFCompatRecipe < Base

data/lib/rubocop/cop/chef/effortless/chef_vault_used.rb CHANGED Viewed

@@ -23,22 +23,22 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   require 'chef-vault'
         #
-        #   ### incorrect
+        #   # bad
         #   ChefVault::Item
         #
-        #   ### incorrect
+        #   # bad
         #   include_recipe 'chef-vault'
         #
-        #   ### incorrect
+        #   # bad
         #   chef_gem 'chef-vault'
         #
-        #   ### incorrect
+        #   # bad
         #   chef_vault_item_for_environment(arg, arg1)
         #
-        #   ### incorrect
+        #   # bad
         #   chef_vault_item(arg, arg1)
         #
         class ChefVaultUsed < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   data_bag_item('admins', login)
         #   data_bag(data_bag_name)
         class CookbookUsesDatabags < Base

data/lib/rubocop/cop/chef/effortless/depends_chef_vault.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'chef-vault'
         #
         class DependsChefVault < Base

data/lib/rubocop/cop/chef/effortless/node_environment.rb CHANGED Viewed

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Effortless
-        # Neither Policyfiles or Effortless Infra which is based on Policyfiles supports Chef Environments
+        # Neither Policyfiles nor Effortless Infra which is based on Policyfiles supports Chef Environments
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.environment == "production"
         #   node.chef_environment == "production"
         #

data/lib/rubocop/cop/chef/effortless/node_policygroup.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.policy_group == "foo"
         #
         class CookbookUsesPolicygroups < Base

data/lib/rubocop/cop/chef/effortless/node_roles.rb CHANGED Viewed

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Effortless
-        # Neither Policyfiles or Effortless Infra which is based on Policyfiles supports Chef Infra Roles
+        # Neither Policyfiles nor Effortless Infra which is based on Policyfiles supports Chef Infra Roles
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.role?('web_server')
         #   node.roles.include?('web_server')
         #

data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   search(:node, 'chef_environment:foo')
         #   search(:node, 'role:bar')
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
         #
         class CookbookUsesSearch < Base

data/lib/rubocop/cop/chef/modernize/action_method_in_resource.rb CHANGED Viewed

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   def action_create
         #    # :create action code here
         #   end
         #
-        #   ### correct
+        #   # good
         #   action :create do
         #    # :create action code here
         #   end

data/lib/rubocop/cop/chef/modernize/allowed_actions_initializer.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   def initialize(*args)
         #     super
         #     @actions = [ :create, :add ]
@@ -35,7 +35,7 @@ module RuboCop
         #     @allowed_actions = [ :create, :add ]
         #   end
         #
-        #   ### correct
+        #   # good
         #   allowed_actions [ :create, :add ]
         #
         class AllowedActionsFromInitialize < Base

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include_recipe 'apt::default'
         #   include_recipe 'apt'
         #
-        #   ### correct
+        #   # good
         #   apt_update
         #
         class IncludingAptDefaultRecipe < Base

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   source 'http://community.opscode.com/api/v3'
         #   source 'https://supermarket.getchef.com'
         #   source 'https://api.berkshelf.com'
         #   site :opscode
         #
-        #   ### correct
+        #   # good
         #   source 'https://supermarket.chef.io'
         #
         class LegacyBerksfileSource < Base

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'build-essential'
         #   include_recipe 'build-essential::default'
         #   include_recipe 'build-essential'
         #
-        #   ### correct
+        #   # good
         #   build_essential 'install compilation tools'
         #
         class UseBuildEssentialResource < Base

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

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Don't depend on cookbooks made obsolete by Chef Infra Client 14.0+ These community cookbooks contain resources that are now included in Chef Infra Client itself.
+        # Don't depend on cookbooks made obsolete by Chef Infra Client 14.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'build-essential'
         #   depends 'chef_handler'
         #   depends 'chef_hostname'

data/lib/rubocop/cop/chef/modernize/chef_15_resources.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'libarchive'
         #   depends 'windows_dns'
         #   depends 'windows_uac'

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   chef_gem 'nokogiri'
         #
         class ChefGemNokogiri < Base

data/lib/rubocop/cop/chef/modernize/class_eval_action_class.rb CHANGED Viewed

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   action_class.class_eval do
         #     foo
         #   end
         #
-        #   ### correct
+        #   # good
         #   action_class do
         #     foo
         #   end

data/lib/rubocop/cop/chef/modernize/compile_time_resources.rb CHANGED Viewed

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   build_essential 'install build tools' do
         #    action :nothing
         #   end.run_action(:install)
         #
-        #   ### correct
+        #   # good
         #   build_essential 'install build tools' do
         #    compile_time true
         #   end

data/lib/rubocop/cop/chef/modernize/conditional_using_test.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   only_if 'test -f /bin/foo'
         #
-        #   ### correct
-        #   only_if { ::File.exist?('bin/foo') }
+        #   # good
+        #   only_if { ::File.exist?('/bin/foo') }
         #
         class ConditionalUsingTest < Base
           extend AutoCorrector

data/lib/rubocop/cop/chef/modernize/cron_d_file_or_template.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   template '/etc/cron.d/backup' do
         #     source 'cron_backup_job.erb'
         #     owner 'root'
@@ -71,7 +71,7 @@ module RuboCop
         #     action :delete
         #   end
         #
-        #   ### correct
+        #   # good
         #   cron_d 'backup' do
         #     minute '1'
         #     hour '1'

data/lib/rubocop/cop/chef/modernize/cron_manage_resource.rb CHANGED Viewed

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   cron_manage 'mike'
         #
-        #   ### correct
+        #   # good
         #   cron_access 'mike'
         #
         class CronManageResource < Base

data/lib/rubocop/cop/chef/modernize/databag_helpers.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   plain_text_data = Chef::DataBagItem.load('foo', 'bar')
         #   encrypted_data = Chef::EncryptedDataBagItem.load('foo2', 'bar2')
         #
-        #   ### correct
+        #   # good
         #   plain_text_data = data_bag_item('foo', 'bar')
         #   encrypted_data = data_bag_item('foo2', 'bar2')
         #

data/lib/rubocop/cop/chef/modernize/declare_action_class.rb CHANGED Viewed

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   declare_action_class do
         #     foo
         #   end
         #
-        #   ### correct
+        #   # good
         #   action_class do
         #     foo
         #   end

data/lib/rubocop/cop/chef/modernize/default_action_initializer.rb CHANGED Viewed

@@ -23,21 +23,21 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   def initialize(*args)
         #     super
         #     @action = :create
         #   end
         #
-        #   ### incorrect
+        #   # bad
         #   def initialize(*args)
         #     super
         #     @default_action = :create
         #   end
         #
-        #  ### correct
-        #  default_action :create
+        #   # good
+        #   default_action :create
+        #
         class DefaultActionFromInitialize < Base
           extend AutoCorrector
           include RangeHelp

data/lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   if defined?(ChefSpec)
         #     def create_yum_repository(resource_name)
         #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)

data/lib/rubocop/cop/chef/modernize/depends_chef_vault_cookbook.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'chef-vault'
         #
         class DependsOnChefVaultCookbook < Base

data/lib/rubocop/cop/chef/modernize/depends_chocolatey_cookbooks.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'chocolatey_source'
         #   depends 'chocolatey_config'
         #

data/lib/rubocop/cop/chef/modernize/depends_kernel_module_cookbook.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'kernel_module'
         #
         class DependsOnKernelModuleCookbook < Base

data/lib/rubocop/cop/chef/modernize/depends_locale_cookbook.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'locale'
         #
         class DependsOnLocaleCookbook < Base

data/lib/rubocop/cop/chef/modernize/depends_openssl_cookbook.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'openssl'
         #
         class DependsOnOpensslCookbook < Base

data/lib/rubocop/cop/chef/modernize/depends_timezone_lwrp_cookbook.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'timezone_lwrp'
         #
         class DependsOnTimezoneLwrpCookbook < Base

data/lib/rubocop/cop/chef/modernize/depends_windows_firewall_cookbook.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'windows_firewall'
         #
         class DependsOnWindowsFirewallCookbook < Base

data/lib/rubocop/cop/chef/modernize/depends_zypper_cookbook.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'zypper'
         #
         class DependsOnZypperCookbook < Base

data/lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb CHANGED Viewed

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.
+        # Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classes by default so there is no need to include this DSL in your resources or providers.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include Chef::DSL::Recipe
         #   include Chef::DSL::IncludeRecipe
         #
@@ -31,7 +31,7 @@ module RuboCop
           extend AutoCorrector
           include RangeHelp
-          MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.'
+          MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classes by default so there is no need to include this DSL in your resources or providers.'
           RESTRICT_ON_SEND = [:include].freeze
           def_node_matcher :dsl_include?, <<-PATTERN

data/lib/rubocop/cop/chef/modernize/empty_resource_initialize.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   def initialize(*args)
         #     super
         #   end

data/lib/rubocop/cop/chef/modernize/execute_apt_update.rb CHANGED Viewed

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Instead of using the execute resource 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.
+        # Instead of using the execute resource to run the `apt-get update` use Chef Infra Client's built-in apt_update resource which is available in Chef Infra Client 12.7 and later.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   execute 'apt-get update'
         #
         #   execute 'Apt all the apt cache' do
@@ -34,7 +34,7 @@ module RuboCop
         #     notifies :run, 'execute[apt-get update]', :immediately
         #   end
         #
-        #   ### correct
+        #   # good
         #   apt_update
         #
         #   apt_update 'update apt cache'

data/lib/rubocop/cop/chef/modernize/execute_sc_exe.rb CHANGED Viewed

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   execute "Delete chef-client service" do
         #     command "sc.exe delete chef-client"
         #     action :run
         #   end
         #
-        #   ### correct
+        #   # good
         #   windows_service 'chef-client' do
         #     action :delete
         #   end

data/lib/rubocop/cop/chef/modernize/execute_sleep.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   execute "sleep 60" do
         #     command "sleep 60"
         #     action :run
@@ -35,7 +35,7 @@ module RuboCop
         #     code 'sleep 60'
         #   end
         #
-        #   ### correct
+        #   # good
         #   chef_sleep '60'
         #
         class ExecuteSleep < Base

data/lib/rubocop/cop/chef/modernize/execute_sysctl.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   file '/etc/sysctl.d/ipv4.conf' do
         #     notifies :run, 'execute[sysctl -p /etc/sysctl.d/ipv4.conf]', :immediately
         #     content '9000 65500'
@@ -33,7 +33,7 @@ module RuboCop
         #     action :nothing
         #   end
         #
-        #   ### correct
+        #   # good
         #   sysctl 'net.ipv4.ip_local_port_range' do
         #     value '9000 65500'
         #   end

data/lib/rubocop/cop/chef/modernize/execute_tzutil.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   execute 'set tz' do
         #     command 'tzutil.exe /s UTC'
         #   end
@@ -35,7 +35,7 @@ module RuboCop
         #     not_if { shell_out('tzutil.exe /g').stdout.include?('UTC') }
         #   end
         #
-        #   ### correct
+        #   # good
         #   timezone 'UTC'
         #
         class ExecuteTzUtil < Base

data/lib/rubocop/cop/chef/modernize/foodcritic_comments.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   # ~FC013
         #
         class FoodcriticComments < Base

data/lib/rubocop/cop/chef/modernize/if_provides_default_action.rb CHANGED Viewed

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   default_action :foo if defined?(default_action)
         #
-        #   ### correct
+        #   # good
         #   default_action :foo
         #
         class IfProvidesDefaultAction < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   require 'chef/mixin/shell_out'
         #   include Chef::Mixin::ShellOut
         #   require 'chef/mixin/powershell_out'