rubocop 0.93.1 → 1.79.2

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks if the quotes used for quoted symbols match the configured defaults.
+      # By default uses the same configuration as `Style/StringLiterals`; if that
+      # cop is not enabled, the default `EnforcedStyle` is `single_quotes`.
+      #
+      # String interpolation is always kept in double quotes.
+      #
+      # NOTE: `Lint/SymbolConversion` can be used in parallel to ensure that symbols
+      # are not quoted that don't need to be. This cop is for configuring the quoting
+      # style to use for symbols that require quotes.
+      #
+      # @example EnforcedStyle: same_as_string_literals (default) / single_quotes
+      #   # bad
+      #   :"abc-def"
+      #
+      #   # good
+      #   :'abc-def'
+      #   :"#{str}"
+      #   :"a\'b"
+      #
+      # @example EnforcedStyle: double_quotes
+      #   # bad
+      #   :'abc-def'
+      #
+      #   # good
+      #   :"abc-def"
+      #   :"#{str}"
+      #   :"a\'b"
+      class QuotedSymbols < Base
+        include ConfigurableEnforcedStyle
+        include SymbolHelp
+        include StringLiteralsHelp
+        extend AutoCorrector
+
+        MSG_SINGLE = "Prefer single-quoted symbols when you don't need string interpolation " \
+                     'or special symbols.'
+        MSG_DOUBLE = 'Prefer double-quoted symbols unless you need single quotes to ' \
+                     'avoid extra backslashes for escaping.'
+
+        def on_sym(node)
+          return unless quoted?(node)
+
+          message = style == :single_quotes ? MSG_SINGLE : MSG_DOUBLE
+
+          if wrong_quotes?(node) || invalid_double_quotes?(node.source)
+            add_offense(node, message: message) do |corrector|
+              opposite_style_detected
+              autocorrect(corrector, node)
+            end
+          else
+            correct_style_detected
+          end
+        end
+
+        private
+
+        def invalid_double_quotes?(source)
+          return false unless style == :double_quotes
+
+          # The string needs single quotes if:
+          # 1. It contains a double quote
+          # 2. It contains text that would become an escape sequence with double quotes
+          # 3. It contains text that would become an interpolation with double quotes
+          !/" | (?<!\\)\\[aAbcdefkMnprsStuUxzZ0-7] | \#[@{$]/x.match?(source)
+        end
+
+        def autocorrect(corrector, node)
+          str = if hash_colon_key?(node)
+                  # strip quotes
+                  correct_quotes(node.source[1..-2])
+                else
+                  # strip leading `:` and quotes
+                  ":#{correct_quotes(node.source[2..-2])}"
+                end
+
+          corrector.replace(node, str)
+        end
+
+        def hash_colon_key?(node)
+          # Is the node a hash key with the colon style?
+          hash_key?(node) && node.parent.colon?
+        end
+
+        def correct_quotes(str)
+          correction = if style == :single_quotes
+                         to_string_literal(str)
+                       else
+                         str.gsub("\\'", "'").inspect
+                       end
+
+          # The conversion process doubles escaped slashes, so they have to be reverted
+          correction.gsub('\\\\', '\\').gsub('\"', '"')
+        end
+
+        def style
+          return super unless super == :same_as_string_literals
+          return :single_quotes unless config.cop_enabled?('Style/StringLiterals')
+
+          string_literals_config['EnforcedStyle'].to_sym
+        end
+
+        def alternative_style
+          (supported_styles - [style, :same_as_string_literals]).first
+        end
+
+        def quoted?(sym_node)
+          sym_node.source.match?(/\A:?(['"]).*?\1\z/m)
+        end
+
+        def wrong_quotes?(node)
+          return super if hash_key?(node)
+
+          super(node.source[1..])
+        end
+      end
+    end
+  end
+end

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

@@ -3,43 +3,56 @@
 module RuboCop
   module Cop
     module Style
-      # This cop 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
-      # with more than one argument.
+      # Checks the args passed to `fail` and `raise`.
       #
-      # The exploded style works identically, but with the addition that it
-      # will also suggest constructing error objects when the exception is
-      # passed multiple arguments.
+      # Exploded style (default) enforces passing the exception class and message
+      # arguments separately, rather than constructing an instance of the error.
+      #
+      # Compact style enforces constructing an error instance.
+      #
+      # Both styles allow passing just a message, or an error instance when there is more
+      # than one argument.
+      #
+      # The exploded style has an `AllowedCompactTypes` configuration
+      # option that takes an `Array` of exception name Strings.
+      #
+      # @safety
+      #   This cop is unsafe because `raise Foo` calls `Foo.exception`, not `Foo.new`.
       #
       # @example EnforcedStyle: exploded (default)
       #   # bad
-      #   raise StandardError.new("message")
+      #   raise StandardError.new('message')
       #
       #   # good
-      #   raise StandardError, "message"
-      #   fail "message"
+      #   raise StandardError, 'message'
+      #   fail 'message'
+      #   raise MyCustomError
       #   raise MyCustomError.new(arg1, arg2, arg3)
       #   raise MyKwArgError.new(key1: val1, key2: val2)
       #
+      #   # With `AllowedCompactTypes` set to ['MyWrappedError']
+      #   raise MyWrappedError.new(obj)
+      #   raise MyWrappedError.new(obj), 'message'
+      #
       # @example EnforcedStyle: compact
       #   # bad
-      #   raise StandardError, "message"
+      #   raise StandardError, 'message'
       #   raise RuntimeError, arg1, arg2, arg3
       #
       #   # good
-      #   raise StandardError.new("message")
+      #   raise StandardError.new('message')
+      #   raise MyCustomError
       #   raise MyCustomError.new(arg1, arg2, arg3)
-      #   fail "message"
+      #   fail 'message'
       class RaiseArgs < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        EXPLODED_MSG = 'Provide an exception class and message ' \
-          'as arguments to `%<method>s`.'
-        COMPACT_MSG = 'Provide an exception object ' \
-          'as an argument to `%<method>s`.'
+        EXPLODED_MSG = 'Provide an exception class and message as arguments to `%<method>s`.'
+        COMPACT_MSG = 'Provide an exception object as an argument to `%<method>s`.'
+        ACCEPTABLE_ARG_TYPES = %i[
+          hash forwarded_restarg splat forwarded_restarg forwarded_args
+        ].freeze
 
         RESTRICT_ON_SEND = %i[raise fail].freeze
 
@@ -59,8 +72,7 @@ module RuboCop
         def correction_compact_to_exploded(node)
           exception_node, _new, message_node = *node.first_argument
 
-          arguments =
-            [exception_node, message_node].compact.map(&:source).join(', ')
+          arguments = [exception_node, message_node].compact.map(&:source).join(', ')
 
           if node.parent && requires_parens?(node.parent)
             "#{node.method_name}(#{arguments})"
@@ -71,23 +83,28 @@ module RuboCop
 
         def correction_exploded_to_compact(node)
           exception_node, *message_nodes = *node.arguments
-          return node.source if message_nodes.size > 1
+          return if message_nodes.size > 1
 
           argument = message_nodes.first.source
+          exception_class = exception_node.receiver&.source || exception_node.source
 
           if node.parent && requires_parens?(node.parent)
-            "#{node.method_name}(#{exception_node.const_name}.new(#{argument}))"
+            "#{node.method_name}(#{exception_class}.new(#{argument}))"
           else
-            "#{node.method_name} #{exception_node.const_name}.new(#{argument})"
+            "#{node.method_name} #{exception_class}.new(#{argument})"
           end
         end
 
         def check_compact(node)
           if node.arguments.size > 1
+            exception = node.first_argument
+            return if exception.send_type? && exception.first_argument&.hash_type?
+
             add_offense(node, message: format(COMPACT_MSG, method: node.method_name)) do |corrector|
               replacement = correction_exploded_to_compact(node)
 
               corrector.replace(node, replacement)
+              opposite_style_detected
             end
           else
             correct_style_detected
@@ -99,16 +116,22 @@ module RuboCop
 
           first_arg = node.first_argument
 
-          return unless first_arg.send_type? && first_arg.method?(:new)
-          return if acceptable_exploded_args?(first_arg.arguments)
+          return if !use_new_method?(first_arg) || acceptable_exploded_args?(first_arg.arguments)
+
+          return if allowed_non_exploded_type?(first_arg)
 
           add_offense(node, message: format(EXPLODED_MSG, method: node.method_name)) do |corrector|
             replacement = correction_compact_to_exploded(node)
 
             corrector.replace(node, replacement)
+            opposite_style_detected
           end
         end
 
+        def use_new_method?(first_arg)
+          first_arg.send_type? && first_arg.receiver && first_arg.method?(:new)
+        end
+
         def acceptable_exploded_args?(args)
           # Allow code like `raise Ex.new(arg1, arg2)`.
           return true if args.size > 1
@@ -118,14 +141,18 @@ module RuboCop
 
           arg = args.first
 
-          # Allow code like `raise Ex.new(kw: arg)`.
-          # Allow code like `raise Ex.new(*args)`.
-          arg.hash_type? || arg.splat_type?
+          # Allow nodes that may forward more than one argument
+          ACCEPTABLE_ARG_TYPES.include?(arg.type)
+        end
+
+        def allowed_non_exploded_type?(arg)
+          type = arg.receiver.const_name
+
+          Array(cop_config['AllowedCompactTypes']).include?(type)
         end
 
         def requires_parens?(parent)
-          parent.and_type? || parent.or_type? ||
-            parent.if_type? && parent.ternary?
+          parent.operator_keyword? || (parent.if_type? && parent.ternary?)
         end
       end
     end

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.
@@ -26,51 +26,50 @@ module RuboCop
       class RandomWithOffset < Base
         extend AutoCorrector
 
-        MSG = 'Prefer ranges when generating random numbers instead of ' \
-          'integers with offsets.'
+        MSG = 'Prefer ranges when generating random numbers instead of integers with offsets.'
         RESTRICT_ON_SEND = %i[+ - succ pred next].freeze
 
+        # @!method integer_op_rand?(node)
         def_node_matcher :integer_op_rand?, <<~PATTERN
           (send
             int {:+ :-}
             (send
               {nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
               :rand
-              {int (irange int int) (erange int int)}))
+              {int (range int int)}))
         PATTERN
 
+        # @!method rand_op_integer?(node)
         def_node_matcher :rand_op_integer?, <<~PATTERN
           (send
             (send
               {nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
               :rand
-              {int (irange int int) (erange int int)})
+              {int (range int int)})
             {:+ :-}
             int)
         PATTERN
 
+        # @!method rand_modified?(node)
         def_node_matcher :rand_modified?, <<~PATTERN
           (send
             (send
               {nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
               :rand
-              {int (irange int int) (erange int int)})
+              {int (range int int)})
             {:succ :pred :next})
         PATTERN
 
         def on_send(node)
           return unless node.receiver
-          return unless integer_op_rand?(node) ||
-                        rand_op_integer?(node) ||
-                        rand_modified?(node)
+          return unless integer_op_rand?(node) || rand_op_integer?(node) || rand_modified?(node)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         private
 
+        # @!method random_call(node)
         def_node_matcher :random_call, <<~PATTERN
           {(send (send $_ _ $_) ...)
            (send _ _ (send $_ _ $_))}
@@ -144,6 +143,7 @@ module RuboCop
           end
         end
 
+        # @!method to_int(node)
         def_node_matcher :to_int, <<~PATTERN
           (int $_)
         PATTERN

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for a redundant argument passed to certain methods.
+      #
+      # NOTE: This cop is limited to methods with single parameter.
+      #
+      # Method names and their redundant arguments can be configured like this:
+      #
+      # [source,yaml]
+      # ----
+      # Methods:
+      #   join: ''
+      #   sum: 0
+      #   split: ' '
+      #   chomp: "\n"
+      #   chomp!: "\n"
+      #   foo: 2
+      # ----
+      #
+      # @safety
+      #   This cop is unsafe because of the following limitations:
+      #
+      #   1. This cop matches by method names only and hence cannot tell apart
+      #      methods with same name in different classes.
+      #   2. This cop may be unsafe if certain special global variables (e.g. `$;`, `$/`) are set.
+      #      That depends on the nature of the target methods, of course. For example, the default
+      #      argument to join is `$OUTPUT_FIELD_SEPARATOR` (or `$,`) rather than `''`, and if that
+      #      global is changed, `''` is no longer a redundant argument.
+      #
+      # @example
+      #   # bad
+      #   array.join('')
+      #   [1, 2, 3].join("")
+      #   array.sum(0)
+      #   exit(true)
+      #   exit!(false)
+      #   string.split(" ")
+      #   "first\nsecond".split(" ")
+      #   string.chomp("\n")
+      #   string.chomp!("\n")
+      #   A.foo(2)
+      #
+      #   # good
+      #   array.join
+      #   [1, 2, 3].join
+      #   array.sum
+      #   exit
+      #   exit!
+      #   string.split
+      #   "first second".split
+      #   string.chomp
+      #   string.chomp!
+      #   A.foo
+      class RedundantArgument < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Argument %<arg>s is redundant because it is implied by default.'
+        NO_RECEIVER_METHODS = %i[exit exit!].freeze
+
+        def on_send(node)
+          return if !NO_RECEIVER_METHODS.include?(node.method_name) && node.receiver.nil?
+          return if node.arguments.count != 1
+          return unless redundant_argument?(node)
+
+          offense_range = argument_range(node)
+          message = format(MSG, arg: node.first_argument.source)
+
+          add_offense(offense_range, message: message) do |corrector|
+            corrector.remove(offense_range)
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def redundant_argument?(node)
+          redundant_argument = redundant_arg_for_method(node.method_name.to_s)
+          return false if redundant_argument.nil?
+
+          target_argument = if node.first_argument.respond_to?(:value)
+                              node.first_argument.value
+                            else
+                              node.first_argument
+                            end
+
+          argument_matched?(target_argument, redundant_argument)
+        end
+
+        def redundant_arg_for_method(method_name)
+          arg = cop_config['Methods'].fetch(method_name) { return }
+
+          @mem ||= {}
+          @mem[method_name] ||= arg.inspect
+        end
+
+        def argument_range(node)
+          if node.parenthesized?
+            range_between(node.loc.begin.begin_pos, node.loc.end.end_pos)
+          else
+            range_with_surrounding_space(node.first_argument.source_range, newlines: false)
+          end
+        end
+
+        def argument_matched?(target_argument, redundant_argument)
+          argument = if target_argument.is_a?(AST::Node)
+                       target_argument.source
+                     elsif exclude_cntrl_character?(target_argument, redundant_argument)
+                       target_argument.inspect
+                     else
+                       target_argument.to_s
+                     end
+
+          argument == redundant_argument
+        end
+
+        def exclude_cntrl_character?(target_argument, redundant_argument)
+          return true unless (target_argument_string = target_argument.to_s).valid_encoding?
+
+          !target_argument_string.sub(/\A'/, '"').sub(/'\z/, '"').match?(/[[:cntrl:]]/) ||
+            !redundant_argument.match?(/[[:cntrl:]]/)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for the instantiation of array using redundant `Array` constructor.
+      # Autocorrect replaces to array literal which is the simplest and fastest.
+      #
+      # @example
+      #
+      #   # bad
+      #   Array.new([])
+      #   Array[]
+      #   Array([])
+      #   Array.new(['foo', 'foo', 'foo'])
+      #   Array['foo', 'foo', 'foo']
+      #   Array(['foo', 'foo', 'foo'])
+      #
+      #   # good
+      #   []
+      #   ['foo', 'foo', 'foo']
+      #   Array.new(3, 'foo')
+      #   Array.new(3) { 'foo' }
+      #
+      class RedundantArrayConstructor < Base
+        extend AutoCorrector
+
+        MSG = 'Remove the redundant `Array` constructor.'
+
+        RESTRICT_ON_SEND = %i[new [] Array].freeze
+
+        # @!method redundant_array_constructor(node)
+        def_node_matcher :redundant_array_constructor, <<~PATTERN
+          {
+            (send
+              (const {nil? cbase} :Array) :new
+              $(array ...))
+            (send
+              (const {nil? cbase} :Array) :[]
+              $...)
+            (send
+              nil? :Array
+              $(array ...))
+          }
+        PATTERN
+
+        def on_send(node)
+          return unless (array_literal = redundant_array_constructor(node))
+
+          receiver = node.receiver
+          selector = node.loc.selector
+
+          if node.method?(:new)
+            range = receiver.source_range.join(selector)
+            replacement = array_literal
+          elsif node.method?(:Array)
+            range = selector
+            replacement = array_literal
+          else
+            range = receiver
+            replacement = selector.begin.join(node.source_range.end)
+          end
+
+          register_offense(range, node, replacement)
+        end
+
+        private
+
+        def register_offense(range, node, replacement)
+          add_offense(range) do |corrector|
+            corrector.replace(node, replacement.source)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for redundant calls of `Array#flatten`.
+      #
+      # `Array#join` joins nested arrays recursively, so flattening an array
+      # beforehand is redundant.
+      #
+      # @safety
+      #   Cop is unsafe because the receiver of `flatten` method might not
+      #   be an `Array`, so it's possible it won't respond to `join` method,
+      #   or the end result would be different.
+      #   Also, if the global variable `$,` is set to a value other than the default `nil`,
+      #   false positives may occur.
+      #
+      # @example
+      #   # bad
+      #   x.flatten.join
+      #   x.flatten(1).join
+      #
+      #   # good
+      #   x.join
+      #
+      class RedundantArrayFlatten < Base
+        extend AutoCorrector
+
+        MSG = 'Remove the redundant `flatten`.'
+
+        RESTRICT_ON_SEND = %i[flatten].freeze
+
+        # @!method flatten_join?(node)
+        def_node_matcher :flatten_join?, <<~PATTERN
+          (call (call !nil? :flatten _?) :join (nil)?)
+        PATTERN
+
+        def on_send(node)
+          return unless flatten_join?(node.parent)
+
+          range = node.loc.dot.begin.join(node.source_range.end)
+          add_offense(range) do |corrector|
+            corrector.remove(range)
+          end
+        end
+        alias on_csend on_send
+      end
+    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
@@ -42,6 +42,7 @@ module RuboCop
 
         MSG = 'Redundant assignment before returning detected.'
 
+        # @!method redundant_assignment?(node)
         def_node_matcher :redundant_assignment?, <<~PATTERN
           (... $(lvasgn _name _expression) (lvar _name))
         PATTERN
@@ -53,12 +54,14 @@ module RuboCop
 
         private
 
+        # rubocop:disable Metrics/CyclomaticComplexity
         def check_branch(node)
           return unless node
 
           case node.type
-          when :case   then check_case_node(node)
-          when :if     then check_if_node(node)
+          when :case       then check_case_node(node)
+          when :case_match then check_case_match_node(node)
+          when :if         then check_if_node(node)
           when :rescue, :resbody
             check_rescue_node(node)
           when :ensure then check_ensure_node(node)
@@ -66,12 +69,18 @@ module RuboCop
             check_begin_node(node)
           end
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def check_case_node(node)
           node.when_branches.each { |when_node| check_branch(when_node.body) }
           check_branch(node.else_branch)
         end
 
+        def check_case_match_node(node)
+          node.in_pattern_branches.each { |in_pattern_node| check_branch(in_pattern_node.body) }
+          check_branch(node.else_branch)
+        end
+
         def check_if_node(node)
           return if node.modifier_form? || node.ternary?
 
@@ -80,13 +89,11 @@ module RuboCop
         end
 
         def check_rescue_node(node)
-          node.child_nodes.each do |child_node|
-            check_branch(child_node)
-          end
+          node.child_nodes.each { |child_node| check_branch(child_node) }
         end
 
         def check_ensure_node(node)
-          check_branch(node.body)
+          check_branch(node.branch)
         end
 
         def check_begin_node(node)