rubocop 1.24.1 → 1.64.1

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)
@@ -41,7 +37,7 @@ module RuboCop
       def report_line(location)
         source_line = location.source_line
 
-        if location.first_line == location.last_line
+        if location.single_line?
           output.puts(source_line)
         else
           output.puts("#{source_line} #{yellow(ELLIPSES)}")

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -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)
@@ -65,18 +66,26 @@ module RuboCop
         @options.fetch(:offense_counts, true)
       end
 
+      def auto_gen_enforced_style?
+        @options.fetch(:auto_gen_enforced_style, true)
+      end
+
       def command
         command = 'rubocop --auto-gen-config'
 
         command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
 
-        if @exclude_limit_option
+        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 += ' --no-offense-counts' unless show_offense_counts?
 
         command += ' --no-auto-gen-timestamp' unless show_timestamp?
 
+        command += ' --no-auto-gen-enforced-style' unless auto_gen_enforced_style?
+
         command
       end
 
@@ -107,23 +116,36 @@ 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?
 
         cop_class = Cop::Registry.global.find_by_cop_name(cop_name)
-        output_buffer.puts '# Cop supports --auto-correct.' if cop_class&.support_autocorrect?
-
         default_cfg = default_config(cop_name)
+
+        if supports_safe_autocorrect?(cop_class, default_cfg)
+          output_buffer.puts '# This cop supports safe autocorrection (--autocorrect).'
+        elsif supports_unsafe_autocorrect?(cop_class, default_cfg)
+          output_buffer.puts '# This cop supports unsafe autocorrection (--autocorrect-all).'
+        end
+
         return unless default_cfg
 
         params = cop_config_params(default_cfg, cfg)
@@ -132,6 +154,14 @@ module RuboCop
         output_cop_param_comments(output_buffer, params, default_cfg)
       end
 
+      def supports_safe_autocorrect?(cop_class, default_cfg)
+        cop_class&.support_autocorrect? && (default_cfg.nil? || safe_autocorrect?(default_cfg))
+      end
+
+      def supports_unsafe_autocorrect?(cop_class, default_cfg)
+        cop_class&.support_autocorrect? && !safe_autocorrect?(default_cfg)
+      end
+
       def cop_config_params(default_cfg, cfg)
         default_cfg.keys -
           %w[Description StyleGuide Reference Enabled Exclude Safe
@@ -148,7 +178,7 @@ module RuboCop
           next unless value.is_a?(Array)
           next if value.empty?
 
-          output_buffer.puts "# #{param}: #{value.join(', ')}"
+          output_buffer.puts "# #{param}: #{value.uniq.join(', ')}"
         end
       end
 
@@ -157,24 +187,29 @@ module RuboCop
       end
 
       def output_cop_config(output_buffer, cfg, cop_name)
-        # 'Enabled' option will be put into file only if exclude
-        # limit is exceeded.
-        cfg_without_enabled = cfg.reject { |key| key == 'Enabled' }
-
+        filtered_cfg = filtered_config(cfg)
         output_buffer.puts "#{cop_name}:"
-        cfg_without_enabled.each do |key, value|
+        filtered_cfg.each do |key, value|
           value = value[0] if value.is_a?(Array)
           output_buffer.puts "  #{key}: #{value}"
         end
 
-        output_offending_files(output_buffer, cfg_without_enabled, cop_name)
+        output_offending_files(output_buffer, filtered_cfg, cop_name)
+      end
+
+      def filtered_config(cfg)
+        # 'Enabled' option will be put into file only if exclude
+        # limit is exceeded.
+        rejected_keys = ['Enabled']
+        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)
         return unless cfg.empty?
 
         offending_files = @files_with_offenses[cop_name].sort
-        if offending_files.count > @exclude_limit
+        if !no_exclude_limit? && offending_files.count > @exclude_limit
           output_buffer.puts '  Enabled: false'
         else
           output_exclude_list(output_buffer, offending_files, cop_name)
@@ -228,6 +263,20 @@ module RuboCop
         regexp = exclude_path
         output_buffer.puts "    - !ruby/regexp /#{regexp.source}/"
       end
+
+      def safe_autocorrect?(config)
+        config.fetch('Safe', true) && config.fetch('SafeAutoCorrect', true)
+      end
+
+      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

@@ -9,23 +9,25 @@ module RuboCop
     # which invoke same method of each formatters.
     class FormatterSet < Array
       BUILTIN_FORMATTERS_FOR_KEYS = {
-        '[a]utogenconf' => AutoGenConfigFormatter,
-        '[c]lang'       => ClangStyleFormatter,
-        '[e]macs'       => EmacsStyleFormatter,
-        '[fi]les'       => FileListFormatter,
-        '[fu]ubar'      => FuubarStyleFormatter,
-        '[g]ithub'      => GitHubActionsFormatter,
-        '[h]tml'        => HTMLFormatter,
-        '[j]son'        => JSONFormatter,
-        '[ju]nit'       => JUnitFormatter,
-        '[o]ffenses'    => OffenseCountFormatter,
-        '[pa]cman'      => PacmanFormatter,
-        '[p]rogress'    => ProgressFormatter,
-        '[q]uiet'       => QuietFormatter,
-        '[s]imple'      => SimpleTextFormatter,
-        '[t]ap'         => TapFormatter,
-        '[w]orst'       => WorstOffendersFormatter
+        '[a]utogenconf' => 'AutoGenConfigFormatter',
+        '[c]lang'       => 'ClangStyleFormatter',
+        '[e]macs'       => 'EmacsStyleFormatter',
+        '[fi]les'       => 'FileListFormatter',
+        '[fu]ubar'      => 'FuubarStyleFormatter',
+        '[g]ithub'      => 'GitHubActionsFormatter',
+        '[h]tml'        => 'HTMLFormatter',
+        '[j]son'        => 'JSONFormatter',
+        '[ju]nit'       => 'JUnitFormatter',
+        '[m]arkdown'    => 'MarkdownFormatter',
+        '[o]ffenses'    => 'OffenseCountFormatter',
+        '[pa]cman'      => 'PacmanFormatter',
+        '[p]rogress'    => 'ProgressFormatter',
+        '[q]uiet'       => 'QuietFormatter',
+        '[s]imple'      => 'SimpleTextFormatter',
+        '[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
 
@@ -54,7 +56,7 @@ module RuboCop
       def add_formatter(formatter_type, output_path = nil)
         if output_path
           dir_path = File.dirname(output_path)
-          FileUtils.mkdir_p(dir_path) unless File.exist?(dir_path)
+          FileUtils.mkdir_p(dir_path)
           output = File.open(output_path, 'w')
         else
           output = $stdout
@@ -87,11 +89,17 @@ 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
 
-        BUILTIN_FORMATTERS_FOR_KEYS[matching_keys.first]
+        formatter_name = BUILTIN_FORMATTERS_FOR_KEYS[matching_keys.first]
+        RuboCop::Formatter.const_get(formatter_name)
       end
 
       def custom_formatter_class(specified_class_name)

data/lib/rubocop/formatter/{git_hub_actions_formatter.rb → github_actions_formatter.rb}

@@ -7,8 +7,21 @@ module RuboCop
     class GitHubActionsFormatter < BaseFormatter
       ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
 
+      def started(_target_files)
+        @offenses_for_files = {}
+      end
+
       def file_finished(file, offenses)
-        offenses.each { |offense| report_offense(file, offense) }
+        @offenses_for_files[file] = offenses unless offenses.empty?
+      end
+
+      def finished(_inspected_files)
+        @offenses_for_files.each do |file, offenses|
+          offenses.each do |offense|
+            report_offense(file, offense)
+          end
+        end
+        output.puts
       end
 
       private
@@ -31,7 +44,7 @@ module RuboCop
 
       def report_offense(file, offense)
         output.printf(
-          "\n::%<severity>s file=%<file>s,line=%<line>d,col=%<column>d::%<message>s\n",
+          "\n::%<severity>s file=%<file>s,line=%<line>d,col=%<column>d::%<message>s",
           severity: github_severity(offense),
           file: PathUtil.smart_path(file),
           line: offense.line,

data/lib/rubocop/formatter/html_formatter.rb

@@ -2,9 +2,6 @@
 
 require 'cgi'
 require 'erb'
-require 'ostruct'
-require 'base64'
-require_relative 'text_util'
 
 module RuboCop
   module Formatter
@@ -12,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
@@ -53,15 +51,8 @@ module RuboCop
         context = ERBContext.new(files, summary)
 
         template = File.read(TEMPLATE_PATH, encoding: Encoding::UTF_8)
-
-        # The following condition is workaround for until Ruby 2.6 is released.
-        # https://github.com/ruby/ruby/commit/cc777d09f44fa909a336ba14f3aa802ffe16e010
-        erb = if RUBY_VERSION >= '2.6'
-                ERB.new(template, trim_mode: '-')
-              else
-                ERB.new(template, nil, '-')
-              end
-        html = erb.result(context.binding)
+        erb = ERB.new(template)
+        html = erb.result(context.binding).lines.map { (_1 =~ /^\s*$/).nil? ? _1 : "\n" }.join
 
         output.write html
       end
@@ -71,14 +62,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
@@ -96,17 +79,17 @@ 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)
           source_before_highlight(offense) +
-            hightlight_source_tag(offense) +
+            highlight_source_tag(offense) +
             source_after_highlight(offense) +
             possible_ellipses(offense.location)
         end
 
-        def hightlight_source_tag(offense)
+        def highlight_source_tag(offense)
           "<span class=\"highlight #{offense.severity}\">" \
             "#{escape(offense.highlighted_area.source)}" \
             '</span>'
@@ -119,11 +102,11 @@ module RuboCop
 
         def source_after_highlight(offense)
           source_line = offense.location.source_line
-          escape(source_line[offense.highlighted_area.end_pos..-1])
+          escape(source_line[offense.highlighted_area.end_pos..])
         end
 
         def possible_ellipses(location)
-          location.first_line == location.last_line ? '' : " #{ELLIPSES}"
+          location.single_line? ? '' : " #{ELLIPSES}"
         end
 
         def escape(string)
@@ -132,8 +115,38 @@ 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

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

@@ -62,7 +62,10 @@ module RuboCop
       end
 
       def classname_attribute_value(file)
-        file.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
+        @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
 
       def finished(_inspected_files)

data/lib/rubocop/formatter/markdown_formatter.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter displays the report data in markdown
+    class MarkdownFormatter < BaseFormatter
+      include TextUtil
+      include PathUtil
+      attr_reader :files, :summary
+
+      def initialize(output, options = {})
+        super
+        @files = []
+        @summary = Struct.new(:offense_count, :inspected_files, :target_files).new(0)
+      end
+
+      def started(target_files)
+        summary.target_files = target_files
+      end
+
+      def file_finished(file, offenses)
+        files << Struct.new(:path, :offenses).new(file, offenses)
+        summary.offense_count += offenses.count
+      end
+
+      def finished(inspected_files)
+        summary.inspected_files = inspected_files
+        render_markdown
+      end
+
+      private
+
+      def render_markdown
+        n_files = pluralize(summary.inspected_files.count, 'file')
+        n_offenses = pluralize(summary.offense_count, 'offense', no_for_zero: true)
+
+        output.write "# RuboCop Inspection Report\n\n"
+        output.write "#{n_files} inspected, #{n_offenses} detected:\n\n"
+        write_file_messages
+      end
+
+      def write_file_messages
+        files.each do |file|
+          next if file.offenses.empty?
+
+          write_heading(file)
+          file.offenses.each do |offense|
+            write_context(offense)
+            write_code(offense)
+          end
+        end
+      end
+
+      def write_heading(file)
+        filename = relative_path(file.path)
+        n_offenses = pluralize(file.offenses.count, 'offense')
+
+        output.write "### #{filename} - (#{n_offenses})\n"
+      end
+
+      def write_context(offense)
+        output.write(
+          "  * **Line # #{offense.location.line} - #{offense.severity}:** #{offense.message}\n\n"
+        )
+      end
+
+      def write_code(offense)
+        code = offense.location.source_line + possible_ellipses(offense.location)
+
+        output.write "    ```rb\n    #{code}\n    ```\n\n" unless code.blank?
+      end
+
+      def possible_ellipses(location)
+        location.single_line? ? '' : ' ...'
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'ruby-progressbar'
+
 module RuboCop
   module Formatter
     # This formatter displays the list of offended cops with a count of how
@@ -10,13 +12,15 @@ module RuboCop
     # 26  LineLength
     # 3   OneLineConditional
     # --
-    # 29  Total
+    # 29  Total in 5 files
     class OffenseCountFormatter < BaseFormatter
       attr_reader :offense_counts
 
       def started(target_files)
         super
         @offense_counts = Hash.new(0)
+        @offending_files_count = 0
+        @style_guide_links = {}
 
         return unless output.tty?
 
@@ -37,26 +41,30 @@ module RuboCop
 
       def file_finished(_file, offenses)
         offenses.each { |o| @offense_counts[o.cop_name] += 1 }
+        if options[:display_style_guide]
+          offenses.each { |o| @style_guide_links[o.cop_name] ||= o.message[/ \(http\S+\)\Z/] }
+        end
+        @offending_files_count += 1 unless offenses.empty?
         @progressbar.increment if instance_variable_defined?(:@progressbar)
       end
 
       def finished(_inspected_files)
-        report_summary(@offense_counts)
+        report_summary(@offense_counts, @offending_files_count)
       end
 
       # rubocop:disable Metrics/AbcSize
-      def report_summary(offense_counts)
+      def report_summary(offense_counts, offending_files_count)
         per_cop_counts = ordered_offense_counts(offense_counts)
         total_count = total_offense_count(offense_counts)
 
         output.puts
 
+        column_width = total_count.to_s.length + 2
         per_cop_counts.each do |cop_name, count|
-          output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}" \
-                      "#{cop_name}\n"
+          output.puts "#{count.to_s.ljust(column_width)}#{cop_information(cop_name)}"
         end
         output.puts '--'
-        output.puts "#{total_count}  Total"
+        output.puts "#{total_count}  Total in #{offending_files_count} files"
 
         output.puts
       end
@@ -69,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/simple_text_formatter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'colorizable'
-require_relative 'text_util'
 
 module RuboCop
   module Formatter
@@ -61,7 +60,9 @@ module RuboCop
                             correction_count,
                             correctable_count,
                             rainbow,
-                            safe_auto_correct: @options[:safe_auto_correct])
+                            # :safe_autocorrect is a derived option based on several command-line
+                            # arguments - see RuboCop::Options#add_autocorrection_options
+                            safe_autocorrect: @options[:safe_autocorrect])
 
         output.puts
         output.puts report.summary
@@ -108,22 +109,22 @@ module RuboCop
         # rubocop:disable Metrics/ParameterLists
         def initialize(
           file_count, offense_count, correction_count, correctable_count, rainbow,
-          safe_auto_correct: false
+          safe_autocorrect: false
         )
           @file_count = file_count
           @offense_count = offense_count
           @correction_count = correction_count
           @correctable_count = correctable_count
           @rainbow = rainbow
-          @safe_auto_correct = safe_auto_correct
+          @safe_autocorrect = safe_autocorrect
         end
         # rubocop:enable Metrics/ParameterLists
 
         def summary
           if @correction_count.positive?
             if @correctable_count.positive?
-              "#{files} inspected, #{offenses} detected, #{corrections} corrected,"\
-                " #{correctable}"
+              "#{files} inspected, #{offenses} detected, #{corrections} corrected, " \
+                "#{correctable}"
             else
               "#{files} inspected, #{offenses} detected, #{corrections} corrected"
             end
@@ -157,12 +158,12 @@ module RuboCop
         end
 
         def correctable
-          if @safe_auto_correct
+          if @safe_autocorrect
             text = pluralize(@correctable_count, 'more offense')
             "#{colorize(text, :yellow)} can be corrected with `rubocop -A`"
           else
             text = pluralize(@correctable_count, 'offense')
-            "#{colorize(text, :yellow)} auto-correctable"
+            "#{colorize(text, :yellow)} autocorrectable"
           end
         end
       end