rubocop 1.19.0 → 1.40.0

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for nested `File.dirname`.
+      # It replaces nested `File.dirname` with the level argument introduced in Ruby 3.1.
+      #
+      # @example
+      #
+      #   # bad
+      #   File.dirname(File.dirname(path))
+      #
+      #   # good
+      #   File.dirname(path, 2)
+      #
+      class NestedFileDirname < Base
+        include RangeHelp
+        extend AutoCorrector
+        extend TargetRubyVersion
+
+        MSG = 'Use `dirname(%<path>s, %<level>s)` instead.'
+        RESTRICT_ON_SEND = %i[dirname].freeze
+
+        minimum_target_ruby_version 3.1
+
+        # @!method file_dirname?(node)
+        def_node_matcher :file_dirname?, <<~PATTERN
+          (send
+            (const {cbase nil?} :File) :dirname ...)
+        PATTERN
+
+        def on_send(node)
+          return if file_dirname?(node.parent) || !file_dirname?(node.first_argument)
+
+          path, level = path_with_dir_level(node, 1)
+          return if level < 2
+
+          message = format(MSG, path: path, level: level)
+          range = offense_range(node)
+
+          add_offense(range, message: message) do |corrector|
+            corrector.replace(range, "dirname(#{path}, #{level})")
+          end
+        end
+
+        private
+
+        def path_with_dir_level(node, level)
+          first_argument = node.first_argument
+
+          if file_dirname?(first_argument)
+            level += 1
+            path_with_dir_level(first_argument, level)
+          else
+            [first_argument.source, level]
+          end
+        end
+
+        def offense_range(node)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for nested use of if, unless, while and until in their
+      # Checks for nested use of if, unless, while and until in their
       # modifier form.
       #
       # @example

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

@@ -3,8 +3,12 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for unparenthesized method calls in the argument list
+      # Checks for unparenthesized method calls in the argument list
       # of a parenthesized method call.
+      # `be`, `be_a`, `be_an`, `be_between`, `be_falsey`, `be_kind_of`, `be_instance_of`,
+      # `be_truthy`, `be_within`, `eq`, `eql`, `end_with`, `include`, `match`, `raise_error`,
+      # `respond_to`, and `start_with` methods are allowed by default.
+      # These are customizable with `AllowedMethods` option.
       #
       # @example
       #   # good
@@ -12,6 +16,11 @@ module RuboCop
       #
       #   # bad
       #   method1(method2 arg)
+      #
+      # @example AllowedMethods: [foo]
+      #   # good
+      #   method1(foo arg)
+      #
       class NestedParenthesizedCalls < Base
         include RangeHelp
         include AllowedMethods
@@ -44,7 +53,7 @@ module RuboCop
           last_arg = nested.last_argument.source_range
 
           leading_space =
-            range_with_surrounding_space(range: first_arg.begin,
+            range_with_surrounding_space(first_arg.begin,
                                          side: :left,
                                          whitespace: true,
                                          continuations: true)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for nested ternary op expressions.
+      # Checks for nested ternary op expressions.
       #
       # @example
       #   # bad
@@ -17,6 +17,8 @@ module RuboCop
       #   end
       class NestedTernaryOperator < Base
         extend AutoCorrector
+        include RangeHelp
+        include IgnoredNode
 
         MSG = 'Ternary operators must not be nested. Prefer `if` or `else` constructs instead.'
 
@@ -26,14 +28,10 @@ module RuboCop
           node.each_descendant(:if).select(&:ternary?).each do |nested_ternary|
             add_offense(nested_ternary) do |corrector|
               if_node = if_node(nested_ternary)
+              next if part_of_ignored_node?(if_node)
 
-              corrector.replace(if_node, <<~RUBY.chop)
-                if #{if_node.condition.source}
-                  #{remove_parentheses(if_node.if_branch.source)}
-                else
-                  #{if_node.else_branch.source}
-                end
-              RUBY
+              autocorrect(corrector, if_node)
+              ignore_node(if_node)
             end
           end
         end
@@ -47,11 +45,25 @@ module RuboCop
           if_node(node)
         end
 
+        def autocorrect(corrector, if_node)
+          replace_loc_and_whitespace(corrector, if_node.loc.question, "\n")
+          replace_loc_and_whitespace(corrector, if_node.loc.colon, "\nelse\n")
+          corrector.replace(if_node.if_branch, remove_parentheses(if_node.if_branch.source))
+          corrector.wrap(if_node, 'if ', "\nend")
+        end
+
         def remove_parentheses(source)
           return source unless source.start_with?('(')
 
           source.delete_prefix('(').delete_suffix(')')
         end
+
+        def replace_loc_and_whitespace(corrector, range, replacement)
+          corrector.replace(
+            range_with_surrounding_space(range: range, whitespace: true),
+            replacement
+          )
+        end
       end
     end
   end

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

@@ -71,6 +71,8 @@ module RuboCop
           check(node)
         end
 
+        alias on_numblock on_block
+
         def on_while(node)
           check(node)
         end
@@ -185,7 +187,7 @@ module RuboCop
         end
 
         def end_followed_by_whitespace_only?(source_buffer, end_pos)
-          /\A\s*$/.match?(source_buffer.source[end_pos..-1])
+          /\A\s*$/.match?(source_buffer.source[end_pos..])
         end
 
         def reindentable_lines(node)
@@ -223,11 +225,7 @@ module RuboCop
           adjustment = delta + @reindented_lines[lineno]
           @reindented_lines[lineno] = adjustment
 
-          if adjustment.positive?
-            corrector.remove_leading(buffer.line_range(lineno), adjustment)
-          elsif adjustment.negative?
-            corrector.insert_before(buffer.line_range(lineno), ' ' * -adjustment)
-          end
+          corrector.remove_leading(buffer.line_range(lineno), adjustment) if adjustment.positive?
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for comparison of something with nil using `==` and
+      # Checks for comparison of something with nil using `==` and
       # `nil?`.
       #
       # Supported styles are: predicate, comparison.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for lambdas and procs that always return nil,
+      # Checks for lambdas and procs that always return nil,
       # which can be replaced with an empty lambda or proc instead.
       #
       # @example
@@ -43,8 +43,8 @@ module RuboCop
           { ({return next break} nil) (nil) }
         PATTERN
 
-        def on_block(node)
-          return unless node.lambda? || node.proc?
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          return unless node.lambda_or_proc?
           return unless nil_return?(node.body)
 
           message = format(MSG, type: node.lambda? ? 'lambda' : 'proc')
@@ -57,7 +57,7 @@ module RuboCop
 
         def autocorrect(corrector, node)
           range = if node.single_line?
-                    range_with_surrounding_space(range: node.body.loc.expression)
+                    range_with_surrounding_space(node.body.loc.expression)
                   else
                     range_by_whole_lines(node.body.loc.expression, include_final_newline: true)
                   end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for non-nil checks, which are usually redundant.
+      # Checks for non-nil checks, which are usually redundant.
       #
       # With `IncludeSemanticChanges` set to `false` by default, this cop
       # does not report offenses for `!x.nil?` and does no changes that might
@@ -63,7 +63,7 @@ module RuboCop
 
         def on_send(node)
           return if ignored_node?(node) ||
-                    !include_semantic_changes? && nil_comparison_style == 'comparison'
+                    (!include_semantic_changes? && nil_comparison_style == 'comparison')
           return unless register_offense?(node)
 
           message = message(node)
@@ -87,7 +87,7 @@ module RuboCop
 
         def register_offense?(node)
           not_equal_to_nil?(node) ||
-            include_semantic_changes? && (not_and_nil_check?(node) || unless_and_nil_check?(node))
+            (include_semantic_changes? && (not_and_nil_check?(node) || unless_and_nil_check?(node)))
         end
 
         def autocorrect(corrector, node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of the keyword `not` instead of `!`.
+      # Checks for uses of the keyword `not` instead of `!`.
       #
       # @example
       #
@@ -33,7 +33,7 @@ module RuboCop
           return unless node.prefix_not?
 
           add_offense(node.loc.selector) do |corrector|
-            range = range_with_surrounding_space(range: node.loc.selector, side: :right)
+            range = range_with_surrounding_space(node.loc.selector, side: :right)
 
             if opposite_method?(node.receiver)
               correct_opposite_method(corrector, range, node.receiver)
@@ -53,8 +53,8 @@ module RuboCop
 
         def requires_parens?(child)
           child.and_type? || child.or_type? ||
-            child.send_type? && child.binary_operation? ||
-            child.if_type? && child.ternary?
+            (child.send_type? && child.binary_operation?) ||
+            (child.if_type? && child.ternary?)
         end
 
         def correct_opposite_method(corrector, range, child)

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for numbered parameters.
+      #
+      # It can either restrict the use of numbered parameters to
+      # single-lined blocks, or disallow completely numbered parameters.
+      #
+      # @example EnforcedStyle: allow_single_line (default)
+      #   # bad
+      #   collection.each do
+      #     puts _1
+      #   end
+      #
+      #   # good
+      #   collection.each { puts _1 }
+      #
+      # @example EnforcedStyle: disallow
+      #   # bad
+      #   collection.each { puts _1 }
+      #
+      #   # good
+      #   collection.each { |item| puts item }
+      #
+      class NumberedParameters < Base
+        include ConfigurableEnforcedStyle
+        extend TargetRubyVersion
+
+        MSG_DISALLOW = 'Avoid using numbered parameters.'
+        MSG_MULTI_LINE = 'Avoid using numbered parameters for multi-line blocks.'
+
+        minimum_target_ruby_version 2.7
+
+        def on_numblock(node)
+          if style == :disallow
+            add_offense(node, message: MSG_DISALLOW)
+          elsif node.multiline?
+            add_offense(node, message: MSG_MULTI_LINE)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Detects use of an excessive amount of numbered parameters in a
+      # single block. Having too many numbered parameters can make code too
+      # cryptic and hard to read.
+      #
+      # The cop defaults to registering an offense if there is more than 1 numbered
+      # parameter but this maximum can be configured by setting `Max`.
+      #
+      # @example Max: 1 (default)
+      #   # bad
+      #   foo { _1.call(_2, _3, _4) }
+      #
+      #   # good
+      #   foo { do_something(_1) }
+      class NumberedParametersLimit < Base
+        extend TargetRubyVersion
+        extend ExcludeLimit
+
+        DEFAULT_MAX_VALUE = 1
+
+        minimum_target_ruby_version 2.7
+        exclude_limit 'Max'
+
+        MSG = 'Avoid using more than %<max>i numbered %<parameter>s; %<count>i detected.'
+
+        def on_numblock(node)
+          _send_node, param_count, * = *node
+          return if param_count <= max_count
+
+          parameter = max_count > 1 ? 'parameters' : 'parameter'
+          message = format(MSG, max: max_count, parameter: parameter, count: param_count)
+          add_offense(node, message: message) { self.max = param_count }
+        end
+
+        private
+
+        def max_count
+          max = cop_config.fetch('Max', DEFAULT_MAX_VALUE)
+
+          # Ruby does not allow more than 9 numbered parameters
+          [max, 9].min
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for octal, hex, binary, and decimal literals using
+      # Checks for octal, hex, binary, and decimal literals using
       # uppercase prefixes and corrects them to lowercase prefix
       # or no prefix (in case of decimals).
       #

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

@@ -3,9 +3,17 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for big numeric literals without _ between groups
+      # Checks for big numeric literals without `_` between groups
       # of digits in them.
       #
+      # Additional allowed patterns can be added by adding regexps to
+      # the `AllowedPatterns` configuration. All regexps are treated
+      # as anchored even if the patterns do not contain anchors (so
+      # `\d{4}_\d{4}` will allow `1234_5678` but not `1234_5678_9012`).
+      #
+      # NOTE: Even if `AllowedPatterns` are given, autocorrection will
+      # only correct to the standard pattern of an `_` every 3 digits.
+      #
       # @example
       #
       #   # bad
@@ -27,8 +35,14 @@ module RuboCop
       #   # bad
       #   10_000_00 # typical representation of $10,000 in cents
       #
+      # @example AllowedNumbers: [3000]
+      #
+      #   # good
+      #   3000 # You can specify allowed numbers. (e.g. port number)
+      #
       class NumericLiterals < Base
         include IntegerNode
+        include AllowedPattern
         extend AutoCorrector
 
         MSG = 'Use underscores(_) as thousands separator and separate every 3 digits with them.'
@@ -51,25 +65,25 @@ module RuboCop
 
         def check(node)
           int = integer_part(node)
-
           # TODO: handle non-decimal literals as well
           return if int.start_with?('0')
+          return if allowed_numbers.include?(int)
+          return if matches_allowed_pattern?(int)
           return unless int.size >= min_digits
 
           case int
           when /^\d+$/
-            return unless (self.min_digits = int.size + 1)
-
-            register_offense(node)
+            register_offense(node) { self.min_digits = int.size + 1 }
           when /\d{4}/, short_group_regex
-            return unless (self.config_to_allow_offenses = { 'Enabled' => false })
-
-            register_offense(node)
+            register_offense(node) { self.config_to_allow_offenses = { 'Enabled' => false } }
           end
         end
 
-        def register_offense(node)
-          add_offense(node) { |corrector| corrector.replace(node, format_number(node)) }
+        def register_offense(node, &_block)
+          add_offense(node) do |corrector|
+            yield
+            corrector.replace(node, format_number(node))
+          end
         end
 
         def short_group_regex
@@ -100,6 +114,15 @@ module RuboCop
         def min_digits
           cop_config['MinDigits']
         end
+
+        def allowed_numbers
+          cop_config.fetch('AllowedNumbers', []).map(&:to_s)
+        end
+
+        def allowed_patterns
+          # Convert the patterns to be anchored
+          super.map { |regexp| Regexp.new(/\A#{regexp}\z/) }
+        end
       end
     end
   end

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

@@ -3,47 +3,82 @@
 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.
       #
+      # @safety
+      #   This cop is unsafe because it cannot be guaranteed that the receiver
+      #   defines the predicates or can be compared to a number, which may lead
+      #   to a false positive for non-standard classes.
+      #
       # @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`.'
@@ -56,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)
@@ -69,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
@@ -77,7 +116,7 @@ module RuboCop
               predicate(node)
             end
 
-          return unless numeric && operator
+          return unless numeric && operator && replacement_supported?(operator)
 
           [numeric, replacement(numeric, operator)]
         end
@@ -102,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