rubocop 1.20.0 → 1.22.2

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 (204) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/config/default.yml +64 -15
  4. data/lib/rubocop/config.rb +5 -0
  5. data/lib/rubocop/config_loader.rb +3 -1
  6. data/lib/rubocop/config_validator.rb +9 -1
  7. data/lib/rubocop/cop/base.rb +3 -3
  8. data/lib/rubocop/cop/bundler/gem_comment.rb +3 -3
  9. data/lib/rubocop/cop/bundler/insecure_protocol_source.rb +45 -21
  10. data/lib/rubocop/cop/bundler/ordered_gems.rb +3 -12
  11. data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb +2 -2
  12. data/lib/rubocop/cop/correctors/line_break_corrector.rb +1 -1
  13. data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb +11 -10
  14. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +3 -12
  15. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +31 -24
  16. data/lib/rubocop/cop/generator.rb +14 -8
  17. data/lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb +60 -0
  18. data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +1 -1
  19. data/lib/rubocop/cop/internal_affairs.rb +1 -0
  20. data/lib/rubocop/cop/layout/argument_alignment.rb +1 -1
  21. data/lib/rubocop/cop/layout/assignment_indentation.rb +1 -1
  22. data/lib/rubocop/cop/layout/class_structure.rb +2 -1
  23. data/lib/rubocop/cop/layout/dot_position.rb +30 -5
  24. data/lib/rubocop/cop/layout/empty_comment.rb +1 -1
  25. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +7 -4
  26. data/lib/rubocop/cop/layout/end_alignment.rb +2 -3
  27. data/lib/rubocop/cop/layout/first_array_element_indentation.rb +1 -1
  28. data/lib/rubocop/cop/layout/first_hash_element_indentation.rb +1 -1
  29. data/lib/rubocop/cop/layout/first_parameter_indentation.rb +1 -1
  30. data/lib/rubocop/cop/layout/hash_alignment.rb +1 -1
  31. data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +1 -1
  32. data/lib/rubocop/cop/layout/indentation_width.rb +1 -1
  33. data/lib/rubocop/cop/layout/leading_comment_space.rb +1 -1
  34. data/lib/rubocop/cop/layout/line_length.rb +9 -7
  35. data/lib/rubocop/cop/layout/multiline_assignment_layout.rb +1 -1
  36. data/lib/rubocop/cop/layout/multiline_block_layout.rb +3 -3
  37. data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +1 -1
  38. data/lib/rubocop/cop/layout/redundant_line_break.rb +1 -0
  39. data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb +1 -1
  40. data/lib/rubocop/cop/layout/single_line_block_chain.rb +15 -4
  41. data/lib/rubocop/cop/layout/space_after_not.rb +1 -0
  42. data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb +2 -1
  43. data/lib/rubocop/cop/layout/space_around_keyword.rb +2 -2
  44. data/lib/rubocop/cop/layout/space_before_brackets.rb +1 -0
  45. data/lib/rubocop/cop/layout/space_before_comment.rb +1 -1
  46. data/lib/rubocop/cop/layout/space_inside_parens.rb +74 -28
  47. data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb +1 -1
  48. data/lib/rubocop/cop/lint/ambiguous_operator_precedence.rb +111 -0
  49. data/lib/rubocop/cop/lint/ambiguous_range.rb +9 -9
  50. data/lib/rubocop/cop/lint/assignment_in_condition.rb +7 -5
  51. data/lib/rubocop/cop/lint/binary_operator_with_identical_operands.rb +18 -5
  52. data/lib/rubocop/cop/lint/boolean_symbol.rb +5 -0
  53. data/lib/rubocop/cop/lint/debugger.rb +0 -2
  54. data/lib/rubocop/cop/lint/deprecated_class_methods.rb +4 -4
  55. data/lib/rubocop/cop/lint/disjunctive_assignment_in_constructor.rb +24 -1
  56. data/lib/rubocop/cop/lint/else_layout.rb +10 -6
  57. data/lib/rubocop/cop/lint/empty_in_pattern.rb +1 -1
  58. data/lib/rubocop/cop/lint/erb_new_arguments.rb +1 -1
  59. data/lib/rubocop/cop/lint/float_out_of_range.rb +1 -1
  60. data/lib/rubocop/cop/lint/hash_compare_by_identity.rb +12 -3
  61. data/lib/rubocop/cop/lint/incompatible_io_select_with_fiber_scheduler.rb +67 -0
  62. data/lib/rubocop/cop/lint/interpolation_check.rb +5 -0
  63. data/lib/rubocop/cop/lint/loop.rb +4 -3
  64. data/lib/rubocop/cop/lint/non_deterministic_require_order.rb +5 -1
  65. data/lib/rubocop/cop/lint/number_conversion.rb +12 -1
  66. data/lib/rubocop/cop/lint/numbered_parameter_assignment.rb +1 -1
  67. data/lib/rubocop/cop/lint/or_assignment_to_constant.rb +4 -2
  68. data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +17 -0
  69. data/lib/rubocop/cop/lint/percent_string_array.rb +10 -0
  70. data/lib/rubocop/cop/lint/raise_exception.rb +4 -0
  71. data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +5 -4
  72. data/lib/rubocop/cop/lint/require_relative_self_path.rb +50 -0
  73. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +1 -1
  74. data/lib/rubocop/cop/lint/symbol_conversion.rb +1 -1
  75. data/lib/rubocop/cop/lint/triple_quotes.rb +1 -1
  76. data/lib/rubocop/cop/lint/unexpected_block_arity.rb +8 -3
  77. data/lib/rubocop/cop/lint/unused_method_argument.rb +2 -3
  78. data/lib/rubocop/cop/lint/useless_method_definition.rb +3 -2
  79. data/lib/rubocop/cop/lint/useless_setter_call.rb +7 -4
  80. data/lib/rubocop/cop/lint/useless_times.rb +4 -3
  81. data/lib/rubocop/cop/metrics/abc_size.rb +6 -0
  82. data/lib/rubocop/cop/metrics/parameter_lists.rb +5 -2
  83. data/lib/rubocop/cop/metrics/perceived_complexity.rb +1 -1
  84. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +1 -1
  85. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +1 -1
  86. data/lib/rubocop/cop/mixin/code_length.rb +1 -1
  87. data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +1 -2
  88. data/lib/rubocop/cop/mixin/frozen_string_literal.rb +15 -6
  89. data/lib/rubocop/cop/mixin/hash_transform_method.rb +3 -3
  90. data/lib/rubocop/cop/mixin/heredoc.rb +1 -3
  91. data/lib/rubocop/cop/mixin/multiline_element_indentation.rb +1 -1
  92. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +2 -2
  93. data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb +1 -1
  94. data/lib/rubocop/cop/mixin/ordered_gem_node.rb +9 -1
  95. data/lib/rubocop/cop/mixin/percent_array.rb +6 -1
  96. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +9 -1
  97. data/lib/rubocop/cop/mixin/space_after_punctuation.rb +1 -1
  98. data/lib/rubocop/cop/mixin/space_before_punctuation.rb +1 -1
  99. data/lib/rubocop/cop/mixin/statement_modifier.rb +1 -1
  100. data/lib/rubocop/cop/mixin/string_literals_help.rb +5 -1
  101. data/lib/rubocop/cop/mixin/trailing_body.rb +1 -1
  102. data/lib/rubocop/cop/naming/ascii_identifiers.rb +0 -3
  103. data/lib/rubocop/cop/naming/block_parameter_name.rb +1 -1
  104. data/lib/rubocop/cop/naming/constant_name.rb +1 -1
  105. data/lib/rubocop/cop/naming/inclusive_language.rb +9 -9
  106. data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +5 -4
  107. data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +7 -0
  108. data/lib/rubocop/cop/security/io_methods.rb +49 -0
  109. data/lib/rubocop/cop/security/json_load.rb +8 -7
  110. data/lib/rubocop/cop/security/open.rb +4 -0
  111. data/lib/rubocop/cop/security/yaml_load.rb +4 -0
  112. data/lib/rubocop/cop/style/accessor_grouping.rb +2 -2
  113. data/lib/rubocop/cop/style/and_or.rb +5 -0
  114. data/lib/rubocop/cop/style/arguments_forwarding.rb +13 -2
  115. data/lib/rubocop/cop/style/array_coercion.rb +21 -3
  116. data/lib/rubocop/cop/style/ascii_comments.rb +0 -3
  117. data/lib/rubocop/cop/style/case_equality.rb +6 -9
  118. data/lib/rubocop/cop/style/case_like_if.rb +5 -0
  119. data/lib/rubocop/cop/style/class_and_module_children.rb +9 -0
  120. data/lib/rubocop/cop/style/collection_compact.rb +7 -5
  121. data/lib/rubocop/cop/style/collection_methods.rb +8 -6
  122. data/lib/rubocop/cop/style/combinable_loops.rb +3 -2
  123. data/lib/rubocop/cop/style/commented_keyword.rb +9 -4
  124. data/lib/rubocop/cop/style/date_time.rb +5 -0
  125. data/lib/rubocop/cop/style/document_dynamic_eval_definition.rb +1 -1
  126. data/lib/rubocop/cop/style/documentation.rb +23 -8
  127. data/lib/rubocop/cop/style/double_negation.rb +15 -5
  128. data/lib/rubocop/cop/style/empty_method.rb +1 -1
  129. data/lib/rubocop/cop/style/explicit_block_argument.rb +21 -11
  130. data/lib/rubocop/cop/style/float_division.rb +10 -2
  131. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +6 -1
  132. data/lib/rubocop/cop/style/global_std_stream.rb +4 -0
  133. data/lib/rubocop/cop/style/hash_each_methods.rb +5 -0
  134. data/lib/rubocop/cop/style/hash_transform_keys.rb +4 -6
  135. data/lib/rubocop/cop/style/hash_transform_values.rb +4 -6
  136. data/lib/rubocop/cop/style/identical_conditional_branches.rb +18 -16
  137. data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +18 -4
  138. data/lib/rubocop/cop/style/infinite_loop.rb +4 -3
  139. data/lib/rubocop/cop/style/inverse_methods.rb +9 -2
  140. data/lib/rubocop/cop/style/lambda_call.rb +1 -1
  141. data/lib/rubocop/cop/style/line_end_concatenation.rb +14 -1
  142. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +6 -6
  143. data/lib/rubocop/cop/style/module_function.rb +8 -9
  144. data/lib/rubocop/cop/style/multiline_in_pattern_then.rb +1 -1
  145. data/lib/rubocop/cop/style/multiline_when_then.rb +1 -1
  146. data/lib/rubocop/cop/style/mutable_constant.rb +13 -8
  147. data/lib/rubocop/cop/style/negated_if.rb +1 -1
  148. data/lib/rubocop/cop/style/negated_unless.rb +1 -1
  149. data/lib/rubocop/cop/style/non_nil_check.rb +2 -2
  150. data/lib/rubocop/cop/style/not.rb +2 -2
  151. data/lib/rubocop/cop/style/numbered_parameters.rb +46 -0
  152. data/lib/rubocop/cop/style/numbered_parameters_limit.rb +50 -0
  153. data/lib/rubocop/cop/style/numeric_literals.rb +7 -8
  154. data/lib/rubocop/cop/style/numeric_predicate.rb +5 -0
  155. data/lib/rubocop/cop/style/optional_arguments.rb +4 -0
  156. data/lib/rubocop/cop/style/optional_boolean_parameter.rb +14 -4
  157. data/lib/rubocop/cop/style/parallel_assignment.rb +1 -1
  158. data/lib/rubocop/cop/style/percent_q_literals.rb +2 -2
  159. data/lib/rubocop/cop/style/preferred_hash_methods.rb +9 -4
  160. data/lib/rubocop/cop/style/quoted_symbols.rb +10 -6
  161. data/lib/rubocop/cop/style/raise_args.rb +1 -1
  162. data/lib/rubocop/cop/style/redundant_argument.rb +19 -9
  163. data/lib/rubocop/cop/style/redundant_condition.rb +2 -3
  164. data/lib/rubocop/cop/style/redundant_fetch_block.rb +4 -0
  165. data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb +12 -3
  166. data/lib/rubocop/cop/style/redundant_freeze.rb +0 -1
  167. data/lib/rubocop/cop/style/redundant_interpolation.rb +1 -1
  168. data/lib/rubocop/cop/style/redundant_percent_q.rb +2 -3
  169. data/lib/rubocop/cop/style/redundant_self.rb +10 -0
  170. data/lib/rubocop/cop/style/redundant_self_assignment.rb +4 -3
  171. data/lib/rubocop/cop/style/redundant_self_assignment_branch.rb +1 -1
  172. data/lib/rubocop/cop/style/redundant_sort.rb +51 -18
  173. data/lib/rubocop/cop/style/regexp_literal.rb +3 -3
  174. data/lib/rubocop/cop/style/return_nil.rb +2 -1
  175. data/lib/rubocop/cop/style/safe_navigation.rb +13 -2
  176. data/lib/rubocop/cop/style/select_by_regexp.rb +138 -0
  177. data/lib/rubocop/cop/style/single_argument_dig.rb +5 -0
  178. data/lib/rubocop/cop/style/slicing_with_range.rb +13 -0
  179. data/lib/rubocop/cop/style/special_global_vars.rb +4 -0
  180. data/lib/rubocop/cop/style/static_class.rb +5 -5
  181. data/lib/rubocop/cop/style/string_chars.rb +4 -2
  182. data/lib/rubocop/cop/style/string_concatenation.rb +5 -1
  183. data/lib/rubocop/cop/style/string_hash_keys.rb +4 -0
  184. data/lib/rubocop/cop/style/struct_inheritance.rb +3 -2
  185. data/lib/rubocop/cop/style/swap_values.rb +4 -2
  186. data/lib/rubocop/cop/style/symbol_proc.rb +26 -0
  187. data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb +19 -0
  188. data/lib/rubocop/cop/style/trivial_accessors.rb +1 -1
  189. data/lib/rubocop/cop/style/yoda_condition.rb +24 -7
  190. data/lib/rubocop/cop/style/zero_length_predicate.rb +6 -0
  191. data/lib/rubocop/cop/util.rb +15 -4
  192. data/lib/rubocop/cops_documentation_generator.rb +17 -5
  193. data/lib/rubocop/options.rb +126 -112
  194. data/lib/rubocop/rake_task.rb +1 -1
  195. data/lib/rubocop/result_cache.rb +3 -3
  196. data/lib/rubocop/rspec/cop_helper.rb +1 -1
  197. data/lib/rubocop/rspec/expect_offense.rb +6 -2
  198. data/lib/rubocop/rspec/parallel_formatter.rb +90 -0
  199. data/lib/rubocop/rspec/support.rb +1 -0
  200. data/lib/rubocop/runner.rb +2 -3
  201. data/lib/rubocop/target_finder.rb +1 -1
  202. data/lib/rubocop/version.rb +1 -1
  203. data/lib/rubocop.rb +8 -1
  204. metadata +14 -5
@@ -58,18 +58,17 @@ module RuboCop
58
58
 
59
59
  case int
60
60
  when /^\d+$/
61
- return unless (self.min_digits = int.size + 1)
62
-
63
- register_offense(node)
61
+ register_offense(node) { self.min_digits = int.size + 1 }
64
62
  when /\d{4}/, short_group_regex
65
- return unless (self.config_to_allow_offenses = { 'Enabled' => false })
66
-
67
- register_offense(node)
63
+ register_offense(node) { self.config_to_allow_offenses = { 'Enabled' => false } }
68
64
  end
69
65
  end
70
66
 
71
- def register_offense(node)
72
- add_offense(node) { |corrector| corrector.replace(node, format_number(node)) }
67
+ def register_offense(node, &_block)
68
+ add_offense(node) do |corrector|
69
+ yield
70
+ corrector.replace(node, format_number(node))
71
+ end
73
72
  end
74
73
 
75
74
  def short_group_regex
@@ -16,6 +16,11 @@ module RuboCop
16
16
  # populated with objects which can be compared with integers, but are
17
17
  # not themselves `Integer` polymorphic.
18
18
  #
19
+ # @safety
20
+ # This cop is unsafe because it cannot be guaranteed that the receiver
21
+ # defines the predicates or can be compared to a number, which may lead
22
+ # to a false positive for non-standard classes.
23
+ #
19
24
  # @example EnforcedStyle: predicate (default)
20
25
  # # bad
21
26
  #
@@ -6,6 +6,10 @@ module RuboCop
6
6
  # This cop checks for optional arguments to methods
7
7
  # that do not come at the end of the argument list.
8
8
  #
9
+ # @safety
10
+ # This cop is unsafe because changing a method signature will
11
+ # implicitly change behaviour.
12
+ #
9
13
  # @example
10
14
  # # bad
11
15
  # def foo(a = 1, b, c)
@@ -7,6 +7,10 @@ module RuboCop
7
7
  # boolean arguments when defining methods. `respond_to_missing?` method is allowed by default.
8
8
  # These are customizable with `AllowedMethods` option.
9
9
  #
10
+ # @safety
11
+ # This cop is unsafe because changing a method signature will
12
+ # implicitly change behaviour.
13
+ #
10
14
  # @example
11
15
  # # bad
12
16
  # def some_method(bar = false)
@@ -33,8 +37,8 @@ module RuboCop
33
37
  class OptionalBooleanParameter < Base
34
38
  include AllowedMethods
35
39
 
36
- MSG = 'Use keyword arguments when defining method with boolean argument.'
37
- BOOLEAN_TYPES = %i[true false].freeze
40
+ MSG = 'Prefer keyword arguments for arguments with a boolean default value; ' \
41
+ 'use `%<replacement>s` instead of `%<original>s`.'
38
42
 
39
43
  def on_def(node)
40
44
  return if allowed_method?(node.method_name)
@@ -42,11 +46,17 @@ module RuboCop
42
46
  node.arguments.each do |arg|
43
47
  next unless arg.optarg_type?
44
48
 
45
- _name, value = *arg
46
- add_offense(arg) if BOOLEAN_TYPES.include?(value.type)
49
+ add_offense(arg, message: format_message(arg)) if arg.default_value.boolean_type?
47
50
  end
48
51
  end
49
52
  alias on_defs on_def
53
+
54
+ private
55
+
56
+ def format_message(argument)
57
+ source = argument.source
58
+ format(MSG, original: source, replacement: source.sub(/\s+=/, ':'))
59
+ end
50
60
  end
51
61
  end
52
62
  end
@@ -153,7 +153,7 @@ module RuboCop
153
153
 
154
154
  def dependency?(lhs, rhs)
155
155
  uses_var?(rhs, var_name(lhs)) ||
156
- lhs.send_type? && lhs.assignment_method? && accesses?(rhs, lhs)
156
+ (lhs.send_type? && lhs.assignment_method? && accesses?(rhs, lhs))
157
157
  end
158
158
 
159
159
  # `lhs` is an assignment method call like `obj.attr=` or `ary[idx]=`.
@@ -53,8 +53,8 @@ module RuboCop
53
53
  end
54
54
 
55
55
  def correct_literal_style?(node)
56
- style == :lower_case_q && type(node) == '%q' ||
57
- style == :upper_case_q && type(node) == '%Q'
56
+ (style == :lower_case_q && type(node) == '%q') ||
57
+ (style == :upper_case_q && type(node) == '%Q')
58
58
  end
59
59
 
60
60
  def message(_range)
@@ -3,10 +3,15 @@
3
3
  module RuboCop
4
4
  module Cop
5
5
  module Style
6
- # This cop (by default) checks for uses of methods Hash#has_key? and
7
- # Hash#has_value? where it enforces Hash#key? and Hash#value?
8
- # It is configurable to enforce the inverse, using `verbose` method
9
- # names also.
6
+ # This cop checks for uses of methods `Hash#has_key?` and
7
+ # `Hash#has_value?`, and suggests using `Hash#key?` and `Hash#value?` instead.
8
+ #
9
+ # It is configurable to enforce the verbose method names, by using the
10
+ # `EnforcedStyle: verbose` configuration.
11
+ #
12
+ # @safety
13
+ # This cop is unsafe because it cannot be guaranteed that the receiver
14
+ # is a `Hash` or responds to the replacement methods.
10
15
  #
11
16
  # @example EnforcedStyle: short (default)
12
17
  # # bad
@@ -4,7 +4,8 @@ module RuboCop
4
4
  module Cop
5
5
  module Style
6
6
  # Checks if the quotes used for quoted symbols match the configured defaults.
7
- # By default uses the same configuration as `Style/StringLiterals`.
7
+ # By default uses the same configuration as `Style/StringLiterals`; if that
8
+ # cop is not enabled, the default `EnforcedStyle` is `single_quotes`.
8
9
  #
9
10
  # String interpolation is always kept in double quotes.
10
11
  #
@@ -75,11 +76,14 @@ module RuboCop
75
76
  end
76
77
 
77
78
  def correct_quotes(str)
78
- if style == :single_quotes
79
- to_string_literal(str)
80
- else
81
- str.inspect
82
- end
79
+ correction = if style == :single_quotes
80
+ to_string_literal(str)
81
+ else
82
+ str.gsub("\\'", "'").inspect
83
+ end
84
+
85
+ # The conversion process doubles escaped slashes, so they have to be reverted
86
+ correction.gsub('\\\\', '\\')
83
87
  end
84
88
 
85
89
  def style
@@ -141,7 +141,7 @@ module RuboCop
141
141
  end
142
142
 
143
143
  def requires_parens?(parent)
144
- parent.and_type? || parent.or_type? || parent.if_type? && parent.ternary?
144
+ parent.and_type? || parent.or_type? || (parent.if_type? && parent.ternary?)
145
145
  end
146
146
  end
147
147
  end
@@ -5,22 +5,29 @@ module RuboCop
5
5
  module Style
6
6
  # This cop checks for a redundant argument passed to certain methods.
7
7
  #
8
- # Limitations:
9
- #
10
- # 1. This cop matches for method names only and hence cannot tell apart
11
- # methods with same name in different classes.
12
- # 2. This cop is limited to methods with single parameter.
13
- # 3. This cop is unsafe if certain special global variables (e.g. `$;`, `$/`) are set.
14
- # That depends on the nature of the target methods, of course.
8
+ # NOTE: This cop is limited to methods with single parameter.
15
9
  #
16
10
  # Method names and their redundant arguments can be configured like this:
17
11
  #
12
+ # [source,yaml]
13
+ # ----
18
14
  # Methods:
19
15
  # join: ''
20
16
  # split: ' '
21
17
  # chomp: "\n"
22
18
  # chomp!: "\n"
23
19
  # foo: 2
20
+ # ----
21
+ #
22
+ # @safety
23
+ # This cop is unsafe because of the following limitations:
24
+ #
25
+ # 1. This cop matches by method names only and hence cannot tell apart
26
+ # methods with same name in different classes.
27
+ # 2. This cop may be unsafe if certain special global variables (e.g. `$;`, `$/`) are set.
28
+ # That depends on the nature of the target methods, of course. For example, the default
29
+ # argument to join is `$OUTPUT_FIELD_SEPARATOR` (or `$,`) rather than `''`, and if that
30
+ # global is changed, `''` is no longer a redundant argument.
24
31
  #
25
32
  # @example
26
33
  # # bad
@@ -51,8 +58,11 @@ module RuboCop
51
58
  return if node.arguments.count != 1
52
59
  return unless redundant_argument?(node)
53
60
 
54
- add_offense(node, message: format(MSG, arg: node.arguments.first.source)) do |corrector|
55
- corrector.remove(argument_range(node))
61
+ offense_range = argument_range(node)
62
+ message = format(MSG, arg: node.arguments.first.source)
63
+
64
+ add_offense(offense_range, message: message) do |corrector|
65
+ corrector.remove(offense_range)
56
66
  end
57
67
  end
58
68
 
@@ -120,11 +120,10 @@ module RuboCop
120
120
  end
121
121
 
122
122
  def require_parentheses?(node)
123
- node.basic_conditional? &&
124
- node.modifier_form? ||
123
+ (node.basic_conditional? && node.modifier_form?) ||
125
124
  node.range_type? ||
126
125
  node.rescue_type? ||
127
- node.respond_to?(:semantic_operator?) && node.semantic_operator?
126
+ (node.respond_to?(:semantic_operator?) && node.semantic_operator?)
128
127
  end
129
128
 
130
129
  def without_argument_parentheses_method?(node)
@@ -9,6 +9,10 @@ module RuboCop
9
9
  # In such cases `fetch(key, value)` method is faster
10
10
  # than `fetch(key) { value }`.
11
11
  #
12
+ # @safety
13
+ # This cop is unsafe because it cannot be guaranteed that the receiver
14
+ # does not have a different implementation of `fetch`.
15
+ #
12
16
  # @example SafeForConstants: false (default)
13
17
  # # bad
14
18
  # hash.fetch(:key) { 5 }
@@ -25,6 +25,7 @@ module RuboCop
25
25
  # require_relative '../foo.so'
26
26
  #
27
27
  class RedundantFileExtensionInRequire < Base
28
+ include RangeHelp
28
29
  extend AutoCorrector
29
30
 
30
31
  MSG = 'Redundant `.rb` file extension detected.'
@@ -39,13 +40,21 @@ module RuboCop
39
40
  require_call?(node) do |name_node|
40
41
  return unless name_node.value.end_with?('.rb')
41
42
 
42
- add_offense(name_node) do |corrector|
43
- correction = name_node.value.delete_suffix('.rb')
43
+ extension_range = extension_range(name_node)
44
44
 
45
- corrector.replace(name_node, "'#{correction}'")
45
+ add_offense(extension_range) do |corrector|
46
+ corrector.remove(extension_range)
46
47
  end
47
48
  end
48
49
  end
50
+
51
+ private
52
+
53
+ def extension_range(name_node)
54
+ end_of_path_string = name_node.source_range.end_pos
55
+
56
+ range_between(end_of_path_string - 4, end_of_path_string - 1)
57
+ end
49
58
  end
50
59
  end
51
60
  end
@@ -59,7 +59,6 @@ module RuboCop
59
59
  (begin (send {float int} {:+ :- :* :** :/ :% :<<} _))
60
60
  (begin (send !{(str _) array} {:+ :- :* :** :/ :%} {float int}))
61
61
  (begin (send _ {:== :=== :!= :<= :>= :< :>} _))
62
- (send (const {nil? cbase} :ENV) :[] _)
63
62
  (send _ {:count :length :size} ...)
64
63
  (block (send _ {:count :length :size} ...) ...)
65
64
  }
@@ -56,7 +56,7 @@ module RuboCop
56
56
  first_child = node.children.first
57
57
 
58
58
  variable_interpolation?(first_child) ||
59
- first_child.send_type? && !first_child.operator_method?
59
+ (first_child.send_type? && !first_child.operator_method?)
60
60
  end
61
61
 
62
62
  def interpolation?(node)
@@ -65,9 +65,8 @@ module RuboCop
65
65
  end
66
66
 
67
67
  def allowed_percent_q?(node)
68
- node.source.start_with?(PERCENT_Q) && acceptable_q?(node) ||
69
- node.source.start_with?(PERCENT_CAPITAL_Q) &&
70
- acceptable_capital_q?(node)
68
+ (node.source.start_with?(PERCENT_Q) && acceptable_q?(node)) ||
69
+ (node.source.start_with?(PERCENT_CAPITAL_Q) && acceptable_capital_q?(node))
71
70
  end
72
71
 
73
72
  def message(node)
@@ -100,6 +100,10 @@ module RuboCop
100
100
  add_lhs_to_local_variables_scopes(rhs, lhs)
101
101
  end
102
102
 
103
+ def on_in_pattern(node)
104
+ add_match_var_scopes(node)
105
+ end
106
+
103
107
  def on_send(node)
104
108
  return unless node.self_receiver? && regular_method_call?(node)
105
109
  return if node.parent&.mlhs_type?
@@ -185,6 +189,12 @@ module RuboCop
185
189
  add_lhs_to_local_variables_scopes(rhs, child.to_a.first)
186
190
  end
187
191
  end
192
+
193
+ def add_match_var_scopes(in_pattern_node)
194
+ in_pattern_node.each_descendant(:match_var) do |match_var_node|
195
+ @local_variables_scopes[in_pattern_node] << match_var_node.children.first
196
+ end
197
+ end
188
198
  end
189
199
  end
190
200
  end
@@ -6,9 +6,10 @@ module RuboCop
6
6
  # This cop checks for places where redundant assignments are made for in place
7
7
  # modification methods.
8
8
  #
9
- # This cop is marked as unsafe, because it can produce false positives for
10
- # user defined methods having one of the expected names, but not modifying
11
- # its receiver in place.
9
+ # @safety
10
+ # This cop is unsafe, because it can produce false positives for
11
+ # user defined methods having one of the expected names, but not modifying
12
+ # its receiver in place.
12
13
  #
13
14
  # @example
14
15
  # # bad
@@ -58,7 +58,7 @@ module RuboCop
58
58
 
59
59
  def inconvertible_to_modifier?(if_branch, else_branch)
60
60
  multiple_statements?(if_branch) || multiple_statements?(else_branch) ||
61
- else_branch.respond_to?(:elsif?) && else_branch.elsif?
61
+ (else_branch.respond_to?(:elsif?) && else_branch.elsif?)
62
62
  end
63
63
 
64
64
  def multiple_statements?(branch)
@@ -12,6 +12,33 @@ module RuboCop
12
12
  # `Enumerable#max_by` can replace `Enumerable#sort_by` calls
13
13
  # after which only the first or last element is used.
14
14
  #
15
+ # @safety
16
+ # This cop is unsafe, because `sort...last` and `max` may not return the
17
+ # same element in all cases.
18
+ #
19
+ # In an enumerable where there are multiple elements where `a <=> b == 0`,
20
+ # or where the transformation done by the `sort_by` block has the
21
+ # same result, `sort.last` and `max` (or `sort_by.last` and `max_by`)
22
+ # will return different elements. `sort.last` will return the last
23
+ # element but `max` will return the first element.
24
+ #
25
+ # For example:
26
+ #
27
+ # [source,ruby]
28
+ # ----
29
+ # class MyString < String; end
30
+ # strings = [MyString.new('test'), 'test']
31
+ # strings.sort.last.class #=> String
32
+ # strings.max.class #=> MyString
33
+ # ----
34
+ #
35
+ # [source,ruby]
36
+ # ----
37
+ # words = %w(dog horse mouse)
38
+ # words.sort_by { |word| word.length }.last #=> 'mouse'
39
+ # words.max_by { |word| word.length } #=> 'horse'
40
+ # ----
41
+ #
15
42
  # @example
16
43
  # # bad
17
44
  # [2, 1, 3].sort.first
@@ -75,33 +102,39 @@ module RuboCop
75
102
  MATCHER
76
103
 
77
104
  def on_send(node)
78
- if (sort_node, sorter, accessor = redundant_sort?(node.parent))
79
- ancestor = node.parent
80
- elsif (sort_node, sorter, accessor = redundant_sort?(node.parent&.parent))
81
- ancestor = node.parent.parent
82
- else
83
- return
84
- end
105
+ ancestor, sort_node, sorter, accessor =
106
+ find_redundant_sort(node.parent, node.parent&.parent)
107
+ return unless ancestor
85
108
 
86
- message = message(ancestor, sorter, accessor)
109
+ register_offense(ancestor, sort_node, sorter, accessor)
110
+ end
111
+
112
+ private
87
113
 
88
- add_offense(offense_range(sort_node, ancestor), message: message) do |corrector|
89
- autocorrect(corrector, ancestor, sort_node, sorter, accessor)
114
+ def find_redundant_sort(*nodes)
115
+ nodes.each do |node|
116
+ if (sort_node, sorter, accessor = redundant_sort?(node))
117
+ return [node, sort_node, sorter, accessor]
118
+ end
90
119
  end
120
+
121
+ nil
91
122
  end
92
123
 
93
- private
124
+ def register_offense(node, sort_node, sorter, accessor)
125
+ message = message(node, sorter, accessor)
94
126
 
95
- def autocorrect(corrector, node, sort_node, sorter, accessor)
96
- # Remove accessor, e.g. `first` or `[-1]`.
97
- corrector.remove(range_between(accessor_start(node), node.loc.expression.end_pos))
127
+ add_offense(offense_range(sort_node, node), message: message) do |corrector|
128
+ # Remove accessor, e.g. `first` or `[-1]`.
129
+ corrector.remove(range_between(accessor_start(node), node.loc.expression.end_pos))
98
130
 
99
- # Replace "sort" or "sort_by" with the appropriate min/max method.
100
- corrector.replace(sort_node.loc.selector, suggestion(sorter, accessor, arg_value(node)))
131
+ # Replace "sort" or "sort_by" with the appropriate min/max method.
132
+ corrector.replace(sort_node.loc.selector, suggestion(sorter, accessor, arg_value(node)))
133
+ end
101
134
  end
102
135
 
103
- def offense_range(sort_node, ancestor)
104
- range_between(sort_node.loc.selector.begin_pos, ancestor.loc.expression.end_pos)
136
+ def offense_range(sort_node, node)
137
+ range_between(sort_node.loc.selector.begin_pos, node.loc.expression.end_pos)
105
138
  end
106
139
 
107
140
  def message(node, sorter, accessor)
@@ -107,7 +107,7 @@ module RuboCop
107
107
  private
108
108
 
109
109
  def allowed_slash_literal?(node)
110
- style == :slashes && !contains_disallowed_slash?(node) || allowed_mixed_slash?(node)
110
+ (style == :slashes && !contains_disallowed_slash?(node)) || allowed_mixed_slash?(node)
111
111
  end
112
112
 
113
113
  def allowed_mixed_slash?(node)
@@ -115,13 +115,13 @@ module RuboCop
115
115
  end
116
116
 
117
117
  def allowed_percent_r_literal?(node)
118
- style == :slashes && contains_disallowed_slash?(node) ||
118
+ (style == :slashes && contains_disallowed_slash?(node)) ||
119
119
  style == :percent_r ||
120
120
  allowed_mixed_percent_r?(node) || allowed_omit_parentheses_with_percent_r_literal?(node)
121
121
  end
122
122
 
123
123
  def allowed_mixed_percent_r?(node)
124
- style == :mixed && node.multiline? || contains_disallowed_slash?(node)
124
+ (style == :mixed && node.multiline?) || contains_disallowed_slash?(node)
125
125
  end
126
126
 
127
127
  def contains_disallowed_slash?(node)
@@ -74,7 +74,8 @@ module RuboCop
74
74
  end
75
75
 
76
76
  def correct_style?(node)
77
- style == :return && !return_nil_node?(node) || style == :return_nil && !return_node?(node)
77
+ (style == :return && !return_nil_node?(node)) ||
78
+ (style == :return_nil && !return_node?(node))
78
79
  end
79
80
 
80
81
  def scoped_node?(node)
@@ -10,14 +10,25 @@ module RuboCop
10
10
  # need to be changed to use safe navigation. We have limited the cop to
11
11
  # not register an offense for method chains that exceed 2 methods.
12
12
  #
13
- # Configuration option: ConvertCodeThatCanStartToReturnNil
14
- # The default for this is `false`. When configured to `true`, this will
13
+ # The default for `ConvertCodeThatCanStartToReturnNil` is `false`.
14
+ # When configured to `true`, this will
15
15
  # check for code in the format `!foo.nil? && foo.bar`. As it is written,
16
16
  # the return of this code is limited to `false` and whatever the return
17
17
  # of the method is. If this is converted to safe navigation,
18
18
  # `foo&.bar` can start returning `nil` as well as what the method
19
19
  # returns.
20
20
  #
21
+ # @safety
22
+ # Autocorrection is unsafe because if a value is `false`, the resulting
23
+ # code will have different behaviour or raise an error.
24
+ #
25
+ # [source,ruby]
26
+ # ----
27
+ # x = false
28
+ # x && x.foo # return false
29
+ # x&.foo # raises NoMethodError
30
+ # ----
31
+ #
21
32
  # @example
22
33
  # # bad
23
34
  # foo.bar if foo