cookstyle 8.7.6 → 9.0.9

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 (272) hide show
  1. checksums.yaml +4 -4
  2. data/config/chefstyle.yml +14 -0
  3. data/config/cookstyle.yml +157 -6
  4. data/lib/cookstyle/version.rb +2 -2
  5. data/lib/cookstyle.rb +5 -6
  6. data/lib/rubocop/chef/autocorrect_helpers.rb +1 -1
  7. data/lib/rubocop/chef/cookbook_helpers.rb +24 -1
  8. data/lib/rubocop/chef/platform_helpers.rb +1 -1
  9. data/lib/rubocop/chef.rb +1 -1
  10. data/lib/rubocop/cop/chef/correctness/block_guard_clause_string_only.rb +1 -1
  11. data/lib/rubocop/cop/chef/correctness/chef_application_fatal.rb +17 -5
  12. data/lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb +1 -1
  13. data/lib/rubocop/cop/chef/correctness/conditional_unified_mode_true.rb +91 -0
  14. data/lib/rubocop/cop/chef/correctness/dnf_package_allow_downgrades.rb +1 -1
  15. data/lib/rubocop/cop/chef/correctness/empty_resource_guard.rb +18 -2
  16. data/lib/rubocop/cop/chef/correctness/execute_delete_file.rb +127 -0
  17. data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb +1 -1
  18. data/lib/rubocop/cop/chef/correctness/invalid_checksum.rb +79 -0
  19. data/lib/rubocop/cop/chef/correctness/invalid_cookbook_name.rb +1 -1
  20. data/lib/rubocop/cop/chef/correctness/invalid_default_action.rb +1 -1
  21. data/lib/rubocop/cop/chef/correctness/invalid_notification_resource.rb +1 -1
  22. data/lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb +1 -1
  23. data/lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb +2 -2
  24. data/lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb +11 -1
  25. data/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb +1 -1
  26. data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb +1 -1
  27. data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb +11 -1
  28. data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb +1 -1
  29. data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb +2 -1
  30. data/lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb +1 -1
  31. data/lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb +1 -1
  32. data/lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb +1 -1
  33. data/lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb +1 -1
  34. data/lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb +1 -1
  35. data/lib/rubocop/cop/chef/correctness/metadata_malformed_version.rb +1 -1
  36. data/lib/rubocop/cop/chef/correctness/metadata_missing_name.rb +1 -1
  37. data/lib/rubocop/cop/chef/correctness/metadata_missing_version.rb +1 -1
  38. data/lib/rubocop/cop/chef/correctness/node_save.rb +1 -1
  39. data/lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb +1 -1
  40. data/lib/rubocop/cop/chef/correctness/octal_mode_as_string.rb +1 -1
  41. data/lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb +1 -1
  42. data/lib/rubocop/cop/chef/correctness/platform_version_string_comparison.rb +66 -0
  43. data/lib/rubocop/cop/chef/correctness/powershell_delete_file.rb +6 -6
  44. data/lib/rubocop/cop/chef/correctness/powershell_file_exists.rb +2 -2
  45. data/lib/rubocop/cop/chef/correctness/property_without_type.rb +1 -1
  46. data/lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb +1 -1
  47. data/lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb +1 -1
  48. data/lib/rubocop/cop/chef/correctness/resource_with_none_action.rb +4 -4
  49. data/lib/rubocop/cop/chef/correctness/ruby_guard_without_block.rb +91 -0
  50. data/lib/rubocop/cop/chef/correctness/scoped_file_exist.rb +1 -1
  51. data/lib/rubocop/cop/chef/correctness/service_resource.rb +71 -20
  52. data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb +1 -1
  53. data/lib/rubocop/cop/chef/deprecation/cb_depends_on_self.rb +1 -1
  54. data/lib/rubocop/cop/chef/deprecation/chef_handler_recipe.rb +9 -2
  55. data/lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb +1 -1
  56. data/lib/rubocop/cop/chef/deprecation/chef_rest.rb +5 -2
  57. data/lib/rubocop/cop/chef/deprecation/chef_rewind.rb +1 -1
  58. data/lib/rubocop/cop/chef/deprecation/chef_shellout.rb +3 -3
  59. data/lib/rubocop/cop/chef/deprecation/chef_sugar_helpers.rb +7 -1
  60. data/lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb +2 -2
  61. data/lib/rubocop/cop/chef/deprecation/chefdk_generators.rb +1 -1
  62. data/lib/rubocop/cop/chef/deprecation/cheffile.rb +1 -1
  63. data/lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb +1 -1
  64. data/lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb +1 -1
  65. data/lib/rubocop/cop/chef/deprecation/chocolatey_package_uninstall_action.rb +4 -4
  66. data/lib/rubocop/cop/chef/deprecation/delivery.rb +1 -1
  67. data/lib/rubocop/cop/chef/deprecation/depends_chef_nginx_cookbook.rb +1 -1
  68. data/lib/rubocop/cop/chef/deprecation/depends_chef_reporting_cookbook.rb +1 -1
  69. data/lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb +1 -1
  70. data/lib/rubocop/cop/chef/deprecation/depends_omnibus_updater_cookbook.rb +1 -1
  71. data/lib/rubocop/cop/chef/deprecation/depends_partial_search.rb +5 -1
  72. data/lib/rubocop/cop/chef/deprecation/depends_poise.rb +1 -1
  73. data/lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb +1 -1
  74. data/lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb +3 -3
  75. data/lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb +1 -1
  76. data/lib/rubocop/cop/chef/deprecation/deprecated_shellout_methods.rb +1 -1
  77. data/lib/rubocop/cop/chef/deprecation/deprecated_sudo_actions.rb +1 -1
  78. data/lib/rubocop/cop/chef/deprecation/deprecated_windows_version_check.rb +1 -1
  79. data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_actions.rb +1 -1
  80. data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb +1 -1
  81. data/lib/rubocop/cop/chef/deprecation/easy_install.rb +1 -1
  82. data/lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb +1 -1
  83. data/lib/rubocop/cop/chef/deprecation/epic_fail.rb +1 -1
  84. data/lib/rubocop/cop/chef/deprecation/erl_call.rb +1 -1
  85. data/lib/rubocop/cop/chef/deprecation/execute_path_property.rb +1 -1
  86. data/lib/rubocop/cop/chef/deprecation/execute_relative_creates_without_cwd.rb +1 -1
  87. data/lib/rubocop/cop/chef/deprecation/foodcritic_file.rb +1 -1
  88. data/lib/rubocop/cop/chef/deprecation/foodcritic_testing.rb +1 -1
  89. data/lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb +5 -5
  90. data/lib/rubocop/cop/chef/deprecation/hwrp_without_unified_mode_true.rb +3 -3
  91. data/lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb +4 -4
  92. data/lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb +1 -1
  93. data/lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb +1 -1
  94. data/lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb +10 -2
  95. data/lib/rubocop/cop/chef/deprecation/librarian_chefspec.rb +1 -1
  96. data/lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb +6 -1
  97. data/lib/rubocop/cop/chef/deprecation/log_resource_notifications.rb +1 -1
  98. data/lib/rubocop/cop/chef/deprecation/macos_userdefaults_global_property.rb +1 -1
  99. data/lib/rubocop/cop/chef/deprecation/name_property_and_default.rb +1 -1
  100. data/lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb +1 -1
  101. data/lib/rubocop/cop/chef/deprecation/partial_search_class_usage.rb +1 -1
  102. data/lib/rubocop/cop/chef/deprecation/partial_search_helper_usage.rb +1 -1
  103. data/lib/rubocop/cop/chef/deprecation/poise_archive.rb +1 -1
  104. data/lib/rubocop/cop/chef/deprecation/policyfile_community_source.rb +1 -1
  105. data/lib/rubocop/cop/chef/deprecation/powershell_cookbook_helpers.rb +1 -1
  106. data/lib/rubocop/cop/chef/deprecation/require_recipe.rb +1 -1
  107. data/lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb +1 -1
  108. data/lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.rb +1 -1
  109. data/lib/rubocop/cop/chef/deprecation/resource_uses_only_resource_name.rb +10 -2
  110. data/lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb +5 -1
  111. data/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb +1 -1
  112. data/lib/rubocop/cop/chef/deprecation/resource_without_unified_mode_true.rb +1 -1
  113. data/lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb +1 -1
  114. data/lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb +43 -4
  115. data/lib/rubocop/cop/chef/deprecation/run_command_helper.rb +1 -1
  116. data/lib/rubocop/cop/chef/deprecation/search_uses_positional_parameters.rb +1 -1
  117. data/lib/rubocop/cop/chef/deprecation/use_automatic_resource_name.rb +10 -1
  118. data/lib/rubocop/cop/chef/deprecation/use_inline_resources.rb +1 -1
  119. data/lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb +6 -1
  120. data/lib/rubocop/cop/chef/deprecation/user_supports_property.rb +1 -1
  121. data/lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.rb +1 -1
  122. data/lib/rubocop/cop/chef/deprecation/windows_feature_servermanagercmd.rb +1 -1
  123. data/lib/rubocop/cop/chef/deprecation/windows_package_installer_type_string.rb +1 -1
  124. data/lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb +1 -1
  125. data/lib/rubocop/cop/chef/deprecation/windows_version_helpers.rb +1 -1
  126. data/lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb +6 -2
  127. data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb +1 -1
  128. data/lib/rubocop/cop/chef/effortless/berksfile.rb +1 -1
  129. data/lib/rubocop/cop/chef/effortless/data_bags.rb +1 -1
  130. data/lib/rubocop/cop/chef/effortless/node_environment.rb +1 -1
  131. data/lib/rubocop/cop/chef/effortless/node_policygroup.rb +1 -1
  132. data/lib/rubocop/cop/chef/effortless/node_roles.rb +1 -1
  133. data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb +1 -1
  134. data/lib/rubocop/cop/chef/effortless/search_used.rb +1 -1
  135. data/lib/rubocop/cop/chef/modernize/action_method_in_resource.rb +1 -1
  136. data/lib/rubocop/cop/chef/modernize/allowed_actions_initializer.rb +1 -1
  137. data/lib/rubocop/cop/chef/modernize/apt_default_recipe.rb +2 -2
  138. data/lib/rubocop/cop/chef/modernize/berksfile_source.rb +1 -1
  139. data/lib/rubocop/cop/chef/modernize/build_essential.rb +5 -2
  140. data/lib/rubocop/cop/chef/modernize/chef_14_resources.rb +9 -1
  141. data/lib/rubocop/cop/chef/modernize/chef_15_resources.rb +12 -1
  142. data/lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb +5 -1
  143. data/lib/rubocop/cop/chef/modernize/class_eval_action_class.rb +1 -1
  144. data/lib/rubocop/cop/chef/modernize/compile_time_resources.rb +1 -1
  145. data/lib/rubocop/cop/chef/modernize/conditional_using_test.rb +11 -4
  146. data/lib/rubocop/cop/chef/modernize/cron_d_file_or_template.rb +7 -5
  147. data/lib/rubocop/cop/chef/modernize/cron_manage_resource.rb +1 -1
  148. data/lib/rubocop/cop/chef/modernize/databag_helpers.rb +7 -4
  149. data/lib/rubocop/cop/chef/modernize/declare_action_class.rb +1 -1
  150. data/lib/rubocop/cop/chef/modernize/default_action_initializer.rb +1 -1
  151. data/lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb +1 -1
  152. data/lib/rubocop/cop/chef/modernize/definitions.rb +1 -1
  153. data/lib/rubocop/cop/chef/modernize/depends_chef_vault_cookbook.rb +5 -1
  154. data/lib/rubocop/cop/chef/modernize/depends_chocolatey_cookbooks.rb +8 -1
  155. data/lib/rubocop/cop/chef/modernize/depends_kernel_module_cookbook.rb +7 -1
  156. data/lib/rubocop/cop/chef/modernize/depends_locale_cookbook.rb +7 -1
  157. data/lib/rubocop/cop/chef/modernize/depends_openssl_cookbook.rb +10 -1
  158. data/lib/rubocop/cop/chef/modernize/depends_timezone_lwrp_cookbook.rb +5 -1
  159. data/lib/rubocop/cop/chef/modernize/depends_windows_firewall_cookbook.rb +9 -1
  160. data/lib/rubocop/cop/chef/modernize/depends_zypper_cookbook.rb +8 -1
  161. data/lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb +2 -2
  162. data/lib/rubocop/cop/chef/modernize/empty_resource_initialize.rb +1 -1
  163. data/lib/rubocop/cop/chef/modernize/execute_apt_update.rb +4 -2
  164. data/lib/rubocop/cop/chef/modernize/execute_archive_extract.rb +121 -0
  165. data/lib/rubocop/cop/chef/modernize/execute_sc_exe.rb +1 -1
  166. data/lib/rubocop/cop/chef/modernize/execute_sleep.rb +1 -1
  167. data/lib/rubocop/cop/chef/modernize/execute_sysctl.rb +1 -1
  168. data/lib/rubocop/cop/chef/modernize/execute_tzutil.rb +1 -1
  169. data/lib/rubocop/cop/chef/modernize/execute_update_alternatives.rb +100 -0
  170. data/lib/rubocop/cop/chef/modernize/foodcritic_comments.rb +1 -1
  171. data/lib/rubocop/cop/chef/modernize/if_provides_default_action.rb +1 -1
  172. data/lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb +5 -1
  173. data/lib/rubocop/cop/chef/modernize/libarchive_file.rb +6 -4
  174. data/lib/rubocop/cop/chef/modernize/macos_user_defaults.rb +1 -1
  175. data/lib/rubocop/cop/chef/modernize/minitest_handler_usage.rb +1 -1
  176. data/lib/rubocop/cop/chef/modernize/node_init_package.rb +1 -1
  177. data/lib/rubocop/cop/chef/modernize/node_roles_include.rb +1 -1
  178. data/lib/rubocop/cop/chef/modernize/ohai_default_recipe.rb +7 -2
  179. data/lib/rubocop/cop/chef/modernize/openssl_rsa_key_resource.rb +1 -1
  180. data/lib/rubocop/cop/chef/modernize/openssl_x509_resource.rb +1 -1
  181. data/lib/rubocop/cop/chef/modernize/osx_config_profile_resource.rb +1 -1
  182. data/lib/rubocop/cop/chef/modernize/powershell_download_file.rb +64 -0
  183. data/lib/rubocop/cop/chef/modernize/powershell_expand_archive.rb +9 -2
  184. data/lib/rubocop/cop/chef/modernize/powershell_guard_interpreter.rb +5 -5
  185. data/lib/rubocop/cop/chef/modernize/powershell_install_package.rb +1 -1
  186. data/lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.rb +1 -1
  187. data/lib/rubocop/cop/chef/modernize/property_with_name_attribute.rb +1 -1
  188. data/lib/rubocop/cop/chef/modernize/provides_initializer.rb +1 -1
  189. data/lib/rubocop/cop/chef/modernize/resource_name_initializer.rb +1 -1
  190. data/lib/rubocop/cop/chef/modernize/resource_set_or_return.rb +1 -1
  191. data/lib/rubocop/cop/chef/modernize/resource_with_attributes.rb +1 -1
  192. data/lib/rubocop/cop/chef/modernize/respond_to_compile_time.rb +1 -1
  193. data/lib/rubocop/cop/chef/modernize/respond_to_metadata.rb +1 -1
  194. data/lib/rubocop/cop/chef/modernize/respond_to_provides.rb +1 -1
  195. data/lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb +1 -1
  196. data/lib/rubocop/cop/chef/modernize/sc_windows_resource.rb +3 -3
  197. data/lib/rubocop/cop/chef/modernize/seven_zip_archive.rb +8 -2
  198. data/lib/rubocop/cop/chef/modernize/shell_out_helper.rb +1 -1
  199. data/lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.rb +16 -5
  200. data/lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb +1 -1
  201. data/lib/rubocop/cop/chef/modernize/sysctl_param_resource.rb +1 -1
  202. data/lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb +1 -1
  203. data/lib/rubocop/cop/chef/modernize/use_chef_language_cloud_helpers.rb +1 -1
  204. data/lib/rubocop/cop/chef/modernize/use_chef_language_env_helpers.rb +1 -1
  205. data/lib/rubocop/cop/chef/modernize/use_chef_language_systemd_helper.rb +1 -1
  206. data/lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb +1 -1
  207. data/lib/rubocop/cop/chef/modernize/use_require_relative.rb +2 -2
  208. data/lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb +1 -1
  209. data/lib/rubocop/cop/chef/modernize/windows_default_recipe.rb +2 -2
  210. data/lib/rubocop/cop/chef/modernize/windows_registry_uac.rb +1 -1
  211. data/lib/rubocop/cop/chef/modernize/windows_zipfile.rb +9 -3
  212. data/lib/rubocop/cop/chef/modernize/zipfile_resource.rb +8 -2
  213. data/lib/rubocop/cop/chef/modernize/zypper_repo.rb +3 -3
  214. data/lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb +1 -1
  215. data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb +1 -1
  216. data/lib/rubocop/cop/chef/redundant/attribute_metadata.rb +1 -1
  217. data/lib/rubocop/cop/chef/redundant/conflicts_metadata.rb +1 -1
  218. data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb +11 -1
  219. data/lib/rubocop/cop/chef/redundant/double_compile_time.rb +23 -9
  220. data/lib/rubocop/cop/chef/redundant/grouping_metadata.rb +1 -1
  221. data/lib/rubocop/cop/chef/redundant/long_description_metadata.rb +1 -1
  222. data/lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb +1 -1
  223. data/lib/rubocop/cop/chef/redundant/name_property_and_required.rb +1 -1
  224. data/lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb +1 -1
  225. data/lib/rubocop/cop/chef/redundant/property_splat_regex.rb +1 -1
  226. data/lib/rubocop/cop/chef/redundant/property_with_default_and_required.rb +1 -1
  227. data/lib/rubocop/cop/chef/redundant/provides_metadata.rb +1 -1
  228. data/lib/rubocop/cop/chef/redundant/recipe_metadata.rb +1 -1
  229. data/lib/rubocop/cop/chef/redundant/replaces_metadata.rb +1 -1
  230. data/lib/rubocop/cop/chef/redundant/resource_with_nothing_action.rb +1 -1
  231. data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb +1 -1
  232. data/lib/rubocop/cop/chef/redundant/service_guard_on_stop_disable.rb +117 -0
  233. data/lib/rubocop/cop/chef/redundant/string_property_with_nil_default.rb +3 -3
  234. data/lib/rubocop/cop/chef/redundant/suggests_metadata.rb +1 -1
  235. data/lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb +1 -1
  236. data/lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb +2 -2
  237. data/lib/rubocop/cop/chef/redundant/use_create_if_missing.rb +1 -1
  238. data/lib/rubocop/cop/chef/security/insecure_remote_file_source.rb +82 -0
  239. data/lib/rubocop/cop/chef/security/ssh_private_key.rb +10 -1
  240. data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb +1 -1
  241. data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb +1 -1
  242. data/lib/rubocop/cop/chef/sharing/empty_property_description.rb +62 -0
  243. data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb +1 -1
  244. data/lib/rubocop/cop/chef/sharing/include_resource_descriptions.rb +1 -1
  245. data/lib/rubocop/cop/chef/sharing/include_resource_examples.rb +1 -1
  246. data/lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb +1 -1
  247. data/lib/rubocop/cop/chef/sharing/invalid_license_string.rb +1 -1
  248. data/lib/rubocop/cop/chef/style/chef_whaaat.rb +1 -1
  249. data/lib/rubocop/cop/chef/style/comment_sentence_spacing.rb +1 -1
  250. data/lib/rubocop/cop/chef/style/comments_copyright_format.rb +1 -1
  251. data/lib/rubocop/cop/chef/style/comments_default_copyright.rb +1 -1
  252. data/lib/rubocop/cop/chef/style/comments_format.rb +1 -1
  253. data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb +1 -1
  254. data/lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb +6 -3
  255. data/lib/rubocop/cop/chef/style/negating_only_if.rb +1 -1
  256. data/lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb +1 -1
  257. data/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb +1 -1
  258. data/lib/rubocop/cop/chef/style/true_false_resource_properties.rb +2 -2
  259. data/lib/rubocop/cop/chef/style/unnecessary_os_check.rb +1 -1
  260. data/lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb +1 -1
  261. data/lib/rubocop/cop/chef/style/use_platform_helpers.rb +1 -1
  262. data/lib/rubocop/cop/chef.rb +349 -0
  263. data/lib/rubocop/cop/chefstyle/ruby/gemspec_license.rb +1 -1
  264. data/lib/rubocop/cop/chefstyle/ruby/gemspec_require_rubygems.rb +1 -1
  265. data/lib/rubocop/cop/chefstyle/ruby/legacy_powershell_out_methods.rb +1 -1
  266. data/lib/rubocop/cop/chefstyle/ruby/require_net_https.rb +1 -1
  267. data/lib/rubocop/cop/chefstyle/ruby/unless_defined_require.rb +1 -1
  268. data/lib/rubocop/cop/inspec/deprecation/attribute_default.rb +1 -1
  269. data/lib/rubocop/cop/inspec/deprecation/attribute_helper.rb +1 -1
  270. data/lib/rubocop/cop/inspec.rb +31 -0
  271. data/lib/rubocop/monkey_patches/directive_comment.rb +21 -3
  272. metadata +21 -8
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -31,6 +31,11 @@ module RuboCop
31
31
  # action :create
32
32
  # end
33
33
  #
34
+ # # bad
35
+ # template '/etc/foo.conf' do
36
+ # notifies :create, 'ruby_block[my special ruby block]', :immediately
37
+ # end
38
+ #
34
39
  # # good
35
40
  # ruby_block 'my special ruby block' do
36
41
  # block do
@@ -39,22 +44,56 @@ module RuboCop
39
44
  # action :run
40
45
  # end
41
46
  #
47
+ # # good
48
+ # template '/etc/foo.conf' do
49
+ # notifies :run, 'ruby_block[my special ruby block]', :immediately
50
+ # end
51
+ #
42
52
  class RubyBlockCreateAction < Base
43
53
  include RuboCop::Chef::CookbookHelpers
44
54
  extend AutoCorrector
45
55
 
46
56
  MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'
57
+ RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
58
+
59
+ def_node_matcher :notification?, <<-PATTERN
60
+ (send nil? {:notifies :subscribes} $(sym :create) ${str dstr} ...)
61
+ PATTERN
47
62
 
48
63
  def on_block(node)
49
64
  match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
50
- ruby_action.arguments.each do |action|
51
- next unless action.source == ':create'
65
+ each_action_symbol(ruby_action) do |action, prefix|
66
+ next unless action.value == :create
52
67
  add_offense(action, severity: :warning) do |corrector|
53
- corrector.replace(action, ':run')
68
+ corrector.replace(action, "#{prefix}run")
54
69
  end
55
70
  end
56
71
  end
57
72
  end
73
+
74
+ def on_send(node)
75
+ notification?(node) do |action, notified_resource|
76
+ next unless ruby_block?(notified_resource)
77
+
78
+ add_offense(action, severity: :warning) do |corrector|
79
+ corrector.replace(action, ':run')
80
+ end
81
+ end
82
+ end
83
+
84
+ private
85
+
86
+ # Does the notified resource string address a ruby_block? An interpolated name
87
+ # ("ruby_block[#{foo}]") still starts with a literal segment we can key off of, but a
88
+ # string whose resource type is itself interpolated tells us nothing, so we skip it.
89
+ #
90
+ # @param [RuboCop::AST::Node] node the str or dstr the notification points at
91
+ #
92
+ # @return [Boolean]
93
+ def ruby_block?(node)
94
+ literal = node.str_type? ? node : node.children.first
95
+ literal&.str_type? && literal.value.start_with?('ruby_block[')
96
+ end
58
97
  end
59
98
  end
60
99
  end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -33,6 +33,15 @@ module RuboCop
33
33
  # end
34
34
  # end
35
35
  #
36
+ # # good
37
+ # module MyCookbook
38
+ # class MyCookbookService < Chef::Resource
39
+ # provides :mycookbook_service
40
+ #
41
+ # # some additional code
42
+ # end
43
+ # end
44
+ #
36
45
  class UseAutomaticResourceName < Base
37
46
  extend RuboCop::Cop::AutoCorrector
38
47
  include RangeHelp
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -36,6 +36,11 @@ module RuboCop
36
36
  RESTRICT_ON_SEND = [:to_yaml].freeze
37
37
 
38
38
  def on_send(node)
39
+ # A receiverless to_yaml is a call to a locally defined method rather than
40
+ # the Ruby stdlib conversion this cop is about, and there's nothing to pass
41
+ # to YAML.dump. Bail out rather than dereferencing a nil receiver.
42
+ return unless node.receiver
43
+
39
44
  add_offense(node, severity: :warning) do |corrector|
40
45
  corrector.replace(node, "YAML.dump(#{node.receiver.source})")
41
46
  end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -26,6 +26,10 @@ module RuboCop
26
26
  # # bad
27
27
  # include_recipe 'xml::ruby'
28
28
  #
29
+ # # good
30
+ # # nokogiri ships with Chef Infra Client, so just require it
31
+ # require 'nokogiri'
32
+ #
29
33
  class IncludingXMLRubyRecipe < Base
30
34
  extend AutoCorrector
31
35
 
@@ -33,7 +37,7 @@ module RuboCop
33
37
  RESTRICT_ON_SEND = [:include_recipe].freeze
34
38
 
35
39
  def_node_matcher :xml_ruby_recipe?, <<-PATTERN
36
- (send nil? :include_recipe (str "xml::ruby"))
40
+ (send {nil? (send nil? :run_context)} :include_recipe (str "xml::ruby"))
37
41
  PATTERN
38
42
 
39
43
  def on_send(node)
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -39,7 +39,7 @@ module RuboCop
39
39
  RESTRICT_ON_SEND = [:include_recipe].freeze
40
40
 
41
41
  def_node_matcher :apt_recipe_usage?, <<-PATTERN
42
- (send nil? :include_recipe (str {"apt" "apt::default"}))
42
+ (send {nil? (send nil? :run_context)} :include_recipe (str {"apt" "apt::default"}))
43
43
  PATTERN
44
44
 
45
45
  def on_send(node)
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@ module RuboCop
27
27
  # depends 'build-essential'
28
28
  # include_recipe 'build-essential::default'
29
29
  # include_recipe 'build-essential'
30
+ # run_context.include_recipe 'build-essential::default'
30
31
  #
31
32
  # # good
32
33
  # build_essential 'install compilation tools'
@@ -37,8 +38,10 @@ module RuboCop
37
38
  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+'
38
39
  RESTRICT_ON_SEND = [:include_recipe].freeze
39
40
 
41
+ # matches a bare include_recipe as well as the run_context.include_recipe form used from
42
+ # libraries and custom resources
40
43
  def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
41
- (send nil? :include_recipe (str {"build-essential" "build-essential::default"}))
44
+ (send {nil? (send nil? :run_context)} :include_recipe (str {"build-essential" "build-essential::default"}))
42
45
  PATTERN
43
46
 
44
47
  def on_send(node)
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -32,6 +32,14 @@ module RuboCop
32
32
  # depends 'swap'
33
33
  # depends 'sysctl'
34
34
  #
35
+ # # good
36
+ # # the resources ship in Chef Infra Client 14+, so use them without a depends
37
+ # build_essential 'install compilation tools'
38
+ #
39
+ # sysctl 'vm.swappiness' do
40
+ # value 10
41
+ # end
42
+ #
35
43
  class UnnecessaryDependsChef14 < Base
36
44
  extend AutoCorrector
37
45
  extend TargetChefVersion
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -29,6 +29,17 @@ module RuboCop
29
29
  # depends 'windows_uac'
30
30
  # depends 'windows_dfs'
31
31
  #
32
+ # # good
33
+ # # the resources ship in Chef Infra Client 15+, so use them without a depends
34
+ # archive_file 'expand website' do
35
+ # path '/tmp/site.zip'
36
+ # destination '/var/www/html'
37
+ # end
38
+ #
39
+ # windows_uac 'set uac' do
40
+ # enable_uac true
41
+ # end
42
+ #
32
43
  class UnnecessaryDependsChef15 < Base
33
44
  extend AutoCorrector
34
45
  extend TargetChefVersion
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -26,6 +26,10 @@ module RuboCop
26
26
  # # bad
27
27
  # chef_gem 'nokogiri'
28
28
  #
29
+ # # good
30
+ # # nokogiri ships with Chef Infra Client, so just require it
31
+ # require 'nokogiri'
32
+ #
29
33
  class ChefGemNokogiri < Base
30
34
  extend AutoCorrector
31
35
  include RangeHelp
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -19,20 +19,27 @@ module RuboCop
19
19
  module Cop
20
20
  module Chef
21
21
  module Modernize
22
- # Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out
22
+ # Use `::File.exist?('/foo/bar')` in an `only_if` or `not_if` guard instead of the slower `'test -f /foo/bar'`, which requires shelling out. The Ruby check has to be passed as a block. Passing it directly, as `not_if ::File.exist?('/foo/bar')`, raises `ArgumentError: Invalid only_if/not_if command, expected a string`.
23
23
  #
24
24
  # @example
25
25
  #
26
26
  # # bad
27
27
  # only_if 'test -f /bin/foo'
28
+ # not_if 'test -f /bin/foo'
29
+ #
30
+ # # bad - a Ruby guard has to be a block, this raises at converge time
31
+ # only_if ::File.exist?('/bin/foo')
28
32
  #
29
33
  # # good
30
34
  # only_if { ::File.exist?('/bin/foo') }
35
+ # not_if { ::File.exist?('/bin/foo') }
31
36
  #
32
37
  class ConditionalUsingTest < Base
33
38
  extend AutoCorrector
34
39
 
35
- MSG = "Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out"
40
+ # %{guard} is the guard the offense was found on, so that a not_if offense isn't told to
41
+ # use an only_if, which would invert the condition
42
+ MSG = "Use %{guard} { ::File.exist?('/foo/bar') } instead of the slower %{guard} 'test -f /foo/bar' which requires shelling out"
36
43
  RESTRICT_ON_SEND = [:not_if, :only_if].freeze
37
44
 
38
45
  def_node_matcher :resource_conditional?, <<~PATTERN
@@ -42,7 +49,7 @@ module RuboCop
42
49
  def on_send(node)
43
50
  resource_conditional?(node) do |conditional|
44
51
  return unless conditional.value.match?(/^test -[ef] \S*$/)
45
- add_offense(node, severity: :refactor) do |corrector|
52
+ add_offense(node, message: format(MSG, guard: node.method_name), severity: :refactor) do |corrector|
46
53
  new_string = "{ ::File.exist?('#{conditional.value.match(/^test -[ef] (\S*)$/)[1]}') }"
47
54
  corrector.replace(conditional, new_string)
48
55
  end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -106,11 +106,13 @@ module RuboCop
106
106
  end
107
107
 
108
108
  match_property_in_resource?(%i(template file cookbook_file), 'path', node) do |code_property|
109
- # instead of using CookbookHelpers#method_arg_ast_to_string, walk the property's descendants
110
- # and check if their value contains '/etc/cron.d'
109
+ # instead of using CookbookHelpers#method_arg_ast_to_string, walk the property's string
110
+ # descendants and check if their value contains '/etc/cron.d'
111
111
  # covers the case where the argument to the path property is provided via a method like File.join
112
- code_property.each_descendant do |d|
113
- add_offense(node, severity: :refactor) if d.respond_to?(:value) && d.value.match?(%r{/etc/cron\.d\b}i)
112
+ # only string nodes are walked: other literals respond to #value too, but return types
113
+ # like Integer that have no #match?, which raised inside the cop (issue #957)
114
+ code_property.each_descendant(:str) do |d|
115
+ add_offense(node, severity: :refactor) if d.value.match?(%r{/etc/cron\.d\b}i)
114
116
  end
115
117
  end
116
118
  end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -40,15 +40,18 @@ module RuboCop
40
40
  def_node_matcher :data_bag_class_load?, <<-PATTERN
41
41
  (send
42
42
  (const
43
- (const nil? :Chef) {:DataBagItem :EncryptedDataBagItem}) :load
43
+ (const {nil? cbase} :Chef) {:DataBagItem :EncryptedDataBagItem}) :load
44
44
  ...)
45
45
  PATTERN
46
46
 
47
47
  def on_send(node)
48
48
  data_bag_class_load?(node) do
49
49
  add_offense(node, severity: :refactor) do |corrector|
50
- corrector.replace(node,
51
- node.source.gsub(/Chef::(EncryptedDataBagItem|DataBagItem).load/, 'data_bag_item'))
50
+ # replace only the receiver and the .load selector, so that the arguments are left
51
+ # exactly as written. rewriting node.source would also hit any argument that
52
+ # happened to contain the class name, and would leave the leading :: of a scope
53
+ # resolved ::Chef::DataBagItem.load behind
54
+ corrector.replace(node.receiver.source_range.join(node.loc.selector), 'data_bag_item')
52
55
  end
53
56
  end
54
57
  end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.