rubocop 1.79.2 → 1.87.0

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

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for manual counting patterns that can be replaced by `Enumerable#tally`.
+      #
+      # The cop detects the following patterns:
+      #
+      # - `each_with_object(Hash.new(0)) { |item, counts| counts[item] += 1 }`
+      # - `group_by(&:itself).transform_values(&:count)`
+      # - `group_by { |x| x }.transform_values(&:size)`
+      # - `group_by { |x| x }.transform_values { |v| v.length }`
+      #
+      # @safety
+      #   This cop is unsafe because it cannot guarantee that the receiver
+      #   is an `Enumerable` by static analysis, so the correction may
+      #   not be actually equivalent.
+      #
+      # @example
+      #   # bad
+      #   array.each_with_object(Hash.new(0)) { |item, counts| counts[item] += 1 }
+      #
+      #   # bad
+      #   array.group_by(&:itself).transform_values(&:count)
+      #
+      #   # bad
+      #   array.group_by { |item| item }.transform_values(&:size)
+      #
+      #   # bad
+      #   array.group_by { |item| item }.transform_values { |v| v.length }
+      #
+      #   # good
+      #   array.tally
+      #
+      class TallyMethod < Base
+        extend AutoCorrector
+        extend TargetRubyVersion
+        include RangeHelp
+
+        minimum_target_ruby_version 2.7
+
+        MSG_EACH_WITH_OBJECT = 'Use `tally` instead of `each_with_object`.'
+        MSG_GROUP_BY = 'Use `tally` instead of `group_by` and `transform_values`.'
+        RESTRICT_ON_SEND = %i[each_with_object transform_values].freeze
+        COUNTING_METHODS = %i[count size length].to_set.freeze
+
+        # Pattern 1: collection.each_with_object(Hash.new(0)) { |elem, hash| hash[elem] += 1 }
+        # @!method tally_each_with_object?(node)
+        def_node_matcher :tally_each_with_object?, <<~PATTERN
+          {
+            (block
+              (call _ :each_with_object
+                (send (const {nil? cbase} :Hash) :new (int 0)))
+              (args (arg _elem) (arg _hash))
+              (op_asgn
+                (send (lvar _hash) :[] (lvar _elem)) :+ (int 1)))
+            (numblock
+              (call _ :each_with_object
+                (send (const {nil? cbase} :Hash) :new (int 0)))
+              2
+              (op_asgn
+                (send (lvar :_2) :[] (lvar :_1)) :+ (int 1)))
+          }
+        PATTERN
+
+        # Pattern 2: collection.group_by(&:itself).transform_values(&:count/size/length)
+        # @!method tally_group_by_symbol?(node)
+        def_node_matcher :tally_group_by_symbol?, <<~PATTERN
+          (call
+            (call _ :group_by (block_pass (sym :itself)))
+            :transform_values
+            (block_pass (sym %COUNTING_METHODS)))
+        PATTERN
+
+        # Pattern 3: collection.group_by { |x| x }.transform_values(&:count/size/length)
+        # @!method tally_group_by_identity_block?(node)
+        def_node_matcher :tally_group_by_identity_block?, <<~PATTERN
+          (call
+            {
+              (block (call _ :group_by) (args (arg _x)) (lvar _x))
+              (numblock (call _ :group_by) 1 (lvar :_1))
+              (itblock (call _ :group_by) :it (lvar :it))
+            }
+            :transform_values
+            (block_pass (sym %COUNTING_METHODS)))
+        PATTERN
+
+        # Pattern 4: collection.group_by(&:itself).transform_values { |v| v.count/size/length }
+        #            collection.group_by { |x| x }.transform_values { |v| v.count/size/length }
+        # @!method tally_group_by_transform_block?(node)
+        def_node_matcher :tally_group_by_transform_block?, <<~PATTERN
+          {
+            (block
+              (call
+                {
+                  (call _ :group_by (block_pass (sym :itself)))
+                  (block (call _ :group_by) (args (arg _x)) (lvar _x))
+                  (numblock (call _ :group_by) 1 (lvar :_1))
+                  (itblock (call _ :group_by) :it (lvar :it))
+                }
+                :transform_values)
+              (args (arg _v))
+              (send (lvar _v) %COUNTING_METHODS))
+            (numblock
+              (call
+                {
+                  (call _ :group_by (block_pass (sym :itself)))
+                  (block (call _ :group_by) (args (arg _x)) (lvar _x))
+                  (numblock (call _ :group_by) 1 (lvar :_1))
+                  (itblock (call _ :group_by) :it (lvar :it))
+                }
+                :transform_values)
+              1
+              (send (lvar :_1) %COUNTING_METHODS))
+            (itblock
+              (call
+                {
+                  (call _ :group_by (block_pass (sym :itself)))
+                  (block (call _ :group_by) (args (arg _x)) (lvar _x))
+                  (numblock (call _ :group_by) 1 (lvar :_1))
+                  (itblock (call _ :group_by) :it (lvar :it))
+                }
+                :transform_values)
+              :it
+              (send (lvar :it) %COUNTING_METHODS))
+          }
+        PATTERN
+        def on_send(node)
+          if node.method?(:each_with_object)
+            check_each_with_object(node)
+          elsif node.method?(:transform_values)
+            check_transform_values(node)
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def check_each_with_object(node)
+          block_node = node.block_node
+          return unless block_node
+          return unless tally_each_with_object?(block_node)
+
+          add_offense(node.loc.selector, message: MSG_EACH_WITH_OBJECT) do |corrector|
+            corrector.replace(replacement_range(node, block_node), 'tally')
+          end
+        end
+
+        def check_transform_values(node)
+          if tally_group_by_symbol?(node) || tally_group_by_identity_block?(node)
+            register_group_by_offense(node, node)
+          elsif (block_node = node.block_node) && tally_group_by_transform_block?(block_node)
+            register_group_by_offense(node, block_node)
+          end
+        end
+
+        def register_group_by_offense(transform_node, end_node)
+          group_by_node = group_by_send_node(transform_node)
+
+          add_offense(group_by_node.loc.selector, message: MSG_GROUP_BY) do |corrector|
+            corrector.replace(replacement_range(group_by_node, end_node), 'tally')
+          end
+        end
+
+        def group_by_send_node(transform_node)
+          receiver = transform_node.receiver
+          if receiver.type?(:any_block)
+            receiver.send_node
+          else
+            receiver
+          end
+        end
+
+        def replacement_range(start_node, end_node)
+          range_between(start_node.loc.selector.begin_pos, end_node.source_range.end_pos)
+        end
+      end
+    end
+  end
+end

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

@@ -3,11 +3,11 @@
 module RuboCop
   module Cop
     module Style
-      # Newcomers to ruby applications may write top-level methods,
+      # Newcomers to Ruby applications may write top-level methods,
       # when ideally they should be organized in appropriate classes or modules.
       # This cop looks for definitions of top-level methods and warns about them.
       #
-      # However for ruby scripts it is perfectly fine to use top-level methods.
+      # However, for Ruby scripts it is perfectly fine to use top-level methods.
       # Hence this cop is disabled by default.
       #
       # @example

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

@@ -10,6 +10,9 @@ module RuboCop
       # for all parenthesized multi-line method calls with arguments.
       # * `comma`: Requires a comma after the last argument, but only for
       # parenthesized method calls where each argument is on its own line.
+      # * `diff_comma`: Requires a comma after the last argument, but only
+      # when that argument is followed by an immediate newline, even if
+      # there is an inline comment on the same line.
       # * `no_comma`: Requires that there is no comma after the last
       # argument.
       #
@@ -75,6 +78,48 @@ module RuboCop
       #     2,
       #   )
       #
+      # @example EnforcedStyleForMultiline: diff_comma
+      #   # bad
+      #   method(1, 2,)
+      #
+      #   # good
+      #   method(1, 2)
+      #
+      #   # good
+      #   method(
+      #     1, 2,
+      #     3,
+      #   )
+      #
+      #   # good
+      #   method(
+      #     1, 2, 3,
+      #   )
+      #
+      #   # good
+      #   method(
+      #     1,
+      #     2,
+      #   )
+      #
+      #   # bad
+      #   method(1, [
+      #     2,
+      #   ],)
+      #
+      #   # good
+      #   method(1, [
+      #     2,
+      #   ])
+      #
+      #   # bad
+      #   object[1, 2,
+      #          3, 4,]
+      #
+      #   # good
+      #   object[1, 2,
+      #          3, 4]
+      #
       # @example EnforcedStyleForMultiline: no_comma (default)
       #   # bad
       #   method(1, 2,)

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

@@ -64,7 +64,7 @@ module RuboCop
 
         MSG = 'Useless trailing comma present in block arguments.'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           # lambda literal (`->`) never has block arguments.
           return if node.send_node.lambda_literal?
           return unless useless_trailing_comma?(node)

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

@@ -45,6 +45,7 @@ module RuboCop
             corrector.insert_before(node.loc.end, "\n#{' ' * node.loc.keyword.column}")
           end
         end
+        alias on_defs on_def
 
         private
 

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

@@ -7,26 +7,26 @@ module RuboCop
       #
       # @example
       #   # bad
-      #   a, b, _ = foo()
-      #   a, b, _, = foo()
-      #   a, _, _ = foo()
-      #   a, _, _, = foo()
+      #   a, b, _ = foo
+      #   a, b, _, = foo
+      #   a, _, _ = foo
+      #   a, _, _, = foo
       #
       #   # good
-      #   a, b, = foo()
-      #   a, = foo()
-      #   *a, b, _ = foo()
+      #   a, b, = foo
+      #   a, = foo
+      #   *a, b, _ = foo
       #   # => We need to know to not include 2 variables in a
-      #   a, *b, _ = foo()
-      #   # => The correction `a, *b, = foo()` is a syntax error
+      #   a, *b, _ = foo
+      #   # => The correction `a, *b, = foo` is a syntax error
       #
       # @example AllowNamedUnderscoreVariables: true (default)
       #   # good
-      #   a, b, _something = foo()
+      #   a, b, _something = foo
       #
       # @example AllowNamedUnderscoreVariables: false
       #   # bad
-      #   a, b, _something = foo()
+      #   a, b, _something = foo
       #
       class TrailingUnderscoreVariable < Base
         include SurroundingSpace

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

@@ -20,7 +20,6 @@ module RuboCop
       #     # do a different thing...
       #   end
       class UnlessElse < Base
-        include RangeHelp
         extend AutoCorrector
 
         MSG = 'Do not use `unless` with `else`. Rewrite these with the positive case first.'
@@ -29,25 +28,27 @@ module RuboCop
           return unless node.unless? && node.else?
 
           add_offense(node) do |corrector|
-            body_range = range_between_condition_and_else(node, node.condition)
-            else_range = range_between_else_and_end(node)
-
             next if part_of_ignored_node?(node)
 
             corrector.replace(node.loc.keyword, 'if')
-            corrector.replace(body_range, else_range.source)
-            corrector.replace(else_range, body_range.source)
+
+            body_range = range_between_condition_and_else(node)
+            else_range = range_between_else_and_end(node)
+
+            corrector.swap(body_range, else_range)
           end
 
           ignore_node(node)
         end
 
-        def range_between_condition_and_else(node, condition)
-          range_between(condition.source_range.end_pos, node.loc.else.begin_pos)
+        def range_between_condition_and_else(node)
+          range = node.loc.begin ? node.loc.begin.end : node.condition.source_range
+
+          range.end.join(node.loc.else.begin)
         end
 
         def range_between_else_and_end(node)
-          range_between(node.loc.else.end_pos, node.loc.end.begin_pos)
+          node.loc.else.end.join(node.loc.end.begin)
         end
       end
     end

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

@@ -14,11 +14,11 @@ module RuboCop
       #
       # `forbid_mixed_logical_operators` style forbids the use of more than one type
       # of logical operators. This makes the `unless` condition easier to read
-      # because either all conditions need to be met or any condition need to be met
+      # because either all conditions need to be met or any condition needs to be met
       # in order for the expression to be truthy or falsey.
       #
-      # `forbid_logical_operators` style forbids any use of logical operator.
-      # This makes it even more easy to read the `unless` condition as
+      # `forbid_logical_operators` style forbids any use of logical operators.
+      # This makes it even easier to read the `unless` condition as
       # there is only one condition in the expression.
       #
       # @example EnforcedStyle: forbid_mixed_logical_operators (default)

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

@@ -16,6 +16,11 @@ module RuboCop
       #   # good
       #   x += 1 while x < 10
       #
+      #   # good
+      #   while x < 10
+      #     y += 1 if x.odd?
+      #   end
+      #
       #   # bad
       #   until x > 10
       #     x += 1
@@ -24,6 +29,11 @@ module RuboCop
       #   # good
       #   x += 1 until x > 10
       #
+      #   # good
+      #   until x > 10
+      #     y += 1 unless x.even?
+      #   end
+      #
       #   # bad
       #   x += 100 while x < 500 # a long comment that makes code too long if it were a single line
       #
@@ -45,6 +55,12 @@ module RuboCop
           end
         end
         alias on_until on_while
+
+        private
+
+        def non_eligible_body?(body)
+          body&.conditional? || super
+        end
       end
     end
   end

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

@@ -147,7 +147,7 @@ module RuboCop
         end
 
         def constant_portion?(node)
-          node.literal? || node.const_type?
+          node.recursive_literal? || node.const_type?
         end
 
         def actual_code_range(node)

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

@@ -76,7 +76,7 @@ module RuboCop
         end
 
         def supported_operators
-          Array(cop_config['SupportedOperators'])
+          @supported_operators ||= Array(cop_config['SupportedOperators']).freeze
         end
 
         def offended_ancestor?(node)

data/lib/rubocop/cop/team.rb

@@ -11,6 +11,9 @@ module RuboCop
     # (unless autocorrections happened).
     # rubocop:disable Metrics/ClassLength
     class Team
+      InvestigationResult = Struct.new(:report, :corrector)
+      private_constant :InvestigationResult
+
       # @return [Team]
       def self.new(cop_or_classes, config, options = {})
         # Support v0 api:
@@ -89,31 +92,25 @@ module RuboCop
 
       # @return [Commissioner::InvestigationReport]
       def investigate(processed_source, offset: 0, original: processed_source)
-        be_ready
-
-        # The autocorrection process may have to be repeated multiple times
-        # until there are no corrections left to perform
-        # To speed things up, run autocorrecting cops by themselves, and only
-        # run the other cops when no corrections are left
-        on_duty = roundup_relevant_cops(processed_source)
+        result = investigate_with_corrector(processed_source, offset: offset, original: original)
+        autocorrect(processed_source, result.corrector)
+        result.report
+      end
 
-        autocorrect_cops, other_cops = on_duty.partition(&:autocorrect?)
-        report = investigate_partial(autocorrect_cops, processed_source,
-                                     offset: offset, original: original)
+      # @return [Array<Offense>]
+      def investigate_fragments(fragments, original:)
+        @updated_source_file = false
 
-        unless autocorrect(processed_source, report, offset: offset, original: original)
-          # If we corrected some errors, another round of inspection will be
-          # done, and any other offenses will be caught then, so only need
-          # to check other_cops if no correction was done
-          report = report.merge(investigate_partial(other_cops, processed_source,
-                                                    offset: offset, original: original))
-        end
+        offenses, errors, warnings, corrector =
+          fragments.each_with_object([[], [], [], nil]) do |fragment, data|
+            investigate_fragment(fragment, original, data)
+          end
 
-        process_errors(processed_source.path, report.errors)
+        autocorrect(original, corrector)
+        @errors = errors
+        @warnings = warnings
 
-        report
-      ensure
-        @ready = false
+        offenses
       end
 
       # @deprecated
@@ -136,14 +133,13 @@ module RuboCop
 
       private
 
-      def autocorrect(processed_source, report, original:, offset:)
+      def autocorrect(processed_source, corrector)
         @updated_source_file = false
         return unless autocorrect?
-        return if report.processed_source.parser_error
-
-        new_source = autocorrect_report(report, original: original, offset: offset)
+        return unless corrector
+        return if corrector.empty?
 
-        return unless new_source
+        new_source = corrector.rewrite
 
         if @options[:stdin]
           # holds source read in from stdin, when --stdin option is used
@@ -174,11 +170,59 @@ module RuboCop
         commissioner.investigate(processed_source, offset: offset, original: original)
       end
 
+      def investigate_with_corrector(processed_source, offset:, original:)
+        be_ready
+
+        # The autocorrection process may have to be repeated multiple times
+        # until there are no corrections left to perform
+        # To speed things up, run autocorrecting cops by themselves, and only
+        # run the other cops when no corrections are left
+        on_duty = roundup_relevant_cops(processed_source)
+
+        autocorrect_cops, other_cops = on_duty.partition(&:autocorrect?)
+        report = investigate_partial(autocorrect_cops, processed_source,
+                                     offset: offset, original: original)
+
+        corrector = collated_corrector(report, offset: offset, original: original)
+
+        unless corrector
+          # If we corrected some errors, another round of inspection will be
+          # done, and any other offenses will be caught then, so only need
+          # to check other_cops if no correction was done
+          report = report.merge(investigate_partial(other_cops, processed_source,
+                                                    offset: offset, original: original))
+        end
+
+        process_errors(processed_source.path, report.errors)
+
+        InvestigationResult.new(report, corrector)
+      ensure
+        @ready = false
+      end
+
+      def investigate_fragment(fragment, original, data)
+        offenses, errors, warnings, corrector = data
+        result = investigate_with_corrector(
+          fragment[:processed_source],
+          offset: fragment[:offset],
+          original: original
+        )
+
+        offenses.concat(result.report.offenses)
+        if result.corrector
+          corrector ||= Corrector.new(original)
+          merge_corrector!(corrector, result.corrector, offset: 0)
+          data[3] = corrector
+        end
+        errors.concat(@errors)
+        warnings.concat(@warnings)
+      end
+
       # @return [Array<cop>]
       def roundup_relevant_cops(processed_source)
         cops.select do |cop|
-          next true if processed_source.comment_config.cop_opted_in?(cop)
           next false if cop.excluded_file?(processed_source.file_path)
+          next true if processed_source.comment_config.cop_opted_in?(cop)
           next false unless @registry.enabled?(cop, @config)
 
           support_target_ruby_version?(cop) && support_target_rails_version?(cop)
@@ -200,28 +244,35 @@ module RuboCop
         cop.class.support_target_rails_version?(cop.target_rails_version)
       end
 
-      def autocorrect_report(report, offset:, original:)
+      def collated_corrector(report, offset:, original:)
+        return unless autocorrect?
+        return if report.processed_source.parser_error
+
         corrector = collate_corrections(report, offset: offset, original: original)
 
-        corrector.rewrite unless corrector.empty?
+        corrector unless corrector.empty?
       end
 
       def collate_corrections(report, offset:, original:)
         corrector = Corrector.new(original)
 
         each_corrector(report) do |to_merge|
-          suppress_clobbering do
-            if offset.positive?
-              corrector.import!(to_merge, offset: offset)
-            else
-              corrector.merge!(to_merge)
-            end
-          end
+          merge_corrector!(corrector, to_merge, offset: offset)
         end
 
         corrector
       end
 
+      def merge_corrector!(corrector, to_merge, offset:)
+        suppress_clobbering do
+          if corrector.source_buffer == to_merge.source_buffer
+            corrector.merge!(to_merge)
+          else
+            corrector.import!(to_merge, offset: offset)
+          end
+        end
+      end
+
       def each_corrector(report)
         skips = Set.new
         report.cop_reports.each do |cop_report|

data/lib/rubocop/cop/util.rb

@@ -117,10 +117,9 @@ module RuboCop
       # with calls chained to the end of it.
       def first_part_of_call_chain(node)
         while node
-          case node.type
-          when :send
+          if node.call_type?
             node = node.receiver
-          when :block
+          elsif node.any_block_type?
             node = node.send_node
           else
             break

data/lib/rubocop/cop/utils/format_string.rb

@@ -71,6 +71,16 @@ module RuboCop
             name && @source.include?('{')
           end
 
+          def variable_width?
+            !!width&.start_with?('*')
+          end
+
+          def variable_width_argument_number
+            return unless variable_width?
+
+            width == '*' ? 1 : width.match(DIGIT_DOLLAR)['arg_number'].to_i
+          end
+
           # Number of arguments required for the format sequence
           def arity
             @source.scan('*').count + 1