rubocop 0.82.0 → 1.18.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (744) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.txt +1 -1
  3. data/README.md +69 -37
  4. data/assets/output.html.erb +1 -1
  5. data/config/default.yml +1025 -139
  6. data/config/obsoletion.yml +200 -0
  7. data/exe/rubocop +2 -4
  8. data/lib/rubocop.rb +137 -68
  9. data/lib/rubocop/ast_aliases.rb +8 -0
  10. data/lib/rubocop/cached_data.rb +4 -4
  11. data/lib/rubocop/cli.rb +11 -11
  12. data/lib/rubocop/cli/command.rb +1 -0
  13. data/lib/rubocop/cli/command/auto_genenerate_config.rb +46 -19
  14. data/lib/rubocop/cli/command/base.rb +2 -0
  15. data/lib/rubocop/cli/command/execute_runner.rb +36 -12
  16. data/lib/rubocop/cli/command/init_dotfile.rb +3 -4
  17. data/lib/rubocop/cli/command/show_cops.rb +6 -12
  18. data/lib/rubocop/cli/command/suggest_extensions.rb +81 -0
  19. data/lib/rubocop/cli/command/version.rb +3 -2
  20. data/lib/rubocop/cli/environment.rb +1 -0
  21. data/lib/rubocop/comment_config.rb +54 -103
  22. data/lib/rubocop/config.rb +45 -29
  23. data/lib/rubocop/config_loader.rb +101 -106
  24. data/lib/rubocop/config_loader_resolver.rb +100 -29
  25. data/lib/rubocop/config_obsoletion.rb +67 -242
  26. data/lib/rubocop/config_obsoletion/changed_enforced_styles.rb +33 -0
  27. data/lib/rubocop/config_obsoletion/changed_parameter.rb +21 -0
  28. data/lib/rubocop/config_obsoletion/cop_rule.rb +33 -0
  29. data/lib/rubocop/config_obsoletion/extracted_cop.rb +44 -0
  30. data/lib/rubocop/config_obsoletion/parameter_rule.rb +44 -0
  31. data/lib/rubocop/config_obsoletion/removed_cop.rb +41 -0
  32. data/lib/rubocop/config_obsoletion/renamed_cop.rb +34 -0
  33. data/lib/rubocop/config_obsoletion/rule.rb +41 -0
  34. data/lib/rubocop/config_obsoletion/split_cop.rb +27 -0
  35. data/lib/rubocop/config_regeneration.rb +33 -0
  36. data/lib/rubocop/config_store.rb +31 -7
  37. data/lib/rubocop/config_validator.rb +53 -28
  38. data/lib/rubocop/cop/autocorrect_logic.rb +37 -38
  39. data/lib/rubocop/cop/badge.rb +11 -27
  40. data/lib/rubocop/cop/base.rb +450 -0
  41. data/lib/rubocop/cop/bundler/duplicated_gem.rb +31 -7
  42. data/lib/rubocop/cop/bundler/gem_comment.rb +117 -10
  43. data/lib/rubocop/cop/bundler/gem_version.rb +133 -0
  44. data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +13 -20
  45. data/lib/rubocop/cop/bundler/ordered_gems.rb +2 -4
  46. data/lib/rubocop/cop/commissioner.rb +98 -74
  47. data/lib/rubocop/cop/cop.rb +84 -234
  48. data/lib/rubocop/cop/corrector.rb +41 -119
  49. data/lib/rubocop/cop/correctors/alignment_corrector.rb +11 -21
  50. data/lib/rubocop/cop/correctors/condition_corrector.rb +3 -5
  51. data/lib/rubocop/cop/correctors/each_to_for_corrector.rb +2 -4
  52. data/lib/rubocop/cop/correctors/empty_line_corrector.rb +9 -10
  53. data/lib/rubocop/cop/correctors/for_to_each_corrector.rb +1 -2
  54. data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb +1 -1
  55. data/lib/rubocop/cop/correctors/line_break_corrector.rb +8 -11
  56. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +35 -6
  57. data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb +1 -3
  58. data/lib/rubocop/cop/correctors/parentheses_corrector.rb +5 -8
  59. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +10 -21
  60. data/lib/rubocop/cop/correctors/punctuation_corrector.rb +8 -10
  61. data/lib/rubocop/cop/correctors/space_corrector.rb +1 -3
  62. data/lib/rubocop/cop/correctors/string_literal_corrector.rb +6 -8
  63. data/lib/rubocop/cop/correctors/unused_arg_corrector.rb +15 -18
  64. data/lib/rubocop/cop/documentation.rb +22 -0
  65. data/lib/rubocop/cop/exclude_limit.rb +26 -0
  66. data/lib/rubocop/cop/force.rb +2 -1
  67. data/lib/rubocop/cop/gemspec/date_assignment.rb +57 -0
  68. data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +6 -5
  69. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +3 -7
  70. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +48 -20
  71. data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +4 -2
  72. data/lib/rubocop/cop/generator.rb +12 -22
  73. data/lib/rubocop/cop/generator/configuration_injector.rb +4 -5
  74. data/lib/rubocop/cop/generator/require_file_injector.rb +2 -5
  75. data/lib/rubocop/cop/ignored_node.rb +1 -3
  76. data/lib/rubocop/cop/internal_affairs.rb +7 -1
  77. data/lib/rubocop/cop/internal_affairs/empty_line_between_expect_offense_and_correction.rb +68 -0
  78. data/lib/rubocop/cop/internal_affairs/example_description.rb +92 -0
  79. data/lib/rubocop/cop/internal_affairs/method_name_equal.rb +8 -17
  80. data/lib/rubocop/cop/internal_affairs/node_destructuring.rb +4 -4
  81. data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +151 -0
  82. data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +11 -14
  83. data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb +12 -10
  84. data/lib/rubocop/cop/internal_affairs/redundant_described_class_as_subject.rb +62 -0
  85. data/lib/rubocop/cop/internal_affairs/redundant_let_rubocop_config_new.rb +65 -0
  86. data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +12 -7
  87. data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +11 -8
  88. data/lib/rubocop/cop/internal_affairs/style_detected_api_use.rb +148 -0
  89. data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +6 -6
  90. data/lib/rubocop/cop/layout/access_modifier_indentation.rb +12 -10
  91. data/lib/rubocop/cop/layout/argument_alignment.rb +36 -19
  92. data/lib/rubocop/cop/layout/array_alignment.rb +10 -8
  93. data/lib/rubocop/cop/layout/assignment_indentation.rb +8 -7
  94. data/lib/rubocop/cop/layout/begin_end_alignment.rb +74 -0
  95. data/lib/rubocop/cop/layout/block_alignment.rb +36 -44
  96. data/lib/rubocop/cop/layout/block_end_newline.rb +4 -8
  97. data/lib/rubocop/cop/layout/case_indentation.rb +72 -30
  98. data/lib/rubocop/cop/layout/class_structure.rb +62 -74
  99. data/lib/rubocop/cop/layout/closing_heredoc_indentation.rb +4 -6
  100. data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +24 -30
  101. data/lib/rubocop/cop/layout/comment_indentation.rb +22 -26
  102. data/lib/rubocop/cop/layout/condition_position.rb +16 -8
  103. data/lib/rubocop/cop/layout/def_end_alignment.rb +9 -10
  104. data/lib/rubocop/cop/layout/dot_position.rb +26 -21
  105. data/lib/rubocop/cop/layout/else_alignment.rb +25 -11
  106. data/lib/rubocop/cop/layout/empty_comment.rb +29 -29
  107. data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +51 -36
  108. data/lib/rubocop/cop/layout/empty_line_after_magic_comment.rb +13 -13
  109. data/lib/rubocop/cop/layout/empty_line_after_multiline_condition.rb +136 -0
  110. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +140 -40
  111. data/lib/rubocop/cop/layout/empty_lines.rb +7 -12
  112. data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +29 -38
  113. data/lib/rubocop/cop/layout/empty_lines_around_arguments.rb +13 -9
  114. data/lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb +118 -0
  115. data/lib/rubocop/cop/layout/empty_lines_around_begin_body.rb +2 -5
  116. data/lib/rubocop/cop/layout/empty_lines_around_block_body.rb +2 -5
  117. data/lib/rubocop/cop/layout/empty_lines_around_class_body.rb +2 -5
  118. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +4 -14
  119. data/lib/rubocop/cop/layout/empty_lines_around_method_body.rb +2 -5
  120. data/lib/rubocop/cop/layout/empty_lines_around_module_body.rb +2 -5
  121. data/lib/rubocop/cop/layout/end_alignment.rb +24 -23
  122. data/lib/rubocop/cop/layout/end_of_line.rb +8 -8
  123. data/lib/rubocop/cop/layout/extra_spacing.rb +23 -42
  124. data/lib/rubocop/cop/layout/first_argument_indentation.rb +40 -13
  125. data/lib/rubocop/cop/layout/first_array_element_indentation.rb +13 -13
  126. data/lib/rubocop/cop/layout/first_array_element_line_break.rb +4 -8
  127. data/lib/rubocop/cop/layout/first_hash_element_indentation.rb +36 -20
  128. data/lib/rubocop/cop/layout/first_hash_element_line_break.rb +3 -7
  129. data/lib/rubocop/cop/layout/first_method_argument_line_break.rb +6 -13
  130. data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb +3 -7
  131. data/lib/rubocop/cop/layout/first_parameter_indentation.rb +9 -8
  132. data/lib/rubocop/cop/layout/hash_alignment.rb +76 -57
  133. data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +45 -29
  134. data/lib/rubocop/cop/layout/heredoc_indentation.rb +32 -116
  135. data/lib/rubocop/cop/layout/indentation_consistency.rb +9 -6
  136. data/lib/rubocop/cop/layout/indentation_style.rb +25 -32
  137. data/lib/rubocop/cop/layout/indentation_width.rb +34 -15
  138. data/lib/rubocop/cop/layout/initial_indentation.rb +7 -11
  139. data/lib/rubocop/cop/layout/leading_comment_space.rb +12 -10
  140. data/lib/rubocop/cop/layout/leading_empty_lines.rb +6 -11
  141. data/lib/rubocop/cop/layout/line_end_string_concatenation_indentation.rb +122 -0
  142. data/lib/rubocop/cop/layout/line_length.rb +37 -47
  143. data/lib/rubocop/cop/layout/multiline_array_brace_layout.rb +8 -11
  144. data/lib/rubocop/cop/layout/multiline_array_line_breaks.rb +3 -7
  145. data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +38 -16
  146. data/lib/rubocop/cop/layout/multiline_block_layout.rb +41 -37
  147. data/lib/rubocop/cop/layout/multiline_hash_brace_layout.rb +8 -11
  148. data/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb +3 -7
  149. data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +6 -13
  150. data/lib/rubocop/cop/layout/multiline_method_call_brace_layout.rb +8 -11
  151. data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +29 -18
  152. data/lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb +8 -11
  153. data/lib/rubocop/cop/layout/multiline_operation_indentation.rb +26 -12
  154. data/lib/rubocop/cop/layout/parameter_alignment.rb +8 -7
  155. data/lib/rubocop/cop/layout/redundant_line_break.rb +139 -0
  156. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +37 -30
  157. data/lib/rubocop/cop/layout/single_line_block_chain.rb +53 -0
  158. data/lib/rubocop/cop/layout/space_after_colon.rb +10 -8
  159. data/lib/rubocop/cop/layout/space_after_comma.rb +2 -5
  160. data/lib/rubocop/cop/layout/space_after_method_name.rb +7 -10
  161. data/lib/rubocop/cop/layout/space_after_not.rb +9 -11
  162. data/lib/rubocop/cop/layout/space_after_semicolon.rb +2 -5
  163. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +45 -52
  164. data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb +19 -23
  165. data/lib/rubocop/cop/layout/space_around_keyword.rb +50 -26
  166. data/lib/rubocop/cop/layout/space_around_method_call_operator.rb +34 -69
  167. data/lib/rubocop/cop/layout/space_around_operators.rb +51 -25
  168. data/lib/rubocop/cop/layout/space_before_block_braces.rb +39 -23
  169. data/lib/rubocop/cop/layout/space_before_brackets.rb +65 -0
  170. data/lib/rubocop/cop/layout/space_before_comma.rb +3 -5
  171. data/lib/rubocop/cop/layout/space_before_comment.rb +8 -9
  172. data/lib/rubocop/cop/layout/space_before_first_arg.rb +9 -15
  173. data/lib/rubocop/cop/layout/space_before_semicolon.rb +2 -5
  174. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +11 -21
  175. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +30 -39
  176. data/lib/rubocop/cop/layout/space_inside_array_percent_literal.rb +5 -15
  177. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +32 -37
  178. data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +22 -41
  179. data/lib/rubocop/cop/layout/space_inside_parens.rb +39 -22
  180. data/lib/rubocop/cop/layout/space_inside_percent_literal_delimiters.rb +5 -10
  181. data/lib/rubocop/cop/layout/space_inside_range_literal.rb +8 -17
  182. data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +18 -29
  183. data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +12 -13
  184. data/lib/rubocop/cop/layout/trailing_empty_lines.rb +10 -15
  185. data/lib/rubocop/cop/layout/trailing_whitespace.rb +42 -18
  186. data/lib/rubocop/cop/legacy/corrections_proxy.rb +43 -0
  187. data/lib/rubocop/cop/legacy/corrector.rb +27 -0
  188. data/lib/rubocop/cop/lint/ambiguous_assignment.rb +54 -0
  189. data/lib/rubocop/cop/lint/ambiguous_block_association.rb +21 -9
  190. data/lib/rubocop/cop/lint/ambiguous_operator.rb +53 -5
  191. data/lib/rubocop/cop/lint/ambiguous_regexp_literal.rb +36 -6
  192. data/lib/rubocop/cop/lint/assignment_in_condition.rb +2 -2
  193. data/lib/rubocop/cop/lint/big_decimal_new.rb +10 -10
  194. data/lib/rubocop/cop/lint/binary_operator_with_identical_operands.rb +55 -0
  195. data/lib/rubocop/cop/lint/boolean_symbol.rb +21 -13
  196. data/lib/rubocop/cop/lint/circular_argument_reference.rb +1 -1
  197. data/lib/rubocop/cop/lint/constant_definition_in_block.rb +100 -0
  198. data/lib/rubocop/cop/lint/constant_resolution.rb +89 -0
  199. data/lib/rubocop/cop/lint/debugger.rb +61 -21
  200. data/lib/rubocop/cop/lint/deprecated_class_methods.rb +86 -47
  201. data/lib/rubocop/cop/lint/deprecated_constants.rb +80 -0
  202. data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +148 -0
  203. data/lib/rubocop/cop/lint/disjunctive_assignment_in_constructor.rb +8 -2
  204. data/lib/rubocop/cop/lint/duplicate_branch.rb +155 -0
  205. data/lib/rubocop/cop/lint/duplicate_case_condition.rb +3 -13
  206. data/lib/rubocop/cop/lint/duplicate_elsif_condition.rb +39 -0
  207. data/lib/rubocop/cop/lint/duplicate_hash_key.rb +2 -4
  208. data/lib/rubocop/cop/lint/duplicate_methods.rb +12 -16
  209. data/lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb +77 -0
  210. data/lib/rubocop/cop/lint/duplicate_require.rb +47 -0
  211. data/lib/rubocop/cop/lint/duplicate_rescue_exception.rb +47 -0
  212. data/lib/rubocop/cop/lint/each_with_object_argument.rb +3 -1
  213. data/lib/rubocop/cop/lint/else_layout.rb +29 -5
  214. data/lib/rubocop/cop/lint/empty_block.rb +98 -0
  215. data/lib/rubocop/cop/lint/empty_class.rb +93 -0
  216. data/lib/rubocop/cop/lint/empty_conditional_body.rb +67 -0
  217. data/lib/rubocop/cop/lint/empty_ensure.rb +5 -7
  218. data/lib/rubocop/cop/lint/empty_expression.rb +2 -2
  219. data/lib/rubocop/cop/lint/empty_file.rb +48 -0
  220. data/lib/rubocop/cop/lint/empty_in_pattern.rb +62 -0
  221. data/lib/rubocop/cop/lint/empty_interpolation.rb +4 -7
  222. data/lib/rubocop/cop/lint/empty_when.rb +31 -8
  223. data/lib/rubocop/cop/lint/ensure_return.rb +29 -16
  224. data/lib/rubocop/cop/lint/erb_new_arguments.rb +18 -20
  225. data/lib/rubocop/cop/lint/flip_flop.rb +9 -3
  226. data/lib/rubocop/cop/lint/float_comparison.rb +93 -0
  227. data/lib/rubocop/cop/lint/float_out_of_range.rb +2 -3
  228. data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +45 -10
  229. data/lib/rubocop/cop/lint/hash_compare_by_identity.rb +38 -0
  230. data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +14 -16
  231. data/lib/rubocop/cop/lint/identity_comparison.rb +51 -0
  232. data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +6 -6
  233. data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +14 -20
  234. data/lib/rubocop/cop/lint/inherit_exception.rb +14 -9
  235. data/lib/rubocop/cop/lint/interpolation_check.rb +20 -7
  236. data/lib/rubocop/cop/lint/lambda_without_literal_block.rb +44 -0
  237. data/lib/rubocop/cop/lint/literal_as_condition.rb +37 -16
  238. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +44 -15
  239. data/lib/rubocop/cop/lint/loop.rb +25 -5
  240. data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +35 -23
  241. data/lib/rubocop/cop/lint/missing_super.rb +101 -0
  242. data/lib/rubocop/cop/lint/mixed_regexp_capture_types.rb +36 -0
  243. data/lib/rubocop/cop/lint/multiple_comparison.rb +14 -14
  244. data/lib/rubocop/cop/lint/nested_method_definition.rb +19 -23
  245. data/lib/rubocop/cop/lint/nested_percent_literal.rb +18 -6
  246. data/lib/rubocop/cop/lint/next_without_accumulator.rb +2 -1
  247. data/lib/rubocop/cop/lint/no_return_in_begin_end_blocks.rb +58 -0
  248. data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +95 -15
  249. data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +12 -9
  250. data/lib/rubocop/cop/lint/number_conversion.rb +97 -23
  251. data/lib/rubocop/cop/lint/numbered_parameter_assignment.rb +47 -0
  252. data/lib/rubocop/cop/lint/or_assignment_to_constant.rb +39 -0
  253. data/lib/rubocop/cop/lint/ordered_magic_comments.rb +12 -15
  254. data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +96 -0
  255. data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +31 -12
  256. data/lib/rubocop/cop/lint/percent_string_array.rb +6 -11
  257. data/lib/rubocop/cop/lint/percent_symbol_array.rb +13 -14
  258. data/lib/rubocop/cop/lint/raise_exception.rb +19 -7
  259. data/lib/rubocop/cop/lint/rand_one.rb +5 -4
  260. data/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb +142 -115
  261. data/lib/rubocop/cop/lint/redundant_cop_enable_directive.rb +44 -30
  262. data/lib/rubocop/cop/lint/redundant_dir_glob_sort.rb +50 -0
  263. data/lib/rubocop/cop/lint/redundant_require_statement.rb +9 -10
  264. data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +77 -0
  265. data/lib/rubocop/cop/lint/redundant_splat_expansion.rb +72 -35
  266. data/lib/rubocop/cop/lint/redundant_string_coercion.rb +8 -15
  267. data/lib/rubocop/cop/lint/redundant_with_index.rb +13 -18
  268. data/lib/rubocop/cop/lint/redundant_with_object.rb +13 -18
  269. data/lib/rubocop/cop/lint/regexp_as_condition.rb +4 -2
  270. data/lib/rubocop/cop/lint/require_parentheses.rb +4 -6
  271. data/lib/rubocop/cop/lint/rescue_exception.rb +3 -4
  272. data/lib/rubocop/cop/lint/rescue_type.rb +10 -16
  273. data/lib/rubocop/cop/lint/return_in_void_context.rb +3 -6
  274. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +5 -8
  275. data/lib/rubocop/cop/lint/safe_navigation_consistency.rb +15 -17
  276. data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +12 -4
  277. data/lib/rubocop/cop/lint/script_permission.rb +10 -7
  278. data/lib/rubocop/cop/lint/self_assignment.rb +78 -0
  279. data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +11 -19
  280. data/lib/rubocop/cop/lint/shadowed_argument.rb +8 -14
  281. data/lib/rubocop/cop/lint/shadowed_exception.rb +18 -30
  282. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +21 -7
  283. data/lib/rubocop/cop/lint/struct_new_override.rb +4 -3
  284. data/lib/rubocop/cop/lint/suppressed_exception.rb +53 -6
  285. data/lib/rubocop/cop/lint/symbol_conversion.rb +178 -0
  286. data/lib/rubocop/cop/lint/syntax.rb +11 -30
  287. data/lib/rubocop/cop/lint/to_enum_arguments.rb +89 -0
  288. data/lib/rubocop/cop/lint/to_json.rb +21 -13
  289. data/lib/rubocop/cop/lint/top_level_return_with_argument.rb +34 -0
  290. data/lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb +55 -0
  291. data/lib/rubocop/cop/lint/triple_quotes.rb +71 -0
  292. data/lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb +5 -7
  293. data/lib/rubocop/cop/lint/unexpected_block_arity.rb +85 -0
  294. data/lib/rubocop/cop/lint/unified_integer.rb +5 -6
  295. data/lib/rubocop/cop/lint/unmodified_reduce_accumulator.rb +204 -0
  296. data/lib/rubocop/cop/lint/unreachable_code.rb +5 -7
  297. data/lib/rubocop/cop/lint/unreachable_loop.rb +196 -0
  298. data/lib/rubocop/cop/lint/unused_block_argument.rb +18 -11
  299. data/lib/rubocop/cop/lint/unused_method_argument.rb +11 -6
  300. data/lib/rubocop/cop/lint/uri_escape_unescape.rb +5 -2
  301. data/lib/rubocop/cop/lint/uri_regexp.rb +12 -47
  302. data/lib/rubocop/cop/lint/useless_access_modifier.rb +38 -22
  303. data/lib/rubocop/cop/lint/useless_assignment.rb +10 -14
  304. data/lib/rubocop/cop/lint/useless_else_without_rescue.rb +7 -11
  305. data/lib/rubocop/cop/lint/useless_method_definition.rb +68 -0
  306. data/lib/rubocop/cop/lint/useless_setter_call.rb +12 -10
  307. data/lib/rubocop/cop/lint/useless_times.rb +109 -0
  308. data/lib/rubocop/cop/lint/void.rb +8 -19
  309. data/lib/rubocop/cop/message_annotator.rb +5 -4
  310. data/lib/rubocop/cop/metrics/abc_size.rb +26 -2
  311. data/lib/rubocop/cop/metrics/block_length.rb +40 -10
  312. data/lib/rubocop/cop/metrics/block_nesting.rb +5 -10
  313. data/lib/rubocop/cop/metrics/class_length.rb +40 -11
  314. data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +38 -6
  315. data/lib/rubocop/cop/metrics/method_length.rb +32 -4
  316. data/lib/rubocop/cop/metrics/module_length.rb +29 -9
  317. data/lib/rubocop/cop/metrics/parameter_lists.rb +74 -11
  318. data/lib/rubocop/cop/metrics/perceived_complexity.rb +7 -9
  319. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +76 -15
  320. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +160 -0
  321. data/lib/rubocop/cop/metrics/utils/iterating_block.rb +61 -0
  322. data/lib/rubocop/cop/metrics/utils/repeated_attribute_discount.rb +143 -0
  323. data/lib/rubocop/cop/metrics/utils/repeated_csend_discount.rb +42 -0
  324. data/lib/rubocop/cop/migration/department_name.rb +25 -29
  325. data/lib/rubocop/cop/mixin/alignment.rb +18 -11
  326. data/lib/rubocop/cop/mixin/allowed_identifiers.rb +18 -0
  327. data/lib/rubocop/cop/mixin/allowed_methods.rb +21 -0
  328. data/lib/rubocop/cop/mixin/annotation_comment.rb +5 -0
  329. data/lib/rubocop/cop/mixin/array_min_size.rb +2 -4
  330. data/lib/rubocop/cop/mixin/auto_corrector.rb +12 -0
  331. data/lib/rubocop/cop/mixin/check_line_breakable.rb +51 -18
  332. data/lib/rubocop/cop/mixin/code_length.rb +29 -8
  333. data/lib/rubocop/cop/mixin/comments_help.rb +42 -0
  334. data/lib/rubocop/cop/mixin/configurable_enforced_style.rb +3 -5
  335. data/lib/rubocop/cop/mixin/configurable_formatting.rb +4 -11
  336. data/lib/rubocop/cop/mixin/configurable_max.rb +1 -0
  337. data/lib/rubocop/cop/mixin/configurable_naming.rb +2 -2
  338. data/lib/rubocop/cop/mixin/configurable_numbering.rb +4 -3
  339. data/lib/rubocop/cop/mixin/def_node.rb +3 -5
  340. data/lib/rubocop/cop/mixin/documentation_comment.rb +4 -7
  341. data/lib/rubocop/cop/mixin/empty_lines_around_body.rb +14 -14
  342. data/lib/rubocop/cop/mixin/empty_parameter.rb +2 -1
  343. data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +11 -2
  344. data/lib/rubocop/cop/mixin/enforce_superclass.rb +16 -8
  345. data/lib/rubocop/cop/mixin/first_element_line_break.rb +3 -3
  346. data/lib/rubocop/cop/mixin/frozen_string_literal.rb +14 -5
  347. data/lib/rubocop/cop/mixin/gem_declaration.rb +13 -0
  348. data/lib/rubocop/cop/mixin/hash_alignment_styles.rb +17 -9
  349. data/lib/rubocop/cop/mixin/hash_transform_method.rb +48 -31
  350. data/lib/rubocop/cop/mixin/ignored_methods.rb +36 -3
  351. data/lib/rubocop/cop/mixin/ignored_pattern.rb +1 -1
  352. data/lib/rubocop/cop/mixin/interpolation.rb +1 -3
  353. data/lib/rubocop/cop/mixin/line_length_help.rb +17 -15
  354. data/lib/rubocop/cop/mixin/match_range.rb +2 -5
  355. data/lib/rubocop/cop/mixin/method_complexity.rb +21 -6
  356. data/lib/rubocop/cop/mixin/method_preference.rb +1 -2
  357. data/lib/rubocop/cop/mixin/multiline_element_indentation.rb +4 -3
  358. data/lib/rubocop/cop/mixin/multiline_element_line_breaks.rb +1 -1
  359. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +13 -42
  360. data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb +14 -14
  361. data/lib/rubocop/cop/mixin/negative_conditional.rb +6 -4
  362. data/lib/rubocop/cop/mixin/nil_methods.rb +3 -5
  363. data/lib/rubocop/cop/mixin/ordered_gem_node.rb +7 -5
  364. data/lib/rubocop/cop/mixin/parentheses.rb +1 -2
  365. data/lib/rubocop/cop/mixin/percent_array.rb +14 -9
  366. data/lib/rubocop/cop/mixin/percent_literal.rb +0 -6
  367. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +6 -12
  368. data/lib/rubocop/cop/mixin/preferred_delimiters.rb +6 -9
  369. data/lib/rubocop/cop/mixin/range_help.rb +24 -13
  370. data/lib/rubocop/cop/mixin/rational_literal.rb +1 -0
  371. data/lib/rubocop/cop/mixin/rescue_node.rb +13 -7
  372. data/lib/rubocop/cop/mixin/safe_assignment.rb +6 -2
  373. data/lib/rubocop/cop/mixin/space_after_punctuation.rb +6 -7
  374. data/lib/rubocop/cop/mixin/space_before_punctuation.rb +5 -5
  375. data/lib/rubocop/cop/mixin/statement_modifier.rb +45 -23
  376. data/lib/rubocop/cop/mixin/string_help.rb +4 -1
  377. data/lib/rubocop/cop/mixin/string_literals_help.rb +3 -5
  378. data/lib/rubocop/cop/mixin/surrounding_space.rb +15 -31
  379. data/lib/rubocop/cop/mixin/symbol_help.rb +13 -0
  380. data/lib/rubocop/cop/mixin/target_ruby_version.rb +5 -1
  381. data/lib/rubocop/cop/mixin/trailing_body.rb +1 -2
  382. data/lib/rubocop/cop/mixin/trailing_comma.rb +12 -17
  383. data/lib/rubocop/cop/mixin/uncommunicative_name.rb +25 -32
  384. data/lib/rubocop/cop/mixin/unused_argument.rb +5 -9
  385. data/lib/rubocop/cop/mixin/visibility_help.rb +37 -0
  386. data/lib/rubocop/cop/naming/accessor_method_name.rb +19 -3
  387. data/lib/rubocop/cop/naming/ascii_identifiers.rb +29 -8
  388. data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +17 -7
  389. data/lib/rubocop/cop/naming/block_parameter_name.rb +1 -1
  390. data/lib/rubocop/cop/naming/class_and_module_camel_case.rb +13 -3
  391. data/lib/rubocop/cop/naming/constant_name.rb +4 -2
  392. data/lib/rubocop/cop/naming/file_name.rb +36 -34
  393. data/lib/rubocop/cop/naming/heredoc_delimiter_case.rb +12 -6
  394. data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb +3 -3
  395. data/lib/rubocop/cop/naming/inclusive_language.rb +249 -0
  396. data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +134 -26
  397. data/lib/rubocop/cop/naming/method_name.rb +6 -8
  398. data/lib/rubocop/cop/naming/method_parameter_name.rb +2 -2
  399. data/lib/rubocop/cop/naming/predicate_name.rb +10 -13
  400. data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +59 -15
  401. data/lib/rubocop/cop/naming/variable_name.rb +3 -1
  402. data/lib/rubocop/cop/naming/variable_number.rb +94 -9
  403. data/lib/rubocop/cop/offense.rb +35 -12
  404. data/lib/rubocop/cop/registry.rb +87 -23
  405. data/lib/rubocop/cop/security/eval.rb +4 -2
  406. data/lib/rubocop/cop/security/json_load.rb +8 -8
  407. data/lib/rubocop/cop/security/marshal_load.rb +4 -4
  408. data/lib/rubocop/cop/security/open.rb +15 -11
  409. data/lib/rubocop/cop/security/yaml_load.rb +8 -6
  410. data/lib/rubocop/cop/severity.rb +4 -14
  411. data/lib/rubocop/cop/style/access_modifier_declarations.rb +15 -11
  412. data/lib/rubocop/cop/style/accessor_grouping.rb +150 -0
  413. data/lib/rubocop/cop/style/alias.rb +46 -45
  414. data/lib/rubocop/cop/style/and_or.rb +25 -17
  415. data/lib/rubocop/cop/style/arguments_forwarding.rb +143 -0
  416. data/lib/rubocop/cop/style/array_coercion.rb +69 -0
  417. data/lib/rubocop/cop/style/array_join.rb +9 -9
  418. data/lib/rubocop/cop/style/ascii_comments.rb +6 -7
  419. data/lib/rubocop/cop/style/attr.rb +15 -15
  420. data/lib/rubocop/cop/style/auto_resource_cleanup.rb +9 -12
  421. data/lib/rubocop/cop/style/bare_percent_literals.rb +12 -14
  422. data/lib/rubocop/cop/style/begin_block.rb +2 -2
  423. data/lib/rubocop/cop/style/bisected_attr_accessor.rb +125 -0
  424. data/lib/rubocop/cop/style/bisected_attr_accessor/macro.rb +60 -0
  425. data/lib/rubocop/cop/style/block_comments.rb +14 -18
  426. data/lib/rubocop/cop/style/block_delimiters.rb +41 -34
  427. data/lib/rubocop/cop/style/case_equality.rb +34 -6
  428. data/lib/rubocop/cop/style/case_like_if.rb +258 -0
  429. data/lib/rubocop/cop/style/character_literal.rb +12 -15
  430. data/lib/rubocop/cop/style/class_and_module_children.rb +57 -24
  431. data/lib/rubocop/cop/style/class_check.rb +6 -11
  432. data/lib/rubocop/cop/style/class_equality_comparison.rb +67 -0
  433. data/lib/rubocop/cop/style/class_methods.rb +8 -14
  434. data/lib/rubocop/cop/style/class_methods_definitions.rb +157 -0
  435. data/lib/rubocop/cop/style/class_vars.rb +23 -7
  436. data/lib/rubocop/cop/style/collection_compact.rb +91 -0
  437. data/lib/rubocop/cop/style/collection_methods.rb +22 -15
  438. data/lib/rubocop/cop/style/colon_method_call.rb +7 -9
  439. data/lib/rubocop/cop/style/colon_method_definition.rb +6 -6
  440. data/lib/rubocop/cop/style/combinable_loops.rb +92 -0
  441. data/lib/rubocop/cop/style/command_literal.rb +22 -28
  442. data/lib/rubocop/cop/style/comment_annotation.rb +73 -26
  443. data/lib/rubocop/cop/style/commented_keyword.rb +34 -21
  444. data/lib/rubocop/cop/style/conditional_assignment.rb +71 -87
  445. data/lib/rubocop/cop/style/constant_visibility.rb +31 -2
  446. data/lib/rubocop/cop/style/copyright.rb +20 -23
  447. data/lib/rubocop/cop/style/date_time.rb +16 -5
  448. data/lib/rubocop/cop/style/def_with_parentheses.rb +9 -12
  449. data/lib/rubocop/cop/style/dir.rb +11 -12
  450. data/lib/rubocop/cop/style/disable_cops_within_source_code_directive.rb +51 -13
  451. data/lib/rubocop/cop/style/document_dynamic_eval_definition.rb +169 -0
  452. data/lib/rubocop/cop/style/documentation.rb +50 -14
  453. data/lib/rubocop/cop/style/documentation_method.rb +2 -1
  454. data/lib/rubocop/cop/style/double_cop_disable_directive.rb +7 -16
  455. data/lib/rubocop/cop/style/double_negation.rb +50 -6
  456. data/lib/rubocop/cop/style/each_for_simple_loop.rb +7 -10
  457. data/lib/rubocop/cop/style/each_with_object.rb +17 -19
  458. data/lib/rubocop/cop/style/empty_block_parameter.rb +9 -10
  459. data/lib/rubocop/cop/style/empty_case_condition.rb +22 -26
  460. data/lib/rubocop/cop/style/empty_else.rb +14 -22
  461. data/lib/rubocop/cop/style/empty_lambda_parameter.rb +9 -10
  462. data/lib/rubocop/cop/style/empty_literal.rb +46 -31
  463. data/lib/rubocop/cop/style/empty_method.rb +12 -23
  464. data/lib/rubocop/cop/style/encoding.rb +6 -10
  465. data/lib/rubocop/cop/style/end_block.rb +5 -8
  466. data/lib/rubocop/cop/style/endless_method.rb +101 -0
  467. data/lib/rubocop/cop/style/eval_with_location.rb +143 -54
  468. data/lib/rubocop/cop/style/even_odd.rb +9 -11
  469. data/lib/rubocop/cop/style/expand_path_arguments.rb +25 -23
  470. data/lib/rubocop/cop/style/explicit_block_argument.rb +114 -0
  471. data/lib/rubocop/cop/style/exponential_notation.rb +15 -18
  472. data/lib/rubocop/cop/style/float_division.rb +60 -11
  473. data/lib/rubocop/cop/style/for.rb +7 -13
  474. data/lib/rubocop/cop/style/format_string.rb +28 -22
  475. data/lib/rubocop/cop/style/format_string_token.rb +78 -22
  476. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +24 -51
  477. data/lib/rubocop/cop/style/global_std_stream.rb +66 -0
  478. data/lib/rubocop/cop/style/global_vars.rb +2 -2
  479. data/lib/rubocop/cop/style/guard_clause.rb +32 -13
  480. data/lib/rubocop/cop/style/hash_as_last_array_item.rb +88 -0
  481. data/lib/rubocop/cop/style/hash_conversion.rb +133 -0
  482. data/lib/rubocop/cop/style/hash_each_methods.rb +26 -12
  483. data/lib/rubocop/cop/style/hash_except.rb +96 -0
  484. data/lib/rubocop/cop/style/hash_like_case.rb +77 -0
  485. data/lib/rubocop/cop/style/hash_syntax.rb +48 -41
  486. data/lib/rubocop/cop/style/hash_transform_keys.rb +23 -11
  487. data/lib/rubocop/cop/style/hash_transform_values.rb +22 -10
  488. data/lib/rubocop/cop/style/identical_conditional_branches.rb +64 -11
  489. data/lib/rubocop/cop/style/if_inside_else.rb +50 -2
  490. data/lib/rubocop/cop/style/if_unless_modifier.rb +58 -49
  491. data/lib/rubocop/cop/style/if_unless_modifier_of_if_unless.rb +11 -3
  492. data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +122 -0
  493. data/lib/rubocop/cop/style/if_with_semicolon.rb +51 -3
  494. data/lib/rubocop/cop/style/implicit_runtime_error.rb +3 -1
  495. data/lib/rubocop/cop/style/in_pattern_then.rb +56 -0
  496. data/lib/rubocop/cop/style/infinite_loop.rb +27 -26
  497. data/lib/rubocop/cop/style/inline_comment.rb +4 -4
  498. data/lib/rubocop/cop/style/inverse_methods.rb +28 -40
  499. data/lib/rubocop/cop/style/ip_addresses.rb +3 -4
  500. data/lib/rubocop/cop/style/keyword_parameters_order.rb +75 -0
  501. data/lib/rubocop/cop/style/lambda.rb +9 -16
  502. data/lib/rubocop/cop/style/lambda_call.rb +18 -35
  503. data/lib/rubocop/cop/style/line_end_concatenation.rb +21 -25
  504. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +62 -13
  505. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +53 -32
  506. data/lib/rubocop/cop/style/method_call_with_args_parentheses/require_parentheses.rb +8 -18
  507. data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +19 -12
  508. data/lib/rubocop/cop/style/method_called_on_do_end_block.rb +14 -7
  509. data/lib/rubocop/cop/style/method_def_parentheses.rb +18 -24
  510. data/lib/rubocop/cop/style/min_max.rb +10 -14
  511. data/lib/rubocop/cop/style/missing_else.rb +13 -25
  512. data/lib/rubocop/cop/style/missing_respond_to_missing.rb +11 -5
  513. data/lib/rubocop/cop/style/mixin_grouping.rb +26 -39
  514. data/lib/rubocop/cop/style/mixin_usage.rb +12 -30
  515. data/lib/rubocop/cop/style/module_function.rb +18 -19
  516. data/lib/rubocop/cop/style/multiline_block_chain.rb +13 -5
  517. data/lib/rubocop/cop/style/multiline_if_modifier.rb +3 -10
  518. data/lib/rubocop/cop/style/multiline_if_then.rb +5 -11
  519. data/lib/rubocop/cop/style/multiline_in_pattern_then.rb +62 -0
  520. data/lib/rubocop/cop/style/multiline_memoization.rb +15 -13
  521. data/lib/rubocop/cop/style/multiline_method_signature.rb +33 -3
  522. data/lib/rubocop/cop/style/multiline_ternary_operator.rb +32 -11
  523. data/lib/rubocop/cop/style/multiline_when_then.rb +25 -18
  524. data/lib/rubocop/cop/style/multiple_comparison.rb +77 -12
  525. data/lib/rubocop/cop/style/mutable_constant.rb +45 -37
  526. data/lib/rubocop/cop/style/negated_if.rb +10 -11
  527. data/lib/rubocop/cop/style/negated_if_else_condition.rb +128 -0
  528. data/lib/rubocop/cop/style/negated_unless.rb +10 -11
  529. data/lib/rubocop/cop/style/negated_while.rb +7 -15
  530. data/lib/rubocop/cop/style/nested_modifier.rb +10 -17
  531. data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +20 -17
  532. data/lib/rubocop/cop/style/nested_ternary_operator.rb +30 -4
  533. data/lib/rubocop/cop/style/next.rb +16 -25
  534. data/lib/rubocop/cop/style/nil_comparison.rb +19 -11
  535. data/lib/rubocop/cop/style/nil_lambda.rb +70 -0
  536. data/lib/rubocop/cop/style/non_nil_check.rb +56 -34
  537. data/lib/rubocop/cop/style/not.rb +20 -26
  538. data/lib/rubocop/cop/style/numeric_literal_prefix.rb +6 -11
  539. data/lib/rubocop/cop/style/numeric_literals.rb +19 -27
  540. data/lib/rubocop/cop/style/numeric_predicate.rb +15 -23
  541. data/lib/rubocop/cop/style/one_line_conditional.rb +73 -28
  542. data/lib/rubocop/cop/style/option_hash.rb +3 -4
  543. data/lib/rubocop/cop/style/optional_arguments.rb +4 -7
  544. data/lib/rubocop/cop/style/optional_boolean_parameter.rb +53 -0
  545. data/lib/rubocop/cop/style/or_assignment.rb +11 -10
  546. data/lib/rubocop/cop/style/parallel_assignment.rb +27 -24
  547. data/lib/rubocop/cop/style/parentheses_around_condition.rb +7 -6
  548. data/lib/rubocop/cop/style/percent_literal_delimiters.rb +16 -24
  549. data/lib/rubocop/cop/style/percent_q_literals.rb +9 -12
  550. data/lib/rubocop/cop/style/perl_backrefs.rb +84 -16
  551. data/lib/rubocop/cop/style/preferred_hash_methods.rb +12 -18
  552. data/lib/rubocop/cop/style/proc.rb +8 -8
  553. data/lib/rubocop/cop/style/quoted_symbols.rb +110 -0
  554. data/lib/rubocop/cop/style/raise_args.rb +41 -37
  555. data/lib/rubocop/cop/style/random_with_offset.rb +30 -35
  556. data/lib/rubocop/cop/style/redundant_argument.rb +85 -0
  557. data/lib/rubocop/cop/style/redundant_assignment.rb +106 -0
  558. data/lib/rubocop/cop/style/redundant_begin.rb +79 -13
  559. data/lib/rubocop/cop/style/redundant_capital_w.rb +7 -11
  560. data/lib/rubocop/cop/style/redundant_condition.rb +28 -15
  561. data/lib/rubocop/cop/style/redundant_conditional.rb +13 -14
  562. data/lib/rubocop/cop/style/redundant_exception.rb +21 -16
  563. data/lib/rubocop/cop/style/redundant_fetch_block.rb +115 -0
  564. data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +52 -0
  565. data/lib/rubocop/cop/style/redundant_freeze.rb +16 -14
  566. data/lib/rubocop/cop/style/redundant_interpolation.rb +32 -27
  567. data/lib/rubocop/cop/style/redundant_parentheses.rb +51 -38
  568. data/lib/rubocop/cop/style/redundant_percent_q.rb +13 -16
  569. data/lib/rubocop/cop/style/redundant_regexp_character_class.rb +104 -0
  570. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +118 -0
  571. data/lib/rubocop/cop/style/redundant_return.rb +24 -22
  572. data/lib/rubocop/cop/style/redundant_self.rb +46 -26
  573. data/lib/rubocop/cop/style/redundant_self_assignment.rb +118 -0
  574. data/lib/rubocop/cop/style/redundant_sort.rb +30 -35
  575. data/lib/rubocop/cop/style/redundant_sort_by.rb +6 -9
  576. data/lib/rubocop/cop/style/regexp_literal.rb +24 -30
  577. data/lib/rubocop/cop/style/rescue_modifier.rb +39 -12
  578. data/lib/rubocop/cop/style/rescue_standard_error.rb +25 -23
  579. data/lib/rubocop/cop/style/return_nil.rb +12 -7
  580. data/lib/rubocop/cop/style/safe_navigation.rb +44 -39
  581. data/lib/rubocop/cop/style/sample.rb +14 -15
  582. data/lib/rubocop/cop/style/self_assignment.rb +26 -22
  583. data/lib/rubocop/cop/style/semicolon.rb +10 -10
  584. data/lib/rubocop/cop/style/send.rb +5 -7
  585. data/lib/rubocop/cop/style/signal_exception.rb +32 -27
  586. data/lib/rubocop/cop/style/single_argument_dig.rb +55 -0
  587. data/lib/rubocop/cop/style/single_line_block_params.rb +34 -12
  588. data/lib/rubocop/cop/style/single_line_methods.rb +81 -19
  589. data/lib/rubocop/cop/style/slicing_with_range.rb +38 -0
  590. data/lib/rubocop/cop/style/sole_nested_conditional.rb +176 -0
  591. data/lib/rubocop/cop/style/special_global_vars.rb +21 -54
  592. data/lib/rubocop/cop/style/stabby_lambda_parentheses.rb +18 -22
  593. data/lib/rubocop/cop/style/static_class.rb +97 -0
  594. data/lib/rubocop/cop/style/stderr_puts.rb +9 -13
  595. data/lib/rubocop/cop/style/string_chars.rb +39 -0
  596. data/lib/rubocop/cop/style/string_concatenation.rb +169 -0
  597. data/lib/rubocop/cop/style/string_hash_keys.rb +8 -7
  598. data/lib/rubocop/cop/style/string_literals.rb +19 -15
  599. data/lib/rubocop/cop/style/string_literals_in_interpolation.rb +5 -3
  600. data/lib/rubocop/cop/style/string_methods.rb +7 -17
  601. data/lib/rubocop/cop/style/strip.rb +10 -14
  602. data/lib/rubocop/cop/style/struct_inheritance.rb +33 -4
  603. data/lib/rubocop/cop/style/swap_values.rb +108 -0
  604. data/lib/rubocop/cop/style/symbol_array.rb +11 -22
  605. data/lib/rubocop/cop/style/symbol_literal.rb +4 -8
  606. data/lib/rubocop/cop/style/symbol_proc.rb +50 -32
  607. data/lib/rubocop/cop/style/ternary_parentheses.rb +29 -33
  608. data/lib/rubocop/cop/style/top_level_method_definition.rb +83 -0
  609. data/lib/rubocop/cop/style/trailing_body_on_class.rb +3 -6
  610. data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb +10 -9
  611. data/lib/rubocop/cop/style/trailing_body_on_module.rb +3 -6
  612. data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +5 -8
  613. data/lib/rubocop/cop/style/trailing_comma_in_array_literal.rb +5 -8
  614. data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +22 -24
  615. data/lib/rubocop/cop/style/trailing_comma_in_hash_literal.rb +5 -8
  616. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +12 -38
  617. data/lib/rubocop/cop/style/trailing_underscore_variable.rb +16 -31
  618. data/lib/rubocop/cop/style/trivial_accessors.rb +101 -40
  619. data/lib/rubocop/cop/style/unless_else.rb +7 -11
  620. data/lib/rubocop/cop/style/unless_logical_operators.rb +105 -0
  621. data/lib/rubocop/cop/style/unpack_first.rb +7 -9
  622. data/lib/rubocop/cop/style/variable_interpolation.rb +8 -11
  623. data/lib/rubocop/cop/style/when_then.rb +7 -7
  624. data/lib/rubocop/cop/style/while_until_do.rb +6 -16
  625. data/lib/rubocop/cop/style/while_until_modifier.rb +16 -24
  626. data/lib/rubocop/cop/style/word_array.rb +6 -25
  627. data/lib/rubocop/cop/style/yoda_condition.rb +17 -18
  628. data/lib/rubocop/cop/style/zero_length_predicate.rb +25 -23
  629. data/lib/rubocop/cop/team.rb +147 -84
  630. data/lib/rubocop/cop/util.rb +43 -27
  631. data/lib/rubocop/cop/utils/format_string.rb +22 -9
  632. data/lib/rubocop/cop/variable_force.rb +11 -26
  633. data/lib/rubocop/cop/variable_force/assignment.rb +2 -2
  634. data/lib/rubocop/cop/variable_force/branch.rb +18 -9
  635. data/lib/rubocop/cop/variable_force/reference.rb +1 -3
  636. data/lib/rubocop/cop/variable_force/scope.rb +6 -9
  637. data/lib/rubocop/cop/variable_force/variable.rb +9 -12
  638. data/lib/rubocop/cop/variable_force/variable_table.rb +1 -1
  639. data/lib/rubocop/cops_documentation_generator.rb +270 -0
  640. data/lib/rubocop/core_ext/string.rb +2 -2
  641. data/lib/rubocop/directive_comment.rb +144 -0
  642. data/lib/rubocop/error.rb +1 -0
  643. data/lib/rubocop/ext/processed_source.rb +18 -0
  644. data/lib/rubocop/ext/regexp_node.rb +87 -0
  645. data/lib/rubocop/ext/regexp_parser.rb +92 -0
  646. data/lib/rubocop/file_finder.rb +12 -13
  647. data/lib/rubocop/formatter/auto_gen_config_formatter.rb +2 -1
  648. data/lib/rubocop/formatter/base_formatter.rb +0 -4
  649. data/lib/rubocop/formatter/clang_style_formatter.rb +4 -2
  650. data/lib/rubocop/formatter/disabled_config_formatter.rb +39 -30
  651. data/lib/rubocop/formatter/emacs_style_formatter.rb +2 -0
  652. data/lib/rubocop/formatter/formatter_set.rb +5 -5
  653. data/lib/rubocop/formatter/git_hub_actions_formatter.rb +44 -0
  654. data/lib/rubocop/formatter/html_formatter.rb +6 -10
  655. data/lib/rubocop/formatter/json_formatter.rb +1 -5
  656. data/lib/rubocop/formatter/junit_formatter.rb +34 -15
  657. data/lib/rubocop/formatter/offense_count_formatter.rb +2 -2
  658. data/lib/rubocop/formatter/progress_formatter.rb +3 -4
  659. data/lib/rubocop/formatter/quiet_formatter.rb +1 -1
  660. data/lib/rubocop/formatter/simple_text_formatter.rb +40 -7
  661. data/lib/rubocop/formatter/tap_formatter.rb +6 -2
  662. data/lib/rubocop/formatter/worst_offenders_formatter.rb +2 -2
  663. data/lib/rubocop/lockfile.rb +40 -0
  664. data/lib/rubocop/magic_comment.rb +33 -4
  665. data/lib/rubocop/name_similarity.rb +18 -10
  666. data/lib/rubocop/options.rb +126 -91
  667. data/lib/rubocop/path_util.rb +20 -22
  668. data/lib/rubocop/platform.rb +1 -1
  669. data/lib/rubocop/rake_task.rb +12 -11
  670. data/lib/rubocop/remote_config.rb +15 -11
  671. data/lib/rubocop/result_cache.rb +50 -31
  672. data/lib/rubocop/rspec/cop_helper.rb +11 -35
  673. data/lib/rubocop/rspec/expect_offense.rb +128 -39
  674. data/lib/rubocop/rspec/shared_contexts.rb +78 -32
  675. data/lib/rubocop/runner.rb +111 -74
  676. data/lib/rubocop/string_interpreter.rb +3 -0
  677. data/lib/rubocop/target_finder.rb +58 -48
  678. data/lib/rubocop/target_ruby.rb +126 -13
  679. data/lib/rubocop/util.rb +16 -0
  680. data/lib/rubocop/version.rb +71 -7
  681. data/lib/rubocop/yaml_duplication_checker.rb +1 -0
  682. metadata +189 -91
  683. data/bin/console +0 -10
  684. data/bin/setup +0 -7
  685. data/lib/rubocop/ast/builder.rb +0 -85
  686. data/lib/rubocop/ast/node.rb +0 -637
  687. data/lib/rubocop/ast/node/alias_node.rb +0 -24
  688. data/lib/rubocop/ast/node/and_node.rb +0 -29
  689. data/lib/rubocop/ast/node/args_node.rb +0 -29
  690. data/lib/rubocop/ast/node/array_node.rb +0 -70
  691. data/lib/rubocop/ast/node/block_node.rb +0 -121
  692. data/lib/rubocop/ast/node/break_node.rb +0 -17
  693. data/lib/rubocop/ast/node/case_match_node.rb +0 -56
  694. data/lib/rubocop/ast/node/case_node.rb +0 -56
  695. data/lib/rubocop/ast/node/class_node.rb +0 -31
  696. data/lib/rubocop/ast/node/def_node.rb +0 -82
  697. data/lib/rubocop/ast/node/defined_node.rb +0 -17
  698. data/lib/rubocop/ast/node/ensure_node.rb +0 -17
  699. data/lib/rubocop/ast/node/float_node.rb +0 -12
  700. data/lib/rubocop/ast/node/for_node.rb +0 -53
  701. data/lib/rubocop/ast/node/forward_args_node.rb +0 -18
  702. data/lib/rubocop/ast/node/hash_node.rb +0 -109
  703. data/lib/rubocop/ast/node/if_node.rb +0 -175
  704. data/lib/rubocop/ast/node/int_node.rb +0 -12
  705. data/lib/rubocop/ast/node/keyword_splat_node.rb +0 -45
  706. data/lib/rubocop/ast/node/mixin/basic_literal_node.rb +0 -16
  707. data/lib/rubocop/ast/node/mixin/binary_operator_node.rb +0 -43
  708. data/lib/rubocop/ast/node/mixin/collection_node.rb +0 -15
  709. data/lib/rubocop/ast/node/mixin/conditional_node.rb +0 -45
  710. data/lib/rubocop/ast/node/mixin/hash_element_node.rb +0 -125
  711. data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +0 -269
  712. data/lib/rubocop/ast/node/mixin/method_identifier_predicates.rb +0 -114
  713. data/lib/rubocop/ast/node/mixin/modifier_node.rb +0 -17
  714. data/lib/rubocop/ast/node/mixin/numeric_node.rb +0 -21
  715. data/lib/rubocop/ast/node/mixin/parameterized_node.rb +0 -61
  716. data/lib/rubocop/ast/node/mixin/predicate_operator_node.rb +0 -35
  717. data/lib/rubocop/ast/node/module_node.rb +0 -24
  718. data/lib/rubocop/ast/node/or_node.rb +0 -29
  719. data/lib/rubocop/ast/node/pair_node.rb +0 -63
  720. data/lib/rubocop/ast/node/range_node.rb +0 -18
  721. data/lib/rubocop/ast/node/regexp_node.rb +0 -33
  722. data/lib/rubocop/ast/node/resbody_node.rb +0 -24
  723. data/lib/rubocop/ast/node/retry_node.rb +0 -17
  724. data/lib/rubocop/ast/node/return_node.rb +0 -24
  725. data/lib/rubocop/ast/node/self_class_node.rb +0 -24
  726. data/lib/rubocop/ast/node/send_node.rb +0 -13
  727. data/lib/rubocop/ast/node/str_node.rb +0 -16
  728. data/lib/rubocop/ast/node/super_node.rb +0 -21
  729. data/lib/rubocop/ast/node/symbol_node.rb +0 -12
  730. data/lib/rubocop/ast/node/until_node.rb +0 -35
  731. data/lib/rubocop/ast/node/when_node.rb +0 -53
  732. data/lib/rubocop/ast/node/while_node.rb +0 -35
  733. data/lib/rubocop/ast/node/yield_node.rb +0 -21
  734. data/lib/rubocop/ast/sexp.rb +0 -16
  735. data/lib/rubocop/ast/traversal.rb +0 -202
  736. data/lib/rubocop/cop/lint/useless_comparison.rb +0 -28
  737. data/lib/rubocop/cop/mixin/classish_length.rb +0 -37
  738. data/lib/rubocop/cop/mixin/parser_diagnostic.rb +0 -37
  739. data/lib/rubocop/cop/mixin/too_many_lines.rb +0 -35
  740. data/lib/rubocop/cop/style/method_missing_super.rb +0 -34
  741. data/lib/rubocop/node_pattern.rb +0 -887
  742. data/lib/rubocop/processed_source.rb +0 -213
  743. data/lib/rubocop/string_util.rb +0 -14
  744. data/lib/rubocop/token.rb +0 -114
@@ -1,28 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module RuboCop
4
- module Cop
5
- module Lint
6
- # This cop checks for comparison of something with itself.
7
- #
8
- # @example
9
- #
10
- # # bad
11
- #
12
- # x.top >= x.top
13
- class UselessComparison < Cop
14
- MSG = 'Comparison of something with itself detected.'
15
- OPS = %w[== === != < > <= >= <=>].freeze
16
-
17
- def_node_matcher :useless_comparison?,
18
- "(send $_match {:#{OPS.join(' :')}} $_match)"
19
-
20
- def on_send(node)
21
- return unless useless_comparison?(node)
22
-
23
- add_offense(node, location: :selector)
24
- end
25
- end
26
- end
27
- end
28
- end
@@ -1,37 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module RuboCop
4
- module Cop
5
- # Common functionality for checking length of classes and modules.
6
- module ClassishLength
7
- include CodeLength
8
-
9
- private
10
-
11
- def code_length(node)
12
- body_line_numbers = line_range(node).to_a[1...-1]
13
-
14
- target_line_numbers = body_line_numbers -
15
- line_numbers_of_inner_nodes(node, :module, :class)
16
-
17
- target_line_numbers.reduce(0) do |length, line_number|
18
- source_line = processed_source[line_number]
19
- next length if irrelevant_line(source_line)
20
-
21
- length + 1
22
- end
23
- end
24
-
25
- def line_numbers_of_inner_nodes(node, *types)
26
- line_numbers = Set.new
27
-
28
- node.each_descendant(*types) do |inner_node|
29
- line_range = line_range(inner_node)
30
- line_numbers.merge(line_range)
31
- end
32
-
33
- line_numbers.to_a
34
- end
35
- end
36
- end
37
- end
@@ -1,37 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module RuboCop
4
- module Cop
5
- # Common functionality for cops which processes Parser's diagnostics.
6
- # This mixin requires its user class to define `#relevant_diagnostic?`.
7
- #
8
- # def relevant_diagnostic?(diagnostic)
9
- # diagnostic.reason == :my_interested_diagnostic_type
10
- # end
11
- #
12
- # If you want to use an alternative offense message rather than the one in
13
- # Parser's diagnostic, define `#alternative_message`.
14
- #
15
- # def alternative_message(diagnostic)
16
- # 'My custom message'
17
- # end
18
- module ParserDiagnostic
19
- def investigate(processed_source)
20
- processed_source.diagnostics.each do |d|
21
- next unless relevant_diagnostic?(d)
22
-
23
- message = if respond_to?(:alternative_message, true)
24
- alternative_message(d)
25
- else
26
- d.message.capitalize
27
- end
28
-
29
- add_offense(nil,
30
- location: d.location,
31
- message: message,
32
- severity: d.level)
33
- end
34
- end
35
- end
36
- end
37
- end
@@ -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,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,887 +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
- # '`send' # descends any number of level in the AST
82
- # # so this matches against any descendant node
83
- # '#method' # we call this a 'funcall'; it calls a method in the
84
- # # context where a pattern-matching method is defined
85
- # # if that returns a truthy value, the match succeeds
86
- # 'equal?(%1)' # predicates can be given 1 or more extra args
87
- # '#method(%0, 1)' # funcalls can also be given 1 or more extra args
88
- #
89
- # You can nest arbitrarily deep:
90
- #
91
- # # matches node parsed from 'Const = Class.new' or 'Const = Module.new':
92
- # '(casgn nil? :Const (send (const nil? {:Class :Module}) :new))'
93
- # # matches a node parsed from an 'if', with a '==' comparison,
94
- # # and no 'else' branch:
95
- # '(if (send _ :== _) _ nil?)'
96
- #
97
- # Note that patterns like 'send' are implemented by calling `#send_type?` on
98
- # the node being matched, 'const' by `#const_type?`, 'int' by `#int_type?`,
99
- # and so on. Therefore, if you add methods which are named like
100
- # `#prefix_type?` to the AST node class, then 'prefix' will become usable as
101
- # a pattern.
102
- #
103
- # Also note that if you need a "guard clause" to protect against possible nils
104
- # in a certain place in the AST, you can do it like this: `[!nil <pattern>]`
105
- #
106
- # The compiler code is very simple; don't be afraid to read through it!
107
- class NodePattern
108
- # @private
109
- Invalid = Class.new(StandardError)
110
-
111
- # @private
112
- # Builds Ruby code which implements a pattern
113
- class Compiler
114
- SYMBOL = %r{:(?:[\w+@*/?!<>=~|%^-]+|\[\]=?)}.freeze
115
- IDENTIFIER = /[a-zA-Z_][a-zA-Z0-9_-]*/.freeze
116
- META = Regexp.union(
117
- %w"( ) { } [ ] $< < > $... $ ! ^ ` ... + * ?"
118
- ).freeze
119
- NUMBER = /-?\d+(?:\.\d+)?/.freeze
120
- STRING = /".+?"/.freeze
121
- METHOD_NAME = /\#?#{IDENTIFIER}[\!\?]?\(?/.freeze
122
- PARAM_NUMBER = /%\d*/.freeze
123
-
124
- SEPARATORS = /[\s]+/.freeze
125
- TOKENS = Regexp.union(META, PARAM_NUMBER, NUMBER,
126
- METHOD_NAME, SYMBOL, STRING)
127
-
128
- TOKEN = /\G(?:#{SEPARATORS}|#{TOKENS}|.)/.freeze
129
-
130
- NODE = /\A#{IDENTIFIER}\Z/.freeze
131
- PREDICATE = /\A#{IDENTIFIER}\?\(?\Z/.freeze
132
- WILDCARD = /\A_(?:#{IDENTIFIER})?\Z/.freeze
133
-
134
- FUNCALL = /\A\##{METHOD_NAME}/.freeze
135
- LITERAL = /\A(?:#{SYMBOL}|#{NUMBER}|#{STRING})\Z/.freeze
136
- PARAM = /\A#{PARAM_NUMBER}\Z/.freeze
137
- CLOSING = /\A(?:\)|\}|\])\Z/.freeze
138
-
139
- REST = '...'
140
- CAPTURED_REST = '$...'
141
-
142
- attr_reader :match_code, :tokens, :captures
143
-
144
- SEQ_HEAD_INDEX = -1
145
-
146
- # Placeholders while compiling, see with_..._context methods
147
- CUR_PLACEHOLDER = '@@@cur'
148
- CUR_NODE = "#{CUR_PLACEHOLDER} node@@@"
149
- CUR_ELEMENT = "#{CUR_PLACEHOLDER} element@@@"
150
- SEQ_HEAD_GUARD = '@@@seq guard head@@@'
151
-
152
- line = __LINE__
153
- ANY_ORDER_TEMPLATE = ERB.new <<~RUBY.gsub("-%>\n", '%>')
154
- <% if capture_rest %>(<%= capture_rest %> = []) && <% end -%>
155
- <% if capture_all %>(<%= capture_all %> = <% end -%>
156
- <%= CUR_NODE %>.children[<%= range %>]<% if capture_all %>)<% end -%>
157
- .each_with_object({}) { |<%= child %>, <%= matched %>|
158
- case
159
- <% patterns.each_with_index do |pattern, i| -%>
160
- when !<%= matched %>[<%= i %>] && <%=
161
- with_context(pattern, child, use_temp_node: false)
162
- %> then <%= matched %>[<%= i %>] = true
163
- <% end -%>
164
- <% if !rest %> else break({})
165
- <% elsif capture_rest %> else <%= capture_rest %> << <%= child %>
166
- <% end -%>
167
- end
168
- }.size == <%= patterns.size -%>
169
- RUBY
170
- ANY_ORDER_TEMPLATE.location = [__FILE__, line + 1]
171
-
172
- line = __LINE__
173
- REPEATED_TEMPLATE = ERB.new <<~RUBY.gsub("-%>\n", '%>')
174
- <% if captured %>(<%= accumulate %> = Array.new) && <% end %>
175
- <%= CUR_NODE %>.children[<%= range %>].all? do |<%= child %>|
176
- <%= with_context(expr, child, use_temp_node: false) %><% if captured %>&&
177
- <%= accumulate %>.push(<%= captured %>)<% end %>
178
- end <% if captured %>&&
179
- (<%= captured %> = if <%= accumulate %>.empty?
180
- <%= captured %>.map{[]} # Transpose hack won't work for empty case
181
- else
182
- <%= accumulate %>.transpose
183
- end) <% end -%>
184
- RUBY
185
- REPEATED_TEMPLATE.location = [__FILE__, line + 1]
186
-
187
- def initialize(str, node_var = 'node0')
188
- @string = str
189
- @root = node_var
190
-
191
- @temps = 0 # avoid name clashes between temp variables
192
- @captures = 0 # number of captures seen
193
- @unify = {} # named wildcard -> temp variable
194
- @params = 0 # highest % (param) number seen
195
- run(node_var)
196
- end
197
-
198
- def run(node_var)
199
- @tokens = Compiler.tokens(@string)
200
-
201
- @match_code = with_context(compile_expr, node_var, use_temp_node: false)
202
- @match_code.prepend("(captures = Array.new(#{@captures})) && ") \
203
- if @captures.positive?
204
-
205
- fail_due_to('unbalanced pattern') unless tokens.empty?
206
- end
207
-
208
- # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
209
- def compile_expr(token = tokens.shift)
210
- # read a single pattern-matching expression from the token stream,
211
- # return Ruby code which performs the corresponding matching operation
212
- #
213
- # the 'pattern-matching' expression may be a composite which
214
- # contains an arbitrary number of sub-expressions, but that composite
215
- # must all have precedence higher or equal to that of `&&`
216
- #
217
- # Expressions may use placeholders like:
218
- # CUR_NODE: Ruby code that evaluates to an AST node
219
- # CUR_ELEMENT: Either the node or the type if in first element of
220
- # a sequence (aka seq_head, e.g. "(seq_head first_node_arg ...")
221
- case token
222
- when '(' then compile_seq
223
- when '{' then compile_union
224
- when '[' then compile_intersect
225
- when '!' then compile_negation
226
- when '$' then compile_capture
227
- when '^' then compile_ascend
228
- when '`' then compile_descend
229
- when WILDCARD then compile_wildcard(token[1..-1])
230
- when FUNCALL then compile_funcall(token)
231
- when LITERAL then compile_literal(token)
232
- when PREDICATE then compile_predicate(token)
233
- when NODE then compile_nodetype(token)
234
- when PARAM then compile_param(token[1..-1])
235
- when CLOSING then fail_due_to("#{token} in invalid position")
236
- when nil then fail_due_to('pattern ended prematurely')
237
- else fail_due_to("invalid token #{token.inspect}")
238
- end
239
- end
240
- # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
241
-
242
- def tokens_until(stop, what)
243
- return to_enum __method__, stop, what unless block_given?
244
-
245
- fail_due_to("empty #{what}") if tokens.first == stop && what
246
- yield until tokens.first == stop
247
- tokens.shift
248
- end
249
-
250
- def compile_seq
251
- terms = tokens_until(')', 'sequence').map { variadic_seq_term }
252
- Sequence.new(self, *terms).compile
253
- end
254
-
255
- def compile_guard_clause
256
- "#{CUR_NODE}.is_a?(RuboCop::AST::Node)"
257
- end
258
-
259
- def variadic_seq_term
260
- token = tokens.shift
261
- case token
262
- when CAPTURED_REST then compile_captured_ellipsis
263
- when REST then compile_ellipsis
264
- when '$<' then compile_any_order(next_capture)
265
- when '<' then compile_any_order
266
- else compile_repeated_expr(token)
267
- end
268
- end
269
-
270
- def compile_repeated_expr(token)
271
- before = @captures
272
- expr = compile_expr(token)
273
- min, max = parse_repetition_token
274
- return [1, expr] if min.nil?
275
-
276
- if @captures != before
277
- captured = "captures[#{before}...#{@captures}]"
278
- accumulate = next_temp_variable(:accumulate)
279
- end
280
- arity = min..max || Float::INFINITY
281
-
282
- [arity, repeated_generator(expr, captured, accumulate)]
283
- end
284
-
285
- def repeated_generator(expr, captured, accumulate)
286
- with_temp_variables do |child|
287
- lambda do |range|
288
- if range.begin == SEQ_HEAD_INDEX
289
- fail_due_to 'repeated pattern at beginning of sequence'
290
- end
291
- REPEATED_TEMPLATE.result(binding)
292
- end
293
- end
294
- end
295
-
296
- def parse_repetition_token
297
- case tokens.first
298
- when '*' then min = 0
299
- when '+' then min = 1
300
- when '?' then min = 0
301
- max = 1
302
- else return
303
- end
304
- tokens.shift
305
- [min, max]
306
- end
307
-
308
- # @private
309
- # Builds Ruby code for a sequence
310
- # (head *first_terms variadic_term *last_terms)
311
- class Sequence < SimpleDelegator
312
- def initialize(compiler, *arity_term_list)
313
- @arities, @terms = arity_term_list.transpose
314
-
315
- super(compiler)
316
- @variadic_index = @arities.find_index { |a| a.is_a?(Range) }
317
- fail_due_to 'multiple variable patterns in same sequence' \
318
- if @variadic_index && !@arities.one? { |a| a.is_a?(Range) }
319
- end
320
-
321
- def compile
322
- [
323
- compile_guard_clause,
324
- compile_child_nb_guard,
325
- compile_seq_head,
326
- *compile_first_terms,
327
- compile_variadic_term,
328
- *compile_last_terms
329
- ].compact.join(" &&\n") << SEQ_HEAD_GUARD
330
- end
331
-
332
- private
333
-
334
- def first_terms_arity
335
- first_terms_range { |r| @arities[r].inject(0, :+) } || 0
336
- end
337
-
338
- def last_terms_arity
339
- last_terms_range { |r| @arities[r].inject(0, :+) } || 0
340
- end
341
-
342
- def variadic_term_min_arity
343
- @variadic_index ? @arities[@variadic_index].begin : 0
344
- end
345
-
346
- def first_terms_range
347
- yield 1..(@variadic_index || @terms.size) - 1 if seq_head?
348
- end
349
-
350
- def last_terms_range
351
- yield @variadic_index + 1...@terms.size if @variadic_index
352
- end
353
-
354
- def seq_head?
355
- @variadic_index != 0
356
- end
357
-
358
- def compile_child_nb_guard
359
- fixed = first_terms_arity + last_terms_arity
360
- min = fixed + variadic_term_min_arity
361
- op = if @variadic_index
362
- max_variadic = @arities[@variadic_index].end
363
- if max_variadic != Float::INFINITY
364
- range = min..fixed + max_variadic
365
- return "(#{range}).cover?(#{CUR_NODE}.children.size)"
366
- end
367
- '>='
368
- else
369
- '=='
370
- end
371
- "#{CUR_NODE}.children.size #{op} #{min}"
372
- end
373
-
374
- def term(index, range)
375
- t = @terms[index]
376
- if t.respond_to? :call
377
- t.call(range)
378
- else
379
- with_child_context(t, range.begin)
380
- end
381
- end
382
-
383
- def compile_seq_head
384
- return unless seq_head?
385
-
386
- fail_due_to 'sequences cannot start with <' \
387
- if @terms[0].respond_to? :call
388
-
389
- with_seq_head_context(@terms[0])
390
- end
391
-
392
- def compile_first_terms
393
- first_terms_range { |range| compile_terms(range, 0) }
394
- end
395
-
396
- def compile_last_terms
397
- last_terms_range { |r| compile_terms(r, -last_terms_arity) }
398
- end
399
-
400
- def compile_terms(index_range, start)
401
- index_range.map do |i|
402
- current = start
403
- start += @arities.fetch(i)
404
- term(i, current..start - 1)
405
- end
406
- end
407
-
408
- def compile_variadic_term
409
- variadic_arity { |arity| term(@variadic_index, arity) }
410
- end
411
-
412
- def variadic_arity
413
- return unless @variadic_index
414
-
415
- first = @variadic_index.positive? ? first_terms_arity : SEQ_HEAD_INDEX
416
- yield first..-last_terms_arity - 1
417
- end
418
- end
419
- private_constant :Sequence
420
-
421
- def compile_captured_ellipsis
422
- capture = next_capture
423
- block = lambda { |range|
424
- # Consider ($...) like (_ $...):
425
- range = 0..range.end if range.begin == SEQ_HEAD_INDEX
426
- "(#{capture} = #{CUR_NODE}.children[#{range}])"
427
- }
428
- [0..Float::INFINITY, block]
429
- end
430
-
431
- def compile_ellipsis
432
- [0..Float::INFINITY, 'true']
433
- end
434
-
435
- # rubocop:disable Metrics/AbcSize
436
- # rubocop:disable Metrics/MethodLength
437
- def compile_any_order(capture_all = nil)
438
- rest = capture_rest = nil
439
- patterns = []
440
- with_temp_variables do |child, matched|
441
- tokens_until('>', 'any child') do
442
- fail_due_to 'ellipsis must be at the end of <>' if rest
443
- token = tokens.shift
444
- case token
445
- when CAPTURED_REST then rest = capture_rest = next_capture
446
- when REST then rest = true
447
- else patterns << compile_expr(token)
448
- end
449
- end
450
- [rest ? patterns.size..Float::INFINITY : patterns.size,
451
- ->(range) { ANY_ORDER_TEMPLATE.result(binding) }]
452
- end
453
- end
454
- # rubocop:enable Metrics/MethodLength
455
- # rubocop:enable Metrics/AbcSize
456
-
457
- def insure_same_captures(enum, what)
458
- return to_enum __method__, enum, what unless block_given?
459
-
460
- captures_before = captures_after = nil
461
- enum.each do
462
- captures_before ||= @captures
463
- @captures = captures_before
464
- yield
465
- captures_after ||= @captures
466
- if captures_after != @captures
467
- fail_due_to("each #{what} must have same # of captures")
468
- end
469
- end
470
- end
471
-
472
- def access_unify(name)
473
- var = @unify[name]
474
-
475
- if var == :forbidden_unification
476
- fail_due_to "Wildcard #{name} was first seen in a subset of a" \
477
- " union and can't be used outside that union"
478
- end
479
- var
480
- end
481
-
482
- def forbid_unification(*names)
483
- names.each do |name|
484
- @unify[name] = :forbidden_unification
485
- end
486
- end
487
-
488
- # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
489
- def unify_in_union(enum)
490
- # We need to reset @unify before each branch is processed.
491
- # Moreover we need to keep track of newly encountered wildcards.
492
- # Var `new_unify_intersection` will hold those that are encountered
493
- # in all branches; these are not a problem.
494
- # Var `partial_unify` will hold those encountered in only a subset
495
- # of the branches; these can't be used outside of the union.
496
-
497
- return to_enum __method__, enum unless block_given?
498
-
499
- new_unify_intersection = nil
500
- partial_unify = []
501
- unify_before = @unify.dup
502
-
503
- result = enum.each do |e|
504
- @unify = unify_before.dup if new_unify_intersection
505
- yield e
506
- new_unify = @unify.keys - unify_before.keys
507
- if new_unify_intersection.nil?
508
- # First iteration
509
- new_unify_intersection = new_unify
510
- else
511
- union = new_unify_intersection | new_unify
512
- new_unify_intersection &= new_unify
513
- partial_unify |= union - new_unify_intersection
514
- end
515
- end
516
-
517
- # At this point, all members of `new_unify_intersection` can be used
518
- # for unification outside of the union, but partial_unify may not
519
-
520
- forbid_unification(*partial_unify)
521
-
522
- result
523
- end
524
- # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
525
-
526
- def compile_union
527
- # we need to ensure that each branch of the {} contains the same
528
- # number of captures (since only one branch of the {} can actually
529
- # match, the same variables are used to hold the captures for each
530
- # branch)
531
- enum = tokens_until('}', 'union')
532
- enum = unify_in_union(enum)
533
- terms = insure_same_captures(enum, 'branch of {}')
534
- .map { compile_expr }
535
-
536
- "(#{terms.join(' || ')})"
537
- end
538
-
539
- def compile_intersect
540
- tokens_until(']', 'intersection')
541
- .map { compile_expr }
542
- .join(' && ')
543
- end
544
-
545
- def compile_capture
546
- "(#{next_capture} = #{CUR_ELEMENT}; #{compile_expr})"
547
- end
548
-
549
- def compile_negation
550
- "!(#{compile_expr})"
551
- end
552
-
553
- def compile_ascend
554
- with_context("#{CUR_NODE} && #{compile_expr}", "#{CUR_NODE}.parent")
555
- end
556
-
557
- def compile_descend
558
- with_temp_variables do |descendant|
559
- pattern = with_context(compile_expr, descendant,
560
- use_temp_node: false)
561
- [
562
- "RuboCop::NodePattern.descend(#{CUR_ELEMENT}).",
563
- "any? do |#{descendant}|",
564
- " #{pattern}",
565
- 'end'
566
- ].join("\n")
567
- end
568
- end
569
-
570
- def compile_wildcard(name)
571
- if name.empty?
572
- 'true'
573
- elsif @unify.key?(name)
574
- # we have already seen a wildcard with this name before
575
- # so the value it matched the first time will already be stored
576
- # in a temp. check if this value matches the one stored in the temp
577
- "#{CUR_ELEMENT} == #{access_unify(name)}"
578
- else
579
- n = @unify[name] = "unify_#{name.gsub('-', '__')}"
580
- # double assign to avoid "assigned but unused variable"
581
- "(#{n} = #{CUR_ELEMENT}; " \
582
- "#{n} = #{n}; true)"
583
- end
584
- end
585
-
586
- def compile_literal(literal)
587
- "#{CUR_ELEMENT} == #{literal}"
588
- end
589
-
590
- def compile_predicate(predicate)
591
- if predicate.end_with?('(') # is there an arglist?
592
- args = compile_args(tokens)
593
- predicate = predicate[0..-2] # drop the trailing (
594
- "#{CUR_ELEMENT}.#{predicate}(#{args.join(',')})"
595
- else
596
- "#{CUR_ELEMENT}.#{predicate}"
597
- end
598
- end
599
-
600
- def compile_funcall(method)
601
- # call a method in the context which this pattern-matching
602
- # code is used in. pass target value as an argument
603
- method = method[1..-1] # drop the leading #
604
- if method.end_with?('(') # is there an arglist?
605
- args = compile_args(tokens)
606
- method = method[0..-2] # drop the trailing (
607
- "#{method}(#{CUR_ELEMENT},#{args.join(',')})"
608
- else
609
- "#{method}(#{CUR_ELEMENT})"
610
- end
611
- end
612
-
613
- def compile_nodetype(type)
614
- "#{compile_guard_clause} && #{CUR_NODE}.#{type.tr('-', '_')}_type?"
615
- end
616
-
617
- def compile_param(number)
618
- "#{CUR_ELEMENT} == #{get_param(number)}"
619
- end
620
-
621
- def compile_args(tokens)
622
- index = tokens.find_index { |token| token == ')' }
623
-
624
- tokens.slice!(0..index).each_with_object([]) do |token, args|
625
- next if [')', ','].include?(token)
626
-
627
- args << compile_arg(token)
628
- end
629
- end
630
-
631
- def compile_arg(token)
632
- case token
633
- when WILDCARD then
634
- name = token[1..-1]
635
- access_unify(name) || fail_due_to('invalid in arglist: ' + token)
636
- when LITERAL then token
637
- when PARAM then get_param(token[1..-1])
638
- when CLOSING then fail_due_to("#{token} in invalid position")
639
- when nil then fail_due_to('pattern ended prematurely')
640
- else fail_due_to("invalid token in arglist: #{token.inspect}")
641
- end
642
- end
643
-
644
- def next_capture
645
- index = @captures
646
- @captures += 1
647
- "captures[#{index}]"
648
- end
649
-
650
- def get_param(number)
651
- number = number.empty? ? 1 : Integer(number)
652
- @params = number if number > @params
653
- number.zero? ? @root : "param#{number}"
654
- end
655
-
656
- def emit_yield_capture(when_no_capture = '')
657
- yield_val = if @captures.zero?
658
- when_no_capture
659
- elsif @captures == 1
660
- 'captures[0]' # Circumvent https://github.com/jruby/jruby/issues/5710
661
- else
662
- '*captures'
663
- end
664
- "yield(#{yield_val})"
665
- end
666
-
667
- def emit_retval
668
- if @captures.zero?
669
- 'true'
670
- elsif @captures == 1
671
- 'captures[0]'
672
- else
673
- 'captures'
674
- end
675
- end
676
-
677
- def emit_param_list
678
- (1..@params).map { |n| "param#{n}" }.join(',')
679
- end
680
-
681
- def emit_trailing_params
682
- params = emit_param_list
683
- params.empty? ? '' : ",#{params}"
684
- end
685
-
686
- def emit_method_code
687
- <<~RUBY
688
- return unless #{@match_code}
689
- block_given? ? #{emit_yield_capture} : (return #{emit_retval})
690
- RUBY
691
- end
692
-
693
- def fail_due_to(message)
694
- raise Invalid, "Couldn't compile due to #{message}. Pattern: #{@string}"
695
- end
696
-
697
- def with_temp_node(cur_node)
698
- with_temp_variables do |node|
699
- yield "(#{node} = #{cur_node})", node
700
- end
701
- .gsub("\n", "\n ") # Nicer indent for debugging
702
- end
703
-
704
- def with_temp_variables(&block)
705
- names = block.parameters.map { |_, name| next_temp_variable(name) }
706
- yield(*names)
707
- end
708
-
709
- def next_temp_variable(name)
710
- "#{name}#{next_temp_value}"
711
- end
712
-
713
- def next_temp_value
714
- @temps += 1
715
- end
716
-
717
- def auto_use_temp_node?(code)
718
- code.scan(CUR_PLACEHOLDER).count > 1
719
- end
720
-
721
- # with_<...>_context methods are used whenever the context,
722
- # i.e the current node or the current element can be determined.
723
-
724
- def with_child_context(code, child_index)
725
- with_context(code, "#{CUR_NODE}.children[#{child_index}]")
726
- end
727
-
728
- def with_context(code, cur_node,
729
- use_temp_node: auto_use_temp_node?(code))
730
- if use_temp_node
731
- with_temp_node(cur_node) do |init, temp_var|
732
- substitute_cur_node(code, temp_var, first_cur_node: init)
733
- end
734
- else
735
- substitute_cur_node(code, cur_node)
736
- end
737
- end
738
-
739
- def with_seq_head_context(code)
740
- if code.include?(SEQ_HEAD_GUARD)
741
- fail_due_to('parentheses at sequence head')
742
- end
743
-
744
- code.gsub CUR_ELEMENT, "#{CUR_NODE}.type"
745
- end
746
-
747
- def substitute_cur_node(code, cur_node, first_cur_node: cur_node)
748
- iter = 0
749
- code
750
- .gsub(CUR_ELEMENT, CUR_NODE)
751
- .gsub(CUR_NODE) do
752
- iter += 1
753
- iter == 1 ? first_cur_node : cur_node
754
- end
755
- .gsub(SEQ_HEAD_GUARD, '')
756
- end
757
-
758
- def self.tokens(pattern)
759
- pattern.scan(TOKEN).reject { |token| token =~ /\A#{SEPARATORS}\Z/ }
760
- end
761
- end
762
- private_constant :Compiler
763
-
764
- # Helpers for defining methods based on a pattern string
765
- module Macros
766
- # Define a method which applies a pattern to an AST node
767
- #
768
- # The new method will return nil if the node does not match
769
- # If the node matches, and a block is provided, the new method will
770
- # yield to the block (passing any captures as block arguments).
771
- # If the node matches, and no block is provided, the new method will
772
- # return the captures, or `true` if there were none.
773
- def def_node_matcher(method_name, pattern_str)
774
- compiler = Compiler.new(pattern_str, 'node')
775
- src = "def #{method_name}(node = self" \
776
- "#{compiler.emit_trailing_params});" \
777
- "#{compiler.emit_method_code};end"
778
-
779
- location = caller_locations(1, 1).first
780
- class_eval(src, location.path, location.lineno)
781
- end
782
-
783
- # Define a method which recurses over the descendants of an AST node,
784
- # checking whether any of them match the provided pattern
785
- #
786
- # If the method name ends with '?', the new method will return `true`
787
- # as soon as it finds a descendant which matches. Otherwise, it will
788
- # yield all descendants which match.
789
- def def_node_search(method_name, pattern_str)
790
- compiler = Compiler.new(pattern_str, 'node')
791
- called_from = caller(1..1).first.split(':')
792
-
793
- if method_name.to_s.end_with?('?')
794
- node_search_first(method_name, compiler, called_from)
795
- else
796
- node_search_all(method_name, compiler, called_from)
797
- end
798
- end
799
-
800
- def node_search_first(method_name, compiler, called_from)
801
- node_search(method_name, compiler, 'return true', '', called_from)
802
- end
803
-
804
- def node_search_all(method_name, compiler, called_from)
805
- yield_code = compiler.emit_yield_capture('node')
806
- prelude = "return enum_for(:#{method_name}, node0" \
807
- "#{compiler.emit_trailing_params}) unless block_given?"
808
-
809
- node_search(method_name, compiler, yield_code, prelude, called_from)
810
- end
811
-
812
- def node_search(method_name, compiler, on_match, prelude, called_from)
813
- src = node_search_body(method_name, compiler.emit_trailing_params,
814
- prelude, compiler.match_code, on_match)
815
- filename, lineno = *called_from
816
- class_eval(src, filename, lineno.to_i)
817
- end
818
-
819
- def node_search_body(method_name, trailing_params, prelude, match_code,
820
- on_match)
821
- <<~RUBY
822
- def #{method_name}(node0#{trailing_params})
823
- #{prelude}
824
- node0.each_node do |node|
825
- if #{match_code}
826
- #{on_match}
827
- end
828
- end
829
- nil
830
- end
831
- RUBY
832
- end
833
- end
834
-
835
- attr_reader :pattern
836
-
837
- def initialize(str)
838
- @pattern = str
839
- compiler = Compiler.new(str)
840
- src = "def match(node0#{compiler.emit_trailing_params});" \
841
- "#{compiler.emit_method_code}end"
842
- instance_eval(src, __FILE__, __LINE__ + 1)
843
- end
844
-
845
- def match(*args)
846
- # If we're here, it's because the singleton method has not been defined,
847
- # either because we've been dup'ed or serialized through YAML
848
- initialize(pattern)
849
- match(*args)
850
- end
851
-
852
- def marshal_load(pattern)
853
- initialize pattern
854
- end
855
-
856
- def marshal_dump
857
- pattern
858
- end
859
-
860
- def ==(other)
861
- other.is_a?(NodePattern) &&
862
- Compiler.tokens(other.pattern) == Compiler.tokens(pattern)
863
- end
864
- alias eql? ==
865
-
866
- def to_s
867
- "#<#{self.class} #{pattern}>"
868
- end
869
-
870
- # Yields its argument and any descendants, depth-first.
871
- #
872
- def self.descend(element, &block)
873
- return to_enum(__method__, element) unless block_given?
874
-
875
- yield element
876
-
877
- if element.is_a?(::RuboCop::AST::Node)
878
- element.children.each do |child|
879
- descend(child, &block)
880
- end
881
- end
882
-
883
- nil
884
- end
885
- end
886
- end
887
- # rubocop:enable Metrics/ClassLength, Metrics/CyclomaticComplexity