rubocop 1.44.1 → 1.78.0

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

@@ -13,31 +13,115 @@ module RuboCop
       #   # good
       #   do_something(foo: bar, baz: qux)
       #
+      #   # bad
+      #   do_something(**{foo: bar, baz: qux}.merge(options))
+      #
+      #   # good
+      #   do_something(foo: bar, baz: qux, **options)
+      #
       class RedundantDoubleSplatHashBraces < Base
         extend AutoCorrector
 
         MSG = 'Remove the redundant double splat and braces, use keyword arguments directly.'
+        MERGE_METHODS = %i[merge merge!].freeze
 
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def on_hash(node)
           return if node.pairs.empty? || node.pairs.any?(&:hash_rocket?)
           return unless (parent = node.parent)
-          return unless parent.kwsplat_type?
+          return unless parent.type?(:call, :kwsplat)
+          return unless mergeable?(parent)
+          return unless (kwsplat = node.each_ancestor(:kwsplat).first)
+          return if !node.braces? || allowed_double_splat_receiver?(kwsplat)
 
-          add_offense(parent) do |corrector|
-            corrector.remove(parent.loc.operator)
-            corrector.remove(opening_brace(node))
-            corrector.remove(closing_brace(node))
+          add_offense(kwsplat) do |corrector|
+            autocorrect(corrector, node, kwsplat)
           end
         end
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         private
 
+        def allowed_double_splat_receiver?(kwsplat)
+          first_child = kwsplat.children.first
+          return true if first_child.any_block_type?
+          return false unless first_child.call_type?
+
+          root_receiver = root_receiver(first_child)
+
+          !root_receiver&.hash_type?
+        end
+
+        def autocorrect(corrector, node, kwsplat)
+          corrector.remove(kwsplat.loc.operator)
+          corrector.remove(opening_brace(node))
+          corrector.remove(closing_brace(node))
+
+          merge_methods = select_merge_method_nodes(kwsplat)
+          return if merge_methods.empty?
+
+          autocorrect_merge_methods(corrector, merge_methods, kwsplat)
+        end
+
+        def root_receiver(node)
+          receiver = node.receiver
+          if receiver&.receiver
+            root_receiver(receiver)
+          else
+            receiver
+          end
+        end
+
+        def select_merge_method_nodes(kwsplat)
+          kwsplat.each_descendant(:call).select do |node|
+            mergeable?(node)
+          end
+        end
+
         def opening_brace(node)
-          node.loc.begin.join(node.children.first.loc.expression.begin)
+          node.loc.begin.join(node.children.first.source_range.begin)
         end
 
         def closing_brace(node)
-          node.children.last.loc.expression.end.join(node.loc.end)
+          node.children.last.source_range.end.join(node.loc.end)
+        end
+
+        def autocorrect_merge_methods(corrector, merge_methods, kwsplat)
+          range = range_of_merge_methods(merge_methods)
+
+          new_kwsplat_arguments = kwsplat.each_descendant(:call).map do |descendant|
+            convert_to_new_arguments(descendant)
+          end
+          new_source = new_kwsplat_arguments.compact.reverse.unshift('').join(', ')
+
+          corrector.replace(range, new_source)
+        end
+
+        def range_of_merge_methods(merge_methods)
+          begin_merge_method = merge_methods.last
+          end_merge_method = merge_methods.first
+
+          begin_merge_method.loc.dot.begin.join(end_merge_method.source_range.end)
+        end
+
+        def convert_to_new_arguments(node)
+          return unless mergeable?(node)
+
+          node.arguments.map do |arg|
+            if arg.hash_type?
+              arg.source
+            else
+              "**#{arg.source}"
+            end
+          end
+        end
+
+        def mergeable?(node)
+          return true unless node.call_type?
+          return false unless MERGE_METHODS.include?(node.method_name)
+          return true unless (parent = node.parent)
+
+          mergeable?(parent)
         end
       end
     end

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

@@ -56,6 +56,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         private
 
@@ -64,7 +65,7 @@ module RuboCop
           return if node.last_argument&.block_pass_type?
 
           if node.method?(:each) && !node.parent&.block_type?
-            ancestor_node = node.each_ancestor(:send).detect do |ancestor|
+            ancestor_node = node.each_ancestor(:call).detect do |ancestor|
               ancestor.receiver == node &&
                 (RESTRICT_ON_SEND.include?(ancestor.method_name) || ancestor.method?(:reverse_each))
             end
@@ -83,10 +84,12 @@ module RuboCop
         # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         def range(node)
-          if node.method?(:each)
-            node.loc.dot.join(node.loc.selector)
+          return node.selector unless node.method?(:each)
+
+          if node.parent&.call_type?
+            node.selector.join(node.parent.loc.dot)
           else
-            node.loc.selector
+            node.loc.dot.join(node.selector)
           end
         end
 

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

@@ -3,19 +3,23 @@
 module RuboCop
   module Cop
     module Style
-      # Checks for RuntimeError as the argument of raise/fail.
-      #
-      # It checks for code like this:
+      # Checks for `RuntimeError` as the argument of `raise`/`fail`.
       #
       # @example
-      #   # Bad
+      #   # bad
       #   raise RuntimeError, 'message'
-      #
-      #   # Bad
       #   raise RuntimeError.new('message')
       #
-      #   # Good
+      #   # good
       #   raise 'message'
+      #
+      #   # bad - message is not a string
+      #   raise RuntimeError, Object.new
+      #   raise RuntimeError.new(Object.new)
+      #
+      #   # good
+      #   raise Object.new.to_s
+      #
       class RedundantException < Base
         extend AutoCorrector
 
@@ -30,26 +34,42 @@ module RuboCop
           fix_exploded(node) || fix_compact(node)
         end
 
+        private
+
         def fix_exploded(node)
           exploded?(node) do |command, message|
             add_offense(node, message: MSG_1) do |corrector|
-              if node.parenthesized?
-                corrector.replace(node, "#{command}(#{message.source})")
-              else
-                corrector.replace(node, "#{command} #{message.source}")
-              end
+              corrector.replace(node, replaced_exploded(node, command, message))
             end
           end
         end
 
+        def replaced_exploded(node, command, message)
+          arg = string_message?(message) ? message.source : "#{message.source}.to_s"
+          arg = node.parenthesized? ? "(#{arg})" : " #{arg}"
+          "#{command}#{arg}"
+        end
+
+        def string_message?(message)
+          message.type?(:str, :dstr, :xstr)
+        end
+
         def fix_compact(node)
           compact?(node) do |new_call, message|
             add_offense(node, message: MSG_2) do |corrector|
-              corrector.replace(new_call, message.source)
+              corrector.replace(new_call, replaced_compact(message))
             end
           end
         end
 
+        def replaced_compact(message)
+          if string_message?(message)
+            message.source
+          else
+            "#{message.source}.to_s"
+          end
+        end
+
         # @!method exploded?(node)
         def_node_matcher :exploded?, <<~PATTERN
           (send nil? ${:raise :fail} (const {nil? cbase} :RuntimeError) $_)

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

@@ -3,11 +3,13 @@
 module RuboCop
   module Cop
     module Style
-      # Identifies places where `fetch(key) { value }`
-      # can be replaced by `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
-      # than `fetch(key) { value }`.
+      # In such cases `fetch(key, value)` method is faster than `fetch(key) { value }`.
+      #
+      # NOTE: The block string `'value'` in `hash.fetch(:key) { 'value' }` is detected
+      # when frozen string literal magic comment is enabled (i.e. `# frozen_string_literal: true`),
+      # but not when disabled.
       #
       # @safety
       #   This cop is unsafe because it cannot be guaranteed that the receiver
@@ -45,9 +47,9 @@ module RuboCop
         # @!method redundant_fetch_block_candidate?(node)
         def_node_matcher :redundant_fetch_block_candidate?, <<~PATTERN
           (block
-            $(send _ :fetch _)
+            $(call _ :fetch _)
             (args)
-            ${nil? #basic_literal? #const_type?})
+            ${nil? basic_literal? const_type?})
         PATTERN
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
@@ -59,24 +61,16 @@ module RuboCop
             bad = build_bad_method(send, body)
 
             add_offense(range, message: format(MSG, good: good, bad: bad)) do |corrector|
-              receiver, _, key = send.children
+              _, _, key = send.children
               default_value = body ? body.source : 'nil'
 
-              corrector.replace(node, "#{receiver.source}.fetch(#{key.source}, #{default_value})")
+              corrector.replace(range, "fetch(#{key.source}, #{default_value})")
             end
           end
         end
 
         private
 
-        def basic_literal?(node)
-          node&.basic_literal?
-        end
-
-        def const_type?(node)
-          node&.const_type?
-        end
-
         def should_not_check?(send, body)
           (body&.const_type? && !check_for_constant?) ||
             (body&.str_type? && !check_for_string?) ||

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

@@ -6,7 +6,7 @@ module RuboCop
       # 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',
+      # NOTE: If the extension is omitted, Ruby tries adding '.rb', '.so',
       #       and so on to the name until found. If the file named cannot be found,
       #       a `LoadError` will be raised.
       #       There is an edge case where `foo.so` file is loaded instead of a `LoadError`

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Identifies usages of `any?`, `empty?` or `none?` predicate methods
+      # chained to `select`/`filter`/`find_all` and change them to use predicate method instead.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because `array.select.any?` evaluates all elements
+      #   through the `select` method, while `array.any?` uses short-circuit evaluation.
+      #   In other words, `array.select.any?` guarantees the evaluation of every element,
+      #   but `array.any?` does not necessarily evaluate all of them.
+      #
+      # @example
+      #   # bad
+      #   arr.select { |x| x > 1 }.any?
+      #
+      #   # good
+      #   arr.any? { |x| x > 1 }
+      #
+      #   # bad
+      #   arr.select { |x| x > 1 }.empty?
+      #   arr.select { |x| x > 1 }.none?
+      #
+      #   # good
+      #   arr.none? { |x| x > 1 }
+      #
+      #   # good
+      #   relation.select(:name).any?
+      #   arr.select { |x| x > 1 }.any?(&:odd?)
+      #
+      # @example AllCops:ActiveSupportExtensionsEnabled: false (default)
+      #   # good
+      #   arr.select { |x| x > 1 }.many?
+      #
+      #   # good
+      #   arr.select { |x| x > 1 }.present?
+      #
+      # @example AllCops:ActiveSupportExtensionsEnabled: true
+      #   # bad
+      #   arr.select { |x| x > 1 }.many?
+      #
+      #   # good
+      #   arr.many? { |x| x > 1 }
+      #
+      #   # bad
+      #   arr.select { |x| x > 1 }.present?
+      #
+      #   # good
+      #   arr.any? { |x| x > 1 }
+      #
+      class RedundantFilterChain < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<prefer>s` instead of `%<first_method>s.%<second_method>s`.'
+
+        RAILS_METHODS = %i[many? present?].freeze
+        RESTRICT_ON_SEND = (%i[any? empty? none? one?] + RAILS_METHODS).freeze
+
+        # @!method select_predicate?(node)
+        def_node_matcher :select_predicate?, <<~PATTERN
+          (call
+            {
+              (block $(call _ {:select :filter :find_all}) ...)
+              $(call _ {:select :filter :find_all} block_pass_type?)
+            }
+            ${:#{RESTRICT_ON_SEND.join(' :')}})
+        PATTERN
+
+        REPLACEMENT_METHODS = {
+          any?: :any?,
+          empty?: :none?,
+          none?: :none?,
+          one?: :one?,
+          many?: :many?,
+          present?: :any?
+        }.freeze
+        private_constant :REPLACEMENT_METHODS
+
+        def on_send(node)
+          return if node.arguments? || node.block_literal?
+
+          select_predicate?(node) do |select_node, filter_method|
+            return if RAILS_METHODS.include?(filter_method) && !active_support_extensions_enabled?
+
+            register_offense(select_node, node)
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def register_offense(select_node, predicate_node)
+          replacement = REPLACEMENT_METHODS[predicate_node.method_name]
+          message = format(MSG, prefer: replacement,
+                                first_method: select_node.method_name,
+                                second_method: predicate_node.method_name)
+
+          offense_range = offense_range(select_node, predicate_node)
+
+          add_offense(offense_range, message: message) do |corrector|
+            corrector.remove(predicate_range(predicate_node))
+            corrector.replace(select_node.loc.selector, replacement)
+          end
+        end
+
+        def offense_range(select_node, predicate_node)
+          select_node.loc.selector.join(predicate_node.loc.selector)
+        end
+
+        def predicate_range(predicate_node)
+          predicate_node.receiver.source_range.end.join(predicate_node.loc.selector)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for calls to `Kernel#format` or `Kernel#sprintf` that are redundant.
+      #
+      # Calling `format` with only a single string or constant argument is redundant,
+      # as it can be replaced by the string or constant itself.
+      #
+      # Also looks for `format` calls where the arguments are literals that can be
+      # inlined into a string easily. This applies to the `%s`, `%d`, `%i`, `%u`, and
+      # `%f` format specifiers.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because string object returned by
+      #   `format` and `sprintf` are never frozen. If `format('string')` is autocorrected to
+      #   `'string'`, `FrozenError` may occur when calling a destructive method like `String#<<`.
+      #   Consider using `'string'.dup` instead of `format('string')`.
+      #   Additionally, since the necessity of `dup` cannot be determined automatically,
+      #   this autocorrection is inherently unsafe.
+      #
+      #   [source,ruby]
+      #   ----
+      #   # frozen_string_literal: true
+      #
+      #   format('template').frozen? # => false
+      #   'template'.frozen?         # => true
+      #   ----
+      #
+      # @example
+      #
+      #   # bad
+      #   format('the quick brown fox jumps over the lazy dog.')
+      #   sprintf('the quick brown fox jumps over the lazy dog.')
+      #
+      #   # good
+      #   'the quick brown fox jumps over the lazy dog.'
+      #
+      #   # bad
+      #   format(MESSAGE)
+      #   sprintf(MESSAGE)
+      #
+      #   # good
+      #   MESSAGE
+      #
+      #   # bad
+      #   format('%s %s', 'foo', 'bar')
+      #   sprintf('%s %s', 'foo', 'bar')
+      #
+      #   # good
+      #   'foo bar'
+      #
+      class RedundantFormat < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<prefer>s` directly instead of `%<method_name>s`.'
+
+        RESTRICT_ON_SEND = %i[format sprintf].to_set.freeze
+        ACCEPTABLE_LITERAL_TYPES = %i[str dstr sym dsym numeric boolean nil].freeze
+
+        # @!method format_without_additional_args?(node)
+        def_node_matcher :format_without_additional_args?, <<~PATTERN
+          (send {(const {nil? cbase} :Kernel) nil?} %RESTRICT_ON_SEND ${str dstr const})
+        PATTERN
+
+        # @!method rational_number?(node)
+        def_node_matcher :rational_number?, <<~PATTERN
+          {rational (send int :/ rational) (begin rational) (begin (send int :/ rational))}
+        PATTERN
+
+        # @!method complex_number?(node)
+        def_node_matcher :complex_number?, <<~PATTERN
+          {complex (send int :+ complex) (begin complex) (begin (send int :+ complex))}
+        PATTERN
+
+        # @!method find_hash_value_node(node, name)
+        def_node_search  :find_hash_value_node, <<~PATTERN
+          (pair (sym %1) $_)
+        PATTERN
+
+        # @!method splatted_arguments?(node)
+        def_node_matcher :splatted_arguments?, <<~PATTERN
+          (send _ %RESTRICT_ON_SEND <{
+            splat
+            (hash <kwsplat ...>)
+          } ...>)
+        PATTERN
+
+        def on_send(node)
+          format_without_additional_args?(node) do |value|
+            replacement = value.source
+
+            add_offense(node, message: message(node, replacement)) do |corrector|
+              corrector.replace(node, replacement)
+            end
+            return
+          end
+
+          detect_unnecessary_fields(node)
+        end
+
+        private
+
+        def message(node, prefer)
+          format(MSG, prefer: prefer, method_name: node.method_name)
+        end
+
+        def detect_unnecessary_fields(node)
+          return unless node.first_argument&.str_type?
+
+          string = node.first_argument.value
+          arguments = node.arguments[1..]
+
+          return unless string && arguments.any?
+          return if splatted_arguments?(node)
+
+          register_all_fields_literal(node, string, arguments)
+        end
+
+        def register_all_fields_literal(node, string, arguments)
+          return unless all_fields_literal?(string, arguments.dup)
+
+          format_arguments = argument_values(arguments)
+          begin
+            formatted_string = format(string, *format_arguments)
+          rescue ArgumentError
+            return
+          end
+          replacement = quote(formatted_string, node)
+
+          add_offense(node, message: message(node, replacement)) do |corrector|
+            corrector.replace(node, replacement)
+          end
+        end
+
+        def all_fields_literal?(string, arguments)
+          count = 0
+          sequences = RuboCop::Cop::Utils::FormatString.new(string).format_sequences
+          return false unless sequences.any?
+
+          sequences.each do |sequence|
+            next if sequence.percent?
+
+            hash = arguments.detect(&:hash_type?)
+            next unless (argument = find_argument(sequence, arguments, hash))
+            next unless matching_argument?(sequence, argument)
+
+            count += 1
+          end
+
+          sequences.size == count
+        end
+
+        def find_argument(sequence, arguments, hash)
+          if hash && (sequence.annotated? || sequence.template?)
+            find_hash_value_node(hash, sequence.name.to_sym).first
+          elsif sequence.arg_number
+            arguments[sequence.arg_number.to_i - 1]
+          else
+            # If the specifier contains `*`, the following arguments will be used
+            # to specify the width and can be ignored.
+            (sequence.arity - 1).times { arguments.shift }
+            arguments.shift
+          end
+        end
+
+        def matching_argument?(sequence, argument)
+          # Template specifiers don't give a type, any acceptable literal type is ok.
+          return argument.type?(*ACCEPTABLE_LITERAL_TYPES) if sequence.template?
+
+          # An argument matches a specifier if it can be easily converted
+          # to that type.
+          case sequence.type
+          when 's'
+            argument.type?(*ACCEPTABLE_LITERAL_TYPES)
+          when 'd', 'i', 'u'
+            integer?(argument)
+          when 'f'
+            float?(argument)
+          else
+            false
+          end
+        end
+
+        def numeric?(argument)
+          argument.type?(:numeric, :str) ||
+            rational_number?(argument) ||
+            complex_number?(argument)
+        end
+
+        def integer?(argument)
+          numeric?(argument) && Integer(argument_value(argument), exception: false)
+        end
+
+        def float?(argument)
+          numeric?(argument) && Float(argument_value(argument), exception: false)
+        end
+
+        # Add correct quotes to the formatted string, preferring retaining the existing
+        # quotes if possible.
+        def quote(string, node)
+          str_node = node.first_argument
+          start_delimiter = str_node.loc.begin.source
+          end_delimiter = str_node.loc.end.source
+
+          # If there is any interpolation, the delimiters need to be changed potentially
+          if node.each_descendant(:dstr, :dsym).any?
+            case start_delimiter
+            when "'"
+              start_delimiter = end_delimiter = '"'
+            when /\A%q(.)/
+              start_delimiter = "%Q#{Regexp.last_match[1]}"
+            end
+          end
+
+          "#{start_delimiter}#{string}#{end_delimiter}"
+        end
+
+        def argument_values(arguments)
+          arguments.map { |argument| argument_value(argument) }
+        end
+
+        def argument_value(argument)
+          argument = argument.children.first if argument.begin_type?
+
+          if argument.dsym_type?
+            dsym_value(argument)
+          elsif argument.hash_type?
+            hash_value(argument)
+          elsif rational_number?(argument)
+            rational_value(argument)
+          elsif complex_number?(argument)
+            complex_value(argument)
+          elsif argument.respond_to?(:value)
+            argument.value
+          else
+            argument.source
+          end
+        end
+
+        def dsym_value(dsym_node)
+          dsym_node.children.first.source
+        end
+
+        def hash_value(hash_node)
+          hash_node.each_pair.with_object({}) do |pair, hash|
+            hash[pair.key.value] = argument_value(pair.value)
+          end
+        end
+
+        def rational_value(rational_node)
+          rational_node.source.to_r
+        end
+
+        def complex_value(complex_node)
+          Complex(complex_node.source)
+        end
+      end
+    end
+  end
+end