rubocop 0.73.0 → 0.77.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 (216) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -2
  3. data/bin/console +1 -0
  4. data/config/default.yml +332 -295
  5. data/lib/rubocop.rb +46 -30
  6. data/lib/rubocop/ast/builder.rb +1 -0
  7. data/lib/rubocop/ast/node.rb +6 -8
  8. data/lib/rubocop/ast/node/block_node.rb +2 -0
  9. data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +1 -12
  10. data/lib/rubocop/ast/node/return_node.rb +24 -0
  11. data/lib/rubocop/cli.rb +11 -227
  12. data/lib/rubocop/cli/command.rb +21 -0
  13. data/lib/rubocop/cli/command/auto_genenerate_config.rb +105 -0
  14. data/lib/rubocop/cli/command/base.rb +33 -0
  15. data/lib/rubocop/cli/command/execute_runner.rb +76 -0
  16. data/lib/rubocop/cli/command/init_dotfile.rb +45 -0
  17. data/lib/rubocop/cli/command/show_cops.rb +73 -0
  18. data/lib/rubocop/cli/command/version.rb +17 -0
  19. data/lib/rubocop/cli/environment.rb +21 -0
  20. data/lib/rubocop/comment_config.rb +5 -4
  21. data/lib/rubocop/config.rb +28 -537
  22. data/lib/rubocop/config_loader.rb +21 -3
  23. data/lib/rubocop/config_loader_resolver.rb +4 -3
  24. data/lib/rubocop/config_obsoletion.rb +275 -0
  25. data/lib/rubocop/config_validator.rb +246 -0
  26. data/lib/rubocop/cop/autocorrect_logic.rb +2 -2
  27. data/lib/rubocop/cop/bundler/gem_comment.rb +4 -4
  28. data/lib/rubocop/cop/commissioner.rb +15 -7
  29. data/lib/rubocop/cop/cop.rb +33 -9
  30. data/lib/rubocop/cop/corrector.rb +8 -7
  31. data/lib/rubocop/cop/correctors/alignment_corrector.rb +43 -17
  32. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +2 -2
  33. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +1 -1
  34. data/lib/rubocop/cop/correctors/space_corrector.rb +1 -2
  35. data/lib/rubocop/cop/generator.rb +3 -3
  36. data/lib/rubocop/cop/generator/configuration_injector.rb +9 -4
  37. data/lib/rubocop/cop/generator/require_file_injector.rb +1 -1
  38. data/lib/rubocop/cop/internal_affairs.rb +1 -0
  39. data/lib/rubocop/cop/internal_affairs/method_name_equal.rb +59 -0
  40. data/lib/rubocop/cop/layout/{align_arguments.rb → argument_alignment.rb} +1 -1
  41. data/lib/rubocop/cop/layout/{align_array.rb → array_alignment.rb} +1 -1
  42. data/lib/rubocop/cop/layout/{indent_assignment.rb → assignment_indentation.rb} +11 -2
  43. data/lib/rubocop/cop/layout/block_alignment.rb +2 -2
  44. data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb +1 -1
  45. data/lib/rubocop/cop/layout/comment_indentation.rb +10 -13
  46. data/lib/rubocop/cop/layout/empty_comment.rb +7 -16
  47. data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +22 -7
  48. data/lib/rubocop/cop/layout/empty_line_after_magic_comment.rb +2 -2
  49. data/lib/rubocop/cop/layout/empty_lines_around_class_body.rb +2 -2
  50. data/lib/rubocop/cop/layout/end_of_line.rb +8 -3
  51. data/lib/rubocop/cop/layout/extra_spacing.rb +15 -60
  52. data/lib/rubocop/cop/layout/{indent_first_argument.rb → first_argument_indentation.rb} +12 -10
  53. data/lib/rubocop/cop/layout/{indent_first_array_element.rb → first_array_element_indentation.rb} +4 -4
  54. data/lib/rubocop/cop/layout/{indent_first_hash_element.rb → first_hash_element_indentation.rb} +4 -4
  55. data/lib/rubocop/cop/layout/{indent_first_parameter.rb → first_parameter_indentation.rb} +3 -3
  56. data/lib/rubocop/cop/layout/{align_hash.rb → hash_alignment.rb} +8 -4
  57. data/lib/rubocop/cop/layout/{indent_heredoc.rb → heredoc_indentation.rb} +2 -2
  58. data/lib/rubocop/cop/layout/indentation_width.rb +19 -5
  59. data/lib/rubocop/cop/layout/{leading_blank_lines.rb → leading_empty_lines.rb} +1 -1
  60. data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +1 -1
  61. data/lib/rubocop/cop/layout/multiline_block_layout.rb +24 -2
  62. data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +1 -1
  63. data/lib/rubocop/cop/layout/{align_parameters.rb → parameter_alignment.rb} +1 -1
  64. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +2 -0
  65. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +5 -1
  66. data/lib/rubocop/cop/layout/space_around_keyword.rb +12 -0
  67. data/lib/rubocop/cop/layout/space_around_operators.rb +43 -24
  68. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +9 -7
  69. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +8 -5
  70. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +7 -0
  71. data/lib/rubocop/cop/layout/space_inside_parens.rb +6 -6
  72. data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +24 -40
  73. data/lib/rubocop/cop/layout/{trailing_blank_lines.rb → trailing_empty_lines.rb} +1 -1
  74. data/lib/rubocop/cop/layout/trailing_whitespace.rb +18 -2
  75. data/lib/rubocop/cop/lint/assignment_in_condition.rb +17 -4
  76. data/lib/rubocop/cop/lint/debugger.rb +1 -3
  77. data/lib/rubocop/cop/lint/disjunctive_assignment_in_constructor.rb +1 -1
  78. data/lib/rubocop/cop/lint/{duplicated_key.rb → duplicate_hash_key.rb} +1 -1
  79. data/lib/rubocop/cop/lint/empty_interpolation.rb +4 -4
  80. data/lib/rubocop/cop/lint/erb_new_arguments.rb +61 -4
  81. data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +10 -36
  82. data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +1 -1
  83. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +7 -8
  84. data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +2 -2
  85. data/lib/rubocop/cop/lint/{multiple_compare.rb → multiple_comparison.rb} +1 -1
  86. data/lib/rubocop/cop/lint/number_conversion.rb +1 -1
  87. data/lib/rubocop/cop/lint/{unneeded_cop_disable_directive.rb → redundant_cop_disable_directive.rb} +24 -24
  88. data/lib/rubocop/cop/lint/{unneeded_cop_enable_directive.rb → redundant_cop_enable_directive.rb} +6 -8
  89. data/lib/rubocop/cop/lint/{unneeded_require_statement.rb → redundant_require_statement.rb} +1 -1
  90. data/lib/rubocop/cop/lint/{unneeded_splat_expansion.rb → redundant_splat_expansion.rb} +12 -7
  91. data/lib/rubocop/cop/lint/{string_conversion_in_interpolation.rb → redundant_string_coercion.rb} +7 -7
  92. data/lib/rubocop/cop/lint/redundant_with_index.rb +2 -2
  93. data/lib/rubocop/cop/lint/redundant_with_object.rb +2 -2
  94. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +5 -6
  95. data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +91 -0
  96. data/lib/rubocop/cop/lint/{handle_exceptions.rb → suppressed_exception.rb} +1 -1
  97. data/lib/rubocop/cop/lint/unused_block_argument.rb +22 -6
  98. data/lib/rubocop/cop/lint/unused_method_argument.rb +23 -5
  99. data/lib/rubocop/cop/lint/useless_access_modifier.rb +57 -23
  100. data/lib/rubocop/cop/lint/useless_setter_call.rb +1 -1
  101. data/lib/rubocop/cop/lint/void.rb +7 -26
  102. data/lib/rubocop/cop/message_annotator.rb +16 -7
  103. data/lib/rubocop/cop/metrics/abc_size.rb +1 -1
  104. data/lib/rubocop/cop/metrics/line_length.rb +48 -42
  105. data/lib/rubocop/cop/metrics/method_length.rb +1 -1
  106. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +23 -6
  107. data/lib/rubocop/cop/migration/department_name.rb +44 -0
  108. data/lib/rubocop/cop/mixin/alignment.rb +1 -1
  109. data/lib/rubocop/cop/mixin/documentation_comment.rb +0 -2
  110. data/lib/rubocop/cop/mixin/frozen_string_literal.rb +1 -1
  111. data/lib/rubocop/cop/mixin/{hash_alignment.rb → hash_alignment_styles.rb} +1 -1
  112. data/lib/rubocop/cop/mixin/interpolation.rb +27 -0
  113. data/lib/rubocop/cop/mixin/method_complexity.rb +2 -1
  114. data/lib/rubocop/cop/mixin/nil_methods.rb +4 -4
  115. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +87 -0
  116. data/lib/rubocop/cop/mixin/statement_modifier.rb +5 -2
  117. data/lib/rubocop/cop/mixin/surrounding_space.rb +7 -5
  118. data/lib/rubocop/cop/mixin/trailing_comma.rb +8 -6
  119. data/lib/rubocop/cop/naming/{uncommunicative_block_param_name.rb → block_parameter_name.rb} +3 -3
  120. data/lib/rubocop/cop/naming/file_name.rb +12 -5
  121. data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb +5 -5
  122. data/lib/rubocop/cop/naming/method_name.rb +12 -1
  123. data/lib/rubocop/cop/naming/{uncommunicative_method_param_name.rb → method_parameter_name.rb} +3 -3
  124. data/lib/rubocop/cop/naming/predicate_name.rb +6 -6
  125. data/lib/rubocop/cop/naming/variable_name.rb +1 -0
  126. data/lib/rubocop/cop/offense.rb +18 -7
  127. data/lib/rubocop/cop/registry.rb +22 -1
  128. data/lib/rubocop/cop/style/access_modifier_declarations.rb +1 -0
  129. data/lib/rubocop/cop/style/alias.rb +1 -1
  130. data/lib/rubocop/cop/style/array_join.rb +1 -1
  131. data/lib/rubocop/cop/style/attr.rb +2 -2
  132. data/lib/rubocop/cop/style/block_delimiters.rb +2 -1
  133. data/lib/rubocop/cop/style/braces_around_hash_parameters.rb +35 -16
  134. data/lib/rubocop/cop/style/class_and_module_children.rb +1 -1
  135. data/lib/rubocop/cop/style/comment_annotation.rb +5 -5
  136. data/lib/rubocop/cop/style/commented_keyword.rb +16 -30
  137. data/lib/rubocop/cop/style/conditional_assignment.rb +5 -7
  138. data/lib/rubocop/cop/style/constant_visibility.rb +13 -2
  139. data/lib/rubocop/cop/style/copyright.rb +11 -7
  140. data/lib/rubocop/cop/style/documentation_method.rb +44 -0
  141. data/lib/rubocop/cop/style/double_cop_disable_directive.rb +10 -4
  142. data/lib/rubocop/cop/style/empty_case_condition.rb +2 -2
  143. data/lib/rubocop/cop/style/empty_literal.rb +2 -2
  144. data/lib/rubocop/cop/style/empty_method.rb +5 -5
  145. data/lib/rubocop/cop/style/eval_with_location.rb +1 -1
  146. data/lib/rubocop/cop/style/even_odd.rb +1 -1
  147. data/lib/rubocop/cop/style/expand_path_arguments.rb +1 -1
  148. data/lib/rubocop/cop/style/format_string.rb +10 -7
  149. data/lib/rubocop/cop/style/format_string_token.rb +19 -68
  150. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +28 -33
  151. data/lib/rubocop/cop/style/guard_clause.rb +39 -10
  152. data/lib/rubocop/cop/style/hash_syntax.rb +2 -2
  153. data/lib/rubocop/cop/style/if_unless_modifier.rb +58 -15
  154. data/lib/rubocop/cop/style/infinite_loop.rb +5 -4
  155. data/lib/rubocop/cop/style/inverse_methods.rb +19 -13
  156. data/lib/rubocop/cop/style/ip_addresses.rb +4 -4
  157. data/lib/rubocop/cop/style/lambda.rb +0 -2
  158. data/lib/rubocop/cop/style/line_end_concatenation.rb +14 -10
  159. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +25 -25
  160. data/lib/rubocop/cop/style/method_def_parentheses.rb +17 -9
  161. data/lib/rubocop/cop/style/mixin_grouping.rb +1 -1
  162. data/lib/rubocop/cop/style/mixin_usage.rb +11 -1
  163. data/lib/rubocop/cop/style/multiline_memoization.rb +1 -1
  164. data/lib/rubocop/cop/style/multiline_when_then.rb +1 -1
  165. data/lib/rubocop/cop/style/nested_modifier.rb +22 -4
  166. data/lib/rubocop/cop/style/nested_parenthesized_calls.rb +5 -5
  167. data/lib/rubocop/cop/style/next.rb +5 -5
  168. data/lib/rubocop/cop/style/non_nil_check.rb +21 -9
  169. data/lib/rubocop/cop/style/numeric_literals.rb +7 -3
  170. data/lib/rubocop/cop/style/option_hash.rb +3 -3
  171. data/lib/rubocop/cop/style/or_assignment.rb +6 -1
  172. data/lib/rubocop/cop/style/parentheses_around_condition.rb +14 -0
  173. data/lib/rubocop/cop/style/{unneeded_capital_w.rb → redundant_capital_w.rb} +1 -1
  174. data/lib/rubocop/cop/style/{unneeded_condition.rb → redundant_condition.rb} +3 -3
  175. data/lib/rubocop/cop/style/{unneeded_interpolation.rb → redundant_interpolation.rb} +1 -1
  176. data/lib/rubocop/cop/style/redundant_parentheses.rb +16 -7
  177. data/lib/rubocop/cop/style/{unneeded_percent_q.rb → redundant_percent_q.rb} +1 -1
  178. data/lib/rubocop/cop/style/redundant_return.rb +39 -29
  179. data/lib/rubocop/cop/style/redundant_self.rb +18 -1
  180. data/lib/rubocop/cop/style/{unneeded_sort.rb → redundant_sort.rb} +5 -5
  181. data/lib/rubocop/cop/style/rescue_modifier.rb +24 -0
  182. data/lib/rubocop/cop/style/safe_navigation.rb +23 -3
  183. data/lib/rubocop/cop/style/semicolon.rb +13 -2
  184. data/lib/rubocop/cop/style/single_line_methods.rb +8 -1
  185. data/lib/rubocop/cop/style/special_global_vars.rb +5 -7
  186. data/lib/rubocop/cop/style/ternary_parentheses.rb +19 -0
  187. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +4 -6
  188. data/lib/rubocop/cop/style/trivial_accessors.rb +5 -5
  189. data/lib/rubocop/cop/style/variable_interpolation.rb +6 -16
  190. data/lib/rubocop/cop/team.rb +5 -0
  191. data/lib/rubocop/cop/util.rb +1 -1
  192. data/lib/rubocop/cop/utils/format_string.rb +120 -0
  193. data/lib/rubocop/cop/variable_force.rb +7 -5
  194. data/lib/rubocop/cop/variable_force/variable.rb +15 -2
  195. data/lib/rubocop/core_ext/string.rb +0 -24
  196. data/lib/rubocop/formatter/clang_style_formatter.rb +9 -6
  197. data/lib/rubocop/formatter/emacs_style_formatter.rb +22 -9
  198. data/lib/rubocop/formatter/file_list_formatter.rb +1 -1
  199. data/lib/rubocop/formatter/formatter_set.rb +16 -15
  200. data/lib/rubocop/formatter/pacman_formatter.rb +80 -0
  201. data/lib/rubocop/formatter/simple_text_formatter.rb +16 -4
  202. data/lib/rubocop/formatter/tap_formatter.rb +18 -7
  203. data/lib/rubocop/magic_comment.rb +4 -0
  204. data/lib/rubocop/node_pattern.rb +3 -1
  205. data/lib/rubocop/options.rb +17 -22
  206. data/lib/rubocop/path_util.rb +1 -1
  207. data/lib/rubocop/processed_source.rb +5 -1
  208. data/lib/rubocop/rake_task.rb +1 -0
  209. data/lib/rubocop/result_cache.rb +22 -8
  210. data/lib/rubocop/rspec/expect_offense.rb +4 -1
  211. data/lib/rubocop/runner.rb +55 -32
  212. data/lib/rubocop/target_finder.rb +12 -6
  213. data/lib/rubocop/version.rb +1 -1
  214. metadata +47 -32
  215. data/lib/rubocop/cop/mixin/ignored_method_patterns.rb +0 -19
  216. data/lib/rubocop/cop/mixin/safe_mode.rb +0 -22
@@ -117,7 +117,7 @@ module RuboCop
117
117
  end
118
118
 
119
119
  def correct_visibility?(node, modifier, ignored_methods)
120
- return true if modifier.nil? || modifier.method_name == :public
120
+ return true if modifier.nil? || modifier.method?(:public)
121
121
 
122
122
  ignored_methods.include?(node.method_name)
123
123
  end
@@ -17,21 +17,20 @@ module RuboCop
17
17
  #
18
18
  # "result is 10"
19
19
  class LiteralInInterpolation < Cop
20
+ include Interpolation
20
21
  include RangeHelp
21
22
  include PercentLiteral
22
23
 
23
24
  MSG = 'Literal interpolation detected.'
24
25
  COMPOSITE = %i[array hash pair irange erange].freeze
25
26
 
26
- def on_dstr(node)
27
- node.each_child_node(:begin) do |begin_node|
28
- final_node = begin_node.children.last
29
- next unless final_node
30
- next if special_keyword?(final_node)
31
- next unless prints_as_self?(final_node)
27
+ def on_interpolation(begin_node)
28
+ final_node = begin_node.children.last
29
+ return unless final_node
30
+ return if special_keyword?(final_node)
31
+ return unless prints_as_self?(final_node)
32
32
 
33
- add_offense(final_node)
34
- end
33
+ add_offense(final_node)
35
34
  end
36
35
 
37
36
  def autocorrect(node)
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # rubocop:disable Lint/UnneededCopDisableDirective
3
+ # rubocop:disable Lint/RedundantCopDisableDirective
4
4
  module RuboCop
5
5
  module Cop
6
6
  module Lint
@@ -81,4 +81,4 @@ module RuboCop
81
81
  end
82
82
  end
83
83
  end
84
- # rubocop:enable Lint/UnneededCopDisableDirective, Layout/SpaceAroundOperators
84
+ # rubocop:enable Lint/RedundantCopDisableDirective, Layout/SpaceAroundOperators
@@ -21,7 +21,7 @@ module RuboCop
21
21
  #
22
22
  # x < y && y < z
23
23
  # 10 <= x && x <= 20
24
- class MultipleCompare < Cop
24
+ class MultipleComparison < Cop
25
25
  MSG = 'Use the `&&` operator to compare multiple values.'
26
26
 
27
27
  def_node_matcher :multiple_compare?, <<~PATTERN
@@ -41,7 +41,7 @@ module RuboCop
41
41
 
42
42
  def on_send(node)
43
43
  to_method(node) do |receiver, to_method|
44
- next if date_time_object?(receiver)
44
+ next if receiver.nil? || date_time_object?(receiver)
45
45
 
46
46
  message = format(
47
47
  MSG,
@@ -1,8 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # The Lint/UnneededCopDisableDirective cop needs to be disabled so as
4
- # to be able to provide a (bad) example of an unneeded disable.
5
- # rubocop:disable Lint/UnneededCopDisableDirective
3
+ # The Lint/RedundantCopDisableDirective cop needs to be disabled so as
4
+ # to be able to provide a (bad) example of a redundant disable.
5
+ # rubocop:disable Lint/RedundantCopDisableDirective
6
6
  module RuboCop
7
7
  module Cop
8
8
  module Lint
@@ -25,21 +25,21 @@ module RuboCop
25
25
  #
26
26
  # # good
27
27
  # x += 1
28
- class UnneededCopDisableDirective < Cop
28
+ class RedundantCopDisableDirective < Cop
29
29
  include NameSimilarity
30
30
  include RangeHelp
31
31
 
32
- COP_NAME = 'Lint/UnneededCopDisableDirective'
32
+ COP_NAME = 'Lint/RedundantCopDisableDirective'
33
33
 
34
34
  def check(offenses, cop_disabled_line_ranges, comments)
35
- unneeded_cops = Hash.new { |h, k| h[k] = Set.new }
35
+ redundant_cops = Hash.new { |h, k| h[k] = Set.new }
36
36
 
37
- each_unneeded_disable(cop_disabled_line_ranges,
38
- offenses, comments) do |comment, unneeded_cop|
39
- unneeded_cops[comment].add(unneeded_cop)
37
+ each_redundant_disable(cop_disabled_line_ranges,
38
+ offenses, comments) do |comment, redundant_cop|
39
+ redundant_cops[comment].add(redundant_cop)
40
40
  end
41
41
 
42
- add_offenses(unneeded_cops)
42
+ add_offenses(redundant_cops)
43
43
  end
44
44
 
45
45
  def autocorrect(args)
@@ -89,8 +89,8 @@ module RuboCop
89
89
  newlines: false)
90
90
  end
91
91
 
92
- def each_unneeded_disable(cop_disabled_line_ranges, offenses, comments,
93
- &block)
92
+ def each_redundant_disable(cop_disabled_line_ranges, offenses, comments,
93
+ &block)
94
94
  disabled_ranges = cop_disabled_line_ranges[COP_NAME] || [0..0]
95
95
 
96
96
  cop_disabled_line_ranges.each do |cop, line_ranges|
@@ -110,9 +110,9 @@ module RuboCop
110
110
  comment = comments.find { |c| c.loc.line == line_range.begin }
111
111
  next if ignore_offense?(disabled_ranges, line_range)
112
112
 
113
- unneeded_cop = find_unneeded(comment, offenses, cop, line_range,
114
- line_ranges[ix + 1])
115
- yield comment, unneeded_cop if unneeded_cop
113
+ redundant_cop = find_redundant(comment, offenses, cop, line_range,
114
+ line_ranges[ix + 1])
115
+ yield comment, redundant_cop if redundant_cop
116
116
  end
117
117
  end
118
118
 
@@ -123,24 +123,24 @@ module RuboCop
123
123
 
124
124
  # If a cop is disabled in a range that begins on the same line as
125
125
  # the end of the previous range, it means that the cop was
126
- # already disabled by an earlier comment. So it's unneeded
126
+ # already disabled by an earlier comment. So it's redundant
127
127
  # whether there are offenses or not.
128
- unneeded_comment = comments.find do |c|
128
+ redundant_comment = comments.find do |c|
129
129
  c.loc.line == range.begin &&
130
130
  # Comments disabling all cops don't count since it's reasonable
131
131
  # to disable a few select cops first and then all cops further
132
132
  # down in the code.
133
133
  !all_disabled?(c)
134
134
  end
135
- yield unneeded_comment if unneeded_comment
135
+ yield redundant_comment if redundant_comment
136
136
  end
137
137
  end
138
138
 
139
- def find_unneeded(comment, offenses, cop, line_range, next_line_range)
139
+ def find_redundant(comment, offenses, cop, line_range, next_line_range)
140
140
  if all_disabled?(comment)
141
141
  # If there's a disable all comment followed by a comment
142
142
  # specifically disabling `cop`, we don't report the `all`
143
- # comment. If the disable all comment is truly unneeded, we will
143
+ # comment. If the disable all comment is truly redundant, we will
144
144
  # detect that when examining the comments of another cop, and we
145
145
  # get the full line range for the disable all.
146
146
  if (next_line_range.nil? ||
@@ -155,7 +155,7 @@ module RuboCop
155
155
  end
156
156
 
157
157
  def all_disabled?(comment)
158
- comment.text =~ /rubocop\s*:\s*disable\s+all\b/
158
+ comment.text =~ /rubocop\s*:\s*(?:disable|todo)\s+all\b/
159
159
  end
160
160
 
161
161
  def ignore_offense?(disabled_ranges, line_range)
@@ -170,8 +170,8 @@ module RuboCop
170
170
  cops_string.split(/,\s*/).size
171
171
  end
172
172
 
173
- def add_offenses(unneeded_cops)
174
- unneeded_cops.each do |comment, cops|
173
+ def add_offenses(redundant_cops)
174
+ redundant_cops.each do |comment, cops|
175
175
  if all_disabled?(comment) ||
176
176
  directive_count(comment) == cops.size
177
177
  add_offense_for_entire_comment(comment, cops)
@@ -260,4 +260,4 @@ module RuboCop
260
260
  end
261
261
  end
262
262
  end
263
- # rubocop:enable Lint/UnneededCopDisableDirective
263
+ # rubocop:enable Lint/RedundantCopDisableDirective
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # The Lint/UnneededCopEnableDirective cop needs to be disabled so as
3
+ # The Lint/RedundantCopEnableDirective cop needs to be disabled so as
4
4
  # to be able to provide a (bad) example of an unneeded enable.
5
5
 
6
- # rubocop:disable Lint/UnneededCopEnableDirective
6
+ # rubocop:disable Lint/RedundantCopEnableDirective
7
7
  module RuboCop
8
8
  module Cop
9
9
  module Lint
@@ -32,7 +32,7 @@ module RuboCop
32
32
  # baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaarrrrrrrrrrrrr
33
33
  # # rubocop:enable all
34
34
  # baz
35
- class UnneededCopEnableDirective < Cop
35
+ class RedundantCopEnableDirective < Cop
36
36
  include RangeHelp
37
37
  include SurroundingSpace
38
38
 
@@ -94,16 +94,14 @@ module RuboCop
94
94
 
95
95
  def range_to_remove(begin_pos, end_pos, comma_pos, comment)
96
96
  start = comment_start(comment)
97
- buffer = processed_source.buffer
98
- range_class = Parser::Source::Range
99
97
 
100
98
  case comma_pos
101
99
  when :before
102
- range_class.new(buffer, start + begin_pos - 1, start + end_pos)
100
+ range_between(start + begin_pos - 1, start + end_pos)
103
101
  when :after
104
- range_class.new(buffer, start + begin_pos, start + end_pos + 1)
102
+ range_between(start + begin_pos, start + end_pos + 1)
105
103
  else
106
- range_class.new(buffer, start, comment.loc.expression.end_pos)
104
+ range_between(start, comment.loc.expression.end_pos)
107
105
  end
108
106
  end
109
107
 
@@ -21,7 +21,7 @@ module RuboCop
21
21
  #
22
22
  # # good
23
23
  # require 'unloaded_feature'
24
- class UnneededRequireStatement < Cop
24
+ class RedundantRequireStatement < Cop
25
25
  include RangeHelp
26
26
 
27
27
  MSG = 'Remove unnecessary `require` statement.'
@@ -49,7 +49,7 @@ module RuboCop
49
49
  # else
50
50
  # baz
51
51
  # end
52
- class UnneededSplatExpansion < Cop
52
+ class RedundantSplatExpansion < Cop
53
53
  MSG = 'Replace splat expansion with comma separated values.'
54
54
  ARRAY_PARAM_MSG = 'Pass array contents as separate arguments.'
55
55
  PERCENT_W = '%w'
@@ -58,14 +58,19 @@ module RuboCop
58
58
  PERCENT_CAPITAL_I = '%I'
59
59
  ASSIGNMENT_TYPES = %i[lvasgn ivasgn cvasgn gvasgn].freeze
60
60
 
61
- def_node_matcher :array_new?, '$(send (const nil? :Array) :new ...)'
61
+ def_node_matcher :array_new?, <<~PATTERN
62
+ {
63
+ $(send (const nil? :Array) :new ...)
64
+ $(block (send (const nil? :Array) :new ...) ...)
65
+ }
66
+ PATTERN
62
67
 
63
68
  def_node_matcher :literal_expansion, <<~PATTERN
64
69
  (splat {$({str dstr int float array} ...) (block $#array_new? ...) $#array_new?} ...)
65
70
  PATTERN
66
71
 
67
72
  def on_splat(node)
68
- unneeded_splat_expansion(node) do
73
+ redundant_splat_expansion(node) do
69
74
  if array_splat?(node) &&
70
75
  (method_argument?(node) || part_of_an_array?(node))
71
76
  add_offense(node, message: ARRAY_PARAM_MSG)
@@ -85,7 +90,7 @@ module RuboCop
85
90
 
86
91
  private
87
92
 
88
- def unneeded_splat_expansion(node)
93
+ def redundant_splat_expansion(node)
89
94
  literal_expansion(node) do |expanded_item|
90
95
  if expanded_item.send_type?
91
96
  return if array_new_inside_array_literal?(expanded_item)
@@ -114,7 +119,7 @@ module RuboCop
114
119
  [node.parent.loc.expression, variable.source]
115
120
  elsif !variable.array_type?
116
121
  [loc.expression, "[#{variable.source}]"]
117
- elsif unneeded_brackets?(node)
122
+ elsif redundant_brackets?(node)
118
123
  [loc.expression, remove_brackets(variable)]
119
124
  else
120
125
  [loc.operator, '']
@@ -136,12 +141,12 @@ module RuboCop
136
141
  parent.array_type? && parent.loc.begin && parent.loc.end
137
142
  end
138
143
 
139
- def unneeded_brackets?(node)
144
+ def redundant_brackets?(node)
140
145
  parent = node.parent
141
146
  grandparent = node.parent.parent
142
147
 
143
148
  parent.when_type? || parent.send_type? || part_of_an_array?(node) ||
144
- (grandparent&.resbody_type?)
149
+ grandparent&.resbody_type?
145
150
  end
146
151
 
147
152
  def remove_brackets(array)
@@ -17,21 +17,21 @@ module RuboCop
17
17
  # # good
18
18
  #
19
19
  # "result is #{something}"
20
- class StringConversionInInterpolation < Cop
20
+ class RedundantStringCoercion < Cop
21
+ include Interpolation
22
+
21
23
  MSG_DEFAULT = 'Redundant use of `Object#to_s` in interpolation.'
22
24
  MSG_SELF = 'Use `self` instead of `Object#to_s` in ' \
23
25
  'interpolation.'
24
26
 
25
27
  def_node_matcher :to_s_without_args?, '(send _ :to_s)'
26
28
 
27
- def on_dstr(node)
28
- node.each_child_node(:begin) do |begin_node|
29
- final_node = begin_node.children.last
29
+ def on_interpolation(begin_node)
30
+ final_node = begin_node.children.last
30
31
 
31
- next unless to_s_without_args?(final_node)
32
+ return unless to_s_without_args?(final_node)
32
33
 
33
- add_offense(final_node, location: :selector)
34
- end
34
+ add_offense(final_node, location: :selector)
35
35
  end
36
36
 
37
37
  def autocorrect(node)
@@ -50,7 +50,7 @@ module RuboCop
50
50
  def autocorrect(node)
51
51
  lambda do |corrector|
52
52
  redundant_with_index?(node) do |send|
53
- if send.method_name == :each_with_index
53
+ if send.method?(:each_with_index)
54
54
  corrector.replace(send.loc.selector, 'each')
55
55
  else
56
56
  corrector.remove(with_index_range(send))
@@ -63,7 +63,7 @@ module RuboCop
63
63
  private
64
64
 
65
65
  def message(node)
66
- if node.method_name == :each_with_index
66
+ if node.method?(:each_with_index)
67
67
  MSG_EACH_WITH_INDEX
68
68
  else
69
69
  MSG_WITH_INDEX
@@ -51,7 +51,7 @@ module RuboCop
51
51
  def autocorrect(node)
52
52
  lambda do |corrector|
53
53
  redundant_with_object?(node) do |send|
54
- if send.method_name == :each_with_object
54
+ if send.method?(:each_with_object)
55
55
  corrector.replace(with_object_range(send), 'each')
56
56
  else
57
57
  corrector.remove(with_object_range(send))
@@ -64,7 +64,7 @@ module RuboCop
64
64
  private
65
65
 
66
66
  def message(node)
67
- if node.method_name == :each_with_object
67
+ if node.method?(:each_with_object)
68
68
  MSG_EACH_WITH_OBJECT
69
69
  else
70
70
  MSG_WITH_OBJECT
@@ -42,9 +42,9 @@ module RuboCop
42
42
 
43
43
  method_chain = method_chain(node)
44
44
  location =
45
- Parser::Source::Range.new(node.loc.expression.source_buffer,
46
- safe_nav.loc.expression.end_pos,
47
- method_chain.loc.expression.end_pos)
45
+ Parser::Source::Range.new(node.source_range.source_buffer,
46
+ safe_nav.source_range.end_pos,
47
+ method_chain.source_range.end_pos)
48
48
  add_offense(node, location: location)
49
49
  end
50
50
  end
@@ -54,9 +54,8 @@ module RuboCop
54
54
  def method_chain(node)
55
55
  chain = node
56
56
  while chain.send_type?
57
- chain = chain.parent if chain.parent &&
58
- %i[send csend].include?(chain.parent.type)
59
- break
57
+ chain = chain.parent if chain.parent&.call_type?
58
+ break # FIXME: Unconditional break. Why while "loop" then?
60
59
  end
61
60
  chain
62
61
  end
@@ -0,0 +1,91 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ module Lint
6
+ #
7
+ # This cop checks for `send`, `public_send`, and `__send__` methods
8
+ # when using mix-in.
9
+ #
10
+ # `include` and `prepend` methods were private methods until Ruby 2.0,
11
+ # they were mixed-in via `send` method. This cop uses Ruby 2.1 or
12
+ # higher style that can be called by public methods.
13
+ # And `extend` method that was originally a public method is also targeted
14
+ # for style unification.
15
+ #
16
+ # @example
17
+ # # bad
18
+ # Foo.send(:include, Bar)
19
+ # Foo.send(:prepend, Bar)
20
+ # Foo.send(:extend, Bar)
21
+ #
22
+ # # bad
23
+ # Foo.public_send(:include, Bar)
24
+ # Foo.public_send(:prepend, Bar)
25
+ # Foo.public_send(:extend, Bar)
26
+ #
27
+ # # bad
28
+ # Foo.__send__(:include, Bar)
29
+ # Foo.__send__(:prepend, Bar)
30
+ # Foo.__send__(:extend, Bar)
31
+ #
32
+ # # good
33
+ # Foo.include Bar
34
+ # Foo.prepend Bar
35
+ # Foo.extend Bar
36
+ #
37
+ class SendWithMixinArgument < Cop
38
+ include RangeHelp
39
+
40
+ MSG = 'Use `%<method>s %<module_name>s` instead of `%<bad_method>s`.'
41
+ MIXIN_METHODS = %i[include prepend extend].freeze
42
+
43
+ def_node_matcher :send_with_mixin_argument?, <<~PATTERN
44
+ (send
45
+ (const _ _) {:send :public_send :__send__}
46
+ ({sym str} $#mixin_method?)
47
+ $(const _ _))
48
+ PATTERN
49
+
50
+ def on_send(node)
51
+ send_with_mixin_argument?(node) do |method, module_name|
52
+ message = message(
53
+ method, module_name.source, bad_location(node).source
54
+ )
55
+
56
+ add_offense(node, location: bad_location(node), message: message)
57
+ end
58
+ end
59
+
60
+ def autocorrect(node)
61
+ send_with_mixin_argument?(node) do |method, module_name|
62
+ lambda do |corrector|
63
+ corrector.replace(
64
+ bad_location(node), "#{method} #{module_name.source}"
65
+ )
66
+ end
67
+ end
68
+ end
69
+
70
+ private
71
+
72
+ def bad_location(node)
73
+ loc = node.loc
74
+
75
+ range_between(loc.selector.begin_pos, loc.expression.end_pos)
76
+ end
77
+
78
+ def message(method, module_name, bad_method)
79
+ format(
80
+ MSG,
81
+ method: method, module_name: module_name, bad_method: bad_method
82
+ )
83
+ end
84
+
85
+ def mixin_method?(node)
86
+ MIXIN_METHODS.include?(node.to_sym)
87
+ end
88
+ end
89
+ end
90
+ end
91
+ end