Class: Rubocop::Formatter::FormatterSet

Inherits:
Array
  • Object
show all
Defined in:
lib/rubocop/formatter/formatter_set.rb

Overview

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.

Constant Summary collapse

BUILTIN_FORMATTERS_FOR_KEYS = 
{
  'progress' => ProgressFormatter,
  'simple'   => SimpleTextFormatter,
  'clang'    => ClangStyleFormatter,
  'emacs'    => EmacsStyleFormatter,
  'json'     => JSONFormatter,
  'files'    => FileListFormatter
}
FORMATTER_APIS = 
[:started, :file_started, :file_finished, :finished]

Instance Method Summary collapse

Constructor Details

#initialize(report_summary = true) ⇒ FormatterSet

Returns a new instance of FormatterSet.



20
21
22
 
# File 'lib/rubocop/formatter/formatter_set.rb', line 20

def initialize(report_summary = true)
  @reports_summary = report_summary
end

Instance Method Details

#add_formatter(formatter_type, output_path = nil) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/formatter/formatter_set.rb', line 30

def add_formatter(formatter_type, output_path = nil)
  formatter_class = case formatter_type
                    when Class
                      formatter_type
                    when /\A[A-Z]/
                      custom_formatter_class(formatter_type)
                    else
                      builtin_formatter_class(formatter_type)
                    end

  output = output_path ? File.open(output_path, 'w') : $stdout

  formatter = formatter_class.new(output)
  if formatter.respond_to?(:reports_summary=)
    # TODO: Consider dropping -s/--silent option
    formatter.reports_summary = @reports_summary
  end
  self << formatter
end

#close_output_files ⇒ Object 



50
51
52
53
54
 
# File 'lib/rubocop/formatter/formatter_set.rb', line 50

def close_output_files
  each do |formatter|
    formatter.output.close if formatter.output.is_a?(File)
  end
end