rubocop 1.89.0 → 1.91.0

data/lib/rubocop/formatter/junit_formatter.rb

@@ -25,21 +25,21 @@ module RuboCop
         super
 
         @test_case_elements = []
+        @config_store = nil
 
         reset_count
       end
 
+      def file_started(_file, options)
+        @config_store = options[:config_store]
+      end
+
       def file_finished(file, offenses)
         @inspected_file_count += 1
+        @offense_count += offenses.count
 
-        # TODO: Returns all cops with the same behavior as
-        # the original rubocop-junit-formatter.
-        # https://github.com/mikian/rubocop-junit-formatter/blob/v0.1.4/lib/rubocop/formatter/junit_formatter.rb#L9
-        #
-        # In the future, it would be preferable to return only enabled cops.
-        Cop::Registry.all.each do |cop|
+        cops_for(file).each do |cop|
           target_offenses = offenses_for_cop(offenses, cop)
-          @offense_count += target_offenses.count
 
           next unless relevant_for_output?(options, target_offenses)
 
@@ -47,7 +47,7 @@ module RuboCop
         end
       end
 
-      # rubocop:disable Layout/LineLength,Metrics/AbcSize,Metrics/MethodLength
+      # rubocop:disable-next Layout/LineLength,Metrics/AbcSize,Metrics/MethodLength -- the XML is emitted line by line
       def finished(_inspected_files)
         output.puts %(<?xml version='1.0'?>)
         output.puts %(<testsuites>)
@@ -70,10 +70,17 @@ module RuboCop
         output.puts %(  </testsuite>)
         output.puts %(</testsuites>)
       end
-      # rubocop:enable Layout/LineLength,Metrics/AbcSize,Metrics/MethodLength
 
       private
 
+      def cops_for(file)
+        # `file_started` is not called when this formatter is used directly through the API,
+        # in which case all cops are returned for compatibility.
+        return Cop::Registry.all if @config_store.nil?
+
+        registry.enabled(@config_store.for_file(file))
+      end
+
       def relevant_for_output?(options, target_offenses)
         !options[:display_only_failed] || target_offenses.any?
       end
@@ -91,6 +98,16 @@ module RuboCop
         end
       end
 
+      # Filtering by badge keeps lazy-loaded cops unloaded; `Registry#enabled` then loads only
+      # the enabled cops, the same set the runner mobilizes.
+      def registry
+        @registry ||= Cop::Registry.global.filter_by_badge(options) do |badge|
+          next false if badge.department == :Test || badge.match_name?(options[:except])
+
+          options[:only].nil? || badge.match_name?(options[:only])
+        end
+      end
+
       def classname_attribute_value(file)
         @classname_attribute_value_cache ||= Hash.new do |hash, key|
           hash[key] = key.delete_suffix('.rb').gsub("#{PathUtil.pwd}/", '').tr('/', '.')

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -52,7 +52,7 @@ module RuboCop
         report_summary(@offense_counts, @offending_files_count)
       end
 
-      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable-next Metrics/AbcSize
       def report_summary(offense_counts, offending_files_count)
         per_cop_counts = ordered_offense_counts(offense_counts)
         total_count = total_offense_count(offense_counts)
@@ -68,7 +68,6 @@ module RuboCop
 
         output.puts
       end
-      # rubocop:enable Metrics/AbcSize
 
       def ordered_offense_counts(offense_counts)
         offense_counts.sort_by { |k, v| [-v, k] }.to_h

data/lib/rubocop/formatter/sarif_formatter.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module RuboCop
+  module Formatter
+    # This formatter formats the report data in SARIF 2.1.0, the OASIS standard
+    # for static analysis results. It's understood by GitHub code scanning,
+    # Azure DevOps, and other tools that aggregate analyzer output.
+    #
+    # SARIF only knows three severity levels, so RuboCop's `info`, `refactor`
+    # and `convention` severities are all reported as `note`.
+    class SARIFFormatter < BaseFormatter
+      SCHEMA_URI = 'https://json.schemastore.org/sarif-2.1.0.json'
+      SARIF_VERSION = '2.1.0'
+      INFORMATION_URI = 'https://rubocop.org'
+
+      SEVERITY_LEVELS = {
+        info: 'note',
+        refactor: 'note',
+        convention: 'note',
+        warning: 'warning',
+        error: 'error',
+        fatal: 'error'
+      }.freeze
+
+      def initialize(output, options = {})
+        super
+
+        @rules = []
+        @rule_indexes = {}
+        @results = []
+        @config_store = nil
+      end
+
+      def file_started(_file, options)
+        @config_store = options[:config_store]
+      end
+
+      def file_finished(file, offenses)
+        offenses.each do |offense|
+          @results << result_for(file, offense)
+        end
+      end
+
+      def finished(_inspected_files)
+        output.write(report.to_json)
+      end
+
+      private
+
+      def report
+        {
+          '$schema': SCHEMA_URI,
+          version: SARIF_VERSION,
+          runs: [{ tool: { driver: driver }, results: @results }]
+        }
+      end
+
+      def driver
+        {
+          name: 'RuboCop',
+          version: RuboCop::Version::STRING,
+          semanticVersion: RuboCop::Version::STRING,
+          informationUri: INFORMATION_URI,
+          rules: @rules
+        }
+      end
+
+      def result_for(file, offense)
+        result = {
+          ruleId: offense.cop_name,
+          ruleIndex: rule_index_for(file, offense),
+          level: SEVERITY_LEVELS.fetch(offense.severity.name, 'warning'),
+          message: { text: offense.message },
+          locations: [location_for(file, offense)],
+          partialFingerprints: fingerprints_for(offense)
+        }
+
+        # Suppressed offenses are only reported under `--display-suppressed`.
+        # SARIF has a first-class representation for them, so consumers can
+        # tell them apart from offenses that were never triggered.
+        result[:suppressions] = [suppression_for(offense)] if offense.disabled?
+        result
+      end
+
+      # The URI is relative to the working directory, which is what consumers
+      # expect to resolve against their own checkout. No `uriBaseId`: it would
+      # have to be declared under `originalUriBaseIds` to mean anything, and
+      # every consumer that matters resolves relative paths without it.
+      def location_for(file, offense)
+        {
+          physicalLocation: {
+            artifactLocation: { uri: uri_for(file) },
+            region: region_for(offense)
+          }
+        }
+      end
+
+      def region_for(offense)
+        # SARIF columns are 1-based and `endColumn` points at the character
+        # *after* the region, while `real_last_column` is the last character.
+        {
+          startLine: offense.first_line,
+          startColumn: offense.real_column,
+          endLine: offense.last_line,
+          endColumn: offense.real_last_column + 1
+        }
+      end
+
+      # GitHub uses these to match an alert across runs. Without them it falls
+      # back to the file path, which makes alerts churn whenever a file moves.
+      def fingerprints_for(offense)
+        source_line = offense.location.source_line
+        { primaryLocationLineHash: Digest::SHA256.hexdigest("#{offense.cop_name}#{source_line}") }
+      end
+
+      def suppression_for(offense)
+        suppression = { kind: 'inSource' }
+        suppression[:justification] = offense.justification if offense.justification
+        suppression
+      end
+
+      def rule_index_for(file, offense)
+        @rule_indexes[offense.cop_name] ||= begin
+          @rules << rule_for(file, offense)
+          @rules.size - 1
+        end
+      end
+
+      def rule_for(file, offense)
+        cop_class = Cop::Registry.global.find_by_cop_name(offense.cop_name)
+        description = description_for(file, offense)
+        help_uri = cop_class && Cop::Documentation.url_for(cop_class, config_for(file))
+
+        rule = {
+          id: offense.cop_name,
+          name: offense.cop_name,
+          shortDescription: { text: description },
+          fullDescription: { text: description },
+          help: help_for(description, help_uri),
+          defaultConfiguration: { level: default_level_for(file, offense, cop_class) },
+          properties: { tags: [offense.cop_name.split('/').first] }
+        }
+        rule[:helpUri] = help_uri if help_uri
+        rule
+      end
+
+      def help_for(description, help_uri)
+        help = { text: description }
+        help[:markdown] = "#{description}\n\n[Documentation](#{help_uri})" if help_uri
+        help
+      end
+
+      def description_for(file, offense)
+        cop_config(file, offense)['Description'] || offense.cop_name
+      end
+
+      def default_level_for(file, offense, cop_class)
+        severity = cop_config(file, offense)['Severity'] ||
+                   (cop_class&.lint? ? :warning : :convention)
+
+        SEVERITY_LEVELS.fetch(severity.to_sym, 'warning')
+      end
+
+      def cop_config(file, offense)
+        config_for(file)&.for_cop(offense.cop_name) || {}
+      end
+
+      # `file_started` is not called when a formatter is used directly through
+      # the API, so there may be no config to consult.
+      def config_for(file)
+        @config_store&.for_file(file)
+      end
+
+      def uri_for(file)
+        PathUtil.smart_path(file).tr('\\', '/')
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -86,7 +86,9 @@ module RuboCop
 
       def message(offense)
         message =
-          if offense.corrected_with_todo?
+          if offense.disabled?
+            magenta('[Suppressed] ')
+          elsif offense.corrected_with_todo?
             green('[Todo] ')
           elsif offense.corrected?
             green('[Corrected] ')
@@ -104,7 +106,7 @@ module RuboCop
         include Colorizable
         include TextUtil
 
-        # rubocop:disable Metrics/ParameterLists
+        # rubocop:disable-next Metrics/ParameterLists
         def initialize(
           file_count, offense_count, correction_count, correctable_count, rainbow,
           safe_autocorrect: false
@@ -116,7 +118,6 @@ module RuboCop
           @rainbow = rainbow
           @safe_autocorrect = safe_autocorrect
         end
-        # rubocop:enable Metrics/ParameterLists
 
         def summary
           if @correction_count.positive?

data/lib/rubocop/formatter/tap_formatter.rb

@@ -68,7 +68,9 @@ module RuboCop
 
       def message(offense)
         message =
-          if offense.corrected_with_todo?
+          if offense.disabled?
+            '[Suppressed] '
+          elsif offense.corrected_with_todo?
             '[Todo] '
           elsif offense.corrected?
             '[Corrected] '

data/lib/rubocop/formatter/worst_offenders_formatter.rb

@@ -32,7 +32,7 @@ module RuboCop
         report_summary(@offense_counts)
       end
 
-      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable-next Metrics/AbcSize
       def report_summary(offense_counts)
         per_file_counts = ordered_offense_counts(offense_counts)
         total_count = total_offense_count(offense_counts)
@@ -50,7 +50,6 @@ module RuboCop
 
         output.puts
       end
-      # rubocop:enable Metrics/AbcSize
 
       def ordered_offense_counts(offense_counts)
         offense_counts.sort_by { |k, v| [-v, k] }.to_h

data/lib/rubocop/formatter.rb

@@ -24,6 +24,7 @@ module RuboCop
     autoload :PacmanFormatter, 'rubocop/formatter/pacman_formatter'
     autoload :ProgressFormatter, 'rubocop/formatter/progress_formatter'
     autoload :QuietFormatter, 'rubocop/formatter/quiet_formatter'
+    autoload :SARIFFormatter, 'rubocop/formatter/sarif_formatter'
     autoload :TapFormatter, 'rubocop/formatter/tap_formatter'
     autoload :WorstOffendersFormatter, 'rubocop/formatter/worst_offenders_formatter'
 

data/lib/rubocop/lockfile.rb

@@ -59,6 +59,18 @@ module RuboCop
       end
     end
 
+    # Names of gems sourced from a local path, i.e. `path:` dependencies and the
+    # project's own gem when the `Gemfile` uses `gemspec`. Git sources are not
+    # included: their code lives outside the project, like a released gem's.
+    # @return [Array<String>]
+    def path_sourced_gem_names
+      return [] unless parser
+
+      parser.specs.filter_map do |spec|
+        spec.name if path_source?(spec.source)
+      end
+    end
+
     # Whether this lockfile includes the named gem, directly or indirectly.
     # @param [String] name
     # @return [Boolean]
@@ -68,6 +80,12 @@ module RuboCop
 
     private
 
+    # `Bundler::Source::Git` is a subclass of `Bundler::Source::Path`, but a git
+    # source is a remote one.
+    def path_source?(source)
+      source.is_a?(::Bundler::Source::Path) && !source.is_a?(::Bundler::Source::Git)
+    end
+
     # @return [Bundler::LockfileParser, nil]
     def parser
       return @parser if defined?(@parser)

data/lib/rubocop/lsp/diagnostic.rb

@@ -35,7 +35,7 @@ module RuboCop
         code_actions
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:disable-next Metrics/AbcSize, Metrics/MethodLength
       def to_lsp_diagnostic(config)
         highlighted = @offense.highlighted_area
 
@@ -61,7 +61,6 @@ module RuboCop
           }
         )
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       private
 
@@ -82,7 +81,7 @@ module RuboCop
         LanguageServer::Protocol::Interface::CodeDescription.new(href: doc_url)
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def autocorrect_action
         LanguageServer::Protocol::Interface::CodeAction.new(
           title: "Autocorrect #{@offense.cop_name}",
@@ -101,9 +100,8 @@ module RuboCop
           is_preferred: true
         )
       end
-      # rubocop:enable Metrics/MethodLength
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def offense_replacements
         @offense.corrector.as_replacements.map do |range, replacement|
           LanguageServer::Protocol::Interface::TextEdit.new(
@@ -121,9 +119,8 @@ module RuboCop
           )
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def disable_line_action
         LanguageServer::Protocol::Interface::CodeAction.new(
           title: "Disable #{@offense.cop_name} for this line",
@@ -141,7 +138,6 @@ module RuboCop
           )
         )
       end
-      # rubocop:enable Metrics/MethodLength
 
       def line_disable_comment
         DisableCommentEdits.new(

data/lib/rubocop/lsp/routes.rb

@@ -151,25 +151,13 @@ module RuboCop
           return
         end
 
-        uri = request[:params][:arguments][0][:uri]
-        formatted = nil
-
-        # The `workspace/executeCommand` is an LSP method triggered by intentional user actions,
-        # so the user's intention for autocorrection is respected.
-        LSP.disable { formatted = format_file(uri, command: command) }
-
-        @server.write(
-          id: request[:id],
-          method: 'workspace/applyEdit',
-          params: {
-            label: label,
-            edit: {
-              changes: {
-                uri => formatted
-              }
-            }
-          }
-        )
+        # Clients such as Eglot can invoke a command without arguments, so respond with
+        # an error instead of letting the server crash on a missing URI.
+        if (uri = document_uri_from(request))
+          write_formatting_edits(request, uri: uri, command: command, label: label)
+        else
+          write_invalid_arguments_error(request, command)
+        end
       end
 
       handle 'textDocument/willSave' do |_request|
@@ -219,6 +207,47 @@ module RuboCop
         }
       end
 
+      def document_uri_from(request)
+        argument = request.dig(:params, :arguments, 0)
+
+        argument[:uri] if argument.is_a?(Hash)
+      end
+
+      def write_formatting_edits(request, uri:, command:, label:)
+        formatted = nil
+
+        # The `workspace/executeCommand` is an LSP method triggered by intentional user actions,
+        # so the user's intention for autocorrection is respected.
+        LSP.disable { formatted = format_file(uri, command: command) }
+
+        @server.write(
+          id: request[:id],
+          method: 'workspace/applyEdit',
+          params: {
+            label: label,
+            edit: {
+              changes: {
+                uri => formatted
+              }
+            }
+          }
+        )
+      end
+
+      def write_invalid_arguments_error(request, command)
+        message = "Missing document URI in arguments for #{command}"
+
+        @server.write(
+          id: request[:id],
+          error: LanguageServer::Protocol::Interface::ResponseError.new(
+            code: LanguageServer::Protocol::Constant::ErrorCodes::INVALID_PARAMS,
+            message: message
+          )
+        )
+
+        Logger.log(message)
+      end
+
       def format_file(file_uri, command: nil)
         unless (text = @text_cache[file_uri])
           Logger.log("Format request arrived before text synchronized; skipping: `#{file_uri}'")

data/lib/rubocop/magic_comment.rb

@@ -12,6 +12,7 @@ module RuboCop
       encoding: '(?:en)?coding',
       frozen_string_literal: 'frozen[_-]string[_-]literal',
       rbs_inline: 'rbs_inline',
+      warn_indent: 'warn[_-]indent',
       shareable_constant_value: 'shareable[_-]constant[_-]value',
       typed: 'typed'
     }.freeze
@@ -38,6 +39,7 @@ module RuboCop
       frozen_string_literal_specified? ||
         encoding_specified? ||
         rbs_inline_specified? ||
+        warn_indent_specified? ||
         shareable_constant_value_specified? ||
         typed_specified?
     end
@@ -77,6 +79,13 @@ module RuboCop
       specified?(frozen_string_literal)
     end
 
+    # Was a warn_indent specified?
+    #
+    # @return [Boolean]
+    def warn_indent_specified?
+      specified?(warn_indent)
+    end
+
     # Was a shareable_constant_value specified?
     #
     # @return [Boolean]
@@ -100,6 +109,13 @@ module RuboCop
       end
     end
 
+    # Expose the `warn_indent` value.
+    #
+    # @return [String] for warn_indent config
+    def warn_indent
+      extract_warn_indent
+    end
+
     # Expose the `shareable_constant_value` value coerced to a boolean if possible.
     #
     # @return [String] for shareable_constant_value config
@@ -216,6 +232,10 @@ module RuboCop
       # Emacs comments cannot specify RBS::inline behavior.
       def extract_rbs_inline_value; end
 
+      def extract_warn_indent
+        match(KEYWORDS[:warn_indent])
+      end
+
       def extract_shareable_constant_value
         match(KEYWORDS[:shareable_constant_value])
       end
@@ -258,6 +278,9 @@ module RuboCop
       # Vim comments cannot specify RBS::inline behavior.
       def extract_rbs_inline_value; end
 
+      # Vim comments cannot specify indentation warning behavior.
+      def warn_indent; end
+
       # Vim comments cannot specify shareable constant values behavior.
       def shareable_constant_value; end
 
@@ -316,6 +339,10 @@ module RuboCop
         extract(/\A\s*#\s*#{KEYWORDS[:rbs_inline]}:\s*#{TOKEN}\s*\z/io)
       end
 
+      def extract_warn_indent
+        extract(/\A\s*#\s*#{KEYWORDS[:warn_indent]}:\s*#{TOKEN}\s*\z/io)
+      end
+
       def extract_shareable_constant_value
         extract(/\A\s*#\s*#{KEYWORDS[:shareable_constant_value]}:\s*#{TOKEN}\s*\z/io)
       end

data/lib/rubocop/mcp/server.rb

@@ -156,7 +156,7 @@ module RuboCop
         summary
       end
 
-      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+      # rubocop:disable-next Metrics/MethodLength, Metrics/ParameterLists
       def build_tool(
         name:, description:,
         title:, destructive_hint:, idempotent_hint:, read_only_hint:, safety_required:
@@ -194,7 +194,6 @@ module RuboCop
           ::MCP::Tool::Response.new([{ type: 'text', text: e.message }], error: true)
         end
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
     end
   end
 end