rubocop 1.29.1 → 1.48.0

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

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for redundant escapes in string literals.
+      #
+      # @example
+      #   # bad - no need to escape # without following {/$/@
+      #   "\#foo"
+      #
+      #   # bad - no need to escape single quotes inside double quoted string
+      #   "\'foo\'"
+      #
+      #   # bad - heredocs are also checked for unnecessary escapes
+      #   <<~STR
+      #     \#foo \"foo\"
+      #   STR
+      #
+      #   # good
+      #   "#foo"
+      #
+      #   # good
+      #   "\#{no_interpolation}"
+      #
+      #   # good
+      #   "'foo'"
+      #
+      #   # good
+      #   "foo\
+      #   bar"
+      #
+      #   # good
+      #   <<~STR
+      #     #foo "foo"
+      #   STR
+      class RedundantStringEscape < Base
+        include MatchRange
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Redundant escape of %<char>s inside string literal.'
+
+        def on_str(node)
+          return if node.parent&.regexp_type? || node.parent&.xstr_type? || node.character_literal?
+
+          str_contents_range = str_contents_range(node)
+
+          each_match_range(str_contents_range, /(\\.)/) do |range|
+            next if allowed_escape?(node, range.resize(3))
+
+            add_offense(range) do |corrector|
+              corrector.remove_leading(range, 1)
+            end
+          end
+        end
+
+        private
+
+        def message(range)
+          format(MSG, char: range.source[-1])
+        end
+
+        def str_contents_range(node)
+          if heredoc?(node)
+            node.loc.heredoc_body
+          elsif begin_loc_present?(node)
+            contents_range(node)
+          else
+            node.source_range
+          end
+        end
+
+        def begin_loc_present?(node)
+          # e.g. a __FILE__ literal has no begin loc so we can't query if it's nil
+          node.loc.to_hash.key?(:begin) && !node.loc.begin.nil?
+        end
+
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def allowed_escape?(node, range)
+          escaped = range.source[(1..-1)]
+
+          # Inside a single-quoted string, escapes (except \\ and \') do not have special meaning,
+          # and so are not redundant, as they are a literal backslash.
+          return true if interpolation_not_enabled?(node)
+
+          # Strictly speaking a few single-letter chars are currently unnecessary to "escape", e.g.
+          # d, but enumerating them is rather difficult, and their behavior could change over time
+          # with different versions of Ruby so that e.g. /\d/ != /d/
+          return true if /[\n\\[[:alnum:]]]/.match?(escaped[0])
+
+          return true if escaped[0] == ' ' && (percent_array_literal?(node) || node.heredoc?)
+
+          return true if disabling_interpolation?(range)
+          return true if delimiter?(node, escaped[0])
+
+          false
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        def interpolation_not_enabled?(node)
+          single_quoted?(node) ||
+            percent_w_literal?(node) ||
+            percent_q_literal?(node) ||
+            heredoc_with_disabled_interpolation?(node)
+        end
+
+        def single_quoted?(node)
+          delimiter?(node, "'")
+        end
+
+        def percent_q_literal?(node)
+          if literal_in_interpolated_or_multiline_string?(node)
+            percent_q_literal?(node.parent)
+          else
+            node.source.start_with?('%q')
+          end
+        end
+
+        def array_literal?(node, prefix)
+          if literal_in_interpolated_or_multiline_string?(node)
+            array_literal?(node.parent, prefix)
+          else
+            node.parent&.array_type? && node.parent.source.start_with?(prefix)
+          end
+        end
+
+        def percent_w_literal?(node)
+          array_literal?(node, '%w')
+        end
+
+        def percent_w_upper_literal?(node)
+          array_literal?(node, '%W')
+        end
+
+        def percent_array_literal?(node)
+          (percent_w_literal?(node) || percent_w_upper_literal?(node))
+        end
+
+        def heredoc_with_disabled_interpolation?(node)
+          if heredoc?(node)
+            node.source.end_with?("'")
+          elsif node.parent&.dstr_type?
+            heredoc_with_disabled_interpolation?(node.parent)
+          else
+            false
+          end
+        end
+
+        def heredoc?(node)
+          (node.str_type? || node.dstr_type?) && node.heredoc?
+        end
+
+        def delimiter?(node, char)
+          return false if heredoc?(node)
+
+          if literal_in_interpolated_or_multiline_string?(node) || percent_array_literal?(node)
+            return delimiter?(node.parent, char)
+          end
+
+          delimiters = [node.loc.begin.source[-1], node.loc.end.source[0]]
+
+          delimiters.include?(char)
+        end
+
+        def literal_in_interpolated_or_multiline_string?(node)
+          node.str_type? && !begin_loc_present?(node) && node.parent&.dstr_type?
+        end
+
+        def disabling_interpolation?(range)
+          # Allow \#{foo}, \#$foo, \#@foo, and \#@@foo
+          # for escaping local, global, instance and class variable interpolations
+          return true if range.source.match?(/\A\\#[{$@]/)
+          # Also allow #\{foo}, #\$foo, #\@foo and #\@@foo
+          return true if range.adjust(begin_pos: -2).source.match?(/\A[^\\]#\\[{$@]/)
+          # For `\#\{foo} allow `\#` and warn `\{`
+          return true if range.adjust(end_pos: 1).source == '\\#\\{'
+
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces using // or %r around regular expressions.
+      # Enforces using // or %r around regular expressions.
       #
       # @example EnforcedStyle: slashes (default)
       #   # bad

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

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Sort `require` and `require_relative` in alphabetical order.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because it will obviously change the execution order.
+      #
+      # @example
+      #   # bad
+      #   require 'b'
+      #   require 'a'
+      #
+      #   # good
+      #   require 'a'
+      #   require 'b'
+      #
+      #   # bad
+      #   require_relative 'b'
+      #   require_relative 'a'
+      #
+      #   # good
+      #   require_relative 'a'
+      #   require_relative 'b'
+      #
+      #   # good (sorted within each section separated by a blank line)
+      #   require 'a'
+      #   require 'd'
+      #
+      #   require 'b'
+      #   require 'c'
+      #
+      #   # good
+      #   require 'b'
+      #   require_relative 'c'
+      #   require 'a'
+      #
+      #   # bad
+      #   require 'a'
+      #   require 'c' if foo
+      #   require 'b'
+      #
+      #   # good
+      #   require 'a'
+      #   require 'b'
+      #   require 'c' if foo
+      #
+      #   # bad
+      #   require 'c'
+      #   if foo
+      #     require 'd'
+      #     require 'b'
+      #   end
+      #   require 'a'
+      #
+      #   # good
+      #   require 'c'
+      #   if foo
+      #     require 'b'
+      #     require 'd'
+      #   end
+      #   require 'a'
+      #
+      class RequireOrder < Base
+        extend AutoCorrector
+
+        include RangeHelp
+
+        RESTRICT_ON_SEND = %i[require require_relative].freeze
+
+        MSG = 'Sort `%<name>s` in alphabetical order.'
+
+        # @!method if_inside_only_require(node)
+        def_node_matcher :if_inside_only_require, <<~PATTERN
+          {
+            (if _ _ $(send nil? {:require :require_relative} _))
+            (if _ $(send nil? {:require :require_relative} _) _)
+          }
+        PATTERN
+
+        def on_send(node)
+          return unless node.parent && node.arguments?
+          return if not_modifier_form?(node.parent)
+
+          previous_older_sibling = find_previous_older_sibling(node)
+          return unless previous_older_sibling
+
+          add_offense(node, message: format(MSG, name: node.method_name)) do |corrector|
+            corrector.swap(
+              range_with_comments_and_lines(previous_older_sibling),
+              range_with_comments_and_lines(node.parent.if_type? ? node.parent : node)
+            )
+          end
+        end
+
+        private
+
+        def not_modifier_form?(node)
+          node.if_type? && !node.modifier_form?
+        end
+
+        def find_previous_older_sibling(node) # rubocop:disable Metrics
+          search_node(node).left_siblings.reverse.find do |sibling|
+            next unless sibling.is_a?(AST::Node)
+
+            sibling = sibling_node(sibling)
+            break unless sibling&.send_type? && sibling&.method?(node.method_name)
+            break unless sibling.arguments? && !sibling.receiver
+            break unless in_same_section?(sibling, node)
+
+            node.first_argument.source < sibling.first_argument.source
+          end
+        end
+
+        def search_node(node)
+          node.parent.if_type? ? node.parent : node
+        end
+
+        def sibling_node(node)
+          return if not_modifier_form?(node)
+
+          node.if_type? ? if_inside_only_require(node) : node
+        end
+
+        def in_same_section?(node1, node2)
+          !node1.source_range.with(end_pos: node2.source_range.end_pos).source.include?("\n\n")
+        end
+      end
+    end
+  end
+end

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

@@ -3,13 +3,13 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of rescue in its modifier form.
+      # Checks for uses of rescue in its modifier form.
       #
       # The cop to check `rescue` in its modifier form is added for following
       # reasons:
       #
       # * The syntax of modifier form `rescue` can be misleading because it
-      #   might led us to believe that `rescue` handles the given exception
+      #   might lead us to believe that `rescue` handles the given exception
       #   but it actually rescue all exceptions to return the given rescue
       #   block. In this case, value returned by handle_error or
       #   SomeException.

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

@@ -3,25 +3,25 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for rescuing `StandardError`. There are two supported
+      # Checks for rescuing `StandardError`. There are two supported
       # styles `implicit` and `explicit`. This cop will not register an offense
       # if any error other than `StandardError` is specified.
       #
-      # @example EnforcedStyle: implicit
-      #   # `implicit` will enforce using `rescue` instead of
-      #   # `rescue StandardError`.
+      # @example EnforcedStyle: explicit (default)
+      #   # `explicit` will enforce using `rescue StandardError`
+      #   # instead of `rescue`.
       #
       #   # bad
       #   begin
       #     foo
-      #   rescue StandardError
+      #   rescue
       #     bar
       #   end
       #
       #   # good
       #   begin
       #     foo
-      #   rescue
+      #   rescue StandardError
       #     bar
       #   end
       #
@@ -39,21 +39,21 @@ module RuboCop
       #     bar
       #   end
       #
-      # @example EnforcedStyle: explicit (default)
-      #   # `explicit` will enforce using `rescue StandardError`
-      #   # instead of `rescue`.
+      # @example EnforcedStyle: implicit
+      #   # `implicit` will enforce using `rescue` instead of
+      #   # `rescue StandardError`.
       #
       #   # bad
       #   begin
       #     foo
-      #   rescue
+      #   rescue StandardError
       #     bar
       #   end
       #
       #   # good
       #   begin
       #     foo
-      #   rescue StandardError
+      #   rescue
       #     bar
       #   end
       #
@@ -98,24 +98,24 @@ module RuboCop
               offense_for_implicit_enforced_style(node, error)
             end
           when :explicit
-            rescue_without_error_class?(node) { offense_for_exlicit_enforced_style(node) }
+            rescue_without_error_class?(node) { offense_for_explicit_enforced_style(node) }
           end
         end
 
         private
 
         def offense_for_implicit_enforced_style(node, error)
-          range = node.loc.keyword.join(error.loc.expression)
+          range = node.loc.keyword.join(error.source_range)
 
           add_offense(range, message: MSG_IMPLICIT) do |corrector|
             error = rescue_standard_error?(node)
-            range = range_between(node.loc.keyword.end_pos, error.loc.expression.end_pos)
+            range = range_between(node.loc.keyword.end_pos, error.source_range.end_pos)
 
             corrector.remove(range)
           end
         end
 
-        def offense_for_exlicit_enforced_style(node)
+        def offense_for_explicit_enforced_style(node)
           add_offense(node.loc.keyword, message: MSG_EXPLICIT) do |corrector|
             corrector.insert_after(node.loc.keyword, ' StandardError')
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces consistency between 'return nil' and 'return'.
+      # Enforces consistency between 'return nil' and 'return'.
       #
       # Supported styles are: return, return_nil.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop transforms usages of a method call safeguarded by a non `nil`
+      # Transforms usages of a method call safeguarded by a non `nil`
       # check for the variable whose method is being called to
       # safe navigation (`&.`). If there is a method chain, all of the methods
       # in the chain need to be checked for safety, and all of the methods will
@@ -50,6 +50,11 @@ module RuboCop
       #   foo && foo.bar { |e| e.something }
       #   foo && foo.bar(param) { |e| e.something }
       #
+      #   foo ? foo.bar : nil
+      #   foo.nil? ? nil : foo.bar
+      #   !foo.nil? ? foo.bar : nil
+      #   !foo ? nil : foo.bar
+      #
       #   # good
       #   foo&.bar
       #   foo&.bar&.baz
@@ -80,11 +85,14 @@ module RuboCop
         include NilMethods
         include RangeHelp
         extend AutoCorrector
+        extend TargetRubyVersion
 
         MSG = 'Use safe navigation (`&.`) instead of checking if an object ' \
               'exists before calling the method.'
         LOGIC_JUMP_KEYWORDS = %i[break fail next raise return throw yield].freeze
 
+        minimum_target_ruby_version 2.3
+
         # if format: (if checked_variable body nil)
         # unless format: (if checked_variable nil body)
         # @!method modifier_if_safe_navigation_candidate(node)
@@ -102,6 +110,17 @@ module RuboCop
           }
         PATTERN
 
+        # @!method ternary_safe_navigation_candidate(node)
+        def_node_matcher :ternary_safe_navigation_candidate, <<~PATTERN
+          {
+            (if (send $_ {:nil? :!}) nil $_)
+
+            (if (send (send $_ :nil?) :!) $_ nil)
+
+            (if $_ $_ nil)
+          }
+        PATTERN
+
         # @!method not_nil_check?(node)
         def_node_matcher :not_nil_check?, '(send (send $_ :nil?) :!)'
 
@@ -115,9 +134,11 @@ module RuboCop
           check_node(node)
         end
 
+        private
+
         def check_node(node)
           checked_variable, receiver, method_chain, method = extract_parts(node)
-          return unless receiver == checked_variable
+          return if receiver != checked_variable || receiver.nil?
           return if use_var_only_in_unless_modifier?(node, checked_variable)
           return if chain_length(method_chain, method) > max_chain_length
           return if unsafe_method_used?(method_chain, method)
@@ -130,20 +151,26 @@ module RuboCop
           node.if_type? && node.unless? && !method_called?(variable)
         end
 
-        private
-
         def autocorrect(corrector, node)
-          body = node.node_parts[1]
+          body = extract_body(node)
           method_call = method_call(node)
 
           corrector.remove(begin_range(node, body))
           corrector.remove(end_range(node, body))
-          corrector.insert_before(method_call.loc.dot, '&')
+          corrector.insert_before(method_call.loc.dot, '&') unless method_call.safe_navigation?
           handle_comments(corrector, node, method_call)
 
           add_safe_nav_to_all_methods_in_chain(corrector, method_call, body)
         end
 
+        def extract_body(node)
+          if node.if_type? && node.ternary?
+            node.branches.find { |branch| !branch.nil_type? }
+          else
+            node.node_parts[1]
+          end
+        end
+
         def handle_comments(corrector, node, method_call)
           comments = comments(node)
           return if comments.empty?
@@ -171,7 +198,7 @@ module RuboCop
         end
 
         def allowed_if_condition?(node)
-          node.else? || node.elsif? || node.ternary?
+          node.else? || node.elsif?
         end
 
         def method_call(node)
@@ -189,7 +216,12 @@ module RuboCop
         end
 
         def extract_parts_from_if(node)
-          variable, receiver = modifier_if_safe_navigation_candidate(node)
+          variable, receiver =
+            if node.ternary?
+              ternary_safe_navigation_candidate(node)
+            else
+              modifier_if_safe_navigation_candidate(node)
+            end
 
           checked_variable, matching_receiver, method = extract_common_parts(receiver, variable)
 
@@ -247,7 +279,9 @@ module RuboCop
         end
 
         def unsafe_method?(send_node)
-          negated?(send_node) || send_node.assignment? || !send_node.dot?
+          negated?(send_node) ||
+            send_node.assignment? ||
+            (!send_node.dot? && !send_node.safe_navigation?)
         end
 
         def negated?(send_node)
@@ -263,11 +297,11 @@ module RuboCop
         end
 
         def begin_range(node, method_call)
-          range_between(node.loc.expression.begin_pos, method_call.loc.expression.begin_pos)
+          range_between(node.source_range.begin_pos, method_call.source_range.begin_pos)
         end
 
         def end_range(node, method_call)
-          range_between(method_call.loc.expression.end_pos, node.loc.expression.end_pos)
+          range_between(method_call.source_range.end_pos, node.source_range.end_pos)
         end
 
         def add_safe_nav_to_all_methods_in_chain(corrector,

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop is used to identify usages of `shuffle.first`,
+      # Identifies usages of `shuffle.first`,
       # `shuffle.last`, and `shuffle[]` and change them to use
       # `sample` instead.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop looks for places where an subset of an Enumerable (array,
+      # Looks for places where an subset of an Enumerable (array,
       # range, set, etc.; see note below) is calculated based on a `Regexp`
       # match, and suggests `grep` or `grep_v` instead.
       #
@@ -49,7 +49,8 @@ module RuboCop
         MSG = 'Prefer `%<replacement>s` to `%<original_method>s` with a regexp match.'
         RESTRICT_ON_SEND = %i[select find_all reject].freeze
         REPLACEMENTS = { select: 'grep', find_all: 'grep', reject: 'grep_v' }.freeze
-        REGEXP_METHODS = %i[match? =~].to_set.freeze
+        OPPOSITE_REPLACEMENTS = { select: 'grep_v', find_all: 'grep_v', reject: 'grep' }.freeze
+        REGEXP_METHODS = %i[match? =~ !~].to_set.freeze
 
         # @!method regexp_match?(node)
         def_node_matcher :regexp_match?, <<~PATTERN
@@ -85,13 +86,15 @@ module RuboCop
 
         def on_send(node)
           return unless (block_node = node.block_node)
-          return if block_node.body.begin_type?
+          return if block_node.body&.begin_type?
           return if receiver_allowed?(block_node.receiver)
           return unless (regexp_method_send_node = extract_send_node(block_node))
           return if match_predicate_without_receiver?(regexp_method_send_node)
 
+          opposite = opposite?(regexp_method_send_node)
           regexp = find_regexp(regexp_method_send_node, block_node)
-          register_offense(node, block_node, regexp)
+
+          register_offense(node, block_node, regexp, opposite)
         end
 
         private
@@ -102,8 +105,9 @@ module RuboCop
           node.hash_type? || creates_hash?(node) || env_const?(node)
         end
 
-        def register_offense(node, block_node, regexp)
-          replacement = REPLACEMENTS[node.method_name.to_sym]
+        def register_offense(node, block_node, regexp, opposite)
+          method_name = node.method_name.to_sym
+          replacement = opposite ? OPPOSITE_REPLACEMENTS[method_name] : REPLACEMENTS[method_name]
           message = format(MSG, replacement: replacement, original_method: node.method_name)
 
           add_offense(block_node, message: message) do |corrector|
@@ -124,6 +128,10 @@ module RuboCop
           regexp_method_send_node
         end
 
+        def opposite?(regexp_method_send_node)
+          regexp_method_send_node.send_type? && regexp_method_send_node.method?(:!~)
+        end
+
         def find_regexp(node, block)
           return node.child_nodes.first if node.match_with_lvasgn_type?
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use the shorthand for self-assignment.
+      # Enforces the use the shorthand for self-assignment.
       #
       # @example
       #
@@ -42,7 +42,7 @@ module RuboCop
 
           if rhs.send_type?
             check_send_node(node, rhs, var_name, var_type)
-          elsif %i[and or].include?(rhs.type)
+          elsif rhs.operator_keyword?
             check_boolean_node(node, rhs, var_name, var_type)
           end
         end
@@ -76,7 +76,7 @@ module RuboCop
 
           if rhs.send_type?
             autocorrect_send_node(corrector, node, rhs)
-          elsif %i[and or].include?(rhs.type)
+          elsif rhs.operator_keyword?
             autocorrect_boolean_node(corrector, node, rhs)
           end
         end