rubocop 1.29.1 → 1.45.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (632) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.txt +1 -1
  3. data/README.md +6 -4
  4. data/config/default.yml +336 -47
  5. data/config/obsoletion.yml +25 -1
  6. data/exe/rubocop +15 -7
  7. data/lib/rubocop/arguments_env.rb +17 -0
  8. data/lib/rubocop/arguments_file.rb +17 -0
  9. data/lib/rubocop/cache_config.rb +29 -0
  10. data/lib/rubocop/cli/command/{auto_genenerate_config.rb → auto_generate_config.rb} +20 -5
  11. data/lib/rubocop/cli/command/execute_runner.rb +8 -8
  12. data/lib/rubocop/cli/command/init_dotfile.rb +1 -1
  13. data/lib/rubocop/cli/command/show_cops.rb +1 -1
  14. data/lib/rubocop/cli/command/suggest_extensions.rb +61 -16
  15. data/lib/rubocop/cli.rb +57 -9
  16. data/lib/rubocop/comment_config.rb +41 -1
  17. data/lib/rubocop/config.rb +45 -17
  18. data/lib/rubocop/config_finder.rb +68 -0
  19. data/lib/rubocop/config_loader.rb +41 -61
  20. data/lib/rubocop/config_loader_resolver.rb +11 -12
  21. data/lib/rubocop/config_obsoletion/changed_parameter.rb +5 -0
  22. data/lib/rubocop/config_obsoletion/parameter_rule.rb +4 -0
  23. data/lib/rubocop/config_obsoletion.rb +7 -2
  24. data/lib/rubocop/config_validator.rb +22 -5
  25. data/lib/rubocop/cop/autocorrect_logic.rb +4 -2
  26. data/lib/rubocop/cop/badge.rb +9 -4
  27. data/lib/rubocop/cop/base.rb +114 -82
  28. data/lib/rubocop/cop/bundler/duplicated_gem.rb +1 -1
  29. data/lib/rubocop/cop/bundler/gem_filename.rb +5 -5
  30. data/lib/rubocop/cop/bundler/ordered_gems.rb +2 -2
  31. data/lib/rubocop/cop/commissioner.rb +19 -6
  32. data/lib/rubocop/cop/cop.rb +52 -32
  33. data/lib/rubocop/cop/corrector.rb +32 -12
  34. data/lib/rubocop/cop/correctors/alignment_corrector.rb +1 -1
  35. data/lib/rubocop/cop/correctors/condition_corrector.rb +1 -1
  36. data/lib/rubocop/cop/correctors/each_to_for_corrector.rb +1 -1
  37. data/lib/rubocop/cop/correctors/empty_line_corrector.rb +1 -1
  38. data/lib/rubocop/cop/correctors/for_to_each_corrector.rb +4 -2
  39. data/lib/rubocop/cop/correctors/if_then_corrector.rb +1 -1
  40. data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb +1 -1
  41. data/lib/rubocop/cop/correctors/line_break_corrector.rb +7 -1
  42. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +25 -9
  43. data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb +2 -7
  44. data/lib/rubocop/cop/correctors/parentheses_corrector.rb +59 -1
  45. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +1 -1
  46. data/lib/rubocop/cop/correctors/punctuation_corrector.rb +1 -1
  47. data/lib/rubocop/cop/correctors/space_corrector.rb +1 -1
  48. data/lib/rubocop/cop/correctors/string_literal_corrector.rb +1 -1
  49. data/lib/rubocop/cop/correctors/unused_arg_corrector.rb +2 -2
  50. data/lib/rubocop/cop/gemspec/dependency_version.rb +16 -18
  51. data/lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb +92 -0
  52. data/lib/rubocop/cop/gemspec/development_dependencies.rb +107 -0
  53. data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +1 -1
  54. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +1 -1
  55. data/lib/rubocop/cop/gemspec/require_mfa.rb +21 -21
  56. data/lib/rubocop/cop/generator/require_file_injector.rb +2 -2
  57. data/lib/rubocop/cop/generator.rb +6 -3
  58. data/lib/rubocop/cop/internal_affairs/cop_description.rb +98 -0
  59. data/lib/rubocop/cop/internal_affairs/create_empty_file.rb +37 -0
  60. data/lib/rubocop/cop/internal_affairs/empty_line_between_expect_offense_and_correction.rb +1 -1
  61. data/lib/rubocop/cop/internal_affairs/example_heredoc_delimiter.rb +111 -0
  62. data/lib/rubocop/cop/internal_affairs/lambda_or_proc.rb +46 -0
  63. data/lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb +1 -1
  64. data/lib/rubocop/cop/internal_affairs/method_name_end_with.rb +1 -1
  65. data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +1 -5
  66. data/lib/rubocop/cop/internal_affairs/numblock_handler.rb +69 -0
  67. data/lib/rubocop/cop/internal_affairs/redundant_described_class_as_subject.rb +1 -1
  68. data/lib/rubocop/cop/internal_affairs/redundant_let_rubocop_config_new.rb +12 -4
  69. data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +1 -1
  70. data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +1 -1
  71. data/lib/rubocop/cop/internal_affairs/single_line_comparison.rb +62 -0
  72. data/lib/rubocop/cop/internal_affairs/useless_restrict_on_send.rb +60 -0
  73. data/lib/rubocop/cop/internal_affairs.rb +7 -0
  74. data/lib/rubocop/cop/layout/argument_alignment.rb +22 -1
  75. data/lib/rubocop/cop/layout/array_alignment.rb +1 -1
  76. data/lib/rubocop/cop/layout/assignment_indentation.rb +1 -1
  77. data/lib/rubocop/cop/layout/begin_end_alignment.rb +1 -1
  78. data/lib/rubocop/cop/layout/block_alignment.rb +17 -13
  79. data/lib/rubocop/cop/layout/block_end_newline.rb +42 -6
  80. data/lib/rubocop/cop/layout/case_indentation.rb +1 -1
  81. data/lib/rubocop/cop/layout/class_structure.rb +31 -24
  82. data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +3 -7
  83. data/lib/rubocop/cop/layout/comment_indentation.rb +4 -2
  84. data/lib/rubocop/cop/layout/condition_position.rb +1 -1
  85. data/lib/rubocop/cop/layout/def_end_alignment.rb +1 -1
  86. data/lib/rubocop/cop/layout/dot_position.rb +1 -1
  87. data/lib/rubocop/cop/layout/else_alignment.rb +1 -1
  88. data/lib/rubocop/cop/layout/empty_comment.rb +2 -2
  89. data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +1 -1
  90. data/lib/rubocop/cop/layout/empty_line_after_multiline_condition.rb +1 -1
  91. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +1 -1
  92. data/lib/rubocop/cop/layout/empty_lines.rb +3 -1
  93. data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +5 -2
  94. data/lib/rubocop/cop/layout/empty_lines_around_arguments.rb +1 -1
  95. data/lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb +25 -4
  96. data/lib/rubocop/cop/layout/empty_lines_around_begin_body.rb +1 -1
  97. data/lib/rubocop/cop/layout/empty_lines_around_block_body.rb +7 -5
  98. data/lib/rubocop/cop/layout/empty_lines_around_class_body.rb +10 -10
  99. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +1 -1
  100. data/lib/rubocop/cop/layout/empty_lines_around_method_body.rb +1 -1
  101. data/lib/rubocop/cop/layout/empty_lines_around_module_body.rb +10 -10
  102. data/lib/rubocop/cop/layout/end_alignment.rb +1 -1
  103. data/lib/rubocop/cop/layout/end_of_line.rb +5 -5
  104. data/lib/rubocop/cop/layout/extra_spacing.rb +10 -6
  105. data/lib/rubocop/cop/layout/first_argument_indentation.rb +36 -30
  106. data/lib/rubocop/cop/layout/first_array_element_indentation.rb +21 -14
  107. data/lib/rubocop/cop/layout/first_array_element_line_break.rb +39 -3
  108. data/lib/rubocop/cop/layout/first_hash_element_indentation.rb +52 -13
  109. data/lib/rubocop/cop/layout/first_hash_element_line_break.rb +50 -3
  110. data/lib/rubocop/cop/layout/first_method_argument_line_break.rb +62 -3
  111. data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb +53 -3
  112. data/lib/rubocop/cop/layout/first_parameter_indentation.rb +1 -1
  113. data/lib/rubocop/cop/layout/hash_alignment.rb +2 -0
  114. data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +1 -1
  115. data/lib/rubocop/cop/layout/heredoc_indentation.rb +7 -10
  116. data/lib/rubocop/cop/layout/indentation_consistency.rb +1 -1
  117. data/lib/rubocop/cop/layout/indentation_style.rb +8 -3
  118. data/lib/rubocop/cop/layout/indentation_width.rb +14 -7
  119. data/lib/rubocop/cop/layout/initial_indentation.rb +2 -2
  120. data/lib/rubocop/cop/layout/leading_comment_space.rb +1 -1
  121. data/lib/rubocop/cop/layout/leading_empty_lines.rb +1 -1
  122. data/lib/rubocop/cop/layout/line_continuation_leading_space.rb +138 -0
  123. data/lib/rubocop/cop/layout/line_continuation_spacing.rb +136 -0
  124. data/lib/rubocop/cop/layout/line_end_string_concatenation_indentation.rb +1 -1
  125. data/lib/rubocop/cop/layout/line_length.rb +9 -2
  126. data/lib/rubocop/cop/layout/multiline_array_brace_layout.rb +1 -1
  127. data/lib/rubocop/cop/layout/multiline_array_line_breaks.rb +52 -3
  128. data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +2 -2
  129. data/lib/rubocop/cop/layout/multiline_block_layout.rb +5 -3
  130. data/lib/rubocop/cop/layout/multiline_hash_brace_layout.rb +1 -1
  131. data/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb +50 -3
  132. data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +58 -4
  133. data/lib/rubocop/cop/layout/multiline_method_call_brace_layout.rb +1 -1
  134. data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +3 -3
  135. data/lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb +1 -1
  136. data/lib/rubocop/cop/layout/multiline_method_parameter_line_breaks.rb +101 -0
  137. data/lib/rubocop/cop/layout/multiline_operation_indentation.rb +3 -3
  138. data/lib/rubocop/cop/layout/redundant_line_break.rb +4 -4
  139. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +1 -1
  140. data/lib/rubocop/cop/layout/single_line_block_chain.rb +1 -1
  141. data/lib/rubocop/cop/layout/space_after_not.rb +1 -1
  142. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +2 -2
  143. data/lib/rubocop/cop/layout/space_around_keyword.rb +3 -3
  144. data/lib/rubocop/cop/layout/space_around_operators.rb +2 -2
  145. data/lib/rubocop/cop/layout/space_before_block_braces.rb +5 -3
  146. data/lib/rubocop/cop/layout/space_before_comment.rb +1 -1
  147. data/lib/rubocop/cop/layout/space_before_first_arg.rb +1 -1
  148. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +1 -1
  149. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +32 -30
  150. data/lib/rubocop/cop/layout/space_inside_array_percent_literal.rb +3 -0
  151. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +33 -15
  152. data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +30 -3
  153. data/lib/rubocop/cop/layout/space_inside_percent_literal_delimiters.rb +34 -0
  154. data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +10 -6
  155. data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +6 -5
  156. data/lib/rubocop/cop/layout/trailing_empty_lines.rb +9 -9
  157. data/lib/rubocop/cop/layout/trailing_whitespace.rb +13 -6
  158. data/lib/rubocop/cop/legacy/corrections_proxy.rb +1 -1
  159. data/lib/rubocop/cop/legacy/corrector.rb +1 -1
  160. data/lib/rubocop/cop/lint/ambiguous_assignment.rb +1 -1
  161. data/lib/rubocop/cop/lint/ambiguous_block_association.rb +28 -8
  162. data/lib/rubocop/cop/lint/ambiguous_operator.rb +5 -1
  163. data/lib/rubocop/cop/lint/ambiguous_operator_precedence.rb +1 -1
  164. data/lib/rubocop/cop/lint/ambiguous_range.rb +3 -3
  165. data/lib/rubocop/cop/lint/ambiguous_regexp_literal.rb +1 -1
  166. data/lib/rubocop/cop/lint/assignment_in_condition.rb +12 -2
  167. data/lib/rubocop/cop/lint/binary_operator_with_identical_operands.rb +1 -1
  168. data/lib/rubocop/cop/lint/boolean_symbol.rb +1 -1
  169. data/lib/rubocop/cop/lint/circular_argument_reference.rb +1 -1
  170. data/lib/rubocop/cop/lint/constant_overwritten_in_rescue.rb +51 -0
  171. data/lib/rubocop/cop/lint/constant_resolution.rb +4 -0
  172. data/lib/rubocop/cop/lint/debugger.rb +25 -32
  173. data/lib/rubocop/cop/lint/deprecated_class_methods.rb +67 -111
  174. data/lib/rubocop/cop/lint/deprecated_constants.rb +9 -2
  175. data/lib/rubocop/cop/lint/disjunctive_assignment_in_constructor.rb +1 -1
  176. data/lib/rubocop/cop/lint/duplicate_branch.rb +1 -3
  177. data/lib/rubocop/cop/lint/duplicate_case_condition.rb +1 -1
  178. data/lib/rubocop/cop/lint/duplicate_elsif_condition.rb +1 -1
  179. data/lib/rubocop/cop/lint/duplicate_hash_key.rb +1 -1
  180. data/lib/rubocop/cop/lint/duplicate_magic_comment.rb +73 -0
  181. data/lib/rubocop/cop/lint/duplicate_methods.rb +48 -18
  182. data/lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb +26 -7
  183. data/lib/rubocop/cop/lint/duplicate_require.rb +1 -1
  184. data/lib/rubocop/cop/lint/duplicate_rescue_exception.rb +1 -1
  185. data/lib/rubocop/cop/lint/each_with_object_argument.rb +1 -1
  186. data/lib/rubocop/cop/lint/else_layout.rb +5 -9
  187. data/lib/rubocop/cop/lint/empty_block.rb +3 -7
  188. data/lib/rubocop/cop/lint/empty_class.rb +4 -2
  189. data/lib/rubocop/cop/lint/empty_conditional_body.rb +109 -3
  190. data/lib/rubocop/cop/lint/empty_ensure.rb +1 -1
  191. data/lib/rubocop/cop/lint/empty_expression.rb +1 -1
  192. data/lib/rubocop/cop/lint/empty_file.rb +1 -1
  193. data/lib/rubocop/cop/lint/empty_in_pattern.rb +1 -1
  194. data/lib/rubocop/cop/lint/empty_interpolation.rb +1 -1
  195. data/lib/rubocop/cop/lint/empty_when.rb +1 -1
  196. data/lib/rubocop/cop/lint/ensure_return.rb +1 -1
  197. data/lib/rubocop/cop/lint/erb_new_arguments.rb +9 -9
  198. data/lib/rubocop/cop/lint/flip_flop.rb +1 -1
  199. data/lib/rubocop/cop/lint/float_comparison.rb +1 -1
  200. data/lib/rubocop/cop/lint/float_out_of_range.rb +1 -1
  201. data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +14 -7
  202. data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +16 -18
  203. data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +2 -2
  204. data/lib/rubocop/cop/lint/incompatible_io_select_with_fiber_scheduler.rb +1 -1
  205. data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +1 -1
  206. data/lib/rubocop/cop/lint/inherit_exception.rb +1 -1
  207. data/lib/rubocop/cop/lint/interpolation_check.rb +6 -5
  208. data/lib/rubocop/cop/lint/lambda_without_literal_block.rb +2 -2
  209. data/lib/rubocop/cop/lint/literal_as_condition.rb +6 -1
  210. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +5 -1
  211. data/lib/rubocop/cop/lint/loop.rb +1 -1
  212. data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +19 -4
  213. data/lib/rubocop/cop/lint/missing_super.rb +1 -1
  214. data/lib/rubocop/cop/lint/mixed_regexp_capture_types.rb +1 -0
  215. data/lib/rubocop/cop/lint/nested_method_definition.rb +58 -6
  216. data/lib/rubocop/cop/lint/nested_percent_literal.rb +1 -1
  217. data/lib/rubocop/cop/lint/next_without_accumulator.rb +25 -6
  218. data/lib/rubocop/cop/lint/non_atomic_file_operation.rb +162 -0
  219. data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +12 -0
  220. data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +1 -1
  221. data/lib/rubocop/cop/lint/number_conversion.rb +32 -10
  222. data/lib/rubocop/cop/lint/numbered_parameter_assignment.rb +1 -1
  223. data/lib/rubocop/cop/lint/or_assignment_to_constant.rb +2 -3
  224. data/lib/rubocop/cop/lint/ordered_magic_comments.rb +4 -5
  225. data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +20 -1
  226. data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +6 -1
  227. data/lib/rubocop/cop/lint/percent_string_array.rb +1 -1
  228. data/lib/rubocop/cop/lint/percent_symbol_array.rb +1 -1
  229. data/lib/rubocop/cop/lint/raise_exception.rb +1 -1
  230. data/lib/rubocop/cop/lint/rand_one.rb +1 -1
  231. data/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb +44 -10
  232. data/lib/rubocop/cop/lint/redundant_cop_enable_directive.rb +3 -3
  233. data/lib/rubocop/cop/lint/redundant_dir_glob_sort.rb +7 -0
  234. data/lib/rubocop/cop/lint/redundant_require_statement.rb +48 -7
  235. data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +16 -3
  236. data/lib/rubocop/cop/lint/redundant_splat_expansion.rb +1 -1
  237. data/lib/rubocop/cop/lint/redundant_string_coercion.rb +1 -1
  238. data/lib/rubocop/cop/lint/redundant_with_index.rb +14 -11
  239. data/lib/rubocop/cop/lint/redundant_with_object.rb +13 -12
  240. data/lib/rubocop/cop/lint/refinement_import_methods.rb +1 -1
  241. data/lib/rubocop/cop/lint/regexp_as_condition.rb +9 -3
  242. data/lib/rubocop/cop/lint/require_parentheses.rb +4 -2
  243. data/lib/rubocop/cop/lint/require_range_parentheses.rb +57 -0
  244. data/lib/rubocop/cop/lint/rescue_exception.rb +1 -1
  245. data/lib/rubocop/cop/lint/return_in_void_context.rb +1 -1
  246. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +44 -8
  247. data/lib/rubocop/cop/lint/safe_navigation_consistency.rb +1 -1
  248. data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +1 -1
  249. data/lib/rubocop/cop/lint/script_permission.rb +1 -1
  250. data/lib/rubocop/cop/lint/self_assignment.rb +1 -1
  251. data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +5 -4
  252. data/lib/rubocop/cop/lint/shadowed_argument.rb +1 -1
  253. data/lib/rubocop/cop/lint/shadowed_exception.rb +16 -11
  254. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +29 -4
  255. data/lib/rubocop/cop/lint/struct_new_override.rb +3 -3
  256. data/lib/rubocop/cop/lint/suppressed_exception.rb +2 -2
  257. data/lib/rubocop/cop/lint/symbol_conversion.rb +1 -1
  258. data/lib/rubocop/cop/lint/syntax.rb +1 -1
  259. data/lib/rubocop/cop/lint/to_enum_arguments.rb +1 -1
  260. data/lib/rubocop/cop/lint/to_json.rb +1 -1
  261. data/lib/rubocop/cop/lint/top_level_return_with_argument.rb +1 -1
  262. data/lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb +2 -2
  263. data/lib/rubocop/cop/lint/triple_quotes.rb +1 -1
  264. data/lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb +1 -1
  265. data/lib/rubocop/cop/lint/unexpected_block_arity.rb +1 -1
  266. data/lib/rubocop/cop/lint/unified_integer.rb +3 -1
  267. data/lib/rubocop/cop/lint/unreachable_code.rb +1 -1
  268. data/lib/rubocop/cop/lint/unreachable_loop.rb +10 -4
  269. data/lib/rubocop/cop/lint/unused_block_argument.rb +1 -1
  270. data/lib/rubocop/cop/lint/unused_method_argument.rb +7 -2
  271. data/lib/rubocop/cop/lint/uri_escape_unescape.rb +1 -1
  272. data/lib/rubocop/cop/lint/uri_regexp.rb +1 -1
  273. data/lib/rubocop/cop/lint/useless_access_modifier.rb +15 -10
  274. data/lib/rubocop/cop/lint/useless_assignment.rb +1 -1
  275. data/lib/rubocop/cop/lint/useless_else_without_rescue.rb +44 -0
  276. data/lib/rubocop/cop/lint/useless_method_definition.rb +4 -4
  277. data/lib/rubocop/cop/lint/useless_rescue.rb +85 -0
  278. data/lib/rubocop/cop/lint/useless_ruby2_keywords.rb +16 -6
  279. data/lib/rubocop/cop/lint/useless_setter_call.rb +2 -2
  280. data/lib/rubocop/cop/lint/useless_times.rb +1 -1
  281. data/lib/rubocop/cop/lint/void.rb +27 -16
  282. data/lib/rubocop/cop/metrics/abc_size.rb +5 -3
  283. data/lib/rubocop/cop/metrics/block_length.rb +17 -12
  284. data/lib/rubocop/cop/metrics/block_nesting.rb +2 -2
  285. data/lib/rubocop/cop/metrics/class_length.rb +10 -5
  286. data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +2 -2
  287. data/lib/rubocop/cop/metrics/method_length.rb +18 -12
  288. data/lib/rubocop/cop/metrics/module_length.rb +10 -5
  289. data/lib/rubocop/cop/metrics/parameter_lists.rb +28 -1
  290. data/lib/rubocop/cop/metrics/perceived_complexity.rb +2 -2
  291. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +3 -6
  292. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +7 -4
  293. data/lib/rubocop/cop/mixin/alignment.rb +2 -2
  294. data/lib/rubocop/cop/mixin/allowed_identifiers.rb +2 -2
  295. data/lib/rubocop/cop/mixin/allowed_methods.rb +23 -2
  296. data/lib/rubocop/cop/mixin/allowed_pattern.rb +17 -1
  297. data/lib/rubocop/cop/mixin/annotation_comment.rb +13 -6
  298. data/lib/rubocop/cop/mixin/check_line_breakable.rb +5 -1
  299. data/lib/rubocop/cop/mixin/comments_help.rb +22 -4
  300. data/lib/rubocop/cop/mixin/configurable_enforced_style.rb +21 -9
  301. data/lib/rubocop/cop/mixin/def_node.rb +2 -7
  302. data/lib/rubocop/cop/mixin/enforce_superclass.rb +2 -1
  303. data/lib/rubocop/cop/mixin/first_element_line_break.rb +11 -7
  304. data/lib/rubocop/cop/mixin/frozen_string_literal.rb +4 -0
  305. data/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb +152 -12
  306. data/lib/rubocop/cop/mixin/hash_transform_method.rb +10 -6
  307. data/lib/rubocop/cop/mixin/line_length_help.rb +11 -2
  308. data/lib/rubocop/cop/mixin/method_complexity.rb +13 -16
  309. data/lib/rubocop/cop/mixin/multiline_element_indentation.rb +34 -12
  310. data/lib/rubocop/cop/mixin/multiline_element_line_breaks.rb +5 -3
  311. data/lib/rubocop/cop/mixin/percent_array.rb +58 -1
  312. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +1 -1
  313. data/lib/rubocop/cop/mixin/range_help.rb +33 -7
  314. data/lib/rubocop/cop/mixin/require_library.rb +2 -0
  315. data/lib/rubocop/cop/mixin/rescue_node.rb +5 -3
  316. data/lib/rubocop/cop/mixin/statement_modifier.rb +16 -1
  317. data/lib/rubocop/cop/mixin/string_help.rb +1 -1
  318. data/lib/rubocop/cop/mixin/surrounding_space.rb +13 -11
  319. data/lib/rubocop/cop/mixin/trailing_comma.rb +1 -1
  320. data/lib/rubocop/cop/mixin/visibility_help.rb +40 -5
  321. data/lib/rubocop/cop/naming/accessor_method_name.rb +4 -2
  322. data/lib/rubocop/cop/naming/ascii_identifiers.rb +1 -1
  323. data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +1 -1
  324. data/lib/rubocop/cop/naming/block_forwarding.rb +7 -3
  325. data/lib/rubocop/cop/naming/block_parameter_name.rb +2 -2
  326. data/lib/rubocop/cop/naming/class_and_module_camel_case.rb +4 -2
  327. data/lib/rubocop/cop/naming/constant_name.rb +3 -3
  328. data/lib/rubocop/cop/naming/file_name.rb +1 -1
  329. data/lib/rubocop/cop/naming/heredoc_delimiter_case.rb +1 -1
  330. data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb +1 -1
  331. data/lib/rubocop/cop/naming/inclusive_language.rb +5 -2
  332. data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +1 -1
  333. data/lib/rubocop/cop/naming/method_name.rb +1 -1
  334. data/lib/rubocop/cop/naming/method_parameter_name.rb +1 -1
  335. data/lib/rubocop/cop/naming/predicate_name.rb +30 -1
  336. data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +1 -1
  337. data/lib/rubocop/cop/naming/variable_name.rb +1 -1
  338. data/lib/rubocop/cop/naming/variable_number.rb +18 -18
  339. data/lib/rubocop/cop/registry.rb +70 -44
  340. data/lib/rubocop/cop/security/compound_hash.rb +3 -2
  341. data/lib/rubocop/cop/security/eval.rb +1 -1
  342. data/lib/rubocop/cop/security/json_load.rb +1 -1
  343. data/lib/rubocop/cop/security/marshal_load.rb +1 -1
  344. data/lib/rubocop/cop/security/open.rb +1 -1
  345. data/lib/rubocop/cop/security/yaml_load.rb +1 -1
  346. data/lib/rubocop/cop/style/access_modifier_declarations.rb +92 -3
  347. data/lib/rubocop/cop/style/accessor_grouping.rb +11 -7
  348. data/lib/rubocop/cop/style/alias.rb +10 -2
  349. data/lib/rubocop/cop/style/and_or.rb +11 -11
  350. data/lib/rubocop/cop/style/arguments_forwarding.rb +4 -3
  351. data/lib/rubocop/cop/style/array_coercion.rb +1 -1
  352. data/lib/rubocop/cop/style/array_intersect.rb +111 -0
  353. data/lib/rubocop/cop/style/array_join.rb +1 -1
  354. data/lib/rubocop/cop/style/ascii_comments.rb +1 -1
  355. data/lib/rubocop/cop/style/attr.rb +1 -1
  356. data/lib/rubocop/cop/style/auto_resource_cleanup.rb +1 -1
  357. data/lib/rubocop/cop/style/bare_percent_literals.rb +1 -1
  358. data/lib/rubocop/cop/style/bisected_attr_accessor.rb +1 -1
  359. data/lib/rubocop/cop/style/block_comments.rb +2 -2
  360. data/lib/rubocop/cop/style/block_delimiters.rb +38 -11
  361. data/lib/rubocop/cop/style/case_equality.rb +41 -11
  362. data/lib/rubocop/cop/style/case_like_if.rb +1 -1
  363. data/lib/rubocop/cop/style/character_literal.rb +1 -1
  364. data/lib/rubocop/cop/style/class_and_module_children.rb +8 -15
  365. data/lib/rubocop/cop/style/class_check.rb +1 -1
  366. data/lib/rubocop/cop/style/class_equality_comparison.rb +55 -6
  367. data/lib/rubocop/cop/style/class_methods.rb +1 -1
  368. data/lib/rubocop/cop/style/class_methods_definitions.rb +3 -2
  369. data/lib/rubocop/cop/style/class_vars.rb +1 -1
  370. data/lib/rubocop/cop/style/collection_compact.rb +13 -4
  371. data/lib/rubocop/cop/style/collection_methods.rb +3 -1
  372. data/lib/rubocop/cop/style/colon_method_call.rb +1 -1
  373. data/lib/rubocop/cop/style/colon_method_definition.rb +1 -1
  374. data/lib/rubocop/cop/style/combinable_loops.rb +4 -2
  375. data/lib/rubocop/cop/style/command_literal.rb +2 -2
  376. data/lib/rubocop/cop/style/comment_annotation.rb +1 -1
  377. data/lib/rubocop/cop/style/commented_keyword.rb +4 -4
  378. data/lib/rubocop/cop/style/comparable_clamp.rb +125 -0
  379. data/lib/rubocop/cop/style/concat_array_literals.rb +86 -0
  380. data/lib/rubocop/cop/style/conditional_assignment.rb +2 -7
  381. data/lib/rubocop/cop/style/constant_visibility.rb +1 -1
  382. data/lib/rubocop/cop/style/date_time.rb +1 -1
  383. data/lib/rubocop/cop/style/def_with_parentheses.rb +1 -1
  384. data/lib/rubocop/cop/style/dir.rb +4 -1
  385. data/lib/rubocop/cop/style/documentation.rb +13 -7
  386. data/lib/rubocop/cop/style/documentation_method.rb +7 -1
  387. data/lib/rubocop/cop/style/double_negation.rb +3 -1
  388. data/lib/rubocop/cop/style/each_for_simple_loop.rb +42 -7
  389. data/lib/rubocop/cop/style/each_with_object.rb +40 -9
  390. data/lib/rubocop/cop/style/empty_block_parameter.rb +2 -2
  391. data/lib/rubocop/cop/style/empty_case_condition.rb +1 -1
  392. data/lib/rubocop/cop/style/empty_else.rb +40 -3
  393. data/lib/rubocop/cop/style/empty_heredoc.rb +73 -0
  394. data/lib/rubocop/cop/style/empty_lambda_parameter.rb +2 -2
  395. data/lib/rubocop/cop/style/empty_literal.rb +1 -1
  396. data/lib/rubocop/cop/style/empty_method.rb +18 -3
  397. data/lib/rubocop/cop/style/encoding.rb +2 -2
  398. data/lib/rubocop/cop/style/end_block.rb +1 -1
  399. data/lib/rubocop/cop/style/endless_method.rb +2 -2
  400. data/lib/rubocop/cop/style/env_home.rb +1 -1
  401. data/lib/rubocop/cop/style/eval_with_location.rb +1 -1
  402. data/lib/rubocop/cop/style/even_odd.rb +1 -1
  403. data/lib/rubocop/cop/style/expand_path_arguments.rb +1 -1
  404. data/lib/rubocop/cop/style/explicit_block_argument.rb +6 -2
  405. data/lib/rubocop/cop/style/exponential_notation.rb +1 -1
  406. data/lib/rubocop/cop/style/fetch_env_var.rb +37 -224
  407. data/lib/rubocop/cop/style/float_division.rb +1 -1
  408. data/lib/rubocop/cop/style/for.rb +3 -1
  409. data/lib/rubocop/cop/style/format_string.rb +1 -1
  410. data/lib/rubocop/cop/style/format_string_token.rb +73 -23
  411. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +6 -3
  412. data/lib/rubocop/cop/style/global_std_stream.rb +1 -1
  413. data/lib/rubocop/cop/style/global_vars.rb +1 -1
  414. data/lib/rubocop/cop/style/guard_clause.rb +132 -43
  415. data/lib/rubocop/cop/style/hash_as_last_array_item.rb +2 -1
  416. data/lib/rubocop/cop/style/hash_conversion.rb +1 -1
  417. data/lib/rubocop/cop/style/hash_each_methods.rb +49 -13
  418. data/lib/rubocop/cop/style/hash_except.rb +89 -9
  419. data/lib/rubocop/cop/style/hash_like_case.rb +1 -1
  420. data/lib/rubocop/cop/style/hash_syntax.rb +24 -3
  421. data/lib/rubocop/cop/style/hash_transform_keys.rb +6 -1
  422. data/lib/rubocop/cop/style/hash_transform_values.rb +4 -1
  423. data/lib/rubocop/cop/style/identical_conditional_branches.rb +17 -2
  424. data/lib/rubocop/cop/style/if_unless_modifier.rb +1 -1
  425. data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +29 -4
  426. data/lib/rubocop/cop/style/if_with_semicolon.rb +4 -4
  427. data/lib/rubocop/cop/style/implicit_runtime_error.rb +3 -3
  428. data/lib/rubocop/cop/style/in_pattern_then.rb +1 -1
  429. data/lib/rubocop/cop/style/infinite_loop.rb +2 -5
  430. data/lib/rubocop/cop/style/inline_comment.rb +1 -1
  431. data/lib/rubocop/cop/style/inverse_methods.rb +12 -8
  432. data/lib/rubocop/cop/style/invertible_unless_condition.rb +114 -0
  433. data/lib/rubocop/cop/style/ip_addresses.rb +1 -1
  434. data/lib/rubocop/cop/style/keyword_parameters_order.rb +2 -2
  435. data/lib/rubocop/cop/style/lambda.rb +1 -1
  436. data/lib/rubocop/cop/style/lambda_call.rb +1 -1
  437. data/lib/rubocop/cop/style/line_end_concatenation.rb +6 -3
  438. data/lib/rubocop/cop/style/magic_comment_format.rb +307 -0
  439. data/lib/rubocop/cop/style/map_compact_with_conditional_block.rb +136 -0
  440. data/lib/rubocop/cop/style/map_to_hash.rb +3 -3
  441. data/lib/rubocop/cop/style/map_to_set.rb +61 -0
  442. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +39 -19
  443. data/lib/rubocop/cop/style/method_call_with_args_parentheses/require_parentheses.rb +5 -1
  444. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +8 -8
  445. data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +22 -3
  446. data/lib/rubocop/cop/style/method_called_on_do_end_block.rb +5 -2
  447. data/lib/rubocop/cop/style/method_def_parentheses.rb +12 -5
  448. data/lib/rubocop/cop/style/min_max.rb +1 -1
  449. data/lib/rubocop/cop/style/min_max_comparison.rb +83 -0
  450. data/lib/rubocop/cop/style/missing_else.rb +37 -25
  451. data/lib/rubocop/cop/style/missing_respond_to_missing.rb +1 -1
  452. data/lib/rubocop/cop/style/mixin_grouping.rb +1 -1
  453. data/lib/rubocop/cop/style/mixin_usage.rb +1 -1
  454. data/lib/rubocop/cop/style/module_function.rb +30 -8
  455. data/lib/rubocop/cop/style/multiline_block_chain.rb +4 -2
  456. data/lib/rubocop/cop/style/multiline_if_modifier.rb +2 -6
  457. data/lib/rubocop/cop/style/multiline_if_then.rb +1 -1
  458. data/lib/rubocop/cop/style/multiline_in_pattern_then.rb +3 -5
  459. data/lib/rubocop/cop/style/multiline_memoization.rb +3 -3
  460. data/lib/rubocop/cop/style/multiline_method_signature.rb +2 -2
  461. data/lib/rubocop/cop/style/multiline_ternary_operator.rb +21 -6
  462. data/lib/rubocop/cop/style/multiline_when_then.rb +2 -4
  463. data/lib/rubocop/cop/style/multiple_comparison.rb +1 -1
  464. data/lib/rubocop/cop/style/mutable_constant.rb +1 -1
  465. data/lib/rubocop/cop/style/negated_if_else_condition.rb +9 -7
  466. data/lib/rubocop/cop/style/nested_file_dirname.rb +1 -1
  467. data/lib/rubocop/cop/style/nested_modifier.rb +1 -1
  468. data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +11 -2
  469. data/lib/rubocop/cop/style/nested_ternary_operator.rb +20 -8
  470. data/lib/rubocop/cop/style/next.rb +3 -5
  471. data/lib/rubocop/cop/style/nil_comparison.rb +1 -1
  472. data/lib/rubocop/cop/style/nil_lambda.rb +4 -4
  473. data/lib/rubocop/cop/style/non_nil_check.rb +1 -1
  474. data/lib/rubocop/cop/style/not.rb +2 -2
  475. data/lib/rubocop/cop/style/numbered_parameters.rb +1 -1
  476. data/lib/rubocop/cop/style/numbered_parameters_limit.rb +12 -4
  477. data/lib/rubocop/cop/style/numeric_literal_prefix.rb +1 -1
  478. data/lib/rubocop/cop/style/numeric_literals.rb +16 -1
  479. data/lib/rubocop/cop/style/numeric_predicate.rb +53 -11
  480. data/lib/rubocop/cop/style/object_then.rb +6 -1
  481. data/lib/rubocop/cop/style/one_line_conditional.rb +4 -7
  482. data/lib/rubocop/cop/style/open_struct_use.rb +1 -1
  483. data/lib/rubocop/cop/style/operator_method_call.rb +67 -0
  484. data/lib/rubocop/cop/style/option_hash.rb +1 -1
  485. data/lib/rubocop/cop/style/optional_arguments.rb +1 -1
  486. data/lib/rubocop/cop/style/optional_boolean_parameter.rb +1 -1
  487. data/lib/rubocop/cop/style/or_assignment.rb +1 -1
  488. data/lib/rubocop/cop/style/parallel_assignment.rb +3 -1
  489. data/lib/rubocop/cop/style/parentheses_around_condition.rb +1 -1
  490. data/lib/rubocop/cop/style/percent_literal_delimiters.rb +1 -1
  491. data/lib/rubocop/cop/style/percent_q_literals.rb +1 -1
  492. data/lib/rubocop/cop/style/perl_backrefs.rb +23 -2
  493. data/lib/rubocop/cop/style/preferred_hash_methods.rb +1 -1
  494. data/lib/rubocop/cop/style/proc.rb +5 -2
  495. data/lib/rubocop/cop/style/quoted_symbols.rb +1 -1
  496. data/lib/rubocop/cop/style/raise_args.rb +1 -1
  497. data/lib/rubocop/cop/style/random_with_offset.rb +1 -1
  498. data/lib/rubocop/cop/style/redundant_argument.rb +5 -2
  499. data/lib/rubocop/cop/style/redundant_assignment.rb +1 -1
  500. data/lib/rubocop/cop/style/redundant_begin.rb +20 -6
  501. data/lib/rubocop/cop/style/redundant_capital_w.rb +1 -1
  502. data/lib/rubocop/cop/style/redundant_condition.rb +48 -11
  503. data/lib/rubocop/cop/style/redundant_conditional.rb +1 -5
  504. data/lib/rubocop/cop/style/redundant_constant_base.rb +85 -0
  505. data/lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb +45 -0
  506. data/lib/rubocop/cop/style/redundant_each.rb +116 -0
  507. data/lib/rubocop/cop/style/redundant_exception.rb +1 -1
  508. data/lib/rubocop/cop/style/redundant_fetch_block.rb +2 -2
  509. data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +1 -1
  510. data/lib/rubocop/cop/style/redundant_freeze.rb +1 -1
  511. data/lib/rubocop/cop/style/redundant_heredoc_delimiter_quotes.rb +58 -0
  512. data/lib/rubocop/cop/style/redundant_initialize.rb +3 -1
  513. data/lib/rubocop/cop/style/redundant_interpolation.rb +22 -1
  514. data/lib/rubocop/cop/style/redundant_parentheses.rb +22 -24
  515. data/lib/rubocop/cop/style/redundant_percent_q.rb +1 -1
  516. data/lib/rubocop/cop/style/redundant_regexp_character_class.rb +10 -3
  517. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +14 -4
  518. data/lib/rubocop/cop/style/redundant_return.rb +9 -2
  519. data/lib/rubocop/cop/style/redundant_self.rb +3 -1
  520. data/lib/rubocop/cop/style/redundant_self_assignment.rb +2 -2
  521. data/lib/rubocop/cop/style/redundant_self_assignment_branch.rb +1 -1
  522. data/lib/rubocop/cop/style/redundant_sort.rb +23 -8
  523. data/lib/rubocop/cop/style/redundant_sort_by.rb +25 -9
  524. data/lib/rubocop/cop/style/redundant_string_escape.rb +184 -0
  525. data/lib/rubocop/cop/style/regexp_literal.rb +1 -1
  526. data/lib/rubocop/cop/style/require_order.rb +135 -0
  527. data/lib/rubocop/cop/style/rescue_modifier.rb +2 -2
  528. data/lib/rubocop/cop/style/rescue_standard_error.rb +13 -13
  529. data/lib/rubocop/cop/style/return_nil.rb +1 -1
  530. data/lib/rubocop/cop/style/safe_navigation.rb +43 -9
  531. data/lib/rubocop/cop/style/sample.rb +1 -1
  532. data/lib/rubocop/cop/style/select_by_regexp.rb +14 -6
  533. data/lib/rubocop/cop/style/self_assignment.rb +3 -3
  534. data/lib/rubocop/cop/style/semicolon.rb +53 -6
  535. data/lib/rubocop/cop/style/send.rb +1 -1
  536. data/lib/rubocop/cop/style/signal_exception.rb +9 -7
  537. data/lib/rubocop/cop/style/single_line_block_params.rb +2 -2
  538. data/lib/rubocop/cop/style/single_line_methods.rb +2 -2
  539. data/lib/rubocop/cop/style/slicing_with_range.rb +1 -1
  540. data/lib/rubocop/cop/style/sole_nested_conditional.rb +42 -14
  541. data/lib/rubocop/cop/style/static_class.rb +33 -2
  542. data/lib/rubocop/cop/style/stderr_puts.rb +1 -1
  543. data/lib/rubocop/cop/style/string_concatenation.rb +6 -7
  544. data/lib/rubocop/cop/style/string_hash_keys.rb +5 -2
  545. data/lib/rubocop/cop/style/string_literals.rb +1 -5
  546. data/lib/rubocop/cop/style/string_literals_in_interpolation.rb +1 -1
  547. data/lib/rubocop/cop/style/string_methods.rb +1 -1
  548. data/lib/rubocop/cop/style/strip.rb +1 -1
  549. data/lib/rubocop/cop/style/struct_inheritance.rb +4 -4
  550. data/lib/rubocop/cop/style/swap_values.rb +2 -2
  551. data/lib/rubocop/cop/style/symbol_array.rb +12 -7
  552. data/lib/rubocop/cop/style/symbol_literal.rb +1 -1
  553. data/lib/rubocop/cop/style/symbol_proc.rb +46 -14
  554. data/lib/rubocop/cop/style/ternary_parentheses.rb +2 -14
  555. data/lib/rubocop/cop/style/top_level_method_definition.rb +3 -1
  556. data/lib/rubocop/cop/style/trailing_body_on_class.rb +1 -1
  557. data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb +1 -1
  558. data/lib/rubocop/cop/style/trailing_body_on_module.rb +1 -1
  559. data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +5 -5
  560. data/lib/rubocop/cop/style/trailing_comma_in_array_literal.rb +1 -1
  561. data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +2 -2
  562. data/lib/rubocop/cop/style/trailing_comma_in_hash_literal.rb +1 -1
  563. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +1 -1
  564. data/lib/rubocop/cop/style/trailing_underscore_variable.rb +1 -1
  565. data/lib/rubocop/cop/style/trivial_accessors.rb +4 -1
  566. data/lib/rubocop/cop/style/unless_else.rb +1 -1
  567. data/lib/rubocop/cop/style/unless_logical_operators.rb +1 -1
  568. data/lib/rubocop/cop/style/unpack_first.rb +5 -2
  569. data/lib/rubocop/cop/style/variable_interpolation.rb +1 -1
  570. data/lib/rubocop/cop/style/when_then.rb +1 -1
  571. data/lib/rubocop/cop/style/word_array.rb +48 -6
  572. data/lib/rubocop/cop/style/yoda_condition.rb +13 -6
  573. data/lib/rubocop/cop/style/yoda_expression.rb +90 -0
  574. data/lib/rubocop/cop/style/zero_length_predicate.rb +32 -15
  575. data/lib/rubocop/cop/team.rb +54 -50
  576. data/lib/rubocop/cop/util.rb +34 -7
  577. data/lib/rubocop/cop/variable_force/assignment.rb +1 -1
  578. data/lib/rubocop/cop/variable_force/scope.rb +3 -3
  579. data/lib/rubocop/cop/variable_force/variable_table.rb +4 -2
  580. data/lib/rubocop/cop/variable_force.rb +18 -30
  581. data/lib/rubocop/cops_documentation_generator.rb +53 -13
  582. data/lib/rubocop/directive_comment.rb +1 -1
  583. data/lib/rubocop/ext/processed_source.rb +2 -0
  584. data/lib/rubocop/ext/range.rb +15 -0
  585. data/lib/rubocop/feature_loader.rb +94 -0
  586. data/lib/rubocop/file_patterns.rb +43 -0
  587. data/lib/rubocop/formatter/clang_style_formatter.rb +1 -1
  588. data/lib/rubocop/formatter/disabled_config_formatter.rb +36 -16
  589. data/lib/rubocop/formatter/formatter_set.rb +20 -19
  590. data/lib/rubocop/formatter/git_hub_actions_formatter.rb +15 -2
  591. data/lib/rubocop/formatter/html_formatter.rb +4 -5
  592. data/lib/rubocop/formatter/markdown_formatter.rb +3 -1
  593. data/lib/rubocop/formatter/offense_count_formatter.rb +10 -5
  594. data/lib/rubocop/formatter/simple_text_formatter.rb +9 -8
  595. data/lib/rubocop/formatter/tap_formatter.rb +1 -1
  596. data/lib/rubocop/formatter/worst_offenders_formatter.rb +6 -3
  597. data/lib/rubocop/formatter.rb +34 -0
  598. data/lib/rubocop/magic_comment.rb +27 -2
  599. data/lib/rubocop/options.rb +128 -53
  600. data/lib/rubocop/path_util.rb +50 -22
  601. data/lib/rubocop/rake_task.rb +34 -9
  602. data/lib/rubocop/result_cache.rb +26 -23
  603. data/lib/rubocop/rspec/cop_helper.rb +25 -2
  604. data/lib/rubocop/rspec/expect_offense.rb +9 -7
  605. data/lib/rubocop/rspec/shared_contexts.rb +42 -9
  606. data/lib/rubocop/rspec/support.rb +16 -2
  607. data/lib/rubocop/runner.rb +78 -23
  608. data/lib/rubocop/server/cache.rb +155 -0
  609. data/lib/rubocop/server/cli.rb +147 -0
  610. data/lib/rubocop/server/client_command/base.rb +44 -0
  611. data/lib/rubocop/server/client_command/exec.rb +64 -0
  612. data/lib/rubocop/server/client_command/restart.rb +25 -0
  613. data/lib/rubocop/server/client_command/start.rb +48 -0
  614. data/lib/rubocop/server/client_command/status.rb +28 -0
  615. data/lib/rubocop/server/client_command/stop.rb +31 -0
  616. data/lib/rubocop/server/client_command.rb +26 -0
  617. data/lib/rubocop/server/core.rb +111 -0
  618. data/lib/rubocop/server/errors.rb +23 -0
  619. data/lib/rubocop/server/helper.rb +34 -0
  620. data/lib/rubocop/server/server_command/base.rb +50 -0
  621. data/lib/rubocop/server/server_command/exec.rb +34 -0
  622. data/lib/rubocop/server/server_command/stop.rb +24 -0
  623. data/lib/rubocop/server/server_command.rb +21 -0
  624. data/lib/rubocop/server/socket_reader.rb +69 -0
  625. data/lib/rubocop/server.rb +53 -0
  626. data/lib/rubocop/target_finder.rb +1 -1
  627. data/lib/rubocop/target_ruby.rb +8 -7
  628. data/lib/rubocop/version.rb +22 -9
  629. data/lib/rubocop.rb +45 -35
  630. metadata +89 -36
  631. data/lib/rubocop/cop/gemspec/date_assignment.rb +0 -49
  632. data/lib/rubocop/cop/mixin/ignored_methods.rb +0 -52
@@ -3,7 +3,7 @@
3
3
  module RuboCop
4
4
  module Cop
5
5
  module Style
6
- # This cop checks for numeric comparisons that can be replaced
6
+ # Checks for numeric comparisons that can be replaced
7
7
  # by a predicate method, such as receiver.length == 0,
8
8
  # receiver.length > 0, receiver.length != 0,
9
9
  # receiver.length < 1 and receiver.size == 0 that can be
@@ -34,43 +34,55 @@ module RuboCop
34
34
  class ZeroLengthPredicate < Base
35
35
  extend AutoCorrector
36
36
 
37
- ZERO_MSG = 'Use `empty?` instead of `%<lhs>s %<opr>s %<rhs>s`.'
38
- NONZERO_MSG = 'Use `!empty?` instead of `%<lhs>s %<opr>s %<rhs>s`.'
37
+ ZERO_MSG = 'Use `empty?` instead of `%<current>s`.'
38
+ NONZERO_MSG = 'Use `!empty?` instead of `%<current>s`.'
39
39
 
40
40
  RESTRICT_ON_SEND = %i[size length].freeze
41
41
 
42
42
  def on_send(node)
43
43
  check_zero_length_predicate(node)
44
- check_nonzero_length_predicate(node)
44
+ check_zero_length_comparison(node)
45
+ check_nonzero_length_comparison(node)
45
46
  end
46
47
 
47
48
  private
48
49
 
49
50
  def check_zero_length_predicate(node)
50
- zero_length_predicate = zero_length_predicate(node.parent)
51
- return unless zero_length_predicate
51
+ return unless (length_method = zero_length_predicate(node.parent))
52
52
 
53
- lhs, opr, rhs = zero_length_predicate
53
+ offense = node.loc.selector.join(node.parent.source_range.end)
54
+ message = format(ZERO_MSG, current: "#{length_method}.zero?")
55
+
56
+ add_offense(offense, message: message) do |corrector|
57
+ corrector.replace(offense, 'empty?')
58
+ end
59
+ end
60
+
61
+ def check_zero_length_comparison(node)
62
+ zero_length_comparison = zero_length_comparison(node.parent)
63
+ return unless zero_length_comparison
64
+
65
+ lhs, opr, rhs = zero_length_comparison
54
66
 
55
67
  return if non_polymorphic_collection?(node.parent)
56
68
 
57
69
  add_offense(
58
- node.parent, message: format(ZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
70
+ node.parent, message: format(ZERO_MSG, current: "#{lhs} #{opr} #{rhs}")
59
71
  ) do |corrector|
60
72
  corrector.replace(node.parent, replacement(node.parent))
61
73
  end
62
74
  end
63
75
 
64
- def check_nonzero_length_predicate(node)
65
- nonzero_length_predicate = nonzero_length_predicate(node.parent)
66
- return unless nonzero_length_predicate
76
+ def check_nonzero_length_comparison(node)
77
+ nonzero_length_comparison = nonzero_length_comparison(node.parent)
78
+ return unless nonzero_length_comparison
67
79
 
68
- lhs, opr, rhs = nonzero_length_predicate
80
+ lhs, opr, rhs = nonzero_length_comparison
69
81
 
70
82
  return if non_polymorphic_collection?(node.parent)
71
83
 
72
84
  add_offense(
73
- node.parent, message: format(NONZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
85
+ node.parent, message: format(NONZERO_MSG, current: "#{lhs} #{opr} #{rhs}")
74
86
  ) do |corrector|
75
87
  corrector.replace(node.parent, replacement(node.parent))
76
88
  end
@@ -78,14 +90,19 @@ module RuboCop
78
90
 
79
91
  # @!method zero_length_predicate(node)
80
92
  def_node_matcher :zero_length_predicate, <<~PATTERN
93
+ (send (send (...) ${:length :size}) :zero?)
94
+ PATTERN
95
+
96
+ # @!method zero_length_comparison(node)
97
+ def_node_matcher :zero_length_comparison, <<~PATTERN
81
98
  {(send (send (...) ${:length :size}) $:== (int $0))
82
99
  (send (int $0) $:== (send (...) ${:length :size}))
83
100
  (send (send (...) ${:length :size}) $:< (int $1))
84
101
  (send (int $1) $:> (send (...) ${:length :size}))}
85
102
  PATTERN
86
103
 
87
- # @!method nonzero_length_predicate(node)
88
- def_node_matcher :nonzero_length_predicate, <<~PATTERN
104
+ # @!method nonzero_length_comparison(node)
105
+ def_node_matcher :nonzero_length_comparison, <<~PATTERN
89
106
  {(send (send (...) ${:length :size}) ${:> :!=} (int $0))
90
107
  (send (int $0) ${:< :!=} (send (...) ${:length :size}))}
91
108
  PATTERN
@@ -10,20 +10,6 @@ module RuboCop
10
10
  # first the ones needed for autocorrection (if any), then the rest
11
11
  # (unless autocorrections happened).
12
12
  class Team
13
- attr_reader :errors, :warnings, :updated_source_file, :cops
14
-
15
- alias updated_source_file? updated_source_file
16
-
17
- def initialize(cops, config = nil, options = {})
18
- @cops = cops
19
- @config = config
20
- @options = options
21
- reset
22
- @ready = true
23
-
24
- validate_config
25
- end
26
-
27
13
  # @return [Team]
28
14
  def self.new(cop_or_classes, config, options = {})
29
15
  # Support v0 api:
@@ -38,18 +24,46 @@ module RuboCop
38
24
  new(cops, config, options)
39
25
  end
40
26
 
41
- # @return [Array<Cop::Cop>]
27
+ # @return [Array<Cop::Base>]
42
28
  def self.mobilize_cops(cop_classes, config, options = {})
43
- cop_classes = Registry.new(cop_classes.to_a) unless cop_classes.is_a?(Registry)
44
- only = options.fetch(:only, [])
45
- safe = options.fetch(:safe, false)
46
- cop_classes.enabled(config, only, only_safe: safe).map do |cop_class|
29
+ cop_classes = Registry.new(cop_classes.to_a, options) unless cop_classes.is_a?(Registry)
30
+
31
+ cop_classes.enabled(config).map do |cop_class|
47
32
  cop_class.new(config, options)
48
33
  end
49
34
  end
50
35
 
36
+ # @return [Array<Force>] needed for the given cops
37
+ def self.forces_for(cops)
38
+ needed = Hash.new { |h, k| h[k] = [] }
39
+ cops.each do |cop|
40
+ forces = cop.class.joining_forces
41
+ if forces.is_a?(Array)
42
+ forces.each { |force| needed[force] << cop }
43
+ elsif forces
44
+ needed[forces] << cop
45
+ end
46
+ end
47
+
48
+ needed.map { |force_class, joining_cops| force_class.new(joining_cops) }
49
+ end
50
+
51
+ attr_reader :errors, :warnings, :updated_source_file, :cops
52
+
53
+ alias updated_source_file? updated_source_file
54
+
55
+ def initialize(cops, config = nil, options = {})
56
+ @cops = cops
57
+ @config = config
58
+ @options = options
59
+ reset
60
+ @ready = true
61
+
62
+ validate_config
63
+ end
64
+
51
65
  def autocorrect?
52
- @options[:auto_correct]
66
+ @options[:autocorrect]
53
67
  end
54
68
 
55
69
  def debug?
@@ -63,24 +77,25 @@ module RuboCop
63
77
  end
64
78
 
65
79
  # @return [Commissioner::InvestigationReport]
66
- def investigate(processed_source)
80
+ def investigate(processed_source, offset: 0, original: processed_source)
67
81
  be_ready
68
82
 
69
83
  # The autocorrection process may have to be repeated multiple times
70
84
  # until there are no corrections left to perform
71
- # To speed things up, run auto-correcting cops by themselves, and only
85
+ # To speed things up, run autocorrecting cops by themselves, and only
72
86
  # run the other cops when no corrections are left
73
87
  on_duty = roundup_relevant_cops(processed_source.file_path)
74
88
 
75
89
  autocorrect_cops, other_cops = on_duty.partition(&:autocorrect?)
90
+ report = investigate_partial(autocorrect_cops, processed_source,
91
+ offset: offset, original: original)
76
92
 
77
- report = investigate_partial(autocorrect_cops, processed_source)
78
-
79
- unless autocorrect(processed_source, report)
93
+ unless autocorrect(processed_source, report, offset: offset, original: original)
80
94
  # If we corrected some errors, another round of inspection will be
81
95
  # done, and any other offenses will be caught then, so only need
82
96
  # to check other_cops if no correction was done
83
- report = report.merge(investigate_partial(other_cops, processed_source))
97
+ report = report.merge(investigate_partial(other_cops, processed_source,
98
+ offset: offset, original: original))
84
99
  end
85
100
 
86
101
  process_errors(processed_source.path, report.errors)
@@ -95,21 +110,6 @@ module RuboCop
95
110
  @forces ||= self.class.forces_for(cops)
96
111
  end
97
112
 
98
- # @return [Array<Force>] needed for the given cops
99
- def self.forces_for(cops)
100
- needed = Hash.new { |h, k| h[k] = [] }
101
- cops.each do |cop|
102
- forces = cop.class.joining_forces
103
- if forces.is_a?(Array)
104
- forces.each { |force| needed[force] << cop }
105
- elsif forces
106
- needed[forces] << cop
107
- end
108
- end
109
-
110
- needed.map { |force_class, joining_cops| force_class.new(joining_cops) }
111
- end
112
-
113
113
  def external_dependency_checksum
114
114
  keys = cops.map(&:external_dependency_checksum).compact
115
115
  Digest::SHA1.hexdigest(keys.join)
@@ -117,12 +117,12 @@ module RuboCop
117
117
 
118
118
  private
119
119
 
120
- def autocorrect(processed_source, report)
120
+ def autocorrect(processed_source, report, original:, offset:)
121
121
  @updated_source_file = false
122
122
  return unless autocorrect?
123
123
  return if report.processed_source.parser_error
124
124
 
125
- new_source = autocorrect_report(report)
125
+ new_source = autocorrect_report(report, original: original, offset: offset)
126
126
 
127
127
  return unless new_source
128
128
 
@@ -150,9 +150,9 @@ module RuboCop
150
150
  end
151
151
 
152
152
  # @return [Commissioner::InvestigationReport]
153
- def investigate_partial(cops, processed_source)
153
+ def investigate_partial(cops, processed_source, offset:, original:)
154
154
  commissioner = Commissioner.new(cops, self.class.forces_for(cops), @options)
155
- commissioner.investigate(processed_source)
155
+ commissioner.investigate(processed_source, offset: offset, original: original)
156
156
  end
157
157
 
158
158
  # @return [Array<cop>]
@@ -176,18 +176,22 @@ module RuboCop
176
176
  cop.class.support_target_rails_version?(cop.target_rails_version)
177
177
  end
178
178
 
179
- def autocorrect_report(report)
180
- corrector = collate_corrections(report)
179
+ def autocorrect_report(report, offset:, original:)
180
+ corrector = collate_corrections(report, offset: offset, original: original)
181
181
 
182
182
  corrector.rewrite unless corrector.empty?
183
183
  end
184
184
 
185
- def collate_corrections(report)
186
- corrector = Corrector.new(report.processed_source)
185
+ def collate_corrections(report, offset:, original:)
186
+ corrector = Corrector.new(original)
187
187
 
188
188
  each_corrector(report) do |to_merge|
189
189
  suppress_clobbering do
190
- corrector.merge!(to_merge)
190
+ if offset.positive?
191
+ corrector.import!(to_merge, offset: offset)
192
+ else
193
+ corrector.merge!(to_merge)
194
+ end
191
195
  end
192
196
  end
193
197
 
@@ -34,7 +34,7 @@ module RuboCop
34
34
  def add_parentheses(node, corrector)
35
35
  if node.args_type?
36
36
  arguments_range = node.source_range
37
- args_with_space = range_with_surrounding_space(range: arguments_range, side: :left)
37
+ args_with_space = range_with_surrounding_space(arguments_range, side: :left)
38
38
  leading_space = range_between(args_with_space.begin_pos, arguments_range.begin_pos)
39
39
  corrector.replace(leading_space, '(')
40
40
  corrector.insert_after(arguments_range, ')')
@@ -52,6 +52,21 @@ module RuboCop
52
52
  end
53
53
  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
54
54
 
55
+ def any_descendant?(node, *types)
56
+ if block_given?
57
+ node.each_descendant(*types) do |descendant|
58
+ return true if yield(descendant)
59
+ end
60
+ else
61
+ # Use a block version to avoid allocating enumerators.
62
+ node.each_descendant do # rubocop:disable Lint/UnreachableLoop
63
+ return true
64
+ end
65
+ end
66
+
67
+ false
68
+ end
69
+
55
70
  def args_begin(node)
56
71
  loc = node.loc
57
72
  selector = if node.super_type? || node.yield_type?
@@ -71,14 +86,19 @@ module RuboCop
71
86
  def on_node(syms, sexp, excludes = [], &block)
72
87
  return to_enum(:on_node, syms, sexp, excludes) unless block
73
88
 
74
- yield sexp if Array(syms).include?(sexp.type)
75
- return if Array(excludes).include?(sexp.type)
89
+ yield sexp if include_or_equal?(syms, sexp.type)
90
+ return if include_or_equal?(excludes, sexp.type)
76
91
 
77
92
  sexp.each_child_node { |elem| on_node(syms, elem, excludes, &block) }
78
93
  end
79
94
 
95
+ LINE_BEGINS_REGEX_CACHE = Hash.new do |hash, index|
96
+ hash[index] = /^\s{#{index}}\S/
97
+ end
98
+ private_constant :LINE_BEGINS_REGEX_CACHE
99
+
80
100
  def begins_its_line?(range)
81
- range.source_line.index(/\S/) == range.column
101
+ range.source_line.match?(LINE_BEGINS_REGEX_CACHE[range.column])
82
102
  end
83
103
 
84
104
  # Returns, for example, a bare `if` node if the given node is an `if`
@@ -122,11 +142,11 @@ module RuboCop
122
142
  string.inspect
123
143
  else
124
144
  # In a single-quoted strings, double quotes don't need to be escaped
125
- "'#{string.gsub('\"', '"').gsub('\\') { '\\\\' }}'"
145
+ "'#{string.gsub('\\') { '\\\\' }.gsub('\"', '"')}'"
126
146
  end
127
147
  end
128
148
 
129
- def trim_string_interporation_escape_character(str)
149
+ def trim_string_interpolation_escape_character(str)
130
150
  str.gsub(/\\\#\{(.*?)\}/) { "\#{#{Regexp.last_match(1)}}" }
131
151
  end
132
152
 
@@ -152,8 +172,11 @@ module RuboCop
152
172
  ' ' * (node.loc.column + offset)
153
173
  end
154
174
 
175
+ @to_supported_styles_cache = {}
176
+
155
177
  def to_supported_styles(enforced_style)
156
- enforced_style.sub(/^Enforced/, 'Supported').sub('Style', 'Styles')
178
+ @to_supported_styles_cache[enforced_style] ||=
179
+ enforced_style.sub(/^Enforced/, 'Supported').sub('Style', 'Styles')
157
180
  end
158
181
 
159
182
  private
@@ -162,6 +185,10 @@ module RuboCop
162
185
  src = src.dup if RUBY_ENGINE == 'jruby'
163
186
  src.force_encoding(Encoding.default_external).valid_encoding?
164
187
  end
188
+
189
+ def include_or_equal?(source, target)
190
+ source == target || (source.is_a?(Array) && source.include?(target))
191
+ end
165
192
  end
166
193
  end
167
194
  end
@@ -83,7 +83,7 @@ module RuboCop
83
83
  end
84
84
 
85
85
  def multiple_assignment_node
86
- grandparent_node = node.parent ? node.parent.parent : nil
86
+ grandparent_node = node.parent&.parent
87
87
  return nil unless grandparent_node
88
88
  return nil unless grandparent_node.type == MULTIPLE_ASSIGNMENT_TYPE
89
89
  return nil unless node.parent.type == MULTIPLE_LEFT_HAND_SIDE_TYPE
@@ -45,9 +45,9 @@ module RuboCop
45
45
  node
46
46
  else
47
47
  child_index = case node.type
48
- when :module, :sclass then 1
49
- when :def, :class, :block then 2
50
- when :defs then 3
48
+ when :module, :sclass then 1
49
+ when :def, :class, :block, :numblock then 2
50
+ when :defs then 3
51
51
  end
52
52
 
53
53
  node.children[child_index]
@@ -97,8 +97,10 @@ module RuboCop
97
97
  scope_stack.reverse_each do |scope|
98
98
  variable = scope.variables[name]
99
99
  return variable if variable
100
+
100
101
  # Only block scope allows referencing outer scope variables.
101
- return nil unless scope.node.block_type?
102
+ node = scope.node
103
+ return nil unless node.block_type? || node.numblock_type?
102
104
  end
103
105
 
104
106
  nil
@@ -109,7 +111,7 @@ module RuboCop
109
111
  end
110
112
 
111
113
  def accessible_variables
112
- scope_stack.reverse_each.each_with_object([]) do |scope, variables|
114
+ scope_stack.reverse_each.with_object([]) do |scope, variables|
113
115
  variables.concat(scope.variables.values)
114
116
  break variables unless scope.node.block_type?
115
117
  end
@@ -50,7 +50,7 @@ module RuboCop
50
50
 
51
51
  ZERO_ARITY_SUPER_TYPE = :zsuper
52
52
 
53
- TWISTED_SCOPE_TYPES = %i[block class sclass defs module].freeze
53
+ TWISTED_SCOPE_TYPES = %i[block numblock class sclass defs module].freeze
54
54
  SCOPE_TYPES = (TWISTED_SCOPE_TYPES + [:def]).freeze
55
55
 
56
56
  SEND_TYPE = :send
@@ -108,34 +108,23 @@ module RuboCop
108
108
  :skip_children
109
109
  end
110
110
 
111
- # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
111
+ NODE_HANDLER_METHOD_NAMES = [
112
+ [VARIABLE_ASSIGNMENT_TYPE, :process_variable_assignment],
113
+ [REGEXP_NAMED_CAPTURE_TYPE, :process_regexp_named_captures],
114
+ [MULTIPLE_ASSIGNMENT_TYPE, :process_variable_multiple_assignment],
115
+ [VARIABLE_REFERENCE_TYPE, :process_variable_referencing],
116
+ [RESCUE_TYPE, :process_rescue],
117
+ [ZERO_ARITY_SUPER_TYPE, :process_zero_arity_super],
118
+ [SEND_TYPE, :process_send],
119
+ *ARGUMENT_DECLARATION_TYPES.product([:process_variable_declaration]),
120
+ *OPERATOR_ASSIGNMENT_TYPES.product([:process_variable_operator_assignment]),
121
+ *LOOP_TYPES.product([:process_loop]),
122
+ *SCOPE_TYPES.product([:process_scope])
123
+ ].to_h.freeze
124
+ private_constant :NODE_HANDLER_METHOD_NAMES
112
125
  def node_handler_method_name(node)
113
- case node.type
114
- when VARIABLE_ASSIGNMENT_TYPE
115
- :process_variable_assignment
116
- when REGEXP_NAMED_CAPTURE_TYPE
117
- :process_regexp_named_captures
118
- when MULTIPLE_ASSIGNMENT_TYPE
119
- :process_variable_multiple_assignment
120
- when VARIABLE_REFERENCE_TYPE
121
- :process_variable_referencing
122
- when RESCUE_TYPE
123
- :process_rescue
124
- when ZERO_ARITY_SUPER_TYPE
125
- :process_zero_arity_super
126
- when SEND_TYPE
127
- :process_send
128
- when *ARGUMENT_DECLARATION_TYPES
129
- :process_variable_declaration
130
- when *OPERATOR_ASSIGNMENT_TYPES
131
- :process_variable_operator_assignment
132
- when *LOOP_TYPES
133
- :process_loop
134
- when *SCOPE_TYPES
135
- :process_scope
136
- end
126
+ NODE_HANDLER_METHOD_NAMES[node.type]
137
127
  end
138
- # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
139
128
 
140
129
  def process_variable_declaration(node)
141
130
  variable_name = node.children.first
@@ -358,13 +347,12 @@ module RuboCop
358
347
  end
359
348
  end
360
349
 
361
- # Use Node#equal? for accurate check.
362
350
  def scanned_node?(node)
363
- scanned_nodes.any? { |scanned_node| scanned_node.equal?(node) }
351
+ scanned_nodes.include?(node)
364
352
  end
365
353
 
366
354
  def scanned_nodes
367
- @scanned_nodes ||= []
355
+ @scanned_nodes ||= Set.new.compare_by_identity
368
356
  end
369
357
 
370
358
  # Hooks invoked by VariableTable.
@@ -33,18 +33,35 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
33
33
  cops.with_department(department).sort!
34
34
  end
35
35
 
36
- def cops_body(cop, description, examples_objects, safety_objects, pars) # rubocop:disable Metrics/AbcSize
36
+ def cops_body(cop, description, examples_objects, safety_objects, see_objects, pars) # rubocop:disable Metrics/AbcSize, Metrics/ParameterLists
37
+ check_examples_to_have_the_default_enforced_style!(examples_objects, cop)
38
+
37
39
  content = h2(cop.cop_name)
38
40
  content << required_ruby_version(cop)
39
41
  content << properties(cop)
40
42
  content << "#{description}\n"
41
43
  content << safety_object(safety_objects) if safety_objects.any? { |s| !s.text.blank? }
42
- content << examples(examples_objects) if examples_objects.count.positive?
43
- content << configurations(pars)
44
- content << references(cop)
44
+ content << examples(examples_objects) if examples_objects.any?
45
+ content << configurations(cop.department, pars)
46
+ content << references(cop, see_objects)
45
47
  content
46
48
  end
47
49
 
50
+ def check_examples_to_have_the_default_enforced_style!(examples_object, cop)
51
+ return if examples_object.none?
52
+
53
+ examples_describing_enforced_style = examples_object.map(&:name).grep(/EnforcedStyle:/)
54
+ return if examples_describing_enforced_style.none?
55
+
56
+ if examples_describing_enforced_style.index { |name| name.match?('default') }.nonzero?
57
+ raise "Put the example with the default EnforcedStyle on top for #{cop.cop_name}"
58
+ end
59
+
60
+ return if examples_describing_enforced_style.any? { |name| name.match?('default') }
61
+
62
+ raise "Specify the default EnforcedStyle for #{cop.cop_name}"
63
+ end
64
+
48
65
  def examples(examples_object)
49
66
  examples_object.each_with_object(h3('Examples').dup) do |example, content|
50
67
  content << "\n" unless content.end_with?("\n\n")
@@ -119,7 +136,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
119
136
  content
120
137
  end
121
138
 
122
- def configurations(pars)
139
+ def configurations(department, pars)
123
140
  return '' if pars.empty?
124
141
 
125
142
  header = ['Name', 'Default value', 'Configurable values']
@@ -130,12 +147,20 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
130
147
  content = configs.map do |name|
131
148
  configurable = configurable_values(pars, name)
132
149
  default = format_table_value(pars[name])
133
- [name, default, configurable]
150
+
151
+ [configuration_name(department, name), default, configurable]
134
152
  end
135
153
 
136
154
  h3('Configurable attributes') + to_table(header, content)
137
155
  end
138
156
 
157
+ def configuration_name(department, name)
158
+ return name unless name == 'AllowMultilineFinalElement'
159
+
160
+ filename = "#{department_to_basename(department)}.adoc"
161
+ "xref:#{filename}#allowmultilinefinalelement[AllowMultilineFinalElement]"
162
+ end
163
+
139
164
  # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
140
165
  def configurable_values(pars, name)
141
166
  case name
@@ -168,7 +193,8 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
168
193
  def to_table(header, content)
169
194
  table = ['|===', "| #{header.join(' | ')}\n\n"].join("\n")
170
195
  marked_contents = content.map do |plain_content|
171
- plain_content.map { |c| "| #{c}" }.join("\n")
196
+ # Escape `|` with backslash to prevent the regexp `|` is not used as a table separator.
197
+ plain_content.map { |c| "| #{c.gsub(/\|/, '\|')}" }.join("\n")
172
198
  end
173
199
  table << marked_contents.join("\n\n")
174
200
  table << "\n|===\n"
@@ -198,21 +224,34 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
198
224
  end
199
225
  end
200
226
 
201
- def references(cop)
227
+ def references(cop, see_objects) # rubocop:disable Metrics/AbcSize
202
228
  cop_config = config.for_cop(cop)
203
229
  urls = RuboCop::Cop::MessageAnnotator.new(config, cop.name, cop_config, {}).urls
204
- return '' if urls.empty?
230
+ return '' if urls.empty? && see_objects.empty?
205
231
 
206
232
  content = h3('References')
207
233
  content << urls.map { |url| "* #{url}" }.join("\n")
208
- content << "\n"
234
+ content << "\n" unless urls.empty?
235
+ content << see_objects.map { |see| "* #{see.name}" }.join("\n")
236
+ content << "\n" unless see_objects.empty?
209
237
  content
210
238
  end
211
239
 
240
+ def footer_for_department(department)
241
+ return '' unless department == :Layout
242
+
243
+ filename = "#{department_to_basename(department)}_footer.adoc"
244
+ file = "#{Dir.pwd}/docs/modules/ROOT/partials/#{filename}"
245
+ return '' unless File.exist?(file)
246
+
247
+ "\ninclude::../partials/#{filename}[]\n"
248
+ end
249
+
212
250
  def print_cops_of_department(department)
213
251
  selected_cops = cops_of_department(department)
214
252
  content = +"= #{department}\n"
215
253
  selected_cops.each { |cop| content << print_cop_with_doc(cop) }
254
+ content << footer_for_department(department)
216
255
  file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/#{department_to_basename(department)}.adoc"
217
256
  File.open(file_name, 'w') do |file|
218
257
  puts "* generated #{file_name}"
@@ -220,7 +259,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
220
259
  end
221
260
  end
222
261
 
223
- def print_cop_with_doc(cop)
262
+ def print_cop_with_doc(cop) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
224
263
  cop_config = config.for_cop(cop)
225
264
  non_display_keys = %w[
226
265
  Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
@@ -228,13 +267,14 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
228
267
  ]
229
268
  pars = cop_config.reject { |k| non_display_keys.include? k }
230
269
  description = 'No documentation'
231
- examples_object = safety_object = []
270
+ examples_object = safety_object = see_object = []
232
271
  cop_code(cop) do |code_object|
233
272
  description = code_object.docstring unless code_object.docstring.blank?
234
273
  examples_object = code_object.tags('example')
235
274
  safety_object = code_object.tags('safety')
275
+ see_object = code_object.tags('see')
236
276
  end
237
- cops_body(cop, description, examples_object, safety_object, pars)
277
+ cops_body(cop, description, examples_object, safety_object, see_object, pars)
238
278
  end
239
279
 
240
280
  def cop_code(cop)
@@ -35,7 +35,7 @@ module RuboCop
35
35
 
36
36
  # Checks if this directive relates to single line
37
37
  def single_line?
38
- !self.class.before_comment(comment.text).empty?
38
+ !comment.text.start_with?(DIRECTIVE_COMMENT_REGEXP)
39
39
  end
40
40
 
41
41
  # Checks if this directive contains all the given cop names
@@ -4,6 +4,8 @@ module RuboCop
4
4
  module Ext
5
5
  # Extensions to AST::ProcessedSource for our cached comment_config
6
6
  module ProcessedSource
7
+ attr_accessor :registry, :config
8
+
7
9
  def comment_config
8
10
  @comment_config ||= CommentConfig.new(self)
9
11
  end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Ext
5
+ # Extensions to Parser::Source::Range
6
+ module Range
7
+ # Adds `Range#single_line?` to parallel `Node#single_line?`
8
+ def single_line?
9
+ first_line == last_line
10
+ end
11
+ end
12
+ end
13
+ end
14
+
15
+ Parser::Source::Range.include RuboCop::Ext::Range