Class: Rubocop::Formatter::FormatterSet
- Inherits:
-
Array
- Object
- Array
- Rubocop::Formatter::FormatterSet
- 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 }
- FORMATTER_APIS =
[:started, :file_started, :file_finished, :finished]
Instance Method Summary collapse
- #add_formatter(formatter_key, output_path = nil) ⇒ Object
- #close_output_files ⇒ Object
-
#initialize(report_summary = true) ⇒ FormatterSet
constructor
A new instance of FormatterSet.
Constructor Details
#initialize(report_summary = true) ⇒ FormatterSet
Returns a new instance of FormatterSet.
19 20 21 |
# File 'lib/rubocop/formatter/formatter_set.rb', line 19 def initialize(report_summary = true) @reports_summary = report_summary end |
Instance Method Details
#add_formatter(formatter_key, output_path = nil) ⇒ Object
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/rubocop/formatter/formatter_set.rb', line 29 def add_formatter(formatter_key, output_path = nil) formatter_class = if formatter_key =~ /\A[A-Z]/ custom_formatter_class(formatter_key) else builtin_formatter_class(formatter_key) 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
46 47 48 49 50 |
# File 'lib/rubocop/formatter/formatter_set.rb', line 46 def close_output_files each do |formatter| formatter.output.close if formatter.output.is_a?(File) end end |