rubocop 1.71.1 → 1.92.0

data/lib/rubocop/directive_comment.rb

@@ -12,16 +12,45 @@ module RuboCop
     # @api private
     LINT_SYNTAX_COP = "#{LINT_DEPARTMENT}/Syntax"
     # @api private
-    COP_NAME_PATTERN = '([A-Z]\w+/)*(?:[A-Z]\w+)'
+    STYLE_DISABLE_COPS_DIRECTIVE_COP = 'Style/DisableCopsWithinSourceCodeDirective'
+    # @api private
+    COP_NAME_PATTERN = '([A-Za-z]\w+/)*(?:[A-Za-z]\w+)'
+    # @api private
+    COP_NAME_PATTERN_NC = '(?:[A-Za-z]\w+/)*[A-Za-z]\w+'
+    # @api private
+    COP_NAMES_PATTERN_NC = "(?:#{COP_NAME_PATTERN_NC} , )*#{COP_NAME_PATTERN_NC}"
     # @api private
     COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
     # @api private
     COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
     # @api private
+    PUSH_POP_ARGS_PATTERN = "([+\\-]#{COP_NAME_PATTERN_NC}(?:\\s+[+\\-]#{COP_NAME_PATTERN_NC})*)"
+    # @api private
+    AVAILABLE_MODES = %w[disable enable todo push pop disable-next todo-next enable-next
+                         next].freeze
+    # @api private
+    # Longest first, so a `-next` mode is not matched as its prefix
+    # (`-` is a word boundary).
+    MODES_PATTERN = AVAILABLE_MODES.sort_by { |mode| -mode.length }.join('|').freeze
+    # @api private
+    DIRECTIVE_MARKER_PATTERN = '# rubocop : '
+    # @api private
+    DIRECTIVE_MARKER_REGEXP = Regexp.new(DIRECTIVE_MARKER_PATTERN.gsub(' ', '\s*'))
+    # @api private
+    DIRECTIVE_HEADER_PATTERN = "#{DIRECTIVE_MARKER_PATTERN}((?:#{MODES_PATTERN}))\\b"
+    # @api private
     DIRECTIVE_COMMENT_REGEXP = Regexp.new(
-      "# rubocop : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
+      "#{DIRECTIVE_HEADER_PATTERN}(?:\\s+#{COPS_PATTERN}|\\s+#{PUSH_POP_ARGS_PATTERN})?"
         .gsub(' ', '\s*')
     )
+    # @api private
+    SIGNED_OPERATIONS = %w[+ -].freeze
+    # @api private
+    TRAILING_COMMENT_MARKER = '--'
+    # @api private
+    MALFORMED_DIRECTIVE_WITHOUT_COP_NAME_REGEXP = Regexp.new(
+      "\\A#{DIRECTIVE_HEADER_PATTERN}\\s*\\z".gsub(' ', '\s*')
+    )
 
     def self.before_comment(line)
       line.split(DIRECTIVE_COMMENT_REGEXP).first
@@ -32,9 +61,54 @@ module RuboCop
     def initialize(comment, cop_registry = Cop::Registry.global)
       @comment = comment
       @cop_registry = cop_registry
+      match_data = comment.text.match(DIRECTIVE_COMMENT_REGEXP)
+      @match_data = match_data&.pre_match&.match?(/\A#\s*\z/) ? nil : match_data
       @mode, @cops = match_captures
     end
 
+    # Checks if the comment starts with `# rubocop:` marker
+    def start_with_marker?
+      comment.text.start_with?(DIRECTIVE_MARKER_REGEXP)
+    end
+
+    # Checks if the comment is malformed as a `# rubocop:` directive
+    def malformed?
+      return true if !start_with_marker? || @match_data.nil?
+      return true if missing_cop_name? || invalid_signed_args?
+
+      tail = @match_data.post_match.lstrip
+      !(tail.empty? || tail.start_with?(TRAILING_COMMENT_MARKER))
+    end
+
+    # Checks if the directive comment is missing a cop name
+    def missing_cop_name?
+      return false if push? || pop?
+
+      MALFORMED_DIRECTIVE_WITHOUT_COP_NAME_REGEXP.match?(comment.text)
+    end
+
+    # `push` and `next` arguments must be `+`/`-` prefixed cop names, and
+    # `pop` takes no arguments at all.
+    def invalid_signed_args?
+      return cops ? !cops.empty? : false if pop?
+      return false unless push? || next?
+      return false unless cops
+
+      cops.split.any? { |cop_spec| !cop_spec.start_with?('+', '-') }
+    end
+
+    # The text of the directive's optional `--` trailing comment, or `nil`
+    # when there is none.
+    def reason
+      return unless @match_data
+
+      tail = @match_data.post_match.lstrip
+      return unless tail.start_with?(TRAILING_COMMENT_MARKER)
+
+      reason = tail.delete_prefix(TRAILING_COMMENT_MARKER).strip
+      reason unless reason.empty?
+    end
+
     # Checks if this directive relates to single line
     def single_line?
       !comment.text.start_with?(DIRECTIVE_COMMENT_REGEXP)
@@ -53,20 +127,71 @@ module RuboCop
       )
     end
 
+    # `#range` stops at the cop list, so a `--` reason sits outside it. The reason documents the
+    # directive and means nothing once the directive is gone, so removal has to cover both. Any
+    # other trailing text is an ordinary comment and is left alone.
+    def range_with_reason
+      directive_range = range
+      trailing = Parser::Source::Range.new(
+        comment.source_range.source_buffer, directive_range.end_pos, comment.source_range.end_pos
+      )
+      return directive_range unless trailing.source.lstrip.start_with?(TRAILING_COMMENT_MARKER)
+
+      directive_range.with(end_pos: comment.source_range.end_pos)
+    end
+
     # Returns match captures to directive comment pattern
     def match_captures
-      @match_captures ||= comment.text.match(DIRECTIVE_COMMENT_REGEXP)&.captures
+      @match_captures ||= @match_data && begin
+        captures = @match_data.captures
+        mode = captures[0]
+        # COPS_PATTERN is at captures[1], PUSH_POP_ARGS_PATTERN is at captures[4]
+        cops = captures[1] || captures[4]
+        [mode, cops]
+      end
     end
 
     # Checks if this directive disables cops
     def disabled?
-      %w[disable todo].include?(mode)
+      %w[disable todo].include?(mode) || disable_next?
+    end
+
+    # Checks if this directive disables cops for the next statement only
+    def disable_next?
+      %w[disable-next todo-next].include?(mode)
     end
 
     # Checks if this directive enables cops
     def enabled?
-      mode == 'enable'
+      mode == 'enable' || enable_next?
+    end
+
+    # Checks if this directive enables cops for the next statement only
+    def enable_next?
+      mode == 'enable-next'
+    end
+
+    # Checks if this directive is a push
+    def push?
+      mode == 'push'
+    end
+
+    # Checks if this directive is a pop
+    def pop?
+      mode == 'pop'
+    end
+
+    # Checks if this directive toggles cops for the next statement only
+    def next?
+      mode == 'next'
+    end
+
+    # Returns the `+`/`-` arguments of a `push` or `next` directive as a hash
+    # of operations to cop names
+    def signed_args
+      @signed_args ||= parse_signed_args
     end
+    alias push_args signed_args
 
     # Checks if this directive enables all cops
     def enabled_all?
@@ -110,6 +235,8 @@ module RuboCop
     end
 
     def directive_count
+      return signed_args.values.sum(&:count) if push? || next?
+
       raw_cop_names.count
     end
 
@@ -143,5 +270,20 @@ module RuboCop
     def exclude_lint_department_cops(cops)
       cops - [LINT_REDUNDANT_DIRECTIVE_COP, LINT_SYNTAX_COP]
     end
+
+    def parse_signed_args
+      return {} unless (push? || next?) && cops
+
+      args = {}
+      cops.split.each do |cop_spec|
+        op = cop_spec[0]
+        cop_name = cop_spec[1..]
+        next unless SIGNED_OPERATIONS.include?(op)
+
+        args[op] ||= []
+        args[op] << cop_name
+      end
+      args
+    end
   end
 end

data/lib/rubocop/ext/regexp_node.rb

@@ -43,7 +43,6 @@ module RuboCop
       def named_capturing?(exp, event, named)
         event == :enter &&
           named == exp.respond_to?(:name) &&
-          !exp.text.start_with?('(?<=') &&
           exp.respond_to?(:capturing?) &&
           exp.capturing?
       end

data/lib/rubocop/feature_loader.rb

@@ -76,12 +76,6 @@ module RuboCop
       @feature.start_with?('.')
     end
 
-    # @param [LoadError] error
-    # @return [Boolean]
-    def seems_cannot_load_such_file_error?(error)
-      error.path == target
-    end
-
     # @return [String]
     def target
       if relative?

data/lib/rubocop/file_patterns.rb

@@ -21,11 +21,19 @@ module RuboCop
     def initialize(patterns)
       @strings = Set.new
       @patterns = []
+      @match_cache = {}
       partition_patterns(patterns)
     end
 
     def match?(path)
-      @strings.include?(path) || @patterns.any? { |pattern| PathUtil.match_path?(pattern, path) }
+      # `FilePatterns.from` memoizes one instance per pattern array (by identity),
+      # so this cache is shared across every cop using the same Include/Exclude
+      # list. Patterns are immutable within a run, so caching by path is safe.
+      cached = @match_cache[path]
+      return cached unless cached.nil?
+
+      @match_cache[path] =
+        @strings.include?(path) || @patterns.any? { |pattern| PathUtil.match_path?(pattern, path) }
     end
 
     private

data/lib/rubocop/formatter/base_formatter.rb

@@ -35,6 +35,7 @@ module RuboCop
     # * `#file_started`
     # * `#file_finished`
     # * `#file_started`
+    # * `#file_problems` (only when a cop crashed or warned on the file)
     # * `#file_finished`
     # * `#finished`
     #
@@ -88,6 +89,27 @@ module RuboCop
       # @return [void]
       def file_started(file, options); end
 
+      # @api public
+      #
+      # Invoked before `#file_finished` for a file that a cop crashed on or
+      # raised a warning for, or whose corrections went into an infinite loop.
+      # Optional: a formatter implementing the API by duck typing is skipped
+      # when it doesn't define it.
+      #
+      # @param file [String]
+      #   the file path
+      #
+      # @param errors [Array(String)]
+      #   the error messages as they're printed, without colors. A cop that
+      #   crashes on every node of a kind has a message for each, naming the
+      #   line and column.
+      #
+      # @param warnings [Array(String)]
+      #   the warning messages, in the same form
+      #
+      # @return [void]
+      def file_problems(file, errors, warnings); end
+
       # @api public
       #
       # Invoked at the end of inspecting each files.

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -47,8 +47,11 @@ module RuboCop
       def report_highlighted_area(highlighted_area)
         space_area  = highlighted_area.source_buffer.slice(0...highlighted_area.begin_pos)
         source_area = highlighted_area.source
-        output.puts("#{' ' * Unicode::DisplayWidth.of(space_area)}" \
-                    "#{'^' * Unicode::DisplayWidth.of(source_area)}")
+        output.puts("#{to_whitespace(space_area)}#{'^' * Unicode::DisplayWidth.of(source_area)}")
+      end
+
+      def to_whitespace(string)
+        "#{string.delete("^\t")}#{' ' * Unicode::DisplayWidth.of(string.delete("\t"))}"
       end
     end
   end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Formatter
     # This formatter displays a YAML configuration file where all cops that
     # detected any offenses are configured to not detect the offense.
-    class DisabledConfigFormatter < BaseFormatter
+    class DisabledConfigFormatter < BaseFormatter # rubocop:disable Metrics/ClassLength
       include PathUtil
 
       HEADING = <<~COMMENTS
@@ -17,6 +17,24 @@ module RuboCop
         # versions of RuboCop, may require this file to be generated again.
       COMMENTS
 
+      EXCLUDED_CONFIG_KEYS = %w[
+        AutoCorrect
+        Description
+        Enabled
+        Exclude
+        Include
+        Preview
+        Reference
+        References
+        Safe
+        SafeAutoCorrect
+        Severity
+        StyleGuide
+        VersionAdded
+        VersionChanged
+        VersionRemoved
+      ].freeze
+
       @config_to_allow_offenses = {}
       @detected_styles = {}
 
@@ -74,12 +92,10 @@ module RuboCop
         command = 'rubocop --auto-gen-config'
 
         command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
-
-        if no_exclude_limit?
-          command += ' --no-exclude-limit'
-        elsif @exclude_limit_option
-          command += format(' --exclude-limit %<limit>d', limit: Integer(@exclude_limit_option))
-        end
+        command += ' --disable-pending-cops' if @options[:disable_pending_cops]
+        command += ' --enable-pending-cops' if @options[:enable_pending_cops]
+        command += preview_option
+        command += exclude_limit_option
         command += ' --no-offense-counts' unless show_offense_counts?
 
         command += ' --no-auto-gen-timestamp' unless show_timestamp?
@@ -89,6 +105,24 @@ module RuboCop
         command
       end
 
+      def preview_option
+        case @options[:preview]
+        when true then ' --preview'
+        when false then ' --no-preview'
+        else ''
+        end
+      end
+
+      def exclude_limit_option
+        if no_exclude_limit?
+          ' --no-exclude-limit'
+        elsif @exclude_limit_option
+          format(' --exclude-limit %<limit>d', limit: Integer(@exclude_limit_option))
+        else
+          ''
+        end
+      end
+
       def timestamp
         show_timestamp? ? "on #{Time.now.utc} " : ''
       end
@@ -114,6 +148,9 @@ module RuboCop
       end
 
       def set_max(cfg, cop_name)
+        exclude_limits = RuboCop::ExcludeLimit.read_limits(cop_name)
+        cfg[:exclude_limit] = exclude_limits unless exclude_limits.empty?
+
         return unless cfg[:exclude_limit]
 
         cfg.merge!(cfg[:exclude_limit]) if should_set_max?(cop_name)
@@ -138,7 +175,7 @@ module RuboCop
         output_buffer.puts "# Offense count: #{offense_count}" if show_offense_counts?
 
         cop_class = Cop::Registry.global.find_by_cop_name(cop_name)
-        default_cfg = default_config(cop_name)
+        default_cfg = default_config(cop_name) || @config_for_pwd[cop_name]
 
         if supports_safe_autocorrect?(cop_class, default_cfg)
           output_buffer.puts '# This cop supports safe autocorrection (--autocorrect).'
@@ -163,10 +200,7 @@ module RuboCop
       end
 
       def cop_config_params(default_cfg, cfg)
-        default_cfg.keys -
-          %w[Description StyleGuide Reference Enabled Exclude Safe
-             SafeAutoCorrect VersionAdded VersionChanged VersionRemoved] -
-          cfg.keys
+        default_cfg.keys - EXCLUDED_CONFIG_KEYS - cfg.keys
       end
 
       def output_cop_param_comments(output_buffer, params, default_cfg)
@@ -178,6 +212,7 @@ module RuboCop
           next unless value.is_a?(Array)
           next if value.empty?
 
+          value = value.map { |v| v.nil? ? '~' : v } # Change nil back to ~ as in the YAML file.
           output_buffer.puts "# #{param}: #{value.uniq.join(', ')}"
         end
       end
@@ -218,7 +253,7 @@ module RuboCop
 
       def output_exclude_list(output_buffer, offending_files, cop_name)
         require 'pathname'
-        parent = Pathname.new(Dir.pwd)
+        parent = Pathname.new(PathUtil.pwd)
 
         output_buffer.puts '  Exclude:'
         excludes(offending_files, cop_name, parent).each do |exclude_path|
@@ -234,7 +269,7 @@ module RuboCop
         config = ConfigStore.new.for(parent)
         cfg = config[cop_name] || {}
 
-        if merge_mode_for_exclude?(config) || merge_mode_for_exclude?(cfg)
+        if exclude_merges?(config, cfg)
           offending_files
         else
           cop_exclude = cfg['Exclude']
@@ -247,6 +282,14 @@ module RuboCop
         end
       end
 
+      # `Preview` merges `Exclude` with the default configuration, so the excludes
+      # already in the configuration do not have to be copied into the todo file.
+      def exclude_merges?(config, cop_config)
+        merge_mode_for_exclude?(config) ||
+          merge_mode_for_exclude?(cop_config) ||
+          config.preview?(@options)
+      end
+
       def merge_mode_for_exclude?(cfg)
         Array(cfg.to_h.dig('inherit_mode', 'merge')).include?('Exclude')
       end

data/lib/rubocop/formatter/emacs_style_formatter.rb

@@ -23,7 +23,9 @@ module RuboCop
 
       def message(offense)
         message =
-          if offense.corrected_with_todo?
+          if offense.disabled?
+            "[Suppressed] #{offense.message}"
+          elsif offense.corrected_with_todo?
             "[Todo] #{offense.message}"
           elsif offense.corrected?
             "[Corrected] #{offense.message}"

data/lib/rubocop/formatter/formatter_set.rb

@@ -23,6 +23,7 @@ module RuboCop
         '[pa]cman'      => 'PacmanFormatter',
         '[p]rogress'    => 'ProgressFormatter',
         '[q]uiet'       => 'QuietFormatter',
+        '[sa]rif'       => 'SARIFFormatter',
         '[s]imple'      => 'SimpleTextFormatter',
         '[t]ap'         => 'TapFormatter',
         '[w]orst'       => 'WorstOffendersFormatter'
@@ -48,6 +49,10 @@ module RuboCop
         each { |f| f.file_started(file, options) }
       end
 
+      def file_problems(file, errors, warnings)
+        each { |f| f.file_problems(file, errors, warnings) if f.respond_to?(:file_problems) }
+      end
+
       def file_finished(file, offenses)
         each { |f| f.file_finished(file, offenses) }
         offenses
@@ -57,7 +62,7 @@ module RuboCop
         if output_path
           dir_path = File.dirname(output_path)
           FileUtils.mkdir_p(dir_path)
-          output = File.open(output_path, 'w')
+          output = File.open(output_path, 'w') # rubocop:disable Style/FileOpen -- the file is closed by `close_output_files`, not by a block
         else
           output = $stdout
         end
@@ -86,7 +91,7 @@ module RuboCop
 
       def builtin_formatter_class(specified_key)
         matching_keys = BUILTIN_FORMATTERS_FOR_KEYS.keys.select do |key|
-          /^\[#{specified_key}\]/.match?(key) || specified_key == key.delete('[]')
+          key.start_with?("[#{specified_key}]") || specified_key == key.delete('[]')
         end
 
         if matching_keys.empty?

data/lib/rubocop/formatter/fuubar_style_formatter.rb

@@ -22,7 +22,7 @@ module RuboCop
 
         @severest_offense = nil
 
-        file_phrase = target_files.count == 1 ? 'file' : 'files'
+        file_phrase = target_files.one? ? 'file' : 'files'
 
         # 185/407 files |====== 45 ======>                    |  ETA: 00:00:04
         # %c / %C       |       %w       >         %i         |       %e

data/lib/rubocop/formatter/github_actions_formatter.rb

@@ -15,6 +15,10 @@ module RuboCop
         @offenses_for_files[file] = offenses unless offenses.empty?
       end
 
+      def file_started(_file, options)
+        @config_store = options[:config_store]
+      end
+
       def finished(_inspected_files)
         @offenses_for_files.each do |file, offenses|
           offenses.each do |offense|
@@ -31,11 +35,8 @@ module RuboCop
       end
 
       def minimum_severity_to_fail
-        @minimum_severity_to_fail ||= begin
-          # Unless given explicitly as `fail_level`, `:info` severity offenses do not fail
-          name = options.fetch(:fail_level, :refactor)
-          RuboCop::Cop::Severity.new(name)
-        end
+        @minimum_severity_to_fail ||=
+          RuboCop::Cop::Severity.minimum_to_fail(options, @config_store&.for_pwd)
       end
 
       def github_severity(offense)

data/lib/rubocop/formatter/html_formatter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cgi'
+require 'cgi/escape'
 require 'erb'
 
 module RuboCop
@@ -74,11 +74,10 @@ module RuboCop
         end
 
         # Make Kernel#binding public.
-        # rubocop:disable Lint/UselessMethodDefinition
+        # rubocop:disable-next Lint/UselessMethodDefinition -- redefined only to make `Kernel#binding` public
         def binding
           super
         end
-        # rubocop:enable Lint/UselessMethodDefinition
 
         def decorated_message(offense)
           offense.message.gsub(/`(.+?)`/) { "<code>#{escape(Regexp.last_match(1))}</code>" }
@@ -144,11 +143,10 @@ module RuboCop
         }.freeze
 
         # Make Kernel#binding public.
-        # rubocop:disable Lint/UselessMethodDefinition
+        # rubocop:disable-next Lint/UselessMethodDefinition -- redefined only to make `Kernel#binding` public
         def binding
           super
         end
-        # rubocop:enable Lint/UselessMethodDefinition
       end
     end
   end