cookstyle 7.5.2 → 7.8.3

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 (226) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/bin/cookstyle +7 -2
  4. data/config/cookstyle.yml +240 -231
  5. data/config/disable_all.yml +22 -0
  6. data/config/upstream.yml +137 -31
  7. data/lib/cookstyle/version.rb +2 -2
  8. data/lib/rubocop/cop/chef/correctness/block_guard_clause_string_only.rb +4 -4
  9. data/lib/rubocop/cop/chef/correctness/chef_application_fatal.rb +2 -2
  10. data/lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb +2 -2
  11. data/lib/rubocop/cop/chef/correctness/dnf_package_allow_downgrades.rb +2 -2
  12. data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb +2 -2
  13. data/lib/rubocop/cop/chef/correctness/invalid_default_action.rb +2 -2
  14. data/lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb +2 -2
  15. data/lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb +2 -2
  16. data/lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb +1 -1
  17. data/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb +2 -2
  18. data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb +2 -2
  19. data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb +1 -1
  20. data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb +2 -2
  21. data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb +2 -2
  22. data/lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb +2 -2
  23. data/lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb +2 -2
  24. data/lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb +2 -2
  25. data/lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb +2 -2
  26. data/lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb +2 -2
  27. data/lib/rubocop/cop/chef/correctness/metadata_missing_name.rb +1 -1
  28. data/lib/rubocop/cop/chef/correctness/node_normal.rb +2 -2
  29. data/lib/rubocop/cop/chef/correctness/node_normal_unless.rb +2 -2
  30. data/lib/rubocop/cop/chef/correctness/node_save.rb +1 -1
  31. data/lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb +2 -2
  32. data/lib/rubocop/cop/chef/correctness/octal_mode_as_string.rb +2 -2
  33. data/lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb +1 -1
  34. data/lib/rubocop/cop/chef/correctness/powershell_delete_file.rb +2 -2
  35. data/lib/rubocop/cop/chef/correctness/property_without_type.rb +2 -2
  36. data/lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb +2 -2
  37. data/lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb +3 -4
  38. data/lib/rubocop/cop/chef/correctness/resource_with_none_action.rb +2 -2
  39. data/lib/rubocop/cop/chef/correctness/scoped_file_exist.rb +2 -2
  40. data/lib/rubocop/cop/chef/correctness/service_resource.rb +1 -1
  41. data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb +2 -2
  42. data/lib/rubocop/cop/chef/correctness/tmp_path.rb +2 -3
  43. data/lib/rubocop/cop/chef/deprecation/ use_automatic_resource_name.rb +1 -1
  44. data/lib/rubocop/cop/chef/deprecation/cb_depends_on_self.rb +2 -2
  45. data/lib/rubocop/cop/chef/deprecation/chef_handler_recipe.rb +1 -1
  46. data/lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb +2 -2
  47. data/lib/rubocop/cop/chef/deprecation/chef_rest.rb +1 -1
  48. data/lib/rubocop/cop/chef/deprecation/chef_shellout.rb +2 -2
  49. data/lib/rubocop/cop/chef/deprecation/chef_sugar_helpers.rb +1 -1
  50. data/lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb +2 -2
  51. data/lib/rubocop/cop/chef/deprecation/chefdk_generators.rb +2 -2
  52. data/lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb +1 -1
  53. data/lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb +2 -2
  54. data/lib/rubocop/cop/chef/deprecation/chocolatey_package_uninstall_action.rb +2 -2
  55. data/lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb +1 -1
  56. data/lib/rubocop/cop/chef/deprecation/depends_partial_search.rb +1 -1
  57. data/lib/rubocop/cop/chef/deprecation/depends_poise.rb +1 -1
  58. data/lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb +3 -3
  59. data/lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb +1 -1
  60. data/lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb +2 -2
  61. data/lib/rubocop/cop/chef/deprecation/deprecated_shellout_methods.rb +2 -2
  62. data/lib/rubocop/cop/chef/deprecation/deprecated_windows_version_check.rb +1 -1
  63. data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_actions.rb +2 -2
  64. data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb +2 -2
  65. data/lib/rubocop/cop/chef/deprecation/easy_install.rb +1 -1
  66. data/lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb +1 -1
  67. data/lib/rubocop/cop/chef/deprecation/epic_fail.rb +2 -2
  68. data/lib/rubocop/cop/chef/deprecation/erl_call.rb +1 -1
  69. data/lib/rubocop/cop/chef/deprecation/execute_path_property.rb +2 -2
  70. data/lib/rubocop/cop/chef/deprecation/execute_relative_creates_without_cwd.rb +2 -2
  71. data/lib/rubocop/cop/chef/deprecation/foodcritic_testing.rb +1 -1
  72. data/lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb +4 -4
  73. data/lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb +2 -2
  74. data/lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb +2 -2
  75. data/lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb +3 -3
  76. data/lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb +1 -1
  77. data/lib/rubocop/cop/chef/deprecation/librarian_chefspec.rb +1 -1
  78. data/lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb +1 -1
  79. data/lib/rubocop/cop/chef/deprecation/log_resource_notifications.rb +2 -2
  80. data/lib/rubocop/cop/chef/deprecation/macos_userdefaults_global_property.rb +2 -2
  81. data/lib/rubocop/cop/chef/deprecation/name_property_and_default.rb +2 -2
  82. data/lib/rubocop/cop/chef/deprecation/node_deep_fetch.rb +4 -4
  83. data/lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb +2 -2
  84. data/lib/rubocop/cop/chef/deprecation/node_set.rb +2 -2
  85. data/lib/rubocop/cop/chef/deprecation/node_set_unless.rb +2 -2
  86. data/lib/rubocop/cop/chef/deprecation/node_set_without_level.rb +2 -2
  87. data/lib/rubocop/cop/chef/deprecation/partial_search_class_usage.rb +2 -2
  88. data/lib/rubocop/cop/chef/deprecation/partial_search_helper_usage.rb +2 -2
  89. data/lib/rubocop/cop/chef/deprecation/poise_archive.rb +2 -2
  90. data/lib/rubocop/cop/chef/deprecation/powershell_cookbook_helpers.rb +2 -2
  91. data/lib/rubocop/cop/chef/deprecation/require_recipe.rb +2 -2
  92. data/lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb +2 -2
  93. data/lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.rb +2 -2
  94. data/lib/rubocop/cop/chef/deprecation/resource_uses_only_resource_name.rb +1 -1
  95. data/lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb +1 -1
  96. data/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb +3 -3
  97. data/lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb +2 -2
  98. data/lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb +2 -2
  99. data/lib/rubocop/cop/chef/deprecation/run_command_helper.rb +2 -2
  100. data/lib/rubocop/cop/chef/deprecation/search_uses_positional_parameters.rb +2 -2
  101. data/lib/rubocop/cop/chef/deprecation/use_inline_resources.rb +1 -1
  102. data/lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb +2 -2
  103. data/lib/rubocop/cop/chef/deprecation/user_supports_property.rb +2 -2
  104. data/lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.rb +2 -2
  105. data/lib/rubocop/cop/chef/deprecation/windows_feature_servermanagercmd.rb +2 -2
  106. data/lib/rubocop/cop/chef/deprecation/windows_package_installer_type_string.rb +2 -2
  107. data/lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb +2 -2
  108. data/lib/rubocop/cop/chef/deprecation/windows_version_helpers.rb +2 -2
  109. data/lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb +1 -1
  110. data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb +1 -1
  111. data/lib/rubocop/cop/chef/effortless/chef_vault_used.rb +6 -6
  112. data/lib/rubocop/cop/chef/effortless/data_bags.rb +1 -1
  113. data/lib/rubocop/cop/chef/effortless/depends_chef_vault.rb +1 -1
  114. data/lib/rubocop/cop/chef/effortless/node_environment.rb +1 -1
  115. data/lib/rubocop/cop/chef/effortless/node_policygroup.rb +1 -1
  116. data/lib/rubocop/cop/chef/effortless/node_roles.rb +1 -1
  117. data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb +1 -1
  118. data/lib/rubocop/cop/chef/effortless/search_used.rb +1 -1
  119. data/lib/rubocop/cop/chef/modernize/action_method_in_resource.rb +2 -2
  120. data/lib/rubocop/cop/chef/modernize/allowed_actions_initializer.rb +2 -2
  121. data/lib/rubocop/cop/chef/modernize/apt_default_recipe.rb +2 -2
  122. data/lib/rubocop/cop/chef/modernize/berksfile_source.rb +3 -5
  123. data/lib/rubocop/cop/chef/modernize/build_essential.rb +2 -2
  124. data/lib/rubocop/cop/chef/modernize/chef_14_resources.rb +1 -1
  125. data/lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb +1 -1
  126. data/lib/rubocop/cop/chef/modernize/compile_time_resources.rb +2 -2
  127. data/lib/rubocop/cop/chef/modernize/conditional_using_test.rb +2 -2
  128. data/lib/rubocop/cop/chef/modernize/cron_d_file_or_template.rb +2 -2
  129. data/lib/rubocop/cop/chef/modernize/cron_manage_resource.rb +5 -5
  130. data/lib/rubocop/cop/chef/modernize/databag_helpers.rb +2 -2
  131. data/lib/rubocop/cop/chef/modernize/default_action_initializer.rb +3 -3
  132. data/lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb +1 -1
  133. data/lib/rubocop/cop/chef/modernize/depends_zypper_cookbook.rb +1 -1
  134. data/lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb +3 -1
  135. data/lib/rubocop/cop/chef/modernize/empty_resource_initialize.rb +1 -1
  136. data/lib/rubocop/cop/chef/modernize/execute_apt_update.rb +5 -4
  137. data/lib/rubocop/cop/chef/modernize/execute_sc_exe.rb +6 -4
  138. data/lib/rubocop/cop/chef/modernize/execute_sleep.rb +4 -2
  139. data/lib/rubocop/cop/chef/modernize/execute_sysctl.rb +4 -2
  140. data/lib/rubocop/cop/chef/modernize/execute_tzutil.rb +5 -4
  141. data/lib/rubocop/cop/chef/modernize/foodcritic_comments.rb +1 -1
  142. data/lib/rubocop/cop/chef/modernize/if_provides_default_action.rb +2 -2
  143. data/lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb +1 -1
  144. data/lib/rubocop/cop/chef/modernize/libarchive_file.rb +2 -2
  145. data/lib/rubocop/cop/chef/modernize/macos_user_defaults.rb +5 -4
  146. data/lib/rubocop/cop/chef/modernize/minitest_handler_usage.rb +1 -1
  147. data/lib/rubocop/cop/chef/modernize/node_init_package.rb +2 -2
  148. data/lib/rubocop/cop/chef/modernize/node_roles_include.rb +2 -2
  149. data/lib/rubocop/cop/chef/modernize/ohai_default_recipe.rb +2 -4
  150. data/lib/rubocop/cop/chef/modernize/openssl_rsa_key_resource.rb +5 -4
  151. data/lib/rubocop/cop/chef/modernize/openssl_x509_resource.rb +5 -4
  152. data/lib/rubocop/cop/chef/modernize/osx_config_profile_resource.rb +5 -4
  153. data/lib/rubocop/cop/chef/modernize/powershell_expand_archive.rb +2 -3
  154. data/lib/rubocop/cop/chef/modernize/powershell_guard_interpreter.rb +2 -2
  155. data/lib/rubocop/cop/chef/modernize/powershell_install_package.rb +3 -4
  156. data/lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.rb +3 -4
  157. data/lib/rubocop/cop/chef/modernize/property_with_name_attribute.rb +2 -2
  158. data/lib/rubocop/cop/chef/modernize/provides_initializer.rb +2 -2
  159. data/lib/rubocop/cop/chef/modernize/resource_name_initializer.rb +2 -2
  160. data/lib/rubocop/cop/chef/modernize/resource_set_or_return.rb +3 -5
  161. data/lib/rubocop/cop/chef/modernize/resource_with_attributes.rb +3 -5
  162. data/lib/rubocop/cop/chef/modernize/respond_to_compile_time.rb +4 -2
  163. data/lib/rubocop/cop/chef/modernize/respond_to_metadata.rb +3 -4
  164. data/lib/rubocop/cop/chef/modernize/respond_to_provides.rb +2 -2
  165. data/lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb +2 -2
  166. data/lib/rubocop/cop/chef/modernize/sc_windows_resource.rb +6 -4
  167. data/lib/rubocop/cop/chef/modernize/seven_zip_archive.rb +1 -1
  168. data/lib/rubocop/cop/chef/modernize/shell_out_helper.rb +2 -2
  169. data/lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.rb +1 -1
  170. data/lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb +2 -2
  171. data/lib/rubocop/cop/chef/modernize/sysctl_param_resource.rb +4 -2
  172. data/lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb +1 -1
  173. data/lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb +2 -2
  174. data/lib/rubocop/cop/chef/modernize/use_require_relative.rb +2 -2
  175. data/lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb +1 -1
  176. data/lib/rubocop/cop/chef/modernize/windows_default_recipe.rb +1 -1
  177. data/lib/rubocop/cop/chef/modernize/windows_registry_uac.rb +4 -2
  178. data/lib/rubocop/cop/chef/modernize/windows_zipfile.rb +1 -1
  179. data/lib/rubocop/cop/chef/modernize/zipfile_resource.rb +1 -1
  180. data/lib/rubocop/cop/chef/modernize/zypper_repo.rb +2 -2
  181. data/lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb +4 -2
  182. data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb +4 -2
  183. data/lib/rubocop/cop/chef/redundant/attribute_metadata.rb +1 -1
  184. data/lib/rubocop/cop/chef/redundant/conflicts_metadata.rb +1 -1
  185. data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb +1 -1
  186. data/lib/rubocop/cop/chef/redundant/double_compile_time.rb +4 -2
  187. data/lib/rubocop/cop/chef/redundant/grouping_metadata.rb +1 -1
  188. data/lib/rubocop/cop/chef/redundant/long_description_metadata.rb +1 -1
  189. data/lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb +2 -2
  190. data/lib/rubocop/cop/chef/redundant/name_property_and_required.rb +2 -3
  191. data/lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb +2 -2
  192. data/lib/rubocop/cop/chef/redundant/property_splat_regex.rb +2 -2
  193. data/lib/rubocop/cop/chef/redundant/property_with_default_and_required.rb +2 -2
  194. data/lib/rubocop/cop/chef/redundant/provides_metadata.rb +1 -1
  195. data/lib/rubocop/cop/chef/redundant/recipe_metadata.rb +1 -1
  196. data/lib/rubocop/cop/chef/redundant/replaces_metadata.rb +1 -1
  197. data/lib/rubocop/cop/chef/redundant/resource_with_nothing_action.rb +1 -1
  198. data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb +3 -1
  199. data/lib/rubocop/cop/chef/redundant/string_property_with_nil_default.rb +2 -2
  200. data/lib/rubocop/cop/chef/redundant/suggests_metadata.rb +1 -1
  201. data/lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb +2 -2
  202. data/lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb +1 -1
  203. data/lib/rubocop/cop/chef/redundant/use_create_if_missing.rb +2 -2
  204. data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb +2 -2
  205. data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb +2 -2
  206. data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb +2 -2
  207. data/lib/rubocop/cop/chef/sharing/include_resource_descriptions.rb +1 -1
  208. data/lib/rubocop/cop/chef/sharing/include_resource_examples.rb +1 -1
  209. data/lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb +2 -2
  210. data/lib/rubocop/cop/chef/sharing/invalid_license_string.rb +57 -3
  211. data/lib/rubocop/cop/chef/style/attribute_keys.rb +4 -4
  212. data/lib/rubocop/cop/chef/style/chef_whaaat.rb +2 -2
  213. data/lib/rubocop/cop/chef/style/comments_copyright_format.rb +9 -9
  214. data/lib/rubocop/cop/chef/style/comments_default_copyright.rb +2 -2
  215. data/lib/rubocop/cop/chef/style/comments_format.rb +2 -2
  216. data/lib/rubocop/cop/chef/style/file_mode.rb +2 -2
  217. data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb +2 -2
  218. data/lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb +2 -2
  219. data/lib/rubocop/cop/chef/style/negating_only_if.rb +2 -2
  220. data/lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb +2 -2
  221. data/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb +2 -2
  222. data/lib/rubocop/cop/chef/style/true_false_resource_properties.rb +2 -2
  223. data/lib/rubocop/cop/chef/style/unnecessary_os_check.rb +2 -2
  224. data/lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb +2 -2
  225. data/lib/rubocop/cop/chef/style/use_platform_helpers.rb +2 -2
  226. metadata +5 -5
@@ -23,7 +23,7 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # gem 'foodcritic'
28
28
  # require 'foodcritic'
29
29
  #
@@ -24,7 +24,7 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # class Chef
29
29
  # class Resource
30
30
  # class UlimitRule < Chef::Resource
@@ -36,7 +36,7 @@ module RuboCop
36
36
  # end
37
37
  # end
38
38
  #
39
- # # bad
39
+ # #### incorrect
40
40
  # class Chef
41
41
  # class Resource
42
42
  # class UlimitRule < Chef::Resource
@@ -50,7 +50,7 @@ module RuboCop
50
50
  # end
51
51
  # end
52
52
  #
53
- # # good when Chef Infra Client < 15 (but compatible with 16+ as well)
53
+ # #### correct when Chef Infra Client < 15 (but compatible with 16+ as well)
54
54
  # class Chef
55
55
  # class Resource
56
56
  # class UlimitRule < Chef::Resource
@@ -65,7 +65,7 @@ module RuboCop
65
65
  # end
66
66
  # end
67
67
  #
68
- # # good when Chef Infra Client 16+
68
+ # #### correct when Chef Infra Client 16+
69
69
  # class Chef
70
70
  # class Resource
71
71
  # class UlimitRule < Chef::Resource
@@ -24,12 +24,12 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # class AptUpdate < ChefCompat::Resource
29
29
  # # some resource code
30
30
  # end
31
31
  #
32
- # # good
32
+ # #### correct
33
33
  # class AptUpdate < Chef::Resource
34
34
  # # some resource code
35
35
  # end
@@ -23,12 +23,12 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # launchd 'foo' do
28
28
  # hash foo: 'bar'
29
29
  # end
30
30
  #
31
- # # good
31
+ # #### correct
32
32
  # launchd 'foo' do
33
33
  # plist_hash foo: 'bar'
34
34
  # end
@@ -23,7 +23,7 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # template '/etc/www/configures-apache.conf' do
28
28
  # notifies :restart, resources(service: 'apache')
29
29
  # end
@@ -40,7 +40,7 @@ module RuboCop
40
40
  # subscribes :restart, resources(service: service_name_variable), :immediately
41
41
  # end
42
42
  #
43
- # # good
43
+ # #### correct
44
44
  # template '/etc/www/configures-apache.conf' do
45
45
  # notifies :restart, 'service[apache]'
46
46
  # end
@@ -74,7 +74,7 @@ module RuboCop
74
74
  when :str
75
75
  "'#{type.source}[#{name.value}]'"
76
76
  when :dstr
77
- "\"#{type.source}[#{name.value.source}]\""
77
+ "\"#{type.source}[#{name.value}]\""
78
78
  else
79
79
  "\"#{type.source}[\#{#{name.source}}]\""
80
80
  end
@@ -25,7 +25,7 @@ module RuboCop
25
25
  #
26
26
  # @example
27
27
  #
28
- # # bad
28
+ # #### incorrect
29
29
  # include_recipe 'yum::elrepo'
30
30
  # include_recipe 'yum::epel'
31
31
  # include_recipe 'yum::ius'
@@ -23,7 +23,7 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # require 'chefspec/librarian'
28
28
  #
29
29
  class LibrarianChefSpec < Base
@@ -23,7 +23,7 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # locale 'set locale' do
28
28
  # lang 'en_gb.utf-8'
29
29
  # lc_all 'en_gb.utf-8'
@@ -24,7 +24,7 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # template '/etc/foo' do
29
29
  # source 'bar.erb'
30
30
  # notifies :write, 'log[Aggregate notifications using a single log resource]', :immediately
@@ -34,7 +34,7 @@ module RuboCop
34
34
  # notifies :restart, 'service[foo]', :delayed
35
35
  # end
36
36
  #
37
- # # good
37
+ # #### correct
38
38
  # template '/etc/foo' do
39
39
  # source 'bar.erb'
40
40
  # notifies :run, 'notify_group[Aggregate notifications using a single notify_group resource]', :immediately
@@ -24,14 +24,14 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # macos_userdefaults 'set a value' do
29
29
  # global true
30
30
  # key 'key'
31
31
  # value 'value'
32
32
  # end
33
33
  #
34
- # # good
34
+ # #### correct
35
35
  # macos_userdefaults 'set a value' do
36
36
  # key 'key'
37
37
  # value 'value'
@@ -23,11 +23,11 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # property :config_file, String, default: 'foo', name_property: true
28
28
  # attribute :config_file, String, default: 'foo', name_attribute: true
29
29
  #
30
- # # good
30
+ # #### correct
31
31
  # property :config_file, String, name_property: true
32
32
  # attribute :config_file, String, name_attribute: true
33
33
  #
@@ -22,16 +22,16 @@ module RuboCop
22
22
  #
23
23
  # @example
24
24
  #
25
- # # bad
25
+ # #### incorrect
26
26
  # node.deep_fetch("foo")
27
27
  #
28
- # # good
28
+ # #### correct
29
29
  # node.read("foo")
30
30
  #
31
- # # bad
31
+ # #### incorrect
32
32
  # node.deep_fetch!("foo")
33
33
  #
34
- # # good
34
+ # #### correct
35
35
  # node.read!("foo")
36
36
  #
37
37
  class NodeDeepFetch < Base
@@ -23,14 +23,14 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # node.fqdn
28
28
  # node.platform
29
29
  # node.platform_family
30
30
  # node.platform_version
31
31
  # node.hostname
32
32
  #
33
- # # good
33
+ # #### correct
34
34
  # node['fqdn']
35
35
  # node['platform']
36
36
  # node['platform_family']
@@ -24,10 +24,10 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # node.set['foo'] = true
29
29
  #
30
- # # good
30
+ # #### correct
31
31
  # node.normal['foo'] = true
32
32
  #
33
33
  class NodeSet < Base
@@ -24,10 +24,10 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # node.set_unless['foo'] = true
29
29
  #
30
- # # good
30
+ # #### correct
31
31
  # node.normal_unless['foo'] = true
32
32
  #
33
33
  class NodeSetUnless < Base
@@ -22,13 +22,13 @@ module RuboCop
22
22
  #
23
23
  # @example
24
24
  #
25
- # # bad
25
+ # #### incorrect
26
26
  # node['foo']['bar'] = 1
27
27
  # node['foo']['bar'] << 1
28
28
  # node['foo']['bar'] += 1
29
29
  # node['foo']['bar'] -= 1
30
30
  #
31
- # # good
31
+ # #### correct
32
32
  # node.default['foo']['bar'] = 1
33
33
  # node.default['foo']['bar'] << 1
34
34
  # node.default['foo']['bar'] += 1
@@ -23,7 +23,7 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # ::Chef::PartialSearch.new.search((:node, 'role:web',
28
28
  # keys: { 'name' => [ 'name' ],
29
29
  # 'ip' => [ 'ipaddress' ],
@@ -35,7 +35,7 @@ module RuboCop
35
35
  # puts result['kernel_version']
36
36
  # end
37
37
  #
38
- # # good
38
+ # #### correct
39
39
  # search(:node, 'role:web',
40
40
  # filter_result: { 'name' => [ 'name' ],
41
41
  # 'ip' => [ 'ipaddress' ],
@@ -23,7 +23,7 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # partial_search(:node, 'role:web',
28
28
  # keys: { 'name' => [ 'name' ],
29
29
  # 'ip' => [ 'ipaddress' ],
@@ -35,7 +35,7 @@ module RuboCop
35
35
  # puts result['kernel_version']
36
36
  # end
37
37
  #
38
- # # good
38
+ # #### correct
39
39
  # search(:node, 'role:web',
40
40
  # filter_result: { 'name' => [ 'name' ],
41
41
  # 'ip' => [ 'ipaddress' ],
@@ -23,12 +23,12 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # poise_archive 'https://example.com/myapp.tgz' do
28
28
  # destination '/opt/my_app'
29
29
  # end
30
30
  #
31
- # # good
31
+ # #### correct
32
32
  # archive_file 'https://example.com/myapp.tgz' do
33
33
  # destination '/opt/my_app'
34
34
  # end
@@ -23,10 +23,10 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # Powershell::VersionHelper.powershell_version?('4.0')
28
28
  #
29
- # # good
29
+ # #### correct
30
30
  # node['powershell']['version'].to_f == 4.0
31
31
  #
32
32
  # # better (Chef Infra Client 15.8+)
@@ -24,10 +24,10 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # require_recipe 'foo'
29
29
  #
30
- # # good
30
+ # #### correct
31
31
  # include_recipe 'foo'
32
32
  #
33
33
  class RequireRecipe < Base
@@ -23,12 +23,12 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # def provides?
28
28
  # true
29
29
  # end
30
30
  #
31
- # # good
31
+ # #### correct
32
32
  # provides :SOME_PROVIDER_NAME
33
33
  #
34
34
  class ResourceOverridesProvidesMethod < Base
@@ -23,10 +23,10 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # my_resource = MyResource.dsl_name
28
28
  #
29
- # # good
29
+ # #### correct
30
30
  # my_resource = MyResource.resource_name
31
31
  #
32
32
  class ResourceUsesDslNameMethod < Base
@@ -23,7 +23,7 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # mycookbook/resources/myresource.rb:
28
28
  # resource_name :mycookbook_myresource
29
29
  #
@@ -23,7 +23,7 @@ module RuboCop
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # provider_base ::Chef::Provider::SomethingSomething
28
28
  #
29
29
  class ResourceUsesProviderBaseMethod < Base
@@ -19,16 +19,16 @@ module RuboCop
19
19
  module Cop
20
20
  module Chef
21
21
  module Deprecations
22
- # Don't call the deprecated updated= method in a resource to set the resource to updated. This method was removed from Chef Infra Client 13 and this will now cause an error. Instead wrap code that updated the state of the node in a converge_by block. Documentation on using the converge_by block can be found at https://docs.chef.io/custom_resources.html.
22
+ # Don't call the deprecated `updated=` method in a resource to set the resource to updated. This method was removed from Chef Infra Client 13 and this will now cause an error. Instead wrap code that updated the state of the node in a `converge_by` block. Documentation on using the `converge_by` block can be found at https://docs.chef.io/custom_resources/.
23
23
  #
24
24
  # @example
25
25
  #
26
- # # bad
26
+ # #### incorrect
27
27
  # action :foo do
28
28
  # updated = true
29
29
  # end
30
30
  #
31
- # # good
31
+ # #### correct
32
32
  # action :foo do
33
33
  # converge_by('resource did something) do
34
34
  # # code that causes the resource to converge
@@ -24,11 +24,11 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # shell_out!('hostnamectl status', { returns: [0, 1] })
29
29
  # shell_out('hostnamectl status', { returns: [0, 1] })
30
30
  #
31
- # # good
31
+ # #### correct
32
32
  # shell_out!('hostnamectl status', returns: [0, 1])
33
33
  # shell_out('hostnamectl status', returns: [0, 1])
34
34
  #
@@ -24,7 +24,7 @@ module RuboCop
24
24
  #
25
25
  # @example
26
26
  #
27
- # # bad
27
+ # #### incorrect
28
28
  # ruby_block 'my special ruby block' do
29
29
  # block do
30
30
  # puts 'running'
@@ -32,7 +32,7 @@ module RuboCop
32
32
  # action :create
33
33
  # end
34
34
  #
35
- # # good
35
+ # #### correct
36
36
  # ruby_block 'my special ruby block' do
37
37
  # block do
38
38
  # puts 'running'