rubocop 1.10.0 → 1.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (487) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -14
  3. data/assets/output.html.erb +1 -1
  4. data/config/default.yml +60 -3
  5. data/exe/rubocop +1 -3
  6. data/lib/rubocop.rb +6 -1
  7. data/lib/rubocop/cached_data.rb +1 -3
  8. data/lib/rubocop/cli.rb +4 -6
  9. data/lib/rubocop/cli/command/auto_genenerate_config.rb +9 -19
  10. data/lib/rubocop/cli/command/execute_runner.rb +1 -1
  11. data/lib/rubocop/cli/command/init_dotfile.rb +1 -3
  12. data/lib/rubocop/cli/command/show_cops.rb +1 -4
  13. data/lib/rubocop/cli/command/suggest_extensions.rb +3 -2
  14. data/lib/rubocop/comment_config.rb +45 -101
  15. data/lib/rubocop/config.rb +11 -26
  16. data/lib/rubocop/config_loader.rb +5 -11
  17. data/lib/rubocop/config_loader_resolver.rb +22 -14
  18. data/lib/rubocop/config_obsoletion/cop_rule.rb +1 -2
  19. data/lib/rubocop/config_store.rb +1 -2
  20. data/lib/rubocop/config_validator.rb +5 -10
  21. data/lib/rubocop/cop/autocorrect_logic.rb +3 -8
  22. data/lib/rubocop/cop/badge.rb +1 -2
  23. data/lib/rubocop/cop/base.rb +8 -6
  24. data/lib/rubocop/cop/bundler/duplicated_gem.rb +3 -3
  25. data/lib/rubocop/cop/bundler/gem_comment.rb +43 -10
  26. data/lib/rubocop/cop/bundler/gem_version.rb +99 -0
  27. data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +1 -0
  28. data/lib/rubocop/cop/bundler/ordered_gems.rb +2 -4
  29. data/lib/rubocop/cop/commissioner.rb +2 -8
  30. data/lib/rubocop/cop/cop.rb +4 -18
  31. data/lib/rubocop/cop/corrector.rb +1 -4
  32. data/lib/rubocop/cop/correctors/alignment_corrector.rb +6 -12
  33. data/lib/rubocop/cop/correctors/each_to_for_corrector.rb +2 -4
  34. data/lib/rubocop/cop/correctors/for_to_each_corrector.rb +1 -2
  35. data/lib/rubocop/cop/correctors/line_break_corrector.rb +3 -6
  36. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +1 -3
  37. data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb +1 -3
  38. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +2 -8
  39. data/lib/rubocop/cop/gemspec/date_assignment.rb +1 -0
  40. data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +3 -2
  41. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +2 -4
  42. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +2 -0
  43. data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +2 -0
  44. data/lib/rubocop/cop/generator.rb +3 -6
  45. data/lib/rubocop/cop/generator/configuration_injector.rb +1 -2
  46. data/lib/rubocop/cop/generator/require_file_injector.rb +2 -5
  47. data/lib/rubocop/cop/internal_affairs.rb +1 -0
  48. data/lib/rubocop/cop/internal_affairs/example_description.rb +7 -4
  49. data/lib/rubocop/cop/internal_affairs/method_name_equal.rb +3 -5
  50. data/lib/rubocop/cop/internal_affairs/node_destructuring.rb +3 -3
  51. data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +151 -0
  52. data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +2 -3
  53. data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb +3 -2
  54. data/lib/rubocop/cop/internal_affairs/redundant_described_class_as_subject.rb +1 -0
  55. data/lib/rubocop/cop/internal_affairs/redundant_let_rubocop_config_new.rb +1 -0
  56. data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +1 -0
  57. data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +3 -0
  58. data/lib/rubocop/cop/internal_affairs/style_detected_api_use.rb +5 -2
  59. data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +3 -3
  60. data/lib/rubocop/cop/layout/access_modifier_indentation.rb +12 -10
  61. data/lib/rubocop/cop/layout/argument_alignment.rb +8 -9
  62. data/lib/rubocop/cop/layout/array_alignment.rb +7 -6
  63. data/lib/rubocop/cop/layout/assignment_indentation.rb +8 -7
  64. data/lib/rubocop/cop/layout/begin_end_alignment.rb +1 -4
  65. data/lib/rubocop/cop/layout/block_alignment.rb +8 -19
  66. data/lib/rubocop/cop/layout/block_end_newline.rb +4 -8
  67. data/lib/rubocop/cop/layout/case_indentation.rb +1 -3
  68. data/lib/rubocop/cop/layout/class_structure.rb +5 -10
  69. data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +18 -30
  70. data/lib/rubocop/cop/layout/comment_indentation.rb +17 -21
  71. data/lib/rubocop/cop/layout/def_end_alignment.rb +2 -6
  72. data/lib/rubocop/cop/layout/dot_position.rb +1 -3
  73. data/lib/rubocop/cop/layout/else_alignment.rb +10 -9
  74. data/lib/rubocop/cop/layout/empty_comment.rb +5 -12
  75. data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +22 -8
  76. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +2 -6
  77. data/lib/rubocop/cop/layout/empty_lines.rb +1 -3
  78. data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +8 -18
  79. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +2 -8
  80. data/lib/rubocop/cop/layout/end_alignment.rb +1 -2
  81. data/lib/rubocop/cop/layout/end_of_line.rb +1 -1
  82. data/lib/rubocop/cop/layout/extra_spacing.rb +5 -9
  83. data/lib/rubocop/cop/layout/first_argument_indentation.rb +11 -5
  84. data/lib/rubocop/cop/layout/first_array_element_indentation.rb +10 -8
  85. data/lib/rubocop/cop/layout/first_array_element_line_break.rb +1 -2
  86. data/lib/rubocop/cop/layout/first_hash_element_indentation.rb +24 -20
  87. data/lib/rubocop/cop/layout/first_hash_element_line_break.rb +1 -2
  88. data/lib/rubocop/cop/layout/first_method_argument_line_break.rb +1 -2
  89. data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb +1 -2
  90. data/lib/rubocop/cop/layout/first_parameter_indentation.rb +6 -5
  91. data/lib/rubocop/cop/layout/hash_alignment.rb +3 -6
  92. data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +2 -9
  93. data/lib/rubocop/cop/layout/heredoc_indentation.rb +2 -6
  94. data/lib/rubocop/cop/layout/indentation_consistency.rb +9 -6
  95. data/lib/rubocop/cop/layout/indentation_style.rb +25 -30
  96. data/lib/rubocop/cop/layout/indentation_width.rb +21 -11
  97. data/lib/rubocop/cop/layout/initial_indentation.rb +1 -4
  98. data/lib/rubocop/cop/layout/line_length.rb +4 -15
  99. data/lib/rubocop/cop/layout/multiline_array_line_breaks.rb +1 -2
  100. data/lib/rubocop/cop/layout/multiline_block_layout.rb +7 -15
  101. data/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb +1 -2
  102. data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +1 -2
  103. data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +22 -15
  104. data/lib/rubocop/cop/layout/multiline_operation_indentation.rb +10 -5
  105. data/lib/rubocop/cop/layout/parameter_alignment.rb +6 -5
  106. data/lib/rubocop/cop/layout/redundant_line_break.rb +137 -0
  107. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +3 -6
  108. data/lib/rubocop/cop/layout/single_line_block_chain.rb +53 -0
  109. data/lib/rubocop/cop/layout/space_after_colon.rb +1 -3
  110. data/lib/rubocop/cop/layout/space_after_method_name.rb +2 -4
  111. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +6 -14
  112. data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb +1 -2
  113. data/lib/rubocop/cop/layout/space_around_keyword.rb +3 -6
  114. data/lib/rubocop/cop/layout/space_around_operators.rb +4 -9
  115. data/lib/rubocop/cop/layout/space_before_block_braces.rb +2 -3
  116. data/lib/rubocop/cop/layout/space_before_brackets.rb +1 -3
  117. data/lib/rubocop/cop/layout/space_before_comment.rb +1 -3
  118. data/lib/rubocop/cop/layout/space_before_first_arg.rb +5 -11
  119. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +2 -4
  120. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +5 -10
  121. data/lib/rubocop/cop/layout/space_inside_array_percent_literal.rb +2 -7
  122. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +6 -11
  123. data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +1 -2
  124. data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +1 -2
  125. data/lib/rubocop/cop/legacy/corrections_proxy.rb +2 -8
  126. data/lib/rubocop/cop/legacy/corrector.rb +1 -3
  127. data/lib/rubocop/cop/lint/ambiguous_assignment.rb +1 -6
  128. data/lib/rubocop/cop/lint/ambiguous_block_association.rb +14 -7
  129. data/lib/rubocop/cop/lint/big_decimal_new.rb +1 -0
  130. data/lib/rubocop/cop/lint/boolean_symbol.rb +2 -2
  131. data/lib/rubocop/cop/lint/constant_definition_in_block.rb +2 -0
  132. data/lib/rubocop/cop/lint/constant_resolution.rb +2 -2
  133. data/lib/rubocop/cop/lint/debugger.rb +3 -1
  134. data/lib/rubocop/cop/lint/deprecated_class_methods.rb +79 -41
  135. data/lib/rubocop/cop/lint/deprecated_constants.rb +3 -3
  136. data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +3 -5
  137. data/lib/rubocop/cop/lint/duplicate_branch.rb +2 -3
  138. data/lib/rubocop/cop/lint/duplicate_hash_key.rb +1 -3
  139. data/lib/rubocop/cop/lint/duplicate_methods.rb +6 -7
  140. data/lib/rubocop/cop/lint/duplicate_require.rb +1 -0
  141. data/lib/rubocop/cop/lint/each_with_object_argument.rb +1 -0
  142. data/lib/rubocop/cop/lint/else_layout.rb +1 -3
  143. data/lib/rubocop/cop/lint/empty_ensure.rb +1 -3
  144. data/lib/rubocop/cop/lint/empty_file.rb +1 -3
  145. data/lib/rubocop/cop/lint/empty_interpolation.rb +1 -3
  146. data/lib/rubocop/cop/lint/ensure_return.rb +1 -3
  147. data/lib/rubocop/cop/lint/erb_new_arguments.rb +4 -7
  148. data/lib/rubocop/cop/lint/float_out_of_range.rb +1 -2
  149. data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +4 -6
  150. data/lib/rubocop/cop/lint/hash_compare_by_identity.rb +1 -0
  151. data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +1 -2
  152. data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +1 -2
  153. data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +4 -7
  154. data/lib/rubocop/cop/lint/inherit_exception.rb +2 -2
  155. data/lib/rubocop/cop/lint/interpolation_check.rb +3 -11
  156. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +3 -6
  157. data/lib/rubocop/cop/lint/loop.rb +1 -2
  158. data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +3 -7
  159. data/lib/rubocop/cop/lint/missing_super.rb +1 -2
  160. data/lib/rubocop/cop/lint/mixed_regexp_capture_types.rb +1 -2
  161. data/lib/rubocop/cop/lint/multiple_comparison.rb +1 -0
  162. data/lib/rubocop/cop/lint/nested_method_definition.rb +4 -2
  163. data/lib/rubocop/cop/lint/nested_percent_literal.rb +1 -3
  164. data/lib/rubocop/cop/lint/next_without_accumulator.rb +1 -0
  165. data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +8 -3
  166. data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +3 -0
  167. data/lib/rubocop/cop/lint/number_conversion.rb +13 -5
  168. data/lib/rubocop/cop/lint/ordered_magic_comments.rb +1 -2
  169. data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +1 -3
  170. data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +1 -3
  171. data/lib/rubocop/cop/lint/percent_symbol_array.rb +1 -3
  172. data/lib/rubocop/cop/lint/raise_exception.rb +3 -2
  173. data/lib/rubocop/cop/lint/rand_one.rb +2 -2
  174. data/lib/rubocop/cop/lint/redundant_cop_disable_directive.rb +9 -22
  175. data/lib/rubocop/cop/lint/redundant_require_statement.rb +1 -0
  176. data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +2 -3
  177. data/lib/rubocop/cop/lint/redundant_splat_expansion.rb +5 -7
  178. data/lib/rubocop/cop/lint/redundant_string_coercion.rb +2 -2
  179. data/lib/rubocop/cop/lint/redundant_with_index.rb +2 -4
  180. data/lib/rubocop/cop/lint/redundant_with_object.rb +2 -4
  181. data/lib/rubocop/cop/lint/regexp_as_condition.rb +1 -3
  182. data/lib/rubocop/cop/lint/require_parentheses.rb +2 -4
  183. data/lib/rubocop/cop/lint/rescue_exception.rb +1 -2
  184. data/lib/rubocop/cop/lint/rescue_type.rb +2 -7
  185. data/lib/rubocop/cop/lint/return_in_void_context.rb +1 -2
  186. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +2 -2
  187. data/lib/rubocop/cop/lint/safe_navigation_consistency.rb +4 -10
  188. data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +2 -2
  189. data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +3 -7
  190. data/lib/rubocop/cop/lint/shadowed_argument.rb +5 -11
  191. data/lib/rubocop/cop/lint/shadowed_exception.rb +7 -8
  192. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +1 -0
  193. data/lib/rubocop/cop/lint/struct_new_override.rb +2 -2
  194. data/lib/rubocop/cop/lint/suppressed_exception.rb +44 -1
  195. data/lib/rubocop/cop/lint/symbol_conversion.rb +91 -6
  196. data/lib/rubocop/cop/lint/syntax.rb +1 -3
  197. data/lib/rubocop/cop/lint/to_enum_arguments.rb +3 -0
  198. data/lib/rubocop/cop/lint/to_json.rb +1 -2
  199. data/lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb +1 -3
  200. data/lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb +1 -3
  201. data/lib/rubocop/cop/lint/unified_integer.rb +1 -0
  202. data/lib/rubocop/cop/lint/unmodified_reduce_accumulator.rb +5 -0
  203. data/lib/rubocop/cop/lint/unreachable_code.rb +3 -5
  204. data/lib/rubocop/cop/lint/unreachable_loop.rb +15 -7
  205. data/lib/rubocop/cop/lint/unused_block_argument.rb +9 -7
  206. data/lib/rubocop/cop/lint/unused_method_argument.rb +2 -2
  207. data/lib/rubocop/cop/lint/uri_escape_unescape.rb +1 -0
  208. data/lib/rubocop/cop/lint/useless_access_modifier.rb +6 -4
  209. data/lib/rubocop/cop/lint/useless_assignment.rb +4 -9
  210. data/lib/rubocop/cop/lint/useless_setter_call.rb +2 -3
  211. data/lib/rubocop/cop/lint/useless_times.rb +3 -0
  212. data/lib/rubocop/cop/lint/void.rb +4 -11
  213. data/lib/rubocop/cop/message_annotator.rb +1 -3
  214. data/lib/rubocop/cop/metrics/block_nesting.rb +2 -7
  215. data/lib/rubocop/cop/metrics/class_length.rb +1 -3
  216. data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +1 -2
  217. data/lib/rubocop/cop/metrics/module_length.rb +3 -6
  218. data/lib/rubocop/cop/metrics/parameter_lists.rb +3 -5
  219. data/lib/rubocop/cop/metrics/perceived_complexity.rb +1 -2
  220. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +4 -7
  221. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +6 -4
  222. data/lib/rubocop/cop/metrics/utils/repeated_attribute_discount.rb +4 -7
  223. data/lib/rubocop/cop/migration/department_name.rb +3 -7
  224. data/lib/rubocop/cop/mixin/alignment.rb +12 -7
  225. data/lib/rubocop/cop/mixin/check_line_breakable.rb +1 -1
  226. data/lib/rubocop/cop/mixin/code_length.rb +1 -3
  227. data/lib/rubocop/cop/mixin/comments_help.rb +5 -1
  228. data/lib/rubocop/cop/mixin/configurable_enforced_style.rb +2 -2
  229. data/lib/rubocop/cop/mixin/configurable_formatting.rb +3 -8
  230. data/lib/rubocop/cop/mixin/def_node.rb +3 -5
  231. data/lib/rubocop/cop/mixin/documentation_comment.rb +3 -6
  232. data/lib/rubocop/cop/mixin/empty_lines_around_body.rb +6 -7
  233. data/lib/rubocop/cop/mixin/empty_parameter.rb +2 -3
  234. data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +1 -3
  235. data/lib/rubocop/cop/mixin/enforce_superclass.rb +4 -6
  236. data/lib/rubocop/cop/mixin/first_element_line_break.rb +1 -3
  237. data/lib/rubocop/cop/mixin/frozen_string_literal.rb +3 -9
  238. data/lib/rubocop/cop/mixin/gem_declaration.rb +13 -0
  239. data/lib/rubocop/cop/mixin/hash_alignment_styles.rb +3 -6
  240. data/lib/rubocop/cop/mixin/hash_transform_method.rb +8 -22
  241. data/lib/rubocop/cop/mixin/interpolation.rb +1 -3
  242. data/lib/rubocop/cop/mixin/line_length_help.rb +13 -10
  243. data/lib/rubocop/cop/mixin/match_range.rb +2 -5
  244. data/lib/rubocop/cop/mixin/method_complexity.rb +2 -3
  245. data/lib/rubocop/cop/mixin/method_preference.rb +1 -2
  246. data/lib/rubocop/cop/mixin/multiline_element_indentation.rb +4 -3
  247. data/lib/rubocop/cop/mixin/multiline_element_line_breaks.rb +1 -3
  248. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +11 -40
  249. data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb +1 -2
  250. data/lib/rubocop/cop/mixin/negative_conditional.rb +4 -2
  251. data/lib/rubocop/cop/mixin/ordered_gem_node.rb +1 -4
  252. data/lib/rubocop/cop/mixin/percent_array.rb +1 -3
  253. data/lib/rubocop/cop/mixin/percent_literal.rb +0 -6
  254. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +5 -11
  255. data/lib/rubocop/cop/mixin/preferred_delimiters.rb +4 -7
  256. data/lib/rubocop/cop/mixin/range_help.rb +10 -13
  257. data/lib/rubocop/cop/mixin/rational_literal.rb +1 -0
  258. data/lib/rubocop/cop/mixin/rescue_node.rb +2 -6
  259. data/lib/rubocop/cop/mixin/safe_assignment.rb +6 -2
  260. data/lib/rubocop/cop/mixin/space_after_punctuation.rb +2 -4
  261. data/lib/rubocop/cop/mixin/space_before_punctuation.rb +1 -2
  262. data/lib/rubocop/cop/mixin/statement_modifier.rb +1 -3
  263. data/lib/rubocop/cop/mixin/string_literals_help.rb +1 -1
  264. data/lib/rubocop/cop/mixin/trailing_body.rb +1 -2
  265. data/lib/rubocop/cop/mixin/trailing_comma.rb +1 -2
  266. data/lib/rubocop/cop/mixin/uncommunicative_name.rb +7 -13
  267. data/lib/rubocop/cop/mixin/unused_argument.rb +1 -3
  268. data/lib/rubocop/cop/mixin/visibility_help.rb +1 -0
  269. data/lib/rubocop/cop/naming/ascii_identifiers.rb +2 -4
  270. data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +2 -2
  271. data/lib/rubocop/cop/naming/constant_name.rb +2 -0
  272. data/lib/rubocop/cop/naming/file_name.rb +7 -16
  273. data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +8 -3
  274. data/lib/rubocop/cop/naming/method_name.rb +4 -2
  275. data/lib/rubocop/cop/naming/predicate_name.rb +2 -2
  276. data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +10 -0
  277. data/lib/rubocop/cop/offense.rb +3 -8
  278. data/lib/rubocop/cop/registry.rb +12 -11
  279. data/lib/rubocop/cop/security/eval.rb +1 -0
  280. data/lib/rubocop/cop/security/json_load.rb +1 -0
  281. data/lib/rubocop/cop/security/marshal_load.rb +1 -0
  282. data/lib/rubocop/cop/security/open.rb +1 -0
  283. data/lib/rubocop/cop/security/yaml_load.rb +1 -0
  284. data/lib/rubocop/cop/style/access_modifier_declarations.rb +4 -5
  285. data/lib/rubocop/cop/style/accessor_grouping.rb +1 -3
  286. data/lib/rubocop/cop/style/alias.rb +6 -12
  287. data/lib/rubocop/cop/style/and_or.rb +3 -1
  288. data/lib/rubocop/cop/style/arguments_forwarding.rb +4 -3
  289. data/lib/rubocop/cop/style/array_coercion.rb +2 -0
  290. data/lib/rubocop/cop/style/array_join.rb +1 -0
  291. data/lib/rubocop/cop/style/ascii_comments.rb +1 -2
  292. data/lib/rubocop/cop/style/attr.rb +2 -3
  293. data/lib/rubocop/cop/style/auto_resource_cleanup.rb +2 -5
  294. data/lib/rubocop/cop/style/bisected_attr_accessor.rb +59 -71
  295. data/lib/rubocop/cop/style/bisected_attr_accessor/macro.rb +60 -0
  296. data/lib/rubocop/cop/style/case_equality.rb +2 -1
  297. data/lib/rubocop/cop/style/case_like_if.rb +16 -6
  298. data/lib/rubocop/cop/style/character_literal.rb +2 -4
  299. data/lib/rubocop/cop/style/class_and_module_children.rb +6 -9
  300. data/lib/rubocop/cop/style/class_equality_comparison.rb +3 -0
  301. data/lib/rubocop/cop/style/class_methods.rb +1 -3
  302. data/lib/rubocop/cop/style/collection_compact.rb +3 -3
  303. data/lib/rubocop/cop/style/colon_method_call.rb +2 -3
  304. data/lib/rubocop/cop/style/combinable_loops.rb +3 -2
  305. data/lib/rubocop/cop/style/command_literal.rb +4 -9
  306. data/lib/rubocop/cop/style/comment_annotation.rb +3 -6
  307. data/lib/rubocop/cop/style/commented_keyword.rb +7 -13
  308. data/lib/rubocop/cop/style/conditional_assignment.rb +12 -24
  309. data/lib/rubocop/cop/style/constant_visibility.rb +1 -0
  310. data/lib/rubocop/cop/style/copyright.rb +3 -6
  311. data/lib/rubocop/cop/style/date_time.rb +5 -5
  312. data/lib/rubocop/cop/style/def_with_parentheses.rb +1 -2
  313. data/lib/rubocop/cop/style/dir.rb +1 -0
  314. data/lib/rubocop/cop/style/disable_cops_within_source_code_directive.rb +2 -2
  315. data/lib/rubocop/cop/style/documentation.rb +30 -3
  316. data/lib/rubocop/cop/style/documentation_method.rb +1 -0
  317. data/lib/rubocop/cop/style/double_negation.rb +1 -0
  318. data/lib/rubocop/cop/style/each_for_simple_loop.rb +2 -2
  319. data/lib/rubocop/cop/style/each_with_object.rb +1 -0
  320. data/lib/rubocop/cop/style/empty_case_condition.rb +2 -7
  321. data/lib/rubocop/cop/style/empty_else.rb +3 -9
  322. data/lib/rubocop/cop/style/empty_literal.rb +13 -8
  323. data/lib/rubocop/cop/style/empty_method.rb +3 -7
  324. data/lib/rubocop/cop/style/end_block.rb +1 -2
  325. data/lib/rubocop/cop/style/endless_method.rb +2 -3
  326. data/lib/rubocop/cop/style/eval_with_location.rb +5 -5
  327. data/lib/rubocop/cop/style/even_odd.rb +1 -0
  328. data/lib/rubocop/cop/style/expand_path_arguments.rb +4 -3
  329. data/lib/rubocop/cop/style/explicit_block_argument.rb +2 -4
  330. data/lib/rubocop/cop/style/float_division.rb +4 -0
  331. data/lib/rubocop/cop/style/format_string.rb +2 -0
  332. data/lib/rubocop/cop/style/format_string_token.rb +2 -4
  333. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +3 -11
  334. data/lib/rubocop/cop/style/global_std_stream.rb +1 -0
  335. data/lib/rubocop/cop/style/guard_clause.rb +3 -7
  336. data/lib/rubocop/cop/style/hash_conversion.rb +57 -5
  337. data/lib/rubocop/cop/style/hash_each_methods.rb +2 -2
  338. data/lib/rubocop/cop/style/hash_except.rb +1 -0
  339. data/lib/rubocop/cop/style/hash_like_case.rb +2 -2
  340. data/lib/rubocop/cop/style/hash_syntax.rb +20 -24
  341. data/lib/rubocop/cop/style/hash_transform_keys.rb +4 -0
  342. data/lib/rubocop/cop/style/hash_transform_values.rb +4 -0
  343. data/lib/rubocop/cop/style/identical_conditional_branches.rb +1 -3
  344. data/lib/rubocop/cop/style/if_unless_modifier.rb +40 -13
  345. data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +2 -0
  346. data/lib/rubocop/cop/style/implicit_runtime_error.rb +1 -0
  347. data/lib/rubocop/cop/style/infinite_loop.rb +2 -5
  348. data/lib/rubocop/cop/style/inverse_methods.rb +5 -7
  349. data/lib/rubocop/cop/style/ip_addresses.rb +1 -2
  350. data/lib/rubocop/cop/style/lambda.rb +2 -4
  351. data/lib/rubocop/cop/style/lambda_call.rb +1 -2
  352. data/lib/rubocop/cop/style/line_end_concatenation.rb +5 -12
  353. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +47 -3
  354. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +26 -16
  355. data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +1 -2
  356. data/lib/rubocop/cop/style/method_called_on_do_end_block.rb +2 -4
  357. data/lib/rubocop/cop/style/method_def_parentheses.rb +4 -8
  358. data/lib/rubocop/cop/style/min_max.rb +2 -2
  359. data/lib/rubocop/cop/style/missing_else.rb +2 -4
  360. data/lib/rubocop/cop/style/missing_respond_to_missing.rb +1 -2
  361. data/lib/rubocop/cop/style/mixin_grouping.rb +4 -10
  362. data/lib/rubocop/cop/style/mixin_usage.rb +3 -2
  363. data/lib/rubocop/cop/style/module_function.rb +8 -6
  364. data/lib/rubocop/cop/style/multiline_block_chain.rb +1 -2
  365. data/lib/rubocop/cop/style/multiline_method_signature.rb +11 -6
  366. data/lib/rubocop/cop/style/multiline_ternary_operator.rb +1 -2
  367. data/lib/rubocop/cop/style/multiple_comparison.rb +22 -5
  368. data/lib/rubocop/cop/style/mutable_constant.rb +7 -10
  369. data/lib/rubocop/cop/style/negated_if.rb +1 -2
  370. data/lib/rubocop/cop/style/negated_if_else_condition.rb +24 -2
  371. data/lib/rubocop/cop/style/negated_unless.rb +1 -2
  372. data/lib/rubocop/cop/style/nested_modifier.rb +3 -7
  373. data/lib/rubocop/cop/style/nested_ternary_operator.rb +2 -3
  374. data/lib/rubocop/cop/style/next.rb +4 -9
  375. data/lib/rubocop/cop/style/nil_comparison.rb +3 -0
  376. data/lib/rubocop/cop/style/nil_lambda.rb +1 -0
  377. data/lib/rubocop/cop/style/non_nil_check.rb +9 -5
  378. data/lib/rubocop/cop/style/numeric_literals.rb +3 -11
  379. data/lib/rubocop/cop/style/numeric_predicate.rb +5 -7
  380. data/lib/rubocop/cop/style/one_line_conditional.rb +1 -2
  381. data/lib/rubocop/cop/style/option_hash.rb +2 -3
  382. data/lib/rubocop/cop/style/optional_arguments.rb +2 -5
  383. data/lib/rubocop/cop/style/or_assignment.rb +4 -6
  384. data/lib/rubocop/cop/style/parallel_assignment.rb +12 -9
  385. data/lib/rubocop/cop/style/parentheses_around_condition.rb +1 -0
  386. data/lib/rubocop/cop/style/percent_literal_delimiters.rb +1 -3
  387. data/lib/rubocop/cop/style/percent_q_literals.rb +1 -2
  388. data/lib/rubocop/cop/style/perl_backrefs.rb +2 -9
  389. data/lib/rubocop/cop/style/preferred_hash_methods.rb +1 -4
  390. data/lib/rubocop/cop/style/proc.rb +2 -2
  391. data/lib/rubocop/cop/style/raise_args.rb +4 -8
  392. data/lib/rubocop/cop/style/random_with_offset.rb +8 -8
  393. data/lib/rubocop/cop/style/redundant_argument.rb +2 -11
  394. data/lib/rubocop/cop/style/redundant_assignment.rb +2 -3
  395. data/lib/rubocop/cop/style/redundant_begin.rb +47 -7
  396. data/lib/rubocop/cop/style/redundant_capital_w.rb +1 -2
  397. data/lib/rubocop/cop/style/redundant_condition.rb +2 -5
  398. data/lib/rubocop/cop/style/redundant_conditional.rb +5 -6
  399. data/lib/rubocop/cop/style/redundant_exception.rb +5 -6
  400. data/lib/rubocop/cop/style/redundant_fetch_block.rb +2 -0
  401. data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +2 -1
  402. data/lib/rubocop/cop/style/redundant_freeze.rb +2 -2
  403. data/lib/rubocop/cop/style/redundant_interpolation.rb +1 -2
  404. data/lib/rubocop/cop/style/redundant_parentheses.rb +21 -20
  405. data/lib/rubocop/cop/style/redundant_percent_q.rb +1 -2
  406. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +1 -4
  407. data/lib/rubocop/cop/style/redundant_return.rb +6 -4
  408. data/lib/rubocop/cop/style/redundant_self.rb +9 -9
  409. data/lib/rubocop/cop/style/redundant_self_assignment.rb +4 -2
  410. data/lib/rubocop/cop/style/redundant_sort.rb +3 -5
  411. data/lib/rubocop/cop/style/redundant_sort_by.rb +1 -0
  412. data/lib/rubocop/cop/style/regexp_literal.rb +4 -8
  413. data/lib/rubocop/cop/style/rescue_modifier.rb +21 -14
  414. data/lib/rubocop/cop/style/rescue_standard_error.rb +5 -7
  415. data/lib/rubocop/cop/style/return_nil.rb +7 -2
  416. data/lib/rubocop/cop/style/safe_navigation.rb +12 -21
  417. data/lib/rubocop/cop/style/sample.rb +1 -0
  418. data/lib/rubocop/cop/style/send.rb +1 -2
  419. data/lib/rubocop/cop/style/signal_exception.rb +6 -7
  420. data/lib/rubocop/cop/style/single_argument_dig.rb +2 -2
  421. data/lib/rubocop/cop/style/single_line_block_params.rb +2 -5
  422. data/lib/rubocop/cop/style/single_line_methods.rb +21 -4
  423. data/lib/rubocop/cop/style/slicing_with_range.rb +1 -0
  424. data/lib/rubocop/cop/style/sole_nested_conditional.rb +31 -7
  425. data/lib/rubocop/cop/style/special_global_vars.rb +6 -18
  426. data/lib/rubocop/cop/style/stabby_lambda_parentheses.rb +1 -2
  427. data/lib/rubocop/cop/style/stderr_puts.rb +3 -6
  428. data/lib/rubocop/cop/style/string_chars.rb +39 -0
  429. data/lib/rubocop/cop/style/string_concatenation.rb +9 -10
  430. data/lib/rubocop/cop/style/string_hash_keys.rb +2 -0
  431. data/lib/rubocop/cop/style/string_literals.rb +2 -5
  432. data/lib/rubocop/cop/style/strip.rb +1 -0
  433. data/lib/rubocop/cop/style/struct_inheritance.rb +11 -0
  434. data/lib/rubocop/cop/style/symbol_literal.rb +1 -3
  435. data/lib/rubocop/cop/style/symbol_proc.rb +29 -10
  436. data/lib/rubocop/cop/style/ternary_parentheses.rb +4 -6
  437. data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb +6 -2
  438. data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +2 -6
  439. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +3 -6
  440. data/lib/rubocop/cop/style/trailing_underscore_variable.rb +4 -10
  441. data/lib/rubocop/cop/style/trivial_accessors.rb +3 -4
  442. data/lib/rubocop/cop/style/unless_else.rb +1 -2
  443. data/lib/rubocop/cop/style/unless_logical_operators.rb +105 -0
  444. data/lib/rubocop/cop/style/unpack_first.rb +1 -0
  445. data/lib/rubocop/cop/style/variable_interpolation.rb +1 -1
  446. data/lib/rubocop/cop/style/when_then.rb +1 -3
  447. data/lib/rubocop/cop/style/while_until_modifier.rb +1 -2
  448. data/lib/rubocop/cop/style/word_array.rb +1 -2
  449. data/lib/rubocop/cop/style/yoda_condition.rb +4 -11
  450. data/lib/rubocop/cop/style/zero_length_predicate.rb +6 -2
  451. data/lib/rubocop/cop/team.rb +2 -5
  452. data/lib/rubocop/cop/util.rb +8 -11
  453. data/lib/rubocop/cop/utils/format_string.rb +1 -3
  454. data/lib/rubocop/cop/variable_force.rb +6 -15
  455. data/lib/rubocop/cop/variable_force/assignment.rb +1 -2
  456. data/lib/rubocop/cop/variable_force/branch.rb +16 -2
  457. data/lib/rubocop/cop/variable_force/reference.rb +1 -3
  458. data/lib/rubocop/cop/variable_force/scope.rb +4 -8
  459. data/lib/rubocop/cop/variable_force/variable.rb +2 -4
  460. data/lib/rubocop/cops_documentation_generator.rb +7 -21
  461. data/lib/rubocop/directive_comment.rb +69 -9
  462. data/lib/rubocop/ext/regexp_parser.rb +3 -6
  463. data/lib/rubocop/file_finder.rb +1 -3
  464. data/lib/rubocop/formatter/clang_style_formatter.rb +4 -2
  465. data/lib/rubocop/formatter/disabled_config_formatter.rb +3 -8
  466. data/lib/rubocop/formatter/git_hub_actions_formatter.rb +1 -5
  467. data/lib/rubocop/formatter/html_formatter.rb +4 -10
  468. data/lib/rubocop/formatter/json_formatter.rb +1 -5
  469. data/lib/rubocop/formatter/junit_formatter.rb +3 -9
  470. data/lib/rubocop/formatter/progress_formatter.rb +1 -3
  471. data/lib/rubocop/formatter/tap_formatter.rb +4 -2
  472. data/lib/rubocop/magic_comment.rb +1 -1
  473. data/lib/rubocop/name_similarity.rb +1 -1
  474. data/lib/rubocop/options.rb +27 -41
  475. data/lib/rubocop/path_util.rb +1 -3
  476. data/lib/rubocop/rake_task.rb +3 -0
  477. data/lib/rubocop/remote_config.rb +4 -7
  478. data/lib/rubocop/result_cache.rb +5 -12
  479. data/lib/rubocop/rspec/cop_helper.rb +1 -1
  480. data/lib/rubocop/rspec/expect_offense.rb +4 -9
  481. data/lib/rubocop/rspec/shared_contexts.rb +8 -15
  482. data/lib/rubocop/runner.rb +7 -14
  483. data/lib/rubocop/target_finder.rb +19 -16
  484. data/lib/rubocop/target_ruby.rb +25 -21
  485. data/lib/rubocop/version.rb +1 -1
  486. metadata +18 -11
  487. data/lib/rubocop/core_ext/hash.rb +0 -20
@@ -36,10 +36,7 @@ module RuboCop
36
36
  # @param [Integer] size
37
37
  def remove_preceding(node_or_range, size)
38
38
  range = to_range(node_or_range)
39
- to_remove = range.with(
40
- begin_pos: range.begin_pos - size,
41
- end_pos: range.begin_pos
42
- )
39
+ to_remove = range.with(begin_pos: range.begin_pos - size, end_pos: range.begin_pos)
43
40
  remove(to_remove)
44
41
  end
45
42
 
@@ -12,7 +12,7 @@ module RuboCop
12
12
  class << self
13
13
  attr_reader :processed_source
14
14
 
15
- def correct(processed_source, node, column_delta)
15
+ def correct(corrector, processed_source, node, column_delta)
16
16
  return unless node
17
17
 
18
18
  @processed_source = processed_source
@@ -21,11 +21,8 @@ module RuboCop
21
21
 
22
22
  taboo_ranges = inside_string_ranges(node)
23
23
 
24
- lambda do |corrector|
25
- each_line(expr) do |line_begin_pos|
26
- autocorrect_line(corrector, line_begin_pos, expr, column_delta,
27
- taboo_ranges)
28
- end
24
+ each_line(expr) do |line_begin_pos|
25
+ autocorrect_line(corrector, line_begin_pos, expr, column_delta, taboo_ranges)
29
26
  end
30
27
  end
31
28
 
@@ -57,8 +54,7 @@ module RuboCop
57
54
  def inside_string_ranges(node)
58
55
  return [] unless node.is_a?(Parser::AST::Node)
59
56
 
60
- node.each_node(:str, :dstr, :xstr).map { |n| inside_string_range(n) }
61
- .compact
57
+ node.each_node(:str, :dstr, :xstr).map { |n| inside_string_range(n) }.compact
62
58
  end
63
59
 
64
60
  def inside_string_range(node)
@@ -79,8 +75,7 @@ module RuboCop
79
75
  def delimited_string_literal?(node)
80
76
  loc = node.location
81
77
 
82
- loc.respond_to?(:begin) && loc.begin &&
83
- loc.respond_to?(:end) && loc.end
78
+ loc.respond_to?(:begin) && loc.begin && loc.respond_to?(:end) && loc.end
84
79
  end
85
80
 
86
81
  def block_comment_within?(expr)
@@ -92,8 +87,7 @@ module RuboCop
92
87
  def calculate_range(expr, line_begin_pos, column_delta)
93
88
  return range_between(line_begin_pos, line_begin_pos) if column_delta.positive?
94
89
 
95
- starts_with_space =
96
- expr.source_buffer.source[line_begin_pos].start_with?(' ')
90
+ starts_with_space = expr.source_buffer.source[line_begin_pos].start_with?(' ')
97
91
 
98
92
  if starts_with_space
99
93
  range_between(line_begin_pos, line_begin_pos + column_delta.abs)
@@ -6,8 +6,7 @@ module RuboCop
6
6
  class EachToForCorrector
7
7
  extend NodePattern::Macros
8
8
 
9
- CORRECTION_WITH_ARGUMENTS =
10
- 'for %<variables>s in %<collection>s do'
9
+ CORRECTION_WITH_ARGUMENTS = 'for %<variables>s in %<collection>s do'
11
10
  CORRECTION_WITHOUT_ARGUMENTS = 'for _ in %<enumerable>s do'
12
11
 
13
12
  def initialize(block_node)
@@ -30,8 +29,7 @@ module RuboCop
30
29
  collection: collection_node.source,
31
30
  variables: argument_node.children.first.source)
32
31
  else
33
- format(CORRECTION_WITHOUT_ARGUMENTS,
34
- enumerable: collection_node.source)
32
+ format(CORRECTION_WITHOUT_ARGUMENTS, enumerable: collection_node.source)
35
33
  end
36
34
  end
37
35
 
@@ -23,8 +23,7 @@ module RuboCop
23
23
  attr_reader :for_node, :variable_node, :collection_node
24
24
 
25
25
  def correction
26
- format(CORRECTION, collection: collection_source,
27
- argument: variable_node.source)
26
+ format(CORRECTION, collection: collection_source, argument: variable_node.source)
28
27
  end
29
28
 
30
29
  def collection_source
@@ -20,8 +20,7 @@ module RuboCop
20
20
 
21
21
  break_line_before(range: range, node: node, corrector: corrector,
22
22
  configured_width: configured_width)
23
- move_comment(eol_comment: eol_comment, node: node,
24
- corrector: corrector)
23
+ move_comment(eol_comment: eol_comment, node: node, corrector: corrector)
25
24
  remove_semicolon(node, corrector)
26
25
  end
27
26
 
@@ -29,8 +28,7 @@ module RuboCop
29
28
  indent_steps: 1)
30
29
  corrector.insert_before(
31
30
  range,
32
- "\n#{' ' * (node.loc.keyword.column +
33
- indent_steps * configured_width)}"
31
+ "\n#{' ' * (node.loc.keyword.column + indent_steps * configured_width)}"
34
32
  )
35
33
  end
36
34
 
@@ -38,8 +36,7 @@ module RuboCop
38
36
  return unless eol_comment
39
37
 
40
38
  text = eol_comment.loc.expression.source
41
- corrector.insert_before(node,
42
- "#{text}\n#{' ' * node.loc.keyword.column}")
39
+ corrector.insert_before(node, "#{text}\n#{' ' * node.loc.keyword.column}")
43
40
  corrector.remove(eol_comment)
44
41
  end
45
42
 
@@ -41,9 +41,7 @@ module RuboCop
41
41
  end
42
42
 
43
43
  def correct_next_line_brace(corrector)
44
- corrector.remove(
45
- range_with_surrounding_space(range: node.loc.end, side: :left)
46
- )
44
+ corrector.remove(range_with_surrounding_space(range: node.loc.end, side: :left))
47
45
 
48
46
  corrector.insert_before(
49
47
  last_element_range_with_trailing_comma(node).end,
@@ -17,9 +17,7 @@ module RuboCop
17
17
  current_range = declaration_with_comment(node)
18
18
  previous_range = declaration_with_comment(previous_declaration)
19
19
 
20
- lambda do |corrector|
21
- swap_range(corrector, current_range, previous_range)
22
- end
20
+ ->(corrector) do swap_range(corrector, current_range, previous_range) end
23
21
  end
24
22
 
25
23
  private
@@ -32,9 +32,7 @@ module RuboCop
32
32
  end
33
33
 
34
34
  def delimiters_for(type)
35
- PreferredDelimiters
36
- .new(type, config, preferred_delimiters)
37
- .delimiters
35
+ PreferredDelimiters.new(type, config, preferred_delimiters).delimiters
38
36
  end
39
37
 
40
38
  def new_contents(node, escape, delimiters)
@@ -61,11 +59,7 @@ module RuboCop
61
59
  base_line_num = node.first_line
62
60
  prev_line_num = base_line_num
63
61
  node.children.map.with_index do |word_node, index|
64
- line_breaks = line_breaks(word_node,
65
- node.source,
66
- prev_line_num,
67
- base_line_num,
68
- index)
62
+ line_breaks = line_breaks(word_node, node.source, prev_line_num, base_line_num, index)
69
63
  prev_line_num = word_node.last_line
70
64
  content = fix_escaped_content(word_node, escape, delimiters)
71
65
  line_breaks + content
@@ -25,6 +25,7 @@ module RuboCop
25
25
 
26
26
  MSG = 'Do not use `date =` in gemspec, it is set automatically when the gem is packaged.'
27
27
 
28
+ # @!method gem_specification(node)
28
29
  def_node_matcher :gem_specification, <<~PATTERN
29
30
  (block
30
31
  (send
@@ -40,6 +40,7 @@ module RuboCop
40
40
  MSG = '`%<assignment>s` method calls already given on line '\
41
41
  '%<line_of_first_occurrence>d of the gemspec.'
42
42
 
43
+ # @!method gem_specification(node)
43
44
  def_node_search :gem_specification, <<~PATTERN
44
45
  (block
45
46
  (send
@@ -49,6 +50,7 @@ module RuboCop
49
50
  (arg $_)) ...)
50
51
  PATTERN
51
52
 
53
+ # @!method assignment_method_declarations(node)
52
54
  def_node_search :assignment_method_declarations, <<~PATTERN
53
55
  (send
54
56
  (lvar #match_block_variable_name?) #assignment_method? ...)
@@ -89,8 +91,7 @@ module RuboCop
89
91
 
90
92
  def register_offense(node, assignment, line_of_first_occurrence)
91
93
  line_range = node.loc.column...node.loc.last_column
92
- offense_location =
93
- source_range(processed_source.buffer, node.first_line, line_range)
94
+ offense_location = source_range(processed_source.buffer, node.first_line, line_range)
94
95
  message = format(
95
96
  MSG,
96
97
  assignment: assignment,
@@ -64,10 +64,7 @@ module RuboCop
64
64
  dependency_declarations(processed_source.ast)
65
65
  .each_cons(2) do |previous, current|
66
66
  next unless consecutive_lines(previous, current)
67
- next unless case_insensitive_out_of_order?(
68
- gem_name(current),
69
- gem_name(previous)
70
- )
67
+ next unless case_insensitive_out_of_order?(gem_name(current), gem_name(previous))
71
68
  next unless get_dependency_name(previous) == get_dependency_name(current)
72
69
 
73
70
  register_offense(previous, current)
@@ -95,6 +92,7 @@ module RuboCop
95
92
  node.method_name
96
93
  end
97
94
 
95
+ # @!method dependency_declarations(node)
98
96
  def_node_search :dependency_declarations, <<~PATTERN
99
97
  (send (lvar _) {:add_dependency :add_runtime_dependency :add_development_dependency} (str _) ...)
100
98
  PATTERN
@@ -55,10 +55,12 @@ module RuboCop
55
55
  '.rubocop.yml) should be equal.'
56
56
  MISSING_MSG = '`required_ruby_version` should be specified.'
57
57
 
58
+ # @!method required_ruby_version(node)
58
59
  def_node_search :required_ruby_version, <<~PATTERN
59
60
  (send _ :required_ruby_version= $_)
60
61
  PATTERN
61
62
 
63
+ # @!method defined_ruby_version(node)
62
64
  def_node_matcher :defined_ruby_version, <<~PATTERN
63
65
  {$(str _) $(array (str _) (str _))
64
66
  (send (const (const nil? :Gem) :Requirement) :new $(str _))}
@@ -28,8 +28,10 @@ module RuboCop
28
28
  class RubyVersionGlobalsUsage < Base
29
29
  MSG = 'Do not use `RUBY_VERSION` in gemspec file.'
30
30
 
31
+ # @!method ruby_version?(node)
31
32
  def_node_matcher :ruby_version?, '(const {cbase nil?} :RUBY_VERSION)'
32
33
 
34
+ # @!method gem_specification?(node)
33
35
  def_node_search :gem_specification?, <<~PATTERN
34
36
  (block
35
37
  (send
@@ -9,7 +9,7 @@ module RuboCop
9
9
  # @api private
10
10
  class Generator
11
11
  # NOTE: RDoc 5.1.0 or lower has the following issue.
12
- # https://github.com/rubocop-hq/rubocop/issues/7043
12
+ # https://github.com/rubocop/rubocop/issues/7043
13
13
  #
14
14
  # The following `String#gsub` can be replaced with
15
15
  # squiggly heredoc when RuboCop supports Ruby 2.5 or higher
@@ -58,7 +58,7 @@ module RuboCop
58
58
  # TODO: Implement the cop in here.
59
59
  #
60
60
  # In many cases, you can use a node matcher for matching node pattern.
61
- # See https://github.com/rubocop-hq/rubocop-ast/blob/master/lib/rubocop/ast/node_pattern.rb
61
+ # See https://github.com/rubocop/rubocop-ast/blob/master/lib/rubocop/ast/node_pattern.rb
62
62
  #
63
63
  # For example
64
64
  MSG = 'Use `#good_method` instead of `#bad_method`.'
@@ -124,10 +124,7 @@ module RuboCop
124
124
  end
125
125
 
126
126
  def inject_require(root_file_path: 'lib/rubocop.rb')
127
- RequireFileInjector.new(
128
- source_path: source_path,
129
- root_file_path: root_file_path
130
- ).inject
127
+ RequireFileInjector.new(source_path: source_path, root_file_path: root_file_path).inject
131
128
  end
132
129
 
133
130
  def inject_config(config_file_path: 'config/default.yml',
@@ -24,8 +24,7 @@ module RuboCop
24
24
  def inject
25
25
  target_line = find_target_line
26
26
  if target_line
27
- configuration_entries.insert(target_line,
28
- "#{new_configuration_entry}\n")
27
+ configuration_entries.insert(target_line, "#{new_configuration_entry}\n")
29
28
  else
30
29
  configuration_entries.push("\n#{new_configuration_entry}")
31
30
  end
@@ -29,14 +29,11 @@ module RuboCop
29
29
  attr_reader :require_entries, :root_file_path, :source_path, :output
30
30
 
31
31
  def require_exists?
32
- require_entries.any? do |entry|
33
- entry == injectable_require_directive
34
- end
32
+ require_entries.any?(injectable_require_directive)
35
33
  end
36
34
 
37
35
  def updated_directives
38
- require_entries.insert(target_line,
39
- injectable_require_directive).join
36
+ require_entries.insert(target_line, injectable_require_directive).join
40
37
  end
41
38
 
42
39
  def target_line
@@ -4,6 +4,7 @@ require_relative 'internal_affairs/empty_line_between_expect_offense_and_correct
4
4
  require_relative 'internal_affairs/example_description'
5
5
  require_relative 'internal_affairs/method_name_equal'
6
6
  require_relative 'internal_affairs/node_destructuring'
7
+ require_relative 'internal_affairs/node_matcher_directive'
7
8
  require_relative 'internal_affairs/node_type_predicate'
8
9
  require_relative 'internal_affairs/offense_location_keyword'
9
10
  require_relative 'internal_affairs/redundant_described_class_as_subject'
@@ -49,14 +49,13 @@ module RuboCop
49
49
  /^(does not|doesn't) add (a|an|any )?offense/
50
50
  ].freeze
51
51
 
52
- EXPECT_NO_CORRECTIONS_INCORRECT_DESCRIPTIONS = [
53
- /^(auto[- ]?)?correct/
54
- ].freeze
52
+ EXPECT_NO_CORRECTIONS_INCORRECT_DESCRIPTIONS = [/^(auto[- ]?)?correct/].freeze
55
53
 
56
54
  EXPECT_CORRECTION_INCORRECT_DESCRIPTIONS = [
57
55
  /\b(does not|doesn't) (auto[- ]?)?correct/
58
56
  ].freeze
59
57
 
58
+ # @!method offense_example?(node)
60
59
  def_node_matcher :offense_example?, <<~PATTERN
61
60
  (block
62
61
  (send _ {:it :specify} $_description)
@@ -79,10 +78,14 @@ module RuboCop
79
78
  private
80
79
 
81
80
  def check_description(description, regexps, message)
82
- return unless regexps.any? { |regexp| regexp.match?(description.value) }
81
+ return unless regexps.any? { |regexp| regexp.match?(string_contents(description)) }
83
82
 
84
83
  add_offense(description, message: message)
85
84
  end
85
+
86
+ def string_contents(node)
87
+ node.str_type? ? node.value : node.source
88
+ end
86
89
  end
87
90
  end
88
91
  end
@@ -16,10 +16,10 @@ module RuboCop
16
16
  include RangeHelp
17
17
  extend AutoCorrector
18
18
 
19
- MSG = 'Use `method?(%<method_name>s)` instead of ' \
20
- '`method_name == %<method_name>s`.'
19
+ MSG = 'Use `method?(%<method_name>s)` instead of `method_name == %<method_name>s`.'
21
20
  RESTRICT_ON_SEND = %i[==].freeze
22
21
 
22
+ # @!method method_name?(node)
23
23
  def_node_matcher :method_name?, <<~PATTERN
24
24
  (send
25
25
  $(send
@@ -42,9 +42,7 @@ module RuboCop
42
42
  private
43
43
 
44
44
  def range(method_name_node, node)
45
- range_between(
46
- method_name_node.loc.selector.begin_pos, node.source_range.end_pos
47
- )
45
+ range_between(method_name_node.loc.selector.begin_pos, node.source_range.end_pos)
48
46
  end
49
47
  end
50
48
  end
@@ -19,18 +19,18 @@ module RuboCop
19
19
  MSG = 'Use the methods provided with the node extensions instead ' \
20
20
  'of manually destructuring nodes.'
21
21
 
22
+ # @!method node_variable?(node)
22
23
  def_node_matcher :node_variable?, <<~PATTERN
23
24
  {(lvar [#node_suffix? _]) (send nil? [#node_suffix? _])}
24
25
  PATTERN
25
26
 
27
+ # @!method node_destructuring?(node)
26
28
  def_node_matcher :node_destructuring?, <<~PATTERN
27
29
  {(masgn (mlhs ...) {(send #node_variable? :children) (array (splat #node_variable?))})}
28
30
  PATTERN
29
31
 
30
32
  def on_masgn(node)
31
- node_destructuring?(node) do
32
- add_offense(node)
33
- end
33
+ node_destructuring?(node) { add_offense(node) }
34
34
  end
35
35
 
36
36
  private
@@ -0,0 +1,151 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ module InternalAffairs
6
+ # Checks that node matcher definitions are tagged with a YARD `@!method`
7
+ # directive so that editors are able to find the dynamically defined
8
+ # method.
9
+ #
10
+ # @example
11
+ # # bad
12
+ # def_node_matcher :foo?, <<~PATTERN
13
+ # ...
14
+ # PATTERN
15
+ #
16
+ # # good
17
+ # # @!method foo?(node)
18
+ # def_node_matcher :foo?, <<~PATTERN
19
+ # ...
20
+ # PATTERN
21
+ #
22
+ class NodeMatcherDirective < Base
23
+ extend AutoCorrector
24
+ include RangeHelp
25
+
26
+ MSG = 'Preceed `%<method>s` with a `@!method` YARD directive.'
27
+ MSG_WRONG_NAME = '`@!method` YARD directive has invalid method name, ' \
28
+ 'use `%<expected>s` instead of `%<actual>s`.'
29
+ MSG_TOO_MANY = 'Multiple `@!method` YARD directives found for this matcher.'
30
+
31
+ RESTRICT_ON_SEND = %i[def_node_matcher def_node_search].to_set.freeze
32
+ REGEXP = /^\s*#\s*@!method\s+(?<method_name>[a-z0-9_]+[?!]?)(?:\((?<args>.*)\))?/.freeze
33
+
34
+ # @!method pattern_matcher?(node)
35
+ def_node_matcher :pattern_matcher?, <<~PATTERN
36
+ (send _ %RESTRICT_ON_SEND {str sym} {str dstr})
37
+ PATTERN
38
+
39
+ def on_send(node)
40
+ return if node.arguments.none?
41
+ return unless valid_method_name?(node)
42
+
43
+ actual_name = node.arguments.first.value
44
+ directives = method_directives(node)
45
+ return too_many_directives(node) if directives.size > 1
46
+
47
+ directive = directives.first
48
+ return if directive_correct?(directive, actual_name)
49
+
50
+ register_offense(node, directive, actual_name)
51
+ end
52
+
53
+ private
54
+
55
+ def valid_method_name?(node)
56
+ node.arguments.first.str_type? || node.arguments.first.sym_type?
57
+ end
58
+
59
+ def method_directives(node)
60
+ comments = processed_source.ast_with_comments[node]
61
+
62
+ comments.map do |comment|
63
+ match = comment.text.match(REGEXP)
64
+ next unless match
65
+
66
+ { node: comment, method_name: match[:method_name], args: match[:args] }
67
+ end.compact
68
+ end
69
+
70
+ def too_many_directives(node)
71
+ add_offense(node, message: MSG_TOO_MANY)
72
+ end
73
+
74
+ def directive_correct?(directive, actual_name)
75
+ directive && directive[:method_name] == actual_name.to_s
76
+ end
77
+
78
+ def register_offense(node, directive, actual_name)
79
+ message = formatted_message(directive, actual_name, node.method_name)
80
+
81
+ add_offense(node, message: message) do |corrector|
82
+ if directive
83
+ correct_directive(corrector, directive, actual_name)
84
+ else
85
+ insert_directive(corrector, node, actual_name)
86
+ end
87
+ end
88
+ end
89
+
90
+ def formatted_message(directive, actual_name, method_name)
91
+ if directive
92
+ format(MSG_WRONG_NAME, expected: actual_name, actual: directive[:method_name])
93
+ else
94
+ format(MSG, method: method_name)
95
+ end
96
+ end
97
+
98
+ def insert_directive(corrector, node, actual_name)
99
+ # If the pattern matcher uses arguments (`%1`, `%2`, etc.), include them in the directive
100
+ arguments = pattern_arguments(node.arguments[1].source)
101
+
102
+ range = range_with_surrounding_space(
103
+ range: node.loc.expression,
104
+ side: :left,
105
+ newlines: false
106
+ )
107
+ indentation = range.source.match(/^\s*/)[0]
108
+ directive = "#{indentation}# @!method #{actual_name}(#{arguments.join(', ')})\n"
109
+ directive = "\n#{directive}" if add_newline?(node)
110
+
111
+ corrector.insert_before(range, directive)
112
+ end
113
+
114
+ def pattern_arguments(pattern)
115
+ arguments = %w[node]
116
+ max_pattern_var = pattern.scan(/(?<=%)\d+/).map(&:to_i).max
117
+ max_pattern_var&.times { |i| arguments << "arg#{i + 1}" }
118
+ arguments
119
+ end
120
+
121
+ def add_newline?(node)
122
+ # Determine if a blank line should be inserted before the new directive
123
+ # in order to spread out pattern matchers
124
+ return if node.sibling_index&.zero?
125
+ return unless node.parent
126
+
127
+ prev_sibling = node.parent.child_nodes[node.sibling_index - 1]
128
+ return unless prev_sibling && pattern_matcher?(prev_sibling)
129
+
130
+ node.loc.line == last_line(prev_sibling) + 1
131
+ end
132
+
133
+ def last_line(node)
134
+ if node.last_argument.heredoc?
135
+ node.last_argument.loc.heredoc_end.line
136
+ else
137
+ node.loc.last_line
138
+ end
139
+ end
140
+
141
+ def correct_directive(corrector, directive, actual_name)
142
+ correct = "@!method #{actual_name}"
143
+ regexp = /@!method\s+#{Regexp.escape(directive[:method_name])}/
144
+
145
+ replacement = directive[:node].text.gsub(regexp, correct)
146
+ corrector.replace(directive[:node], replacement)
147
+ end
148
+ end
149
+ end
150
+ end
151
+ end