rubocop 0.75.1 → 0.93.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (647) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.txt +1 -1
  3. data/README.md +31 -23
  4. data/bin/rubocop-profile +32 -0
  5. data/config/default.yml +940 -401
  6. data/lib/rubocop.rb +130 -94
  7. data/lib/rubocop/ast_aliases.rb +8 -0
  8. data/lib/rubocop/cached_data.rb +3 -1
  9. data/lib/rubocop/cli.rb +20 -232
  10. data/lib/rubocop/cli/command.rb +22 -0
  11. data/lib/rubocop/cli/command/auto_genenerate_config.rb +141 -0
  12. data/lib/rubocop/cli/command/base.rb +35 -0
  13. data/lib/rubocop/cli/command/execute_runner.rb +85 -0
  14. data/lib/rubocop/cli/command/init_dotfile.rb +46 -0
  15. data/lib/rubocop/cli/command/show_cops.rb +77 -0
  16. data/lib/rubocop/cli/command/version.rb +18 -0
  17. data/lib/rubocop/cli/environment.rb +22 -0
  18. data/lib/rubocop/comment_config.rb +26 -14
  19. data/lib/rubocop/config.rb +68 -14
  20. data/lib/rubocop/config_loader.rb +89 -102
  21. data/lib/rubocop/config_loader_resolver.rb +51 -10
  22. data/lib/rubocop/config_obsoletion.rb +81 -11
  23. data/lib/rubocop/config_regeneration.rb +33 -0
  24. data/lib/rubocop/config_store.rb +19 -5
  25. data/lib/rubocop/config_validator.rb +98 -113
  26. data/lib/rubocop/cop/autocorrect_logic.rb +21 -29
  27. data/lib/rubocop/cop/badge.rb +6 -6
  28. data/lib/rubocop/cop/base.rb +430 -0
  29. data/lib/rubocop/cop/bundler/duplicated_gem.rb +5 -1
  30. data/lib/rubocop/cop/bundler/gem_comment.rb +82 -8
  31. data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +14 -22
  32. data/lib/rubocop/cop/commissioner.rb +84 -60
  33. data/lib/rubocop/cop/cop.rb +91 -202
  34. data/lib/rubocop/cop/corrector.rb +69 -121
  35. data/lib/rubocop/cop/correctors/alignment_corrector.rb +7 -11
  36. data/lib/rubocop/cop/correctors/condition_corrector.rb +3 -6
  37. data/lib/rubocop/cop/correctors/empty_line_corrector.rb +9 -10
  38. data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb +4 -4
  39. data/lib/rubocop/cop/correctors/line_break_corrector.rb +10 -10
  40. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +34 -3
  41. data/lib/rubocop/cop/correctors/parentheses_corrector.rb +5 -8
  42. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +6 -11
  43. data/lib/rubocop/cop/correctors/punctuation_corrector.rb +8 -10
  44. data/lib/rubocop/cop/correctors/space_corrector.rb +2 -5
  45. data/lib/rubocop/cop/correctors/string_literal_corrector.rb +2 -2
  46. data/lib/rubocop/cop/correctors/unused_arg_corrector.rb +15 -18
  47. data/lib/rubocop/cop/documentation.rb +22 -0
  48. data/lib/rubocop/cop/force.rb +1 -0
  49. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +2 -4
  50. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +42 -16
  51. data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +1 -1
  52. data/lib/rubocop/cop/generator.rb +9 -8
  53. data/lib/rubocop/cop/generator/configuration_injector.rb +5 -5
  54. data/lib/rubocop/cop/ignored_node.rb +1 -3
  55. data/lib/rubocop/cop/internal_affairs.rb +1 -0
  56. data/lib/rubocop/cop/internal_affairs/method_name_equal.rb +52 -0
  57. data/lib/rubocop/cop/internal_affairs/node_destructuring.rb +1 -1
  58. data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +12 -14
  59. data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb +9 -8
  60. data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +11 -7
  61. data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +8 -8
  62. data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +2 -2
  63. data/lib/rubocop/cop/layout/{align_arguments.rb → argument_alignment.rb} +1 -1
  64. data/lib/rubocop/cop/layout/array_alignment.rb +83 -0
  65. data/lib/rubocop/cop/layout/{indent_assignment.rb → assignment_indentation.rb} +1 -1
  66. data/lib/rubocop/cop/layout/begin_end_alignment.rb +77 -0
  67. data/lib/rubocop/cop/layout/block_alignment.rb +24 -20
  68. data/lib/rubocop/cop/layout/block_end_newline.rb +5 -3
  69. data/lib/rubocop/cop/layout/case_indentation.rb +21 -25
  70. data/lib/rubocop/cop/layout/class_structure.rb +35 -70
  71. data/lib/rubocop/cop/layout/closing_heredoc_indentation.rb +4 -6
  72. data/lib/rubocop/cop/layout/comment_indentation.rb +14 -17
  73. data/lib/rubocop/cop/layout/condition_position.rb +16 -8
  74. data/lib/rubocop/cop/layout/def_end_alignment.rb +8 -5
  75. data/lib/rubocop/cop/layout/dot_position.rb +21 -20
  76. data/lib/rubocop/cop/layout/else_alignment.rb +8 -0
  77. data/lib/rubocop/cop/layout/empty_comment.rb +38 -40
  78. data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +21 -18
  79. data/lib/rubocop/cop/layout/empty_line_after_magic_comment.rb +13 -13
  80. data/lib/rubocop/cop/layout/empty_line_after_multiline_condition.rb +136 -0
  81. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +22 -23
  82. data/lib/rubocop/cop/layout/empty_lines.rb +6 -9
  83. data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +20 -20
  84. data/lib/rubocop/cop/layout/empty_lines_around_arguments.rb +7 -8
  85. data/lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb +118 -0
  86. data/lib/rubocop/cop/layout/empty_lines_around_begin_body.rb +2 -5
  87. data/lib/rubocop/cop/layout/empty_lines_around_block_body.rb +2 -5
  88. data/lib/rubocop/cop/layout/empty_lines_around_class_body.rb +2 -5
  89. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +3 -7
  90. data/lib/rubocop/cop/layout/empty_lines_around_method_body.rb +2 -5
  91. data/lib/rubocop/cop/layout/empty_lines_around_module_body.rb +2 -5
  92. data/lib/rubocop/cop/layout/end_alignment.rb +14 -19
  93. data/lib/rubocop/cop/layout/end_of_line.rb +11 -6
  94. data/lib/rubocop/cop/layout/extra_spacing.rb +23 -37
  95. data/lib/rubocop/cop/layout/{indent_first_argument.rb → first_argument_indentation.rb} +17 -13
  96. data/lib/rubocop/cop/layout/{indent_first_array_element.rb → first_array_element_indentation.rb} +18 -14
  97. data/lib/rubocop/cop/layout/first_array_element_line_break.rb +3 -6
  98. data/lib/rubocop/cop/layout/{indent_first_hash_element.rb → first_hash_element_indentation.rb} +5 -5
  99. data/lib/rubocop/cop/layout/first_hash_element_line_break.rb +2 -5
  100. data/lib/rubocop/cop/layout/first_method_argument_line_break.rb +5 -11
  101. data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb +2 -5
  102. data/lib/rubocop/cop/layout/{indent_first_parameter.rb → first_parameter_indentation.rb} +5 -5
  103. data/lib/rubocop/cop/layout/{align_hash.rb → hash_alignment.rb} +39 -35
  104. data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +18 -21
  105. data/lib/rubocop/cop/layout/heredoc_indentation.rb +176 -0
  106. data/lib/rubocop/cop/layout/{tab.rb → indentation_style.rb} +48 -8
  107. data/lib/rubocop/cop/layout/indentation_width.rb +1 -3
  108. data/lib/rubocop/cop/layout/initial_indentation.rb +6 -7
  109. data/lib/rubocop/cop/layout/leading_comment_space.rb +46 -13
  110. data/lib/rubocop/cop/layout/{leading_blank_lines.rb → leading_empty_lines.rb} +6 -11
  111. data/lib/rubocop/cop/{metrics → layout}/line_length.rb +78 -119
  112. data/lib/rubocop/cop/layout/multiline_array_brace_layout.rb +2 -5
  113. data/lib/rubocop/cop/layout/multiline_array_line_breaks.rb +2 -5
  114. data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +11 -15
  115. data/lib/rubocop/cop/layout/multiline_block_layout.rb +50 -29
  116. data/lib/rubocop/cop/layout/multiline_hash_brace_layout.rb +2 -9
  117. data/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb +2 -5
  118. data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +6 -12
  119. data/lib/rubocop/cop/layout/multiline_method_call_brace_layout.rb +2 -5
  120. data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +1 -1
  121. data/lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb +2 -5
  122. data/lib/rubocop/cop/layout/multiline_operation_indentation.rb +13 -4
  123. data/lib/rubocop/cop/layout/{align_parameters.rb → parameter_alignment.rb} +1 -1
  124. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +41 -22
  125. data/lib/rubocop/cop/layout/space_after_colon.rb +12 -8
  126. data/lib/rubocop/cop/layout/space_after_comma.rb +2 -5
  127. data/lib/rubocop/cop/layout/space_after_method_name.rb +5 -6
  128. data/lib/rubocop/cop/layout/space_after_not.rb +9 -11
  129. data/lib/rubocop/cop/layout/space_after_semicolon.rb +2 -5
  130. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +22 -27
  131. data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb +17 -21
  132. data/lib/rubocop/cop/layout/space_around_keyword.rb +31 -20
  133. data/lib/rubocop/cop/layout/space_around_method_call_operator.rb +98 -0
  134. data/lib/rubocop/cop/layout/space_around_operators.rb +82 -21
  135. data/lib/rubocop/cop/layout/space_before_block_braces.rb +54 -22
  136. data/lib/rubocop/cop/layout/space_before_comma.rb +3 -5
  137. data/lib/rubocop/cop/layout/space_before_comment.rb +9 -8
  138. data/lib/rubocop/cop/layout/space_before_first_arg.rb +15 -7
  139. data/lib/rubocop/cop/layout/space_before_semicolon.rb +2 -5
  140. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +17 -23
  141. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +32 -33
  142. data/lib/rubocop/cop/layout/space_inside_array_percent_literal.rb +3 -8
  143. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +16 -19
  144. data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +21 -46
  145. data/lib/rubocop/cop/layout/space_inside_parens.rb +15 -20
  146. data/lib/rubocop/cop/layout/space_inside_percent_literal_delimiters.rb +5 -10
  147. data/lib/rubocop/cop/layout/space_inside_range_literal.rb +9 -18
  148. data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +17 -27
  149. data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +12 -13
  150. data/lib/rubocop/cop/layout/{trailing_blank_lines.rb → trailing_empty_lines.rb} +10 -15
  151. data/lib/rubocop/cop/layout/trailing_whitespace.rb +28 -12
  152. data/lib/rubocop/cop/legacy/corrections_proxy.rb +49 -0
  153. data/lib/rubocop/cop/legacy/corrector.rb +29 -0
  154. data/lib/rubocop/cop/lint/ambiguous_block_association.rb +9 -4
  155. data/lib/rubocop/cop/lint/ambiguous_operator.rb +53 -5
  156. data/lib/rubocop/cop/lint/ambiguous_regexp_literal.rb +35 -6
  157. data/lib/rubocop/cop/lint/assignment_in_condition.rb +2 -2
  158. data/lib/rubocop/cop/lint/big_decimal_new.rb +9 -10
  159. data/lib/rubocop/cop/lint/binary_operator_with_identical_operands.rb +50 -0
  160. data/lib/rubocop/cop/lint/boolean_symbol.rb +22 -2
  161. data/lib/rubocop/cop/lint/circular_argument_reference.rb +1 -1
  162. data/lib/rubocop/cop/lint/constant_definition_in_block.rb +74 -0
  163. data/lib/rubocop/cop/lint/constant_resolution.rb +89 -0
  164. data/lib/rubocop/cop/lint/debugger.rb +8 -3
  165. data/lib/rubocop/cop/lint/deprecated_class_methods.rb +7 -10
  166. data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +141 -0
  167. data/lib/rubocop/cop/lint/disjunctive_assignment_in_constructor.rb +9 -3
  168. data/lib/rubocop/cop/lint/duplicate_case_condition.rb +1 -1
  169. data/lib/rubocop/cop/lint/duplicate_elsif_condition.rb +39 -0
  170. data/lib/rubocop/cop/lint/{duplicated_key.rb → duplicate_hash_key.rb} +1 -1
  171. data/lib/rubocop/cop/lint/duplicate_methods.rb +8 -11
  172. data/lib/rubocop/cop/lint/duplicate_require.rb +46 -0
  173. data/lib/rubocop/cop/lint/duplicate_rescue_exception.rb +47 -0
  174. data/lib/rubocop/cop/lint/each_with_object_argument.rb +3 -2
  175. data/lib/rubocop/cop/lint/else_layout.rb +1 -1
  176. data/lib/rubocop/cop/lint/empty_conditional_body.rb +67 -0
  177. data/lib/rubocop/cop/lint/empty_ensure.rb +5 -5
  178. data/lib/rubocop/cop/lint/empty_expression.rb +2 -2
  179. data/lib/rubocop/cop/lint/empty_file.rb +50 -0
  180. data/lib/rubocop/cop/lint/empty_interpolation.rb +5 -6
  181. data/lib/rubocop/cop/lint/empty_when.rb +31 -8
  182. data/lib/rubocop/cop/lint/ensure_return.rb +29 -14
  183. data/lib/rubocop/cop/lint/erb_new_arguments.rb +21 -19
  184. data/lib/rubocop/cop/lint/flip_flop.rb +1 -1
  185. data/lib/rubocop/cop/lint/float_comparison.rb +93 -0
  186. data/lib/rubocop/cop/lint/float_out_of_range.rb +2 -2
  187. data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +41 -4
  188. data/lib/rubocop/cop/lint/hash_compare_by_identity.rb +37 -0
  189. data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +13 -14
  190. data/lib/rubocop/cop/lint/identity_comparison.rb +51 -0
  191. data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +6 -5
  192. data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +11 -14
  193. data/lib/rubocop/cop/lint/inherit_exception.rb +12 -7
  194. data/lib/rubocop/cop/lint/interpolation_check.rb +21 -5
  195. data/lib/rubocop/cop/lint/literal_as_condition.rb +24 -15
  196. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +7 -7
  197. data/lib/rubocop/cop/lint/loop.rb +30 -7
  198. data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +8 -7
  199. data/lib/rubocop/cop/lint/missing_super.rb +99 -0
  200. data/lib/rubocop/cop/lint/mixed_regexp_capture_types.rb +37 -0
  201. data/lib/rubocop/cop/lint/{multiple_compare.rb → multiple_comparison.rb} +10 -11
  202. data/lib/rubocop/cop/lint/nested_method_definition.rb +17 -23
  203. data/lib/rubocop/cop/lint/nested_percent_literal.rb +2 -2
  204. data/lib/rubocop/cop/lint/next_without_accumulator.rb +1 -1
  205. data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +160 -0
  206. data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +9 -9
  207. data/lib/rubocop/cop/lint/number_conversion.rb +7 -9
  208. data/lib/rubocop/cop/lint/ordered_magic_comments.rb +11 -13
  209. data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +79 -0
  210. data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +33 -12
  211. data/lib/rubocop/cop/lint/percent_string_array.rb +6 -11
  212. data/lib/rubocop/cop/lint/percent_symbol_array.rb +14 -13
  213. data/lib/rubocop/cop/lint/raise_exception.rb +86 -0
  214. data/lib/rubocop/cop/lint/rand_one.rb +3 -2
  215. data/lib/rubocop/cop/lint/{unneeded_cop_disable_directive.rb → redundant_cop_disable_directive.rb} +84 -76
  216. data/lib/rubocop/cop/lint/{unneeded_cop_enable_directive.rb → redundant_cop_enable_directive.rb} +37 -28
  217. data/lib/rubocop/cop/lint/{unneeded_require_statement.rb → redundant_require_statement.rb} +8 -10
  218. data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +78 -0
  219. data/lib/rubocop/cop/lint/{unneeded_splat_expansion.rb → redundant_splat_expansion.rb} +20 -16
  220. data/lib/rubocop/cop/lint/{string_conversion_in_interpolation.rb → redundant_string_coercion.rb} +6 -13
  221. data/lib/rubocop/cop/lint/redundant_with_index.rb +12 -15
  222. data/lib/rubocop/cop/lint/redundant_with_object.rb +12 -15
  223. data/lib/rubocop/cop/lint/regexp_as_condition.rb +6 -2
  224. data/lib/rubocop/cop/lint/require_parentheses.rb +2 -2
  225. data/lib/rubocop/cop/lint/rescue_exception.rb +2 -2
  226. data/lib/rubocop/cop/lint/rescue_type.rb +8 -9
  227. data/lib/rubocop/cop/lint/return_in_void_context.rb +2 -4
  228. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +7 -11
  229. data/lib/rubocop/cop/lint/safe_navigation_consistency.rb +14 -10
  230. data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +10 -2
  231. data/lib/rubocop/cop/lint/script_permission.rb +10 -7
  232. data/lib/rubocop/cop/lint/self_assignment.rb +78 -0
  233. data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +8 -12
  234. data/lib/rubocop/cop/lint/shadowed_argument.rb +3 -3
  235. data/lib/rubocop/cop/lint/shadowed_exception.rb +8 -8
  236. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +7 -7
  237. data/lib/rubocop/cop/lint/struct_new_override.rb +59 -0
  238. data/lib/rubocop/cop/lint/{handle_exceptions.rb → suppressed_exception.rb} +21 -27
  239. data/lib/rubocop/cop/lint/syntax.rb +11 -28
  240. data/lib/rubocop/cop/lint/to_json.rb +20 -11
  241. data/lib/rubocop/cop/lint/top_level_return_with_argument.rb +34 -0
  242. data/lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb +57 -0
  243. data/lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb +4 -4
  244. data/lib/rubocop/cop/lint/unified_integer.rb +4 -8
  245. data/lib/rubocop/cop/lint/unreachable_code.rb +2 -2
  246. data/lib/rubocop/cop/lint/unreachable_loop.rb +171 -0
  247. data/lib/rubocop/cop/lint/unused_block_argument.rb +8 -3
  248. data/lib/rubocop/cop/lint/unused_method_argument.rb +40 -9
  249. data/lib/rubocop/cop/lint/uri_escape_unescape.rb +4 -2
  250. data/lib/rubocop/cop/lint/uri_regexp.rb +12 -47
  251. data/lib/rubocop/cop/lint/useless_access_modifier.rb +87 -39
  252. data/lib/rubocop/cop/lint/useless_assignment.rb +7 -6
  253. data/lib/rubocop/cop/lint/useless_else_without_rescue.rb +7 -11
  254. data/lib/rubocop/cop/lint/useless_method_definition.rb +70 -0
  255. data/lib/rubocop/cop/lint/useless_setter_call.rb +9 -7
  256. data/lib/rubocop/cop/lint/useless_times.rb +106 -0
  257. data/lib/rubocop/cop/lint/void.rb +7 -11
  258. data/lib/rubocop/cop/metrics/abc_size.rb +2 -2
  259. data/lib/rubocop/cop/metrics/block_length.rb +27 -3
  260. data/lib/rubocop/cop/metrics/block_nesting.rb +2 -2
  261. data/lib/rubocop/cop/metrics/class_length.rb +39 -8
  262. data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +37 -4
  263. data/lib/rubocop/cop/metrics/method_length.rb +26 -3
  264. data/lib/rubocop/cop/metrics/module_length.rb +26 -3
  265. data/lib/rubocop/cop/metrics/parameter_lists.rb +2 -6
  266. data/lib/rubocop/cop/metrics/perceived_complexity.rb +7 -8
  267. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +80 -9
  268. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +158 -0
  269. data/lib/rubocop/cop/metrics/utils/iterating_block.rb +61 -0
  270. data/lib/rubocop/cop/metrics/utils/repeated_csend_discount.rb +37 -0
  271. data/lib/rubocop/cop/migration/department_name.rb +55 -16
  272. data/lib/rubocop/cop/mixin/alignment.rb +7 -5
  273. data/lib/rubocop/cop/mixin/allowed_methods.rb +21 -0
  274. data/lib/rubocop/cop/mixin/annotation_comment.rb +5 -0
  275. data/lib/rubocop/cop/mixin/array_min_size.rb +2 -4
  276. data/lib/rubocop/cop/mixin/auto_corrector.rb +12 -0
  277. data/lib/rubocop/cop/mixin/check_line_breakable.rb +19 -16
  278. data/lib/rubocop/cop/mixin/code_length.rb +26 -5
  279. data/lib/rubocop/cop/mixin/comments_help.rb +48 -0
  280. data/lib/rubocop/cop/mixin/configurable_enforced_style.rb +5 -3
  281. data/lib/rubocop/cop/mixin/configurable_formatting.rb +3 -5
  282. data/lib/rubocop/cop/mixin/configurable_naming.rb +2 -2
  283. data/lib/rubocop/cop/mixin/configurable_numbering.rb +3 -3
  284. data/lib/rubocop/cop/mixin/documentation_comment.rb +2 -2
  285. data/lib/rubocop/cop/mixin/empty_lines_around_body.rb +8 -7
  286. data/lib/rubocop/cop/mixin/empty_parameter.rb +3 -1
  287. data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +18 -2
  288. data/lib/rubocop/cop/mixin/enforce_superclass.rb +3 -1
  289. data/lib/rubocop/cop/mixin/first_element_line_break.rb +4 -2
  290. data/lib/rubocop/cop/mixin/frozen_string_literal.rb +14 -5
  291. data/lib/rubocop/cop/mixin/{hash_alignment.rb → hash_alignment_styles.rb} +1 -1
  292. data/lib/rubocop/cop/mixin/hash_transform_method.rb +197 -0
  293. data/lib/rubocop/cop/mixin/ignored_pattern.rb +1 -1
  294. data/lib/rubocop/cop/mixin/line_length_help.rb +87 -0
  295. data/lib/rubocop/cop/mixin/method_complexity.rb +17 -3
  296. data/lib/rubocop/cop/mixin/multiline_element_line_breaks.rb +3 -1
  297. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +1 -1
  298. data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb +13 -12
  299. data/lib/rubocop/cop/mixin/negative_conditional.rb +2 -2
  300. data/lib/rubocop/cop/mixin/nil_methods.rb +4 -6
  301. data/lib/rubocop/cop/mixin/ordered_gem_node.rb +6 -1
  302. data/lib/rubocop/cop/mixin/parentheses.rb +1 -2
  303. data/lib/rubocop/cop/mixin/percent_array.rb +16 -9
  304. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +1 -1
  305. data/lib/rubocop/cop/mixin/range_help.rb +19 -5
  306. data/lib/rubocop/cop/mixin/rational_literal.rb +18 -0
  307. data/lib/rubocop/cop/mixin/rescue_node.rb +11 -1
  308. data/lib/rubocop/cop/mixin/space_after_punctuation.rb +4 -3
  309. data/lib/rubocop/cop/mixin/space_before_punctuation.rb +4 -3
  310. data/lib/rubocop/cop/mixin/statement_modifier.rb +46 -23
  311. data/lib/rubocop/cop/mixin/string_literals_help.rb +1 -1
  312. data/lib/rubocop/cop/mixin/surrounding_space.rb +15 -31
  313. data/lib/rubocop/cop/mixin/target_ruby_version.rb +5 -1
  314. data/lib/rubocop/cop/mixin/trailing_comma.rb +27 -33
  315. data/lib/rubocop/cop/mixin/uncommunicative_name.rb +13 -18
  316. data/lib/rubocop/cop/mixin/unused_argument.rb +4 -6
  317. data/lib/rubocop/cop/mixin/visibility_help.rb +38 -0
  318. data/lib/rubocop/cop/naming/accessor_method_name.rb +4 -2
  319. data/lib/rubocop/cop/naming/ascii_identifiers.rb +29 -6
  320. data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +4 -4
  321. data/lib/rubocop/cop/naming/{uncommunicative_block_param_name.rb → block_parameter_name.rb} +3 -3
  322. data/lib/rubocop/cop/naming/class_and_module_camel_case.rb +13 -3
  323. data/lib/rubocop/cop/naming/constant_name.rb +3 -2
  324. data/lib/rubocop/cop/naming/file_name.rb +40 -22
  325. data/lib/rubocop/cop/naming/heredoc_delimiter_case.rb +2 -2
  326. data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb +8 -8
  327. data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +3 -3
  328. data/lib/rubocop/cop/naming/method_name.rb +27 -1
  329. data/lib/rubocop/cop/naming/{uncommunicative_method_param_name.rb → method_parameter_name.rb} +3 -3
  330. data/lib/rubocop/cop/naming/predicate_name.rb +10 -14
  331. data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +13 -12
  332. data/lib/rubocop/cop/naming/variable_name.rb +1 -1
  333. data/lib/rubocop/cop/naming/variable_number.rb +1 -1
  334. data/lib/rubocop/cop/offense.rb +41 -2
  335. data/lib/rubocop/cop/registry.rb +80 -15
  336. data/lib/rubocop/cop/security/eval.rb +3 -2
  337. data/lib/rubocop/cop/security/json_load.rb +7 -8
  338. data/lib/rubocop/cop/security/marshal_load.rb +3 -4
  339. data/lib/rubocop/cop/security/open.rb +3 -2
  340. data/lib/rubocop/cop/security/yaml_load.rb +7 -6
  341. data/lib/rubocop/cop/severity.rb +1 -11
  342. data/lib/rubocop/cop/style/access_modifier_declarations.rb +36 -13
  343. data/lib/rubocop/cop/style/accessor_grouping.rb +152 -0
  344. data/lib/rubocop/cop/style/alias.rb +44 -37
  345. data/lib/rubocop/cop/style/and_or.rb +16 -19
  346. data/lib/rubocop/cop/style/array_coercion.rb +67 -0
  347. data/lib/rubocop/cop/style/array_join.rb +8 -9
  348. data/lib/rubocop/cop/style/ascii_comments.rb +4 -4
  349. data/lib/rubocop/cop/style/attr.rb +22 -13
  350. data/lib/rubocop/cop/style/auto_resource_cleanup.rb +7 -7
  351. data/lib/rubocop/cop/style/bare_percent_literals.rb +12 -14
  352. data/lib/rubocop/cop/style/begin_block.rb +2 -2
  353. data/lib/rubocop/cop/style/bisected_attr_accessor.rb +141 -0
  354. data/lib/rubocop/cop/style/block_comments.rb +14 -18
  355. data/lib/rubocop/cop/style/block_delimiters.rb +77 -26
  356. data/lib/rubocop/cop/style/case_equality.rb +54 -4
  357. data/lib/rubocop/cop/style/case_like_if.rb +252 -0
  358. data/lib/rubocop/cop/style/character_literal.rb +2 -2
  359. data/lib/rubocop/cop/style/class_and_module_children.rb +17 -12
  360. data/lib/rubocop/cop/style/class_check.rb +6 -11
  361. data/lib/rubocop/cop/style/class_equality_comparison.rb +64 -0
  362. data/lib/rubocop/cop/style/class_methods.rb +7 -11
  363. data/lib/rubocop/cop/style/class_methods_definitions.rb +157 -0
  364. data/lib/rubocop/cop/style/class_vars.rb +23 -7
  365. data/lib/rubocop/cop/style/collection_methods.rb +13 -17
  366. data/lib/rubocop/cop/style/colon_method_call.rb +8 -9
  367. data/lib/rubocop/cop/style/colon_method_definition.rb +6 -6
  368. data/lib/rubocop/cop/style/combinable_loops.rb +91 -0
  369. data/lib/rubocop/cop/style/command_literal.rb +24 -25
  370. data/lib/rubocop/cop/style/comment_annotation.rb +23 -17
  371. data/lib/rubocop/cop/style/commented_keyword.rb +13 -11
  372. data/lib/rubocop/cop/style/conditional_assignment.rb +69 -73
  373. data/lib/rubocop/cop/style/constant_visibility.rb +3 -2
  374. data/lib/rubocop/cop/style/copyright.rb +27 -23
  375. data/lib/rubocop/cop/style/date_time.rb +14 -3
  376. data/lib/rubocop/cop/style/def_with_parentheses.rb +8 -10
  377. data/lib/rubocop/cop/style/dir.rb +10 -12
  378. data/lib/rubocop/cop/style/disable_cops_within_source_code_directive.rb +47 -0
  379. data/lib/rubocop/cop/style/documentation.rb +51 -15
  380. data/lib/rubocop/cop/style/documentation_method.rb +1 -1
  381. data/lib/rubocop/cop/style/double_cop_disable_directive.rb +14 -17
  382. data/lib/rubocop/cop/style/double_negation.rb +44 -6
  383. data/lib/rubocop/cop/style/each_for_simple_loop.rb +5 -8
  384. data/lib/rubocop/cop/style/each_with_object.rb +16 -19
  385. data/lib/rubocop/cop/style/empty_block_parameter.rb +9 -10
  386. data/lib/rubocop/cop/style/empty_case_condition.rb +29 -28
  387. data/lib/rubocop/cop/style/empty_else.rb +17 -19
  388. data/lib/rubocop/cop/style/empty_lambda_parameter.rb +9 -10
  389. data/lib/rubocop/cop/style/empty_literal.rb +26 -27
  390. data/lib/rubocop/cop/style/empty_method.rb +13 -20
  391. data/lib/rubocop/cop/style/encoding.rb +6 -10
  392. data/lib/rubocop/cop/style/end_block.rb +6 -2
  393. data/lib/rubocop/cop/style/eval_with_location.rb +8 -8
  394. data/lib/rubocop/cop/style/even_odd.rb +9 -12
  395. data/lib/rubocop/cop/style/expand_path_arguments.rb +26 -25
  396. data/lib/rubocop/cop/style/explicit_block_argument.rb +106 -0
  397. data/lib/rubocop/cop/style/exponential_notation.rb +117 -0
  398. data/lib/rubocop/cop/style/float_division.rb +10 -11
  399. data/lib/rubocop/cop/style/for.rb +7 -15
  400. data/lib/rubocop/cop/style/format_string.rb +30 -28
  401. data/lib/rubocop/cop/style/format_string_token.rb +15 -16
  402. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +98 -35
  403. data/lib/rubocop/cop/style/global_std_stream.rb +65 -0
  404. data/lib/rubocop/cop/style/global_vars.rb +2 -2
  405. data/lib/rubocop/cop/style/guard_clause.rb +34 -10
  406. data/lib/rubocop/cop/style/hash_as_last_array_item.rb +88 -0
  407. data/lib/rubocop/cop/style/hash_each_methods.rb +86 -0
  408. data/lib/rubocop/cop/style/hash_like_case.rb +76 -0
  409. data/lib/rubocop/cop/style/hash_syntax.rb +27 -18
  410. data/lib/rubocop/cop/style/hash_transform_keys.rb +91 -0
  411. data/lib/rubocop/cop/style/hash_transform_values.rb +88 -0
  412. data/lib/rubocop/cop/style/identical_conditional_branches.rb +2 -2
  413. data/lib/rubocop/cop/style/if_inside_else.rb +2 -2
  414. data/lib/rubocop/cop/style/if_unless_modifier.rb +80 -44
  415. data/lib/rubocop/cop/style/if_unless_modifier_of_if_unless.rb +11 -3
  416. data/lib/rubocop/cop/style/if_with_semicolon.rb +15 -2
  417. data/lib/rubocop/cop/style/implicit_runtime_error.rb +2 -1
  418. data/lib/rubocop/cop/style/infinite_loop.rb +28 -27
  419. data/lib/rubocop/cop/style/inline_comment.rb +4 -4
  420. data/lib/rubocop/cop/style/inverse_methods.rb +37 -37
  421. data/lib/rubocop/cop/style/ip_addresses.rb +5 -5
  422. data/lib/rubocop/cop/style/keyword_parameters_order.rb +53 -0
  423. data/lib/rubocop/cop/style/lambda.rb +9 -13
  424. data/lib/rubocop/cop/style/lambda_call.rb +17 -34
  425. data/lib/rubocop/cop/style/line_end_concatenation.rb +33 -26
  426. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +9 -206
  427. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +174 -0
  428. data/lib/rubocop/cop/style/method_call_with_args_parentheses/require_parentheses.rb +48 -0
  429. data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +9 -10
  430. data/lib/rubocop/cop/style/method_called_on_do_end_block.rb +12 -3
  431. data/lib/rubocop/cop/style/method_def_parentheses.rb +21 -22
  432. data/lib/rubocop/cop/style/min_max.rb +8 -12
  433. data/lib/rubocop/cop/style/missing_else.rb +11 -21
  434. data/lib/rubocop/cop/style/missing_respond_to_missing.rb +10 -3
  435. data/lib/rubocop/cop/style/mixin_grouping.rb +26 -29
  436. data/lib/rubocop/cop/style/mixin_usage.rb +9 -28
  437. data/lib/rubocop/cop/style/module_function.rb +64 -21
  438. data/lib/rubocop/cop/style/multiline_block_chain.rb +12 -3
  439. data/lib/rubocop/cop/style/multiline_if_modifier.rb +4 -11
  440. data/lib/rubocop/cop/style/multiline_if_then.rb +5 -11
  441. data/lib/rubocop/cop/style/multiline_memoization.rb +15 -13
  442. data/lib/rubocop/cop/style/multiline_method_signature.rb +2 -2
  443. data/lib/rubocop/cop/style/multiline_ternary_operator.rb +31 -9
  444. data/lib/rubocop/cop/style/multiline_when_then.rb +29 -11
  445. data/lib/rubocop/cop/style/multiple_comparison.rb +1 -1
  446. data/lib/rubocop/cop/style/mutable_constant.rb +27 -26
  447. data/lib/rubocop/cop/style/negated_if.rb +9 -9
  448. data/lib/rubocop/cop/style/negated_unless.rb +9 -9
  449. data/lib/rubocop/cop/style/negated_while.rb +7 -15
  450. data/lib/rubocop/cop/style/nested_modifier.rb +13 -14
  451. data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +21 -22
  452. data/lib/rubocop/cop/style/nested_ternary_operator.rb +29 -2
  453. data/lib/rubocop/cop/style/next.rb +19 -23
  454. data/lib/rubocop/cop/style/nil_comparison.rb +13 -11
  455. data/lib/rubocop/cop/style/non_nil_check.rb +55 -35
  456. data/lib/rubocop/cop/style/not.rb +20 -26
  457. data/lib/rubocop/cop/style/numeric_literal_prefix.rb +6 -11
  458. data/lib/rubocop/cop/style/numeric_literals.rb +8 -4
  459. data/lib/rubocop/cop/style/numeric_predicate.rb +11 -16
  460. data/lib/rubocop/cop/style/one_line_conditional.rb +76 -29
  461. data/lib/rubocop/cop/style/option_hash.rb +4 -4
  462. data/lib/rubocop/cop/style/optional_arguments.rb +2 -2
  463. data/lib/rubocop/cop/style/optional_boolean_parameter.rb +53 -0
  464. data/lib/rubocop/cop/style/or_assignment.rb +16 -12
  465. data/lib/rubocop/cop/style/parallel_assignment.rb +18 -18
  466. data/lib/rubocop/cop/style/parentheses_around_condition.rb +6 -6
  467. data/lib/rubocop/cop/style/percent_literal_delimiters.rb +21 -27
  468. data/lib/rubocop/cop/style/percent_q_literals.rb +8 -10
  469. data/lib/rubocop/cop/style/perl_backrefs.rb +8 -10
  470. data/lib/rubocop/cop/style/preferred_hash_methods.rb +11 -14
  471. data/lib/rubocop/cop/style/proc.rb +7 -7
  472. data/lib/rubocop/cop/style/raise_args.rb +12 -24
  473. data/lib/rubocop/cop/style/random_with_offset.rb +24 -29
  474. data/lib/rubocop/cop/style/redundant_assignment.rb +107 -0
  475. data/lib/rubocop/cop/style/redundant_begin.rb +35 -9
  476. data/lib/rubocop/cop/style/{unneeded_capital_w.rb → redundant_capital_w.rb} +6 -9
  477. data/lib/rubocop/cop/style/{unneeded_condition.rb → redundant_condition.rb} +42 -15
  478. data/lib/rubocop/cop/style/redundant_conditional.rb +9 -9
  479. data/lib/rubocop/cop/style/redundant_exception.rb +19 -13
  480. data/lib/rubocop/cop/style/redundant_fetch_block.rb +113 -0
  481. data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +51 -0
  482. data/lib/rubocop/cop/style/redundant_freeze.rb +6 -8
  483. data/lib/rubocop/cop/style/{unneeded_interpolation.rb → redundant_interpolation.rb} +31 -25
  484. data/lib/rubocop/cop/style/redundant_parentheses.rb +34 -26
  485. data/lib/rubocop/cop/style/{unneeded_percent_q.rb → redundant_percent_q.rb} +13 -15
  486. data/lib/rubocop/cop/style/redundant_regexp_character_class.rb +98 -0
  487. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +105 -0
  488. data/lib/rubocop/cop/style/redundant_return.rb +40 -44
  489. data/lib/rubocop/cop/style/redundant_self.rb +15 -20
  490. data/lib/rubocop/cop/style/redundant_self_assignment.rb +116 -0
  491. data/lib/rubocop/cop/style/{unneeded_sort.rb → redundant_sort.rb} +31 -34
  492. data/lib/rubocop/cop/style/redundant_sort_by.rb +5 -9
  493. data/lib/rubocop/cop/style/regexp_literal.rb +10 -21
  494. data/lib/rubocop/cop/style/rescue_modifier.rb +29 -9
  495. data/lib/rubocop/cop/style/rescue_standard_error.rb +21 -17
  496. data/lib/rubocop/cop/style/return_nil.rb +6 -6
  497. data/lib/rubocop/cop/style/safe_navigation.rb +35 -30
  498. data/lib/rubocop/cop/style/sample.rb +13 -15
  499. data/lib/rubocop/cop/style/self_assignment.rb +26 -22
  500. data/lib/rubocop/cop/style/semicolon.rb +9 -12
  501. data/lib/rubocop/cop/style/send.rb +4 -5
  502. data/lib/rubocop/cop/style/signal_exception.rb +26 -20
  503. data/lib/rubocop/cop/style/single_argument_dig.rb +55 -0
  504. data/lib/rubocop/cop/style/single_line_block_params.rb +4 -2
  505. data/lib/rubocop/cop/style/single_line_methods.rb +18 -17
  506. data/lib/rubocop/cop/style/slicing_with_range.rb +37 -0
  507. data/lib/rubocop/cop/style/sole_nested_conditional.rb +66 -0
  508. data/lib/rubocop/cop/style/special_global_vars.rb +17 -28
  509. data/lib/rubocop/cop/style/stabby_lambda_parentheses.rb +17 -23
  510. data/lib/rubocop/cop/style/stderr_puts.rb +6 -7
  511. data/lib/rubocop/cop/style/string_concatenation.rb +106 -0
  512. data/lib/rubocop/cop/style/string_hash_keys.rb +6 -7
  513. data/lib/rubocop/cop/style/string_methods.rb +7 -17
  514. data/lib/rubocop/cop/style/strip.rb +9 -14
  515. data/lib/rubocop/cop/style/struct_inheritance.rb +22 -4
  516. data/lib/rubocop/cop/style/symbol_array.rb +13 -24
  517. data/lib/rubocop/cop/style/symbol_literal.rb +6 -8
  518. data/lib/rubocop/cop/style/symbol_proc.rb +16 -20
  519. data/lib/rubocop/cop/style/ternary_parentheses.rb +25 -28
  520. data/lib/rubocop/cop/style/trailing_body_on_class.rb +3 -6
  521. data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb +4 -7
  522. data/lib/rubocop/cop/style/trailing_body_on_module.rb +3 -6
  523. data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +37 -27
  524. data/lib/rubocop/cop/style/trailing_comma_in_array_literal.rb +43 -5
  525. data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +90 -0
  526. data/lib/rubocop/cop/style/trailing_comma_in_hash_literal.rb +46 -5
  527. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +9 -32
  528. data/lib/rubocop/cop/style/trailing_underscore_variable.rb +16 -21
  529. data/lib/rubocop/cop/style/trivial_accessors.rb +35 -38
  530. data/lib/rubocop/cop/style/unless_else.rb +6 -9
  531. data/lib/rubocop/cop/style/unpack_first.rb +4 -11
  532. data/lib/rubocop/cop/style/variable_interpolation.rb +7 -10
  533. data/lib/rubocop/cop/style/when_then.rb +5 -7
  534. data/lib/rubocop/cop/style/while_until_do.rb +6 -16
  535. data/lib/rubocop/cop/style/while_until_modifier.rb +8 -22
  536. data/lib/rubocop/cop/style/word_array.rb +6 -24
  537. data/lib/rubocop/cop/style/yoda_condition.rb +29 -8
  538. data/lib/rubocop/cop/style/zero_length_predicate.rb +19 -21
  539. data/lib/rubocop/cop/team.rb +143 -77
  540. data/lib/rubocop/cop/util.rb +30 -17
  541. data/lib/rubocop/cop/utils/format_string.rb +31 -24
  542. data/lib/rubocop/cop/variable_force.rb +16 -17
  543. data/lib/rubocop/cop/variable_force/assignment.rb +1 -0
  544. data/lib/rubocop/cop/variable_force/branch.rb +2 -7
  545. data/lib/rubocop/cop/variable_force/scope.rb +1 -0
  546. data/lib/rubocop/cop/variable_force/variable.rb +7 -8
  547. data/lib/rubocop/cops_documentation_generator.rb +284 -0
  548. data/lib/rubocop/core_ext/string.rb +2 -2
  549. data/lib/rubocop/directive_comment.rb +32 -0
  550. data/lib/rubocop/error.rb +1 -0
  551. data/lib/rubocop/ext/processed_source.rb +18 -0
  552. data/lib/rubocop/ext/regexp_node.rb +62 -0
  553. data/lib/rubocop/file_finder.rb +13 -12
  554. data/lib/rubocop/formatter/auto_gen_config_formatter.rb +2 -1
  555. data/lib/rubocop/formatter/base_formatter.rb +0 -4
  556. data/lib/rubocop/formatter/clang_style_formatter.rb +0 -2
  557. data/lib/rubocop/formatter/disabled_config_formatter.rb +15 -16
  558. data/lib/rubocop/formatter/formatter_set.rb +4 -5
  559. data/lib/rubocop/formatter/html_formatter.rb +2 -0
  560. data/lib/rubocop/formatter/json_formatter.rb +6 -5
  561. data/lib/rubocop/formatter/junit_formatter.rb +84 -0
  562. data/lib/rubocop/formatter/pacman_formatter.rb +1 -1
  563. data/lib/rubocop/formatter/progress_formatter.rb +2 -1
  564. data/lib/rubocop/formatter/quiet_formatter.rb +1 -1
  565. data/lib/rubocop/formatter/simple_text_formatter.rb +36 -6
  566. data/lib/rubocop/formatter/tap_formatter.rb +0 -2
  567. data/lib/rubocop/magic_comment.rb +1 -1
  568. data/lib/rubocop/name_similarity.rb +18 -10
  569. data/lib/rubocop/options.rb +103 -46
  570. data/lib/rubocop/path_util.rb +19 -19
  571. data/lib/rubocop/platform.rb +1 -1
  572. data/lib/rubocop/rake_task.rb +8 -9
  573. data/lib/rubocop/remote_config.rb +2 -3
  574. data/lib/rubocop/result_cache.rb +69 -27
  575. data/lib/rubocop/rspec/cop_helper.rb +11 -31
  576. data/lib/rubocop/rspec/expect_offense.rb +104 -25
  577. data/lib/rubocop/rspec/shared_contexts.rb +79 -29
  578. data/lib/rubocop/runner.rb +123 -74
  579. data/lib/rubocop/string_interpreter.rb +3 -0
  580. data/lib/rubocop/target_finder.rb +61 -50
  581. data/lib/rubocop/target_ruby.rb +160 -0
  582. data/lib/rubocop/version.rb +12 -4
  583. data/lib/rubocop/yaml_duplication_checker.rb +1 -0
  584. metadata +176 -117
  585. data/lib/rubocop/ast/builder.rb +0 -81
  586. data/lib/rubocop/ast/node.rb +0 -640
  587. data/lib/rubocop/ast/node/alias_node.rb +0 -24
  588. data/lib/rubocop/ast/node/and_node.rb +0 -29
  589. data/lib/rubocop/ast/node/args_node.rb +0 -29
  590. data/lib/rubocop/ast/node/array_node.rb +0 -57
  591. data/lib/rubocop/ast/node/block_node.rb +0 -115
  592. data/lib/rubocop/ast/node/break_node.rb +0 -17
  593. data/lib/rubocop/ast/node/case_node.rb +0 -56
  594. data/lib/rubocop/ast/node/class_node.rb +0 -31
  595. data/lib/rubocop/ast/node/def_node.rb +0 -71
  596. data/lib/rubocop/ast/node/defined_node.rb +0 -17
  597. data/lib/rubocop/ast/node/ensure_node.rb +0 -17
  598. data/lib/rubocop/ast/node/float_node.rb +0 -12
  599. data/lib/rubocop/ast/node/for_node.rb +0 -53
  600. data/lib/rubocop/ast/node/hash_node.rb +0 -109
  601. data/lib/rubocop/ast/node/if_node.rb +0 -175
  602. data/lib/rubocop/ast/node/int_node.rb +0 -12
  603. data/lib/rubocop/ast/node/keyword_splat_node.rb +0 -45
  604. data/lib/rubocop/ast/node/mixin/basic_literal_node.rb +0 -16
  605. data/lib/rubocop/ast/node/mixin/binary_operator_node.rb +0 -43
  606. data/lib/rubocop/ast/node/mixin/collection_node.rb +0 -15
  607. data/lib/rubocop/ast/node/mixin/conditional_node.rb +0 -45
  608. data/lib/rubocop/ast/node/mixin/hash_element_node.rb +0 -125
  609. data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +0 -261
  610. data/lib/rubocop/ast/node/mixin/method_identifier_predicates.rb +0 -114
  611. data/lib/rubocop/ast/node/mixin/modifier_node.rb +0 -17
  612. data/lib/rubocop/ast/node/mixin/numeric_node.rb +0 -21
  613. data/lib/rubocop/ast/node/mixin/parameterized_node.rb +0 -61
  614. data/lib/rubocop/ast/node/mixin/predicate_operator_node.rb +0 -35
  615. data/lib/rubocop/ast/node/module_node.rb +0 -24
  616. data/lib/rubocop/ast/node/or_node.rb +0 -29
  617. data/lib/rubocop/ast/node/pair_node.rb +0 -63
  618. data/lib/rubocop/ast/node/range_node.rb +0 -18
  619. data/lib/rubocop/ast/node/regexp_node.rb +0 -35
  620. data/lib/rubocop/ast/node/resbody_node.rb +0 -24
  621. data/lib/rubocop/ast/node/retry_node.rb +0 -17
  622. data/lib/rubocop/ast/node/self_class_node.rb +0 -24
  623. data/lib/rubocop/ast/node/send_node.rb +0 -13
  624. data/lib/rubocop/ast/node/str_node.rb +0 -16
  625. data/lib/rubocop/ast/node/super_node.rb +0 -21
  626. data/lib/rubocop/ast/node/symbol_node.rb +0 -12
  627. data/lib/rubocop/ast/node/until_node.rb +0 -35
  628. data/lib/rubocop/ast/node/when_node.rb +0 -53
  629. data/lib/rubocop/ast/node/while_node.rb +0 -35
  630. data/lib/rubocop/ast/node/yield_node.rb +0 -21
  631. data/lib/rubocop/ast/sexp.rb +0 -16
  632. data/lib/rubocop/ast/traversal.rb +0 -183
  633. data/lib/rubocop/cop/layout/align_array.rb +0 -39
  634. data/lib/rubocop/cop/layout/indent_heredoc.rb +0 -256
  635. data/lib/rubocop/cop/lint/end_in_method.rb +0 -40
  636. data/lib/rubocop/cop/lint/useless_comparison.rb +0 -28
  637. data/lib/rubocop/cop/mixin/classish_length.rb +0 -37
  638. data/lib/rubocop/cop/mixin/parser_diagnostic.rb +0 -37
  639. data/lib/rubocop/cop/mixin/safe_mode.rb +0 -24
  640. data/lib/rubocop/cop/mixin/too_many_lines.rb +0 -35
  641. data/lib/rubocop/cop/style/braces_around_hash_parameters.rb +0 -209
  642. data/lib/rubocop/cop/style/method_missing_super.rb +0 -34
  643. data/lib/rubocop/formatter/disabled_lines_formatter.rb +0 -57
  644. data/lib/rubocop/node_pattern.rb +0 -799
  645. data/lib/rubocop/processed_source.rb +0 -216
  646. data/lib/rubocop/string_util.rb +0 -14
  647. data/lib/rubocop/token.rb +0 -114
@@ -1,35 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module RuboCop
4
- module Cop
5
- # Common functionality for checking for too many lines.
6
- module TooManyLines
7
- include ConfigurableMax
8
- include CodeLength
9
-
10
- MSG = '%<label>s has too many lines. [%<length>d/%<max>d]'
11
-
12
- private
13
-
14
- def message(length, max_length)
15
- format(MSG, label: cop_label, length: length, max: max_length)
16
- end
17
-
18
- def code_length(node)
19
- body = extract_body(node)
20
- lines = body&.source&.lines || []
21
-
22
- lines.count { |line| !irrelevant_line(line) }
23
- end
24
-
25
- def extract_body(node)
26
- case node.type
27
- when :block, :def, :defs
28
- node.body
29
- else
30
- node
31
- end
32
- end
33
- end
34
- end
35
- end
@@ -1,209 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module RuboCop
4
- module Cop
5
- module Style
6
- # This cop checks for braces around the last parameter in a method call
7
- # if the last parameter is a hash.
8
- # It supports `braces`, `no_braces` and `context_dependent` styles.
9
- #
10
- # @example EnforcedStyle: braces
11
- # # The `braces` style enforces braces around all method
12
- # # parameters that are hashes.
13
- #
14
- # # bad
15
- # some_method(x, y, a: 1, b: 2)
16
- #
17
- # # good
18
- # some_method(x, y, {a: 1, b: 2})
19
- #
20
- # @example EnforcedStyle: no_braces (default)
21
- # # The `no_braces` style checks that the last parameter doesn't
22
- # # have braces around it.
23
- #
24
- # # bad
25
- # some_method(x, y, {a: 1, b: 2})
26
- #
27
- # # good
28
- # some_method(x, y, a: 1, b: 2)
29
- #
30
- # @example EnforcedStyle: context_dependent
31
- # # The `context_dependent` style checks that the last parameter
32
- # # doesn't have braces around it, but requires braces if the
33
- # # second to last parameter is also a hash literal.
34
- #
35
- # # bad
36
- # some_method(x, y, {a: 1, b: 2})
37
- # some_method(x, y, {a: 1, b: 2}, a: 1, b: 2)
38
- #
39
- # # good
40
- # some_method(x, y, a: 1, b: 2)
41
- # some_method(x, y, {a: 1, b: 2}, {a: 1, b: 2})
42
- class BracesAroundHashParameters < Cop
43
- include ConfigurableEnforcedStyle
44
- include RangeHelp
45
-
46
- MSG = '%<type>s curly braces around a hash parameter.'
47
-
48
- def on_send(node)
49
- return if node.assignment_method? || node.operator_method?
50
-
51
- return unless node.arguments? && node.last_argument.hash_type? &&
52
- !node.last_argument.empty?
53
-
54
- check(node.last_argument, node.arguments)
55
- end
56
- alias on_csend on_send
57
-
58
- def autocorrect(send_node)
59
- hash_node = send_node.last_argument
60
-
61
- lambda do |corrector|
62
- if hash_node.braces?
63
- remove_braces_with_whitespace(corrector,
64
- hash_node,
65
- extra_space(hash_node))
66
- else
67
- add_braces(corrector, hash_node)
68
- end
69
- end
70
- end
71
-
72
- private
73
-
74
- def check(arg, args)
75
- case style
76
- when :braces
77
- check_braces(arg)
78
- when :no_braces
79
- check_no_braces(arg)
80
- when :context_dependent
81
- check_context_dependent(arg, args)
82
- end
83
- end
84
-
85
- def check_braces(arg)
86
- add_arg_offense(arg, :missing) unless arg.braces?
87
- end
88
-
89
- def check_no_braces(arg)
90
- return unless arg.braces? && !braces_needed_for_semantics?(arg)
91
-
92
- add_arg_offense(arg, :redundant)
93
- end
94
-
95
- def check_context_dependent(arg, args)
96
- braces_around_second_from_end = args.size > 1 && args[-2].hash_type?
97
-
98
- if arg.braces?
99
- unless braces_around_second_from_end ||
100
- braces_needed_for_semantics?(arg)
101
- add_arg_offense(arg, :redundant)
102
- end
103
- elsif braces_around_second_from_end
104
- add_arg_offense(arg, :missing)
105
- end
106
- end
107
-
108
- # Returns true if there's block inside the braces of the given hash arg
109
- # and that block uses do..end. The reason for wanting to check this is
110
- # that the do..end could bind to a different method invocation if the
111
- # hash braces were removed.
112
- def braces_needed_for_semantics?(arg)
113
- arg.each_pair do |_key, value|
114
- return true if value.block_type? && !value.braces?
115
- end
116
- false
117
- end
118
-
119
- def add_arg_offense(arg, type)
120
- add_offense(arg.parent, location: arg.source_range,
121
- message: format(MSG,
122
- type: type.to_s.capitalize))
123
- end
124
-
125
- def extra_space(hash_node)
126
- {
127
- newlines: extra_left_space?(hash_node) &&
128
- extra_right_space?(hash_node),
129
- left: extra_left_space?(hash_node),
130
- right: extra_right_space?(hash_node)
131
- }
132
- end
133
-
134
- def extra_left_space?(hash_node)
135
- @extra_left_space ||= begin
136
- top_line = hash_node.source_range.source_line
137
- top_line.delete(' ') == '{'
138
- end
139
- end
140
-
141
- def extra_right_space?(hash_node)
142
- @extra_right_space ||= begin
143
- bottom_line_number = hash_node.source_range.last_line
144
- bottom_line = processed_source.lines[bottom_line_number - 1]
145
- bottom_line.delete(' ') == '}'
146
- end
147
- end
148
-
149
- def remove_braces_with_whitespace(corrector, node, space)
150
- if node.multiline?
151
- remove_braces_with_range(corrector,
152
- left_whole_line_range(node.loc.begin),
153
- right_whole_line_range(node.loc.end))
154
- else
155
- right_brace_and_space = right_brace_and_space(node.loc.end, space)
156
- left_brace_and_space = left_brace_and_space(node.loc.begin, space)
157
- remove_braces_with_range(corrector,
158
- left_brace_and_space,
159
- right_brace_and_space)
160
- end
161
- end
162
-
163
- def remove_braces_with_range(corrector, left_range, right_range)
164
- corrector.remove(left_range)
165
- corrector.remove(right_range)
166
- end
167
-
168
- def left_whole_line_range(loc_begin)
169
- if range_by_whole_lines(loc_begin).source.strip == '{'
170
- range_by_whole_lines(loc_begin, include_final_newline: true)
171
- else
172
- loc_begin
173
- end
174
- end
175
-
176
- def right_whole_line_range(loc_end)
177
- if range_by_whole_lines(loc_end).source.strip =~ /\A}\s*,?\z/
178
- range_by_whole_lines(loc_end, include_final_newline: true)
179
- else
180
- loc_end
181
- end
182
- end
183
-
184
- def left_brace_and_space(loc_begin, space)
185
- range_with_surrounding_space(range: loc_begin,
186
- side: :right,
187
- newlines: space[:newlines],
188
- whitespace: space[:left])
189
- end
190
-
191
- def right_brace_and_space(loc_end, space)
192
- brace_and_space =
193
- range_with_surrounding_space(
194
- range: loc_end,
195
- side: :left,
196
- newlines: space[:newlines],
197
- whitespace: space[:right]
198
- )
199
- range_with_surrounding_comma(brace_and_space, :left)
200
- end
201
-
202
- def add_braces(corrector, node)
203
- corrector.insert_before(node.source_range, '{')
204
- corrector.insert_after(node.source_range, '}')
205
- end
206
- end
207
- end
208
- end
209
- end
@@ -1,34 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module RuboCop
4
- module Cop
5
- module Style
6
- # This cop checks for the presence of `method_missing` without
7
- # falling back on `super`.
8
- #
9
- # @example
10
- # #bad
11
- # def method_missing(name, *args)
12
- # # ...
13
- # end
14
- #
15
- # #good
16
- #
17
- # def method_missing(name, *args)
18
- # # ...
19
- # super
20
- # end
21
- class MethodMissingSuper < Cop
22
- MSG = 'When using `method_missing`, fall back on `super`.'
23
-
24
- def on_def(node)
25
- return unless node.method?(:method_missing)
26
- return if node.descendants.any?(&:zsuper_type?)
27
-
28
- add_offense(node)
29
- end
30
- alias on_defs on_def
31
- end
32
- end
33
- end
34
- end
@@ -1,57 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module RuboCop
4
- module Formatter
5
- # A basic formatter that displays the lines disabled
6
- # inline comments.
7
- class DisabledLinesFormatter < BaseFormatter
8
- include PathUtil
9
- include Colorizable
10
-
11
- attr_reader :cop_disabled_line_ranges
12
-
13
- def started(_target_files)
14
- @cop_disabled_line_ranges = {}
15
- end
16
-
17
- def file_started(file, options)
18
- return unless options[:cop_disabled_line_ranges]
19
-
20
- @cop_disabled_line_ranges[file] =
21
- options[:cop_disabled_line_ranges]
22
- end
23
-
24
- def finished(_inspected_files)
25
- cops_disabled_in_comments_summary
26
- end
27
-
28
- private
29
-
30
- def cops_disabled_in_comments_summary
31
- summary = "\nCops disabled line ranges:\n\n"
32
-
33
- @cop_disabled_line_ranges.each do |file, disabled_cops|
34
- disabled_cops.each do |cop, line_ranges|
35
- line_ranges.each do |line_range|
36
- file = cyan(smart_path(file))
37
- summary += "#{file}:#{line_range}: #{cop}\n"
38
- end
39
- end
40
- end
41
-
42
- output.puts summary
43
- end
44
-
45
- def smart_path(path)
46
- # Ideally, we calculate this relative to the project root.
47
- base_dir = Dir.pwd
48
-
49
- if path.start_with? base_dir
50
- relative_path(path, base_dir)
51
- else
52
- path
53
- end
54
- end
55
- end
56
- end
57
- end
@@ -1,799 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'delegate'
4
- require 'erb'
5
-
6
- # rubocop:disable Metrics/ClassLength, Metrics/CyclomaticComplexity
7
- module RuboCop
8
- # This class performs a pattern-matching operation on an AST node.
9
- #
10
- # Initialize a new `NodePattern` with `NodePattern.new(pattern_string)`, then
11
- # pass an AST node to `NodePattern#match`. Alternatively, use one of the class
12
- # macros in `NodePattern::Macros` to define your own pattern-matching method.
13
- #
14
- # If the match fails, `nil` will be returned. If the match succeeds, the
15
- # return value depends on whether a block was provided to `#match`, and
16
- # whether the pattern contained any "captures" (values which are extracted
17
- # from a matching AST.)
18
- #
19
- # - With block: #match yields the captures (if any) and passes the return
20
- # value of the block through.
21
- # - With no block, but one capture: the capture is returned.
22
- # - With no block, but multiple captures: captures are returned as an array.
23
- # - With no block and no captures: #match returns `true`.
24
- #
25
- # ## Pattern string format examples
26
- #
27
- # ':sym' # matches a literal symbol
28
- # '1' # matches a literal integer
29
- # 'nil' # matches a literal nil
30
- # 'send' # matches (send ...)
31
- # '(send)' # matches (send)
32
- # '(send ...)' # matches (send ...)
33
- # '(op-asgn)' # node types with hyphenated names also work
34
- # '{send class}' # matches (send ...) or (class ...)
35
- # '({send class})' # matches (send) or (class)
36
- # '(send const)' # matches (send (const ...))
37
- # '(send _ :new)' # matches (send <anything> :new)
38
- # '(send $_ :new)' # as above, but whatever matches the $_ is captured
39
- # '(send $_ $_)' # you can use as many captures as you want
40
- # '(send !const ...)' # ! negates the next part of the pattern
41
- # '$(send const ...)' # arbitrary matching can be performed on a capture
42
- # '(send _recv _msg)' # wildcards can be named (for readability)
43
- # '(send ... :new)' # you can match against the last children
44
- # '(array <str sym>)' # you can match children in any order. This
45
- # # would match `['x', :y]` as well as `[:y, 'x']
46
- # '(_ <str sym ...>)' # will match if arguments have at least a `str` and
47
- # # a `sym` node, but can have more.
48
- # '(array <$str $_>)' # captures are in the order of the pattern,
49
- # # irrespective of the actual order of the children
50
- # '(array int*)' # will match an array of 0 or more integers
51
- # '(array int ?)' # will match 0 or 1 integer.
52
- # # Note: Space needed to distinguish from int?
53
- # '(array int+)' # will match an array of 1 or more integers
54
- # '(array (int $_)+)' # as above and will capture the numbers in an array
55
- # '(send $...)' # capture all the children as an array
56
- # '(send $... int)' # capture all children but the last as an array
57
- # '(send _x :+ _x)' # unification is performed on named wildcards
58
- # # (like Prolog variables...)
59
- # # (#== is used to see if values unify)
60
- # '(int odd?)' # words which end with a ? are predicate methods,
61
- # # are are called on the target to see if it matches
62
- # # any Ruby method which the matched object supports
63
- # # can be used
64
- # # if a truthy value is returned, the match succeeds
65
- # '(int [!1 !2])' # [] contains multiple patterns, ALL of which must
66
- # # match in that position
67
- # # in other words, while {} is pattern union (logical
68
- # # OR), [] is intersection (logical AND)
69
- # '(send %1 _)' # % stands for a parameter which must be supplied to
70
- # # #match at matching time
71
- # # it will be compared to the corresponding value in
72
- # # the AST using #==
73
- # # a bare '%' is the same as '%1'
74
- # # the number of extra parameters passed to #match
75
- # # must equal the highest % value in the pattern
76
- # # for consistency, %0 is the 'root node' which is
77
- # # passed as the 1st argument to #match, where the
78
- # # matching process starts
79
- # '^^send' # each ^ ascends one level in the AST
80
- # # so this matches against the grandparent node
81
- # '#method' # we call this a 'funcall'; it calls a method in the
82
- # # context where a pattern-matching method is defined
83
- # # if that returns a truthy value, the match succeeds
84
- # 'equal?(%1)' # predicates can be given 1 or more extra args
85
- # '#method(%0, 1)' # funcalls can also be given 1 or more extra args
86
- #
87
- # You can nest arbitrarily deep:
88
- #
89
- # # matches node parsed from 'Const = Class.new' or 'Const = Module.new':
90
- # '(casgn nil? :Const (send (const nil? {:Class :Module}) :new))'
91
- # # matches a node parsed from an 'if', with a '==' comparison,
92
- # # and no 'else' branch:
93
- # '(if (send _ :== _) _ nil?)'
94
- #
95
- # Note that patterns like 'send' are implemented by calling `#send_type?` on
96
- # the node being matched, 'const' by `#const_type?`, 'int' by `#int_type?`,
97
- # and so on. Therefore, if you add methods which are named like
98
- # `#prefix_type?` to the AST node class, then 'prefix' will become usable as
99
- # a pattern.
100
- #
101
- # Also note that if you need a "guard clause" to protect against possible nils
102
- # in a certain place in the AST, you can do it like this: `[!nil <pattern>]`
103
- #
104
- # The compiler code is very simple; don't be afraid to read through it!
105
- class NodePattern
106
- # @private
107
- Invalid = Class.new(StandardError)
108
-
109
- # @private
110
- # Builds Ruby code which implements a pattern
111
- class Compiler
112
- SYMBOL = %r{:(?:[\w+@*/?!<>=~|%^-]+|\[\]=?)}.freeze
113
- IDENTIFIER = /[a-zA-Z_][a-zA-Z0-9_-]*/.freeze
114
- META = Regexp.union(
115
- %w"( ) { } [ ] $< < > $... $ ! ^ ... + * ?"
116
- ).freeze
117
- NUMBER = /-?\d+(?:\.\d+)?/.freeze
118
- STRING = /".+?"/.freeze
119
- METHOD_NAME = /\#?#{IDENTIFIER}[\!\?]?\(?/.freeze
120
- PARAM_NUMBER = /%\d*/.freeze
121
-
122
- SEPARATORS = /[\s]+/.freeze
123
- TOKENS = Regexp.union(META, PARAM_NUMBER, NUMBER,
124
- METHOD_NAME, SYMBOL, STRING)
125
-
126
- TOKEN = /\G(?:#{SEPARATORS}|#{TOKENS}|.)/.freeze
127
-
128
- NODE = /\A#{IDENTIFIER}\Z/.freeze
129
- PREDICATE = /\A#{IDENTIFIER}\?\(?\Z/.freeze
130
- WILDCARD = /\A_(?:#{IDENTIFIER})?\Z/.freeze
131
-
132
- FUNCALL = /\A\##{METHOD_NAME}/.freeze
133
- LITERAL = /\A(?:#{SYMBOL}|#{NUMBER}|#{STRING})\Z/.freeze
134
- PARAM = /\A#{PARAM_NUMBER}\Z/.freeze
135
- CLOSING = /\A(?:\)|\}|\])\Z/.freeze
136
-
137
- REST = '...'
138
- CAPTURED_REST = '$...'
139
-
140
- attr_reader :match_code, :tokens, :captures
141
-
142
- SEQ_HEAD_INDEX = -1
143
-
144
- # Placeholders while compiling, see with_..._context methods
145
- CUR_PLACEHOLDER = '@@@cur'
146
- CUR_NODE = "#{CUR_PLACEHOLDER} node@@@"
147
- CUR_ELEMENT = "#{CUR_PLACEHOLDER} element@@@"
148
- SEQ_HEAD_GUARD = '@@@seq guard head@@@'
149
-
150
- line = __LINE__
151
- ANY_ORDER_TEMPLATE = ERB.new <<~RUBY.gsub("-%>\n", '%>')
152
- <% if capture_rest %>(<%= capture_rest %> = []) && <% end -%>
153
- <% if capture_all %>(<%= capture_all %> = <% end -%>
154
- <%= CUR_NODE %>.children[<%= range %>]<% if capture_all %>)<% end -%>
155
- .each_with_object({}) { |<%= child %>, <%= matched %>|
156
- case
157
- <% patterns.each_with_index do |pattern, i| -%>
158
- when !<%= matched %>[<%= i %>] && <%=
159
- with_context(pattern, child, use_temp_node: false)
160
- %> then <%= matched %>[<%= i %>] = true
161
- <% end -%>
162
- <% if !rest %> else break({})
163
- <% elsif capture_rest %> else <%= capture_rest %> << <%= child %>
164
- <% end -%>
165
- end
166
- }.size == <%= patterns.size -%>
167
- RUBY
168
- ANY_ORDER_TEMPLATE.location = [__FILE__, line + 1]
169
-
170
- line = __LINE__
171
- REPEATED_TEMPLATE = ERB.new <<~RUBY.gsub("-%>\n", '%>')
172
- <% if captured %>(<%= accumulate %> = Array.new) && <% end %>
173
- <%= CUR_NODE %>.children[<%= range %>].all? do |<%= child %>|
174
- <%= with_context(expr, child, use_temp_node: false) %><% if captured %>&&
175
- <%= accumulate %>.push(<%= captured %>)<% end %>
176
- end <% if captured %>&&
177
- (<%= captured %> = if <%= accumulate %>.empty?
178
- <%= captured %>.map{[]} # Transpose hack won't work for empty case
179
- else
180
- <%= accumulate %>.transpose
181
- end) <% end -%>
182
- RUBY
183
- REPEATED_TEMPLATE.location = [__FILE__, line + 1]
184
-
185
- def initialize(str, node_var = 'node0')
186
- @string = str
187
- @root = node_var
188
-
189
- @temps = 0 # avoid name clashes between temp variables
190
- @captures = 0 # number of captures seen
191
- @unify = {} # named wildcard -> temp variable number
192
- @params = 0 # highest % (param) number seen
193
- run(node_var)
194
- end
195
-
196
- def run(node_var)
197
- @tokens = Compiler.tokens(@string)
198
-
199
- @match_code = with_context(compile_expr, node_var, use_temp_node: false)
200
- @match_code.prepend("(captures = Array.new(#{@captures})) && ") \
201
- if @captures.positive?
202
-
203
- fail_due_to('unbalanced pattern') unless tokens.empty?
204
- end
205
-
206
- # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
207
- def compile_expr(token = tokens.shift)
208
- # read a single pattern-matching expression from the token stream,
209
- # return Ruby code which performs the corresponding matching operation
210
- #
211
- # the 'pattern-matching' expression may be a composite which
212
- # contains an arbitrary number of sub-expressions, but that composite
213
- # must all have precedence higher or equal to that of `&&`
214
- #
215
- # Expressions may use placeholders like:
216
- # CUR_NODE: Ruby code that evaluates to an AST node
217
- # CUR_ELEMENT: Either the node or the type if in first element of
218
- # a sequence (aka seq_head, e.g. "(seq_head first_node_arg ...")
219
- case token
220
- when '(' then compile_seq
221
- when '{' then compile_union
222
- when '[' then compile_intersect
223
- when '!' then compile_negation
224
- when '$' then compile_capture
225
- when '^' then compile_ascend
226
- when WILDCARD then compile_wildcard(token[1..-1])
227
- when FUNCALL then compile_funcall(token)
228
- when LITERAL then compile_literal(token)
229
- when PREDICATE then compile_predicate(token)
230
- when NODE then compile_nodetype(token)
231
- when PARAM then compile_param(token[1..-1])
232
- when CLOSING then fail_due_to("#{token} in invalid position")
233
- when nil then fail_due_to('pattern ended prematurely')
234
- else fail_due_to("invalid token #{token.inspect}")
235
- end
236
- end
237
- # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
238
-
239
- def tokens_until(stop, what)
240
- return to_enum __method__, stop, what unless block_given?
241
-
242
- fail_due_to("empty #{what}") if tokens.first == stop && what
243
- yield until tokens.first == stop
244
- tokens.shift
245
- end
246
-
247
- def compile_seq
248
- terms = tokens_until(')', 'sequence').map { variadic_seq_term }
249
- Sequence.new(self, *terms).compile
250
- end
251
-
252
- def compile_guard_clause
253
- "#{CUR_NODE}.is_a?(RuboCop::AST::Node)"
254
- end
255
-
256
- def variadic_seq_term
257
- token = tokens.shift
258
- case token
259
- when CAPTURED_REST then compile_captured_ellipsis
260
- when REST then compile_ellipsis
261
- when '$<' then compile_any_order(next_capture)
262
- when '<' then compile_any_order
263
- else compile_repeated_expr(token)
264
- end
265
- end
266
-
267
- def compile_repeated_expr(token)
268
- before = @captures
269
- expr = compile_expr(token)
270
- min, max = parse_repetition_token
271
- return [1, expr] if min.nil?
272
-
273
- if @captures != before
274
- captured = "captures[#{before}...#{@captures}]"
275
- accumulate = next_temp_variable(:accumulate)
276
- end
277
- arity = min..max || Float::INFINITY
278
-
279
- [arity, repeated_generator(expr, captured, accumulate)]
280
- end
281
-
282
- def repeated_generator(expr, captured, accumulate)
283
- with_temp_variables do |child|
284
- lambda do |range|
285
- if range.begin == SEQ_HEAD_INDEX
286
- fail_due_to 'repeated pattern at beginning of sequence'
287
- end
288
- REPEATED_TEMPLATE.result(binding)
289
- end
290
- end
291
- end
292
-
293
- def parse_repetition_token
294
- case tokens.first
295
- when '*' then min = 0
296
- when '+' then min = 1
297
- when '?' then min = 0
298
- max = 1
299
- else return
300
- end
301
- tokens.shift
302
- [min, max]
303
- end
304
-
305
- # @private
306
- # Builds Ruby code for a sequence
307
- # (head *first_terms variadic_term *last_terms)
308
- class Sequence < SimpleDelegator
309
- def initialize(compiler, *arity_term_list)
310
- @arities, @terms = arity_term_list.transpose
311
-
312
- super(compiler)
313
- @variadic_index = @arities.find_index { |a| a.is_a?(Range) }
314
- fail_due_to 'multiple variable patterns in same sequence' \
315
- if @variadic_index && !@arities.one? { |a| a.is_a?(Range) }
316
- end
317
-
318
- def compile
319
- [
320
- compile_guard_clause,
321
- compile_child_nb_guard,
322
- compile_seq_head,
323
- *compile_first_terms,
324
- compile_variadic_term,
325
- *compile_last_terms
326
- ].compact.join(" &&\n") << SEQ_HEAD_GUARD
327
- end
328
-
329
- private
330
-
331
- def first_terms_arity
332
- first_terms_range { |r| @arities[r].inject(0, :+) } || 0
333
- end
334
-
335
- def last_terms_arity
336
- last_terms_range { |r| @arities[r].inject(0, :+) } || 0
337
- end
338
-
339
- def variadic_term_min_arity
340
- @variadic_index ? @arities[@variadic_index].begin : 0
341
- end
342
-
343
- def first_terms_range
344
- yield 1..(@variadic_index || @terms.size) - 1 if seq_head?
345
- end
346
-
347
- def last_terms_range
348
- yield @variadic_index + 1...@terms.size if @variadic_index
349
- end
350
-
351
- def seq_head?
352
- @variadic_index != 0
353
- end
354
-
355
- def compile_child_nb_guard
356
- fixed = first_terms_arity + last_terms_arity
357
- min = fixed + variadic_term_min_arity
358
- op = if @variadic_index
359
- max_variadic = @arities[@variadic_index].end
360
- if max_variadic != Float::INFINITY
361
- range = min..fixed + max_variadic
362
- return "(#{range}).cover?(#{CUR_NODE}.children.size)"
363
- end
364
- '>='
365
- else
366
- '=='
367
- end
368
- "#{CUR_NODE}.children.size #{op} #{min}"
369
- end
370
-
371
- def term(index, range)
372
- t = @terms[index]
373
- if t.respond_to? :call
374
- t.call(range)
375
- else
376
- with_child_context(t, range.begin)
377
- end
378
- end
379
-
380
- def compile_seq_head
381
- return unless seq_head?
382
-
383
- fail_due_to 'sequences can not start with <' \
384
- if @terms[0].respond_to? :call
385
-
386
- with_seq_head_context(@terms[0])
387
- end
388
-
389
- def compile_first_terms
390
- first_terms_range { |range| compile_terms(range, 0) }
391
- end
392
-
393
- def compile_last_terms
394
- last_terms_range { |r| compile_terms(r, -last_terms_arity) }
395
- end
396
-
397
- def compile_terms(index_range, start)
398
- index_range.map do |i|
399
- current = start
400
- start += @arities.fetch(i)
401
- term(i, current..start - 1)
402
- end
403
- end
404
-
405
- def compile_variadic_term
406
- variadic_arity { |arity| term(@variadic_index, arity) }
407
- end
408
-
409
- def variadic_arity
410
- return unless @variadic_index
411
-
412
- first = @variadic_index.positive? ? first_terms_arity : SEQ_HEAD_INDEX
413
- yield first..-last_terms_arity - 1
414
- end
415
- end
416
- private_constant :Sequence
417
-
418
- def compile_captured_ellipsis
419
- capture = next_capture
420
- block = lambda { |range|
421
- # Consider ($...) like (_ $...):
422
- range = 0..range.end if range.begin == SEQ_HEAD_INDEX
423
- "(#{capture} = #{CUR_NODE}.children[#{range}])"
424
- }
425
- [0..Float::INFINITY, block]
426
- end
427
-
428
- def compile_ellipsis
429
- [0..Float::INFINITY, 'true']
430
- end
431
-
432
- # rubocop:disable Metrics/MethodLength
433
- def compile_any_order(capture_all = nil)
434
- rest = capture_rest = nil
435
- patterns = []
436
- with_temp_variables do |child, matched|
437
- tokens_until('>', 'any child').each do
438
- fail_due_to 'ellipsis must be at the end of <>' if rest
439
- token = tokens.shift
440
- case token
441
- when CAPTURED_REST then rest = capture_rest = next_capture
442
- when REST then rest = true
443
- else patterns << compile_expr(token)
444
- end
445
- end
446
- [rest ? patterns.size..Float::INFINITY : patterns.size,
447
- ->(range) { ANY_ORDER_TEMPLATE.result(binding) }]
448
- end
449
- end
450
- # rubocop:enable Metrics/MethodLength
451
-
452
- def insure_same_captures(enum, what)
453
- return to_enum __method__, enum, what unless block_given?
454
-
455
- captures_before = captures_after = nil
456
- enum.each do
457
- captures_before ||= @captures
458
- @captures = captures_before
459
- yield
460
- captures_after ||= @captures
461
- if captures_after != @captures
462
- fail_due_to("each #{what} must have same # of captures")
463
- end
464
- end
465
- end
466
-
467
- def compile_union
468
- # we need to ensure that each branch of the {} contains the same
469
- # number of captures (since only one branch of the {} can actually
470
- # match, the same variables are used to hold the captures for each
471
- # branch)
472
- enum = tokens_until('}', 'union')
473
- terms = insure_same_captures(enum, 'branch of {}')
474
- .map { compile_expr }
475
-
476
- "(#{terms.join(' || ')})"
477
- end
478
-
479
- def compile_intersect
480
- tokens_until(']', 'intersection')
481
- .map { compile_expr }
482
- .join(' && ')
483
- end
484
-
485
- def compile_capture
486
- "(#{next_capture} = #{CUR_ELEMENT}; #{compile_expr})"
487
- end
488
-
489
- def compile_negation
490
- "!(#{compile_expr})"
491
- end
492
-
493
- def compile_ascend
494
- with_context("#{CUR_NODE} && #{compile_expr}", "#{CUR_NODE}.parent")
495
- end
496
-
497
- def compile_wildcard(name)
498
- if name.empty?
499
- 'true'
500
- elsif @unify.key?(name)
501
- # we have already seen a wildcard with this name before
502
- # so the value it matched the first time will already be stored
503
- # in a temp. check if this value matches the one stored in the temp
504
- "#{CUR_ELEMENT} == temp#{@unify[name]}"
505
- else
506
- n = @unify[name] = next_temp_value
507
- # double assign to temp#{n} to avoid "assigned but unused variable"
508
- "(temp#{n} = #{CUR_ELEMENT}; " \
509
- "temp#{n} = temp#{n}; true)"
510
- end
511
- end
512
-
513
- def compile_literal(literal)
514
- "#{CUR_ELEMENT} == #{literal}"
515
- end
516
-
517
- def compile_predicate(predicate)
518
- if predicate.end_with?('(') # is there an arglist?
519
- args = compile_args(tokens)
520
- predicate = predicate[0..-2] # drop the trailing (
521
- "#{CUR_ELEMENT}.#{predicate}(#{args.join(',')})"
522
- else
523
- "#{CUR_ELEMENT}.#{predicate}"
524
- end
525
- end
526
-
527
- def compile_funcall(method)
528
- # call a method in the context which this pattern-matching
529
- # code is used in. pass target value as an argument
530
- method = method[1..-1] # drop the leading #
531
- if method.end_with?('(') # is there an arglist?
532
- args = compile_args(tokens)
533
- method = method[0..-2] # drop the trailing (
534
- "#{method}(#{CUR_ELEMENT},#{args.join(',')})"
535
- else
536
- "#{method}(#{CUR_ELEMENT})"
537
- end
538
- end
539
-
540
- def compile_nodetype(type)
541
- "#{compile_guard_clause} && #{CUR_NODE}.#{type.tr('-', '_')}_type?"
542
- end
543
-
544
- def compile_param(number)
545
- "#{CUR_ELEMENT} == #{get_param(number)}"
546
- end
547
-
548
- def compile_args(tokens)
549
- index = tokens.find_index { |token| token == ')' }
550
-
551
- tokens.slice!(0..index).each_with_object([]) do |token, args|
552
- next if [')', ','].include?(token)
553
-
554
- args << compile_arg(token)
555
- end
556
- end
557
-
558
- def compile_arg(token)
559
- case token
560
- when WILDCARD then
561
- name = token[1..-1]
562
- number = @unify[name] || fail_due_to('invalid in arglist: ' + token)
563
- "temp#{number}"
564
- when LITERAL then token
565
- when PARAM then get_param(token[1..-1])
566
- when CLOSING then fail_due_to("#{token} in invalid position")
567
- when nil then fail_due_to('pattern ended prematurely')
568
- else fail_due_to("invalid token in arglist: #{token.inspect}")
569
- end
570
- end
571
-
572
- def next_capture
573
- index = @captures
574
- @captures += 1
575
- "captures[#{index}]"
576
- end
577
-
578
- def get_param(number)
579
- number = number.empty? ? 1 : Integer(number)
580
- @params = number if number > @params
581
- number.zero? ? @root : "param#{number}"
582
- end
583
-
584
- def emit_yield_capture(when_no_capture = '')
585
- yield_val = if @captures.zero?
586
- when_no_capture
587
- elsif @captures == 1
588
- 'captures[0]' # Circumvent https://github.com/jruby/jruby/issues/5710
589
- else
590
- '*captures'
591
- end
592
- "yield(#{yield_val})"
593
- end
594
-
595
- def emit_retval
596
- if @captures.zero?
597
- 'true'
598
- elsif @captures == 1
599
- 'captures[0]'
600
- else
601
- 'captures'
602
- end
603
- end
604
-
605
- def emit_param_list
606
- (1..@params).map { |n| "param#{n}" }.join(',')
607
- end
608
-
609
- def emit_trailing_params
610
- params = emit_param_list
611
- params.empty? ? '' : ",#{params}"
612
- end
613
-
614
- def emit_method_code
615
- <<~RUBY
616
- return unless #{@match_code}
617
- block_given? ? #{emit_yield_capture} : (return #{emit_retval})
618
- RUBY
619
- end
620
-
621
- def fail_due_to(message)
622
- raise Invalid, "Couldn't compile due to #{message}. Pattern: #{@string}"
623
- end
624
-
625
- def with_temp_node(cur_node)
626
- with_temp_variables do |node|
627
- yield "(#{node} = #{cur_node})", node
628
- end
629
- .gsub("\n", "\n ") # Nicer indent for debugging
630
- end
631
-
632
- def with_temp_variables(&block)
633
- names = block.parameters.map { |_, name| next_temp_variable(name) }
634
- yield(*names)
635
- end
636
-
637
- def next_temp_variable(name)
638
- "#{name}#{next_temp_value}"
639
- end
640
-
641
- def next_temp_value
642
- @temps += 1
643
- end
644
-
645
- def auto_use_temp_node?(code)
646
- code.scan(CUR_PLACEHOLDER).count > 1
647
- end
648
-
649
- # with_<...>_context methods are used whenever the context,
650
- # i.e the current node or the current element can be determined.
651
-
652
- def with_child_context(code, child_index)
653
- with_context(code, "#{CUR_NODE}.children[#{child_index}]")
654
- end
655
-
656
- def with_context(code, cur_node,
657
- use_temp_node: auto_use_temp_node?(code))
658
- if use_temp_node
659
- with_temp_node(cur_node) do |init, temp_var|
660
- substitute_cur_node(code, temp_var, first_cur_node: init)
661
- end
662
- else
663
- substitute_cur_node(code, cur_node)
664
- end
665
- end
666
-
667
- def with_seq_head_context(code)
668
- if code.include?(SEQ_HEAD_GUARD)
669
- fail_due_to('parentheses at sequence head')
670
- end
671
-
672
- code.gsub CUR_ELEMENT, "#{CUR_NODE}.type"
673
- end
674
-
675
- def substitute_cur_node(code, cur_node, first_cur_node: cur_node)
676
- iter = 0
677
- code
678
- .gsub(CUR_ELEMENT, CUR_NODE)
679
- .gsub(CUR_NODE) do
680
- iter += 1
681
- iter == 1 ? first_cur_node : cur_node
682
- end
683
- .gsub(SEQ_HEAD_GUARD, '')
684
- end
685
-
686
- def self.tokens(pattern)
687
- pattern.scan(TOKEN).reject { |token| token =~ /\A#{SEPARATORS}\Z/ }
688
- end
689
- end
690
- private_constant :Compiler
691
-
692
- # Helpers for defining methods based on a pattern string
693
- module Macros
694
- # Define a method which applies a pattern to an AST node
695
- #
696
- # The new method will return nil if the node does not match
697
- # If the node matches, and a block is provided, the new method will
698
- # yield to the block (passing any captures as block arguments).
699
- # If the node matches, and no block is provided, the new method will
700
- # return the captures, or `true` if there were none.
701
- def def_node_matcher(method_name, pattern_str)
702
- compiler = Compiler.new(pattern_str, 'node')
703
- src = "def #{method_name}(node = self" \
704
- "#{compiler.emit_trailing_params});" \
705
- "#{compiler.emit_method_code};end"
706
-
707
- location = caller_locations(1, 1).first
708
- class_eval(src, location.path, location.lineno)
709
- end
710
-
711
- # Define a method which recurses over the descendants of an AST node,
712
- # checking whether any of them match the provided pattern
713
- #
714
- # If the method name ends with '?', the new method will return `true`
715
- # as soon as it finds a descendant which matches. Otherwise, it will
716
- # yield all descendants which match.
717
- def def_node_search(method_name, pattern_str)
718
- compiler = Compiler.new(pattern_str, 'node')
719
- called_from = caller(1..1).first.split(':')
720
-
721
- if method_name.to_s.end_with?('?')
722
- node_search_first(method_name, compiler, called_from)
723
- else
724
- node_search_all(method_name, compiler, called_from)
725
- end
726
- end
727
-
728
- def node_search_first(method_name, compiler, called_from)
729
- node_search(method_name, compiler, 'return true', '', called_from)
730
- end
731
-
732
- def node_search_all(method_name, compiler, called_from)
733
- yield_code = compiler.emit_yield_capture('node')
734
- prelude = "return enum_for(:#{method_name}, node0" \
735
- "#{compiler.emit_trailing_params}) unless block_given?"
736
-
737
- node_search(method_name, compiler, yield_code, prelude, called_from)
738
- end
739
-
740
- def node_search(method_name, compiler, on_match, prelude, called_from)
741
- src = node_search_body(method_name, compiler.emit_trailing_params,
742
- prelude, compiler.match_code, on_match)
743
- filename, lineno = *called_from
744
- class_eval(src, filename, lineno.to_i)
745
- end
746
-
747
- def node_search_body(method_name, trailing_params, prelude, match_code,
748
- on_match)
749
- <<~RUBY
750
- def #{method_name}(node0#{trailing_params})
751
- #{prelude}
752
- node0.each_node do |node|
753
- if #{match_code}
754
- #{on_match}
755
- end
756
- end
757
- nil
758
- end
759
- RUBY
760
- end
761
- end
762
-
763
- attr_reader :pattern
764
-
765
- def initialize(str)
766
- @pattern = str
767
- compiler = Compiler.new(str)
768
- src = "def match(node0#{compiler.emit_trailing_params});" \
769
- "#{compiler.emit_method_code}end"
770
- instance_eval(src, __FILE__, __LINE__ + 1)
771
- end
772
-
773
- def match(*args)
774
- # If we're here, it's because the singleton method has not been defined,
775
- # either because we've been dup'ed or serialized through YAML
776
- initialize(pattern)
777
- match(*args)
778
- end
779
-
780
- def marshal_load(pattern)
781
- initialize pattern
782
- end
783
-
784
- def marshal_dump
785
- pattern
786
- end
787
-
788
- def ==(other)
789
- other.is_a?(NodePattern) &&
790
- Compiler.tokens(other.pattern) == Compiler.tokens(pattern)
791
- end
792
- alias eql? ==
793
-
794
- def to_s
795
- "#<#{self.class} #{pattern}>"
796
- end
797
- end
798
- end
799
- # rubocop:enable Metrics/ClassLength, Metrics/CyclomaticComplexity