rubocop 1.10.0 → 1.14.0

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 (487) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -14
  3. data/assets/output.html.erb +1 -1
  4. data/config/default.yml +60 -3
  5. data/exe/rubocop +1 -3
  6. data/lib/rubocop.rb +6 -1
  7. data/lib/rubocop/cached_data.rb +1 -3
  8. data/lib/rubocop/cli.rb +4 -6
  9. data/lib/rubocop/cli/command/auto_genenerate_config.rb +9 -19
  10. data/lib/rubocop/cli/command/execute_runner.rb +1 -1
  11. data/lib/rubocop/cli/command/init_dotfile.rb +1 -3
  12. data/lib/rubocop/cli/command/show_cops.rb +1 -4
  13. data/lib/rubocop/cli/command/suggest_extensions.rb +3 -2
  14. data/lib/rubocop/comment_config.rb +45 -101
  15. data/lib/rubocop/config.rb +11 -26
  16. data/lib/rubocop/config_loader.rb +5 -11
  17. data/lib/rubocop/config_loader_resolver.rb +22 -14
  18. data/lib/rubocop/config_obsoletion/cop_rule.rb +1 -2
  19. data/lib/rubocop/config_store.rb +1 -2
  20. data/lib/rubocop/config_validator.rb +5 -10
  21. data/lib/rubocop/cop/autocorrect_logic.rb +3 -8
  22. data/lib/rubocop/cop/badge.rb +1 -2
  23. data/lib/rubocop/cop/base.rb +8 -6
  24. data/lib/rubocop/cop/bundler/duplicated_gem.rb +3 -3
  25. data/lib/rubocop/cop/bundler/gem_comment.rb +43 -10
  26. data/lib/rubocop/cop/bundler/gem_version.rb +99 -0
  27. data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +1 -0
  28. data/lib/rubocop/cop/bundler/ordered_gems.rb +2 -4
  29. data/lib/rubocop/cop/commissioner.rb +2 -8
  30. data/lib/rubocop/cop/cop.rb +4 -18
  31. data/lib/rubocop/cop/corrector.rb +1 -4
  32. data/lib/rubocop/cop/correctors/alignment_corrector.rb +6 -12
  33. data/lib/rubocop/cop/correctors/each_to_for_corrector.rb +2 -4
  34. data/lib/rubocop/cop/correctors/for_to_each_corrector.rb +1 -2
  35. data/lib/rubocop/cop/correctors/line_break_corrector.rb +3 -6
  36. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +1 -3
  37. data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb +1 -3
  38. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +2 -8
  39. data/lib/rubocop/cop/gemspec/date_assignment.rb +1 -0
  40. data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +3 -2
  41. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +2 -4
  42. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +2 -0
  43. data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +2 -0
  44. data/lib/rubocop/cop/generator.rb +3 -6
  45. data/lib/rubocop/cop/generator/configuration_injector.rb +1 -2
  46. data/lib/rubocop/cop/generator/require_file_injector.rb +2 -5
  47. data/lib/rubocop/cop/internal_affairs.rb +1 -0
  48. data/lib/rubocop/cop/internal_affairs/example_description.rb +7 -4
  49. data/lib/rubocop/cop/internal_affairs/method_name_equal.rb +3 -5
  50. data/lib/rubocop/cop/internal_affairs/node_destructuring.rb +3 -3
  51. data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +151 -0
  52. data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +2 -3
  53. data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb +3 -2
  54. data/lib/rubocop/cop/internal_affairs/redundant_described_class_as_subject.rb +1 -0
  55. data/lib/rubocop/cop/internal_affairs/redundant_let_rubocop_config_new.rb +1 -0
  56. data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +1 -0
  57. data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +3 -0
  58. data/lib/rubocop/cop/internal_affairs/style_detected_api_use.rb +5 -2
  59. data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +3 -3
  60. data/lib/rubocop/cop/layout/access_modifier_indentation.rb +12 -10
  61. data/lib/rubocop/cop/layout/argument_alignment.rb +8 -9
  62. data/lib/rubocop/cop/layout/array_alignment.rb +7 -6
  63. data/lib/rubocop/cop/layout/assignment_indentation.rb +8 -7
  64. data/lib/rubocop/cop/layout/begin_end_alignment.rb +1 -4
  65. data/lib/rubocop/cop/layout/block_alignment.rb +8 -19
  66. data/lib/rubocop/cop/layout/block_end_newline.rb +4 -8
  67. data/lib/rubocop/cop/layout/case_indentation.rb +1 -3
  68. data/lib/rubocop/cop/layout/class_structure.rb +5 -10
  69. data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +18 -30
  70. data/lib/rubocop/cop/layout/comment_indentation.rb +17 -21
  71. data/lib/rubocop/cop/layout/def_end_alignment.rb +2 -6
  72. data/lib/rubocop/cop/layout/dot_position.rb +1 -3
  73. data/lib/rubocop/cop/layout/else_alignment.rb +10 -9
  74. data/lib/rubocop/cop/layout/empty_comment.rb +5 -12
  75. data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +22 -8
  76. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +2 -6
  77. data/lib/rubocop/cop/layout/empty_lines.rb +1 -3
  78. data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +8 -18
  79. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +2 -8
  80. data/lib/rubocop/cop/layout/end_alignment.rb +1 -2
  81. data/lib/rubocop/cop/layout/end_of_line.rb +1 -1
  82. data/lib/rubocop/cop/layout/extra_spacing.rb +5 -9
  83. data/lib/rubocop/cop/layout/first_argument_indentation.rb +11 -5
  84. data/lib/rubocop/cop/layout/first_array_element_indentation.rb +10 -8
  85. data/lib/rubocop/cop/layout/first_array_element_line_break.rb +1 -2
  86. data/lib/rubocop/cop/layout/first_hash_element_indentation.rb +24 -20
  87. data/lib/rubocop/cop/layout/first_hash_element_line_break.rb +1 -2
  88. data/lib/rubocop/cop/layout/first_method_argument_line_break.rb +1 -2
  89. data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb +1 -2
  90. data/lib/rubocop/cop/layout/first_parameter_indentation.rb +6 -5
  91. data/lib/rubocop/cop/layout/hash_alignment.rb +3 -6
  92. data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +2 -9
  93. data/lib/rubocop/cop/layout/heredoc_indentation.rb +2 -6
  94. data/lib/rubocop/cop/layout/indentation_consistency.rb +9 -6
  95. data/lib/rubocop/cop/layout/indentation_style.rb +25 -30
  96. data/lib/rubocop/cop/layout/indentation_width.rb +21 -11
  97. data/lib/rubocop/cop/layout/initial_indentation.rb +1 -4
  98. data/lib/rubocop/cop/layout/line_length.rb +4 -15
  99. data/lib/rubocop/cop/layout/multiline_array_line_breaks.rb +1 -2
  100. data/lib/rubocop/cop/layout/multiline_block_layout.rb +7 -15
  101. data/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb +1 -2
  102. data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +1 -2
  103. data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +22 -15
  104. data/lib/rubocop/cop/layout/multiline_operation_indentation.rb +10 -5
  105. data/lib/rubocop/cop/layout/parameter_alignment.rb +6 -5
  106. data/lib/rubocop/cop/layout/redundant_line_break.rb +137 -0
  107. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +3 -6
  108. data/lib/rubocop/cop/layout/single_line_block_chain.rb +53 -0
  109. data/lib/rubocop/cop/layout/space_after_colon.rb +1 -3
  110. data/lib/rubocop/cop/layout/space_after_method_name.rb +2 -4
  111. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +6 -14
  112. data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb +1 -2
  113. data/lib/rubocop/cop/layout/space_around_keyword.rb +3 -6
  114. data/lib/rubocop/cop/layout/space_around_operators.rb +4 -9
  115. data/lib/rubocop/cop/layout/space_before_block_braces.rb +2 -3
  116. data/lib/rubocop/cop/layout/space_before_brackets.rb +1 -3
  117. data/lib/rubocop/cop/layout/space_before_comment.rb +1 -3
  118. data/lib/rubocop/cop/layout/space_before_first_arg.rb +5 -11
  119. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +2 -4
  120. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +5 -10
  121. data/lib/rubocop/cop/layout/space_inside_array_percent_literal.rb +2 -7
  122. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +6 -11
  123. data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +1 -2
  124. data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +1 -2
  125. data/lib/rubocop/cop/legacy/corrections_proxy.rb +2 -8
  126. data/lib/rubocop/cop/legacy/corrector.rb +1 -3
  127. data/lib/rubocop/cop/lint/ambiguous_assignment.rb +1 -6
  128. data/lib/rubocop/cop/lint/ambiguous_block_association.rb +14 -7
  129. data/lib/rubocop/cop/lint/big_decimal_new.rb +1 -0
  130. data/lib/rubocop/cop/lint/boolean_symbol.rb +2 -2
  131. data/lib/rubocop/cop/lint/constant_definition_in_block.rb +2 -0
  132. data/lib/rubocop/cop/lint/constant_resolution.rb +2 -2
  133. data/lib/rubocop/cop/lint/debugger.rb +3 -1
  134. data/lib/rubocop/cop/lint/deprecated_class_methods.rb +79 -41
  135. data/lib/rubocop/cop/lint/deprecated_constants.rb +3 -3
  136. data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +3 -5
  137. data/lib/rubocop/cop/lint/duplicate_branch.rb +2 -3
  138. data/lib/rubocop/cop/lint/duplicate_hash_key.rb +1 -3
  139. data/lib/rubocop/cop/lint/duplicate_methods.rb +6 -7
  140. data/lib/rubocop/cop/lint/duplicate_require.rb +1 -0
  141. data/lib/rubocop/cop/lint/each_with_object_argument.rb +1 -0
  142. data/lib/rubocop/cop/lint/else_layout.rb +1 -3
  143. data/lib/rubocop/cop/lint/empty_ensure.rb +1 -3
  144. data/lib/rubocop/cop/lint/empty_file.rb +1 -3
  145. data/lib/rubocop/cop/lint/empty_interpolation.rb +1 -3
  146. data/lib/rubocop/cop/lint/ensure_return.rb +1 -3
  147. data/lib/rubocop/cop/lint/erb_new_arguments.rb +4 -7
  148. data/lib/rubocop/cop/lint/float_out_of_range.rb +1 -2
  149. data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +4 -6
  150. data/lib/rubocop/cop/lint/hash_compare_by_identity.rb +1 -0
  151. data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +1 -2
  152. data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +1 -2
  153. data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +4 -7
  154. data/lib/rubocop/cop/lint/inherit_exception.rb +2 -2
  155. data/lib/rubocop/cop/lint/interpolation_check.rb +3 -11
  156. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +3 -6
  157. data/lib/rubocop/cop/lint/loop.rb +1 -2
  158. data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +3 -7
  159. data/lib/rubocop/cop/lint/missing_super.rb +1 -2
  160. data/lib/rubocop/cop/lint/mixed_regexp_capture_types.rb +1 -2
  161. data/lib/rubocop/cop/lint/multiple_comparison.rb +1 -0
  162. data/lib/rubocop/cop/lint/nested_method_definition.rb +4 -2
  163. data/lib/rubocop/cop/lint/nested_percent_literal.rb +1 -3
  164. data/lib/rubocop/cop/lint/next_without_accumulator.rb +1 -0
  165. data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +8 -3
  166. data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +3 -0
  167. data/lib/rubocop/cop/lint/number_conversion.rb +13 -5
  168. data/lib/rubocop/cop/lint/ordered_magic_comments.rb +1 -2
  169. data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +1 -3
  170. data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +1 -3
  171. data/lib/rubocop/cop/lint/percent_symbol_array.rb +1 -3
  172. data/lib/rubocop/cop/lint/raise_exception.rb +3 -2
  173. data/lib/rubocop/cop/lint/rand_one.rb +2 -2
  174. data/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb +9 -22
  175. data/lib/rubocop/cop/lint/redundant_require_statement.rb +1 -0
  176. data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +2 -3
  177. data/lib/rubocop/cop/lint/redundant_splat_expansion.rb +5 -7
  178. data/lib/rubocop/cop/lint/redundant_string_coercion.rb +2 -2
  179. data/lib/rubocop/cop/lint/redundant_with_index.rb +2 -4
  180. data/lib/rubocop/cop/lint/redundant_with_object.rb +2 -4
  181. data/lib/rubocop/cop/lint/regexp_as_condition.rb +1 -3
  182. data/lib/rubocop/cop/lint/require_parentheses.rb +2 -4
  183. data/lib/rubocop/cop/lint/rescue_exception.rb +1 -2
  184. data/lib/rubocop/cop/lint/rescue_type.rb +2 -7
  185. data/lib/rubocop/cop/lint/return_in_void_context.rb +1 -2
  186. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +2 -2
  187. data/lib/rubocop/cop/lint/safe_navigation_consistency.rb +4 -10
  188. data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +2 -2
  189. data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +3 -7
  190. data/lib/rubocop/cop/lint/shadowed_argument.rb +5 -11
  191. data/lib/rubocop/cop/lint/shadowed_exception.rb +7 -8
  192. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +1 -0
  193. data/lib/rubocop/cop/lint/struct_new_override.rb +2 -2
  194. data/lib/rubocop/cop/lint/suppressed_exception.rb +44 -1
  195. data/lib/rubocop/cop/lint/symbol_conversion.rb +91 -6
  196. data/lib/rubocop/cop/lint/syntax.rb +1 -3
  197. data/lib/rubocop/cop/lint/to_enum_arguments.rb +3 -0
  198. data/lib/rubocop/cop/lint/to_json.rb +1 -2
  199. data/lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb +1 -3
  200. data/lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb +1 -3
  201. data/lib/rubocop/cop/lint/unified_integer.rb +1 -0
  202. data/lib/rubocop/cop/lint/unmodified_reduce_accumulator.rb +5 -0
  203. data/lib/rubocop/cop/lint/unreachable_code.rb +3 -5
  204. data/lib/rubocop/cop/lint/unreachable_loop.rb +15 -7
  205. data/lib/rubocop/cop/lint/unused_block_argument.rb +9 -7
  206. data/lib/rubocop/cop/lint/unused_method_argument.rb +2 -2
  207. data/lib/rubocop/cop/lint/uri_escape_unescape.rb +1 -0
  208. data/lib/rubocop/cop/lint/useless_access_modifier.rb +6 -4
  209. data/lib/rubocop/cop/lint/useless_assignment.rb +4 -9
  210. data/lib/rubocop/cop/lint/useless_setter_call.rb +2 -3
  211. data/lib/rubocop/cop/lint/useless_times.rb +3 -0
  212. data/lib/rubocop/cop/lint/void.rb +4 -11
  213. data/lib/rubocop/cop/message_annotator.rb +1 -3
  214. data/lib/rubocop/cop/metrics/block_nesting.rb +2 -7
  215. data/lib/rubocop/cop/metrics/class_length.rb +1 -3
  216. data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +1 -2
  217. data/lib/rubocop/cop/metrics/module_length.rb +3 -6
  218. data/lib/rubocop/cop/metrics/parameter_lists.rb +3 -5
  219. data/lib/rubocop/cop/metrics/perceived_complexity.rb +1 -2
  220. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +4 -7
  221. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +6 -4
  222. data/lib/rubocop/cop/metrics/utils/repeated_attribute_discount.rb +4 -7
  223. data/lib/rubocop/cop/migration/department_name.rb +3 -7
  224. data/lib/rubocop/cop/mixin/alignment.rb +12 -7
  225. data/lib/rubocop/cop/mixin/check_line_breakable.rb +1 -1
  226. data/lib/rubocop/cop/mixin/code_length.rb +1 -3
  227. data/lib/rubocop/cop/mixin/comments_help.rb +5 -1
  228. data/lib/rubocop/cop/mixin/configurable_enforced_style.rb +2 -2
  229. data/lib/rubocop/cop/mixin/configurable_formatting.rb +3 -8
  230. data/lib/rubocop/cop/mixin/def_node.rb +3 -5
  231. data/lib/rubocop/cop/mixin/documentation_comment.rb +3 -6
  232. data/lib/rubocop/cop/mixin/empty_lines_around_body.rb +6 -7
  233. data/lib/rubocop/cop/mixin/empty_parameter.rb +2 -3
  234. data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +1 -3
  235. data/lib/rubocop/cop/mixin/enforce_superclass.rb +4 -6
  236. data/lib/rubocop/cop/mixin/first_element_line_break.rb +1 -3
  237. data/lib/rubocop/cop/mixin/frozen_string_literal.rb +3 -9
  238. data/lib/rubocop/cop/mixin/gem_declaration.rb +13 -0
  239. data/lib/rubocop/cop/mixin/hash_alignment_styles.rb +3 -6
  240. data/lib/rubocop/cop/mixin/hash_transform_method.rb +8 -22
  241. data/lib/rubocop/cop/mixin/interpolation.rb +1 -3
  242. data/lib/rubocop/cop/mixin/line_length_help.rb +13 -10
  243. data/lib/rubocop/cop/mixin/match_range.rb +2 -5
  244. data/lib/rubocop/cop/mixin/method_complexity.rb +2 -3
  245. data/lib/rubocop/cop/mixin/method_preference.rb +1 -2
  246. data/lib/rubocop/cop/mixin/multiline_element_indentation.rb +4 -3
  247. data/lib/rubocop/cop/mixin/multiline_element_line_breaks.rb +1 -3
  248. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +11 -40
  249. data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb +1 -2
  250. data/lib/rubocop/cop/mixin/negative_conditional.rb +4 -2
  251. data/lib/rubocop/cop/mixin/ordered_gem_node.rb +1 -4
  252. data/lib/rubocop/cop/mixin/percent_array.rb +1 -3
  253. data/lib/rubocop/cop/mixin/percent_literal.rb +0 -6
  254. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +5 -11
  255. data/lib/rubocop/cop/mixin/preferred_delimiters.rb +4 -7
  256. data/lib/rubocop/cop/mixin/range_help.rb +10 -13
  257. data/lib/rubocop/cop/mixin/rational_literal.rb +1 -0
  258. data/lib/rubocop/cop/mixin/rescue_node.rb +2 -6
  259. data/lib/rubocop/cop/mixin/safe_assignment.rb +6 -2
  260. data/lib/rubocop/cop/mixin/space_after_punctuation.rb +2 -4
  261. data/lib/rubocop/cop/mixin/space_before_punctuation.rb +1 -2
  262. data/lib/rubocop/cop/mixin/statement_modifier.rb +1 -3
  263. data/lib/rubocop/cop/mixin/string_literals_help.rb +1 -1
  264. data/lib/rubocop/cop/mixin/trailing_body.rb +1 -2
  265. data/lib/rubocop/cop/mixin/trailing_comma.rb +1 -2
  266. data/lib/rubocop/cop/mixin/uncommunicative_name.rb +7 -13
  267. data/lib/rubocop/cop/mixin/unused_argument.rb +1 -3
  268. data/lib/rubocop/cop/mixin/visibility_help.rb +1 -0
  269. data/lib/rubocop/cop/naming/ascii_identifiers.rb +2 -4
  270. data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +2 -2
  271. data/lib/rubocop/cop/naming/constant_name.rb +2 -0
  272. data/lib/rubocop/cop/naming/file_name.rb +7 -16
  273. data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +8 -3
  274. data/lib/rubocop/cop/naming/method_name.rb +4 -2
  275. data/lib/rubocop/cop/naming/predicate_name.rb +2 -2
  276. data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +10 -0
  277. data/lib/rubocop/cop/offense.rb +3 -8
  278. data/lib/rubocop/cop/registry.rb +12 -11
  279. data/lib/rubocop/cop/security/eval.rb +1 -0
  280. data/lib/rubocop/cop/security/json_load.rb +1 -0
  281. data/lib/rubocop/cop/security/marshal_load.rb +1 -0
  282. data/lib/rubocop/cop/security/open.rb +1 -0
  283. data/lib/rubocop/cop/security/yaml_load.rb +1 -0
  284. data/lib/rubocop/cop/style/access_modifier_declarations.rb +4 -5
  285. data/lib/rubocop/cop/style/accessor_grouping.rb +1 -3
  286. data/lib/rubocop/cop/style/alias.rb +6 -12
  287. data/lib/rubocop/cop/style/and_or.rb +3 -1
  288. data/lib/rubocop/cop/style/arguments_forwarding.rb +4 -3
  289. data/lib/rubocop/cop/style/array_coercion.rb +2 -0
  290. data/lib/rubocop/cop/style/array_join.rb +1 -0
  291. data/lib/rubocop/cop/style/ascii_comments.rb +1 -2
  292. data/lib/rubocop/cop/style/attr.rb +2 -3
  293. data/lib/rubocop/cop/style/auto_resource_cleanup.rb +2 -5
  294. data/lib/rubocop/cop/style/bisected_attr_accessor.rb +59 -71
  295. data/lib/rubocop/cop/style/bisected_attr_accessor/macro.rb +60 -0
  296. data/lib/rubocop/cop/style/case_equality.rb +2 -1
  297. data/lib/rubocop/cop/style/case_like_if.rb +16 -6
  298. data/lib/rubocop/cop/style/character_literal.rb +2 -4
  299. data/lib/rubocop/cop/style/class_and_module_children.rb +6 -9
  300. data/lib/rubocop/cop/style/class_equality_comparison.rb +3 -0
  301. data/lib/rubocop/cop/style/class_methods.rb +1 -3
  302. data/lib/rubocop/cop/style/collection_compact.rb +3 -3
  303. data/lib/rubocop/cop/style/colon_method_call.rb +2 -3
  304. data/lib/rubocop/cop/style/combinable_loops.rb +3 -2
  305. data/lib/rubocop/cop/style/command_literal.rb +4 -9
  306. data/lib/rubocop/cop/style/comment_annotation.rb +3 -6
  307. data/lib/rubocop/cop/style/commented_keyword.rb +7 -13
  308. data/lib/rubocop/cop/style/conditional_assignment.rb +12 -24
  309. data/lib/rubocop/cop/style/constant_visibility.rb +1 -0
  310. data/lib/rubocop/cop/style/copyright.rb +3 -6
  311. data/lib/rubocop/cop/style/date_time.rb +5 -5
  312. data/lib/rubocop/cop/style/def_with_parentheses.rb +1 -2
  313. data/lib/rubocop/cop/style/dir.rb +1 -0
  314. data/lib/rubocop/cop/style/disable_cops_within_source_code_directive.rb +2 -2
  315. data/lib/rubocop/cop/style/documentation.rb +30 -3
  316. data/lib/rubocop/cop/style/documentation_method.rb +1 -0
  317. data/lib/rubocop/cop/style/double_negation.rb +1 -0
  318. data/lib/rubocop/cop/style/each_for_simple_loop.rb +2 -2
  319. data/lib/rubocop/cop/style/each_with_object.rb +1 -0
  320. data/lib/rubocop/cop/style/empty_case_condition.rb +2 -7
  321. data/lib/rubocop/cop/style/empty_else.rb +3 -9
  322. data/lib/rubocop/cop/style/empty_literal.rb +13 -8
  323. data/lib/rubocop/cop/style/empty_method.rb +3 -7
  324. data/lib/rubocop/cop/style/end_block.rb +1 -2
  325. data/lib/rubocop/cop/style/endless_method.rb +2 -3
  326. data/lib/rubocop/cop/style/eval_with_location.rb +5 -5
  327. data/lib/rubocop/cop/style/even_odd.rb +1 -0
  328. data/lib/rubocop/cop/style/expand_path_arguments.rb +4 -3
  329. data/lib/rubocop/cop/style/explicit_block_argument.rb +2 -4
  330. data/lib/rubocop/cop/style/float_division.rb +4 -0
  331. data/lib/rubocop/cop/style/format_string.rb +2 -0
  332. data/lib/rubocop/cop/style/format_string_token.rb +2 -4
  333. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +3 -11
  334. data/lib/rubocop/cop/style/global_std_stream.rb +1 -0
  335. data/lib/rubocop/cop/style/guard_clause.rb +3 -7
  336. data/lib/rubocop/cop/style/hash_conversion.rb +57 -5
  337. data/lib/rubocop/cop/style/hash_each_methods.rb +2 -2
  338. data/lib/rubocop/cop/style/hash_except.rb +1 -0
  339. data/lib/rubocop/cop/style/hash_like_case.rb +2 -2
  340. data/lib/rubocop/cop/style/hash_syntax.rb +20 -24
  341. data/lib/rubocop/cop/style/hash_transform_keys.rb +4 -0
  342. data/lib/rubocop/cop/style/hash_transform_values.rb +4 -0
  343. data/lib/rubocop/cop/style/identical_conditional_branches.rb +1 -3
  344. data/lib/rubocop/cop/style/if_unless_modifier.rb +40 -13
  345. data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +2 -0
  346. data/lib/rubocop/cop/style/implicit_runtime_error.rb +1 -0
  347. data/lib/rubocop/cop/style/infinite_loop.rb +2 -5
  348. data/lib/rubocop/cop/style/inverse_methods.rb +5 -7
  349. data/lib/rubocop/cop/style/ip_addresses.rb +1 -2
  350. data/lib/rubocop/cop/style/lambda.rb +2 -4
  351. data/lib/rubocop/cop/style/lambda_call.rb +1 -2
  352. data/lib/rubocop/cop/style/line_end_concatenation.rb +5 -12
  353. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +47 -3
  354. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +26 -16
  355. data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +1 -2
  356. data/lib/rubocop/cop/style/method_called_on_do_end_block.rb +2 -4
  357. data/lib/rubocop/cop/style/method_def_parentheses.rb +4 -8
  358. data/lib/rubocop/cop/style/min_max.rb +2 -2
  359. data/lib/rubocop/cop/style/missing_else.rb +2 -4
  360. data/lib/rubocop/cop/style/missing_respond_to_missing.rb +1 -2
  361. data/lib/rubocop/cop/style/mixin_grouping.rb +4 -10
  362. data/lib/rubocop/cop/style/mixin_usage.rb +3 -2
  363. data/lib/rubocop/cop/style/module_function.rb +8 -6
  364. data/lib/rubocop/cop/style/multiline_block_chain.rb +1 -2
  365. data/lib/rubocop/cop/style/multiline_method_signature.rb +11 -6
  366. data/lib/rubocop/cop/style/multiline_ternary_operator.rb +1 -2
  367. data/lib/rubocop/cop/style/multiple_comparison.rb +22 -5
  368. data/lib/rubocop/cop/style/mutable_constant.rb +7 -10
  369. data/lib/rubocop/cop/style/negated_if.rb +1 -2
  370. data/lib/rubocop/cop/style/negated_if_else_condition.rb +24 -2
  371. data/lib/rubocop/cop/style/negated_unless.rb +1 -2
  372. data/lib/rubocop/cop/style/nested_modifier.rb +3 -7
  373. data/lib/rubocop/cop/style/nested_ternary_operator.rb +2 -3
  374. data/lib/rubocop/cop/style/next.rb +4 -9
  375. data/lib/rubocop/cop/style/nil_comparison.rb +3 -0
  376. data/lib/rubocop/cop/style/nil_lambda.rb +1 -0
  377. data/lib/rubocop/cop/style/non_nil_check.rb +9 -5
  378. data/lib/rubocop/cop/style/numeric_literals.rb +3 -11
  379. data/lib/rubocop/cop/style/numeric_predicate.rb +5 -7
  380. data/lib/rubocop/cop/style/one_line_conditional.rb +1 -2
  381. data/lib/rubocop/cop/style/option_hash.rb +2 -3
  382. data/lib/rubocop/cop/style/optional_arguments.rb +2 -5
  383. data/lib/rubocop/cop/style/or_assignment.rb +4 -6
  384. data/lib/rubocop/cop/style/parallel_assignment.rb +12 -9
  385. data/lib/rubocop/cop/style/parentheses_around_condition.rb +1 -0
  386. data/lib/rubocop/cop/style/percent_literal_delimiters.rb +1 -3
  387. data/lib/rubocop/cop/style/percent_q_literals.rb +1 -2
  388. data/lib/rubocop/cop/style/perl_backrefs.rb +2 -9
  389. data/lib/rubocop/cop/style/preferred_hash_methods.rb +1 -4
  390. data/lib/rubocop/cop/style/proc.rb +2 -2
  391. data/lib/rubocop/cop/style/raise_args.rb +4 -8
  392. data/lib/rubocop/cop/style/random_with_offset.rb +8 -8
  393. data/lib/rubocop/cop/style/redundant_argument.rb +2 -11
  394. data/lib/rubocop/cop/style/redundant_assignment.rb +2 -3
  395. data/lib/rubocop/cop/style/redundant_begin.rb +47 -7
  396. data/lib/rubocop/cop/style/redundant_capital_w.rb +1 -2
  397. data/lib/rubocop/cop/style/redundant_condition.rb +2 -5
  398. data/lib/rubocop/cop/style/redundant_conditional.rb +5 -6
  399. data/lib/rubocop/cop/style/redundant_exception.rb +5 -6
  400. data/lib/rubocop/cop/style/redundant_fetch_block.rb +2 -0
  401. data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +2 -1
  402. data/lib/rubocop/cop/style/redundant_freeze.rb +2 -2
  403. data/lib/rubocop/cop/style/redundant_interpolation.rb +1 -2
  404. data/lib/rubocop/cop/style/redundant_parentheses.rb +21 -20
  405. data/lib/rubocop/cop/style/redundant_percent_q.rb +1 -2
  406. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +1 -4
  407. data/lib/rubocop/cop/style/redundant_return.rb +6 -4
  408. data/lib/rubocop/cop/style/redundant_self.rb +9 -9
  409. data/lib/rubocop/cop/style/redundant_self_assignment.rb +4 -2
  410. data/lib/rubocop/cop/style/redundant_sort.rb +3 -5
  411. data/lib/rubocop/cop/style/redundant_sort_by.rb +1 -0
  412. data/lib/rubocop/cop/style/regexp_literal.rb +4 -8
  413. data/lib/rubocop/cop/style/rescue_modifier.rb +21 -14
  414. data/lib/rubocop/cop/style/rescue_standard_error.rb +5 -7
  415. data/lib/rubocop/cop/style/return_nil.rb +7 -2
  416. data/lib/rubocop/cop/style/safe_navigation.rb +12 -21
  417. data/lib/rubocop/cop/style/sample.rb +1 -0
  418. data/lib/rubocop/cop/style/send.rb +1 -2
  419. data/lib/rubocop/cop/style/signal_exception.rb +6 -7
  420. data/lib/rubocop/cop/style/single_argument_dig.rb +2 -2
  421. data/lib/rubocop/cop/style/single_line_block_params.rb +2 -5
  422. data/lib/rubocop/cop/style/single_line_methods.rb +21 -4
  423. data/lib/rubocop/cop/style/slicing_with_range.rb +1 -0
  424. data/lib/rubocop/cop/style/sole_nested_conditional.rb +31 -7
  425. data/lib/rubocop/cop/style/special_global_vars.rb +6 -18
  426. data/lib/rubocop/cop/style/stabby_lambda_parentheses.rb +1 -2
  427. data/lib/rubocop/cop/style/stderr_puts.rb +3 -6
  428. data/lib/rubocop/cop/style/string_chars.rb +39 -0
  429. data/lib/rubocop/cop/style/string_concatenation.rb +9 -10
  430. data/lib/rubocop/cop/style/string_hash_keys.rb +2 -0
  431. data/lib/rubocop/cop/style/string_literals.rb +2 -5
  432. data/lib/rubocop/cop/style/strip.rb +1 -0
  433. data/lib/rubocop/cop/style/struct_inheritance.rb +11 -0
  434. data/lib/rubocop/cop/style/symbol_literal.rb +1 -3
  435. data/lib/rubocop/cop/style/symbol_proc.rb +29 -10
  436. data/lib/rubocop/cop/style/ternary_parentheses.rb +4 -6
  437. data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb +6 -2
  438. data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +2 -6
  439. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +3 -6
  440. data/lib/rubocop/cop/style/trailing_underscore_variable.rb +4 -10
  441. data/lib/rubocop/cop/style/trivial_accessors.rb +3 -4
  442. data/lib/rubocop/cop/style/unless_else.rb +1 -2
  443. data/lib/rubocop/cop/style/unless_logical_operators.rb +105 -0
  444. data/lib/rubocop/cop/style/unpack_first.rb +1 -0
  445. data/lib/rubocop/cop/style/variable_interpolation.rb +1 -1
  446. data/lib/rubocop/cop/style/when_then.rb +1 -3
  447. data/lib/rubocop/cop/style/while_until_modifier.rb +1 -2
  448. data/lib/rubocop/cop/style/word_array.rb +1 -2
  449. data/lib/rubocop/cop/style/yoda_condition.rb +4 -11
  450. data/lib/rubocop/cop/style/zero_length_predicate.rb +6 -2
  451. data/lib/rubocop/cop/team.rb +2 -5
  452. data/lib/rubocop/cop/util.rb +8 -11
  453. data/lib/rubocop/cop/utils/format_string.rb +1 -3
  454. data/lib/rubocop/cop/variable_force.rb +6 -15
  455. data/lib/rubocop/cop/variable_force/assignment.rb +1 -2
  456. data/lib/rubocop/cop/variable_force/branch.rb +16 -2
  457. data/lib/rubocop/cop/variable_force/reference.rb +1 -3
  458. data/lib/rubocop/cop/variable_force/scope.rb +4 -8
  459. data/lib/rubocop/cop/variable_force/variable.rb +2 -4
  460. data/lib/rubocop/cops_documentation_generator.rb +7 -21
  461. data/lib/rubocop/directive_comment.rb +69 -9
  462. data/lib/rubocop/ext/regexp_parser.rb +3 -6
  463. data/lib/rubocop/file_finder.rb +1 -3
  464. data/lib/rubocop/formatter/clang_style_formatter.rb +4 -2
  465. data/lib/rubocop/formatter/disabled_config_formatter.rb +3 -8
  466. data/lib/rubocop/formatter/git_hub_actions_formatter.rb +1 -5
  467. data/lib/rubocop/formatter/html_formatter.rb +4 -10
  468. data/lib/rubocop/formatter/json_formatter.rb +1 -5
  469. data/lib/rubocop/formatter/junit_formatter.rb +3 -9
  470. data/lib/rubocop/formatter/progress_formatter.rb +1 -3
  471. data/lib/rubocop/formatter/tap_formatter.rb +4 -2
  472. data/lib/rubocop/magic_comment.rb +1 -1
  473. data/lib/rubocop/name_similarity.rb +1 -1
  474. data/lib/rubocop/options.rb +27 -41
  475. data/lib/rubocop/path_util.rb +1 -3
  476. data/lib/rubocop/rake_task.rb +3 -0
  477. data/lib/rubocop/remote_config.rb +4 -7
  478. data/lib/rubocop/result_cache.rb +5 -12
  479. data/lib/rubocop/rspec/cop_helper.rb +1 -1
  480. data/lib/rubocop/rspec/expect_offense.rb +4 -9
  481. data/lib/rubocop/rspec/shared_contexts.rb +8 -15
  482. data/lib/rubocop/runner.rb +7 -14
  483. data/lib/rubocop/target_finder.rb +19 -16
  484. data/lib/rubocop/target_ruby.rb +25 -21
  485. data/lib/rubocop/version.rb +1 -1
  486. metadata +18 -11
  487. data/lib/rubocop/core_ext/hash.rb +0 -20
@@ -75,8 +75,9 @@ module RuboCop
75
75
  private
76
76
 
77
77
  def collection_looping_method?(node)
78
- method_name = node.send_node.method_name
79
- method_name.match?(/^each/) || method_name.match?(/_each$/)
78
+ # TODO: Remove `Symbol#to_s` after supporting only Ruby >= 2.7.
79
+ method_name = node.send_node.method_name.to_s
80
+ method_name.start_with?('each') || method_name.end_with?('_each')
80
81
  end
81
82
 
82
83
  def same_collection_looping?(node, sibling)
@@ -97,17 +97,13 @@ module RuboCop
97
97
  def check_backtick_literal(node, message)
98
98
  return if allowed_backtick_literal?(node)
99
99
 
100
- add_offense(node, message: message) do |corrector|
101
- autocorrect(corrector, node)
102
- end
100
+ add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
103
101
  end
104
102
 
105
103
  def check_percent_x_literal(node, message)
106
104
  return if allowed_percent_x_literal?(node)
107
105
 
108
- add_offense(node, message: message) do |corrector|
109
- autocorrect(corrector, node)
110
- end
106
+ add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
111
107
  end
112
108
 
113
109
  def autocorrect(corrector, node)
@@ -165,7 +161,7 @@ module RuboCop
165
161
  end
166
162
 
167
163
  def preferred_delimiter
168
- (command_delimiter || default_delimiter).split(//)
164
+ (command_delimiter || default_delimiter).chars
169
165
  end
170
166
 
171
167
  def command_delimiter
@@ -177,8 +173,7 @@ module RuboCop
177
173
  end
178
174
 
179
175
  def preferred_delimiters_config
180
- config.for_cop('Style/PercentLiteralDelimiters') \
181
- ['PreferredDelimiters']
176
+ config.for_cop('Style/PercentLiteralDelimiters') ['PreferredDelimiters']
182
177
  end
183
178
  end
184
179
  end
@@ -44,8 +44,7 @@ module RuboCop
44
44
  MSG = 'Annotation keywords like `%<keyword>s` should be all ' \
45
45
  'upper case, followed by a colon, and a space, ' \
46
46
  'then a note describing the problem.'
47
- MISSING_NOTE = 'Annotation comment, with keyword `%<keyword>s`, ' \
48
- 'is missing a note.'
47
+ MISSING_NOTE = 'Annotation comment, with keyword `%<keyword>s`, is missing a note.'
49
48
 
50
49
  def on_new_investigation
51
50
  processed_source.comments.each_with_index do |comment, index|
@@ -53,8 +52,7 @@ module RuboCop
53
52
  inline_comment?(comment)
54
53
 
55
54
  margin, first_word, colon, space, note = split_comment(comment)
56
- next unless annotation?(comment) &&
57
- !correct_annotation?(first_word, colon, space, note)
55
+ next unless annotation?(comment) && !correct_annotation?(first_word, colon, space, note)
58
56
 
59
57
  range = annotation_range(comment, margin, first_word, colon, space)
60
58
 
@@ -76,8 +74,7 @@ module RuboCop
76
74
  end
77
75
 
78
76
  def first_comment_line?(comments, index)
79
- index.zero? ||
80
- comments[index - 1].loc.line < comments[index].loc.line - 1
77
+ index.zero? || comments[index - 1].loc.line < comments[index].loc.line - 1
81
78
  end
82
79
 
83
80
  def inline_comment?(comment)
@@ -40,8 +40,13 @@ module RuboCop
40
40
  include RangeHelp
41
41
  extend AutoCorrector
42
42
 
43
- MSG = 'Do not place comments on the same line as the ' \
44
- '`%<keyword>s` keyword.'
43
+ MSG = 'Do not place comments on the same line as the `%<keyword>s` keyword.'
44
+
45
+ KEYWORDS = %w[begin class def end module].freeze
46
+ KEYWORD_REGEXES = KEYWORDS.map { |w| /^\s*#{w}\s/ }.freeze
47
+
48
+ ALLOWED_COMMENTS = %w[:nodoc: :yields: rubocop:disable rubocop:todo].freeze
49
+ ALLOWED_COMMENT_REGEXES = ALLOWED_COMMENTS.map { |c| /#\s*#{c}/ }.freeze
45
50
 
46
51
  def on_new_investigation
47
52
  processed_source.comments.each do |comment|
@@ -53,17 +58,6 @@ module RuboCop
53
58
 
54
59
  private
55
60
 
56
- KEYWORDS = %w[begin class def end module].freeze
57
- KEYWORD_REGEXES = KEYWORDS.map { |w| /^\s*#{w}\s/ }.freeze
58
-
59
- ALLOWED_COMMENTS = %w[
60
- :nodoc:
61
- :yields:
62
- rubocop:disable
63
- rubocop:todo
64
- ].freeze
65
- ALLOWED_COMMENT_REGEXES = ALLOWED_COMMENTS.map { |c| /#\s*#{c}/ }.freeze
66
-
67
61
  def register_offense(comment, matched_keyword)
68
62
  add_offense(comment, message: format(MSG, keyword: matched_keyword)) do |corrector|
69
63
  range = range_with_surrounding_space(range: comment.loc.expression, newlines: false)
@@ -103,8 +103,7 @@ module RuboCop
103
103
  end
104
104
 
105
105
  def setter_method?(method_name)
106
- method_name.to_s.end_with?(EQUAL) &&
107
- !%i[!= == === >= <=].include?(method_name)
106
+ method_name.to_s.end_with?(EQUAL) && !%i[!= == === >= <=].include?(method_name)
108
107
  end
109
108
 
110
109
  def assignment_rhs_exist?(node)
@@ -214,14 +213,10 @@ module RuboCop
214
213
  include IgnoredNode
215
214
  extend AutoCorrector
216
215
 
217
- MSG = 'Use the return of the conditional for variable assignment ' \
218
- 'and comparison.'
219
- ASSIGN_TO_CONDITION_MSG =
220
- 'Assign variables inside of conditionals'
221
- VARIABLE_ASSIGNMENT_TYPES =
222
- %i[casgn cvasgn gvasgn ivasgn lvasgn].freeze
223
- ASSIGNMENT_TYPES = VARIABLE_ASSIGNMENT_TYPES +
224
- %i[and_asgn or_asgn op_asgn masgn].freeze
216
+ MSG = 'Use the return of the conditional for variable assignment and comparison.'
217
+ ASSIGN_TO_CONDITION_MSG = 'Assign variables inside of conditionals'
218
+ VARIABLE_ASSIGNMENT_TYPES = %i[casgn cvasgn gvasgn ivasgn lvasgn].freeze
219
+ ASSIGNMENT_TYPES = VARIABLE_ASSIGNMENT_TYPES + %i[and_asgn or_asgn op_asgn masgn].freeze
225
220
  LINE_LENGTH = 'Layout/LineLength'
226
221
  INDENTATION_WIDTH = 'Layout/IndentationWidth'
227
222
  ENABLED = 'Enabled'
@@ -231,6 +226,7 @@ module RuboCop
231
226
 
232
227
  # The shovel operator `<<` does not have its own type. It is a `send`
233
228
  # type.
229
+ # @!method assignment_type?(node)
234
230
  def_node_matcher :assignment_type?, <<~PATTERN
235
231
  {
236
232
  #{ASSIGNMENT_TYPES.join(' ')}
@@ -300,6 +296,7 @@ module RuboCop
300
296
  style == :assign_inside_condition && assignment_rhs_exist?(node)
301
297
  end
302
298
 
299
+ # @!method candidate_condition?(node)
303
300
  def_node_matcher :candidate_condition?, '[{if case} !#allowed_ternary?]'
304
301
 
305
302
  def allowed_ternary?(assignment)
@@ -366,9 +363,7 @@ module RuboCop
366
363
  return if allowed_single_line?(branches)
367
364
  return if correction_exceeds_line_limit?(node, branches)
368
365
 
369
- add_offense(node) do |corrector|
370
- autocorrect(corrector, node)
371
- end
366
+ add_offense(node) { |corrector| autocorrect(corrector, node) }
372
367
  end
373
368
 
374
369
  def autocorrect(corrector, node)
@@ -409,9 +404,7 @@ module RuboCop
409
404
 
410
405
  def longest_line(node, assignment)
411
406
  assignment_regex = /\s*#{Regexp.escape(assignment).gsub('\ ', '\s*')}/
412
- lines = node.source.lines.map do |line|
413
- line.chomp.sub(assignment_regex, '')
414
- end
407
+ lines = node.source.lines.map { |line| line.chomp.sub(assignment_regex, '') }
415
408
  longest_line = lines.max_by(&:length)
416
409
  assignment + longest_line
417
410
  end
@@ -455,9 +448,7 @@ module RuboCop
455
448
  expression = node.loc.expression
456
449
  begin_pos = expression.begin_pos - (expression.column - column - 2)
457
450
 
458
- Parser::Source::Range.new(expression.source_buffer,
459
- begin_pos,
460
- expression.begin_pos)
451
+ Parser::Source::Range.new(expression.source_buffer, begin_pos, expression.begin_pos)
461
452
  end
462
453
 
463
454
  def assignment(node)
@@ -530,9 +521,7 @@ module RuboCop
530
521
  _variable, *_operator, if_rhs = *node.if_branch
531
522
  _else_variable, *_operator, else_rhs = *node.else_branch
532
523
 
533
- expr = "#{node.condition.source} ? " \
534
- "#{if_rhs.source} : " \
535
- "#{else_rhs.source}"
524
+ expr = "#{node.condition.source} ? #{if_rhs.source} : #{else_rhs.source}"
536
525
 
537
526
  element_assignment?(node.if_branch) ? "(#{expr})" : expr
538
527
  end
@@ -594,8 +583,7 @@ module RuboCop
594
583
  def move_branch_inside_condition(corrector, branch, condition,
595
584
  assignment, column)
596
585
  branch_assignment = tail(branch)
597
- corrector.insert_before(branch_assignment,
598
- assignment.source)
586
+ corrector.insert_before(branch_assignment, assignment.source)
599
587
 
600
588
  remove_whitespace_in_branches(corrector, branch, condition, column)
601
589
 
@@ -92,6 +92,7 @@ module RuboCop
92
92
  end
93
93
  end
94
94
 
95
+ # @!method visibility_declaration_for?(node, const_name)
95
96
  def_node_matcher :visibility_declaration_for?, <<~PATTERN
96
97
  (send nil? {:public_constant :private_constant} ({sym str} #match_name?(%1)))
97
98
  PATTERN
@@ -19,10 +19,8 @@ module RuboCop
19
19
  include RangeHelp
20
20
  extend AutoCorrector
21
21
 
22
- MSG = 'Include a copyright notice matching /%<notice>s/ before ' \
23
- 'any code.'
24
- AUTOCORRECT_EMPTY_WARNING = 'An AutocorrectNotice must be defined in ' \
25
- 'your RuboCop config'
22
+ MSG = 'Include a copyright notice matching /%<notice>s/ before any code.'
23
+ AUTOCORRECT_EMPTY_WARNING = 'An AutocorrectNotice must be defined in your RuboCop config'
26
24
 
27
25
  def on_new_investigation
28
26
  return if notice.empty? || notice_found?(processed_source)
@@ -57,8 +55,7 @@ module RuboCop
57
55
  regex = Regexp.new(notice)
58
56
  return if autocorrect_notice&.match?(regex)
59
57
 
60
- raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must " \
61
- "match Notice /#{notice}/"
58
+ raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must match Notice /#{notice}/"
62
59
  end
63
60
 
64
61
  def insert_notice_before(processed_source)
@@ -47,28 +47,28 @@ module RuboCop
47
47
  CLASS_MSG = 'Prefer Time over DateTime.'
48
48
  COERCION_MSG = 'Do not use #to_datetime.'
49
49
 
50
+ # @!method date_time?(node)
50
51
  def_node_matcher :date_time?, <<~PATTERN
51
52
  (send (const {nil? (cbase)} :DateTime) ...)
52
53
  PATTERN
53
54
 
55
+ # @!method historic_date?(node)
54
56
  def_node_matcher :historic_date?, <<~PATTERN
55
57
  (send _ _ _ (const (const {nil? (cbase)} :Date) _))
56
58
  PATTERN
57
59
 
60
+ # @!method to_datetime?(node)
58
61
  def_node_matcher :to_datetime?, <<~PATTERN
59
62
  (send _ :to_datetime)
60
63
  PATTERN
61
64
 
62
65
  def on_send(node)
63
- return unless date_time?(node) ||
64
- (to_datetime?(node) && disallow_coercion?)
66
+ return unless date_time?(node) || (to_datetime?(node) && disallow_coercion?)
65
67
  return if historic_date?(node)
66
68
 
67
69
  message = to_datetime?(node) ? COERCION_MSG : CLASS_MSG
68
70
 
69
- add_offense(node, message: message) do |corrector|
70
- autocorrect(corrector, node)
71
- end
71
+ add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
72
72
  end
73
73
 
74
74
  private
@@ -36,8 +36,7 @@ module RuboCop
36
36
  class DefWithParentheses < Base
37
37
  extend AutoCorrector
38
38
 
39
- MSG = "Omit the parentheses in defs when the method doesn't accept " \
40
- 'any arguments.'
39
+ MSG = "Omit the parentheses in defs when the method doesn't accept any arguments."
41
40
 
42
41
  def on_def(node)
43
42
  return if node.single_line?
@@ -22,6 +22,7 @@ module RuboCop
22
22
  MSG = "Use `__dir__` to get an absolute path to the current file's directory."
23
23
  RESTRICT_ON_SEND = %i[expand_path dirname].freeze
24
24
 
25
+ # @!method dir_replacement?(node)
25
26
  def_node_matcher :dir_replacement?, <<~PATTERN
26
27
  {(send (const {nil? cbase} :File) :expand_path (send (const {nil? cbase} :File) :dirname #file_keyword?))
27
28
  (send (const {nil? cbase} :File) :dirname (send (const {nil? cbase} :File) :realpath #file_keyword?))}
@@ -70,8 +70,8 @@ module RuboCop
70
70
  end
71
71
 
72
72
  def directive_cops(comment)
73
- match = CommentConfig::COMMENT_DIRECTIVE_REGEXP.match(comment.text)
74
- match && match[2] ? match[2].split(',').map(&:strip) : []
73
+ match_captures = DirectiveComment.new(comment).match_captures
74
+ match_captures && match_captures[1] ? match_captures[1].split(',').map(&:strip) : []
75
75
  end
76
76
 
77
77
  def allowed_cops
@@ -60,13 +60,27 @@ module RuboCop
60
60
  # extend Foo
61
61
  # end
62
62
  #
63
+ # @example AllowedConstants: ['ClassMethods']
64
+ #
65
+ # # good
66
+ # module A
67
+ # module ClassMethods
68
+ # # ...
69
+ # end
70
+ # end
71
+ #
63
72
  class Documentation < Base
64
73
  include DocumentationComment
65
74
 
66
75
  MSG = 'Missing top-level %<type>s documentation comment.'
67
76
 
77
+ # @!method constant_definition?(node)
68
78
  def_node_matcher :constant_definition?, '{class module casgn}'
79
+
80
+ # @!method outer_module(node)
69
81
  def_node_search :outer_module, '(const (const nil? _) _)'
82
+
83
+ # @!method constant_visibility_declaration?(node)
70
84
  def_node_matcher :constant_visibility_declaration?, <<~PATTERN
71
85
  (send nil? {:public_constant :private_constant} ({sym str} _))
72
86
  PATTERN
@@ -85,14 +99,19 @@ module RuboCop
85
99
 
86
100
  def check(node, body, type)
87
101
  return if namespace?(body)
88
- return if documentation_comment?(node) || nodoc_comment?(node)
89
- return if compact_namespace?(node) &&
90
- nodoc_comment?(outer_module(node).first)
102
+ return if documentation_comment?(node)
103
+ return if constant_allowed?(node)
104
+ return if nodoc_self_or_outer_module?(node)
91
105
  return if macro_only?(body)
92
106
 
93
107
  add_offense(node.loc.keyword, message: format(MSG, type: type))
94
108
  end
95
109
 
110
+ def nodoc_self_or_outer_module?(node)
111
+ nodoc_comment?(node) ||
112
+ compact_namespace?(node) && nodoc_comment?(outer_module(node).first)
113
+ end
114
+
96
115
  def macro_only?(body)
97
116
  body.respond_to?(:macro?) && body.macro? ||
98
117
  body.respond_to?(:children) && body.children&.all? { |child| macro_only?(child) }
@@ -112,6 +131,10 @@ module RuboCop
112
131
  constant_definition?(node) || constant_visibility_declaration?(node)
113
132
  end
114
133
 
134
+ def constant_allowed?(node)
135
+ allowed_constants.include?(node.identifier.short_name)
136
+ end
137
+
115
138
  def compact_namespace?(node)
116
139
  /::/.match?(node.loc.name.source)
117
140
  end
@@ -138,6 +161,10 @@ module RuboCop
138
161
  def nodoc(node)
139
162
  processed_source.ast_with_comments[node.children.first].first
140
163
  end
164
+
165
+ def allowed_constants
166
+ @allowed_constants ||= cop_config.fetch('AllowedConstants', []).map(&:intern)
167
+ end
141
168
  end
142
169
  end
143
170
  end
@@ -97,6 +97,7 @@ module RuboCop
97
97
 
98
98
  MSG = 'Missing method documentation comment.'
99
99
 
100
+ # @!method module_function_node?(node)
100
101
  def_node_matcher :module_function_node?, <<~PATTERN
101
102
  (send nil? :module_function ...)
102
103
  PATTERN
@@ -39,6 +39,7 @@ module RuboCop
39
39
  MSG = 'Avoid the use of double negation (`!!`).'
40
40
  RESTRICT_ON_SEND = %i[!].freeze
41
41
 
42
+ # @!method double_negative?(node)
42
43
  def_node_matcher :double_negative?, '(send (send _ :!) :!)'
43
44
 
44
45
  def on_send(node)
@@ -25,8 +25,7 @@ module RuboCop
25
25
  class EachForSimpleLoop < Base
26
26
  extend AutoCorrector
27
27
 
28
- MSG = 'Use `Integer#times` for a simple loop which iterates a fixed ' \
29
- 'number of times.'
28
+ MSG = 'Use `Integer#times` for a simple loop which iterates a fixed number of times.'
30
29
 
31
30
  def on_block(node)
32
31
  return unless offending_each_range(node)
@@ -46,6 +45,7 @@ module RuboCop
46
45
 
47
46
  private
48
47
 
48
+ # @!method offending_each_range(node)
49
49
  def_node_matcher :offending_each_range, <<~PATTERN
50
50
  (block (send (begin (${irange erange} (int $_) (int $_))) :each) (args) ...)
51
51
  PATTERN
@@ -23,6 +23,7 @@ module RuboCop
23
23
  MSG = 'Use `each_with_object` instead of `%<method>s`.'
24
24
  METHODS = %i[inject reduce].freeze
25
25
 
26
+ # @!method each_with_object_candidate?(node)
26
27
  def_node_matcher :each_with_object_candidate?, <<~PATTERN
27
28
  (block $(send _ {:inject :reduce} _) $_ $_)
28
29
  PATTERN
@@ -44,19 +44,14 @@ module RuboCop
44
44
  def on_case(case_node)
45
45
  return if case_node.condition
46
46
 
47
- branch_bodies = [
48
- *case_node.when_branches.map(&:body),
49
- case_node.else_branch
50
- ].compact
47
+ branch_bodies = [*case_node.when_branches.map(&:body), case_node.else_branch].compact
51
48
 
52
49
  return if branch_bodies.any? do |body|
53
50
  body.return_type? ||
54
51
  body.each_descendant.any?(&:return_type?)
55
52
  end
56
53
 
57
- add_offense(case_node.loc.keyword) do |corrector|
58
- autocorrect(corrector, case_node)
59
- end
54
+ add_offense(case_node.loc.keyword) { |corrector| autocorrect(corrector, case_node) }
60
55
  end
61
56
 
62
57
  private