rubocop 0.76.0 → 1.50.0

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -5,6 +5,8 @@ module RuboCop
     # This formatter displays a YAML configuration file where all cops that
     # detected any offenses are configured to not detect the offense.
     class DisabledConfigFormatter < BaseFormatter
+      include PathUtil
+
       HEADING = <<~COMMENTS
         # This configuration was generated by
         # `%<command>s`
@@ -32,7 +34,6 @@ module RuboCop
         @exclude_limit_option = @options[:exclude_limit]
         @exclude_limit = Integer(@exclude_limit_option ||
           RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS)
-        @show_offense_counts = !@options[:no_offense_counts]
       end
 
       def file_finished(file, offenses)
@@ -56,29 +57,39 @@ module RuboCop
 
       private
 
+      def show_timestamp?
+        @options.fetch(:auto_gen_timestamp, true)
+      end
+
+      def show_offense_counts?
+        @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'
 
-        if @options[:auto_gen_only_exclude]
-          command += ' --auto-gen-only-exclude'
-        end
+        command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
 
-        if @exclude_limit_option
-          command +=
-            format(' --exclude-limit %<limit>d',
-                   limit: Integer(@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' if @options[:no_offense_counts]
+        command += ' --no-offense-counts' unless show_offense_counts?
 
-        if @options[:no_auto_gen_timestamp]
-          command += ' --no-auto-gen-timestamp'
-        end
+        command += ' --no-auto-gen-timestamp' unless show_timestamp?
+
+        command += ' --no-auto-gen-enforced-style' unless auto_gen_enforced_style?
 
         command
       end
 
       def timestamp
-        @options[:no_auto_gen_timestamp] ? '' : "on #{Time.now} "
+        show_timestamp? ? "on #{Time.now.utc} " : ''
       end
 
       def output_offenses
@@ -106,8 +117,7 @@ module RuboCop
 
         # 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
+        if !@options[:auto_gen_only_exclude] || @files_with_offenses[cop_name].size > @exclude_limit
           cfg.merge!(cfg[:exclude_limit])
         end
 
@@ -116,16 +126,17 @@ module RuboCop
       end
 
       def output_cop_comments(output_buffer, cfg, cop_name, offense_count)
-        if @show_offense_counts
-          output_buffer.puts "# Offense count: #{offense_count}"
-        end
+        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)
 
-        cop_class = Cop::Cop.registry.find_by_cop_name(cop_name)
-        if cop_class&.new&.support_autocorrect?
-          output_buffer.puts '# Cop supports --auto-correct.'
+        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
 
-        default_cfg = default_config(cop_name)
         return unless default_cfg
 
         params = cop_config_params(default_cfg, cfg)
@@ -134,6 +145,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
@@ -143,16 +162,14 @@ module RuboCop
 
       def output_cop_param_comments(output_buffer, params, default_cfg)
         config_params = params.reject { |p| p.start_with?('Supported') }
-        output_buffer.puts(
-          "# Configuration parameters: #{config_params.join(', ')}."
-        )
+        output_buffer.puts("# Configuration parameters: #{config_params.join(', ')}.")
 
         params.each do |param|
           value = default_cfg[param]
           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
 
@@ -161,24 +178,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 << 'EnforcedStyle' unless auto_gen_enforced_style?
+        cfg.reject { |key| rejected_keys.include?(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)
@@ -196,15 +218,28 @@ module RuboCop
       end
 
       def excludes(offending_files, cop_name, parent)
-        # Exclude properties in .rubocop_todo.yml override default ones, as well
-        # as any custom excludes in .rubocop.yml, so in order to retain those
-        # excludes we must copy them.
-        # There can be multiple .rubocop.yml files in subdirectories, but we
-        # just look at the current working directory
+        # Exclude properties in .rubocop_todo.yml override default ones, as well as any custom
+        # excludes in .rubocop.yml, so in order to retain those excludes we must copy them.
+        # There can be multiple .rubocop.yml files in subdirectories, but we just look at the
+        # current working directory.
         config = ConfigStore.new.for(parent)
         cfg = config[cop_name] || {}
 
-        ((cfg['Exclude'] || []) + offending_files).uniq
+        if merge_mode_for_exclude?(config) || merge_mode_for_exclude?(cfg)
+          offending_files
+        else
+          cop_exclude = cfg['Exclude']
+          if cop_exclude && cop_exclude != default_config(cop_name)['Exclude']
+            warn "`#{cop_name}: Exclude` in `#{smart_path(config.loaded_path)}` overrides a " \
+                 'generated `Exclude` in `.rubocop_todo.yml`. Either remove ' \
+                 "`#{cop_name}: Exclude` or add `inherit_mode: merge: - Exclude`."
+          end
+          ((cop_exclude || []) + offending_files).uniq
+        end
+      end
+
+      def merge_mode_for_exclude?(cfg)
+        Array(cfg.to_h.dig('inherit_mode', 'merge')).include?('Exclude')
       end
 
       def output_exclude_path(output_buffer, exclude_path, parent)
@@ -219,6 +254,14 @@ 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
     end
   end
 end

data/lib/rubocop/formatter/emacs_style_formatter.rb

@@ -27,6 +27,8 @@ module RuboCop
             "[Todo] #{offense.message}"
           elsif offense.corrected?
             "[Corrected] #{offense.message}"
+          elsif offense.correctable?
+            "[Correctable] #{offense.message}"
           else
             offense.message
           end

data/lib/rubocop/formatter/formatter_set.rb

@@ -9,32 +9,35 @@ module RuboCop
     # which invoke same method of each formatters.
     class FormatterSet < Array
       BUILTIN_FORMATTERS_FOR_KEYS = {
-        '[a]utogenconf' => AutoGenConfigFormatter,
-        '[c]lang'       => ClangStyleFormatter,
-        '[d]isabled'    => DisabledLinesFormatter,
-        '[e]macs'       => EmacsStyleFormatter,
-        '[fi]les'       => FileListFormatter,
-        '[fu]ubar'      => FuubarStyleFormatter,
-        '[h]tml'        => HTMLFormatter,
-        '[j]son'        => JSONFormatter,
-        '[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
 
       FORMATTER_APIS = %i[started finished].freeze
 
       FORMATTER_APIS.each do |method_name|
         define_method(method_name) do |*args|
-          each { |f| f.send(method_name, *args) }
+          each { |f| f.public_send(method_name, *args) }
         end
       end
 
       def initialize(options = {})
+        super()
         @options = options # CLI options
       end
 
@@ -52,7 +55,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
@@ -82,16 +85,15 @@ module RuboCop
 
       def builtin_formatter_class(specified_key)
         matching_keys = BUILTIN_FORMATTERS_FOR_KEYS.keys.select do |key|
-          key =~ /^\[#{specified_key}\]/ || specified_key == key.delete('[]')
+          /^\[#{specified_key}\]/.match?(key) || specified_key == key.delete('[]')
         end
 
         raise %(No formatter for "#{specified_key}") if matching_keys.empty?
 
-        if matching_keys.size > 1
-          raise %(Cannot determine formatter for "#{specified_key}")
-        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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter formats report data as GitHub Workflow commands resulting
+    # in GitHub check annotations when run within GitHub Actions.
+    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_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
+
+      def github_escape(string)
+        string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
+      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
+      end
+
+      def github_severity(offense)
+        offense.severity < minimum_severity_to_fail ? 'warning' : 'error'
+      end
+
+      def report_offense(file, offense)
+        output.printf(
+          "\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,
+          column: offense.real_column,
+          message: github_escape(offense.message)
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/html_formatter.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
+require 'base64'
 require 'cgi'
 require 'erb'
 require 'ostruct'
-require 'base64'
-require_relative 'text_util'
 
 module RuboCop
   module Formatter
     # This formatter saves the output as an html file.
     class HTMLFormatter < BaseFormatter
       ELLIPSES = '<span class="extra-code">...</span>'
-      TEMPLATE_PATH =
-        File.expand_path('../../../assets/output.html.erb', __dir__)
+      TEMPLATE_PATH = File.expand_path('../../../assets/output.html.erb', __dir__)
 
       Color = Struct.new(:red, :green, :blue, :alpha) do
         def to_s
@@ -20,18 +18,19 @@ module RuboCop
         end
 
         def fade_out(amount)
-          dup.tap do |color|
-            color.alpha -= amount
-          end
+          dup.tap { |color| color.alpha -= amount }
         end
       end
 
+      Summary = Struct.new(:offense_count, :inspected_files, :target_files, keyword_init: true)
+      FileOffenses = Struct.new(:path, :offenses, keyword_init: true)
+
       attr_reader :files, :summary
 
       def initialize(output, options = {})
         super
         @files = []
-        @summary = OpenStruct.new(offense_count: 0)
+        @summary = Summary.new(offense_count: 0)
       end
 
       def started(target_files)
@@ -39,7 +38,7 @@ module RuboCop
       end
 
       def file_finished(file, offenses)
-        files << OpenStruct.new(path: file, offenses: offenses)
+        files << FileOffenses.new(path: file, offenses: offenses)
         summary.offense_count += offenses.count
       end
 
@@ -53,14 +52,7 @@ 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
+        erb = ERB.new(template, trim_mode: '-')
         html = erb.result(context.binding)
 
         output.write html
@@ -79,8 +71,7 @@ module RuboCop
           fatal:      Color.new(0xD2, 0x32, 0x2D, 1.0)
         }.freeze
 
-        LOGO_IMAGE_PATH =
-          File.expand_path('../../../assets/logo.png', __dir__)
+        LOGO_IMAGE_PATH = File.expand_path('../../../assets/logo.png', __dir__)
 
         attr_reader :files, :summary
 
@@ -90,24 +81,24 @@ module RuboCop
         end
 
         # Make Kernel#binding public.
+        # rubocop:disable Lint/UselessMethodDefinition
         def binding
           super
         end
+        # rubocop:enable Lint/UselessMethodDefinition
 
         def decorated_message(offense)
-          offense.message.gsub(/`(.+?)`/) do
-            "<code>#{Regexp.last_match(1)}</code>"
-          end
+          offense.message.gsub(/`(.+?)`/) { "<code>#{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>'
@@ -120,11 +111,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)

data/lib/rubocop/formatter/json_formatter.rb

@@ -13,11 +13,7 @@ module RuboCop
 
       def initialize(output, options = {})
         super
-        @output_hash = {
-          metadata: metadata_hash,
-          files:    [],
-          summary:  { offense_count: 0 }
-        }
+        @output_hash = { metadata: metadata_hash, files: [], summary: { offense_count: 0 } }
       end
 
       def started(target_files)
@@ -53,21 +49,25 @@ module RuboCop
 
       def hash_for_offense(offense)
         {
-          severity:  offense.severity.name,
-          message:   offense.message,
-          cop_name:  offense.cop_name,
-          corrected: offense.corrected?,
-          location:  hash_for_location(offense)
+          severity:    offense.severity.name,
+          message:     offense.message,
+          cop_name:    offense.cop_name,
+          corrected:   offense.corrected?,
+          correctable: offense.correctable?,
+          location:    hash_for_location(offense)
         }
       end
 
       # TODO: Consider better solution for Offense#real_column.
+      #       The minimum value of `start_column: real_column` is 1.
+      #       So, the minimum value of `last_column` should be 1.
+      #       And non-zero value of `last_column` should be used as is.
       def hash_for_location(offense)
         {
           start_line:   offense.line,
           start_column: offense.real_column,
           last_line:    offense.last_line,
-          last_column:  offense.last_column,
+          last_column:  offense.last_column.zero? ? 1 : offense.last_column,
           length:       offense.location.length,
           # `line` and `column` exist for compatibility.
           # Use `start_line` and `start_column` instead.

data/lib/rubocop/formatter/junit_formatter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'rexml/document'
+
+#
+# This code is based on https://github.com/mikian/rubocop-junit-formatter.
+#
+# Copyright (c) 2015 Mikko Kokkonen
+#
+# MIT License
+#
+# https://github.com/mikian/rubocop-junit-formatter/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Formatter
+    # This formatter formats the report data in JUnit format.
+    class JUnitFormatter < BaseFormatter
+      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') }
+
+        reset_count
+      end
+
+      def file_finished(file, offenses)
+        @inspected_file_count += 1
+
+        # 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|
+          target_offenses = offenses_for_cop(offenses, cop)
+          @offense_count += target_offenses.count
+
+          next unless relevant_for_output?(options, target_offenses)
+
+          add_testcase_element_to_testsuite_element(file, target_offenses, cop)
+        end
+      end
+
+      def relevant_for_output?(options, target_offenses)
+        !options[:display_only_failed] || target_offenses.any?
+      end
+
+      def offenses_for_cop(all_offenses, cop)
+        all_offenses.select { |offense| offense.cop_name == cop.cop_name }
+      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)
+        end
+      end
+
+      def classname_attribute_value(file)
+        @classname_attribute_value_cache ||= Hash.new do |hash, key|
+          hash[key] = key.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
+        end
+        @classname_attribute_value_cache[file]
+      end
+
+      def finished(_inspected_files)
+        @testsuite.add_attributes('tests' => @inspected_file_count, 'failures' => @offense_count)
+        @document.write(output, 2)
+      end
+
+      private
+
+      def reset_count
+        @inspected_file_count = 0
+        @offense_count = 0
+      end
+
+      def add_failure_to(testcase, offenses, cop_name)
+        # 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
+        end
+      end
+    end
+  end
+end