rubocop 1.53.1 → 1.90.0

data/lib/rubocop/directive_comment.rb

@@ -6,20 +6,48 @@ module RuboCop
   # cops it contains.
   class DirectiveComment
     # @api private
-    REDUNDANT_DIRECTIVE_COP_DEPARTMENT = 'Lint'
+    LINT_DEPARTMENT = 'Lint'
     # @api private
-    REDUNDANT_DIRECTIVE_COP = "#{REDUNDANT_DIRECTIVE_COP_DEPARTMENT}/RedundantCopDisableDirective"
+    LINT_REDUNDANT_DIRECTIVE_COP = "#{LINT_DEPARTMENT}/RedundantCopDisableDirective"
     # @api private
-    COP_NAME_PATTERN = '([A-Z]\w+/)*(?:[A-Z]\w+)'
+    LINT_SYNTAX_COP = "#{LINT_DEPARTMENT}/Syntax"
+    # @api private
+    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].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
+    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
@@ -30,9 +58,44 @@ 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?
+
+      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
+
+    # 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)
@@ -51,14 +114,38 @@ 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
@@ -66,6 +153,21 @@ module RuboCop
       mode == 'enable'
     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
+
+    # Returns the push arguments as a hash of cop names with their operations
+    def push_args
+      @push_args ||= parse_push_args
+    end
+
     # Checks if this directive enables all cops
     def enabled_all?
       !disabled? && all_cops?
@@ -86,10 +188,15 @@ module RuboCop
       @cop_names ||= all_cops? ? all_cop_names : parsed_cop_names
     end
 
+    # Returns an array of cops for this directive comment, without resolving departments
+    def raw_cop_names
+      @raw_cop_names ||= (cops || '').split(/,\s*/)
+    end
+
     # Returns array of specified in this directive department names
     # when all department disabled
     def department_names
-      splitted_cops_string.select { |cop| department?(cop) }
+      raw_cop_names.select { |cop| department?(cop) }
     end
 
     # Checks if directive departments include cop
@@ -99,11 +206,11 @@ module RuboCop
 
     # Checks if cop department has already used in directive comment
     def overridden_by_department?(cop)
-      in_directive_department?(cop) && splitted_cops_string.include?(cop)
+      in_directive_department?(cop) && raw_cop_names.include?(cop)
     end
 
     def directive_count
-      splitted_cops_string.count
+      raw_cop_names.count
     end
 
     # Returns line number for directive
@@ -113,14 +220,11 @@ module RuboCop
 
     private
 
-    def splitted_cops_string
-      (cops || '').split(/,\s*/)
-    end
-
     def parsed_cop_names
-      splitted_cops_string.map do |name|
+      cops = raw_cop_names.map do |name|
         department?(name) ? cop_names_for_department(name) : name
       end.flatten
+      cops - [LINT_SYNTAX_COP]
     end
 
     def department?(name)
@@ -128,17 +232,29 @@ module RuboCop
     end
 
     def all_cop_names
-      exclude_redundant_directive_cop(cop_registry.names)
+      exclude_lint_department_cops(cop_registry.names)
     end
 
     def cop_names_for_department(department)
       names = cop_registry.names_for_department(department)
-      has_redundant_directive_cop = department == REDUNDANT_DIRECTIVE_COP_DEPARTMENT
-      has_redundant_directive_cop ? exclude_redundant_directive_cop(names) : names
+      department == LINT_DEPARTMENT ? exclude_lint_department_cops(names) : names
     end
 
-    def exclude_redundant_directive_cop(cops)
-      cops - [REDUNDANT_DIRECTIVE_COP]
+    def exclude_lint_department_cops(cops)
+      cops - [LINT_REDUNDANT_DIRECTIVE_COP, LINT_SYNTAX_COP]
+    end
+
+    def parse_push_args
+      return {} unless push? && cops
+
+      args = {}
+      cops.split.each do |cop_spec|
+        op = cop_spec[0]
+        cop_name = cop_spec[1..]
+        args[op] ||= []
+        args[op] << cop_name
+      end
+      args
     end
   end
 end

data/lib/rubocop/ext/regexp_node.rb

@@ -15,49 +15,24 @@ module RuboCop
       # see `ext/regexp_parser`.
       attr_reader :parsed_tree
 
-      if Gem::Version.new(Regexp::Parser::VERSION) >= Gem::Version.new('2.0')
-        def assign_properties(*)
-          super
+      def assign_properties(*)
+        super
 
-          str = with_interpolations_blanked
-          @parsed_tree = begin
-            Regexp::Parser.parse(str, options: options)
-          rescue StandardError
-            nil
-          end
-          origin = loc.begin.end
-          @parsed_tree&.each_expression(true) { |e| e.origin = origin }
-        end
-      # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
-      # It's for compatibility with regexp_parser 1.8 and will never be maintained.
-      else
-        def assign_properties(*)
-          super
-
-          str = with_interpolations_blanked
-          begin
-            @parsed_tree = Regexp::Parser.parse(str, options: options)
-          rescue StandardError
-            @parsed_tree = nil
-          else
-            origin = loc.begin.end
-            source = @parsed_tree.to_s
-            @parsed_tree.each_expression(true) do |e|
-              e.origin = origin
-              e.source = source
-            end
-          end
+        str = with_interpolations_blanked
+        @parsed_tree = begin
+          Regexp::Parser.parse(str, options: options)
+        rescue StandardError
+          nil
         end
+        origin = loc.begin.end
+        @parsed_tree&.each_expression(true) { |e| e.origin = origin }
       end
 
       def each_capture(named: ANY)
         return enum_for(__method__, named: named) unless block_given?
 
         parsed_tree&.traverse do |event, exp, _index|
-          yield(exp) if event == :enter &&
-                        named == exp.respond_to?(:name) &&
-                        exp.respond_to?(:capturing?) &&
-                        exp.capturing?
+          yield(exp) if named_capturing?(exp, event, named)
         end
 
         self
@@ -65,6 +40,13 @@ module RuboCop
 
       private
 
+      def named_capturing?(exp, event, named)
+        event == :enter &&
+          named == exp.respond_to?(:name) &&
+          exp.respond_to?(:capturing?) &&
+          exp.capturing?
+      end
+
       def with_interpolations_blanked
         # Ignore the trailing regopt node
         children[0...-1].map do |child|

data/lib/rubocop/ext/regexp_parser.rb

@@ -22,26 +22,9 @@ module RuboCop
         module Base
           attr_accessor :origin
 
-          if Gem::Version.new(Regexp::Parser::VERSION) >= Gem::Version.new('2.0')
-            # Shortcut to `loc.expression`
-            def expression
-              @expression ||= origin.adjust(begin_pos: ts, end_pos: ts + full_length)
-            end
-          # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
-          # It's for compatibility with regexp_parser 1.8 and will never be maintained.
-          else
-            attr_accessor :source
-
-            def start_index
-              # ts is a byte index; convert it to a character index
-              @start_index ||= source.byteslice(0, ts).length
-            end
-
-            # Shortcut to `loc.expression`
-            def expression
-              end_pos = start_index + full_length
-              @expression ||= origin.adjust(begin_pos: start_index, end_pos: end_pos)
-            end
+          # Shortcut to `loc.expression`
+          def expression
+            @expression ||= origin.adjust(begin_pos: ts, end_pos: ts + full_length)
           end
 
           # @returns a location map like `parser` does, with:
@@ -69,8 +52,8 @@ module RuboCop
 
             body = expression.adjust(end_pos: -q.text.length)
             q.origin = origin
-            q.source = source if q.respond_to?(:source=) # for regexp_parser 1.8
             q_loc = q.expression
+
             { body: body, quantifier: q_loc }
           end
         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_finder.rb

@@ -6,12 +6,8 @@ module RuboCop
   # Common methods for finding files.
   # @api private
   module FileFinder
-    def self.root_level=(level)
-      @root_level = level
-    end
-
-    def self.root_level?(path, stop_dir)
-      (@root_level || stop_dir) == path.to_s
+    class << self
+      attr_accessor :root_level
     end
 
     def find_file_upwards(filename, start_dir, stop_dir = nil)
@@ -27,14 +23,20 @@ module RuboCop
       last_file
     end
 
+    def traverse_directories_upwards(start_dir, stop_dir = nil)
+      Pathname.new(start_dir).expand_path.ascend do |dir|
+        yield(dir)
+        dir = dir.to_s
+        break if dir == stop_dir || dir == FileFinder.root_level
+      end
+    end
+
     private
 
     def traverse_files_upwards(filename, start_dir, stop_dir)
-      Pathname.new(start_dir).expand_path.ascend do |dir|
+      traverse_directories_upwards(start_dir, stop_dir) do |dir|
         file = dir + filename
         yield(file.to_s) if file.exist?
-
-        break if FileFinder.root_level?(dir, stop_dir)
       end
     end
   end

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/clang_style_formatter.rb

@@ -24,14 +24,10 @@ module RuboCop
           message: message(offense)
         )
 
-        begin
-          return unless valid_line?(offense)
+        return unless valid_line?(offense)
 
-          report_line(offense.location)
-          report_highlighted_area(offense.highlighted_area)
-        rescue IndexError
-          # range is not on a valid line; perhaps the source file is empty
-        end
+        report_line(offense.location)
+        report_highlighted_area(offense.highlighted_area)
       end
 
       def valid_line?(offense)
@@ -51,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,19 +4,36 @@ 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
         # This configuration was generated by
         # `%<command>s`
-        # %<timestamp>susing RuboCop version #{Version.version}.
+        # %<timestamp>susing RuboCop version #{Version::STRING}.
         # The point is for the user to remove these configuration records
         # one by one as the offenses are removed from the code base.
         # Note that changes in the inspected code, or installation of new
         # versions of RuboCop, may require this file to be generated again.
       COMMENTS
 
+      EXCLUDED_CONFIG_KEYS = %w[
+        AutoCorrect
+        Description
+        Enabled
+        Exclude
+        Include
+        Reference
+        References
+        Safe
+        SafeAutoCorrect
+        Severity
+        StyleGuide
+        VersionAdded
+        VersionChanged
+        VersionRemoved
+      ].freeze
+
       @config_to_allow_offenses = {}
       @detected_styles = {}
 
@@ -30,7 +47,8 @@ module RuboCop
         @files_with_offenses ||= {}
       end
 
-      def file_started(_file, _file_info)
+      def file_started(_file, options)
+        @config_for_pwd = options[:config_store].for_pwd
         @exclude_limit_option = @options[:exclude_limit]
         @exclude_limit = Integer(@exclude_limit_option ||
           RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS)
@@ -73,12 +91,9 @@ 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 += exclude_limit_option
         command += ' --no-offense-counts' unless show_offense_counts?
 
         command += ' --no-auto-gen-timestamp' unless show_timestamp?
@@ -88,6 +103,16 @@ module RuboCop
         command
       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
@@ -113,23 +138,34 @@ 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]
 
-        # In case auto_gen_only_exclude is set, only modify the maximum if the
-        # files are not excluded one by one.
-        if !@options[:auto_gen_only_exclude] || @files_with_offenses[cop_name].size > @exclude_limit
-          cfg.merge!(cfg[:exclude_limit])
-        end
+        cfg.merge!(cfg[:exclude_limit]) if should_set_max?(cop_name)
 
         # Remove already used exclude_limit.
         cfg.reject! { |key| key == :exclude_limit }
       end
 
+      def should_set_max?(cop_name)
+        max_set_in_user_config =
+          @config_for_pwd.for_cop(cop_name)['Max'] != default_config(cop_name)['Max']
+
+        max_allowed = !max_set_in_user_config && !no_exclude_limit?
+        return false unless max_allowed
+
+        # In case auto_gen_only_exclude is set, only modify the maximum if the files are not
+        # excluded one by one.
+        !@options[:auto_gen_only_exclude] || @files_with_offenses[cop_name].size > @exclude_limit
+      end
+
       def output_cop_comments(output_buffer, cfg, cop_name, offense_count)
         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).'
@@ -154,10 +190,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)
@@ -169,6 +202,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
@@ -192,8 +226,8 @@ module RuboCop
         # 'Enabled' option will be put into file only if exclude
         # limit is exceeded.
         rejected_keys = ['Enabled']
-        rejected_keys << 'EnforcedStyle' unless auto_gen_enforced_style?
-        cfg.reject { |key| rejected_keys.include?(key) }
+        rejected_keys << /\AEnforcedStyle\w*/ unless auto_gen_enforced_style?
+        cfg.reject { |key| include_or_match?(rejected_keys, key) }
       end
 
       def output_offending_files(output_buffer, cfg, cop_name)
@@ -209,7 +243,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|
@@ -262,6 +296,12 @@ module RuboCop
       def no_exclude_limit?
         @options[:no_exclude_limit] == false
       end
+
+      # Returns true if the given arr include the given elm or if any of the
+      # given arr is a regexp that matches the given elm.
+      def include_or_match?(arr, elm)
+        arr.include?(elm) || arr.any? { |x| x.is_a?(Regexp) && x.match?(elm) }
+      end
     end
   end
 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}"