rubocop 0.72.0 → 0.76.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 (249) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -1
  3. data/bin/console +1 -0
  4. data/config/default.yml +93 -56
  5. data/lib/rubocop.rb +21 -10
  6. data/lib/rubocop/ast/builder.rb +1 -0
  7. data/lib/rubocop/ast/node.rb +12 -14
  8. data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +4 -4
  9. data/lib/rubocop/ast/node/return_node.rb +24 -0
  10. data/lib/rubocop/ast/traversal.rb +3 -3
  11. data/lib/rubocop/cli.rb +7 -4
  12. data/lib/rubocop/comment_config.rb +5 -4
  13. data/lib/rubocop/config.rb +28 -537
  14. data/lib/rubocop/config_loader.rb +21 -3
  15. data/lib/rubocop/config_loader_resolver.rb +4 -3
  16. data/lib/rubocop/config_obsoletion.rb +222 -0
  17. data/lib/rubocop/config_validator.rb +248 -0
  18. data/lib/rubocop/cop/autocorrect_logic.rb +71 -1
  19. data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +1 -1
  20. data/lib/rubocop/cop/bundler/ordered_gems.rb +1 -1
  21. data/lib/rubocop/cop/commissioner.rb +18 -16
  22. data/lib/rubocop/cop/cop.rb +49 -14
  23. data/lib/rubocop/cop/corrector.rb +10 -10
  24. data/lib/rubocop/cop/correctors/alignment_corrector.rb +43 -17
  25. data/lib/rubocop/cop/correctors/empty_line_corrector.rb +2 -2
  26. data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb +2 -2
  27. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +1 -1
  28. data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +2 -2
  29. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +1 -1
  30. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +1 -1
  31. data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +1 -1
  32. data/lib/rubocop/cop/generator.rb +4 -4
  33. data/lib/rubocop/cop/generator/configuration_injector.rb +9 -4
  34. data/lib/rubocop/cop/generator/require_file_injector.rb +1 -1
  35. data/lib/rubocop/cop/internal_affairs/node_destructuring.rb +2 -2
  36. data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +1 -1
  37. data/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb +2 -2
  38. data/lib/rubocop/cop/internal_affairs/redundant_location_argument.rb +1 -1
  39. data/lib/rubocop/cop/internal_affairs/redundant_message_argument.rb +2 -2
  40. data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +2 -2
  41. data/lib/rubocop/cop/layout/align_hash.rb +6 -2
  42. data/lib/rubocop/cop/layout/block_alignment.rb +3 -3
  43. data/lib/rubocop/cop/layout/class_structure.rb +1 -1
  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 +14 -59
  52. data/lib/rubocop/cop/layout/indent_assignment.rb +10 -1
  53. data/lib/rubocop/cop/layout/indent_first_argument.rb +10 -8
  54. data/lib/rubocop/cop/layout/indent_first_hash_element.rb +1 -1
  55. data/lib/rubocop/cop/layout/indent_heredoc.rb +4 -3
  56. data/lib/rubocop/cop/layout/indentation_width.rb +20 -6
  57. data/lib/rubocop/cop/layout/leading_comment_space.rb +28 -0
  58. data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +1 -1
  59. data/lib/rubocop/cop/layout/multiline_block_layout.rb +24 -2
  60. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +20 -4
  61. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +5 -1
  62. data/lib/rubocop/cop/layout/space_around_operators.rb +42 -23
  63. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +9 -7
  64. data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb +8 -5
  65. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +21 -2
  66. data/lib/rubocop/cop/layout/space_inside_parens.rb +6 -6
  67. data/lib/rubocop/cop/layout/space_inside_string_interpolation.rb +24 -40
  68. data/lib/rubocop/cop/layout/tab.rb +10 -22
  69. data/lib/rubocop/cop/layout/trailing_whitespace.rb +18 -2
  70. data/lib/rubocop/cop/lint/assignment_in_condition.rb +17 -4
  71. data/lib/rubocop/cop/lint/big_decimal_new.rb +1 -1
  72. data/lib/rubocop/cop/lint/debugger.rb +4 -6
  73. data/lib/rubocop/cop/lint/duplicate_methods.rb +3 -3
  74. data/lib/rubocop/cop/lint/each_with_object_argument.rb +1 -1
  75. data/lib/rubocop/cop/lint/empty_interpolation.rb +4 -4
  76. data/lib/rubocop/cop/lint/erb_new_arguments.rb +62 -5
  77. data/lib/rubocop/cop/lint/format_parameter_mismatch.rb +11 -37
  78. data/lib/rubocop/cop/lint/ineffective_access_modifier.rb +1 -1
  79. data/lib/rubocop/cop/lint/inherit_exception.rb +1 -1
  80. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +7 -8
  81. data/lib/rubocop/cop/lint/missing_cop_enable_directive.rb +2 -2
  82. data/lib/rubocop/cop/lint/multiple_compare.rb +1 -1
  83. data/lib/rubocop/cop/lint/nested_method_definition.rb +3 -3
  84. data/lib/rubocop/cop/lint/next_without_accumulator.rb +1 -1
  85. data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb +1 -1
  86. data/lib/rubocop/cop/lint/number_conversion.rb +3 -3
  87. data/lib/rubocop/cop/lint/rand_one.rb +1 -1
  88. data/lib/rubocop/cop/lint/{unneeded_cop_disable_directive.rb → redundant_cop_disable_directive.rb} +24 -24
  89. data/lib/rubocop/cop/lint/{unneeded_cop_enable_directive.rb → redundant_cop_enable_directive.rb} +6 -8
  90. data/lib/rubocop/cop/lint/{unneeded_require_statement.rb → redundant_require_statement.rb} +2 -2
  91. data/lib/rubocop/cop/lint/{unneeded_splat_expansion.rb → redundant_splat_expansion.rb} +12 -7
  92. data/lib/rubocop/cop/lint/redundant_with_index.rb +1 -1
  93. data/lib/rubocop/cop/lint/redundant_with_object.rb +1 -1
  94. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +10 -11
  95. data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb +1 -1
  96. data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +91 -0
  97. data/lib/rubocop/cop/lint/string_conversion_in_interpolation.rb +6 -6
  98. data/lib/rubocop/cop/lint/unified_integer.rb +1 -1
  99. data/lib/rubocop/cop/lint/unreachable_code.rb +1 -1
  100. data/lib/rubocop/cop/lint/unused_block_argument.rb +22 -6
  101. data/lib/rubocop/cop/lint/unused_method_argument.rb +23 -5
  102. data/lib/rubocop/cop/lint/uri_escape_unescape.rb +1 -1
  103. data/lib/rubocop/cop/lint/uri_regexp.rb +2 -2
  104. data/lib/rubocop/cop/lint/useless_access_modifier.rb +6 -6
  105. data/lib/rubocop/cop/lint/useless_setter_call.rb +1 -1
  106. data/lib/rubocop/cop/lint/void.rb +7 -26
  107. data/lib/rubocop/cop/message_annotator.rb +16 -7
  108. data/lib/rubocop/cop/metrics/abc_size.rb +1 -1
  109. data/lib/rubocop/cop/metrics/class_length.rb +1 -1
  110. data/lib/rubocop/cop/metrics/line_length.rb +7 -4
  111. data/lib/rubocop/cop/metrics/module_length.rb +1 -1
  112. data/lib/rubocop/cop/metrics/parameter_lists.rb +1 -1
  113. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +23 -6
  114. data/lib/rubocop/cop/migration/department_name.rb +44 -0
  115. data/lib/rubocop/cop/mixin/alignment.rb +1 -1
  116. data/lib/rubocop/cop/mixin/def_node.rb +1 -1
  117. data/lib/rubocop/cop/mixin/documentation_comment.rb +0 -2
  118. data/lib/rubocop/cop/mixin/empty_parameter.rb +1 -1
  119. data/lib/rubocop/cop/mixin/enforce_superclass.rb +4 -4
  120. data/lib/rubocop/cop/mixin/frozen_string_literal.rb +1 -1
  121. data/lib/rubocop/cop/mixin/interpolation.rb +27 -0
  122. data/lib/rubocop/cop/mixin/method_complexity.rb +3 -2
  123. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +3 -3
  124. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +87 -0
  125. data/lib/rubocop/cop/mixin/safe_mode.rb +2 -0
  126. data/lib/rubocop/cop/mixin/statement_modifier.rb +5 -2
  127. data/lib/rubocop/cop/mixin/surrounding_space.rb +7 -5
  128. data/lib/rubocop/cop/mixin/trailing_comma.rb +8 -6
  129. data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +1 -1
  130. data/lib/rubocop/cop/naming/constant_name.rb +2 -2
  131. data/lib/rubocop/cop/naming/file_name.rb +12 -5
  132. data/lib/rubocop/cop/naming/method_name.rb +12 -1
  133. data/lib/rubocop/cop/naming/predicate_name.rb +1 -1
  134. data/lib/rubocop/cop/naming/variable_name.rb +1 -0
  135. data/lib/rubocop/cop/offense.rb +18 -7
  136. data/lib/rubocop/cop/registry.rb +22 -1
  137. data/lib/rubocop/cop/security/eval.rb +1 -1
  138. data/lib/rubocop/cop/security/json_load.rb +1 -1
  139. data/lib/rubocop/cop/security/marshal_load.rb +1 -1
  140. data/lib/rubocop/cop/security/open.rb +1 -1
  141. data/lib/rubocop/cop/security/yaml_load.rb +1 -1
  142. data/lib/rubocop/cop/style/access_modifier_declarations.rb +1 -0
  143. data/lib/rubocop/cop/style/alias.rb +1 -1
  144. data/lib/rubocop/cop/style/attr.rb +2 -2
  145. data/lib/rubocop/cop/style/block_delimiters.rb +2 -1
  146. data/lib/rubocop/cop/style/braces_around_hash_parameters.rb +35 -16
  147. data/lib/rubocop/cop/style/class_and_module_children.rb +1 -1
  148. data/lib/rubocop/cop/style/colon_method_call.rb +1 -1
  149. data/lib/rubocop/cop/style/comment_annotation.rb +5 -5
  150. data/lib/rubocop/cop/style/commented_keyword.rb +16 -30
  151. data/lib/rubocop/cop/style/conditional_assignment.rb +6 -8
  152. data/lib/rubocop/cop/style/constant_visibility.rb +14 -3
  153. data/lib/rubocop/cop/style/copyright.rb +11 -7
  154. data/lib/rubocop/cop/style/date_time.rb +3 -3
  155. data/lib/rubocop/cop/style/dir.rb +1 -1
  156. data/lib/rubocop/cop/style/documentation_method.rb +45 -1
  157. data/lib/rubocop/cop/style/double_cop_disable_directive.rb +55 -0
  158. data/lib/rubocop/cop/style/each_for_simple_loop.rb +1 -1
  159. data/lib/rubocop/cop/style/each_with_object.rb +1 -1
  160. data/lib/rubocop/cop/style/empty_case_condition.rb +2 -2
  161. data/lib/rubocop/cop/style/empty_literal.rb +2 -2
  162. data/lib/rubocop/cop/style/empty_method.rb +5 -5
  163. data/lib/rubocop/cop/style/eval_with_location.rb +2 -2
  164. data/lib/rubocop/cop/style/even_odd.rb +1 -1
  165. data/lib/rubocop/cop/style/expand_path_arguments.rb +4 -4
  166. data/lib/rubocop/cop/style/float_division.rb +4 -4
  167. data/lib/rubocop/cop/style/format_string.rb +17 -14
  168. data/lib/rubocop/cop/style/format_string_token.rb +19 -68
  169. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +28 -33
  170. data/lib/rubocop/cop/style/guard_clause.rb +39 -10
  171. data/lib/rubocop/cop/style/hash_syntax.rb +4 -4
  172. data/lib/rubocop/cop/style/if_unless_modifier.rb +58 -15
  173. data/lib/rubocop/cop/style/infinite_loop.rb +5 -4
  174. data/lib/rubocop/cop/style/inverse_methods.rb +21 -15
  175. data/lib/rubocop/cop/style/lambda.rb +0 -2
  176. data/lib/rubocop/cop/style/line_end_concatenation.rb +14 -10
  177. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +25 -25
  178. data/lib/rubocop/cop/style/method_def_parentheses.rb +17 -9
  179. data/lib/rubocop/cop/style/min_max.rb +1 -1
  180. data/lib/rubocop/cop/style/mixin_usage.rb +12 -2
  181. data/lib/rubocop/cop/style/multiline_memoization.rb +1 -1
  182. data/lib/rubocop/cop/style/multiline_when_then.rb +55 -0
  183. data/lib/rubocop/cop/style/multiple_comparison.rb +1 -1
  184. data/lib/rubocop/cop/style/mutable_constant.rb +3 -3
  185. data/lib/rubocop/cop/style/nested_modifier.rb +22 -4
  186. data/lib/rubocop/cop/style/non_nil_check.rb +21 -9
  187. data/lib/rubocop/cop/style/numeric_predicate.rb +3 -3
  188. data/lib/rubocop/cop/style/option_hash.rb +1 -1
  189. data/lib/rubocop/cop/style/or_assignment.rb +8 -3
  190. data/lib/rubocop/cop/style/parentheses_around_condition.rb +15 -1
  191. data/lib/rubocop/cop/style/random_with_offset.rb +6 -6
  192. data/lib/rubocop/cop/style/{unneeded_capital_w.rb → redundant_capital_w.rb} +1 -1
  193. data/lib/rubocop/cop/style/{unneeded_condition.rb → redundant_condition.rb} +3 -3
  194. data/lib/rubocop/cop/style/redundant_conditional.rb +2 -2
  195. data/lib/rubocop/cop/style/redundant_exception.rb +2 -2
  196. data/lib/rubocop/cop/style/redundant_freeze.rb +1 -1
  197. data/lib/rubocop/cop/style/{unneeded_interpolation.rb → redundant_interpolation.rb} +1 -1
  198. data/lib/rubocop/cop/style/redundant_parentheses.rb +15 -6
  199. data/lib/rubocop/cop/style/{unneeded_percent_q.rb → redundant_percent_q.rb} +1 -1
  200. data/lib/rubocop/cop/style/redundant_return.rb +37 -21
  201. data/lib/rubocop/cop/style/redundant_self.rb +18 -1
  202. data/lib/rubocop/cop/style/{unneeded_sort.rb → redundant_sort.rb} +4 -4
  203. data/lib/rubocop/cop/style/redundant_sort_by.rb +1 -1
  204. data/lib/rubocop/cop/style/rescue_modifier.rb +24 -0
  205. data/lib/rubocop/cop/style/rescue_standard_error.rb +2 -2
  206. data/lib/rubocop/cop/style/return_nil.rb +1 -1
  207. data/lib/rubocop/cop/style/safe_navigation.rb +24 -4
  208. data/lib/rubocop/cop/style/sample.rb +1 -1
  209. data/lib/rubocop/cop/style/semicolon.rb +13 -2
  210. data/lib/rubocop/cop/style/single_line_methods.rb +8 -1
  211. data/lib/rubocop/cop/style/special_global_vars.rb +5 -7
  212. data/lib/rubocop/cop/style/stderr_puts.rb +1 -1
  213. data/lib/rubocop/cop/style/string_hash_keys.rb +2 -2
  214. data/lib/rubocop/cop/style/strip.rb +1 -1
  215. data/lib/rubocop/cop/style/struct_inheritance.rb +3 -3
  216. data/lib/rubocop/cop/style/symbol_proc.rb +1 -1
  217. data/lib/rubocop/cop/style/ternary_parentheses.rb +20 -1
  218. data/lib/rubocop/cop/style/trailing_method_end_statement.rb +4 -6
  219. data/lib/rubocop/cop/style/trivial_accessors.rb +1 -1
  220. data/lib/rubocop/cop/style/unpack_first.rb +1 -1
  221. data/lib/rubocop/cop/style/variable_interpolation.rb +6 -16
  222. data/lib/rubocop/cop/style/zero_length_predicate.rb +5 -5
  223. data/lib/rubocop/cop/team.rb +15 -14
  224. data/lib/rubocop/cop/util.rb +1 -1
  225. data/lib/rubocop/cop/utils/format_string.rb +120 -0
  226. data/lib/rubocop/cop/variable_force.rb +7 -5
  227. data/lib/rubocop/cop/variable_force/variable.rb +15 -2
  228. data/lib/rubocop/core_ext/string.rb +0 -24
  229. data/lib/rubocop/error.rb +23 -0
  230. data/lib/rubocop/formatter/clang_style_formatter.rb +8 -3
  231. data/lib/rubocop/formatter/emacs_style_formatter.rb +22 -9
  232. data/lib/rubocop/formatter/file_list_formatter.rb +1 -1
  233. data/lib/rubocop/formatter/formatter_set.rb +16 -15
  234. data/lib/rubocop/formatter/pacman_formatter.rb +80 -0
  235. data/lib/rubocop/formatter/simple_text_formatter.rb +16 -4
  236. data/lib/rubocop/formatter/tap_formatter.rb +17 -4
  237. data/lib/rubocop/magic_comment.rb +4 -0
  238. data/lib/rubocop/node_pattern.rb +5 -3
  239. data/lib/rubocop/options.rb +33 -21
  240. data/lib/rubocop/path_util.rb +1 -1
  241. data/lib/rubocop/processed_source.rb +4 -0
  242. data/lib/rubocop/result_cache.rb +1 -1
  243. data/lib/rubocop/rspec/expect_offense.rb +4 -1
  244. data/lib/rubocop/rspec/shared_contexts.rb +12 -0
  245. data/lib/rubocop/runner.rb +42 -31
  246. data/lib/rubocop/target_finder.rb +12 -4
  247. data/lib/rubocop/version.rb +1 -1
  248. metadata +21 -12
  249. data/lib/rubocop/cop/mixin/ignored_method_patterns.rb +0 -19
@@ -28,7 +28,7 @@ module RuboCop
28
28
  # def value?
29
29
  # end
30
30
  class PredicateName < Cop
31
- def_node_matcher :dynamic_method_define, <<-PATTERN
31
+ def_node_matcher :dynamic_method_define, <<~PATTERN
32
32
  (send nil? #method_definition_macros
33
33
  (sym $_)
34
34
  ...)
@@ -39,6 +39,7 @@ module RuboCop
39
39
  alias on_kwarg on_lvasgn
40
40
  alias on_kwrestarg on_lvasgn
41
41
  alias on_blockarg on_lvasgn
42
+ alias on_lvar on_lvasgn
42
43
 
43
44
  private
44
45
 
@@ -67,23 +67,34 @@ module RuboCop
67
67
 
68
68
  # @api public
69
69
  #
70
- # @!attribute [r] corrected
70
+ # @!attribute [r] corrected?
71
71
  #
72
72
  # @return [Boolean]
73
- # whether this offense is automatically corrected.
74
- def corrected
75
- @status == :corrected
73
+ # whether this offense is automatically corrected via
74
+ # autocorrect or a todo.
75
+ def corrected?
76
+ @status == :corrected || @status == :corrected_with_todo
77
+ end
78
+
79
+ # @api public
80
+ #
81
+ # @!attribute [r] corrected_with_todo?
82
+ #
83
+ # @return [Boolean]
84
+ # whether this offense is automatically disabled via a todo.
85
+ def corrected_with_todo?
86
+ @status == :corrected_with_todo
76
87
  end
77
- alias corrected? corrected
78
88
 
79
89
  # @api public
80
90
  #
81
91
  # @!attribute [r] disabled?
82
92
  #
83
93
  # @return [Boolean]
84
- # whether this offense was locally disabled where it occurred
94
+ # whether this offense was locally disabled with a
95
+ # disable or todo where it occurred.
85
96
  def disabled?
86
- @status == :disabled
97
+ @status == :disabled || @status == :todo
87
98
  end
88
99
 
89
100
  # @api public
@@ -91,8 +91,11 @@ module RuboCop
91
91
  # @note Emits a warning if the provided name has an incorrect namespace
92
92
  #
93
93
  # @return [String] Qualified cop name
94
- def qualified_cop_name(name, path)
94
+ def qualified_cop_name(name, path, shall_warn = true)
95
95
  badge = Badge.parse(name)
96
+ if shall_warn && department_missing?(badge, name)
97
+ print_warning(name, path)
98
+ end
96
99
  return name if registered?(badge)
97
100
 
98
101
  potential_badges = qualify_badge(badge)
@@ -104,6 +107,24 @@ module RuboCop
104
107
  end
105
108
  end
106
109
 
110
+ def department_missing?(badge, name)
111
+ !badge.qualified? && unqualified_cop_names.include?(name)
112
+ end
113
+
114
+ def print_warning(name, path)
115
+ message = "#{path}: Warning: no department given for #{name}."
116
+ if path.end_with?('.rb')
117
+ message += ' Run `rubocop -a --only Migration/DepartmentName` to fix.'
118
+ end
119
+ warn message
120
+ end
121
+
122
+ def unqualified_cop_names
123
+ @unqualified_cop_names ||=
124
+ Set.new(@cops_by_cop_name.keys.map { |qn| File.basename(qn) }) <<
125
+ 'RedundantCopDisableDirective'
126
+ end
127
+
107
128
  # @return [Hash{String => Array<Class>}]
108
129
  def to_h
109
130
  @cops_by_cop_name
@@ -14,7 +14,7 @@ module RuboCop
14
14
  class Eval < Cop
15
15
  MSG = 'The use of `eval` is a serious security risk.'
16
16
 
17
- def_node_matcher :eval?, <<-PATTERN
17
+ def_node_matcher :eval?, <<~PATTERN
18
18
  (send {nil? (send nil? :binding)} :eval $!str ...)
19
19
  PATTERN
20
20
 
@@ -25,7 +25,7 @@ module RuboCop
25
25
  class JSONLoad < Cop
26
26
  MSG = 'Prefer `JSON.parse` over `JSON.%<method>s`.'
27
27
 
28
- def_node_matcher :json_load, <<-PATTERN
28
+ def_node_matcher :json_load, <<~PATTERN
29
29
  (send (const {nil? cbase} :JSON) ${:load :restore} ...)
30
30
  PATTERN
31
31
 
@@ -21,7 +21,7 @@ module RuboCop
21
21
  class MarshalLoad < Cop
22
22
  MSG = 'Avoid using `Marshal.%<method>s`.'
23
23
 
24
- def_node_matcher :marshal_load, <<-PATTERN
24
+ def_node_matcher :marshal_load, <<~PATTERN
25
25
  (send (const {nil? cbase} :Marshal) ${:load :restore}
26
26
  !(send (const {nil? cbase} :Marshal) :dump ...))
27
27
  PATTERN
@@ -22,7 +22,7 @@ module RuboCop
22
22
  class Open < Cop
23
23
  MSG = 'The use of `Kernel#open` is a serious security risk.'
24
24
 
25
- def_node_matcher :open?, <<-PATTERN
25
+ def_node_matcher :open?, <<~PATTERN
26
26
  (send nil? :open $!str ...)
27
27
  PATTERN
28
28
 
@@ -18,7 +18,7 @@ module RuboCop
18
18
  class YAMLLoad < Cop
19
19
  MSG = 'Prefer using `YAML.safe_load` over `YAML.load`.'
20
20
 
21
- def_node_matcher :yaml_load, <<-PATTERN
21
+ def_node_matcher :yaml_load, <<~PATTERN
22
22
  (send (const {nil? cbase} :YAML) :load ...)
23
23
  PATTERN
24
24
 
@@ -63,6 +63,7 @@ module RuboCop
63
63
 
64
64
  def on_send(node)
65
65
  return unless node.access_modifier?
66
+ return if node.parent.pair_type?
66
67
 
67
68
  if offense?(node)
68
69
  add_offense(node, location: :selector) do
@@ -138,7 +138,7 @@ module RuboCop
138
138
  end
139
139
  end
140
140
 
141
- def_node_matcher :identifier, <<-PATTERN
141
+ def_node_matcher :identifier, <<~PATTERN
142
142
  (sym $_)
143
143
  PATTERN
144
144
  end
@@ -31,7 +31,7 @@ module RuboCop
31
31
  node_expr = node.source_range
32
32
  attr_expr = attr_name.source_range
33
33
 
34
- if setter && (setter.true_type? || setter.false_type?)
34
+ if setter&.boolean_type?
35
35
  remove = range_between(attr_expr.end_pos, node_expr.end_pos)
36
36
  end
37
37
 
@@ -50,7 +50,7 @@ module RuboCop
50
50
  def replacement_method(node)
51
51
  setter = node.last_argument
52
52
 
53
- if setter && (setter.true_type? || setter.false_type?)
53
+ if setter&.boolean_type?
54
54
  setter.true_type? ? 'attr_accessor' : 'attr_reader'
55
55
  else
56
56
  'attr_reader'
@@ -114,7 +114,8 @@ module RuboCop
114
114
 
115
115
  def on_send(node)
116
116
  return unless node.arguments?
117
- return if node.parenthesized? || node.operator_method?
117
+ return if node.parenthesized?
118
+ return if node.operator_method? || node.assignment_method?
118
119
 
119
120
  node.arguments.each do |arg|
120
121
  get_blocks(arg) do |block|
@@ -55,10 +55,6 @@ module RuboCop
55
55
  end
56
56
  alias on_csend on_send
57
57
 
58
- # We let AutocorrectUnlessChangingAST#autocorrect work with the send
59
- # node, because that context is needed. When parsing the code to see if
60
- # the AST has changed, a braceless hash would not be parsed as a hash
61
- # otherwise.
62
58
  def autocorrect(send_node)
63
59
  hash_node = send_node.last_argument
64
60
 
@@ -76,20 +72,32 @@ module RuboCop
76
72
  private
77
73
 
78
74
  def check(arg, args)
79
- if style == :braces && !arg.braces?
80
- add_arg_offense(arg, :missing)
81
- elsif style == :no_braces && arg.braces?
82
- add_arg_offense(arg, :redundant)
83
- elsif style == :context_dependent
75
+ case style
76
+ when :braces
77
+ check_braces(arg)
78
+ when :no_braces
79
+ check_no_braces(arg)
80
+ when :context_dependent
84
81
  check_context_dependent(arg, args)
85
82
  end
86
83
  end
87
84
 
85
+ def check_braces(arg)
86
+ add_arg_offense(arg, :missing) unless arg.braces?
87
+ end
88
+
89
+ def check_no_braces(arg)
90
+ return unless arg.braces? && !braces_needed_for_semantics?(arg)
91
+
92
+ add_arg_offense(arg, :redundant)
93
+ end
94
+
88
95
  def check_context_dependent(arg, args)
89
96
  braces_around_second_from_end = args.size > 1 && args[-2].hash_type?
90
97
 
91
98
  if arg.braces?
92
- unless braces_around_second_from_end
99
+ unless braces_around_second_from_end ||
100
+ braces_needed_for_semantics?(arg)
93
101
  add_arg_offense(arg, :redundant)
94
102
  end
95
103
  elsif braces_around_second_from_end
@@ -97,6 +105,17 @@ module RuboCop
97
105
  end
98
106
  end
99
107
 
108
+ # Returns true if there's block inside the braces of the given hash arg
109
+ # and that block uses do..end. The reason for wanting to check this is
110
+ # that the do..end could bind to a different method invocation if the
111
+ # hash braces were removed.
112
+ def braces_needed_for_semantics?(arg)
113
+ arg.each_pair do |_key, value|
114
+ return true if value.block_type? && !value.braces?
115
+ end
116
+ false
117
+ end
118
+
100
119
  def add_arg_offense(arg, type)
101
120
  add_offense(arg.parent, location: arg.source_range,
102
121
  message: format(MSG,
@@ -128,16 +147,16 @@ module RuboCop
128
147
  end
129
148
 
130
149
  def remove_braces_with_whitespace(corrector, node, space)
150
+ loc = node.loc
151
+
131
152
  if node.multiline?
132
153
  remove_braces_with_range(corrector,
133
- left_whole_line_range(node.loc.begin),
134
- right_whole_line_range(node.loc.end))
154
+ left_whole_line_range(loc.begin),
155
+ right_whole_line_range(loc.end))
135
156
  else
136
- right_brace_and_space = right_brace_and_space(node.loc.end, space)
137
- left_brace_and_space = left_brace_and_space(node.loc.begin, space)
138
157
  remove_braces_with_range(corrector,
139
- left_brace_and_space,
140
- right_brace_and_space)
158
+ left_brace_and_space(loc.begin, space),
159
+ right_brace_and_space(loc.end, space))
141
160
  end
142
161
  end
143
162
 
@@ -115,7 +115,7 @@ module RuboCop
115
115
  end
116
116
 
117
117
  def indent_width
118
- @config.for_cop('IndentationWidth')['Width'] || 2
118
+ @config.for_cop('Layout/IndentationWidth')['Width'] || 2
119
119
  end
120
120
 
121
121
  def check_style(node, body)
@@ -20,7 +20,7 @@ module RuboCop
20
20
  class ColonMethodCall < Cop
21
21
  MSG = 'Do not use `::` for method calls.'
22
22
 
23
- def_node_matcher :java_type_node?, <<-PATTERN
23
+ def_node_matcher :java_type_node?, <<~PATTERN
24
24
  (send
25
25
  (const nil? :Java) _)
26
26
  PATTERN
@@ -49,10 +49,10 @@ module RuboCop
49
49
  next unless annotation?(comment) &&
50
50
  !correct_annotation?(first_word, colon, space, note)
51
51
 
52
- length = concat_length(first_word, colon, space)
53
52
  add_offense(
54
53
  comment,
55
- location: annotation_range(comment, margin, length),
54
+ location: annotation_range(comment, margin,
55
+ first_word, colon, space),
56
56
  message: format(note ? MSG : MISSING_NOTE, keyword: first_word)
57
57
  )
58
58
  end
@@ -62,8 +62,7 @@ module RuboCop
62
62
  margin, first_word, colon, space, note = split_comment(comment)
63
63
  return if note.nil?
64
64
 
65
- length = concat_length(first_word, colon, space)
66
- range = annotation_range(comment, margin, length)
65
+ range = annotation_range(comment, margin, first_word, colon, space)
67
66
 
68
67
  ->(corrector) { corrector.replace(range, "#{first_word.upcase}: ") }
69
68
  end
@@ -79,8 +78,9 @@ module RuboCop
79
78
  !comment_line?(comment.loc.expression.source_line)
80
79
  end
81
80
 
82
- def annotation_range(comment, margin, length)
81
+ def annotation_range(comment, margin, first_word, colon, space)
83
82
  start = comment.loc.expression.begin_pos + margin.length
83
+ length = concat_length(first_word, colon, space)
84
84
  range_between(start, start + length)
85
85
  end
86
86
 
@@ -6,7 +6,8 @@ module RuboCop
6
6
  # This cop checks for comments put on the same line as some keywords.
7
7
  # These keywords are: `begin`, `class`, `def`, `end`, `module`.
8
8
  #
9
- # Note that some comments (`:nodoc:`, `:yields:`, and `rubocop:disable`)
9
+ # Note that some comments
10
+ # (`:nodoc:`, `:yields:`, `rubocop:disable` and `rubocop:todo`)
10
11
  # are allowed.
11
12
  #
12
13
  # @example
@@ -33,53 +34,38 @@ module RuboCop
33
34
  # y
34
35
  # end
35
36
  class CommentedKeyword < Cop
36
- include RangeHelp
37
-
38
37
  MSG = 'Do not place comments on the same line as the ' \
39
38
  '`%<keyword>s` keyword.'
40
39
 
41
40
  def investigate(processed_source)
42
- heredoc_lines = extract_heredoc_lines(processed_source.ast)
43
-
44
41
  processed_source.each_comment do |comment|
45
- location = comment.location
46
- line_position = location.line
47
- line = processed_source.lines[line_position - 1]
48
- next if heredoc_lines.any? { |r| r.include?(line_position) }
49
- next unless offensive?(line)
50
-
51
- range = source_range(processed_source.buffer,
52
- line_position,
53
- (location.column)...(location.last_column))
54
-
55
- add_offense(range, location: range)
42
+ add_offense(comment) if offensive?(comment)
56
43
  end
57
44
  end
58
45
 
59
46
  private
60
47
 
61
48
  KEYWORDS = %w[begin class def end module].freeze
62
- ALLOWED_COMMENTS = %w[:nodoc: :yields: rubocop:disable].freeze
49
+ ALLOWED_COMMENTS = %w[
50
+ :nodoc:
51
+ :yields:
52
+ rubocop:disable
53
+ rubocop:todo
54
+ ].freeze
63
55
 
64
- def offensive?(line)
65
- line = line.lstrip
66
- KEYWORDS.any? { |word| line =~ /^#{word}\s/ } &&
56
+ def offensive?(comment)
57
+ line = line(comment)
58
+ KEYWORDS.any? { |word| line =~ /^\s*#{word}\s/ } &&
67
59
  ALLOWED_COMMENTS.none? { |c| line =~ /#\s*#{c}/ }
68
60
  end
69
61
 
70
- def message(node)
71
- line = node.source_line
72
- keyword = /^\s*(\S+).*#/.match(line)[1]
62
+ def message(comment)
63
+ keyword = line(comment).match(/(\S+).*#/)[1]
73
64
  format(MSG, keyword: keyword)
74
65
  end
75
66
 
76
- def extract_heredoc_lines(ast)
77
- return [] unless ast
78
-
79
- ast.each_node(:str, :dstr, :xstr).select(&:heredoc?).map do |node|
80
- body = node.location.heredoc_body
81
- (body.first_line...body.last_line)
82
- end
67
+ def line(comment)
68
+ comment.location.expression.source_line
83
69
  end
84
70
  end
85
71
  end
@@ -68,16 +68,16 @@ module RuboCop
68
68
  private
69
69
 
70
70
  def expand_elsif(node, elsif_branches = [])
71
- return [] if node.nil? || !node.if_type?
71
+ return [] if node.nil? || !node.if_type? || !node.elsif?
72
72
 
73
73
  elsif_branches << node.if_branch
74
74
 
75
- if node.else_branch&.if_type?
76
- expand_elsif(node.else_branch, elsif_branches)
75
+ else_branch = node.else_branch
76
+ if else_branch&.if_type? && else_branch&.elsif?
77
+ expand_elsif(else_branch, elsif_branches)
77
78
  else
78
- elsif_branches << node.else_branch
79
+ elsif_branches << else_branch
79
80
  end
80
- elsif_branches
81
81
  end
82
82
 
83
83
  def lhs_for_send(node)
@@ -219,11 +219,9 @@ module RuboCop
219
219
  SINGLE_LINE_CONDITIONS_ONLY = 'SingleLineConditionsOnly'
220
220
  WIDTH = 'Width'
221
221
 
222
- def_node_matcher :condition?, '{if case}'
223
-
224
222
  # The shovel operator `<<` does not have its own type. It is a `send`
225
223
  # type.
226
- def_node_matcher :assignment_type?, <<-PATTERN
224
+ def_node_matcher :assignment_type?, <<~PATTERN
227
225
  {
228
226
  #{ASSIGNMENT_TYPES.join(' ')}
229
227
  (send _recv {:[]= :<< :=~ :!~ :<=> #end_with_eq?} ...)