rubbycop 0.49.0

data/lib/rubbycop/formatter/clang_style_formatter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  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 = '...'.freeze
+
+      def report_file(file, offenses)
+        offenses.each { |offense| report_offense(file, offense) }
+      end
+
+      private
+
+      def report_offense(file, offense)
+        output.printf("%s:%d:%d: %s: %s\n",
+                      cyan(smart_path(file)), offense.line, offense.real_column,
+                      colored_severity_code(offense), message(offense))
+
+        # rubbycop:disable Lint/HandleExceptions
+        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
+        # rubbycop:enable Lint/HandleExceptions
+      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/rubbycop/formatter/colorizable.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  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/rubbycop/formatter/disabled_config_formatter.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  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 =
+        ['# This configuration was generated by',
+         '# `%s`',
+         "# on #{Time.now} using RubbyCop 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 RubbyCop, may require this file to be generated again.']
+        .join("\n")
+
+      @config_to_allow_offenses = {}
+      @detected_styles = {}
+
+      COPS = Cop::Cop.registry.to_h
+
+      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 = (
+          @exclude_limit_option ||
+          RubbyCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS).to_i
+        @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] ||= []
+          @files_with_offenses[o.cop_name] << file
+        end
+      end
+
+      def finished(_inspected_files)
+        output.puts HEADING % command
+
+        # Syntax isn't a real cop and it can't be disabled.
+        @cops_with_offenses.delete('Syntax')
+
+        output_offenses
+
+        puts "Created #{output.path}."
+        puts "Run `rubbycop --config #{output.path}`, or add `inherit_from: " \
+             "#{output.path}` in a .rubbycop.yml file."
+      end
+
+      private
+
+      def command
+        command = 'rubbycop --auto-gen-config'
+        if @exclude_limit_option
+          command += format(' --exclude-limit %d', @exclude_limit_option.to_i)
+        end
+        command += ' --no-offense-counts' if @options[:no_offense_counts]
+
+        command
+      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] || {}
+
+        output_cop_comments(output, cfg, cop_name, offense_count)
+        output_cop_config(output, cfg, cop_name)
+      end
+
+      def output_cop_comments(output, cfg, cop_name, offense_count)
+        output.puts "# Offense count: #{offense_count}" if @show_offense_counts
+        if COPS[cop_name] && COPS[cop_name].first.new.support_autocorrect?
+          output.puts '# Cop supports --auto-correct.'
+        end
+
+        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(params, default_cfg)
+      end
+
+      def cop_config_params(default_cfg, cfg)
+        default_cfg.keys -
+          %w[Description StyleGuide Reference Enabled Exclude] -
+          cfg.keys
+      end
+
+      def output_cop_param_comments(params, default_cfg)
+        output.puts "# Configuration parameters: #{params.join(', ')}."
+
+        params.each do |param|
+          value = default_cfg[param]
+          if value.is_a?(Array)
+            next if value.empty?
+            output.puts "# #{param}: #{value.join(', ')}"
+          end
+        end
+      end
+
+      def default_config(cop_name)
+        RubbyCop::ConfigLoader.default_configuration[cop_name]
+      end
+
+      def output_cop_config(output, 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.puts "#{cop_name}:"
+        cfg_without_enabled.each do |key, value|
+          value = value[0] if value.is_a?(Array)
+          output.puts "  #{key}: #{value}"
+        end
+
+        output_offending_files(output, cfg_without_enabled, cop_name)
+      end
+
+      def output_offending_files(output, cfg, cop_name)
+        return unless cfg.empty?
+
+        offending_files = @files_with_offenses[cop_name].uniq.sort
+        if offending_files.count > @exclude_limit
+          output.puts '  Enabled: false'
+        else
+          output_exclude_list(output, offending_files, cop_name)
+        end
+      end
+
+      def output_exclude_list(output, offending_files, cop_name)
+        require 'pathname'
+        parent = Pathname.new(Dir.pwd)
+
+        output.puts '  Exclude:'
+        excludes(offending_files, cop_name, parent).each do |file|
+          output_exclude_path(output, file, parent)
+        end
+      end
+
+      def excludes(offending_files, cop_name, parent)
+        # Exclude properties in .rubbycop_todo.yml override default ones, as well
+        # as any custom excludes in .rubbycop.yml, so in order to retain those
+        # excludes we must copy them.
+        # There can be multiple .rubbycop.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, file, parent)
+        file_path = Pathname.new(file)
+        relative = file_path.relative_path_from(parent)
+        output.puts "    - '#{relative}'"
+      rescue ArgumentError
+        output.puts "    - '#{file}'"
+      end
+    end
+  end
+end

data/lib/rubbycop/formatter/disabled_lines_formatter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Formatter
+    # A basic formatter that displays the lines disabled
+    # inline comments.
+    class DisabledLinesFormatter < BaseFormatter
+      include PathUtil
+      include Colorizable
+
+      attr_reader :cop_disabled_line_ranges
+
+      def started(_target_files)
+        @cop_disabled_line_ranges = {}
+      end
+
+      def file_started(file, options)
+        return unless options[:cop_disabled_line_ranges]
+
+        @cop_disabled_line_ranges[file] =
+          options[:cop_disabled_line_ranges]
+      end
+
+      def finished(_inspected_files)
+        cops_disabled_in_comments_summary
+      end
+
+      private
+
+      def cops_disabled_in_comments_summary
+        summary = "\nCops disabled line ranges:\n\n"
+
+        @cop_disabled_line_ranges.each do |file, disabled_cops|
+          disabled_cops.each do |cop, line_ranges|
+            line_ranges.each do |line_range|
+              file = cyan(smart_path(file))
+              summary += "#{file}:#{line_range}: #{cop}\n"
+            end
+          end
+        end
+
+        output.puts summary
+      end
+
+      def smart_path(path)
+        # Ideally, we calculate this relative to the project root.
+        base_dir = Dir.pwd
+
+        if path.start_with? base_dir
+          relative_path(path, base_dir)
+        else
+          path
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/formatter/emacs_style_formatter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Formatter
+    # This formatter displays the report data in format that's
+    # easy to process in the Emacs text editor.
+    # The output is machine-parsable.
+    class EmacsStyleFormatter < BaseFormatter
+      def file_finished(file, offenses)
+        offenses.each do |o|
+          message = if o.corrected?
+                      "[Corrected] #{o.message}"
+                    else
+                      o.message
+                    end
+
+          output.printf("%s:%d:%d: %s: %s\n",
+                        file, o.line, o.real_column, o.severity.code,
+                        message.tr("\n", ' '))
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/formatter/file_list_formatter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Formatter
+    # This formatter displays just a list of the files with offenses in them,
+    # separated by newlines. The output is machine-parsable.
+    #
+    # Here's the format:
+    #
+    # /some/file
+    # /some/other/file
+    class FileListFormatter < BaseFormatter
+      def file_finished(file, offenses)
+        return if offenses.empty?
+        output.printf("%s\n", file)
+      end
+    end
+  end
+end

data/lib/rubbycop/formatter/formatter_set.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module RubbyCop
+  module Formatter
+    # This is a collection of formatters. A FormatterSet can hold multiple
+    # formatter instances and provides transparent formatter API methods
+    # which invoke same method of each formatters.
+    class FormatterSet < Array
+      BUILTIN_FORMATTERS_FOR_KEYS = {
+        'progress' => ProgressFormatter,
+        'simple'   => SimpleTextFormatter,
+        'clang'    => ClangStyleFormatter,
+        'fuubar'   => FuubarStyleFormatter,
+        'emacs'    => EmacsStyleFormatter,
+        'json'     => JSONFormatter,
+        'html'     => HTMLFormatter,
+        'files'    => FileListFormatter,
+        'offenses' => OffenseCountFormatter,
+        'disabled' => DisabledLinesFormatter,
+        'worst'    => 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) }
+        end
+      end
+
+      def initialize(options = {})
+        @options = options # CLI options
+      end
+
+      def file_started(file, options)
+        @options = options[:cli_options]
+        @config_store = options[:config_store]
+        each { |f| f.file_started(file, options) }
+      end
+
+      def file_finished(file, offenses)
+        each { |f| f.file_finished(file, offenses) }
+        offenses
+      end
+
+      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)
+          output = File.open(output_path, 'w')
+        else
+          output = $stdout
+        end
+
+        self << formatter_class(formatter_type).new(output, @options)
+      end
+
+      def close_output_files
+        each do |formatter|
+          formatter.output.close if formatter.output.is_a?(File)
+        end
+      end
+
+      private
+
+      def formatter_class(formatter_type)
+        case formatter_type
+        when Class
+          formatter_type
+        when /\A[A-Z]/
+          custom_formatter_class(formatter_type)
+        else
+          builtin_formatter_class(formatter_type)
+        end
+      end
+
+      def builtin_formatter_class(specified_key)
+        matching_keys = BUILTIN_FORMATTERS_FOR_KEYS.keys.select do |key|
+          key.start_with?(specified_key)
+        end
+
+        raise %(No formatter for "#{specified_key}") if matching_keys.empty?
+
+        if matching_keys.size > 1
+          raise %(Cannot determine formatter for "#{specified_key}")
+        end
+
+        BUILTIN_FORMATTERS_FOR_KEYS[matching_keys.first]
+      end
+
+      def custom_formatter_class(specified_class_name)
+        constant_names = specified_class_name.split('::')
+        constant_names.shift if constant_names.first.empty?
+        constant_names.reduce(Object) do |namespace, constant_name|
+          namespace.const_get(constant_name, false)
+        end
+      end
+    end
+  end
+end