rubocop 0.89.1 → 0.90.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 (256) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/config/default.yml +79 -11
  4. data/lib/rubocop.rb +13 -0
  5. data/lib/rubocop/cached_data.rb +1 -0
  6. data/lib/rubocop/cli/command.rb +1 -0
  7. data/lib/rubocop/cli/command/auto_genenerate_config.rb +1 -0
  8. data/lib/rubocop/cli/command/base.rb +1 -0
  9. data/lib/rubocop/cli/command/execute_runner.rb +1 -0
  10. data/lib/rubocop/cli/command/init_dotfile.rb +1 -0
  11. data/lib/rubocop/cli/command/show_cops.rb +1 -0
  12. data/lib/rubocop/cli/command/version.rb +1 -0
  13. data/lib/rubocop/cli/environment.rb +1 -0
  14. data/lib/rubocop/comment_config.rb +5 -0
  15. data/lib/rubocop/config_loader.rb +17 -6
  16. data/lib/rubocop/config_loader_resolver.rb +1 -0
  17. data/lib/rubocop/config_obsoletion.rb +1 -0
  18. data/lib/rubocop/config_validator.rb +3 -0
  19. data/lib/rubocop/cop/base.rb +23 -0
  20. data/lib/rubocop/cop/bundler/gem_comment.rb +7 -3
  21. data/lib/rubocop/cop/commissioner.rb +47 -7
  22. data/lib/rubocop/cop/correctors/alignment_corrector.rb +4 -4
  23. data/lib/rubocop/cop/correctors/condition_corrector.rb +3 -5
  24. data/lib/rubocop/cop/correctors/empty_line_corrector.rb +9 -10
  25. data/lib/rubocop/cop/correctors/line_break_corrector.rb +2 -2
  26. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +8 -3
  27. data/lib/rubocop/cop/correctors/parentheses_corrector.rb +5 -8
  28. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +4 -9
  29. data/lib/rubocop/cop/correctors/punctuation_corrector.rb +8 -10
  30. data/lib/rubocop/cop/documentation.rb +22 -0
  31. data/lib/rubocop/cop/generator.rb +1 -0
  32. data/lib/rubocop/cop/layout/block_alignment.rb +23 -19
  33. data/lib/rubocop/cop/layout/class_structure.rb +10 -9
  34. data/lib/rubocop/cop/layout/closing_heredoc_indentation.rb +4 -6
  35. data/lib/rubocop/cop/layout/condition_position.rb +13 -15
  36. data/lib/rubocop/cop/layout/def_end_alignment.rb +7 -4
  37. data/lib/rubocop/cop/layout/dot_position.rb +21 -17
  38. data/lib/rubocop/cop/layout/empty_comment.rb +30 -23
  39. data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +19 -16
  40. data/lib/rubocop/cop/layout/empty_line_after_magic_comment.rb +13 -13
  41. data/lib/rubocop/cop/layout/empty_line_after_multiline_condition.rb +144 -0
  42. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +21 -23
  43. data/lib/rubocop/cop/layout/empty_lines.rb +6 -7
  44. data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +4 -6
  45. data/lib/rubocop/cop/layout/empty_lines_around_arguments.rb +7 -8
  46. data/lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb +3 -6
  47. data/lib/rubocop/cop/layout/empty_lines_around_begin_body.rb +2 -5
  48. data/lib/rubocop/cop/layout/empty_lines_around_block_body.rb +2 -5
  49. data/lib/rubocop/cop/layout/empty_lines_around_class_body.rb +2 -5
  50. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +2 -5
  51. data/lib/rubocop/cop/layout/empty_lines_around_method_body.rb +2 -5
  52. data/lib/rubocop/cop/layout/empty_lines_around_module_body.rb +2 -5
  53. data/lib/rubocop/cop/layout/end_alignment.rb +6 -7
  54. data/lib/rubocop/cop/layout/first_array_element_line_break.rb +2 -5
  55. data/lib/rubocop/cop/layout/first_hash_element_line_break.rb +2 -5
  56. data/lib/rubocop/cop/layout/first_method_argument_line_break.rb +4 -8
  57. data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb +2 -5
  58. data/lib/rubocop/cop/layout/hash_alignment.rb +17 -20
  59. data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +15 -14
  60. data/lib/rubocop/cop/layout/heredoc_indentation.rb +14 -11
  61. data/lib/rubocop/cop/layout/initial_indentation.rb +6 -7
  62. data/lib/rubocop/cop/layout/leading_comment_space.rb +11 -9
  63. data/lib/rubocop/cop/layout/leading_empty_lines.rb +6 -11
  64. data/lib/rubocop/cop/layout/multiline_array_brace_layout.rb +2 -5
  65. data/lib/rubocop/cop/layout/multiline_array_line_breaks.rb +2 -5
  66. data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +10 -14
  67. data/lib/rubocop/cop/layout/multiline_block_layout.rb +21 -19
  68. data/lib/rubocop/cop/layout/multiline_hash_brace_layout.rb +2 -5
  69. data/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb +2 -5
  70. data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +5 -9
  71. data/lib/rubocop/cop/layout/multiline_method_call_brace_layout.rb +2 -5
  72. data/lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb +2 -5
  73. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +18 -21
  74. data/lib/rubocop/cop/layout/space_after_colon.rb +11 -7
  75. data/lib/rubocop/cop/layout/space_after_comma.rb +2 -5
  76. data/lib/rubocop/cop/layout/space_after_method_name.rb +5 -6
  77. data/lib/rubocop/cop/layout/space_after_not.rb +9 -11
  78. data/lib/rubocop/cop/layout/space_after_semicolon.rb +2 -5
  79. data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb +20 -15
  80. data/lib/rubocop/cop/layout/space_around_keyword.rb +17 -18
  81. data/lib/rubocop/cop/layout/space_around_operators.rb +17 -16
  82. data/lib/rubocop/cop/layout/space_before_block_braces.rb +23 -22
  83. data/lib/rubocop/cop/layout/space_before_comma.rb +3 -5
  84. data/lib/rubocop/cop/layout/space_before_comment.rb +10 -7
  85. data/lib/rubocop/cop/layout/space_before_first_arg.rb +7 -7
  86. data/lib/rubocop/cop/layout/space_before_semicolon.rb +2 -5
  87. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +9 -17
  88. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +13 -16
  89. data/lib/rubocop/cop/layout/space_inside_array_percent_literal.rb +3 -8
  90. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +17 -16
  91. data/lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb +16 -19
  92. data/lib/rubocop/cop/layout/space_inside_parens.rb +9 -14
  93. data/lib/rubocop/cop/layout/space_inside_percent_literal_delimiters.rb +5 -10
  94. data/lib/rubocop/cop/layout/space_inside_range_literal.rb +8 -17
  95. data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +13 -16
  96. data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +10 -11
  97. data/lib/rubocop/cop/layout/trailing_empty_lines.rb +10 -15
  98. data/lib/rubocop/cop/layout/trailing_whitespace.rb +11 -11
  99. data/lib/rubocop/cop/lint/binary_operator_with_identical_operands.rb +1 -1
  100. data/lib/rubocop/cop/lint/constant_resolution.rb +1 -1
  101. data/lib/rubocop/cop/lint/duplicate_require.rb +41 -0
  102. data/lib/rubocop/cop/lint/duplicate_rescue_exception.rb +0 -11
  103. data/lib/rubocop/cop/lint/empty_file.rb +53 -0
  104. data/lib/rubocop/cop/lint/missing_super.rb +2 -2
  105. data/lib/rubocop/cop/lint/mixed_regexp_capture_types.rb +2 -35
  106. data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +9 -19
  107. data/lib/rubocop/cop/lint/percent_string_array.rb +8 -12
  108. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +4 -4
  109. data/lib/rubocop/cop/lint/top_level_return_with_argument.rb +1 -1
  110. data/lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb +57 -0
  111. data/lib/rubocop/cop/lint/useless_method_definition.rb +77 -0
  112. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +2 -0
  113. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +1 -0
  114. data/lib/rubocop/cop/mixin/alignment.rb +3 -0
  115. data/lib/rubocop/cop/mixin/allowed_methods.rb +2 -0
  116. data/lib/rubocop/cop/mixin/annotation_comment.rb +5 -0
  117. data/lib/rubocop/cop/mixin/check_line_breakable.rb +16 -7
  118. data/lib/rubocop/cop/mixin/comments_help.rb +54 -0
  119. data/lib/rubocop/cop/mixin/empty_lines_around_body.rb +8 -7
  120. data/lib/rubocop/cop/mixin/empty_parameter.rb +3 -1
  121. data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +3 -1
  122. data/lib/rubocop/cop/mixin/first_element_line_break.rb +3 -1
  123. data/lib/rubocop/cop/mixin/hash_transform_method.rb +17 -0
  124. data/lib/rubocop/cop/mixin/multiline_element_line_breaks.rb +3 -1
  125. data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb +12 -10
  126. data/lib/rubocop/cop/mixin/negative_conditional.rb +2 -2
  127. data/lib/rubocop/cop/mixin/percent_array.rb +14 -3
  128. data/lib/rubocop/cop/mixin/regexp_literal_help.rb +1 -1
  129. data/lib/rubocop/cop/mixin/rescue_node.rb +10 -1
  130. data/lib/rubocop/cop/mixin/space_after_punctuation.rb +4 -3
  131. data/lib/rubocop/cop/mixin/space_before_punctuation.rb +4 -3
  132. data/lib/rubocop/cop/mixin/surrounding_space.rb +8 -4
  133. data/lib/rubocop/cop/mixin/trailing_comma.rb +7 -7
  134. data/lib/rubocop/cop/offense.rb +1 -0
  135. data/lib/rubocop/cop/severity.rb +0 -8
  136. data/lib/rubocop/cop/style/case_equality.rb +8 -3
  137. data/lib/rubocop/cop/style/case_like_if.rb +20 -4
  138. data/lib/rubocop/cop/style/class_methods_definitions.rb +131 -0
  139. data/lib/rubocop/cop/style/combinable_loops.rb +89 -0
  140. data/lib/rubocop/cop/style/empty_block_parameter.rb +9 -10
  141. data/lib/rubocop/cop/style/empty_lambda_parameter.rb +9 -10
  142. data/lib/rubocop/cop/style/guard_clause.rb +1 -0
  143. data/lib/rubocop/cop/style/hash_syntax.rb +6 -5
  144. data/lib/rubocop/cop/style/hash_transform_keys.rb +14 -1
  145. data/lib/rubocop/cop/style/hash_transform_values.rb +14 -1
  146. data/lib/rubocop/cop/style/if_unless_modifier.rb +2 -2
  147. data/lib/rubocop/cop/style/keyword_parameters_order.rb +58 -0
  148. data/lib/rubocop/cop/style/method_called_on_do_end_block.rb +10 -1
  149. data/lib/rubocop/cop/style/multiline_when_then.rb +2 -2
  150. data/lib/rubocop/cop/style/negated_if.rb +6 -6
  151. data/lib/rubocop/cop/style/negated_unless.rb +6 -6
  152. data/lib/rubocop/cop/style/negated_while.rb +7 -15
  153. data/lib/rubocop/cop/style/nested_modifier.rb +10 -13
  154. data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +11 -11
  155. data/lib/rubocop/cop/style/nested_ternary_operator.rb +14 -16
  156. data/lib/rubocop/cop/style/next.rb +10 -14
  157. data/lib/rubocop/cop/style/nil_comparison.rb +11 -11
  158. data/lib/rubocop/cop/style/non_nil_check.rb +32 -26
  159. data/lib/rubocop/cop/style/not.rb +19 -26
  160. data/lib/rubocop/cop/style/numeric_literal_prefix.rb +4 -9
  161. data/lib/rubocop/cop/style/numeric_predicate.rb +4 -11
  162. data/lib/rubocop/cop/style/one_line_conditional.rb +71 -23
  163. data/lib/rubocop/cop/style/option_hash.rb +1 -1
  164. data/lib/rubocop/cop/style/optional_arguments.rb +1 -1
  165. data/lib/rubocop/cop/style/or_assignment.rb +13 -10
  166. data/lib/rubocop/cop/style/parallel_assignment.rb +14 -14
  167. data/lib/rubocop/cop/style/parentheses_around_condition.rb +6 -6
  168. data/lib/rubocop/cop/style/percent_literal_delimiters.rb +13 -19
  169. data/lib/rubocop/cop/style/percent_q_literals.rb +8 -10
  170. data/lib/rubocop/cop/style/perl_backrefs.rb +8 -10
  171. data/lib/rubocop/cop/style/preferred_hash_methods.rb +9 -14
  172. data/lib/rubocop/cop/style/proc.rb +6 -6
  173. data/lib/rubocop/cop/style/raise_args.rb +13 -24
  174. data/lib/rubocop/cop/style/random_with_offset.rb +15 -16
  175. data/lib/rubocop/cop/style/redundant_assignment.rb +8 -10
  176. data/lib/rubocop/cop/style/redundant_begin.rb +7 -9
  177. data/lib/rubocop/cop/style/redundant_capital_w.rb +6 -9
  178. data/lib/rubocop/cop/style/redundant_condition.rb +5 -6
  179. data/lib/rubocop/cop/style/redundant_fetch_block.rb +3 -12
  180. data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +8 -8
  181. data/lib/rubocop/cop/style/redundant_freeze.rb +3 -6
  182. data/lib/rubocop/cop/style/redundant_interpolation.rb +25 -24
  183. data/lib/rubocop/cop/style/redundant_parentheses.rb +7 -9
  184. data/lib/rubocop/cop/style/redundant_regexp_character_class.rb +6 -13
  185. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +5 -14
  186. data/lib/rubocop/cop/style/redundant_self.rb +2 -2
  187. data/lib/rubocop/cop/style/redundant_self_assignment.rb +116 -0
  188. data/lib/rubocop/cop/style/regexp_literal.rb +10 -21
  189. data/lib/rubocop/cop/style/rescue_modifier.rb +29 -9
  190. data/lib/rubocop/cop/style/return_nil.rb +5 -5
  191. data/lib/rubocop/cop/style/safe_navigation.rb +13 -12
  192. data/lib/rubocop/cop/style/sample.rb +10 -13
  193. data/lib/rubocop/cop/style/self_assignment.rb +26 -22
  194. data/lib/rubocop/cop/style/semicolon.rb +6 -9
  195. data/lib/rubocop/cop/style/send.rb +2 -2
  196. data/lib/rubocop/cop/style/signal_exception.rb +21 -19
  197. data/lib/rubocop/cop/style/single_line_block_params.rb +4 -2
  198. data/lib/rubocop/cop/style/single_line_methods.rb +17 -16
  199. data/lib/rubocop/cop/style/slicing_with_range.rb +4 -7
  200. data/lib/rubocop/cop/style/sole_nested_conditional.rb +66 -0
  201. data/lib/rubocop/cop/style/special_global_vars.rb +10 -15
  202. data/lib/rubocop/cop/style/stabby_lambda_parentheses.rb +17 -21
  203. data/lib/rubocop/cop/style/stderr_puts.rb +4 -6
  204. data/lib/rubocop/cop/style/string_hash_keys.rb +6 -7
  205. data/lib/rubocop/cop/style/string_methods.rb +7 -17
  206. data/lib/rubocop/cop/style/strip.rb +8 -14
  207. data/lib/rubocop/cop/style/struct_inheritance.rb +3 -6
  208. data/lib/rubocop/cop/style/symbol_array.rb +5 -16
  209. data/lib/rubocop/cop/style/symbol_literal.rb +4 -6
  210. data/lib/rubocop/cop/style/symbol_proc.rb +14 -18
  211. data/lib/rubocop/cop/style/ternary_parentheses.rb +21 -20
  212. data/lib/rubocop/cop/style/trailing_body_on_class.rb +3 -6
  213. data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb +4 -7
  214. data/lib/rubocop/cop/style/trailing_body_on_module.rb +3 -6
  215. data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb +2 -5
  216. data/lib/rubocop/cop/style/trailing_comma_in_array_literal.rb +2 -5
  217. data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +7 -6
  218. data/lib/rubocop/cop/style/trailing_comma_in_hash_literal.rb +2 -5
  219. data/lib/rubocop/cop/style/trailing_underscore_variable.rb +8 -17
  220. data/lib/rubocop/cop/style/trivial_accessors.rb +26 -30
  221. data/lib/rubocop/cop/style/unless_else.rb +5 -8
  222. data/lib/rubocop/cop/style/unpack_first.rb +4 -8
  223. data/lib/rubocop/cop/style/variable_interpolation.rb +7 -10
  224. data/lib/rubocop/cop/style/when_then.rb +4 -6
  225. data/lib/rubocop/cop/style/while_until_do.rb +6 -16
  226. data/lib/rubocop/cop/style/while_until_modifier.rb +6 -20
  227. data/lib/rubocop/cop/style/word_array.rb +5 -23
  228. data/lib/rubocop/cop/style/yoda_condition.rb +4 -15
  229. data/lib/rubocop/cop/style/zero_length_predicate.rb +11 -13
  230. data/lib/rubocop/cop/team.rb +1 -0
  231. data/lib/rubocop/cop/util.rb +1 -1
  232. data/lib/rubocop/cop/utils/format_string.rb +3 -5
  233. data/lib/rubocop/cop/variable_force.rb +2 -0
  234. data/lib/rubocop/cops_documentation_generator.rb +4 -2
  235. data/lib/rubocop/core_ext/string.rb +1 -1
  236. data/lib/rubocop/ext/regexp_node.rb +46 -0
  237. data/lib/rubocop/file_finder.rb +1 -0
  238. data/lib/rubocop/formatter/auto_gen_config_formatter.rb +2 -1
  239. data/lib/rubocop/formatter/html_formatter.rb +2 -0
  240. data/lib/rubocop/formatter/progress_formatter.rb +2 -1
  241. data/lib/rubocop/formatter/quiet_formatter.rb +1 -1
  242. data/lib/rubocop/formatter/simple_text_formatter.rb +36 -6
  243. data/lib/rubocop/name_similarity.rb +1 -0
  244. data/lib/rubocop/options.rb +3 -0
  245. data/lib/rubocop/remote_config.rb +1 -0
  246. data/lib/rubocop/result_cache.rb +1 -0
  247. data/lib/rubocop/rspec/cop_helper.rb +4 -1
  248. data/lib/rubocop/rspec/expect_offense.rb +10 -5
  249. data/lib/rubocop/rspec/shared_contexts.rb +12 -0
  250. data/lib/rubocop/runner.rb +1 -0
  251. data/lib/rubocop/string_interpreter.rb +3 -0
  252. data/lib/rubocop/target_finder.rb +1 -0
  253. data/lib/rubocop/target_ruby.rb +6 -0
  254. data/lib/rubocop/version.rb +2 -1
  255. data/lib/rubocop/yaml_duplication_checker.rb +1 -0
  256. metadata +15 -2
@@ -52,20 +52,40 @@ module RuboCop
52
52
  end
53
53
 
54
54
  def autocorrect(node)
55
+ parenthesized = parenthesized?(node)
56
+ lambda do |corrector|
57
+ corrector.replace(node, corrected_block(node, parenthesized))
58
+ ParenthesesCorrector.correct(corrector, node.parent) if parenthesized
59
+ end
60
+ end
61
+
62
+ private
63
+
64
+ def parenthesized?(node)
65
+ node.parent && parentheses?(node.parent)
66
+ end
67
+
68
+ def corrected_block(node, parenthesized)
55
69
  operation, rescue_modifier, = *node
56
70
  *_, rescue_args = *rescue_modifier
57
71
 
58
- indent = indentation(node)
59
- correction =
60
- "begin\n" \
61
- "#{operation.source.gsub(/^/, indent)}" \
62
- "\n#{offset(node)}rescue\n" \
63
- "#{rescue_args.source.gsub(/^/, indent)}" \
64
- "\n#{offset(node)}end"
72
+ node_indentation, node_offset = indentation_and_offset(node, parenthesized)
65
73
 
66
- lambda do |corrector|
67
- corrector.replace(node, correction)
74
+ "begin\n" \
75
+ "#{operation.source.gsub(/^/, node_indentation)}" \
76
+ "\n#{node_offset}rescue\n" \
77
+ "#{rescue_args.source.gsub(/^/, node_indentation)}" \
78
+ "\n#{node_offset}end"
79
+ end
80
+
81
+ def indentation_and_offset(node, parenthesized)
82
+ node_indentation = indentation(node)
83
+ node_offset = offset(node)
84
+ if parenthesized
85
+ node_indentation = node_indentation[0...-1]
86
+ node_offset = node_offset[0...-1]
68
87
  end
88
+ [node_indentation, node_offset]
69
89
  end
70
90
  end
71
91
  end
@@ -28,8 +28,9 @@ module RuboCop
28
28
  # def foo(arg)
29
29
  # return nil if arg
30
30
  # end
31
- class ReturnNil < Cop
31
+ class ReturnNil < Base
32
32
  include ConfigurableEnforcedStyle
33
+ extend AutoCorrector
33
34
 
34
35
  RETURN_MSG = 'Use `return` instead of `return nil`.'
35
36
  RETURN_NIL_MSG = 'Use `return nil` instead of `return`.'
@@ -54,12 +55,11 @@ module RuboCop
54
55
  return nil if chained_send?(send_node)
55
56
  end
56
57
 
57
- add_offense(node) unless correct_style?(node)
58
- end
58
+ return if correct_style?(node)
59
59
 
60
- def autocorrect(node)
61
- lambda do |corrector|
60
+ add_offense(node) do |corrector|
62
61
  corrected = style == :return ? 'return' : 'return nil'
62
+
63
63
  corrector.replace(node, corrected)
64
64
  end
65
65
  end
@@ -58,9 +58,10 @@ module RuboCop
58
58
  # foo.baz = bar if foo
59
59
  # foo.baz + bar if foo
60
60
  # foo.bar > 2 if foo
61
- class SafeNavigation < Cop
61
+ class SafeNavigation < Base
62
62
  include NilMethods
63
63
  include RangeHelp
64
+ extend AutoCorrector
64
65
 
65
66
  MSG = 'Use safe navigation (`&.`) instead of checking if an object ' \
66
67
  'exists before calling the method.'
@@ -104,29 +105,29 @@ module RuboCop
104
105
  return if chain_size(method_chain, method) > 1
105
106
  return if unsafe_method_used?(method_chain, method)
106
107
 
107
- add_offense(node)
108
+ add_offense(node) do |corrector|
109
+ autocorrect(corrector, node)
110
+ end
108
111
  end
109
112
 
110
113
  def use_var_only_in_unless_modifier?(node, variable)
111
114
  node.if_type? && node.unless? && !method_called?(variable)
112
115
  end
113
116
 
114
- def autocorrect(node)
117
+ private
118
+
119
+ def autocorrect(corrector, node)
115
120
  body = node.node_parts[1]
116
121
  method_call = method_call(node)
117
122
 
118
- lambda do |corrector|
119
- corrector.remove(begin_range(node, body))
120
- corrector.remove(end_range(node, body))
121
- corrector.insert_before(method_call.loc.dot, '&')
122
- handle_comments(corrector, node, method_call)
123
+ corrector.remove(begin_range(node, body))
124
+ corrector.remove(end_range(node, body))
125
+ corrector.insert_before(method_call.loc.dot, '&')
126
+ handle_comments(corrector, node, method_call)
123
127
 
124
- add_safe_nav_to_all_methods_in_chain(corrector, method_call, body)
125
- end
128
+ add_safe_nav_to_all_methods_in_chain(corrector, method_call, body)
126
129
  end
127
130
 
128
- private
129
-
130
131
  def handle_comments(corrector, node, method_call)
131
132
  comments = comments(node)
132
133
  return if comments.empty?
@@ -27,7 +27,9 @@ module RuboCop
27
27
  # [1, 2, 3].shuffle[1..3] # sample(3) might return a longer Array
28
28
  # [1, 2, 3].shuffle[foo, bar]
29
29
  # [1, 2, 3].shuffle(random: Random.new)
30
- class Sample < Cop
30
+ class Sample < Base
31
+ extend AutoCorrector
32
+
31
33
  MSG = 'Use `%<correct>s` instead of `%<incorrect>s`.'
32
34
 
33
35
  def_node_matcher :sample_candidate?, <<~PATTERN
@@ -35,22 +37,17 @@ module RuboCop
35
37
  PATTERN
36
38
 
37
39
  def on_send(node)
38
- sample_candidate?(node) do |shuffle, shuffle_arg, method, method_args|
40
+ sample_candidate?(node) do |shuffle_node, shuffle_arg, method, method_args|
39
41
  return unless offensive?(method, method_args)
40
42
 
41
- range = source_range(shuffle, node)
43
+ range = source_range(shuffle_node, node)
42
44
  message = message(shuffle_arg, method, method_args, range)
43
- add_offense(node, location: range, message: message)
44
- end
45
- end
46
-
47
- def autocorrect(node)
48
- shuffle_node, shuffle_arg, method, method_args =
49
- sample_candidate?(node)
50
45
 
51
- lambda do |corrector|
52
- corrector.replace(source_range(shuffle_node, node),
53
- correction(shuffle_arg, method, method_args))
46
+ add_offense(range, message: message) do |corrector|
47
+ corrector.replace(
48
+ source_range(shuffle_node, node), correction(shuffle_arg, method, method_args)
49
+ )
50
+ end
54
51
  end
55
52
  end
56
53
 
@@ -12,7 +12,9 @@ module RuboCop
12
12
  #
13
13
  # # good
14
14
  # x += 1
15
- class SelfAssignment < Cop
15
+ class SelfAssignment < Base
16
+ extend AutoCorrector
17
+
16
18
  MSG = 'Use self-assignment shorthand `%<method>s=`.'
17
19
  OPS = %i[+ - * ** / | &].freeze
18
20
 
@@ -32,16 +34,6 @@ module RuboCop
32
34
  check(node, :cvar)
33
35
  end
34
36
 
35
- def autocorrect(node)
36
- _var_name, rhs = *node
37
-
38
- if rhs.send_type?
39
- autocorrect_send_node(node, rhs)
40
- elsif %i[and or].include?(rhs.type)
41
- autocorrect_boolean_node(node, rhs)
42
- end
43
- end
44
-
45
37
  private
46
38
 
47
39
  def check(node, var_type)
@@ -62,7 +54,9 @@ module RuboCop
62
54
  target_node = s(var_type, var_name)
63
55
  return unless receiver == target_node
64
56
 
65
- add_offense(node, message: format(MSG, method: method_name))
57
+ add_offense(node, message: format(MSG, method: method_name)) do |corrector|
58
+ autocorrect(corrector, node)
59
+ end
66
60
  end
67
61
 
68
62
  def check_boolean_node(node, rhs, var_name, var_type)
@@ -72,24 +66,34 @@ module RuboCop
72
66
  return unless first_operand == target_node
73
67
 
74
68
  operator = rhs.loc.operator.source
75
- add_offense(node, message: format(MSG, method: operator))
69
+ add_offense(node, message: format(MSG, method: operator)) do |corrector|
70
+ autocorrect(corrector, node)
71
+ end
76
72
  end
77
73
 
78
- def autocorrect_send_node(node, rhs)
74
+ def autocorrect(corrector, node)
75
+ _var_name, rhs = *node
76
+
77
+ if rhs.send_type?
78
+ autocorrect_send_node(corrector, node, rhs)
79
+ elsif %i[and or].include?(rhs.type)
80
+ autocorrect_boolean_node(corrector, node, rhs)
81
+ end
82
+ end
83
+
84
+ def autocorrect_send_node(corrector, node, rhs)
79
85
  _receiver, method_name, args = *rhs
80
- apply_autocorrect(node, rhs, method_name.to_s, args)
86
+ apply_autocorrect(corrector, node, rhs, method_name.to_s, args)
81
87
  end
82
88
 
83
- def autocorrect_boolean_node(node, rhs)
89
+ def autocorrect_boolean_node(corrector, node, rhs)
84
90
  _first_operand, second_operand = *rhs
85
- apply_autocorrect(node, rhs, rhs.loc.operator.source, second_operand)
91
+ apply_autocorrect(corrector, node, rhs, rhs.loc.operator.source, second_operand)
86
92
  end
87
93
 
88
- def apply_autocorrect(node, rhs, operator, new_rhs)
89
- lambda do |corrector|
90
- corrector.insert_before(node.loc.operator, operator)
91
- corrector.replace(rhs, new_rhs.source)
92
- end
94
+ def apply_autocorrect(corrector, node, rhs, operator, new_rhs)
95
+ corrector.insert_before(node.loc.operator, operator)
96
+ corrector.replace(rhs, new_rhs.source)
93
97
  end
94
98
  end
95
99
  end
@@ -26,12 +26,13 @@ module RuboCop
26
26
  # @example AllowAsExpressionSeparator: true
27
27
  # # good
28
28
  # foo = 1; bar = 2
29
- class Semicolon < Cop
29
+ class Semicolon < Base
30
30
  include RangeHelp
31
+ extend AutoCorrector
31
32
 
32
33
  MSG = 'Do not use semicolons to terminate expressions.'
33
34
 
34
- def investigate(processed_source)
35
+ def on_new_investigation
35
36
  return if processed_source.blank?
36
37
 
37
38
  @processed_source = processed_source
@@ -66,12 +67,6 @@ module RuboCop
66
67
  end
67
68
  end
68
69
 
69
- def autocorrect(range)
70
- return unless range
71
-
72
- ->(corrector) { corrector.remove(range) }
73
- end
74
-
75
70
  private
76
71
 
77
72
  def check_for_line_terminator_or_opener
@@ -93,7 +88,9 @@ module RuboCop
93
88
  range = source_range(@processed_source.buffer, line, column)
94
89
  # Don't attempt to autocorrect if semicolon is separating statements
95
90
  # on the same line
96
- add_offense(autocorrect ? range : nil, location: range)
91
+ add_offense(range) do |corrector|
92
+ corrector.remove(range) if autocorrect
93
+ end
97
94
  end
98
95
  end
99
96
  end
@@ -13,7 +13,7 @@ module RuboCop
13
13
  # # good
14
14
  # Foo.__send__(:bar)
15
15
  # quuz.public_send(:fred)
16
- class Send < Cop
16
+ class Send < Base
17
17
  MSG = 'Prefer `Object#__send__` or `Object#public_send` to ' \
18
18
  '`send`.'
19
19
 
@@ -22,7 +22,7 @@ module RuboCop
22
22
  def on_send(node)
23
23
  return unless sending?(node) && node.arguments?
24
24
 
25
- add_offense(node, location: :selector)
25
+ add_offense(node.loc.selector)
26
26
  end
27
27
  alias on_csend on_send
28
28
  end
@@ -104,8 +104,9 @@ module RuboCop
104
104
  #
105
105
  # explicit_receiver.fail
106
106
  # explicit_receiver.raise
107
- class SignalException < Cop
107
+ class SignalException < Base
108
108
  include ConfigurableEnforcedStyle
109
+ extend AutoCorrector
109
110
 
110
111
  FAIL_MSG = 'Use `fail` instead of `raise` to signal exceptions.'
111
112
  RAISE_MSG = 'Use `raise` instead of `fail` to ' \
@@ -115,7 +116,7 @@ module RuboCop
115
116
  def_node_search :custom_fail_methods,
116
117
  '{(def :fail ...) (defs _ :fail ...)}'
117
118
 
118
- def investigate(processed_source)
119
+ def on_new_investigation
119
120
  ast = processed_source.ast
120
121
  @custom_fail_defined = ast && custom_fail_methods(ast).any?
121
122
  end
@@ -145,20 +146,6 @@ module RuboCop
145
146
  end
146
147
  end
147
148
 
148
- def autocorrect(node)
149
- lambda do |corrector|
150
- name =
151
- case style
152
- when :semantic
153
- command_or_kernel_call?(:raise, node) ? 'fail' : 'raise'
154
- when :only_raise then 'raise'
155
- when :only_fail then 'fail'
156
- end
157
-
158
- corrector.replace(node.loc.selector, name)
159
- end
160
- end
161
-
162
149
  private
163
150
 
164
151
  def message(method_name)
@@ -178,8 +165,9 @@ module RuboCop
178
165
  each_command_or_kernel_call(method_name, node) do |send_node|
179
166
  next if ignored_node?(send_node)
180
167
 
181
- add_offense(send_node,
182
- location: :selector, message: message(method_name))
168
+ add_offense(send_node.loc.selector, message: message(method_name)) do |corrector|
169
+ autocorrect(corrector, send_node)
170
+ end
183
171
  ignore_node(send_node)
184
172
  end
185
173
  end
@@ -187,7 +175,21 @@ module RuboCop
187
175
  def check_send(method_name, node)
188
176
  return unless node && command_or_kernel_call?(method_name, node)
189
177
 
190
- add_offense(node, location: :selector, message: message(method_name))
178
+ add_offense(node.loc.selector, message: message(method_name)) do |corrector|
179
+ autocorrect(corrector, node)
180
+ end
181
+ end
182
+
183
+ def autocorrect(corrector, node)
184
+ name =
185
+ case style
186
+ when :semantic
187
+ command_or_kernel_call?(:raise, node) ? 'fail' : 'raise'
188
+ when :only_raise then 'raise'
189
+ when :only_fail then 'fail'
190
+ end
191
+
192
+ corrector.replace(node.loc.selector, name)
191
193
  end
192
194
 
193
195
  def command_or_kernel_call?(name, node)
@@ -28,7 +28,7 @@ module RuboCop
28
28
  # foo.reduce do |c, d|
29
29
  # c + d
30
30
  # end
31
- class SingleLineBlockParams < Cop
31
+ class SingleLineBlockParams < Base
32
32
  MSG = 'Name `%<method>s` block params `|%<params>s|`.'
33
33
 
34
34
  def on_block(node)
@@ -39,7 +39,9 @@ module RuboCop
39
39
 
40
40
  return if args_match?(node.send_node.method_name, node.arguments)
41
41
 
42
- add_offense(node.arguments)
42
+ message = message(node.arguments)
43
+
44
+ add_offense(node.arguments, message: message)
43
45
  end
44
46
 
45
47
  private
@@ -24,8 +24,9 @@ module RuboCop
24
24
  # # bad
25
25
  # def no_op; end
26
26
  #
27
- class SingleLineMethods < Cop
27
+ class SingleLineMethods < Base
28
28
  include Alignment
29
+ extend AutoCorrector
29
30
 
30
31
  MSG = 'Avoid single-line method definitions.'
31
32
 
@@ -33,29 +34,29 @@ module RuboCop
33
34
  return unless node.single_line?
34
35
  return if allow_empty? && !node.body
35
36
 
36
- add_offense(node)
37
+ add_offense(node) do |corrector|
38
+ autocorrect(corrector, node)
39
+ end
37
40
  end
38
41
  alias on_defs on_def
39
42
 
40
- def autocorrect(node)
41
- lambda do |corrector|
42
- each_part(node.body) do |part|
43
- LineBreakCorrector.break_line_before(
44
- range: part, node: node, corrector: corrector,
45
- configured_width: configured_indentation_width
46
- )
47
- end
43
+ private
48
44
 
45
+ def autocorrect(corrector, node)
46
+ each_part(node.body) do |part|
49
47
  LineBreakCorrector.break_line_before(
50
- range: node.loc.end, node: node, corrector: corrector,
51
- indent_steps: 0, configured_width: configured_indentation_width
48
+ range: part, node: node, corrector: corrector,
49
+ configured_width: configured_indentation_width
52
50
  )
53
-
54
- move_comment(node, corrector)
55
51
  end
56
- end
57
52
 
58
- private
53
+ LineBreakCorrector.break_line_before(
54
+ range: node.loc.end, node: node, corrector: corrector,
55
+ indent_steps: 0, configured_width: configured_indentation_width
56
+ )
57
+
58
+ move_comment(node, corrector)
59
+ end
59
60
 
60
61
  def allow_empty?
61
62
  cop_config['AllowIfMethodIsEmpty']