rubocop 1.81.7 → 1.92.1

data/lib/rubocop/cop/team.rb

@@ -9,8 +9,11 @@ module RuboCop
     # For performance reasons, Team will first dispatch cops & forces in two groups,
     # first the ones needed for autocorrection (if any), then the rest
     # (unless autocorrections happened).
-    # rubocop:disable Metrics/ClassLength
+    # rubocop:disable-next 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:
@@ -26,8 +29,17 @@ module RuboCop
 
       # @return [Team] with cops assembled from the given `cop_classes`
       def self.mobilize(cop_classes, config, options = {})
-        cops = mobilize_cops(cop_classes, config, options)
-        new(cops, config, options)
+        if cop_classes.is_a?(Registry)
+          # Instantiate only the enabled cops so that disabled lazy-loaded cops are not loaded.
+          # The registry is kept on standby to mobilize a disabled cop when a comment directive
+          # opts it back in.
+          cops = cop_classes.enabled(config).map { |cop_class| cop_class.new(config, options) }
+          team = new(cops, config, options)
+          team.standby_registry = cop_classes
+          team
+        else
+          new(mobilize_cops(cop_classes, config, options), config, options)
+        end
       end
 
       # @return [Array<Cop::Base>]
@@ -56,12 +68,30 @@ module RuboCop
 
       attr_reader :errors, :warnings, :updated_source_file, :cops
 
+      # When set to true, the corrected source is not written back to the
+      # inspected file; it is exposed through `#updated_source` instead.
+      # @api private
+      attr_accessor :defer_corrections
+
+      # The corrected source of the last investigation, if corrections were
+      # made with `#defer_corrections` enabled.
+      # @api private
+      attr_reader :updated_source
+
+      # Registry used to mobilize cops that were not instantiated because they are disabled in
+      # the config, when a comment directive opts them back in for a file.
+      #
+      # @api private
+      attr_writer :standby_registry
+
       alias updated_source_file? updated_source_file
 
       def initialize(cops, config = nil, options = {})
         @cops = cops
         @config = config
         @options = options
+        @standby_registry = nil
+        @standby_cops = {}
         reset
         @ready = true
         @registry = Registry.new(cops, options.dup)
@@ -89,31 +119,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,23 +160,26 @@ module RuboCop
 
       private
 
-      def autocorrect(processed_source, report, original:, offset:)
+      def autocorrect(processed_source, corrector)
         @updated_source_file = false
+        @updated_source = nil
         return unless autocorrect?
-        return if report.processed_source.parser_error
+        return unless corrector
+        return if corrector.empty?
 
-        new_source = autocorrect_report(report, original: original, offset: offset)
-
-        return unless new_source
+        apply_correction(processed_source, corrector.rewrite)
+        @updated_source_file = true
+      end
 
+      def apply_correction(processed_source, new_source)
         if @options[:stdin]
           # holds source read in from stdin, when --stdin option is used
           @options[:stdin] = new_source
+        elsif defer_corrections
+          @updated_source = new_source
         else
-          filename = processed_source.file_path
-          File.write(filename, new_source)
+          RuboCop::Util.replace_file_contents(processed_source.file_path, new_source)
         end
-        @updated_source_file = true
       end
 
       def be_ready
@@ -160,6 +187,7 @@ module RuboCop
 
         reset
         @cops.map!(&:ready)
+        @standby_cops.transform_values! { |cop| cop&.ready }
         @ready = true
       end
 
@@ -174,17 +202,101 @@ 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 = partition_by_correcting(on_duty)
+        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>]
+      # A cop whose unsafe correction is skipped still inserts todo comments
+      # under `--disable-uncorrectable`, so it must run with the correcting
+      # cops - correctors of the later `other_cops` round are never applied.
+      def partition_by_correcting(cops)
+        cops.partition do |cop|
+          cop.autocorrect? || cop.skipped_unsafe_correction_with_disable_uncorrectable?
+        end
+      end
+
       def roundup_relevant_cops(processed_source)
-        cops.select do |cop|
-          next true if processed_source.comment_config.cop_opted_in?(cop)
+        (cops + opted_in_standby_cops(processed_source)).select do |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)
         end
       end
 
+      # Cops that were not mobilized because they are disabled in the config,
+      # but are opted back in for the given file by an `enable` comment directive.
+      # Their classes are loaded on demand.
+      #
+      # @return [Array<cop>]
+      def opted_in_standby_cops(processed_source)
+        return [] unless @standby_registry
+
+        opted_in_names = processed_source.comment_config.opt_in_cops
+        return [] if opted_in_names.empty?
+
+        @mobilized_cop_names ||= Set.new(cops.map(&:cop_name))
+        opted_in_names.filter_map do |cop_name|
+          next if @mobilized_cop_names.include?(cop_name)
+
+          standby_cop(cop_name)
+        end
+      end
+
+      def standby_cop(cop_name)
+        return @standby_cops[cop_name] if @standby_cops.key?(cop_name)
+
+        cop_class = @standby_registry.find_by_cop_name(cop_name)
+
+        @standby_cops[cop_name] = cop_class&.new(@config, @options)
+      end
+
       def support_target_ruby_version?(cop)
         return true unless cop.class.respond_to?(:support_target_ruby_version?)
 
@@ -200,43 +312,55 @@ 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
+        applied = []
         report.cop_reports.each do |cop_report|
-          cop = cop_report.cop
+          cop_class = cop_report.cop.class
           corrector = cop_report.corrector
 
           next if corrector.nil? || corrector.empty?
-          next if skips.include?(cop.class)
+          next if applied.any? { |other| autocorrect_incompatible?(cop_class, other) }
 
           yield corrector
 
-          skips.merge(cop.class.autocorrect_incompatible_with)
+          applied << cop_class
         end
       end
 
+      def autocorrect_incompatible?(cop_class, other)
+        cop_class.autocorrect_incompatible_with.include?(other) ||
+          other.autocorrect_incompatible_with.include?(cop_class)
+      end
+
       def suppress_clobbering
         yield
       rescue ::Parser::ClobberingError
@@ -285,6 +409,5 @@ module RuboCop
         end
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/rubocop/cop/util.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     # This module contains a collection of useful utility methods.
-    # rubocop:disable Metrics/ModuleLength
+    # rubocop:disable-next Metrics/ModuleLength
     module Util
       include PathUtil
 
@@ -35,7 +35,7 @@ module RuboCop
         node.loc_is?(:end, ')')
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:disable-next Metrics/AbcSize, Metrics/MethodLength
       def add_parentheses(node, corrector)
         if node.args_type?
           arguments_range = node.source_range
@@ -55,7 +55,6 @@ module RuboCop
           corrector.insert_after(args_end(node), ')')
         end
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       def any_descendant?(node, *types)
         if block_given?
@@ -64,7 +63,7 @@ module RuboCop
           end
         else
           # Use a block version to avoid allocating enumerators.
-          node.each_descendant do # rubocop:disable Lint/UnreachableLoop
+          node.each_descendant do # rubocop:disable Lint/UnreachableLoop -- the block form avoids allocating an enumerator
             return true
           end
         end
@@ -117,10 +116,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
@@ -211,6 +209,5 @@ module RuboCop
         source == target || (source.is_a?(Array) && source.include?(target))
       end
     end
-    # rubocop:enable Metrics/ModuleLength
   end
 end

data/lib/rubocop/cop/variable_force/assignment.rb

@@ -48,7 +48,7 @@ module RuboCop
         end
 
         def used?
-          (!reassigned? && @variable.captured_by_block?) || @referenced
+          (!reassigned? && @variable.captured_by_block? && @variable.referenced?) || @referenced
         end
 
         def regexp_named_capture?

data/lib/rubocop/cop/variable_force/branch.rb

@@ -254,8 +254,8 @@ module RuboCop
           end
         end
 
-        # Mix-in module for logical operator control structures.
-        module LogicalOperator
+        # Mix-in module for operator control structures.
+        module Operator
           def always_run?
             left_body?
           end
@@ -263,7 +263,15 @@ module RuboCop
 
         # left_body && right_body
         class And < Base
-          include LogicalOperator
+          include Operator
+
+          define_predicate :left_body?,  child_index: 0
+          define_predicate :right_body?, child_index: 1
+        end
+
+        # left_body &&= right_body
+        class AndAsgn < Base
+          include Operator
 
           define_predicate :left_body?,  child_index: 0
           define_predicate :right_body?, child_index: 1
@@ -271,7 +279,23 @@ module RuboCop
 
         # left_body || right_body
         class Or < Base
-          include LogicalOperator
+          include Operator
+
+          define_predicate :left_body?,  child_index: 0
+          define_predicate :right_body?, child_index: 1
+        end
+
+        # left_body ||= right_body
+        class OrAsgn < Base
+          include Operator
+
+          define_predicate :left_body?,  child_index: 0
+          define_predicate :right_body?, child_index: 1
+        end
+
+        # e.g. left_body += right_body
+        class OpAsgn < Base
+          include Operator
 
           define_predicate :left_body?,  child_index: 0
           define_predicate :right_body?, child_index: 1
@@ -322,8 +346,8 @@ module RuboCop
           end
         end
 
-        CLASSES_BY_TYPE = Base.classes.each_with_object({}) do |klass, classes|
-          classes[klass.type] = klass
+        CLASSES_BY_TYPE = Base.classes.to_h do |klass|
+          [klass.type, klass]
         end
       end
     end

data/lib/rubocop/cop/variable_force/variable.rb

@@ -47,7 +47,7 @@ module RuboCop
           !@references.empty?
         end
 
-        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:disable-next Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def reference!(node)
           reference = Reference.new(node, @scope)
           @references << reference
@@ -63,23 +63,47 @@ module RuboCop
             # if/unless keyword. A preceding assignment is needed to put the
             # variable in scope. For this reason we skip to the next assignment
             # here.
-            next if in_modifier_conditional?(assignment)
+            next if in_modifier_conditional?(assignment, node)
 
             break if !assignment.branch || assignment.branch == reference.branch
 
-            unless assignment.branch.may_run_incompletely?
+            unless assignment.branch.may_run_incompletely? ||
+                   exception_may_reach?(assignment.branch, node)
               (consumed_branches ||= Set.new) << assignment.branch
             end
           end
         end
-        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-        def in_modifier_conditional?(assignment)
-          parent = assignment.node.parent
-          parent = parent.parent if parent&.begin_type?
-          return false if parent.nil?
+        def in_modifier_conditional?(assignment, reference_node)
+          conditional = modifier_conditional_of(assignment.node)
+          return false unless conditional
 
-          parent.basic_conditional? && parent.modifier_form?
+          # The out-of-scope problem only affects a reference in the modifier body (to the
+          # left of the keyword); a reference after the modifier is put in scope by the
+          # condition's assignment, so an earlier assignment there is genuinely useless.
+          covers?(conditional, reference_node) && !covers?(conditional.condition, reference_node)
+        end
+
+        # A branch nested in the main body of `begin` can be cut short by an exception
+        # too. An earlier assignment in it is visible to a reference in the `rescue` or
+        # `ensure` clause, or after a `rescue` that handles the exception.
+        def exception_may_reach?(branch, reference_node)
+          branch.each_ancestor.any? do |ancestor|
+            next false unless ancestor.may_run_incompletely?
+            next false if covers?(ancestor.child_node, reference_node)
+
+            ancestor.control_node.rescue_type? || covers?(ancestor.control_node, reference_node)
+          end
+        end
+
+        def modifier_conditional_of(node)
+          node.each_ancestor(:if, :while, :until).find do |conditional|
+            conditional.modifier_form? && covers?(conditional.condition, node)
+          end
+        end
+
+        def covers?(container, node)
+          container.equal?(node) || container.source_range.contains?(node.source_range)
         end
 
         def capture_with_block!

data/lib/rubocop/cops_documentation_generator.rb

@@ -6,7 +6,7 @@ require 'yard'
 # Class for generating documentation of all cops departments
 # @api private
 class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
-  include ::RuboCop::Cop::Documentation
+  include RuboCop::Cop::Documentation
 
   CopData = Struct.new(
     :cop, :description, :example_objects, :safety_objects, :see_objects, :config, keyword_init: true
@@ -20,6 +20,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     safety:                ->(data) { safety_object(data.safety_objects, data.cop) },
     examples:              ->(data) { examples(data.example_objects, data.cop) },
     configuration:         ->(data) { configurations(data.cop.department, data.cop, data.config) },
+    preview:               ->(data) { preview_defaults(data.cop) },
     references:            ->(data) { references(data.cop, data.see_objects) }
   }.freeze
 
@@ -137,7 +138,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     "NOTE: Requires Ruby version #{requirement}\n\n"
   end
 
-  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable-next Metrics/MethodLength
   def properties(cop)
     header = [
       'Enabled by default', 'Safe', 'Supports autocorrection', 'Version Added',
@@ -160,7 +161,6 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     ]]
     "#{to_table(header, content)}\n"
   end
-  # rubocop:enable Metrics/MethodLength
 
   def cop_header(cop)
     content = +"\n"
@@ -195,7 +195,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   def configurations(department, cop, cop_config)
     header = ['Name', 'Default value', 'Configurable values']
     configs = cop_config.each_key.reject do |key|
-      key == 'AllowMultipleStyles' ||
+      key == 'AllowMultipleStyles' || key == 'Preview' ||
         (key != 'SupportedTypes' && key.start_with?('Supported'))
     end
     return '' if configs.empty?
@@ -210,6 +210,22 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     cop_subsection('Configurable attributes', cop) + to_table(header, content)
   end
 
+  def preview_defaults(cop)
+    cop_config = config.for_cop(cop)
+    preview = cop_config['Preview']
+    return '' unless preview.is_a?(Hash)
+
+    header = ['Name', 'Current default', 'Preview default']
+    content = preview.map do |name, value|
+      [name, format_table_value(cop_config[name]), format_table_value(value)]
+    end
+
+    cop_subsection('Preview defaults', cop) +
+      'These defaults apply under xref:versioning.adoc#preview[Preview] and are ' \
+      "expected to become the regular defaults in the next major release.\n\n" +
+      to_table(header, content)
+  end
+
   def configuration_name(department, name)
     return name unless name == 'AllowMultilineFinalElement'
 
@@ -217,7 +233,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     "xref:#{filename}#allowmultilinefinalelement[AllowMultilineFinalElement]"
   end
 
-  # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
+  # rubocop:disable-next Metrics/CyclomaticComplexity,Metrics/MethodLength
   def configurable_values(cop_config, name)
     case name
     when /^Enforced/
@@ -244,7 +260,6 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       end
     end
   end
-  # rubocop:enable Metrics/CyclomaticComplexity,Metrics/MethodLength
 
   def to_table(header, content)
     table = ['|===', "| #{header.join(' | ')}\n\n"].join("\n")
@@ -303,7 +318,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     "\ninclude::../partials/#{filename}[]\n"
   end
 
-  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable-next Metrics/MethodLength
   def print_cops_of_department(department)
     selected_cops = cops_of_department(department)
     content = +<<~HEADER
@@ -323,7 +338,6 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       file.write("#{content.strip}\n")
     end
   end
-  # rubocop:enable Metrics/MethodLength
 
   def print_cop_with_doc(cop) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
     cop_config = config.for_cop(cop)
@@ -392,7 +406,11 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   def cop_status(status)
     return 'Disabled' unless status
 
-    status == 'pending' ? 'Pending' : 'Enabled'
+    case status
+    when 'pending' then 'Pending'
+    when 'preview' then 'Preview'
+    else 'Enabled'
+    end
   end
 
   # HTML anchor are somewhat limited in what characters they can contain, just