rubocop 1.29.1 → 1.36.0

data/lib/rubocop/cop/style/numeric_predicate.rb

@@ -3,16 +3,19 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for usage of comparison operators (`==`,
+      # Checks for usage of comparison operators (`==`,
       # `>`, `<`) to test numbers as zero, positive, or negative.
       # These can be replaced by their respective predicate methods.
-      # The cop can also be configured to do the reverse.
+      # This cop can also be configured to do the reverse.
       #
-      # The cop disregards `#nonzero?` as its value is truthy or falsey,
+      # This cop can be customized allowed methods with `AllowedMethods`.
+      # By default, there are no methods to allowed.
+      #
+      # This cop disregards `#nonzero?` as its value is truthy or falsey,
       # but not `true` and `false`, and thus not always interchangeable with
       # `!= 0`.
       #
-      # The cop ignores comparisons to global variables, since they are often
+      # This cop allows comparisons to global variables, since they are often
       # populated with objects which can be compared with integers, but are
       # not themselves `Integer` polymorphic.
       #
@@ -23,32 +26,59 @@ module RuboCop
       #
       # @example EnforcedStyle: predicate (default)
       #   # bad
-      #
       #   foo == 0
       #   0 > foo
       #   bar.baz > 0
       #
       #   # good
-      #
       #   foo.zero?
       #   foo.negative?
       #   bar.baz.positive?
       #
       # @example EnforcedStyle: comparison
       #   # bad
-      #
       #   foo.zero?
       #   foo.negative?
       #   bar.baz.positive?
       #
       #   # good
+      #   foo == 0
+      #   0 > foo
+      #   bar.baz > 0
+      #
+      # @example AllowedMethods: [] (default) with EnforcedStyle: predicate
+      #   # bad
+      #   foo == 0
+      #   0 > foo
+      #   bar.baz > 0
       #
+      # @example AllowedMethods: [==] with EnforcedStyle: predicate
+      #   # good
       #   foo == 0
+      #
+      #   # bad
       #   0 > foo
       #   bar.baz > 0
+      #
+      # @example AllowedPatterns: [] (default) with EnforcedStyle: comparison
+      #   # bad
+      #   foo.zero?
+      #   foo.negative?
+      #   bar.baz.positive?
+      #
+      # @example AllowedPatterns: [/zero/] with EnforcedStyle: predicate
+      #   # good
+      #   # bad
+      #   foo.zero?
+      #
+      #   # bad
+      #   foo.negative?
+      #   bar.baz.positive?
+      #
       class NumericPredicate < Base
         include ConfigurableEnforcedStyle
-        include IgnoredMethods
+        include AllowedMethods
+        include AllowedPattern
         extend AutoCorrector
 
         MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
@@ -61,9 +91,9 @@ module RuboCop
           numeric, replacement = check(node)
           return unless numeric
 
-          return if ignored_method?(node.method_name) ||
+          return if allowed_method_name?(node.method_name) ||
                     node.each_ancestor(:send, :block).any? do |ancestor|
-                      ignored_method?(ancestor.method_name)
+                      allowed_method_name?(ancestor.method_name)
                     end
 
           message = format(MSG, prefer: replacement, current: node.source)
@@ -74,6 +104,10 @@ module RuboCop
 
         private
 
+        def allowed_method_name?(name)
+          allowed_method?(name) || matches_allowed_pattern?(name)
+        end
+
         def check(node)
           numeric, operator =
             if style == :predicate
@@ -82,7 +116,7 @@ module RuboCop
               predicate(node)
             end
 
-          return unless numeric && operator
+          return unless numeric && operator && replacement_supported?(operator)
 
           [numeric, replacement(numeric, operator)]
         end
@@ -107,6 +141,14 @@ module RuboCop
           node.send_type? && node.binary_operation? && !node.parenthesized?
         end
 
+        def replacement_supported?(operator)
+          if %i[> <].include?(operator)
+            target_ruby_version >= 2.3
+          else
+            true
+          end
+        end
+
         def invert
           lambda do |comparison, numeric|
             comparison = { :> => :<, :< => :> }[comparison] || comparison

data/lib/rubocop/cop/style/object_then.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use of consistent method names
+      # Enforces the use of consistent method names
       # `Object#yield_self` or `Object#then`.
       #
       # @example EnforcedStyle: then (default)
@@ -32,6 +32,8 @@ module RuboCop
           check_method_node(node.send_node)
         end
 
+        alias on_numblock on_block
+
         def on_send(node)
           return unless node.arguments.one? && node.first_argument.block_pass_type?
 

data/lib/rubocop/cop/style/one_line_conditional.rb

@@ -6,7 +6,7 @@ module RuboCop
       # Checks for uses of if/then/else/end constructs on a single line.
       # AlwaysCorrectToMultiline config option can be set to true to auto-convert all offenses to
       # multi-line constructs. When AlwaysCorrectToMultiline is false (default case) the
-      # auto-correct will first try converting them to ternary operators.
+      # autocorrect will first try converting them to ternary operators.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/open_struct_use.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop flags uses of OpenStruct, as it is now officially discouraged
+      # Flags uses of OpenStruct, as it is now officially discouraged
       # to be used for performance, version compatibility, and potential security issues.
       #
       # @safety

data/lib/rubocop/cop/style/option_hash.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for options hashes and discourages them if the
+      # Checks for options hashes and discourages them if the
       # current Ruby version supports keyword arguments.
       #
       # @example

data/lib/rubocop/cop/style/optional_arguments.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for optional arguments to methods
+      # Checks for optional arguments to methods
       # that do not come at the end of the argument list.
       #
       # @safety

data/lib/rubocop/cop/style/optional_boolean_parameter.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for places where keyword arguments can be used instead of
+      # Checks for places where keyword arguments can be used instead of
       # boolean arguments when defining methods. `respond_to_missing?` method is allowed by default.
       # These are customizable with `AllowedMethods` option.
       #

data/lib/rubocop/cop/style/or_assignment.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for potential usage of the `||=` operator.
+      # Checks for potential usage of the `||=` operator.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/parentheses_around_condition.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for the presence of superfluous parentheses around the
+      # Checks for the presence of superfluous parentheses around the
       # condition of if/unless/while/until.
       #
       # `AllowSafeAssignment` option for safe assignment.

data/lib/rubocop/cop/style/percent_literal_delimiters.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the consistent usage of `%`-literal delimiters.
+      # Enforces the consistent usage of `%`-literal delimiters.
       #
       # Specify the 'default' key to set all preferred delimiters at once. You
       # can continue to specify individual preferred delimiters to override the

data/lib/rubocop/cop/style/percent_q_literals.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for usage of the %Q() syntax when %q() would do.
+      # Checks for usage of the %Q() syntax when %q() would do.
       #
       # @example EnforcedStyle: lower_case_q (default)
       #   # The `lower_case_q` style prefers `%q` unless

data/lib/rubocop/cop/style/perl_backrefs.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop looks for uses of Perl-style regexp match
+      # Looks for uses of Perl-style regexp match
       # backreferences and their English versions like
       # $1, $2, $&, &+, $MATCH, $PREMATCH, etc.
       #
@@ -83,10 +83,31 @@ module RuboCop
           end
         end
 
+        # @private
+        # @param [RuboCop::AST::Node] node
+        # @return [String, nil]
+        def preferred_expression_to_node_with_constant_prefix(node)
+          expression = preferred_expression_to(node)
+          return unless expression
+
+          "#{constant_prefix(node)}#{expression}"
+        end
+
+        # @private
+        # @param [RuboCop::AST::Node] node
+        # @return [String]
+        def constant_prefix(node)
+          if node.each_ancestor(:class, :module).any?
+            '::'
+          else
+            ''
+          end
+        end
+
         # @private
         # @param [RuboCop::AST::Node] node
         def on_back_ref_or_gvar_or_nth_ref(node)
-          preferred_expression = preferred_expression_to(node)
+          preferred_expression = preferred_expression_to_node_with_constant_prefix(node)
           return unless preferred_expression
 
           add_offense(

data/lib/rubocop/cop/style/preferred_hash_methods.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of methods `Hash#has_key?` and
+      # Checks for uses of methods `Hash#has_key?` and
       # `Hash#has_value?`, and suggests using `Hash#key?` and `Hash#value?` instead.
       #
       # It is configurable to enforce the verbose method names, by using the

data/lib/rubocop/cop/style/proc.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of Proc.new where Kernel#proc
+      # Checks for uses of Proc.new where Kernel#proc
       # would be more appropriate.
       #
       # @example
@@ -19,7 +19,8 @@ module RuboCop
         MSG = 'Use `proc` instead of `Proc.new`.'
 
         # @!method proc_new?(node)
-        def_node_matcher :proc_new?, '(block $(send (const {nil? cbase} :Proc) :new) ...)'
+        def_node_matcher :proc_new?,
+                         '({block numblock} $(send (const {nil? cbase} :Proc) :new) ...)'
 
         def on_block(node)
           proc_new?(node) do |block_method|
@@ -28,6 +29,8 @@ module RuboCop
             end
           end
         end
+
+        alias on_numblock on_block
       end
     end
   end

data/lib/rubocop/cop/style/raise_args.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks the args passed to `fail` and `raise`. For exploded
+      # Checks the args passed to `fail` and `raise`. For exploded
       # style (default), it recommends passing the exception class and message
       # to `raise`, rather than construct an instance of the error. It will
       # still allow passing just a message, or the construction of an error

data/lib/rubocop/cop/style/random_with_offset.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for the use of randomly generated numbers,
+      # Checks for the use of randomly generated numbers,
       # added/subtracted with integer literals, as well as those with
       # Integer#succ and Integer#pred methods. Prefer using ranges instead,
       # as it clearly states the intentions.

data/lib/rubocop/cop/style/redundant_argument.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for a redundant argument passed to certain methods.
+      # Checks for a redundant argument passed to certain methods.
       #
       # NOTE: This cop is limited to methods with single parameter.
       #
@@ -86,7 +86,7 @@ module RuboCop
           if node.parenthesized?
             range_between(node.loc.begin.begin_pos, node.loc.end.end_pos)
           else
-            range_with_surrounding_space(range: node.first_argument.source_range, newlines: false)
+            range_with_surrounding_space(node.first_argument.source_range, newlines: false)
           end
         end
       end

data/lib/rubocop/cop/style/redundant_assignment.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for redundant assignment before returning.
+      # Checks for redundant assignment before returning.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/redundant_begin.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for redundant `begin` blocks.
+      # Checks for redundant `begin` blocks.
       #
       # Currently it checks for code like this:
       #
@@ -36,6 +36,7 @@ module RuboCop
       #   do_something
       #
       #   # bad
+      #   # When using Ruby 2.5 or later.
       #   do_something do
       #     begin
       #       something
@@ -67,6 +68,11 @@ module RuboCop
 
         MSG = 'Redundant `begin` block detected.'
 
+        # @!method offensive_kwbegins(node)
+        def_node_search :offensive_kwbegins, <<~PATTERN
+          [(kwbegin ...) !#allowable_kwbegin?]
+        PATTERN
+
         def on_def(node)
           return unless node.body&.kwbegin_type?
 
@@ -75,6 +81,7 @@ module RuboCop
         alias on_defs on_def
 
         def on_block(node)
+          return if target_ruby_version < 2.5
           return if node.send_node.lambda_literal?
           return if node.braces?
           return unless node.body&.kwbegin_type?
@@ -82,17 +89,23 @@ module RuboCop
           register_offense(node.body)
         end
 
+        alias on_numblock on_block
+
         def on_kwbegin(node)
-          return if empty_begin?(node) ||
-                    begin_block_has_multiline_statements?(node) ||
-                    contain_rescue_or_ensure?(node) ||
-                    valid_context_using_only_begin?(node)
+          return unless (target_node = offensive_kwbegins(node).to_a.last)
 
-          register_offense(node)
+          register_offense(target_node)
         end
 
         private
 
+        def allowable_kwbegin?(node)
+          empty_begin?(node) ||
+            begin_block_has_multiline_statements?(node) ||
+            contain_rescue_or_ensure?(node) ||
+            valid_context_using_only_begin?(node)
+        end
+
         def register_offense(node)
           offense_range = node.loc.begin
 

data/lib/rubocop/cop/style/redundant_capital_w.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for usage of the %W() syntax when %w() would do.
+      # Checks for usage of the %W() syntax when %w() would do.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/redundant_condition.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for unnecessary conditional expressions.
+      # Checks for unnecessary conditional expressions.
       #
       # @example
       #   # bad
@@ -46,7 +46,7 @@ module RuboCop
           add_offense(range_of_offense(node), message: message) do |corrector|
             if node.ternary? && !branches_have_method?(node)
               correct_ternary(corrector, node)
-            elsif redudant_condition?(node)
+            elsif redundant_condition?(node)
               corrector.replace(node, node.if_branch.source)
             else
               corrected = make_ternary_form(node)
@@ -59,7 +59,7 @@ module RuboCop
         private
 
         def message(node)
-          if redudant_condition?(node)
+          if redundant_condition?(node)
             REDUNDANT_CONDITION
           else
             MSG
@@ -82,7 +82,7 @@ module RuboCop
             (node.ternary? || !else_branch.instance_of?(AST::Node) || else_branch.single_line?)
         end
 
-        def redudant_condition?(node)
+        def redundant_condition?(node)
           node.modifier_form? || !node.else_branch
         end
 
@@ -147,19 +147,29 @@ module RuboCop
 
           if_branch.send_type? && if_branch.arguments.count == 1 &&
             else_branch.send_type? && else_branch.arguments.count == 1 &&
-            if_branch.method?(else_branch.method_name)
+            same_method?(if_branch, else_branch)
         end
 
-        def if_source(if_branch)
+        def same_method?(if_branch, else_branch)
+          if_branch.method?(else_branch.method_name) && if_branch.receiver == else_branch.receiver
+        end
+
+        def if_source(if_branch, arithmetic_operation)
           if branches_have_method?(if_branch.parent) && if_branch.parenthesized?
             if_branch.source.delete_suffix(')')
+          elsif arithmetic_operation
+            argument_source = if_branch.first_argument.source
+
+            "#{if_branch.receiver.source} #{if_branch.method_name} (#{argument_source}"
           else
             if_branch.source
           end
         end
 
-        def else_source(else_branch)
-          if branches_have_method?(else_branch.parent)
+        def else_source(else_branch, arithmetic_operation) # rubocop:disable Metrics/AbcSize
+          if arithmetic_operation
+            "#{else_branch.first_argument.source})"
+          elsif branches_have_method?(else_branch.parent)
             else_source_if_has_method(else_branch)
           elsif require_parentheses?(else_branch)
             "(#{else_branch.source})"
@@ -194,7 +204,12 @@ module RuboCop
 
         def make_ternary_form(node)
           _condition, if_branch, else_branch = *node
-          ternary_form = [if_source(if_branch), else_source(else_branch)].join(' || ')
+          arithmetic_operation = use_arithmetic_operation?(if_branch)
+
+          ternary_form = [
+            if_source(if_branch, arithmetic_operation),
+            else_source(else_branch, arithmetic_operation)
+          ].join(' || ')
           ternary_form += ')' if branches_have_method?(node) && if_branch.parenthesized?
 
           if node.parent&.send_type?
@@ -223,6 +238,10 @@ module RuboCop
           node.hash_type? && !node.braces?
         end
 
+        def use_arithmetic_operation?(node)
+          node.respond_to?(:arithmetic_operation?) && node.arithmetic_operation?
+        end
+
         def without_argument_parentheses_method?(node)
           node.send_type? && !node.arguments.empty? &&
             !node.parenthesized? && !node.operator_method? && !node.assignment_method?

data/lib/rubocop/cop/style/redundant_conditional.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for redundant returning of true/false in conditionals.
+      # Checks for redundant returning of true/false in conditionals.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/redundant_exception.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for RuntimeError as the argument of raise/fail.
+      # Checks for RuntimeError as the argument of raise/fail.
       #
       # It checks for code like this:
       #

data/lib/rubocop/cop/style/redundant_fetch_block.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop identifies places where `fetch(key) { value }`
+      # Identifies places where `fetch(key) { value }`
       # can be replaced by `fetch(key, value)`.
       #
       # In such cases `fetch(key, value)` method is faster
@@ -50,7 +50,7 @@ module RuboCop
             ${nil? #basic_literal? #const_type?})
         PATTERN
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           redundant_fetch_block_candidate?(node) do |send, body|
             return if should_not_check?(send, body)
 

data/lib/rubocop/cop/style/redundant_file_extension_in_require.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for the presence of superfluous `.rb` extension in
+      # Checks for the presence of superfluous `.rb` extension in
       # the filename provided to `require` and `require_relative`.
       #
       # Note: If the extension is omitted, Ruby tries adding '.rb', '.so',

data/lib/rubocop/cop/style/redundant_freeze.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop check for uses of `Object#freeze` on immutable objects.
+      # Check for uses of `Object#freeze` on immutable objects.
       #
       # NOTE: Regexp and Range literals are frozen objects since Ruby 3.0.
       #

data/lib/rubocop/cop/style/redundant_interpolation.rb

@@ -3,7 +3,28 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for strings that are just an interpolated expression.
+      # Checks for strings that are just an interpolated expression.
+      #
+      # @safety
+      #   Autocorrection is unsafe because when calling a destructive method to string,
+      #   the resulting string may have different behavior or raise `FrozenError`.
+      #
+      #   [source,ruby]
+      #   ----
+      #   x = 'a'
+      #   y = "#{x}"
+      #   y << 'b'   # return 'ab'
+      #   x          # return 'a'
+      #   y = x.to_s
+      #   y << 'b'   # return 'ab'
+      #   x          # return 'ab'
+      #
+      #   x = 'a'.freeze
+      #   y = "#{x}"
+      #   y << 'b'   # return 'ab'.
+      #   y = x.to_s
+      #   y << 'b'   # raise `FrozenError`.
+      #   ----
       #
       # @example
       #