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, 'fuubar' => FuubarStyleFormatter, 'emacs' => EmacsStyleFormatter, 'json' => JSONFormatter, 'html' => HTMLFormatter, 'files' => FileListFormatter, 'offenses' => OffenseCountFormatter, 'disabled' => DisabledLinesFormatter }
- FORMATTER_APIS =
[:started, :finished]
Instance Method Summary collapse
- #add_formatter(formatter_type, output_path = nil) ⇒ Object
- #close_output_files ⇒ Object
- #file_finished(file, offenses) ⇒ Object
- #file_started(file, options) ⇒ Object
Instance Method Details
#add_formatter(formatter_type, output_path = nil) ⇒ Object
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/rubocop/formatter/formatter_set.rb', line 58 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 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.new(output) end |
#close_output_files ⇒ Object
79 80 81 82 83 |
# File 'lib/rubocop/formatter/formatter_set.rb', line 79 def close_output_files each do |formatter| formatter.output.close if formatter.output.is_a?(File) end end |
#file_finished(file, offenses) ⇒ Object
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/rubocop/formatter/formatter_set.rb', line 40 def file_finished(file, offenses) if @cop_disabled_line_ranges.any? && # Don't check unneeded disable if --only or --except option is # given, because these options override configuration. (@options[:except] || []).empty? && (@options[:only] || []).empty? config = @config_store.for(file) if config['Lint/UnneededDisable']['Enabled'] cop = Cop::Lint::UnneededDisable.new(config, @options) cop.check(offenses, @cop_disabled_line_ranges, @comments) offenses += cop.offenses end end offenses = offenses.sort.reject(&:disabled?) each { |f| f.file_finished(file, offenses) } offenses end |
#file_started(file, options) ⇒ Object
32 33 34 35 36 37 38 |
# File 'lib/rubocop/formatter/formatter_set.rb', line 32 def file_started(file, ) @cop_disabled_line_ranges = [:cop_disabled_line_ranges] @comments = [:comments] @options = [:cli_options] @config_store = [:config_store] each { |f| f.file_started(file, ) } end |