rubocop 0.87.1

data/lib/rubocop/formatter/auto_gen_config_formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # Does not show individual offenses in the console.
+    class AutoGenConfigFormatter < ProgressFormatter
+      def finished(inspected_files)
+        output.puts
+
+        report_summary(inspected_files.size,
+                       @total_offense_count,
+                       @total_correction_count)
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/base_formatter.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # Abstract base class for formatter, implements all public API methods.
+    #
+    # ## Creating Custom Formatter
+    #
+    # You can create a custom formatter by subclassing
+    # `RuboCop::Formatter::BaseFormatter` and overriding some methods
+    # or by implementing all the methods by duck typing.
+    #
+    # ## Using Custom Formatter in Command Line
+    #
+    # You can tell RuboCop to use your custom formatter with a combination of
+    # `--format` and `--require` option.
+    # For example, when you have defined `MyCustomFormatter` in
+    # `./path/to/my_custom_formatter.rb`, you would type this command:
+    #
+    #     rubocop --require ./path/to/my_custom_formatter --format MyCustomFormatter
+    #
+    # Note: The path passed to `--require` is directly passed to
+    # `Kernel.require`.
+    # If your custom formatter file is not in `$LOAD_PATH`,
+    # you need to specify the path as relative path prefixed with `./`
+    # explicitly or absolute path.
+    #
+    # ## Method Invocation Order
+    #
+    # For example, when RuboCop inspects 2 files,
+    # the invocation order should be like this:
+    #
+    # * `#initialize`
+    # * `#started`
+    # * `#file_started`
+    # * `#file_finished`
+    # * `#file_started`
+    # * `#file_finished`
+    # * `#finished`
+    #
+    class BaseFormatter
+      # @api public
+      #
+      # @!attribute [r] output
+      #
+      # @return [IO]
+      #   the IO object passed to `#initialize`
+      #
+      # @see #initialize
+      attr_reader :output
+
+      # @api public
+      #
+      # @!attribute [r] options
+      #
+      # @return [Hash]
+      attr_reader :options
+
+      # @api public
+      #
+      # @param output [IO]
+      #   `$stdout` or opened file
+      def initialize(output, options = {})
+        @output = output
+        @options = options
+      end
+
+      # @api public
+      #
+      # Invoked once before any files are inspected.
+      #
+      # @param target_files [Array(String)]
+      #   all target file paths to be inspected
+      #
+      # @return [void]
+      def started(target_files); end
+
+      # @api public
+      #
+      # Invoked at the beginning of inspecting each files.
+      #
+      # @param file [String]
+      #   the file path
+      #
+      # @param options [Hash]
+      #   file specific information, currently this is always empty.
+      #
+      # @return [void]
+      def file_started(file, options); end
+
+      # @api public
+      #
+      # Invoked at the end of inspecting each files.
+      #
+      # @param file [String]
+      #   the file path
+      #
+      # @param offenses [Array(RuboCop::Cop::Offense)]
+      #   all detected offenses for the file
+      #
+      # @return [void]
+      #
+      # @see RuboCop::Cop::Offense
+      def file_finished(file, offenses); end
+
+      # @api public
+      #
+      # Invoked after all files are inspected or interrupted by user.
+      #
+      # @param inspected_files [Array(String)]
+      #   the inspected file paths.
+      #   This would be same as `target_files` passed to `#started`
+      #   unless RuboCop is interrupted by user.
+      #
+      # @return [void]
+      def finished(inspected_files); end
+    end
+  end
+end

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter formats report data in clang style.
+    # The precise location of the problem is shown together with the
+    # relevant source code.
+    class ClangStyleFormatter < SimpleTextFormatter
+      ELLIPSES = '...'
+
+      def report_file(file, offenses)
+        offenses.each { |offense| report_offense(file, offense) }
+      end
+
+      private
+
+      def report_offense(file, offense)
+        output.printf(
+          "%<path>s:%<line>d:%<column>d: %<severity>s: %<message>s\n",
+          path: cyan(smart_path(file)),
+          line: offense.line,
+          column: offense.real_column,
+          severity: colored_severity_code(offense),
+          message: message(offense)
+        )
+
+        begin
+          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
+      end
+
+      def valid_line?(offense)
+        !offense.location.source_line.blank?
+      end
+
+      def report_line(location)
+        source_line = location.source_line
+
+        if location.first_line == location.last_line
+          output.puts(source_line)
+        else
+          output.puts("#{source_line} #{yellow(ELLIPSES)}")
+        end
+      end
+
+      def report_highlighted_area(highlighted_area)
+        output.puts("#{' ' * highlighted_area.begin_pos}" \
+                    "#{'^' * highlighted_area.size}")
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/colorizable.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This mix-in module provides string coloring methods for terminals.
+    # It automatically disables coloring if coloring is disabled in the process
+    # globally or the formatter's output is not a terminal.
+    module Colorizable
+      def rainbow
+        @rainbow ||= begin
+          rainbow = Rainbow.new
+          if options[:color]
+            rainbow.enabled = true
+          elsif options[:color] == false || !output.tty?
+            rainbow.enabled = false
+          end
+          rainbow
+        end
+      end
+
+      def colorize(string, *args)
+        rainbow.wrap(string).color(*args)
+      end
+
+      %i[
+        black
+        red
+        green
+        yellow
+        blue
+        magenta
+        cyan
+        white
+      ].each do |color|
+        define_method(color) do |string|
+          colorize(string, color)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+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
+      HEADING = <<~COMMENTS
+        # This configuration was generated by
+        # `%<command>s`
+        # %<timestamp>susing RuboCop version #{Version.version}.
+        # 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
+
+      @config_to_allow_offenses = {}
+      @detected_styles = {}
+
+      class << self
+        attr_accessor :config_to_allow_offenses, :detected_styles
+      end
+
+      def initialize(output, options = {})
+        super
+        @cops_with_offenses ||= Hash.new(0)
+        @files_with_offenses ||= {}
+      end
+
+      def file_started(_file, _file_info)
+        @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)
+        offenses.each do |o|
+          @cops_with_offenses[o.cop_name] += 1
+          @files_with_offenses[o.cop_name] ||= Set.new
+          @files_with_offenses[o.cop_name] << file
+        end
+      end
+
+      def finished(_inspected_files)
+        output.puts format(HEADING, command: command, timestamp: timestamp)
+
+        # Syntax isn't a real cop and it can't be disabled.
+        @cops_with_offenses.delete('Lint/Syntax')
+
+        output_offenses
+
+        puts "Created #{output.path}."
+      end
+
+      private
+
+      def command
+        command = 'rubocop --auto-gen-config'
+
+        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))
+        end
+        command += ' --no-offense-counts' if @options[:no_offense_counts]
+
+        command += ' --no-auto-gen-timestamp' if @options[:no_auto_gen_timestamp]
+
+        command
+      end
+
+      def timestamp
+        @options[:no_auto_gen_timestamp] ? '' : "on #{Time.now.utc} "
+      end
+
+      def output_offenses
+        @cops_with_offenses.sort.each do |cop_name, offense_count|
+          output_cop(cop_name, offense_count)
+        end
+      end
+
+      def output_cop(cop_name, offense_count)
+        output.puts
+        cfg = self.class.config_to_allow_offenses[cop_name] || {}
+        set_max(cfg, cop_name)
+
+        # To avoid malformed YAML when potentially reading the config in
+        # #excludes, we use an output buffer and append it to the actual output
+        # only when it results in valid YAML.
+        output_buffer = StringIO.new
+        output_cop_comments(output_buffer, cfg, cop_name, offense_count)
+        output_cop_config(output_buffer, cfg, cop_name)
+        output.puts(output_buffer.string)
+      end
+
+      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
+
+        # Remove already used exclude_limit.
+        cfg.reject! { |key| key == :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::Cop.registry.find_by_cop_name(cop_name)
+        output_buffer.puts '# Cop supports --auto-correct.' if cop_class&.support_autocorrect?
+
+        default_cfg = default_config(cop_name)
+        return unless default_cfg
+
+        params = cop_config_params(default_cfg, cfg)
+        return if params.empty?
+
+        output_cop_param_comments(output_buffer, params, default_cfg)
+      end
+
+      def cop_config_params(default_cfg, cfg)
+        default_cfg.keys -
+          %w[Description StyleGuide Reference Enabled Exclude Safe
+             SafeAutoCorrect VersionAdded VersionChanged VersionRemoved] -
+          cfg.keys
+      end
+
+      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(', ')}."
+        )
+
+        params.each do |param|
+          value = default_cfg[param]
+          next unless value.is_a?(Array)
+          next if value.empty?
+
+          output_buffer.puts "# #{param}: #{value.join(', ')}"
+        end
+      end
+
+      def default_config(cop_name)
+        RuboCop::ConfigLoader.default_configuration[cop_name]
+      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' }
+
+        output_buffer.puts "#{cop_name}:"
+        cfg_without_enabled.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)
+      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
+          output_buffer.puts '  Enabled: false'
+        else
+          output_exclude_list(output_buffer, offending_files, cop_name)
+        end
+      end
+
+      def output_exclude_list(output_buffer, offending_files, cop_name)
+        require 'pathname'
+        parent = Pathname.new(Dir.pwd)
+
+        output_buffer.puts '  Exclude:'
+        excludes(offending_files, cop_name, parent).each do |exclude_path|
+          output_exclude_path(output_buffer, exclude_path, parent)
+        end
+      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
+        config = ConfigStore.new.for(parent)
+        cfg = config[cop_name] || {}
+
+        ((cfg['Exclude'] || []) + offending_files).uniq
+      end
+
+      def output_exclude_path(output_buffer, exclude_path, parent)
+        # exclude_path is either relative path, an absolute path, or a regexp.
+        file_path = Pathname.new(exclude_path)
+        relative = file_path.relative_path_from(parent)
+        output_buffer.puts "    - '#{relative}'"
+      rescue ArgumentError
+        file = exclude_path
+        output_buffer.puts "    - '#{file}'"
+      rescue TypeError
+        regexp = exclude_path
+        output_buffer.puts "    - !ruby/regexp /#{regexp.source}/"
+      end
+    end
+  end
+end