rubocop 0.49.1 → 0.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (506) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -9
  3. data/bin/rubocop +1 -1
  4. data/config/default.yml +264 -118
  5. data/config/disabled.yml +13 -9
  6. data/config/enabled.yml +1156 -918
  7. data/lib/rubocop.rb +555 -489
  8. data/lib/rubocop/ast/builder.rb +6 -1
  9. data/lib/rubocop/ast/node.rb +68 -52
  10. data/lib/rubocop/ast/node/args_node.rb +15 -10
  11. data/lib/rubocop/ast/node/array_node.rb +10 -1
  12. data/lib/rubocop/ast/node/block_node.rb +9 -0
  13. data/lib/rubocop/ast/node/def_node.rb +71 -0
  14. data/lib/rubocop/ast/node/for_node.rb +8 -0
  15. data/lib/rubocop/ast/node/if_node.rb +10 -2
  16. data/lib/rubocop/ast/node/mixin/basic_literal_node.rb +16 -0
  17. data/lib/rubocop/ast/node/mixin/collection_node.rb +15 -0
  18. data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +174 -0
  19. data/lib/rubocop/ast/node/mixin/method_identifier_predicates.rb +89 -0
  20. data/lib/rubocop/ast/node/mixin/parameterized_node.rb +18 -31
  21. data/lib/rubocop/ast/node/regexp_node.rb +35 -0
  22. data/lib/rubocop/ast/node/send_node.rb +21 -150
  23. data/lib/rubocop/ast/node/str_node.rb +14 -0
  24. data/lib/rubocop/ast/node/super_node.rb +3 -24
  25. data/lib/rubocop/ast/node/symbol_node.rb +20 -0
  26. data/lib/rubocop/ast/node/yield_node.rb +21 -0
  27. data/lib/rubocop/ast/traversal.rb +7 -7
  28. data/lib/rubocop/cached_data.rb +1 -6
  29. data/lib/rubocop/cli.rb +59 -13
  30. data/lib/rubocop/comment_config.rb +2 -5
  31. data/lib/rubocop/config.rb +136 -29
  32. data/lib/rubocop/config_loader.rb +61 -104
  33. data/lib/rubocop/config_loader_resolver.rb +102 -4
  34. data/lib/rubocop/cop/autocorrect_logic.rb +1 -1
  35. data/lib/rubocop/cop/bundler/duplicated_gem.rb +13 -11
  36. data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +67 -0
  37. data/lib/rubocop/cop/bundler/ordered_gems.rb +7 -58
  38. data/lib/rubocop/cop/commissioner.rb +6 -3
  39. data/lib/rubocop/cop/cop.rb +11 -6
  40. data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +102 -0
  41. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +97 -0
  42. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +87 -0
  43. data/lib/rubocop/cop/generator.rb +122 -25
  44. data/lib/rubocop/cop/internal_affairs.rb +6 -2
  45. data/lib/rubocop/cop/internal_affairs/node_destructuring.rb +46 -0
  46. data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +16 -5
  47. data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb +54 -0
  48. data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +59 -0
  49. data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +71 -0
  50. data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +3 -3
  51. data/lib/rubocop/cop/layout/access_modifier_indentation.rb +6 -10
  52. data/lib/rubocop/cop/layout/align_array.rb +2 -2
  53. data/lib/rubocop/cop/layout/align_hash.rb +18 -18
  54. data/lib/rubocop/cop/layout/align_parameters.rb +11 -23
  55. data/lib/rubocop/cop/layout/block_end_newline.rb +20 -6
  56. data/lib/rubocop/cop/layout/case_indentation.rb +15 -18
  57. data/lib/rubocop/cop/layout/class_structure.rb +306 -0
  58. data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +7 -6
  59. data/lib/rubocop/cop/layout/comment_indentation.rb +42 -3
  60. data/lib/rubocop/cop/layout/dot_position.rb +31 -13
  61. data/lib/rubocop/cop/layout/else_alignment.rb +37 -17
  62. data/lib/rubocop/cop/layout/empty_line_after_magic_comment.rb +1 -1
  63. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +22 -18
  64. data/lib/rubocop/cop/layout/empty_lines.rb +16 -2
  65. data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +23 -6
  66. data/lib/rubocop/cop/layout/empty_lines_around_arguments.rb +89 -0
  67. data/lib/rubocop/cop/layout/empty_lines_around_begin_body.rb +2 -2
  68. data/lib/rubocop/cop/layout/empty_lines_around_block_body.rb +4 -8
  69. data/lib/rubocop/cop/layout/empty_lines_around_class_body.rb +30 -5
  70. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +10 -6
  71. data/lib/rubocop/cop/layout/empty_lines_around_method_body.rb +5 -5
  72. data/lib/rubocop/cop/layout/empty_lines_around_module_body.rb +22 -7
  73. data/lib/rubocop/cop/layout/end_of_line.rb +2 -2
  74. data/lib/rubocop/cop/layout/extra_spacing.rb +23 -26
  75. data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb +3 -3
  76. data/lib/rubocop/cop/layout/first_parameter_indentation.rb +9 -3
  77. data/lib/rubocop/cop/layout/indent_array.rb +68 -21
  78. data/lib/rubocop/cop/layout/indent_hash.rb +71 -26
  79. data/lib/rubocop/cop/layout/indent_heredoc.rb +70 -35
  80. data/lib/rubocop/cop/layout/indentation_consistency.rb +1 -2
  81. data/lib/rubocop/cop/layout/indentation_width.rb +40 -27
  82. data/lib/rubocop/cop/layout/initial_indentation.rb +10 -7
  83. data/lib/rubocop/cop/layout/leading_comment_space.rb +32 -17
  84. data/lib/rubocop/cop/layout/multiline_array_brace_layout.rb +47 -14
  85. data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +12 -11
  86. data/lib/rubocop/cop/layout/multiline_block_layout.rb +19 -16
  87. data/lib/rubocop/cop/layout/multiline_hash_brace_layout.rb +46 -13
  88. data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +29 -27
  89. data/lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb +7 -3
  90. data/lib/rubocop/cop/layout/multiline_operation_indentation.rb +6 -0
  91. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +12 -4
  92. data/lib/rubocop/cop/layout/space_after_colon.rb +13 -6
  93. data/lib/rubocop/cop/layout/space_after_comma.rb +11 -1
  94. data/lib/rubocop/cop/layout/space_after_method_name.rb +8 -6
  95. data/lib/rubocop/cop/layout/space_after_not.rb +1 -1
  96. data/lib/rubocop/cop/layout/space_after_semicolon.rb +8 -1
  97. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +32 -25
  98. data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb +28 -17
  99. data/lib/rubocop/cop/layout/space_around_keyword.rb +22 -16
  100. data/lib/rubocop/cop/layout/space_around_operators.rb +27 -14
  101. data/lib/rubocop/cop/layout/space_before_block_braces.rb +61 -12
  102. data/lib/rubocop/cop/layout/space_before_comma.rb +12 -1
  103. data/lib/rubocop/cop/layout/space_before_comment.rb +10 -5
  104. data/lib/rubocop/cop/layout/space_before_first_arg.rb +5 -4
  105. data/lib/rubocop/cop/layout/space_before_semicolon.rb +8 -1
  106. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +12 -14
  107. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +235 -0
  108. data/lib/rubocop/cop/layout/space_inside_array_percent_literal.rb +4 -4
  109. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +89 -18
  110. data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +62 -36
  111. data/lib/rubocop/cop/layout/space_inside_parens.rb +40 -3
  112. data/lib/rubocop/cop/layout/space_inside_percent_literal_delimiters.rb +1 -1
  113. data/lib/rubocop/cop/layout/space_inside_range_literal.rb +15 -15
  114. data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +81 -0
  115. data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +32 -17
  116. data/lib/rubocop/cop/layout/tab.rb +7 -4
  117. data/lib/rubocop/cop/layout/trailing_blank_lines.rb +11 -9
  118. data/lib/rubocop/cop/layout/trailing_whitespace.rb +1 -1
  119. data/lib/rubocop/cop/lint/ambiguous_block_association.rb +12 -19
  120. data/lib/rubocop/cop/lint/assignment_in_condition.rb +16 -2
  121. data/lib/rubocop/cop/lint/block_alignment.rb +42 -30
  122. data/lib/rubocop/cop/lint/boolean_symbol.rb +38 -0
  123. data/lib/rubocop/cop/lint/circular_argument_reference.rb +3 -14
  124. data/lib/rubocop/cop/lint/condition_position.rb +5 -1
  125. data/lib/rubocop/cop/lint/debugger.rb +18 -11
  126. data/lib/rubocop/cop/lint/def_end_alignment.rb +9 -14
  127. data/lib/rubocop/cop/lint/deprecated_class_methods.rb +4 -4
  128. data/lib/rubocop/cop/lint/duplicate_case_condition.rb +3 -3
  129. data/lib/rubocop/cop/lint/duplicate_methods.rb +75 -5
  130. data/lib/rubocop/cop/lint/duplicated_key.rb +1 -1
  131. data/lib/rubocop/cop/lint/each_with_object_argument.rb +1 -1
  132. data/lib/rubocop/cop/lint/else_layout.rb +3 -3
  133. data/lib/rubocop/cop/lint/empty_ensure.rb +1 -1
  134. data/lib/rubocop/cop/lint/empty_expression.rb +1 -1
  135. data/lib/rubocop/cop/lint/empty_interpolation.rb +1 -1
  136. data/lib/rubocop/cop/lint/empty_when.rb +1 -1
  137. data/lib/rubocop/cop/lint/end_alignment.rb +13 -14
  138. data/lib/rubocop/cop/lint/end_in_method.rb +1 -1
  139. data/lib/rubocop/cop/lint/ensure_return.rb +1 -1
  140. data/lib/rubocop/cop/lint/float_out_of_range.rb +5 -5
  141. data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +36 -41
  142. data/lib/rubocop/cop/lint/handle_exceptions.rb +1 -1
  143. data/lib/rubocop/cop/lint/implicit_string_concatenation.rb +1 -1
  144. data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +25 -20
  145. data/lib/rubocop/cop/lint/inherit_exception.rb +16 -19
  146. data/lib/rubocop/cop/lint/interpolation_check.rb +37 -0
  147. data/lib/rubocop/cop/lint/{literal_in_condition.rb → literal_as_condition.rb} +21 -7
  148. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +1 -1
  149. data/lib/rubocop/cop/lint/loop.rb +1 -1
  150. data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +81 -0
  151. data/lib/rubocop/cop/lint/multiple_compare.rb +1 -1
  152. data/lib/rubocop/cop/lint/nested_method_definition.rb +6 -8
  153. data/lib/rubocop/cop/lint/nested_percent_literal.rb +58 -0
  154. data/lib/rubocop/cop/lint/next_without_accumulator.rb +1 -1
  155. data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +4 -4
  156. data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +4 -3
  157. data/lib/rubocop/cop/lint/percent_string_array.rb +13 -22
  158. data/lib/rubocop/cop/lint/percent_symbol_array.rb +12 -12
  159. data/lib/rubocop/cop/lint/rand_one.rb +8 -2
  160. data/lib/rubocop/cop/lint/redundant_with_index.rb +80 -0
  161. data/lib/rubocop/cop/lint/redundant_with_object.rb +81 -0
  162. data/lib/rubocop/cop/lint/regexp_as_condition.rb +29 -0
  163. data/lib/rubocop/cop/lint/require_parentheses.rb +5 -3
  164. data/lib/rubocop/cop/lint/rescue_exception.rb +1 -1
  165. data/lib/rubocop/cop/lint/rescue_type.rb +18 -9
  166. data/lib/rubocop/cop/lint/return_in_void_context.rb +74 -0
  167. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +1 -1
  168. data/lib/rubocop/cop/lint/script_permission.rb +8 -1
  169. data/lib/rubocop/cop/lint/shadowed_argument.rb +146 -0
  170. data/lib/rubocop/cop/lint/shadowed_exception.rb +37 -10
  171. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +1 -1
  172. data/lib/rubocop/cop/lint/string_conversion_in_interpolation.rb +7 -7
  173. data/lib/rubocop/cop/lint/syntax.rb +23 -20
  174. data/lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb +1 -1
  175. data/lib/rubocop/cop/lint/unified_integer.rb +5 -4
  176. data/lib/rubocop/cop/lint/unneeded_disable.rb +41 -16
  177. data/lib/rubocop/cop/lint/unneeded_require_statement.rb +51 -0
  178. data/lib/rubocop/cop/lint/unneeded_splat_expansion.rb +45 -19
  179. data/lib/rubocop/cop/lint/unreachable_code.rb +53 -8
  180. data/lib/rubocop/cop/lint/unused_method_argument.rb +2 -1
  181. data/lib/rubocop/cop/lint/uri_escape_unescape.rb +74 -0
  182. data/lib/rubocop/cop/lint/uri_regexp.rb +73 -0
  183. data/lib/rubocop/cop/lint/useless_access_modifier.rb +12 -16
  184. data/lib/rubocop/cop/lint/useless_assignment.rb +1 -1
  185. data/lib/rubocop/cop/lint/useless_comparison.rb +1 -1
  186. data/lib/rubocop/cop/lint/useless_setter_call.rb +15 -12
  187. data/lib/rubocop/cop/lint/void.rb +38 -27
  188. data/lib/rubocop/cop/message_annotator.rb +4 -2
  189. data/lib/rubocop/cop/metrics/abc_size.rb +2 -2
  190. data/lib/rubocop/cop/metrics/block_nesting.rb +1 -1
  191. data/lib/rubocop/cop/metrics/class_length.rb +3 -1
  192. data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +2 -1
  193. data/lib/rubocop/cop/metrics/line_length.rb +8 -5
  194. data/lib/rubocop/cop/metrics/method_length.rb +8 -3
  195. data/lib/rubocop/cop/metrics/module_length.rb +3 -1
  196. data/lib/rubocop/cop/metrics/parameter_lists.rb +14 -5
  197. data/lib/rubocop/cop/metrics/perceived_complexity.rb +2 -1
  198. data/lib/rubocop/cop/mixin/array_hash_indentation.rb +3 -2
  199. data/lib/rubocop/cop/mixin/autocorrect_alignment.rb +2 -2
  200. data/lib/rubocop/cop/mixin/code_length.rb +1 -1
  201. data/lib/rubocop/cop/mixin/configurable_formatting.rb +1 -1
  202. data/lib/rubocop/cop/mixin/def_node.rb +1 -1
  203. data/lib/rubocop/cop/mixin/documentation_comment.rb +1 -1
  204. data/lib/rubocop/cop/mixin/empty_lines_around_body.rb +14 -7
  205. data/lib/rubocop/cop/mixin/empty_parameter.rb +23 -0
  206. data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +8 -4
  207. data/lib/rubocop/cop/mixin/enforce_superclass.rb +3 -3
  208. data/lib/rubocop/cop/mixin/first_element_line_break.rb +12 -3
  209. data/lib/rubocop/cop/mixin/heredoc.rb +28 -0
  210. data/lib/rubocop/cop/mixin/method_complexity.rb +33 -7
  211. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +74 -33
  212. data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb +34 -8
  213. data/lib/rubocop/cop/mixin/negative_conditional.rb +4 -1
  214. data/lib/rubocop/cop/mixin/ordered_gem_node.rb +67 -0
  215. data/lib/rubocop/cop/mixin/parentheses.rb +12 -0
  216. data/lib/rubocop/cop/mixin/parser_diagnostic.rb +4 -1
  217. data/lib/rubocop/cop/mixin/percent_array.rb +52 -0
  218. data/lib/rubocop/cop/mixin/space_after_punctuation.rb +9 -8
  219. data/lib/rubocop/cop/mixin/space_before_punctuation.rb +11 -10
  220. data/lib/rubocop/cop/mixin/statement_modifier.rb +7 -17
  221. data/lib/rubocop/cop/mixin/string_help.rb +1 -1
  222. data/lib/rubocop/cop/mixin/string_literals_help.rb +1 -1
  223. data/lib/rubocop/cop/mixin/surrounding_space.rb +95 -8
  224. data/lib/rubocop/cop/mixin/too_many_lines.rb +2 -2
  225. data/lib/rubocop/cop/mixin/trailing_comma.rb +25 -17
  226. data/lib/rubocop/cop/mixin/unused_argument.rb +6 -2
  227. data/lib/rubocop/cop/naming/accessor_method_name.rb +55 -0
  228. data/lib/rubocop/cop/{style → naming}/ascii_identifiers.rb +35 -2
  229. data/lib/rubocop/cop/{style/op_method.rb → naming/binary_operator_parameter_name.rb} +7 -6
  230. data/lib/rubocop/cop/naming/class_and_module_camel_case.rb +33 -0
  231. data/lib/rubocop/cop/naming/constant_name.rb +58 -0
  232. data/lib/rubocop/cop/{style → naming}/file_name.rb +28 -13
  233. data/lib/rubocop/cop/naming/heredoc_delimiter_case.rb +62 -0
  234. data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb +59 -0
  235. data/lib/rubocop/cop/naming/method_name.rb +40 -0
  236. data/lib/rubocop/cop/naming/predicate_name.rb +101 -0
  237. data/lib/rubocop/cop/naming/variable_name.rb +50 -0
  238. data/lib/rubocop/cop/{style → naming}/variable_number.rb +11 -28
  239. data/lib/rubocop/cop/offense.rb +6 -1
  240. data/lib/rubocop/cop/performance/caller.rb +39 -11
  241. data/lib/rubocop/cop/performance/case_when_splat.rb +3 -7
  242. data/lib/rubocop/cop/performance/casecmp.rb +9 -8
  243. data/lib/rubocop/cop/performance/compare_with_block.rb +23 -13
  244. data/lib/rubocop/cop/performance/count.rb +7 -4
  245. data/lib/rubocop/cop/performance/detect.rb +9 -6
  246. data/lib/rubocop/cop/performance/double_start_end_with.rb +12 -20
  247. data/lib/rubocop/cop/performance/end_with.rb +6 -6
  248. data/lib/rubocop/cop/performance/fixed_size.rb +1 -1
  249. data/lib/rubocop/cop/performance/flat_map.rb +5 -2
  250. data/lib/rubocop/cop/performance/hash_each_methods.rb +85 -40
  251. data/lib/rubocop/cop/performance/lstrip_rstrip.rb +9 -6
  252. data/lib/rubocop/cop/performance/range_include.rb +3 -3
  253. data/lib/rubocop/cop/performance/redundant_block_call.rb +28 -28
  254. data/lib/rubocop/cop/performance/redundant_match.rb +13 -12
  255. data/lib/rubocop/cop/performance/redundant_merge.rb +44 -26
  256. data/lib/rubocop/cop/performance/redundant_sort_by.rb +9 -6
  257. data/lib/rubocop/cop/performance/regexp_match.rb +19 -10
  258. data/lib/rubocop/cop/performance/reverse_each.rb +1 -1
  259. data/lib/rubocop/cop/performance/sample.rb +1 -1
  260. data/lib/rubocop/cop/performance/size.rb +3 -3
  261. data/lib/rubocop/cop/performance/start_with.rb +6 -6
  262. data/lib/rubocop/cop/performance/string_replacement.rb +6 -6
  263. data/lib/rubocop/cop/performance/times_map.rb +32 -22
  264. data/lib/rubocop/cop/performance/unfreeze_string.rb +50 -0
  265. data/lib/rubocop/cop/performance/uri_default_parser.rb +47 -0
  266. data/lib/rubocop/cop/rails/action_filter.rb +23 -1
  267. data/lib/rubocop/cop/rails/active_support_aliases.rb +4 -5
  268. data/lib/rubocop/cop/rails/application_job.rb +5 -3
  269. data/lib/rubocop/cop/rails/application_record.rb +5 -3
  270. data/lib/rubocop/cop/rails/blank.rb +20 -17
  271. data/lib/rubocop/cop/rails/create_table_with_timestamps.rb +82 -0
  272. data/lib/rubocop/cop/rails/date.rb +7 -6
  273. data/lib/rubocop/cop/rails/delegate.rb +53 -29
  274. data/lib/rubocop/cop/rails/delegate_allow_blank.rb +4 -4
  275. data/lib/rubocop/cop/rails/dynamic_find_by.rb +2 -2
  276. data/lib/rubocop/cop/rails/enum_uniqueness.rb +4 -4
  277. data/lib/rubocop/cop/rails/environment_comparison.rb +66 -0
  278. data/lib/rubocop/cop/rails/exit.rb +8 -1
  279. data/lib/rubocop/cop/rails/file_path.rb +8 -11
  280. data/lib/rubocop/cop/rails/find_by.rb +2 -1
  281. data/lib/rubocop/cop/rails/find_each.rb +1 -1
  282. data/lib/rubocop/cop/rails/has_and_belongs_to_many.rb +8 -1
  283. data/lib/rubocop/cop/rails/has_many_or_has_one_dependent.rb +76 -0
  284. data/lib/rubocop/cop/rails/http_positional_arguments.rb +40 -44
  285. data/lib/rubocop/cop/rails/inverse_of.rb +96 -0
  286. data/lib/rubocop/cop/rails/lexically_scoped_action_filter.rb +112 -0
  287. data/lib/rubocop/cop/rails/not_null_column.rb +6 -6
  288. data/lib/rubocop/cop/rails/output.rb +11 -2
  289. data/lib/rubocop/cop/rails/output_safety.rb +16 -21
  290. data/lib/rubocop/cop/rails/pluralization_grammar.rb +10 -10
  291. data/lib/rubocop/cop/rails/presence.rb +105 -0
  292. data/lib/rubocop/cop/rails/present.rb +14 -17
  293. data/lib/rubocop/cop/rails/read_write_attribute.rb +13 -13
  294. data/lib/rubocop/cop/rails/redundant_receiver_in_with_options.rb +91 -0
  295. data/lib/rubocop/cop/rails/relative_date_constant.rb +11 -11
  296. data/lib/rubocop/cop/rails/request_referer.rb +3 -3
  297. data/lib/rubocop/cop/rails/reversible_migration.rb +36 -35
  298. data/lib/rubocop/cop/rails/safe_navigation.rb +7 -8
  299. data/lib/rubocop/cop/rails/save_bang.rb +19 -17
  300. data/lib/rubocop/cop/rails/scope_args.rb +2 -2
  301. data/lib/rubocop/cop/rails/skips_model_validations.rb +2 -2
  302. data/lib/rubocop/cop/rails/time_zone.rb +3 -2
  303. data/lib/rubocop/cop/rails/uniq_before_pluck.rb +4 -2
  304. data/lib/rubocop/cop/rails/unknown_env.rb +63 -0
  305. data/lib/rubocop/cop/rails/validation.rb +8 -8
  306. data/lib/rubocop/cop/registry.rb +2 -1
  307. data/lib/rubocop/cop/security/eval.rb +4 -4
  308. data/lib/rubocop/cop/security/json_load.rb +7 -5
  309. data/lib/rubocop/cop/security/marshal_load.rb +8 -6
  310. data/lib/rubocop/cop/security/yaml_load.rb +4 -4
  311. data/lib/rubocop/cop/style/alias.rb +49 -27
  312. data/lib/rubocop/cop/style/and_or.rb +65 -45
  313. data/lib/rubocop/cop/style/array_join.rb +10 -1
  314. data/lib/rubocop/cop/style/ascii_comments.rb +24 -4
  315. data/lib/rubocop/cop/style/attr.rb +15 -5
  316. data/lib/rubocop/cop/style/auto_resource_cleanup.rb +7 -5
  317. data/lib/rubocop/cop/style/bare_percent_literals.rb +31 -10
  318. data/lib/rubocop/cop/style/begin_block.rb +1 -1
  319. data/lib/rubocop/cop/style/block_comments.rb +17 -3
  320. data/lib/rubocop/cop/style/block_delimiters.rb +82 -16
  321. data/lib/rubocop/cop/style/braces_around_hash_parameters.rb +68 -32
  322. data/lib/rubocop/cop/style/case_equality.rb +13 -1
  323. data/lib/rubocop/cop/style/character_literal.rb +10 -0
  324. data/lib/rubocop/cop/style/class_and_module_children.rb +8 -4
  325. data/lib/rubocop/cop/style/class_check.rb +29 -10
  326. data/lib/rubocop/cop/style/class_methods.rb +10 -9
  327. data/lib/rubocop/cop/style/class_vars.rb +5 -4
  328. data/lib/rubocop/cop/style/collection_methods.rb +5 -3
  329. data/lib/rubocop/cop/style/colon_method_call.rb +18 -2
  330. data/lib/rubocop/cop/style/colon_method_definition.rb +36 -0
  331. data/lib/rubocop/cop/style/command_literal.rb +90 -30
  332. data/lib/rubocop/cop/style/comment_annotation.rb +39 -11
  333. data/lib/rubocop/cop/style/commented_keyword.rb +84 -0
  334. data/lib/rubocop/cop/style/conditional_assignment.rb +41 -41
  335. data/lib/rubocop/cop/style/copyright.rb +27 -28
  336. data/lib/rubocop/cop/style/date_time.rb +44 -0
  337. data/lib/rubocop/cop/style/def_with_parentheses.rb +31 -5
  338. data/lib/rubocop/cop/style/dir.rb +48 -0
  339. data/lib/rubocop/cop/style/documentation.rb +17 -2
  340. data/lib/rubocop/cop/style/documentation_method.rb +2 -6
  341. data/lib/rubocop/cop/style/double_negation.rb +1 -1
  342. data/lib/rubocop/cop/style/each_for_simple_loop.rb +8 -8
  343. data/lib/rubocop/cop/style/each_with_object.rb +6 -5
  344. data/lib/rubocop/cop/style/empty_block_parameter.rb +47 -0
  345. data/lib/rubocop/cop/style/empty_case_condition.rb +3 -3
  346. data/lib/rubocop/cop/style/empty_else.rb +55 -24
  347. data/lib/rubocop/cop/style/empty_lambda_parameter.rb +43 -0
  348. data/lib/rubocop/cop/style/empty_literal.rb +25 -14
  349. data/lib/rubocop/cop/style/empty_method.rb +29 -25
  350. data/lib/rubocop/cop/style/encoding.rb +8 -51
  351. data/lib/rubocop/cop/style/end_block.rb +1 -1
  352. data/lib/rubocop/cop/style/eval_with_location.rb +146 -0
  353. data/lib/rubocop/cop/style/even_odd.rb +4 -2
  354. data/lib/rubocop/cop/style/extend_self.rb +92 -0
  355. data/lib/rubocop/cop/style/flip_flop.rb +13 -2
  356. data/lib/rubocop/cop/style/for.rb +6 -2
  357. data/lib/rubocop/cop/style/format_string.rb +33 -5
  358. data/lib/rubocop/cop/style/format_string_token.rb +17 -15
  359. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +7 -6
  360. data/lib/rubocop/cop/style/global_vars.rb +12 -2
  361. data/lib/rubocop/cop/style/guard_clause.rb +6 -4
  362. data/lib/rubocop/cop/style/hash_syntax.rb +56 -56
  363. data/lib/rubocop/cop/style/identical_conditional_branches.rb +12 -8
  364. data/lib/rubocop/cop/style/if_inside_else.rb +11 -11
  365. data/lib/rubocop/cop/style/if_unless_modifier.rb +8 -7
  366. data/lib/rubocop/cop/style/if_unless_modifier_of_if_unless.rb +3 -2
  367. data/lib/rubocop/cop/style/if_with_semicolon.rb +10 -1
  368. data/lib/rubocop/cop/style/implicit_runtime_error.rb +7 -6
  369. data/lib/rubocop/cop/style/infinite_loop.rb +4 -4
  370. data/lib/rubocop/cop/style/inline_comment.rb +1 -1
  371. data/lib/rubocop/cop/style/inverse_methods.rb +24 -14
  372. data/lib/rubocop/cop/style/lambda.rb +45 -43
  373. data/lib/rubocop/cop/style/lambda_call.rb +37 -10
  374. data/lib/rubocop/cop/style/line_end_concatenation.rb +5 -5
  375. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +3 -19
  376. data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb +6 -4
  377. data/lib/rubocop/cop/style/method_called_on_do_end_block.rb +1 -1
  378. data/lib/rubocop/cop/style/method_def_parentheses.rb +20 -25
  379. data/lib/rubocop/cop/style/method_missing.rb +13 -26
  380. data/lib/rubocop/cop/style/min_max.rb +68 -0
  381. data/lib/rubocop/cop/style/missing_else.rb +20 -6
  382. data/lib/rubocop/cop/style/mixin_grouping.rb +31 -21
  383. data/lib/rubocop/cop/style/mixin_usage.rb +71 -0
  384. data/lib/rubocop/cop/style/module_function.rb +27 -11
  385. data/lib/rubocop/cop/style/multiline_block_chain.rb +1 -1
  386. data/lib/rubocop/cop/style/multiline_if_modifier.rb +8 -4
  387. data/lib/rubocop/cop/style/multiline_if_then.rb +15 -13
  388. data/lib/rubocop/cop/style/multiline_memoization.rb +33 -17
  389. data/lib/rubocop/cop/style/multiline_ternary_operator.rb +1 -1
  390. data/lib/rubocop/cop/style/multiple_comparison.rb +1 -1
  391. data/lib/rubocop/cop/style/mutable_constant.rb +11 -15
  392. data/lib/rubocop/cop/style/negated_if.rb +27 -31
  393. data/lib/rubocop/cop/style/negated_while.rb +1 -5
  394. data/lib/rubocop/cop/style/nested_modifier.rb +1 -1
  395. data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +26 -23
  396. data/lib/rubocop/cop/style/nested_ternary_operator.rb +1 -1
  397. data/lib/rubocop/cop/style/next.rb +41 -12
  398. data/lib/rubocop/cop/style/nil_comparison.rb +8 -8
  399. data/lib/rubocop/cop/style/non_nil_check.rb +41 -38
  400. data/lib/rubocop/cop/style/not.rb +15 -5
  401. data/lib/rubocop/cop/style/numeric_literal_prefix.rb +8 -4
  402. data/lib/rubocop/cop/style/numeric_literals.rb +9 -9
  403. data/lib/rubocop/cop/style/numeric_predicate.rb +21 -21
  404. data/lib/rubocop/cop/style/one_line_conditional.rb +9 -4
  405. data/lib/rubocop/cop/style/option_hash.rb +11 -25
  406. data/lib/rubocop/cop/style/optional_arguments.rb +1 -2
  407. data/lib/rubocop/cop/style/or_assignment.rb +88 -0
  408. data/lib/rubocop/cop/style/parallel_assignment.rb +16 -16
  409. data/lib/rubocop/cop/style/parentheses_around_condition.rb +30 -13
  410. data/lib/rubocop/cop/style/percent_literal_delimiters.rb +25 -4
  411. data/lib/rubocop/cop/style/percent_q_literals.rb +29 -8
  412. data/lib/rubocop/cop/style/perl_backrefs.rb +8 -1
  413. data/lib/rubocop/cop/style/preferred_hash_methods.rb +7 -11
  414. data/lib/rubocop/cop/style/proc.rb +10 -2
  415. data/lib/rubocop/cop/style/raise_args.rb +22 -29
  416. data/lib/rubocop/cop/style/random_with_offset.rb +160 -0
  417. data/lib/rubocop/cop/style/redundant_begin.rb +16 -5
  418. data/lib/rubocop/cop/style/redundant_conditional.rb +96 -0
  419. data/lib/rubocop/cop/style/redundant_exception.rb +4 -4
  420. data/lib/rubocop/cop/style/redundant_freeze.rb +1 -1
  421. data/lib/rubocop/cop/style/redundant_parentheses.rb +14 -12
  422. data/lib/rubocop/cop/style/redundant_return.rb +28 -15
  423. data/lib/rubocop/cop/style/redundant_self.rb +35 -27
  424. data/lib/rubocop/cop/style/regexp_literal.rb +88 -27
  425. data/lib/rubocop/cop/style/rescue_modifier.rb +12 -1
  426. data/lib/rubocop/cop/style/rescue_standard_error.rb +122 -0
  427. data/lib/rubocop/cop/style/return_nil.rb +89 -0
  428. data/lib/rubocop/cop/style/safe_navigation.rb +100 -48
  429. data/lib/rubocop/cop/style/self_assignment.rb +13 -13
  430. data/lib/rubocop/cop/style/semicolon.rb +19 -9
  431. data/lib/rubocop/cop/style/send.rb +10 -1
  432. data/lib/rubocop/cop/style/signal_exception.rb +104 -3
  433. data/lib/rubocop/cop/style/single_line_block_params.rb +16 -15
  434. data/lib/rubocop/cop/style/single_line_methods.rb +26 -18
  435. data/lib/rubocop/cop/style/special_global_vars.rb +19 -14
  436. data/lib/rubocop/cop/style/stabby_lambda_parentheses.rb +23 -50
  437. data/lib/rubocop/cop/style/stderr_puts.rb +54 -0
  438. data/lib/rubocop/cop/style/string_hash_keys.rb +36 -0
  439. data/lib/rubocop/cop/style/string_literals.rb +26 -3
  440. data/lib/rubocop/cop/style/string_literals_in_interpolation.rb +16 -1
  441. data/lib/rubocop/cop/style/string_methods.rb +19 -8
  442. data/lib/rubocop/cop/style/struct_inheritance.rb +3 -3
  443. data/lib/rubocop/cop/style/symbol_array.rb +7 -35
  444. data/lib/rubocop/cop/style/symbol_literal.rb +1 -1
  445. data/lib/rubocop/cop/style/symbol_proc.rb +11 -25
  446. data/lib/rubocop/cop/style/ternary_parentheses.rb +46 -51
  447. data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb +101 -0
  448. data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +20 -6
  449. data/lib/rubocop/cop/style/trailing_comma_in_literal.rb +22 -7
  450. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +95 -0
  451. data/lib/rubocop/cop/style/trailing_underscore_variable.rb +70 -24
  452. data/lib/rubocop/cop/style/trivial_accessors.rb +72 -65
  453. data/lib/rubocop/cop/style/unless_else.rb +16 -1
  454. data/lib/rubocop/cop/style/unneeded_capital_w.rb +18 -8
  455. data/lib/rubocop/cop/style/unneeded_interpolation.rb +15 -19
  456. data/lib/rubocop/cop/style/unneeded_percent_q.rb +14 -13
  457. data/lib/rubocop/cop/style/variable_interpolation.rb +23 -9
  458. data/lib/rubocop/cop/style/when_then.rb +14 -1
  459. data/lib/rubocop/cop/style/while_until_do.rb +27 -4
  460. data/lib/rubocop/cop/style/while_until_modifier.rb +26 -6
  461. data/lib/rubocop/cop/style/word_array.rb +9 -30
  462. data/lib/rubocop/cop/style/yoda_condition.rb +51 -22
  463. data/lib/rubocop/cop/style/zero_length_predicate.rb +44 -29
  464. data/lib/rubocop/cop/team.rb +16 -8
  465. data/lib/rubocop/cop/util.rb +43 -34
  466. data/lib/rubocop/cop/variable_force.rb +1 -1
  467. data/lib/rubocop/cop/variable_force/assignment.rb +4 -2
  468. data/lib/rubocop/cop/variable_force/scope.rb +1 -5
  469. data/lib/rubocop/cop/variable_force/variable.rb +1 -1
  470. data/lib/rubocop/formatter/disabled_config_formatter.rb +3 -4
  471. data/lib/rubocop/formatter/formatter_set.rb +3 -1
  472. data/lib/rubocop/formatter/html_formatter.rb +1 -1
  473. data/lib/rubocop/formatter/json_formatter.rb +9 -3
  474. data/lib/rubocop/formatter/offense_count_formatter.rb +2 -0
  475. data/lib/rubocop/formatter/quiet_formatter.rb +13 -0
  476. data/lib/rubocop/formatter/simple_text_formatter.rb +3 -3
  477. data/lib/rubocop/formatter/tap_formatter.rb +71 -0
  478. data/lib/rubocop/formatter/worst_offenders_formatter.rb +2 -0
  479. data/lib/rubocop/node_pattern.rb +46 -29
  480. data/lib/rubocop/options.rb +13 -8
  481. data/lib/rubocop/path_util.rb +15 -3
  482. data/lib/rubocop/processed_source.rb +8 -9
  483. data/lib/rubocop/rake_task.rb +16 -23
  484. data/lib/rubocop/remote_config.rb +13 -1
  485. data/lib/rubocop/result_cache.rb +1 -0
  486. data/lib/rubocop/rspec/cop_helper.rb +10 -10
  487. data/lib/rubocop/rspec/expect_offense.rb +6 -8
  488. data/lib/rubocop/rspec/shared_contexts.rb +4 -8
  489. data/lib/rubocop/rspec/shared_examples.rb +8 -8
  490. data/lib/rubocop/rspec/support.rb +5 -5
  491. data/lib/rubocop/runner.rb +1 -1
  492. data/lib/rubocop/string_util.rb +2 -0
  493. data/lib/rubocop/token.rb +74 -0
  494. data/lib/rubocop/version.rb +1 -1
  495. metadata +118 -48
  496. data/lib/rubocop/cop/layout/space_inside_brackets.rb +0 -20
  497. data/lib/rubocop/cop/lint/invalid_character_literal.rb +0 -41
  498. data/lib/rubocop/cop/mixin/access_modifier_node.rb +0 -41
  499. data/lib/rubocop/cop/mixin/on_method_def.rb +0 -44
  500. data/lib/rubocop/cop/mixin/space_inside.rb +0 -76
  501. data/lib/rubocop/cop/style/accessor_method_name.rb +0 -45
  502. data/lib/rubocop/cop/style/class_and_module_camel_case.rb +0 -29
  503. data/lib/rubocop/cop/style/constant_name.rb +0 -29
  504. data/lib/rubocop/cop/style/method_name.rb +0 -34
  505. data/lib/rubocop/cop/style/predicate_name.rb +0 -67
  506. data/lib/rubocop/cop/style/variable_name.rb +0 -39
@@ -8,13 +8,22 @@ module RuboCop
8
8
  # Not all cases can reliably checked, due to Ruby's dynamic
9
9
  # types, so we consider only cases when the first argument is an
10
10
  # array literal or the second is a string literal.
11
+ #
12
+ # @example
13
+ #
14
+ # # bad
15
+ # %w(foo bar baz) * ","
16
+ #
17
+ # # good
18
+ # %w(foo bar bax).join(",")
19
+ #
11
20
  class ArrayJoin < Cop
12
21
  MSG = 'Favor `Array#join` over `Array#*`.'.freeze
13
22
 
14
23
  def_node_matcher :join_candidate?, '(send $array :* $str)'
15
24
 
16
25
  def on_send(node)
17
- join_candidate?(node) { add_offense(node, :selector) }
26
+ join_candidate?(node) { add_offense(node, location: :selector) }
18
27
  end
19
28
 
20
29
  def autocorrect(node)
@@ -1,18 +1,28 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # rubocop:disable Style/AsciiComments
4
+
3
5
  module RuboCop
4
6
  module Cop
5
7
  module Style
6
8
  # This cop checks for non-ascii (non-English) characters
7
- # in comments.
9
+ # in comments. You could set an array of allowed non-ascii chars in
10
+ # AllowedChars attribute (empty by default).
11
+ #
12
+ # @example
13
+ # # bad
14
+ # # Translates from English to 日本語。
15
+ #
16
+ # # good
17
+ # # Translates from English to Japanese
8
18
  class AsciiComments < Cop
9
19
  MSG = 'Use only ascii symbols in comments.'.freeze
10
20
 
11
21
  def investigate(processed_source)
12
22
  processed_source.comments.each do |comment|
13
- unless comment.text.ascii_only?
14
- add_offense(comment, first_offense_range(comment))
15
- end
23
+ next if comment.text.ascii_only?
24
+ next if only_allowed_non_ascii_chars?(comment.text)
25
+ add_offense(comment, location: first_offense_range(comment))
16
26
  end
17
27
  end
18
28
 
@@ -32,7 +42,17 @@ module RuboCop
32
42
  def first_non_ascii_chars(string)
33
43
  string.match(/[^[:ascii:]]+/).to_s
34
44
  end
45
+
46
+ def only_allowed_non_ascii_chars?(string)
47
+ non_ascii = string.scan(/[^[:ascii:]]/)
48
+ (non_ascii - allowed_non_ascii_chars).empty?
49
+ end
50
+
51
+ def allowed_non_ascii_chars
52
+ cop_config['AllowedChars'] || []
53
+ end
35
54
  end
36
55
  end
37
56
  end
38
57
  end
58
+ # rubocop:enable Style/AsciiComments
@@ -4,17 +4,25 @@ module RuboCop
4
4
  module Cop
5
5
  module Style
6
6
  # This cop checks for uses of Module#attr.
7
+ #
8
+ # @example
9
+ # # bad - creates a single attribute accessor (deprecated in Ruby 1.9)
10
+ # attr :something, true
11
+ # attr :one, :two, :three # behaves as attr_reader
12
+ #
13
+ # # good
14
+ # attr_accessor :something
15
+ # attr_reader :one, :two, :three
16
+ #
7
17
  class Attr < Cop
8
- MSG = 'Do not use `attr`. Use `%s` instead.'.freeze
18
+ MSG = 'Do not use `attr`. Use `%<replacement>s` instead.'.freeze
9
19
 
10
20
  def on_send(node)
11
21
  return unless node.command?(:attr) && node.arguments?
12
22
 
13
- add_offense(node, :selector)
23
+ add_offense(node, location: :selector)
14
24
  end
15
25
 
16
- private
17
-
18
26
  def autocorrect(node)
19
27
  attr_name, setter = *node.arguments
20
28
 
@@ -31,8 +39,10 @@ module RuboCop
31
39
  end
32
40
  end
33
41
 
42
+ private
43
+
34
44
  def message(node)
35
- format(MSG, replacement_method(node))
45
+ format(MSG, replacement: replacement_method(node))
36
46
  end
37
47
 
38
48
  def replacement_method(node)
@@ -13,11 +13,11 @@ module RuboCop
13
13
  # f = File.open('file')
14
14
  #
15
15
  # # good
16
- # f = File.open('file') do
17
- # ...
16
+ # File.open('file') do |f|
17
+ # # ...
18
18
  # end
19
19
  class AutoResourceCleanup < Cop
20
- MSG = 'Use the block version of `%s.%s`.'.freeze
20
+ MSG = 'Use the block version of `%<class>s.%<method>s`.'.freeze
21
21
 
22
22
  TARGET_METHODS = {
23
23
  File: :open
@@ -32,8 +32,10 @@ module RuboCop
32
32
  next if node.parent && node.parent.block_type?
33
33
  next if node.block_argument?
34
34
 
35
- add_offense(node, :expression,
36
- format(MSG, target_class, target_method))
35
+ add_offense(node,
36
+ message: format(MSG,
37
+ class: target_class,
38
+ method: target_method))
37
39
  end
38
40
  end
39
41
  end
@@ -4,10 +4,29 @@ module RuboCop
4
4
  module Cop
5
5
  module Style
6
6
  # This cop checks if usage of %() or %Q() matches configuration.
7
+ #
8
+ # @example EnforcedStyle: bare_percent (default)
9
+ # # bad
10
+ # %Q(He said: "#{greeting}")
11
+ # %q{She said: 'Hi'}
12
+ #
13
+ # # good
14
+ # %(He said: "#{greeting}")
15
+ # %{She said: 'Hi'}
16
+ #
17
+ # @example EnforcedStyle: percent_q
18
+ # # bad
19
+ # %|He said: "#{greeting}"|
20
+ # %/She said: 'Hi'/
21
+ #
22
+ # # good
23
+ # %Q|He said: "#{greeting}"|
24
+ # %q/She said: 'Hi'/
25
+ #
7
26
  class BarePercentLiterals < Cop
8
27
  include ConfigurableEnforcedStyle
9
28
 
10
- MSG = 'Use `%%%s` instead of `%%%s`.'.freeze
29
+ MSG = 'Use `%%%<good>s` instead of `%%%<bad>s`.'.freeze
11
30
 
12
31
  def on_dstr(node)
13
32
  check(node)
@@ -17,6 +36,14 @@ module RuboCop
17
36
  check(node)
18
37
  end
19
38
 
39
+ def autocorrect(node)
40
+ src = node.loc.begin.source
41
+ replacement = src.start_with?('%Q') ? '%' : '%Q'
42
+ lambda do |corrector|
43
+ corrector.replace(node.loc.begin, src.sub(/%Q?/, replacement))
44
+ end
45
+ end
46
+
20
47
  private
21
48
 
22
49
  def check(node)
@@ -41,15 +68,9 @@ module RuboCop
41
68
  end
42
69
 
43
70
  def add_offense_for_wrong_style(node, good, bad)
44
- add_offense(node, :begin, format(MSG, good, bad))
45
- end
46
-
47
- def autocorrect(node)
48
- src = node.loc.begin.source
49
- replacement = src.start_with?('%Q') ? '%' : '%Q'
50
- lambda do |corrector|
51
- corrector.replace(node.loc.begin, src.sub(/%Q?/, replacement))
52
- end
71
+ add_offense(node, location: :begin, message: format(MSG,
72
+ good: good,
73
+ bad: bad))
53
74
  end
54
75
  end
55
76
  end
@@ -8,7 +8,7 @@ module RuboCop
8
8
  MSG = 'Avoid the use of `BEGIN` blocks.'.freeze
9
9
 
10
10
  def on_preexe(node)
11
- add_offense(node, :keyword)
11
+ add_offense(node, location: :keyword)
12
12
  end
13
13
  end
14
14
  end
@@ -4,6 +4,18 @@ module RuboCop
4
4
  module Cop
5
5
  module Style
6
6
  # This cop looks for uses of block comments (=begin...=end).
7
+ #
8
+ # @example
9
+ # # bad
10
+ # =begin
11
+ # Multiple lines
12
+ # of comments...
13
+ # =end
14
+ #
15
+ # # good
16
+ # # Multiple lines
17
+ # # of comments...
18
+ #
7
19
  class BlockComments < Cop
8
20
  MSG = 'Do not use block comments.'.freeze
9
21
  BEGIN_LENGTH = "=begin\n".length
@@ -11,12 +23,12 @@ module RuboCop
11
23
 
12
24
  def investigate(processed_source)
13
25
  processed_source.comments.each do |comment|
14
- add_offense(comment, :expression) if comment.document?
26
+ next unless comment.document?
27
+
28
+ add_offense(comment)
15
29
  end
16
30
  end
17
31
 
18
- private
19
-
20
32
  def autocorrect(comment)
21
33
  eq_begin, eq_end, contents = parts(comment)
22
34
 
@@ -33,6 +45,8 @@ module RuboCop
33
45
  end
34
46
  end
35
47
 
48
+ private
49
+
36
50
  def parts(comment)
37
51
  expr = comment.loc.expression
38
52
  eq_begin = expr.resize(BEGIN_LENGTH)
@@ -5,6 +5,72 @@ module RuboCop
5
5
  module Style
6
6
  # Check for uses of braces or do/end around single line or
7
7
  # multi-line blocks.
8
+ #
9
+ # @example EnforcedStyle: line_count_based (default)
10
+ # # bad - single line block
11
+ # items.each do |item| item / 5 end
12
+ #
13
+ # # good - single line block
14
+ # items.each { |item| item / 5 }
15
+ #
16
+ # # bad - multi-line block
17
+ # things.map { |thing|
18
+ # something = thing.some_method
19
+ # process(something)
20
+ # }
21
+ #
22
+ # # good - multi-line block
23
+ # things.map do |thing|
24
+ # something = thing.some_method
25
+ # process(something)
26
+ # end
27
+ #
28
+ # @example EnforcedStyle: semantic
29
+ # # Prefer `do...end` over `{...}` for procedural blocks.
30
+ #
31
+ # # return value is used/assigned
32
+ # # bad
33
+ # foo = map do |x|
34
+ # x
35
+ # end
36
+ # puts (map do |x|
37
+ # x
38
+ # end)
39
+ #
40
+ # # return value is not used out of scope
41
+ # # good
42
+ # map do |x|
43
+ # x
44
+ # end
45
+ #
46
+ # # Prefer `{...}` over `do...end` for functional blocks.
47
+ #
48
+ # # return value is not used out of scope
49
+ # # bad
50
+ # each { |x|
51
+ # x
52
+ # }
53
+ #
54
+ # # return value is used/assigned
55
+ # # good
56
+ # foo = map { |x|
57
+ # x
58
+ # }
59
+ # map { |x|
60
+ # x
61
+ # }.inspect
62
+ #
63
+ # @example EnforcedStyle: braces_for_chaining
64
+ # # bad
65
+ # words.each do |word|
66
+ # word.flip.flop
67
+ # end.join("-")
68
+ #
69
+ # # good
70
+ # words.each { |word|
71
+ # word.flip.flop
72
+ # }.join("-")
73
+ #
8
74
  class BlockDelimiters < Cop
9
75
  include ConfigurableEnforcedStyle
10
76
 
@@ -25,13 +91,23 @@ module RuboCop
25
91
  def on_block(node)
26
92
  return if ignored_node?(node)
27
93
 
28
- add_offense(node, :begin) unless proper_block_style?(node)
94
+ add_offense(node, location: :begin) unless proper_block_style?(node)
95
+ end
96
+
97
+ def autocorrect(node)
98
+ return if correction_would_break_code?(node)
99
+
100
+ if node.braces?
101
+ replace_braces_with_do_end(node.loc)
102
+ else
103
+ replace_do_end_with_braces(node.loc)
104
+ end
29
105
  end
30
106
 
31
107
  private
32
108
 
33
109
  def line_count_based_message(node)
34
- if block_length(node) > 0
110
+ if node.multiline?
35
111
  'Avoid using `{...}` for multi-line blocks.'
36
112
  else
37
113
  'Prefer `{...}` over `do...end` for single-line blocks.'
@@ -49,7 +125,7 @@ module RuboCop
49
125
  end
50
126
 
51
127
  def braces_for_chaining_message(node)
52
- if block_length(node) > 0
128
+ if node.multiline?
53
129
  if return_value_chaining?(node)
54
130
  'Prefer `{...}` over `do...end` for multi-line chained blocks.'
55
131
  else
@@ -68,16 +144,6 @@ module RuboCop
68
144
  end
69
145
  end
70
146
 
71
- def autocorrect(node)
72
- return if correction_would_break_code?(node)
73
-
74
- if node.braces?
75
- replace_braces_with_do_end(node.loc)
76
- else
77
- replace_do_end_with_braces(node.loc)
78
- end
79
- end
80
-
81
147
  def replace_braces_with_do_end(loc)
82
148
  b = loc.begin
83
149
  e = loc.end
@@ -111,6 +177,7 @@ module RuboCop
111
177
  range.source_buffer.source[range.begin_pos + length, 1] =~ /\s/
112
178
  end
113
179
 
180
+ # rubocop:disable Metrics/CyclomaticComplexity
114
181
  def get_blocks(node, &block)
115
182
  case node.type
116
183
  when :block
@@ -126,8 +193,8 @@ module RuboCop
126
193
  when :pair
127
194
  node.each_child_node { |child| get_blocks(child, &block) }
128
195
  end
129
- nil
130
196
  end
197
+ # rubocop:enable Metrics/CyclomaticComplexity
131
198
 
132
199
  def proper_block_style?(node)
133
200
  return true if ignored_method?(node.method_name)
@@ -154,10 +221,9 @@ module RuboCop
154
221
  end
155
222
 
156
223
  def braces_for_chaining_style?(node)
157
- block_length = block_length(node)
158
224
  block_begin = node.loc.begin.source
159
225
 
160
- block_begin == if block_length > 0
226
+ block_begin == if node.multiline?
161
227
  (return_value_chaining?(node) ? '{' : 'do')
162
228
  else
163
229
  '{'
@@ -5,33 +5,33 @@ module RuboCop
5
5
  module Style
6
6
  # This cop checks for braces around the last parameter in a method call
7
7
  # if the last parameter is a hash.
8
- # It supports 3 styles:
8
+ # It supports `braces`, `no_braces` and `context_dependent` styles.
9
9
  #
10
- # * The `braces` style enforces braces around all method
11
- # parameters that are hashes.
10
+ # @example EnforcedStyle: braces
11
+ # # The `braces` style enforces braces around all method
12
+ # # parameters that are hashes.
12
13
  #
13
- # @example
14
14
  # # bad
15
15
  # some_method(x, y, a: 1, b: 2)
16
16
  #
17
17
  # # good
18
18
  # some_method(x, y, {a: 1, b: 2})
19
19
  #
20
- # * The `no_braces` style checks that the last parameter doesn't
21
- # have braces around it.
20
+ # @example EnforcedStyle: no_braces (default)
21
+ # # The `no_braces` style checks that the last parameter doesn't
22
+ # # have braces around it.
22
23
  #
23
- # @example
24
24
  # # bad
25
25
  # some_method(x, y, {a: 1, b: 2})
26
26
  #
27
27
  # # good
28
28
  # some_method(x, y, a: 1, b: 2)
29
29
  #
30
- # * The `context_dependent` style checks that the last parameter
31
- # doesn't have braces around it, but requires braces if the
32
- # second to last parameter is also a hash literal.
30
+ # @example EnforcedStyle: context_dependent
31
+ # # The `context_dependent` style checks that the last parameter
32
+ # # doesn't have braces around it, but requires braces if the
33
+ # # second to last parameter is also a hash literal.
33
34
  #
34
- # @example
35
35
  # # bad
36
36
  # some_method(x, y, {a: 1, b: 2})
37
37
  # some_method(x, y, {a: 1, b: 2}, a: 1, b: 2)
@@ -42,7 +42,7 @@ module RuboCop
42
42
  class BracesAroundHashParameters < Cop
43
43
  include ConfigurableEnforcedStyle
44
44
 
45
- MSG = '%s curly braces around a hash parameter.'.freeze
45
+ MSG = '%<type>s curly braces around a hash parameter.'.freeze
46
46
 
47
47
  def on_send(node)
48
48
  return if node.assignment_method? || node.operator_method?
@@ -53,6 +53,24 @@ module RuboCop
53
53
  check(node.last_argument, node.arguments)
54
54
  end
55
55
 
56
+ # We let AutocorrectUnlessChangingAST#autocorrect work with the send
57
+ # node, because that context is needed. When parsing the code to see if
58
+ # the AST has changed, a braceless hash would not be parsed as a hash
59
+ # otherwise.
60
+ def autocorrect(send_node)
61
+ hash_node = send_node.last_argument
62
+
63
+ lambda do |corrector|
64
+ if hash_node.braces?
65
+ remove_braces_with_whitespace(corrector,
66
+ hash_node,
67
+ extra_space(hash_node))
68
+ else
69
+ add_braces(corrector, hash_node)
70
+ end
71
+ end
72
+ end
73
+
56
74
  private
57
75
 
58
76
  def check(arg, args)
@@ -78,28 +96,37 @@ module RuboCop
78
96
  end
79
97
 
80
98
  def add_arg_offense(arg, type)
81
- add_offense(arg.parent, arg.source_range,
82
- format(MSG, type.to_s.capitalize))
99
+ add_offense(arg.parent, location: arg.source_range,
100
+ message: format(MSG,
101
+ type: type.to_s.capitalize))
83
102
  end
84
103
 
85
- # We let AutocorrectUnlessChangingAST#autocorrect work with the send
86
- # node, because that context is needed. When parsing the code to see if
87
- # the AST has changed, a braceless hash would not be parsed as a hash
88
- # otherwise.
89
- def autocorrect(send_node)
90
- hash_node = send_node.last_argument
104
+ def extra_space(hash_node)
105
+ {
106
+ newlines: extra_left_space?(hash_node) &&
107
+ extra_right_space?(hash_node),
108
+ left: extra_left_space?(hash_node),
109
+ right: extra_right_space?(hash_node)
110
+ }
111
+ end
91
112
 
92
- lambda do |corrector|
93
- if hash_node.braces?
94
- remove_braces_with_whitespace(corrector, hash_node)
95
- else
96
- add_braces(corrector, hash_node)
97
- end
113
+ def extra_left_space?(hash_node)
114
+ @extra_left_space ||= begin
115
+ top_line = hash_node.source_range.source_line
116
+ top_line.delete(' ') == '{'
117
+ end
118
+ end
119
+
120
+ def extra_right_space?(hash_node)
121
+ @extra_right_space ||= begin
122
+ bottom_line_number = hash_node.source_range.last_line
123
+ bottom_line = processed_source.lines[bottom_line_number - 1]
124
+ bottom_line.delete(' ') == '}'
98
125
  end
99
126
  end
100
127
 
101
- def remove_braces_with_whitespace(corrector, node)
102
- right_brace_and_space = right_brace_and_space(node.loc.end)
128
+ def remove_braces_with_whitespace(corrector, node, space)
129
+ right_brace_and_space = right_brace_and_space(node.loc.end, space)
103
130
 
104
131
  if comment_on_line?(right_brace_and_space.line)
105
132
  # Removing a line break between a comment and the closing
@@ -107,15 +134,24 @@ module RuboCop
107
134
  # braces in that case.
108
135
  remove_braces(corrector, node)
109
136
  else
110
- left_brace_and_space = range_with_surrounding_space(node.loc.begin,
111
- :right)
137
+ left_brace_and_space =
138
+ range_with_surrounding_space(range: node.loc.begin,
139
+ side: :right,
140
+ newlines: space[:newlines],
141
+ whitespace: space[:left])
112
142
  corrector.remove(left_brace_and_space)
113
143
  corrector.remove(right_brace_and_space)
114
144
  end
115
145
  end
116
146
 
117
- def right_brace_and_space(loc_end)
118
- brace_and_space = range_with_surrounding_space(loc_end, :left)
147
+ def right_brace_and_space(loc_end, space)
148
+ brace_and_space =
149
+ range_with_surrounding_space(
150
+ range: loc_end,
151
+ side: :left,
152
+ newlines: space[:newlines],
153
+ whitespace: space[:right]
154
+ )
119
155
  range_with_surrounding_comma(brace_and_space, :left)
120
156
  end
121
157