rubocop 1.44.1 → 1.78.0

data/lib/rubocop/ext/comment.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions to `Parser::Source::Comment`.
+    module Comment
+      def source
+        loc.expression.source
+      end
+
+      def source_range
+        loc.expression
+      end
+    end
+  end
+end
+
+Parser::Source::Comment.include RuboCop::Ext::Comment

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_arser 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_arser 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:
@@ -68,7 +51,9 @@ module RuboCop
             return { body: expression } unless (q = quantifier)
 
             body = expression.adjust(end_pos: -q.text.length)
-            q_loc = expression.with(begin_pos: body.end_pos)
+            q.origin = origin
+            q_loc = q.expression
+
             { body: body, quantifier: q_loc }
           end
         end
@@ -86,6 +71,7 @@ module RuboCop
         end
       end
       ::Regexp::Expression::Base.include Expression::Base
+      ::Regexp::Expression::Quantifier.include Expression::Base
       ::Regexp::Expression::CharacterSet.include Expression::CharacterSet
     end
   end

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/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)

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -10,7 +10,7 @@ module RuboCop
       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
@@ -30,7 +30,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)
@@ -115,16 +116,24 @@ module RuboCop
       def set_max(cfg, cop_name)
         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?
 
@@ -155,7 +164,7 @@ module RuboCop
 
       def cop_config_params(default_cfg, cfg)
         default_cfg.keys -
-          %w[Description StyleGuide Reference Enabled Exclude Safe
+          %w[Description StyleGuide Reference References Enabled Exclude Safe
              SafeAutoCorrect VersionAdded VersionChanged VersionRemoved] -
           cfg.keys
       end
@@ -169,6 +178,7 @@ module RuboCop
           next unless value.is_a?(Array)
           next if value.empty?
 
+          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 +202,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)
@@ -262,6 +272,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/formatter_set.rb

@@ -27,6 +27,7 @@ module RuboCop
         '[t]ap'         => 'TapFormatter',
         '[w]orst'       => 'WorstOffendersFormatter'
       }.freeze
+      BUILTIN_FORMATTER_NAMES = BUILTIN_FORMATTERS_FOR_KEYS.keys.map { |key| key.delete('[]') }
 
       FORMATTER_APIS = %i[started finished].freeze
 
@@ -76,7 +77,7 @@ module RuboCop
         case formatter_type
         when Class
           formatter_type
-        when /\A[A-Z]/
+        when /\A(::)?[A-Z]/
           custom_formatter_class(formatter_type)
         else
           builtin_formatter_class(formatter_type)
@@ -88,7 +89,12 @@ module RuboCop
           /^\[#{specified_key}\]/.match?(key) || specified_key == key.delete('[]')
         end
 
-        raise %(No formatter for "#{specified_key}") if matching_keys.empty?
+        if matching_keys.empty?
+          similar_name = NameSimilarity.find_similar_name(specified_key, BUILTIN_FORMATTER_NAMES)
+          suggestion = %( Did you mean? "#{similar_name}") if similar_name
+
+          raise Rainbow(%(Formatter "#{specified_key}" not found.#{suggestion})).red
+        end
 
         raise %(Cannot determine formatter for "#{specified_key}") if matching_keys.size > 1
 

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

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'base64'
-require 'cgi'
+require 'cgi/escape'
 require 'erb'
-require 'ostruct'
 
 module RuboCop
   module Formatter
@@ -11,6 +9,7 @@ module RuboCop
     class HTMLFormatter < BaseFormatter
       ELLIPSES = '<span class="extra-code">...</span>'
       TEMPLATE_PATH = File.expand_path('../../../assets/output.html.erb', __dir__)
+      CSS_PATH = File.expand_path('../../../assets/output.css.erb', __dir__)
 
       Color = Struct.new(:red, :green, :blue, :alpha) do
         def to_s
@@ -52,8 +51,10 @@ module RuboCop
         context = ERBContext.new(files, summary)
 
         template = File.read(TEMPLATE_PATH, encoding: Encoding::UTF_8)
-        erb = ERB.new(template, trim_mode: '-')
-        html = erb.result(context.binding)
+        erb = ERB.new(template)
+        html = erb.result(context.binding).lines.map do |line|
+          line.match?(/\A\s*\z/) ? "\n" : line
+        end.join
 
         output.write html
       end
@@ -63,14 +64,6 @@ module RuboCop
         include PathUtil
         include TextUtil
 
-        SEVERITY_COLORS = {
-          refactor:   Color.new(0xED, 0x9C, 0x28, 1.0),
-          convention: Color.new(0xED, 0x9C, 0x28, 1.0),
-          warning:    Color.new(0x96, 0x28, 0xEF, 1.0),
-          error:      Color.new(0xD2, 0x32, 0x2D, 1.0),
-          fatal:      Color.new(0xD2, 0x32, 0x2D, 1.0)
-        }.freeze
-
         LOGO_IMAGE_PATH = File.expand_path('../../../assets/logo.png', __dir__)
 
         attr_reader :files, :summary
@@ -88,7 +81,7 @@ module RuboCop
         # rubocop:enable Lint/UselessMethodDefinition
 
         def decorated_message(offense)
-          offense.message.gsub(/`(.+?)`/) { "<code>#{Regexp.last_match(1)}</code>" }
+          offense.message.gsub(/`(.+?)`/) { "<code>#{escape(Regexp.last_match(1))}</code>" }
         end
 
         def highlighted_source_line(offense)
@@ -124,9 +117,39 @@ module RuboCop
 
         def base64_encoded_logo_image
           image = File.read(LOGO_IMAGE_PATH, binmode: true)
-          Base64.encode64(image)
+
+          # `Base64.encode64` compatible:
+          # https://github.com/ruby/base64/blob/v0.1.1/lib/base64.rb#L27-L40
+          [image].pack('m')
+        end
+
+        def render_css
+          context = CSSContext.new
+          template = File.read(CSS_PATH, encoding: Encoding::UTF_8)
+          erb = ERB.new(template, trim_mode: '-')
+          erb.result(context.binding).lines.map do |line|
+            line == "\n" ? line : "      #{line}"
+          end.join
         end
       end
+
+      # This class provides helper methods used in the ERB CSS template.
+      class CSSContext
+        SEVERITY_COLORS = {
+          refactor:   Color.new(0xED, 0x9C, 0x28, 1.0),
+          convention: Color.new(0xED, 0x9C, 0x28, 1.0),
+          warning:    Color.new(0x96, 0x28, 0xEF, 1.0),
+          error:      Color.new(0xD2, 0x32, 0x2D, 1.0),
+          fatal:      Color.new(0xD2, 0x32, 0x2D, 1.0)
+        }.freeze
+
+        # Make Kernel#binding public.
+        # rubocop:disable Lint/UselessMethodDefinition
+        def binding
+          super
+        end
+        # rubocop:enable Lint/UselessMethodDefinition
+      end
     end
   end
 end

data/lib/rubocop/formatter/json_formatter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'pathname'
 
 module RuboCop
   module Formatter

data/lib/rubocop/formatter/junit_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rexml/document'
-
 #
 # This code is based on https://github.com/mikian/rubocop-junit-formatter.
 #
@@ -15,13 +13,18 @@ module RuboCop
   module Formatter
     # This formatter formats the report data in JUnit format.
     class JUnitFormatter < BaseFormatter
+      ESCAPE_MAP = {
+        '"' => '&quot;',
+        "'" => '&apos;',
+        '<' => '&lt;',
+        '>' => '&gt;',
+        '&' => '&amp;'
+      }.freeze
+
       def initialize(output, options = {})
         super
 
-        @document = REXML::Document.new.tap { |document| document << REXML::XMLDecl.new }
-        testsuites = REXML::Element.new('testsuites', @document)
-        testsuite = REXML::Element.new('testsuite', testsuites)
-        @testsuite = testsuite.tap { |element| element.add_attributes('name' => 'rubocop') }
+        @test_case_elements = []
 
         reset_count
       end
@@ -44,6 +47,33 @@ module RuboCop
         end
       end
 
+      # rubocop:disable Layout/LineLength,Metrics/AbcSize,Metrics/MethodLength
+      def finished(_inspected_files)
+        output.puts %(<?xml version='1.0'?>)
+        output.puts %(<testsuites>)
+        output.puts %(  <testsuite name='rubocop' tests='#{@inspected_file_count}' failures='#{@offense_count}'>)
+
+        @test_case_elements.each do |test_case_element|
+          if test_case_element.failures.empty?
+            output.puts %(    <testcase classname='#{xml_escape test_case_element.classname}' name='#{test_case_element.name}'/>)
+          else
+            output.puts %(    <testcase classname='#{xml_escape test_case_element.classname}' name='#{test_case_element.name}'>)
+            test_case_element.failures.each do |failure_element|
+              output.puts %(      <failure type='#{failure_element.type}' message='#{xml_escape failure_element.message}'>)
+              output.puts %(        #{xml_escape failure_element.text})
+              output.puts %(      </failure>)
+            end
+            output.puts %(    </testcase>)
+          end
+        end
+
+        output.puts %(  </testsuite>)
+        output.puts %(</testsuites>)
+      end
+      # rubocop:enable Layout/LineLength,Metrics/AbcSize,Metrics/MethodLength
+
+      private
+
       def relevant_for_output?(options, target_offenses)
         !options[:display_only_failed] || target_offenses.any?
       end
@@ -53,25 +83,21 @@ module RuboCop
       end
 
       def add_testcase_element_to_testsuite_element(file, target_offenses, cop)
-        REXML::Element.new('testcase', @testsuite).tap do |testcase|
-          testcase.attributes['classname'] = classname_attribute_value(file)
-          testcase.attributes['name'] = cop.cop_name
-
-          add_failure_to(testcase, target_offenses, cop.cop_name)
+        @test_case_elements << TestCaseElement.new(
+          classname: classname_attribute_value(file),
+          name: cop.cop_name
+        ).tap do |test_case_element|
+          add_failure_to(test_case_element, target_offenses, cop.cop_name)
         end
       end
 
       def classname_attribute_value(file)
-        file.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
-      end
-
-      def finished(_inspected_files)
-        @testsuite.add_attributes('tests' => @inspected_file_count, 'failures' => @offense_count)
-        @document.write(output, 2)
+        @classname_attribute_value_cache ||= Hash.new do |hash, key|
+          hash[key] = key.delete_suffix('.rb').gsub("#{Dir.pwd}/", '').tr('/', '.')
+        end
+        @classname_attribute_value_cache[file]
       end
 
-      private
-
       def reset_count
         @inspected_file_count = 0
         @offense_count = 0
@@ -81,11 +107,35 @@ module RuboCop
         # One failure per offense. Zero failures is a passing test case,
         # for most surefire/nUnit parsers.
         offenses.each do |offense|
-          REXML::Element.new('failure', testcase).tap do |failure|
-            failure.attributes['type'] = cop_name
-            failure.attributes['message'] = offense.message
-            failure.add_text(offense.location.to_s)
-          end
+          testcase.failures << FailureElement.new(
+            type: cop_name,
+            message: offense.message,
+            text: offense.location.to_s
+          )
+        end
+      end
+
+      def xml_escape(string)
+        string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
+      end
+
+      class TestCaseElement # :nodoc:
+        attr_reader :classname, :name, :failures
+
+        def initialize(classname:, name:)
+          @classname = classname
+          @name = name
+          @failures = []
+        end
+      end
+
+      class FailureElement # :nodoc:
+        attr_reader :type, :message, :text
+
+        def initialize(type:, message:, text:)
+          @type = type
+          @message = message
+          @text = text
         end
       end
     end

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -24,7 +24,7 @@ module RuboCop
 
         return unless output.tty?
 
-        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
@@ -61,8 +61,7 @@ module RuboCop
 
         column_width = total_count.to_s.length + 2
         per_cop_counts.each do |cop_name, count|
-          output.puts "#{count.to_s.ljust(column_width)}#{cop_name}" \
-                      "#{@style_guide_links[cop_name]}\n"
+          output.puts "#{count.to_s.ljust(column_width)}#{cop_information(cop_name)}"
         end
         output.puts '--'
         output.puts "#{total_count}  Total in #{offending_files_count} files"
@@ -78,6 +77,17 @@ module RuboCop
       def total_offense_count(offense_counts)
         offense_counts.values.sum
       end
+
+      def cop_information(cop_name)
+        cop = RuboCop::Cop::Registry.global.find_by_cop_name(cop_name).new
+
+        if cop.correctable?
+          safety = cop.safe_autocorrect? ? 'Safe' : 'Unsafe'
+          correctable = Rainbow(" [#{safety} Correctable]").yellow
+        end
+
+        "#{cop_name}#{correctable}#{@style_guide_links[cop_name]}"
+      end
     end
   end
 end

data/lib/rubocop/formatter/pacman_formatter.rb

@@ -58,7 +58,7 @@ module RuboCop
         return pacdots(@total_files) unless @total_files > cols
         return pacdots(cols) unless (@total_files / cols).eql?(@repetitions)
 
-        pacdots((@total_files - (cols * @repetitions)))
+        pacdots(@total_files - (cols * @repetitions))
       end
 
       def pacdots(number)

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -61,7 +61,7 @@ module RuboCop
                             correctable_count,
                             rainbow,
                             # :safe_autocorrect is a derived option based on several command-line
-                            # arguments - see Rubocop::Options#add_autocorrection_options
+                            # arguments - see RuboCop::Options#add_autocorrection_options
                             safe_autocorrect: @options[:safe_autocorrect])
 
         output.puts

data/lib/rubocop/formatter/tap_formatter.rb

@@ -53,14 +53,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 annotate_message(msg)

data/lib/rubocop/formatter.rb

@@ -14,7 +14,7 @@ module RuboCop
     require_relative 'formatter/emacs_style_formatter'
     require_relative 'formatter/file_list_formatter'
     require_relative 'formatter/fuubar_style_formatter'
-    require_relative 'formatter/git_hub_actions_formatter'
+    require_relative 'formatter/github_actions_formatter'
     require_relative 'formatter/html_formatter'
     require_relative 'formatter/json_formatter'
     require_relative 'formatter/junit_formatter'